hubspot.crm.quote
Module hubspot.crm.quote
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_hubspot.crm.quote_2.0.0.png)
ballerinax/hubspot.crm.quote 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 API keys related to your account.
Quickstart
To use the HubSpot CRM Quotes connector in your Ballerina application, update the .bal file as follows:
Step 1 - Import connector
First, import the ballerinax/hubspot.crm.quote module into the Ballerina project.
import ballerinax/hubspot.crm.quote;
Step 2 - Create a new connector instance
You can now make the connection configuration using the access token.
quote:ApiKeysConfig config = { hapikey : "<your apiKey>" }; quote:Client baseClient = check new Client(clientConfig);
Step 3 - Invoke connector operation
- List quotes
quote:SimplePublicObjectWithAssociationsArray|error bEvent = baseClient->getPage(); if (bEvent is quote:SimplePublicObjectWithAssociationsArray) { log:printInfo("Quote list" + bEvent.toString()); } else { log:printError(msg = bEvent.message()); }
- Use
bal run
command to compile and run the Ballerina program
Clients![](/images/permalink.svg)
hubspot.crm.quote: Client![](/images/permalink.svg)
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![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a HubSpot account and obtain the API Key following this guide.
init (ApiKeysConfig apiKeyConfig, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.hubapi.com" - URL of the target service
getPage![](/images/permalink.svg)
function getPage(int 'limit, string? after, string[]? properties, string[]? associations, boolean archived) returns SimplePublicObjectWithAssociationsArray|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
- SimplePublicObjectWithAssociationsArray|error - successful operation
batchRead![](/images/permalink.svg)
function batchRead(SimplePublicObjectIdReadArray payload, boolean archived) returns SimplePublicObjectBatchWithErrors|SimplePublicObjectBatch|error
Read a batch of quotes by internal ID, or unique property values
Parameters
- payload SimplePublicObjectIdReadArray - Object which contains array of internal IDs of quotes
- archived boolean (default false) - Whether to return only results that have been archived.
Return Type
- SimplePublicObjectBatchWithErrors|SimplePublicObjectBatch|error - successful operation
doSearch![](/images/permalink.svg)
function doSearch(PublicObjectSearchRequest payload) returns SimplePublicObjectWithForwardPaging|error
Filter, Sort, and Search CRM Objects
Parameters
- payload PublicObjectSearchRequest - Quote search request
Return Type
- SimplePublicObjectWithForwardPaging|error - successful operation
getObjectById![](/images/permalink.svg)
function getObjectById(string quoteId, string[]? properties, string[]? associations, boolean archived, string? idProperty) returns SimplePublicObjectWithAssociations|error
Read
Parameters
- quoteId string - Quote 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
associationsGetAll![](/images/permalink.svg)
function associationsGetAll(string quoteId, string toObjectType, string? after, int 'limit) returns AssociatedIdArrayWithForwardPaging|error
List associations of a quote by type
Parameters
- quoteId string - Quote ID
- toObjectType string - Object type
- 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
- AssociatedIdArrayWithForwardPaging|error - successful operation
Records![](/images/permalink.svg)
hubspot.crm.quote: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- hapikey string - Represents API Key
hapikey
hubspot.crm.quote: AssociatedId![](/images/permalink.svg)
Fields
- id string -
- 'type string -
hubspot.crm.quote: AssociatedIdArray![](/images/permalink.svg)
Fields
- results AssociatedId[] -
- paging Paging? -
hubspot.crm.quote: AssociatedIdArrayWithForwardPaging![](/images/permalink.svg)
Fields
- results AssociatedId[] -
- paging ForwardPaging? -
hubspot.crm.quote: Error![](/images/permalink.svg)
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.quote: ErrorCategory![](/images/permalink.svg)
Fields
- httpStatus string -
- name string -
hubspot.crm.quote: ErrorDetail![](/images/permalink.svg)
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.quote: Filter![](/images/permalink.svg)
Fields
- value string? -
- propertyName string -
- operator string -
hubspot.crm.quote: FilterGroup![](/images/permalink.svg)
Fields
- filters Filter[] -
hubspot.crm.quote: ForwardPaging![](/images/permalink.svg)
Fields
- next NextPage? -
hubspot.crm.quote: NextPage![](/images/permalink.svg)
Fields
- after string -
- link string? -
hubspot.crm.quote: Paging![](/images/permalink.svg)
Fields
- next NextPage? -
- prev PreviousPage? -
hubspot.crm.quote: PreviousPage![](/images/permalink.svg)
Fields
- before string -
- link string? -
hubspot.crm.quote: PublicObjectSearchRequest![](/images/permalink.svg)
Fields
- filterGroups FilterGroup[] -
- sorts string[] -
- query string? -
- properties string[] -
- 'limit int -
- after int -
hubspot.crm.quote: SimplePublicObject![](/images/permalink.svg)
Fields
- id string -
- properties record {} -
- createdAt string -
- updatedAt string -
- archived boolean? -
- archivedAt string? -
hubspot.crm.quote: SimplePublicObjectArray![](/images/permalink.svg)
Fields
- inputs SimplePublicObjectBatchInput[] -
hubspot.crm.quote: SimplePublicObjectBatch![](/images/permalink.svg)
Fields
- status string -
- results SimplePublicObject[] -
- requestedAt string? -
- startedAt string -
- completedAt string -
- links record {}? -
hubspot.crm.quote: SimplePublicObjectBatchInput![](/images/permalink.svg)
Fields
- properties record {} -
- id string -
hubspot.crm.quote: SimplePublicObjectBatchWithErrors![](/images/permalink.svg)
Fields
- status string -
- results SimplePublicObject[] -
- numErrors int? -
- errors StandardError[]? -
- requestedAt string? -
- startedAt string -
- completedAt string -
- links record {}? -
hubspot.crm.quote: SimplePublicObjectId![](/images/permalink.svg)
Fields
- id string -
hubspot.crm.quote: SimplePublicObjectIdArray![](/images/permalink.svg)
Fields
- inputs SimplePublicObjectId[] -
hubspot.crm.quote: SimplePublicObjectIdReadArray![](/images/permalink.svg)
Fields
- properties string[] -
- idProperty string? -
- inputs SimplePublicObjectId[] -
hubspot.crm.quote: SimplePublicObjectInput![](/images/permalink.svg)
Fields
- properties record {} -
hubspot.crm.quote: SimplePublicObjectInputArray![](/images/permalink.svg)
Fields
- inputs SimplePublicObjectInput[] -
hubspot.crm.quote: SimplePublicObjectWithAssociations![](/images/permalink.svg)
Fields
- id string -
- properties record {} -
- createdAt string -
- updatedAt string -
- archived boolean? -
- archivedAt string? -
- associations record {}? -
hubspot.crm.quote: SimplePublicObjectWithAssociationsArray![](/images/permalink.svg)
Fields
- results SimplePublicObjectWithAssociations[] -
- paging ForwardPaging? -
hubspot.crm.quote: SimplePublicObjectWithForwardPaging![](/images/permalink.svg)
Fields
- total int -
- results SimplePublicObject[] -
- paging ForwardPaging? -
hubspot.crm.quote: StandardError![](/images/permalink.svg)
Fields
- status string -
- id string? -
- category ErrorCategory -
- subCategory record {}? -
- message string -
- errors ErrorDetail[] -
- context record {} -
- links record {} -
Import
import ballerinax/hubspot.crm.quote;
Metadata
Released date: over 2 years ago
Version: 2.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.2
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Freemium
Contributors
Dependencies