Classes CategoryUsageFileResource ⇐ GenericResource The CategoryUsageFileResource class provides methods to access the categor objects for a usage file. UsageFileResource ⇐ GenericResource The UsageFileResource class provides methods to access the usage file endpoint of the Cloud Blue Connect API. CategoryUsageFileResource ⇐ GenericResource The CategoryUsageFileResource class provides methods to access the categor objects for a usage file….
Read More
ConnectClient ConnectClient provides access to resouce endpoints of the Cloud Blue Connect Platform. Kind: global class Category: Base ConnectClient new ConnectClient(endpoint, apiKey, adapter) .accounts : AccountResource .assets : AssetResource .billingRequests : BillingRequestResource .conversations : ConversationResource .products : ProductResource .requests : RequestResource .hubs : HubResource .recurringAssets : RecurringAssetResource .tierAccounts : TierAccountResource .tierAccountRequests : TierAccountRequestResource .tierConfigs :…
Read More
Classes MessageResource ⇐ GenericResource The MessageResources class provides methods to access the attachment objects for a case. ConversationResource ⇐ GenericResource The ConversationResource class provides methods to access the conversations endpoint of the Cloud Blue Connect API. MessageResource ⇐ GenericResource The MessageResources class provides methods to access the attachment objects for a case. Kind: global class…
Read More
Classes AbstractHttpAdapter The AbstractHttpAdapter class allow a CloudBlue Connect SDK consumer to wrap a preferred http client library and adapt requests and responses to in order to work with this SDK. DefaultHttpAdapter ⇐ AbstractHttpAdapter The DefaultHttpAdapter is the default adapter used in the CloudBlue Connect Javascript SDK based on the node-fetch http client library. AbstractHttpAdapter…
Read More
Directory The Directory class exposes specialized methods to help developers to access the directory (assets, tier configs, tier accounts). Kind: global class Category: Operations Directory new Directory(client) .searchAssets(query) ⇒ Array .searchTierConfigurations(query) ⇒ Array .searchTierAccounts(query) ⇒ Array .getTierAccount(id) ⇒ object .getAssetsByProductIdExternalId(productId, externalId) ⇒ Array .createTierAccountRequest(request) ⇒ object .searchTierAccountRequests(query) ⇒ Array .getTierAccountRequest(id) ⇒ object .acceptTierAccountRequest(id) ⇒ object…
Read More
Fulfillment The Fullfilment class exposes specialized methods to help developers to achive common use cases for the fulfillment workflow. Kind: global class Category: Operations Fulfillment new Fulfillment(client) .searchRequests(query) ⇒ Array .failRequest(id, reason) ⇒ object .updateRequest(id, request) ⇒ object .createRequest(request) .updateRequestParameters(id, params, note) ⇒ object .inquireRequest(id, request, params, note) ⇒ object .inquireRequestWithTemplate(id, templateId, params, note) ⇒…
Read More
GenericResource The GenericResource map a generic endpoint of the CloudBlue Connect API. Each API endpoint should extend this class and implements endpoint specific actions and subresources access. Kind: global class Category: Resources GenericResource new GenericResource(client, baseUri) .baseUri : string .get(id) ⇒ object .create(obj) ⇒ object .update(id, obj) ⇒ object .delete(id) .search(filters) ⇒ Array .fetch(url, options)…
Read More
Classes HttpError ⇐ Error HttpError wraps any http response which status is != 2xx. APIError ⇐ HttpError APIError wraps CloudBlue Connect API errors. Provides convenient methods to obtains error code and error messages. The Cloud Blue Connect JSON error looks like: HttpError ⇐ Error HttpError wraps any http response which status is != 2xx. Kind:…
Read More
HubResource ⇐ GenericResource The HubResource class provides methods to access the hubs endpoint of the Cloud Blue Connect API. Kind: global class Extends: GenericResource Category: Resources new HubResource(client) Creates a new instance of the HubResource class. Returns: HubResource – An instance of the HubResource class. Param Type Description client ConnectClient An instance of the ConnectClient…
Read More
Inventory The Inventory class exposes specialized methods to help developers to access the inventory (products, items etc). Kind: global class Category: Operations Inventory new Inventory(client) .getParametersByProduct(id) ⇒ Array .getAssetParametersForFulfillmentByProduct(id) ⇒ Array .getProductTemplates(id) ⇒ Array .getProductAssetTemplates(id) ⇒ Array .getProductActionLink(id, actionId, assetId) ⇒ Array .searchProductParameters(productId, query) ⇒ Array new Inventory(client) Creates an instance of the Inventory class….
Read More
ListingRequestResource ⇐ GenericResource The ListingRequestResource class provides methods to access the listing requests endpoint of the Cloud Blue Connect API. Kind: global class Extends: GenericResource Category: Resources ListingRequestResource ⇐ GenericResource new ListingRequestResource(client) .cancel(id) .complete(id) .deploy(id) .refine(id) .submit(id) new ListingRequestResource(client) Creates a new instance of the ListingRequestResource class. Returns: ListingRequestResource – An instance of the ListingRequestResource…
Read More
Listings The Listings class exposes specialized methods to help developers to handle listings and listing requests. Kind: global class Category: Operations Listings new Listings(client) .searchListingRequests(query) ⇒ Array .createListingRequest(request) ⇒ object .getListingRequest(id) ⇒ object .submitListingRequest(id) ⇒ object .cancelListingRequest(id) ⇒ object .refineListingRequest(id) ⇒ object .completeListingRequest(id) ⇒ object .deployListingRequest(id) ⇒ object new Listings(client) Creates an instance of the…
Read More
Classes MessageResource ⇐ GenericResource The MessageResources class provides methods to access the attachment objects for a case. ConversationResource ⇐ GenericResource The ConversationResource class provides methods to access the conversations endpoint of the Cloud Blue Connect API. MessageResource ⇐ GenericResource The MessageResources class provides methods to access the attachment objects for a case. Kind: global class…
Read More
Classes ProductActionResource The ProductActionResource class provides methods to access the Action objects for a product. ProductVersionResource ⇐ GenericResource The ProductVersionResource class provides methods to access the Version objects for a product. ProductConfigurationResource ⇐ GenericResource The ProductConfigurationResource class provides methods to access the ProductConfiguration objects for a product. ProductParameterResource ⇐ GenericResource The ProductParameterResource class provides methods…
Read More
Classes ProductActionResource The ProductActionResource class provides methods to access the Action objects for a product. ProductVersionResource ⇐ GenericResource The ProductVersionResource class provides methods to access the Version objects for a product. ProductConfigurationResource ⇐ GenericResource The ProductConfigurationResource class provides methods to access the ProductConfiguration objects for a product. ProductParameterResource ⇐ GenericResource The ProductParameterResource class provides methods…
Read More
