hubspot.crm.lineitem
Module hubspot.crm.lineitem
API
Definitions
ballerinax/hubspot.crm.lineitem Ballerina library
Overview
This is a generated connector from HubSpot OpenAPI specification.
This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the CRM Object Properties API.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a HubSpot developer account
- Obtain tokens
- Use this guide to obtain the credentials which are needed to create the <CLIENT_ID> and <CLIENT_SECRET>
Quickstart
To use the HubSpot CRM Lineitems connector in your Ballerina application, update the .bal file as follows:
Step 1 - Import connector
First, import the ballerinax/hubspot.crm.lineitem module into the Ballerina project.
import ballerinax/hubspot.crm.lineitem;
Step 2 - Create a new connector instance
You can now make the connection configuration using the access token.
lineitem:ClientConfig clientConfig = { auth : { token: <ACCESS_TOKEN> } }; lineitem:Client baseClient = check new Client(clientConfig);
Step 3 - Invoke connector operation
- Create a line-item instance
lineitem:SimplePublicObjectInput lineitem = { properties : { "name": "1 year implementation consultation", "hs_recurring_billing_period": "P24M", "recurringbillingfrequency": "monthly", "quantity": "2", "price": "6000.00" } }; lineitem:SimplePublicObject|error bEvent = baseClient->create(lineitem); if (bEvent is lineitem:SimplePublicObject) { log:printInfo("Created the line-item" + bEvent.toString()); } else { log:printError(msg = bEvent.message()); }
Step 3 - Invoke connector operation
- List line-items
lineitem:CollectionResponseSimplePublicObjectWithAssociationsForwardPaging|error bEvent = baseClient->getPage(); if (bEvent is lineitem:CollectionResponseSimplePublicObjectWithAssociationsForwardPaging) { log:printInfo("Line-item list" + bEvent.toString()); } else { log:printError(msg = bEvent.message()); }
- Use
bal run
command to compile and run the Ballerina program
Clients
hubspot.crm.lineitem: Client
This is a generated connector from HubSpot OpenAPI specification. This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the CRM Object Properties API.
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a HubSpot account and obtain OAuth tokens following this guide.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.hubapi.com/" - URL of the target service
getPage
function getPage(int 'limit, string? after, string[]? properties, string[]? associations, boolean archived) returns CollectionResponseSimplePublicObjectWithAssociationsForwardPaging|error
List
Parameters
- 'limit int (default 10) - The maximum number of results to display per page.
- after string? (default ()) - The paging cursor token of the last successfully read resource will be returned as the
paging.next.after
JSON property of a paged response containing more results.
- properties string[]? (default ()) - A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- associations string[]? (default ()) - A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- archived boolean (default false) - Whether to return only results that have been archived.
Return Type
- CollectionResponseSimplePublicObjectWithAssociationsForwardPaging|error - successful operation
create
function create(SimplePublicObjectInput payload) returns SimplePublicObject|error
Create
Parameters
- payload SimplePublicObjectInput -
Return Type
- SimplePublicObject|error - successful operation
batchArchiveArchive
function batchArchiveArchive(BatchInputSimplePublicObjectId payload) returns Response|error
Archive a batch of line items by ID
Parameters
- payload BatchInputSimplePublicObjectId -
batchCreateCreate
function batchCreateCreate(BatchInputSimplePublicObjectInput payload) returns BatchResponseSimplePublicObject|BatchResponseSimplePublicObjectWithErrors|error
Create a batch of line items
Parameters
- payload BatchInputSimplePublicObjectInput -
Return Type
- BatchResponseSimplePublicObject|BatchResponseSimplePublicObjectWithErrors|error - successful operation
batchReadRead
function batchReadRead(BatchReadInputSimplePublicObjectId payload, boolean archived) returns BatchResponseSimplePublicObject|BatchResponseSimplePublicObjectWithErrors|error
Read a batch of line items by internal ID, or unique property values
Parameters
- payload BatchReadInputSimplePublicObjectId -
- archived boolean (default false) - Whether to return only results that have been archived.
Return Type
- BatchResponseSimplePublicObject|BatchResponseSimplePublicObjectWithErrors|error - successful operation
batchUpdateUpdate
function batchUpdateUpdate(BatchInputSimplePublicObjectBatchInput payload) returns BatchResponseSimplePublicObject|BatchResponseSimplePublicObjectWithErrors|error
Update a batch of line items
Parameters
- payload BatchInputSimplePublicObjectBatchInput -
Return Type
- BatchResponseSimplePublicObject|BatchResponseSimplePublicObjectWithErrors|error - successful operation
doSearch
function doSearch(PublicObjectSearchRequest payload) returns CollectionResponseWithTotalSimplePublicObjectForwardPaging|error
Filter, Sort, and Search CRM Objects
Parameters
- payload PublicObjectSearchRequest -
Return Type
- CollectionResponseWithTotalSimplePublicObjectForwardPaging|error - successful operation
getById
function getById(string lineItemId, string[]? properties, string[]? associations, boolean archived, string? idProperty) returns SimplePublicObjectWithAssociations|error
Read
Parameters
- lineItemId string - Line item ID
- properties string[]? (default ()) - A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- associations string[]? (default ()) - A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- archived boolean (default false) - Whether to return only results that have been archived.
- idProperty string? (default ()) - The name of a property whose values are unique for this object type
Return Type
- SimplePublicObjectWithAssociations|error - successful operation
archive
Archive
Parameters
- lineItemId string - Line item ID
update
function update(string lineItemId, SimplePublicObjectInput payload, string? idProperty) returns SimplePublicObject|error
Update
Parameters
- lineItemId string - Line item ID
- payload SimplePublicObjectInput -
- idProperty string? (default ()) - The name of a property whose values are unique for this object type
Return Type
- SimplePublicObject|error - successful operation
associationsGetAll
function associationsGetAll(string lineItemId, string toObjectType, string? after, int 'limit) returns CollectionResponseAssociatedIdForwardPaging|error
List associations of a line item by type
Parameters
- lineItemId string - Line item ID
- toObjectType string - Object type to associate with
- after string? (default ()) - The paging cursor token of the last successfully read resource will be returned as the
paging.next.after
JSON property of a paged response containing more results.
- 'limit int (default 500) - The maximum number of results to display per page.
Return Type
- CollectionResponseAssociatedIdForwardPaging|error - successful operation
associationsCreate
function associationsCreate(string lineItemId, string toObjectType, string toObjectId, string associationType) returns SimplePublicObjectWithAssociations|error
Associate a line item with another object
Parameters
- lineItemId string - Line item ID
- toObjectType string - Object type to associate with
- toObjectId string - Object ID to associate
- associationType string - Type of the association
Return Type
- SimplePublicObjectWithAssociations|error - successful operation
associationsArchive
function associationsArchive(string lineItemId, string toObjectType, string toObjectId, string associationType) returns Response|error
Remove an association between two line items
Records
hubspot.crm.lineitem: AssociatedId
Fields
- id string -
- 'type string -
hubspot.crm.lineitem: BatchInputSimplePublicObjectBatchInput
Fields
- inputs SimplePublicObjectBatchInput[] -
hubspot.crm.lineitem: BatchInputSimplePublicObjectId
Fields
- inputs SimplePublicObjectId[] -
hubspot.crm.lineitem: BatchInputSimplePublicObjectInput
Fields
- inputs SimplePublicObjectInput[] -
hubspot.crm.lineitem: BatchReadInputSimplePublicObjectId
Fields
- properties string[] -
- idProperty string? -
- inputs SimplePublicObjectId[] -
hubspot.crm.lineitem: BatchResponseSimplePublicObject
Fields
- status string -
- results SimplePublicObject[] -
- requestedAt string? -
- startedAt string -
- completedAt string -
- links record {}? -
hubspot.crm.lineitem: BatchResponseSimplePublicObjectWithErrors
Fields
- status string -
- results SimplePublicObject[] -
- numErrors int? -
- errors StandardError[]? -
- requestedAt string? -
- startedAt string -
- completedAt string -
- links record {}? -
hubspot.crm.lineitem: ClientConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - 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-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
hubspot.crm.lineitem: CollectionResponseAssociatedId
Fields
- results AssociatedId[] -
- paging Paging? -
hubspot.crm.lineitem: CollectionResponseAssociatedIdForwardPaging
Fields
- results AssociatedId[] -
- paging ForwardPaging? -
hubspot.crm.lineitem: CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
Fields
- results SimplePublicObjectWithAssociations[] -
- paging ForwardPaging? -
hubspot.crm.lineitem: CollectionResponseWithTotalSimplePublicObjectForwardPaging
Fields
- total int -
- results SimplePublicObject[] -
- paging ForwardPaging? -
hubspot.crm.lineitem: Error
Fields
- message string - A human readable message describing the error along with remediation steps where appropriate
- correlationId string - A unique identifier for the request. Include this value with any error reports or support tickets
- category string - The error category
- subCategory string? - A specific category that contains more specific detail about the error
- errors ErrorDetail[]? - further information about the error
- context record {}? - Context about the error condition
- links record {}? - A map of link names to associated URIs containing documentation about the error or recommended remediation steps
hubspot.crm.lineitem: ErrorCategory
Fields
- httpStatus string -
- name string -
hubspot.crm.lineitem: ErrorDetail
Fields
- message string - A human readable message describing the error along with remediation steps where appropriate
- 'in string? - The name of the field or parameter in which the error was found.
- code string? - The status code associated with the error detail
- subCategory string? - A specific category that contains more specific detail about the error
- context record {}? - Context about the error condition
hubspot.crm.lineitem: Filter
Fields
- value string? -
- propertyName string -
- operator string -
hubspot.crm.lineitem: FilterGroup
Fields
- filters Filter[] -
hubspot.crm.lineitem: ForwardPaging
Fields
- next NextPage? -
hubspot.crm.lineitem: NextPage
Fields
- after string -
- link string? -
hubspot.crm.lineitem: Paging
Fields
- next NextPage? -
- prev PreviousPage? -
hubspot.crm.lineitem: PreviousPage
Fields
- before string -
- link string? -
hubspot.crm.lineitem: PublicObjectSearchRequest
Fields
- filterGroups FilterGroup[] -
- sorts string[] -
- query string? -
- properties string[] -
- 'limit int -
- after int -
hubspot.crm.lineitem: SimplePublicObject
Fields
- id string -
- properties record {} -
- createdAt string -
- updatedAt string -
- archived boolean? -
- archivedAt string? -
hubspot.crm.lineitem: SimplePublicObjectBatchInput
Fields
- properties record {} -
- id string -
hubspot.crm.lineitem: SimplePublicObjectId
Fields
- id string -
hubspot.crm.lineitem: SimplePublicObjectInput
Fields
- properties record {} -
hubspot.crm.lineitem: SimplePublicObjectWithAssociations
Fields
- id string -
- properties record {} -
- createdAt string -
- updatedAt string -
- archived boolean? -
- archivedAt string? -
- associations record {}? -
hubspot.crm.lineitem: StandardError
Fields
- status string -
- id string? -
- category ErrorCategory -
- subCategory record {}? -
- message string -
- errors ErrorDetail[] -
- context record {} -
- links record {} -
Import
import ballerinax/hubspot.crm.lineitem;
Metadata
Released date: over 2 years ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Freemium
Contributors
Dependencies