Ballerina library

insightly.custom

Module insightly.custom

OverviewPrerequisites

API

Client

Definitions

APICustomField
APICustomFieldDependency
APICustomFieldMetadata
APICustomFieldOption
APICustomFieldOptionsFilter
APICustomObject
ClientHttp1Settings
ConnectionConfig
CustomFieldMetadata
CustomObject
CustomObjectsRecords
Customobjectsrecords1
CustomObjectsRecords1
Customobjectsrecords2
Customobjectsrecords3
ProxyConfig

ballerinax/insightly.custom Ballerina library

1.5.1

Overview

This is a generated connector for Insightly API v3.1 OpenAPI specification.

This API enables you to integrate Insightly with external systems and applications. This uses HTTPS to access data within the Insightly web application.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Clients

insightly.custom: Client

Isolated

This is a generated connector for Insightly API v3.1 OpenAPI specification. This API enables you to integrate Insightly with external systems and applications. This uses HTTPS to access data within the Insightly web application.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create an Insightly Account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://api.insightly.com/v3.1" - URL of the target service

getEntities

Isolated FunctionRemote Function
function getEntities(string objectName, boolean brief, int? skip, int? top, boolean countTotal) returns CustomObjectsRecords[]|error

Gets a list of records

Parameters
  • objectName string - The object name
  • brief boolean (default false) - Optional, true if response should only contain top level properties of the record.
  • skip int? (default ()) - Optional, number of records to skip.
  • top int? (default ()) - Optional, maximum number of records to return in the response.
  • countTotal boolean (default false) - Optional,true if total number of records should be returned in the response headers.
Return Type

updateEntity

Isolated FunctionRemote Function
function updateEntity(string objectName, Customobjectsrecords1 payload) returns CustomObjectsRecords|error

Updates a record

Parameters
  • objectName string - The object name
Return Type

addEntity

Isolated FunctionRemote Function
function addEntity(string objectName, Customobjectsrecords2 payload) returns CustomObjectsRecords|error

Adds a record

Parameters
  • objectName string - The object name
Return Type

getEntity

Isolated FunctionRemote Function
function getEntity(string objectName, int id) returns CustomObjectsRecords|error

Gets a record

Parameters
  • objectName string - The object name
  • id int - The record's ID
Return Type

deleteEntity

Isolated FunctionRemote Function
function deleteEntity(string objectName, int id) returns Response|error

Deletes a Record

Parameters
  • objectName string - The object name
  • id int - Entity's ID
Return Type

getTranslation

Isolated FunctionRemote Function
function getTranslation(string objectName, int id, string language) returns CustomObjectsRecords[]|error

Gets a record's translation in a specific language

Parameters
  • objectName string - The object name
  • id int - The record's ID
  • language string - The requested language
Return Type

updateTranslation

Isolated FunctionRemote Function
function updateTranslation(string objectName, string language, string id, Customobjectsrecords3 payload) returns CustomObjectsRecords[]|error

Updates a record's translation in a specific language

Parameters
  • objectName string - The object name
  • language string - The language of the record's translation to update
Return Type

addTranslation

Isolated FunctionRemote Function
function addTranslation(string objectName, string language, string id, CustomObjectsRecords1 payload) returns CustomObjectsRecords[]|error

Adds a Translation for a record in a specific language

Parameters
  • objectName string - The object name
  • language string - The language of the translation to add
Return Type

getCustomObjectsRecordsBySearch

Isolated FunctionRemote Function
function getCustomObjectsRecordsBySearch(string objectName, string? fieldName, string? fieldValue, string? updatedAfterUtc, boolean brief, int? skip, int? top, boolean countTotal) returns CustomObjectsRecords[]|error

Gets a filtered list of records

Parameters
  • objectName string - The object name
  • fieldName string? (default ()) - Optional, field name for object
  • fieldValue string? (default ()) - Optional, field value of the record
  • updatedAfterUtc string? (default ()) - Optional, earliest date when a record was last updated.
  • brief boolean (default false) - Optional, true if response should only contain top level properties of the record.
  • skip int? (default ()) - Optional, number of records to skip.
  • top int? (default ()) - Optional, maximum number of records to return in the response.
  • countTotal boolean (default false) - Optional, true if total number of records should be returned in the response headers.
Return Type

getCustomFields

Isolated FunctionRemote Function
function getCustomFields(string objectName) returns APICustomFieldMetadata[]|error

Gets a list of Custom Fields

Parameters
Return Type

getCustomfieldBySearch

Isolated FunctionRemote Function
function getCustomfieldBySearch(string objectName, string fieldName) returns CustomFieldMetadata|error

Gets a Custom Field by name

Parameters
  • objectName string - The object name
  • fieldName string - The custom field name
Return Type

getCustomObjects

Isolated FunctionRemote Function
function getCustomObjects() returns APICustomObject[]|error

Gets a list of custom objects

Return Type

getCustomObject

Isolated FunctionRemote Function
function getCustomObject(string customObjectName) returns CustomObject|error

Gets a custom object by object name

Parameters
  • customObjectName string - The custom object name
Return Type

Records

insightly.custom: APICustomField

Fields
  • FIELD_VALUE record {}? -

insightly.custom: APICustomFieldDependency

Fields
  • CONTROLLING_FIELD_ID string? -

insightly.custom: APICustomFieldMetadata

Fields
  • FIELD_ORDER int -

insightly.custom: APICustomFieldOption

Fields
  • OPTION_ID int? -

insightly.custom: APICustomFieldOptionsFilter

Fields
  • OPTION_IDS int[]? -

insightly.custom: APICustomObject

Fields
  • RECORD_NAME_DISPLAY_FORMAT string? -
  • CREATED_USER_ID int? -

insightly.custom: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

insightly.custom: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

insightly.custom: CustomFieldMetadata

Fields
  • FIELD_ORDER int -

insightly.custom: CustomObject

Fields
  • RECORD_NAME_DISPLAY_FORMAT string? -
  • CREATED_USER_ID int? -

insightly.custom: CustomObjectsRecords

Fields
  • RECORD_ID int? -
  • OWNER_USER_ID int? -
  • VISIBLE_TEAM_ID int? -

insightly.custom: Customobjectsrecords1

Fields
  • OWNER_USER_ID int? -
  • VISIBLE_TEAM_ID int? -

insightly.custom: CustomObjectsRecords1

Fields
  • OWNER_USER_ID int? -
  • VISIBLE_TEAM_ID int? -

insightly.custom: Customobjectsrecords2

Fields
  • OWNER_USER_ID int? -
  • VISIBLE_TEAM_ID int? -

insightly.custom: Customobjectsrecords3

Fields
  • OWNER_USER_ID int? -
  • VISIBLE_TEAM_ID int? -

insightly.custom: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

Import

import ballerinax/insightly.custom;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Sales & CRM/Customer Relationship Management

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0

Dependencies

ballerina/url/2.2.3ballerina/constraint/1.1.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC