Constructor
# new ConnectClient(endpoint, apiKey, adapter) → {ConnectClient}
Creates a new instance of the Cloud Blue ConnectClient class. Configures the beforeRequest hooks to inject the API key in the Authorizaton header and prefixes the url with the API's base url.
Parameters:
| Name | Type | Description |
|---|---|---|
endpoint |
string | The base URL for API access. |
apiKey |
string | The API key to authenticate with Connect. |
adapter |
AbstractHttpAdapter | An optional adapter. |
An instance of the ConnectClient class.
Members
# accounts
Returns an instance of the AccountResource class to access the Account resource endpoint.
# assets
Returns an instance of the AssetResource class to access the Asset resource endpoint.
# billingRequests
Returns an instance of the BillingRequestResource class to access the BillingRequest resource endpoint.
# cases
Returns an instance of the CaseResource class to access the HelpdesCase resource endpoint.
# conversations
Returns an instance of the ConversationResource class to access the Conversation resource endpoint.
# hubs
Returns an instance of the HubResource class to access the Hub resource endpoint.
# listingRequests
Returns an instance of the ListingRequestResource class to access the ListingRequest resource endpoint.
# products
Returns an instance of the ProductResource class to access the Product resource endpoint.
# recurringAssets
Returns an instance of the RecurringAssetResource class to access the RecurringAsset resource endpoint.
# requests
Returns an instance of the RequestResource class to access the Request resource endpoint.
# tierAccountRequests
Returns an instance of the TierAccountRequestResource class to access the TierAccountRequest resource endpoint.
# tierAccounts
Returns an instance of the TierAccountResource class to access the TierAccount resource endpoint.
# tierConfigRequests
Returns an instance of the TierConfigRequestResource class to access the TierConfigurationRequest resource endpoint.
# tierConfigs
Returns an instance of the TierConfigResource class to access the TierConfiguration resource endpoint.
# usageAggregates
Returns an instance of the UsageAggregateResource class to access the UsageFile resource endpoint.
# usageChunks
Returns an instance of the UsageChunkResource class to access the UsageChunk resource endpoint.
# usageFiles
Returns an instance of the UsageFileResource class to access the UsageFile resource endpoint.
# usageReconciliations
Returns an instance of the UsageReconciliationResource class to access the UsageReconciliation resource endpoint.
# usageRecords
Returns an instance of the UsagerecordResource class to access the UsageRecord resource endpoint.
# webhooks
Returns an instance of the WebhookResource class to access the Webhook resource endpoint.