Module insightly.custom
ballerinax/insightly.custom Ballerina library
1.5.2
Overview
The Insightly API v3.1 connector(https://api.insightly.com/v3.1/Help?_ga=2.145122291.690415835.1637494899-1873531480.1637320890#!/Overview/Introduction) 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.
Key Features
- Programmatic access to create and manage resources via REST API
- Access analytics, reports, and performance metrics
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Insightly account.
- Obtain tokens by following this guide.
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[]|errorGets 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
- CustomObjectsRecords[]|error - Request succeeded.
updateEntity
Isolated FunctionRemote Function
function updateEntity(string objectName, Customobjectsrecords1 payload) returns CustomObjectsRecords|errorUpdates a record
Parameters
- objectName string - The object name
- payload Customobjectsrecords1 - The record to update (just include the JSON object as the request body)
Return Type
- CustomObjectsRecords|error - Request succeeded.
addEntity
Isolated FunctionRemote Function
function addEntity(string objectName, Customobjectsrecords2 payload) returns CustomObjectsRecords|errorAdds a record
Parameters
- objectName string - The object name
- payload Customobjectsrecords2 - The record to add (just include the JSON object as the request body)
Return Type
- CustomObjectsRecords|error - Request succeeded.
getEntity
Isolated FunctionRemote Function
function getEntity(string objectName, int id) returns CustomObjectsRecords|errorGets a record
Return Type
- CustomObjectsRecords|error - Request succeeded.
deleteEntity
Isolated FunctionRemote Function
Deletes a Record
getTranslation
Isolated FunctionRemote Function
function getTranslation(string objectName, int id, string language) returns CustomObjectsRecords[]|errorGets 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
- CustomObjectsRecords[]|error - Request succeeded.
updateTranslation
Isolated FunctionRemote Function
function updateTranslation(string objectName, string language, string id, Customobjectsrecords3 payload) returns CustomObjectsRecords[]|errorUpdates 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
- id string -
- payload Customobjectsrecords3 - The record to update (just include the JSON object as the request body)
Return Type
- CustomObjectsRecords[]|error - Request succeeded.
addTranslation
Isolated FunctionRemote Function
function addTranslation(string objectName, string language, string id, CustomObjectsRecords1 payload) returns CustomObjectsRecords[]|errorAdds a Translation for a record in a specific language
Parameters
- objectName string - The object name
- language string - The language of the translation to add
- id string -
- payload CustomObjectsRecords1 - The record to add (just include the JSON object as the request body)
Return Type
- CustomObjectsRecords[]|error - Request succeeded.
getCustomObjectsRecordsBySearch
Isolated FunctionRemote Function
function getCustomObjectsRecordsBySearch(string objectName, string? fieldName, string? fieldValue, string? updatedAfterUtc, boolean brief, int? skip, int? top, boolean countTotal) returns CustomObjectsRecords[]|errorGets 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
- CustomObjectsRecords[]|error - Request succeeded.
getCustomFields
Isolated FunctionRemote Function
function getCustomFields(string objectName) returns APICustomFieldMetadata[]|errorGets a list of Custom Fields
Parameters
- objectName string -
Return Type
- APICustomFieldMetadata[]|error - Request succeeded.
getCustomfieldBySearch
Isolated FunctionRemote Function
function getCustomfieldBySearch(string objectName, string fieldName) returns CustomFieldMetadata|errorGets a Custom Field by name
Return Type
- CustomFieldMetadata|error - Request succeeded.
getCustomObjects
Isolated FunctionRemote Function
function getCustomObjects() returns APICustomObject[]|errorGets a list of custom objects
Return Type
- APICustomObject[]|error - Request succeeded.
getCustomObject
Isolated FunctionRemote Function
function getCustomObject(string customObjectName) returns CustomObject|errorGets a custom object by object name
Parameters
- customObjectName string - The custom object name
Return Type
- CustomObject|error - Request succeeded.
Records
insightly.custom: APICustomField
Fields
- FIELD_NAME? string -
- FIELD_VALUE? record {} -
insightly.custom: APICustomFieldDependency
Fields
- CONTROLLING_FIELD_ID? string -
- OPTIONS_FILTERS? APICustomFieldOptionsFilter[] -
insightly.custom: APICustomFieldMetadata
Fields
- FIELD_NAME string -
- FIELD_ORDER int -
- FIELD_FOR string -
- FIELD_LABEL string -
- FIELD_TYPE string -
- FIELD_HELP_TEXT? string -
- DEFAULT_VALUE? string -
- EDITABLE? boolean -
- VISIBLE? boolean -
- CUSTOM_FIELD_OPTIONS? APICustomFieldOption[] -
- DEPENDENCY? APICustomFieldDependency -
- JOIN_OBJECT? string -
insightly.custom: APICustomFieldOption
Fields
- OPTION_ID? int -
- OPTION_VALUE string -
- OPTION_DEFAULT boolean -
insightly.custom: APICustomFieldOptionsFilter
Fields
- CONTROLLING_VALUE? string -
- OPTION_IDS? int[] -
insightly.custom: APICustomObject
Fields
- OBJECT_NAME? string -
- SINGULAR_LABEL? string -
- PLURAL_LABEL? string -
- DESCRIPTION? string -
- RECORD_NAME_LABEL? string -
- RECORD_NAME_TYPE? string -
- RECORD_NAME_DISPLAY_FORMAT? string -
- ENABLE_NAVBAR? boolean -
- ENABLE_WORKFLOWS? boolean -
- CREATED_USER_ID? int -
- DATE_CREATED_UTC? string -
- DATE_UPDATED_UTC? string -
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
- proxy? ProxyConfig - Proxy server related options
insightly.custom: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- 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-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- 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
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
insightly.custom: CustomFieldMetadata
Fields
- FIELD_NAME string -
- FIELD_ORDER int -
- FIELD_FOR string -
- FIELD_LABEL string -
- FIELD_TYPE string -
- FIELD_HELP_TEXT? string -
- DEFAULT_VALUE? string -
- EDITABLE? boolean -
- VISIBLE? boolean -
- CUSTOM_FIELD_OPTIONS? APICustomFieldOption[] -
- DEPENDENCY? APICustomFieldDependency -
- JOIN_OBJECT? string -
insightly.custom: CustomObject
Fields
- OBJECT_NAME? string -
- SINGULAR_LABEL? string -
- PLURAL_LABEL? string -
- DESCRIPTION? string -
- RECORD_NAME_LABEL? string -
- RECORD_NAME_TYPE? string -
- RECORD_NAME_DISPLAY_FORMAT? string -
- ENABLE_NAVBAR? boolean -
- ENABLE_WORKFLOWS? boolean -
- CREATED_USER_ID? int -
- DATE_CREATED_UTC? string -
- DATE_UPDATED_UTC? string -
insightly.custom: CustomObjectsRecords
Fields
- RECORD_ID? int -
- RECORD_NAME string -
- OWNER_USER_ID? int -
- DATE_CREATED_UTC? string -
- VISIBLE_TO? string -
- VISIBLE_TEAM_ID? int -
- CUSTOMFIELDS? APICustomField[] -
insightly.custom: Customobjectsrecords1
Fields
- RECORD_NAME string -
- OWNER_USER_ID? int -
- VISIBLE_TO? string -
- VISIBLE_TEAM_ID? int -
- CUSTOMFIELDS? APICustomField[] -
insightly.custom: CustomObjectsRecords1
Fields
- RECORD_NAME string -
- OWNER_USER_ID? int -
- VISIBLE_TO? string -
- VISIBLE_TEAM_ID? int -
- CUSTOMFIELDS? APICustomField[] -
insightly.custom: Customobjectsrecords2
Fields
- RECORD_NAME string -
- OWNER_USER_ID? int -
- VISIBLE_TO? string -
- VISIBLE_TEAM_ID? int -
- CUSTOMFIELDS? APICustomField[] -
insightly.custom: Customobjectsrecords3
Fields
- RECORD_NAME string -
- OWNER_USER_ID? int -
- VISIBLE_TO? string -
- VISIBLE_TEAM_ID? int -
- CUSTOMFIELDS? APICustomField[] -
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
Array types
insightly.custom: CustomObjectsRecordsArr
CustomObjectsRecordsArr
insightly.custom: APICustomFieldMetadataArr
APICustomFieldMetadataArr
insightly.custom: APICustomObjectArr
APICustomObjectArr