From 21566d3dcd20932215bab18f1070efa070a9078b Mon Sep 17 00:00:00 2001 From: Travis CI Date: Thu, 5 Mar 2020 16:05:16 +0000 Subject: [PATCH] [ci skip] Documentation generated for release v19.2.2 --- .scannerwork/report-task.txt | 6 +- mddocs/002_searches.md | 213 --------- mddocs/003_Class_APIError.md | 111 ----- mddocs/004_Class_AbstractHttpAdapter.md | 64 --- mddocs/005_Class_ConnectClient.md | 130 ----- mddocs/006_Class_DefaultHttpAdapter.md | 64 --- mddocs/007_Class_HttpError.md | 111 ----- mddocs/008_Class_Directory.md | 175 ------- mddocs/009_Class_Fulfillment.md | 449 ------------------ mddocs/010_Class_Inventory.md | 76 --- mddocs/011_Class_Subscriptions.md | 106 ----- .../012_Class_ProductConfigurationResource.md | 210 -------- mddocs/013_Class_AccountUserResource.md | 59 --- mddocs/014_Class_AccountResource.md | 59 --- mddocs/015_Class_RecurringAssetResource.md | 20 - mddocs/016_Class_GenericResource.md | 107 ----- mddocs/017_Class_BillingRequestResource.md | 38 -- mddocs/018_Class_ConversationResource.md | 51 -- mddocs/019_Class_AssetResource.md | 20 - .../020_Class_TierAccountRequestResource.md | 51 -- mddocs/021_Class_ProductActionResource.md | 210 -------- mddocs/022_Class_HubResource.md | 20 - .../023_Class_TierAccountVersionResource.md | 60 --- mddocs/024_Class_ProductResource.md | 210 -------- mddocs/025_Class_TierAccountResource.md | 60 --- mddocs/026_Class_ProductVersionResource.md | 210 -------- mddocs/027_Class_RequestResource.md | 111 ----- mddocs/028_Class_TierConfigRequestResource.md | 86 ---- mddocs/029_Class_TierConfigResource.md | 20 - mddocs/030_Class_WebhookResource.md | 20 - mddocs/report.json | 253 ---------- 31 files changed, 3 insertions(+), 3377 deletions(-) delete mode 100644 mddocs/002_searches.md delete mode 100644 mddocs/003_Class_APIError.md delete mode 100644 mddocs/004_Class_AbstractHttpAdapter.md delete mode 100644 mddocs/005_Class_ConnectClient.md delete mode 100644 mddocs/006_Class_DefaultHttpAdapter.md delete mode 100644 mddocs/007_Class_HttpError.md delete mode 100644 mddocs/008_Class_Directory.md delete mode 100644 mddocs/009_Class_Fulfillment.md delete mode 100644 mddocs/010_Class_Inventory.md delete mode 100644 mddocs/011_Class_Subscriptions.md delete mode 100644 mddocs/012_Class_ProductConfigurationResource.md delete mode 100644 mddocs/013_Class_AccountUserResource.md delete mode 100644 mddocs/014_Class_AccountResource.md delete mode 100644 mddocs/015_Class_RecurringAssetResource.md delete mode 100644 mddocs/016_Class_GenericResource.md delete mode 100644 mddocs/017_Class_BillingRequestResource.md delete mode 100644 mddocs/018_Class_ConversationResource.md delete mode 100644 mddocs/019_Class_AssetResource.md delete mode 100644 mddocs/020_Class_TierAccountRequestResource.md delete mode 100644 mddocs/021_Class_ProductActionResource.md delete mode 100644 mddocs/022_Class_HubResource.md delete mode 100644 mddocs/023_Class_TierAccountVersionResource.md delete mode 100644 mddocs/024_Class_ProductResource.md delete mode 100644 mddocs/025_Class_TierAccountResource.md delete mode 100644 mddocs/026_Class_ProductVersionResource.md delete mode 100644 mddocs/027_Class_RequestResource.md delete mode 100644 mddocs/028_Class_TierConfigRequestResource.md delete mode 100644 mddocs/029_Class_TierConfigResource.md delete mode 100644 mddocs/030_Class_WebhookResource.md delete mode 100644 mddocs/report.json diff --git a/.scannerwork/report-task.txt b/.scannerwork/report-task.txt index e45912b..f98e9a7 100644 --- a/.scannerwork/report-task.txt +++ b/.scannerwork/report-task.txt @@ -2,6 +2,6 @@ organization=cloudbluesonarcube projectKey=cloudblue_connect-javascript-sdk serverUrl=https://sonarcloud.io serverVersion=8.0.0.5447 -dashboardUrl=https://sonarcloud.io/dashboard?id=cloudblue_connect-javascript-sdk&pullRequest=16 -ceTaskId=AXCrbuA8RKLUjzMW1LLh -ceTaskUrl=https://sonarcloud.io/api/ce/task?id=AXCrbuA8RKLUjzMW1LLh +dashboardUrl=https://sonarcloud.io/dashboard?id=cloudblue_connect-javascript-sdk +ceTaskId=AXCrcY_z2sxIEnSfORME +ceTaskUrl=https://sonarcloud.io/api/ce/task?id=AXCrcY_z2sxIEnSfORME diff --git a/mddocs/002_searches.md b/mddocs/002_searches.md deleted file mode 100644 index 2c73470..0000000 --- a/mddocs/002_searches.md +++ /dev/null @@ -1,213 +0,0 @@ -## Resource Query Language - -The *CloudBlue Connect* public API supports the RQL query language to search, sort and paginate objects. - -A RQL query is a Javascript object that is defined according to the following typescript syntax: - -``` -interface IRQLFilter { - $eq?: string|number, - $ne?: string|number, - $not?: IRQLFilter, - $gt?: number, - $ge?: number, - $lt?: number, - $le?: number, - $like?: string, - $ilike?: string, - $empty?: boolean, - $null?: boolean, - $in?: Array, - $out?: Array, - $range?: { - min: number, - max: number, - }, -} - - -interface IQueryFilters { - $or?: Array; - $ordering?: Array; - limit?: number; - offset?: number; - [key: string]?: string|number|Array|boolean|IRQLFilter; -} -``` - -## Examples - -### Simple filter - -``` -const filter = { - name: 'eugene', - age: 13, -}; -``` - -### Filter with text matching - -``` -const filter = { - name: { - $like: 'vasya*', - $ilike: '***New', - }, -}; -``` - -### Filter with list - -``` -const filter = { - age: { - $out: [1, 2], - }, - num: { - $in: [3, 4, 5], - }, -}; -``` - -### Filter with range - -``` -const filter = { - age: { - $range: { - max: 5, - min: 9, - }, - }, -}; -``` - -### Filter with relational - -``` -const filter = { - name: { - $eq: 'vasya', - }, - age: { - $gt: 1, - $lt: 8, - }, - num: { - $lte: 9, - $gte: 4, - }, -}; -``` - -### Filter with logical NOT - -``` -const filter = { - name: { - $not: [{ - $eq: 'vasya', - }, { - $eq: 'petya', - }], - }, - age: { - $not: { - $eq: 10, - $in: [1, 2, 3], - }, - }, -}; -``` - -### Filter with logical OR - -``` -const filter = { - // You can use $or inside field - color: { - $or: [ - // Inside { } may be some conditions and for all them is used logical operator AND - { $eq: 'red' }, - { $eq: 'blue' }, - { $eq: 'yellow' }, - ], - }, - - - // Also you can use $or in root level, then inside must be objects array with fields name - $or: [ - // Inside { } may be some fields with conditions and for all them is used logical operator AND - { product: 'TV' }, - { product: 'Computer' }, - ], -}; -``` - -### Combine AND and OR filter - -``` -const filter = { - $and: [ - {$or: [ - {status: 'new'}, - {type: 'program'} - ]}, - {$or: [ - {status: 'done'}, - {type: 'service'} - ]}, - ] -}; -``` - -### Filter with control operators - -``` -const controlFilter = { - limit: 100, - offset: 0, - $ordering: '-created', -}; -``` - -### Filter with empty values - -``` -// If values are empty, null, undefined then they will not be in the query. -const filter = { - $ordering: [], - name: '', - age: null, - $or: [{name: undefined}], - type: 'pending', -}; -``` - -### Combined - -``` -const combinationFilter = { - offset: 0, - limit: 10, - $ordering: ['title', '-created'], - $or: [ - { - type: 'distribution', - owner: { $eq: 'me' }, - }, - { - type: { $in: ['sourcing', 'service'] }, - owner: { $not: { $eq: 'me' } }, - }, - ], - name: { - $or: [ - { $like: 'my test' }, - { $like: 'my' }, - { $ilike: '***CONTRACT' }, - ], - }, -}; -``` diff --git a/mddocs/003_Class_APIError.md b/mddocs/003_Class_APIError.md deleted file mode 100644 index 94446b7..0000000 --- a/mddocs/003_Class_APIError.md +++ /dev/null @@ -1,111 +0,0 @@ -## 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**: global class -**Extends**: Error -**Category**: Base - -* [HttpError](#HttpError) ⇐ Error - * [new HttpError(status, message)](#new_HttpError_new) - * [.status](#HttpError+status) : number - - - -### new HttpError(status, message) -Create a new instance of the HttpError class. - - -| Param | Type | Description | -| --- | --- | --- | -| status | number | the http status code. | -| message | string | an error message. | - - - -### httpError.status : number -The http status code. - -**Kind**: instance property of [HttpError](#HttpError) - - -## APIError ⇐ [HttpError](#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: - -**Kind**: global class -**Extends**: [HttpError](#HttpError) -**Category**: Base - -* [APIError](#APIError) ⇐ [HttpError](#HttpError) - * [new APIError(status, message)](#new_APIError_new) - * [.json](#APIError+json) ⇒ object - * [.errorCode](#APIError+errorCode) ⇒ string - * [.errors](#APIError+errors) ⇒ Array - * [.status](#HttpError+status) : number - - - -### new APIError(status, message) -Create a new instance of the APIError class. - - -| Param | Type | Description | -| --- | --- | --- | -| status | number | the http status code. | -| message | string | A JSON parseable object. | - -**Example** -```js -{ - "error_code": "SYS_001", - "errors": [ - "error message 1" - ] -} -``` - - -### apiError.json ⇒ object -Returns the JSON error object. - -**Kind**: instance property of [APIError](#APIError) -**Returns**: object - The error object. - - -### apiError.errorCode ⇒ string -Returns the error code. - -**Kind**: instance property of [APIError](#APIError) -**Returns**: string - The error code. - - -### apiError.errors ⇒ Array -Returns an array of error messages. - -**Kind**: instance property of [APIError](#APIError) -**Returns**: Array - The error messages. - - -### apiError.status : number -The http status code. - -**Kind**: instance property of [APIError](#APIError) -**Overrides**: [status](#HttpError+status) diff --git a/mddocs/004_Class_AbstractHttpAdapter.md b/mddocs/004_Class_AbstractHttpAdapter.md deleted file mode 100644 index b7372ce..0000000 --- a/mddocs/004_Class_AbstractHttpAdapter.md +++ /dev/null @@ -1,64 +0,0 @@ -## 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 -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. - -**Kind**: global class -**Category**: Base - -* [AbstractHttpAdapter](#AbstractHttpAdapter) - * [new AbstractHttpAdapter(fetch)](#new_AbstractHttpAdapter_new) - * [.beforeRequest](#AbstractHttpAdapter+beforeRequest) ⇒ Array - - - -### new AbstractHttpAdapter(fetch) -Create a subclass of AbstractHttpAdapter - - -| Param | Type | Description | -| --- | --- | --- | -| fetch | function | the fetch function used to make the actual http call. | - - - -### abstractHttpAdapter.beforeRequest ⇒ Array -Get or set a list of beforeRequest hook functions. - -**Kind**: instance property of [AbstractHttpAdapter](#AbstractHttpAdapter) -**Returns**: Array - Array of hooks. - - -## DefaultHttpAdapter ⇐ [AbstractHttpAdapter](#AbstractHttpAdapter) -The *DefaultHttpAdapter* is the default adapter used in the -CloudBlue Connect Javascript SDK based on the node-fetch http -client library. - -**Kind**: global class -**Extends**: [AbstractHttpAdapter](#AbstractHttpAdapter) -**Category**: Base - - -### defaultHttpAdapter.beforeRequest ⇒ Array -Get or set a list of beforeRequest hook functions. - -**Kind**: instance property of [DefaultHttpAdapter](#DefaultHttpAdapter) -**Overrides**: [beforeRequest](#AbstractHttpAdapter+beforeRequest) -**Returns**: Array - Array of hooks. diff --git a/mddocs/005_Class_ConnectClient.md b/mddocs/005_Class_ConnectClient.md deleted file mode 100644 index 6081f3d..0000000 --- a/mddocs/005_Class_ConnectClient.md +++ /dev/null @@ -1,130 +0,0 @@ - - -## ConnectClient -*ConnectClient* provides access to resouce endpoints of the Cloud Blue Connect Platform. - -**Kind**: global class -**Category**: Base - -* [ConnectClient](#ConnectClient) - * [new ConnectClient(endpoint, apiKey, adapter)](#new_ConnectClient_new) - * [.accounts](#ConnectClient+accounts) : AccountResource - * [.assets](#ConnectClient+assets) : AssetResource - * [.billingRequests](#ConnectClient+billingRequests) : BillingRequestResource - * [.conversations](#ConnectClient+conversations) : ConversationResource - * [.products](#ConnectClient+products) : ProductResource - * [.requests](#ConnectClient+requests) : RequestResource - * [.hubs](#ConnectClient+hubs) : HubResource - * [.recurringAssets](#ConnectClient+recurringAssets) : RecurringAssetResource - * [.tierAccounts](#ConnectClient+tierAccounts) : TierAccountResource - * [.tierAccountRequests](#ConnectClient+tierAccountRequests) : TierAccountRequestResource - * [.tierConfigs](#ConnectClient+tierConfigs) : TierConfigResource - * [.tierConfigRequests](#ConnectClient+tierConfigRequests) : TierConfigRequestResource - * [.webhooks](#ConnectClient+webhooks) : WebhookResource - - - -### new ConnectClient(endpoint, apiKey, adapter) -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. - -**Returns**: [ConnectClient](#ConnectClient) - An instance of the ConnectClient class. - -| Param | Type | Description | -| --- | --- | --- | -| endpoint | string | The base URL for API access. | -| apiKey | string | The API key to authenticate with Connect. | -| adapter | AbstractHttpAdapter | An optional adapter. | - - - -### connectClient.accounts : AccountResource -Returns an instance of the *AccountResource* class to access -the *Account* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.assets : AssetResource -Returns an instance of the *AssetResource* class to access -the *Asset* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.billingRequests : BillingRequestResource -Returns an instance of the *BillingRequestResource* class to access -the *BillingRequest* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.conversations : ConversationResource -Returns an instance of the *ConversationResource* class to access -the *Conversation* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.products : ProductResource -Returns an instance of the *ProductResource* class to access -the *Product* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.requests : RequestResource -Returns an instance of the *RequestResource* class to access -the *Request* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.hubs : HubResource -Returns an instance of the *HubResource* class to access -the *Hub* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.recurringAssets : RecurringAssetResource -Returns an instance of the *RecurringAssetResource* class to access -the *RecurringAsset* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.tierAccounts : TierAccountResource -Returns an instance of the *TierAccountResource* class to access -the *TierAccount* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.tierAccountRequests : TierAccountRequestResource -Returns an instance of the *TierAccountRequestResource* class to access -the *TierAccountRequest* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.tierConfigs : TierConfigResource -Returns an instance of the *TierConfigResource* class to access -the *TierConfiguration* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.tierConfigRequests : TierConfigRequestResource -Returns an instance of the *TierConfigRequestResource* class to access -the *TierConfigurationRequest* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) - - -### connectClient.webhooks : WebhookResource -Returns an instance of the *WebhookResource* class to access -the *Webhook* resource endpoint. - -**Kind**: instance property of [ConnectClient](#ConnectClient) diff --git a/mddocs/006_Class_DefaultHttpAdapter.md b/mddocs/006_Class_DefaultHttpAdapter.md deleted file mode 100644 index b7372ce..0000000 --- a/mddocs/006_Class_DefaultHttpAdapter.md +++ /dev/null @@ -1,64 +0,0 @@ -## 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 -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. - -**Kind**: global class -**Category**: Base - -* [AbstractHttpAdapter](#AbstractHttpAdapter) - * [new AbstractHttpAdapter(fetch)](#new_AbstractHttpAdapter_new) - * [.beforeRequest](#AbstractHttpAdapter+beforeRequest) ⇒ Array - - - -### new AbstractHttpAdapter(fetch) -Create a subclass of AbstractHttpAdapter - - -| Param | Type | Description | -| --- | --- | --- | -| fetch | function | the fetch function used to make the actual http call. | - - - -### abstractHttpAdapter.beforeRequest ⇒ Array -Get or set a list of beforeRequest hook functions. - -**Kind**: instance property of [AbstractHttpAdapter](#AbstractHttpAdapter) -**Returns**: Array - Array of hooks. - - -## DefaultHttpAdapter ⇐ [AbstractHttpAdapter](#AbstractHttpAdapter) -The *DefaultHttpAdapter* is the default adapter used in the -CloudBlue Connect Javascript SDK based on the node-fetch http -client library. - -**Kind**: global class -**Extends**: [AbstractHttpAdapter](#AbstractHttpAdapter) -**Category**: Base - - -### defaultHttpAdapter.beforeRequest ⇒ Array -Get or set a list of beforeRequest hook functions. - -**Kind**: instance property of [DefaultHttpAdapter](#DefaultHttpAdapter) -**Overrides**: [beforeRequest](#AbstractHttpAdapter+beforeRequest) -**Returns**: Array - Array of hooks. diff --git a/mddocs/007_Class_HttpError.md b/mddocs/007_Class_HttpError.md deleted file mode 100644 index 94446b7..0000000 --- a/mddocs/007_Class_HttpError.md +++ /dev/null @@ -1,111 +0,0 @@ -## 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**: global class -**Extends**: Error -**Category**: Base - -* [HttpError](#HttpError) ⇐ Error - * [new HttpError(status, message)](#new_HttpError_new) - * [.status](#HttpError+status) : number - - - -### new HttpError(status, message) -Create a new instance of the HttpError class. - - -| Param | Type | Description | -| --- | --- | --- | -| status | number | the http status code. | -| message | string | an error message. | - - - -### httpError.status : number -The http status code. - -**Kind**: instance property of [HttpError](#HttpError) - - -## APIError ⇐ [HttpError](#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: - -**Kind**: global class -**Extends**: [HttpError](#HttpError) -**Category**: Base - -* [APIError](#APIError) ⇐ [HttpError](#HttpError) - * [new APIError(status, message)](#new_APIError_new) - * [.json](#APIError+json) ⇒ object - * [.errorCode](#APIError+errorCode) ⇒ string - * [.errors](#APIError+errors) ⇒ Array - * [.status](#HttpError+status) : number - - - -### new APIError(status, message) -Create a new instance of the APIError class. - - -| Param | Type | Description | -| --- | --- | --- | -| status | number | the http status code. | -| message | string | A JSON parseable object. | - -**Example** -```js -{ - "error_code": "SYS_001", - "errors": [ - "error message 1" - ] -} -``` - - -### apiError.json ⇒ object -Returns the JSON error object. - -**Kind**: instance property of [APIError](#APIError) -**Returns**: object - The error object. - - -### apiError.errorCode ⇒ string -Returns the error code. - -**Kind**: instance property of [APIError](#APIError) -**Returns**: string - The error code. - - -### apiError.errors ⇒ Array -Returns an array of error messages. - -**Kind**: instance property of [APIError](#APIError) -**Returns**: Array - The error messages. - - -### apiError.status : number -The http status code. - -**Kind**: instance property of [APIError](#APIError) -**Overrides**: [status](#HttpError+status) diff --git a/mddocs/008_Class_Directory.md b/mddocs/008_Class_Directory.md deleted file mode 100644 index c089a55..0000000 --- a/mddocs/008_Class_Directory.md +++ /dev/null @@ -1,175 +0,0 @@ - - -## 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](#Directory) - * [new Directory(client)](#new_Directory_new) - * [.searchAssets(query)](#Directory+searchAssets) ⇒ Array - * [.searchTierConfigurations(query)](#Directory+searchTierConfigurations) ⇒ Array - * [.searchTierAccounts(query)](#Directory+searchTierAccounts) ⇒ Array - * [.getTierAccount(id)](#Directory+getTierAccount) ⇒ object - * [.getAssetsByProductIdExternalId(productId, externalId)](#Directory+getAssetsByProductIdExternalId) ⇒ Array - * [.createTierAccountRequest(request)](#Directory+createTierAccountRequest) ⇒ object - * [.searchTierAccountRequest(query)](#Directory+searchTierAccountRequest) ⇒ Array - * [.getTierAccountRequest(id)](#Directory+getTierAccountRequest) ⇒ object - * [.acceptTierAccountRequest(id)](#Directory+acceptTierAccountRequest) ⇒ object - * [.ignoreTierAccountRequest(id)](#Directory+ignoreTierAccountRequest) ⇒ object - * [.getTierAccountVersion(id, version)](#Directory+getTierAccountVersion) ⇒ object - - - -### new Directory(client) -Creates an instance of the Directory class. - -**Returns**: [Directory](#Directory) - An instance of the Directory class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### directory.searchAssets(query) ⇒ Array -Returns a list of *Asset* objects that match the provided -(optional) query. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: Array - An array of *Asset* object optionally matching the provided query. - -| Param | Type | Description | -| --- | --- | --- | -| query | object | The optional query to filter results. | - - - -### directory.searchTierConfigurations(query) ⇒ Array -Returns a list of *TierConfiguration* objects that match the provided -(optional) query. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: Array - An array of *TierConfiguration* object optionally - matching the provided query. - -| Param | Type | Description | -| --- | --- | --- | -| query | object | The optional query to filter results. | - - - -### directory.searchTierAccounts(query) ⇒ Array -Returns a list of *TierAccount* objects that match the provided -(optional) query. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: Array - An array of *TierAccount* object optionally matching the provided query. - -| Param | Type | Description | -| --- | --- | --- | -| query | object | The optional query to filter results. | - - - -### directory.getTierAccount(id) ⇒ object -Retrieve a *TierAccount* by its id. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: object - The TierAccount object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierAccount object. | - - - -### directory.getAssetsByProductIdExternalId(productId, externalId) ⇒ Array -Returns a list of *Asset* objects based on the productId and -the *Asset* externalId. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: Array - An array of *Asset* objects. - -| Param | Type | Description | -| --- | --- | --- | -| productId | string | The unique id of the *Product* related to this *Asset*. | -| externalId | string | The external identifier of the *Asset*. | - - - -### directory.createTierAccountRequest(request) ⇒ object -Creates a new *TierAccountRequest* - -**Kind**: instance method of [Directory](#Directory) -**Returns**: object - The created TierAccountRequest object. - -| Param | Type | Description | -| --- | --- | --- | -| request | object | The TierAccountRequest object. | - - - -### directory.searchTierAccountRequest(query) ⇒ Array -Returns a list of *TierAccountRequest* objects that match the provided -filters. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: Array - An array of *TierAccountRequest* objects - that match the provided filters. - -| Param | Type | Description | -| --- | --- | --- | -| query | object | A RQL query. | - - - -### directory.getTierAccountRequest(id) ⇒ object -Retrieve the *TierAccountRequest* object identified by its id. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: object - The *TierAccountRequest* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *TierAccountRequest* object. | - - - -### directory.acceptTierAccountRequest(id) ⇒ object -Accept the *TierAccountRequest* object identified by its id. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: object - The *TierAccountRequest* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *TierAccountRequest* object. | - - - -### directory.ignoreTierAccountRequest(id) ⇒ object -Ignore the *TierAccountRequest* object identified by its id. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: object - The *TierAccountRequest* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *TierAccountRequest* object. | - - - -### directory.getTierAccountVersion(id, version) ⇒ object -Returns the specified version of the *TierAccount* object identified by its id. - -**Kind**: instance method of [Directory](#Directory) -**Returns**: object - The *TierAccount* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *TierAccount* object. | -| version | string | The version to be retrieved. | - diff --git a/mddocs/009_Class_Fulfillment.md b/mddocs/009_Class_Fulfillment.md deleted file mode 100644 index 182a9b4..0000000 --- a/mddocs/009_Class_Fulfillment.md +++ /dev/null @@ -1,449 +0,0 @@ - - -## 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](#Fulfillment) - * [new Fulfillment(client)](#new_Fulfillment_new) - * [.searchRequests(query)](#Fulfillment+searchRequests) ⇒ Array - * [.failRequest(id, reason)](#Fulfillment+failRequest) ⇒ object - * [.updateRequest(id, request)](#Fulfillment+updateRequest) ⇒ object - * [.createRequest(request)](#Fulfillment+createRequest) - * [.updateRequestParameters(id, params, note)](#Fulfillment+updateRequestParameters) ⇒ object - * [.inquireRequest(id, request, params, note)](#Fulfillment+inquireRequest) ⇒ object - * [.inquireRequestWithTemplate(id, templateId, params, note)](#Fulfillment+inquireRequestWithTemplate) ⇒ object - * [.approveRequest(id, request)](#Fulfillment+approveRequest) ⇒ object - * [.approveRequestWithTemplate(id, templateId)](#Fulfillment+approveRequestWithTemplate) ⇒ object - * [.pendingRequest(id)](#Fulfillment+pendingRequest) ⇒ object - * [.getRequest(id)](#Fulfillment+getRequest) ⇒ object - * [.searchTierConfigRequests(query)](#Fulfillment+searchTierConfigRequests) ⇒ Array - * [.failTierConfigRequest(id, reason)](#Fulfillment+failTierConfigRequest) - * [.approveTierConfigRequest(id, request)](#Fulfillment+approveTierConfigRequest) ⇒ object - * [.approveTierConfigRequestWithTemplate(id, templateId)](#Fulfillment+approveTierConfigRequestWithTemplate) ⇒ object - * [.updateTierConfigRequest(id, request)](#Fulfillment+updateTierConfigRequest) ⇒ object - * [.updateTierConfigRequestParameters(id, params, notes)](#Fulfillment+updateTierConfigRequestParameters) ⇒ object - * [.createTierConfigRequest(request)](#Fulfillment+createTierConfigRequest) - * [.createUpdateTierConfigRequest(configId, params)](#Fulfillment+createUpdateTierConfigRequest) - * [.inquireTierConfigRequest(id, params, notes)](#Fulfillment+inquireTierConfigRequest) - * [.pendingTierConfigRequest(id)](#Fulfillment+pendingTierConfigRequest) ⇒ object - * [.getTierConfigRequest(id)](#Fulfillment+getTierConfigRequest) ⇒ object - * [.getConnectionIdByProductAndHub(productId, hubId)](#Fulfillment+getConnectionIdByProductAndHub) ⇒ string \| null - - - -### new Fulfillment(client) -Creates an instance of the Fulfillment class. - -**Returns**: [Fulfillment](#Fulfillment) - An instance of the Fulfillment class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### fulfillment.searchRequests(query) ⇒ Array -Returns a list of *Request* objects that match the provided -filters. -If no filter is passed, a page of Request in 'pending' status is returned. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: Array - An array of Request objects that match the provided filters. - -| Param | Type | Description | -| --- | --- | --- | -| query | object | A RQL query. | - - - -### fulfillment.failRequest(id, reason) ⇒ object -Changes the status of the *Request* object to 'fail'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated Request object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| reason | string | The reason for which the Request has been failed. | - - - -### fulfillment.updateRequest(id, request) ⇒ object -Updates a *Request* object. -Only a partial update can be performed on a *Request* object: -developers can update only the **note** attribute of the Request and/or -the asset parameters **value** or **value_error** attributes. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated *Request* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| request | object | The body of the request. | - -**Example** -```js -{ - note: 'Test Note', - asset: { - params: [ - { - id: 'param_a', // id is required - value: 'value_of_param_a', - value_error: 'This address is already used. Try another.' - } - ] - } -} -``` - - -### fulfillment.createRequest(request) -Creates a new *Request* object. - -**Kind**: instance method of [Fulfillment](#Fulfillment) - -| Param | Type | Description | -| --- | --- | --- | -| request | object | The Request object to create. | - - - -### fulfillment.updateRequestParameters(id, params, note) ⇒ object -Updates the asset parameters of a Request object. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated Request object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| params | Array | Array of *Parameter* objects to update. | -| note | string | An optional **note** for the Request. | - - - -### fulfillment.inquireRequest(id, request, params, note) ⇒ object -Updates the *Request* object to inquire the provider -for ordering parameter. -It updates the *Parameter* object **value_error** attribute -and set the status of the *Request* to 'inquire'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated *Request* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| request | object | The request body. | -| params | Array | An array of *Parameter* objects to update. | -| note | string | An optional 'note' attribute for the Request. | - -**Example** -```js -// example of the params argument. -[ - { - id: 'param_a', // id is required - value_error: 'This address is already used. Try another.' - } -] -``` -**Example** -```js -// request body using a template id -{ - template_id: 'TL-827-840-476' -} -``` -**Example** -```js -// request body using an activation tile -{ - activation_tile: '' -} -``` - - -### fulfillment.inquireRequestWithTemplate(id, templateId, params, note) ⇒ object -Updates the *Request* object to inquire the provider -for ordering parameter using an activation template. -It updates the *Parameter* object **value_error** attribute -and set the status of the *Request* to 'inquire'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated *Request* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| templateId | string | The unique identifier of the *Template* object. | -| params | Array | An array of *Parameter* objects to update. | -| note | string | An optional 'note' attribute for the Request. | - - - -### fulfillment.approveRequest(id, request) ⇒ object -Updates the *Request* and set its status to 'approved'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated *Request* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| request | object | The request body. | - -**Example** -```js -// request body using a template id -{ - template_id: 'TL-827-840-476' -} -``` -**Example** -```js -// request body using an activation tile -{ - activation_tile: '' -} -``` - - -### fulfillment.approveRequestWithTemplate(id, templateId) ⇒ object -Updates the *Request* and set its status to 'approved' -using an activation template. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated *Request* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| templateId | string | The template id to use for *Request* approval. | - - - -### fulfillment.pendingRequest(id) ⇒ object -Updates the *Request* and set its status to 'pending'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated *Request* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | - - - -### fulfillment.getRequest(id) ⇒ object -Retrieve the *Request* object identified by its id. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The *Request* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | - - - -### fulfillment.searchTierConfigRequests(query) ⇒ Array -Returns a list of at most **limit** *TierConfigurationRequest* objects -that match the provided filters. -If no filter is passed, a page of Request in 'pending' status is returned. - -for further information about the filters object. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: Array - An array of TierConfigurationRequest objects that match the provided filters. - -| Param | Type | Description | -| --- | --- | --- | -| query | object | A RQL query. | - - - -### fulfillment.failTierConfigRequest(id, reason) -Changes the status of the *TierConfigurationRequest* object to 'fail'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigurationRequest object. | -| reason | string | The reason for which the TierConfigurationRequest has been failed. | - - - -### fulfillment.approveTierConfigRequest(id, request) ⇒ object -Updates the *TierConfigurationRequest* and set its status to 'approved'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The rendered template. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| request | object | The request body. | - -**Example** -```js -// request body using a template id -{ - template: { - id: 'TL-827-840-476' - } -} -``` - - -### fulfillment.approveTierConfigRequestWithTemplate(id, templateId) ⇒ object -Updates the *TierConfigurationRequest* and set its status to 'approved' -using an template. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The rendered template. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigurationRequest object. | -| templateId | string | The template id to use for TierConfigurationRequest approval. | - - - -### fulfillment.updateTierConfigRequest(id, request) ⇒ object -Updates a *TierConfigurationRequest* object. -Only a partial update can be performed on a *TierConfigurationRequest* object: -developers can update only the **notew** attribute of the TierConfigurationRequest and/or -the config parameters **value** or **value_error** attributes. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated *TierConfigurationRequest* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigurationRequest object. | -| request | object | The body of the request. | - -**Example** -```js -{ - notes: 'Test Note', - params: [ - { - id: 'param_a', // id is required - value: 'value_of_param_a', - value_error: 'This address is already used. Try another.' - } - ] -} -``` - - -### fulfillment.updateTierConfigRequestParameters(id, params, notes) ⇒ object -Updates the parameters of a *TierConfigurationRequest* object. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated Request object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigurationRequest object. | -| params | Array | Array of *Parameter* objects to update. | -| notes | string | An optional **notes** for the TierConfigurationRequest. | - - - -### fulfillment.createTierConfigRequest(request) -Creates a new *TierConfigurationRequest* object. - -**Kind**: instance method of [Fulfillment](#Fulfillment) - -| Param | Type | Description | -| --- | --- | --- | -| request | object | The TierConfigurationRequest object to create. | - - - -### fulfillment.createUpdateTierConfigRequest(configId, params) -Creates a new *TierConfigurationRequest* object of type="update". - -**Kind**: instance method of [Fulfillment](#Fulfillment) - -| Param | Type | Description | -| --- | --- | --- | -| configId | string | The TierConfigurationRequest unique identifier. | -| params | Array | An array of parameters. | - - - -### fulfillment.inquireTierConfigRequest(id, params, notes) -Updates the *TierConfigRequest* object to inquire the tier -for ordering parameter. -It updates the *Parameter* object **value_error** attribute -and set the status of the *TierConfigRequest* to 'inquire'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| params | Array | An array of *Parameter* objects to update. | -| notes | string | An optional 'notes' attribute for the Request. | - -**Example** -```js -// example of the params argument. -[ - { - id: 'param_a', // id is required - value_error: 'This address is already used. Try another.' - } -] -``` - - -### fulfillment.pendingTierConfigRequest(id) ⇒ object -Updates the *TierConfigRequest* and set its status to 'pending'. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The updated *TierConfigRequest* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigRequest object. | - - - -### fulfillment.getTierConfigRequest(id) ⇒ object -Retrieve the *TierConfigRequest* object identified by its id. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: object - The *TierConfigRequest* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigRequest object. | - - - -### fulfillment.getConnectionIdByProductAndHub(productId, hubId) ⇒ string \| null -Search a connection by a product and a hub and if found returns -the connection identifier otherwise returns null. - -**Kind**: instance method of [Fulfillment](#Fulfillment) -**Returns**: string \| null - The Connection identifier or null. - -| Param | Type | Description | -| --- | --- | --- | -| productId | string | The unique identifier of the Product. | -| hubId | string | The unique identifier of the Hub. | - diff --git a/mddocs/010_Class_Inventory.md b/mddocs/010_Class_Inventory.md deleted file mode 100644 index ddd6136..0000000 --- a/mddocs/010_Class_Inventory.md +++ /dev/null @@ -1,76 +0,0 @@ - - -## Inventory -The Inventory class exposes specialized methods to help -developers to access the inventory (products, items etc). - -**Kind**: global class -**Category**: Operations - -* [Inventory](#Inventory) - * [new Inventory(client)](#new_Inventory_new) - * [.getParametersByProduct(id)](#Inventory+getParametersByProduct) ⇒ Array - * [.getAssetParametersForFulfillmentByProduct(id)](#Inventory+getAssetParametersForFulfillmentByProduct) ⇒ Array - * [.getProductTemplates(id)](#Inventory+getProductTemplates) ⇒ Array - * [.getProductAssetTemplates(id)](#Inventory+getProductAssetTemplates) ⇒ Array - - - -### new Inventory(client) -Creates an instance of the Inventory class. - -**Returns**: [Inventory](#Inventory) - An instance of the Inventory class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### inventory.getParametersByProduct(id) ⇒ Array -Retrieves the list of parameters configured for the product. - -**Kind**: instance method of [Inventory](#Inventory) -**Returns**: Array - An array with the Parameter objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique product identifier for which retrieve the parameters. | - - - -### inventory.getAssetParametersForFulfillmentByProduct(id) ⇒ Array -Retrieves the list of parameters of scope asset and phase fulfillment configured for -the product. - -**Kind**: instance method of [Inventory](#Inventory) -**Returns**: Array - An array with the Parameter objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique product identifier for which retrieve the parameters. | - - - -### inventory.getProductTemplates(id) ⇒ Array -Returns the list of templates configured for a product. - -**Kind**: instance method of [Inventory](#Inventory) -**Returns**: Array - An array of Template objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the product. | - - - -### inventory.getProductAssetTemplates(id) ⇒ Array -Returns the list of templates configured for a product with scope "asset". - -**Kind**: instance method of [Inventory](#Inventory) -**Returns**: Array - An array of Template objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the product. | - diff --git a/mddocs/011_Class_Subscriptions.md b/mddocs/011_Class_Subscriptions.md deleted file mode 100644 index 2786fa4..0000000 --- a/mddocs/011_Class_Subscriptions.md +++ /dev/null @@ -1,106 +0,0 @@ - - -## Subscriptions -The Subscriptions class exposes specialized methods to help -developers to handle subscriptions (recurring assets and billing requests.). - -**Kind**: global class -**Category**: Operations - -* [Subscriptions](#Subscriptions) - * [new Subscriptions(client)](#new_Subscriptions_new) - * [.searchBillingRequests(query)](#Subscriptions+searchBillingRequests) ⇒ Array - * [.createBillingRequest(request)](#Subscriptions+createBillingRequest) ⇒ object - * [.getBillingRequest(id)](#Subscriptions+getBillingRequest) ⇒ object - * [.updateBillingRequestAttributes(id, attributes)](#Subscriptions+updateBillingRequestAttributes) ⇒ object - * [.searchRecurringAssets(query)](#Subscriptions+searchRecurringAssets) ⇒ Array - * [.getRecurringAsset(id)](#Subscriptions+getRecurringAsset) ⇒ object - - - -### new Subscriptions(client) -Creates an instance of the Subscriptions class. - -**Returns**: [Subscriptions](#Subscriptions) - An instance of the Subscriptions class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### subscriptions.searchBillingRequests(query) ⇒ Array -Returns a list of *BillingRequest* objects that match the provided -(optional) query. - -**Kind**: instance method of [Subscriptions](#Subscriptions) -**Returns**: Array - An array of *BillingRequest* object optionally matching - the provided query. - -| Param | Type | Description | -| --- | --- | --- | -| query | object | The optional query to filter results. | - - - -### subscriptions.createBillingRequest(request) ⇒ object -Creates a new *BillingRequest* - -**Kind**: instance method of [Subscriptions](#Subscriptions) -**Returns**: object - The created BillingRequest object. - -| Param | Type | Description | -| --- | --- | --- | -| request | object | The BillingRequest object. | - - - -### subscriptions.getBillingRequest(id) ⇒ object -Retrieve the *BillingRequest* object identified by its id. - -**Kind**: instance method of [Subscriptions](#Subscriptions) -**Returns**: object - The *BillingRequest* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *BillingRequest* object. | - - - -### subscriptions.updateBillingRequestAttributes(id, attributes) ⇒ object -Updates the attributes of a *BillingRequest* object. - -**Kind**: instance method of [Subscriptions](#Subscriptions) -**Returns**: object - The updated BillingRequest attributes object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the BillingRequest object. | -| attributes | object | An attributes object to be updated. | - - - -### subscriptions.searchRecurringAssets(query) ⇒ Array -Returns a list of *RecurringAsset* objects that match the provided -(optional) query. - -**Kind**: instance method of [Subscriptions](#Subscriptions) -**Returns**: Array - An array of *RecurringAsset* object optionally matching - the provided query. - -| Param | Type | Description | -| --- | --- | --- | -| query | object | The optional query to filter results. | - - - -### subscriptions.getRecurringAsset(id) ⇒ object -Retrieve the *RecurringAsset* object identified by its id. - -**Kind**: instance method of [Subscriptions](#Subscriptions) -**Returns**: object - The *RecurringAsset* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *RecurringAsset* object. | - diff --git a/mddocs/012_Class_ProductConfigurationResource.md b/mddocs/012_Class_ProductConfigurationResource.md deleted file mode 100644 index dc1d4c3..0000000 --- a/mddocs/012_Class_ProductConfigurationResource.md +++ /dev/null @@ -1,210 +0,0 @@ -## 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.

-
-
ProductResource ⇐ GenericResource
-

The ProductResource class provides methods to access the products -endpoint of the Cloud Blue Connect API.

-
-
- - - -## ProductActionResource -The *ProductActionResource* class provides methods to access the -*Action* objects for a product. - -**Kind**: global class -**Category**: Resources - - -### productActionResource.link(id, assetId) ⇒ object -Returns the *ActionLink* object for a product and asset. - -**Kind**: instance method of [ProductActionResource](#ProductActionResource) -**Returns**: object - The *ActionLink* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Action*. | -| assetId | string | The unique identifier of the *Asset*. | - - - -## ProductVersionResource ⇐ GenericResource -The *ProductVersionResource* class provides methods to access the -*Version* objects for a product. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ProductVersionResource](#ProductVersionResource) ⇐ GenericResource - * [new ProductVersionResource(client, baseUri)](#new_ProductVersionResource_new) - * [.actions(id)](#ProductVersionResource+actions) ⇒ [ProductActionResource](#ProductActionResource) - - - -### new ProductVersionResource(client, baseUri) -Creates a new instance of the *ProductVersionResource* class. - -**Returns**: [ProductVersionResource](#ProductVersionResource) - An instance of the *ProductVersionResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | -| baseUri | string | The base uri for this resource. | - - - -### productVersionResource.actions(id) ⇒ [ProductActionResource](#ProductActionResource) -Returns an instance of the *ProductActionResource* class -to access the *Action* objects configured for a specific -version of a *Product*. - -**Kind**: instance method of [ProductVersionResource](#ProductVersionResource) -**Returns**: [ProductActionResource](#ProductActionResource) - The instance of the *ProductActionResource* - class for a product/version. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Version* object for a *Product*. | - - - -## ProductConfigurationResource ⇐ GenericResource -The *ProductConfigurationResource* class provides methods to access the -*ProductConfiguration* objects for a product. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -## ProductResource ⇐ GenericResource -The *ProductResource* class provides methods to access the products -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ProductResource](#ProductResource) ⇐ GenericResource - * [new ProductResource(client)](#new_ProductResource_new) - * [.actions(id)](#ProductResource+actions) ⇒ [ProductActionResource](#ProductActionResource) - * [.versions(id)](#ProductResource+versions) ⇒ [ProductVersionResource](#ProductVersionResource) - * [.configurations(id)](#ProductResource+configurations) ⇒ [ProductConfigurationResource](#ProductConfigurationResource) - * [.getTemplates(id)](#ProductResource+getTemplates) ⇒ Array - * [.getParameters(id)](#ProductResource+getParameters) ⇒ Array - * [.getItems(id)](#ProductResource+getItems) ⇒ Array - * [.getConnections(id)](#ProductResource+getConnections) ⇒ Array - - - -### new ProductResource(client) -Creates a new instance of the *ProductResource* class. - -**Returns**: [ProductResource](#ProductResource) - An instance of the *ProductResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | - - - -### productResource.actions(id) ⇒ [ProductActionResource](#ProductActionResource) -Returns an instance of the *ProductActionResource* for a *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductActionResource](#ProductActionResource) - An instance of the *ProductActionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.versions(id) ⇒ [ProductVersionResource](#ProductVersionResource) -Returns an instance of the *ProductVersionResource* for a *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductVersionResource](#ProductVersionResource) - An instance of the *ProductVersionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.configurations(id) ⇒ [ProductConfigurationResource](#ProductConfigurationResource) -Returns an instance of the *ProductConfigurationResource* for a *ProductConfiguration*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductConfigurationResource](#ProductConfigurationResource) - An instance of the *ProductConfigurationResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getTemplates(id) ⇒ Array -Returns the list of *Template* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Template* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getParameters(id) ⇒ Array -Returns the list of *Parameter* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Parameter* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getItems(id) ⇒ Array -Returns the list of *ProductItem* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *ProductItem* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getConnections(id) ⇒ Array -Returns the list of *Connection* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Connection* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - diff --git a/mddocs/013_Class_AccountUserResource.md b/mddocs/013_Class_AccountUserResource.md deleted file mode 100644 index 2c6f534..0000000 --- a/mddocs/013_Class_AccountUserResource.md +++ /dev/null @@ -1,59 +0,0 @@ -## Classes - -
-
AccountUserResource ⇐ GenericResource
-

The AccountUserResource allow consumers of the CloudBlue Connect -API to access information about Users related to an account.

-
-
AccountResource ⇐ GenericResource
-

The AccountResource class provides methods to access the accounts -endpoint of the Cloud Blue Connect API.

-
-
- - - -## AccountUserResource ⇐ GenericResource -The *AccountUserResource* allow consumers of the CloudBlue Connect -API to access information about *Users* related to an account. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -## AccountResource ⇐ GenericResource -The *AccountResource* class provides methods to access the accounts -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [AccountResource](#AccountResource) ⇐ GenericResource - * [new AccountResource(client)](#new_AccountResource_new) - * [.users(id)](#AccountResource+users) ⇒ [AccountUserResource](#AccountUserResource) - - - -### new AccountResource(client) -Creates a new instance of the *AccountResource* class. - -**Returns**: [AccountResource](#AccountResource) - An instance of the *AccountResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | - - - -### accountResource.users(id) ⇒ [AccountUserResource](#AccountUserResource) -Returns an instance of the *AccountUserResorce* class. - -**Kind**: instance method of [AccountResource](#AccountResource) -**Returns**: [AccountUserResource](#AccountUserResource) - An instance of *AccountUserResource*. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The account unique identifier. | - diff --git a/mddocs/014_Class_AccountResource.md b/mddocs/014_Class_AccountResource.md deleted file mode 100644 index 2c6f534..0000000 --- a/mddocs/014_Class_AccountResource.md +++ /dev/null @@ -1,59 +0,0 @@ -## Classes - -
-
AccountUserResource ⇐ GenericResource
-

The AccountUserResource allow consumers of the CloudBlue Connect -API to access information about Users related to an account.

-
-
AccountResource ⇐ GenericResource
-

The AccountResource class provides methods to access the accounts -endpoint of the Cloud Blue Connect API.

-
-
- - - -## AccountUserResource ⇐ GenericResource -The *AccountUserResource* allow consumers of the CloudBlue Connect -API to access information about *Users* related to an account. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -## AccountResource ⇐ GenericResource -The *AccountResource* class provides methods to access the accounts -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [AccountResource](#AccountResource) ⇐ GenericResource - * [new AccountResource(client)](#new_AccountResource_new) - * [.users(id)](#AccountResource+users) ⇒ [AccountUserResource](#AccountUserResource) - - - -### new AccountResource(client) -Creates a new instance of the *AccountResource* class. - -**Returns**: [AccountResource](#AccountResource) - An instance of the *AccountResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | - - - -### accountResource.users(id) ⇒ [AccountUserResource](#AccountUserResource) -Returns an instance of the *AccountUserResorce* class. - -**Kind**: instance method of [AccountResource](#AccountResource) -**Returns**: [AccountUserResource](#AccountUserResource) - An instance of *AccountUserResource*. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The account unique identifier. | - diff --git a/mddocs/015_Class_RecurringAssetResource.md b/mddocs/015_Class_RecurringAssetResource.md deleted file mode 100644 index 4c63bdd..0000000 --- a/mddocs/015_Class_RecurringAssetResource.md +++ /dev/null @@ -1,20 +0,0 @@ - - -## RecurringAssetResource ⇐ GenericResource -The *RecurringAssetResource* class provides methods to access the recurring -assets endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -### new RecurringAssetResource(client) -Creates a new instance of the *RecurringAssetResource* class. - -**Returns**: [RecurringAssetResource](#RecurringAssetResource) - An instance of the *RecurringAssetResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - diff --git a/mddocs/016_Class_GenericResource.md b/mddocs/016_Class_GenericResource.md deleted file mode 100644 index 7cdf998..0000000 --- a/mddocs/016_Class_GenericResource.md +++ /dev/null @@ -1,107 +0,0 @@ - - -## 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](#GenericResource) - * [new GenericResource(client, baseUri)](#new_GenericResource_new) - * [.baseUri](#GenericResource+baseUri) : string - * [.get(id)](#GenericResource+get) ⇒ object - * [.create(obj)](#GenericResource+create) ⇒ object - * [.update(id, obj)](#GenericResource+update) ⇒ object - * [.delete(id)](#GenericResource+delete) - * [.search(filters)](#GenericResource+search) ⇒ Array - * [.fetch(url, options)](#GenericResource+fetch) - - - -### new GenericResource(client, baseUri) - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | A *ConnectClient* instance. | -| baseUri | string | The base URI of the resource | - - - -### genericResource.baseUri : string -Returns the base URI of the resource mapped by this class. - -**Kind**: instance property of [GenericResource](#GenericResource) - - -### genericResource.get(id) ⇒ object -Retrieve a resource by its unique identifier. - -**Kind**: instance method of [GenericResource](#GenericResource) -**Returns**: object - The resource. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the resource to retrieve. | - - - -### genericResource.create(obj) ⇒ object -Create a new resource. - -**Kind**: instance method of [GenericResource](#GenericResource) -**Returns**: object - The created resource. - -| Param | Type | Description | -| --- | --- | --- | -| obj | object | The resource to create. | - - - -### genericResource.update(id, obj) ⇒ object -Update a resource. - -**Kind**: instance method of [GenericResource](#GenericResource) -**Returns**: object - The updated resource. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the resource to update. | -| obj | object | The eventually partial resource to update. | - - - -### genericResource.delete(id) -Delete a resource. - -**Kind**: instance method of [GenericResource](#GenericResource) - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the resource to delete. | - - - -### genericResource.search(filters) ⇒ Array -Search for a resource. - -**Kind**: instance method of [GenericResource](#GenericResource) -**Returns**: Array - An array of resources that match the provided filters. - -| Param | Type | Description | -| --- | --- | --- | -| filters | object | The query to send to the server as a RQL object. | - - - -### genericResource.fetch(url, options) -Fetch the URL and returns a response. - -**Kind**: instance method of [GenericResource](#GenericResource) - -| Param | Type | Description | -| --- | --- | --- | -| url | string | the URL to fetch. | -| options | object | the request options. | - diff --git a/mddocs/017_Class_BillingRequestResource.md b/mddocs/017_Class_BillingRequestResource.md deleted file mode 100644 index f840940..0000000 --- a/mddocs/017_Class_BillingRequestResource.md +++ /dev/null @@ -1,38 +0,0 @@ - - -## BillingRequestResource ⇐ GenericResource -The *BillingRequestResource* class provides methods to access the billing -requests endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [BillingRequestResource](#BillingRequestResource) ⇐ GenericResource - * [new BillingRequestResource(client)](#new_BillingRequestResource_new) - * [.updateAttributes(id, attributes)](#BillingRequestResource+updateAttributes) ⇒ object - - - -### new BillingRequestResource(client) -Creates a new instance of the *BillingRequestResource* class. - -**Returns**: [BillingRequestResource](#BillingRequestResource) - An instance of the *BillingRequestResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### billingRequestResource.updateAttributes(id, attributes) ⇒ object -Update billing request attributs. - -**Kind**: instance method of [BillingRequestResource](#BillingRequestResource) -**Returns**: object - The updated attributes object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identified of the *BillingRequest*. | -| attributes | object | An object containing the attributes to update. | - diff --git a/mddocs/018_Class_ConversationResource.md b/mddocs/018_Class_ConversationResource.md deleted file mode 100644 index fdc8fc2..0000000 --- a/mddocs/018_Class_ConversationResource.md +++ /dev/null @@ -1,51 +0,0 @@ - - -## ConversationResource ⇐ GenericResource -The *ConversationResource* class provides methods to access the conversations -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ConversationResource](#ConversationResource) ⇐ GenericResource - * [new ConversationResource(client)](#new_ConversationResource_new) - * [.getConversationsByObjectId(id)](#ConversationResource+getConversationsByObjectId) ⇒ Array - * [.createMessage(id, msg)](#ConversationResource+createMessage) ⇒ object - - - -### new ConversationResource(client) -Creates a new instance of the *ConversationResource* class. - -**Returns**: [ConversationResource](#ConversationResource) - An instance of the *ConversationResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### conversationResource.getConversationsByObjectId(id) ⇒ Array -Returns a list of conversations attached to the business object specified by its id. - -**Kind**: instance method of [ConversationResource](#ConversationResource) -**Returns**: Array - A list of conversations attached to a business object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique id of the business object attached to a conversation. | - - - -### conversationResource.createMessage(id, msg) ⇒ object -Add a message to a *Conversation* object. - -**Kind**: instance method of [ConversationResource](#ConversationResource) -**Returns**: object - The newly created *Message* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Conversation object. | -| msg | string | The text of the message to post. | - diff --git a/mddocs/019_Class_AssetResource.md b/mddocs/019_Class_AssetResource.md deleted file mode 100644 index 26afdc3..0000000 --- a/mddocs/019_Class_AssetResource.md +++ /dev/null @@ -1,20 +0,0 @@ - - -## AssetResource ⇐ GenericResource -The *AssetResource* class provides methods to access the assets -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -### new AssetResource(client) -Creates a new instance of the *AssetResource* class. - -**Returns**: [AssetResource](#AssetResource) - An instance of the *AssetResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | - diff --git a/mddocs/020_Class_TierAccountRequestResource.md b/mddocs/020_Class_TierAccountRequestResource.md deleted file mode 100644 index f272855..0000000 --- a/mddocs/020_Class_TierAccountRequestResource.md +++ /dev/null @@ -1,51 +0,0 @@ - - -## TierAccountRequestResource ⇐ GenericResource -The *TierAccountRequestResource* class provides methods to access the tier account -requests endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [TierAccountRequestResource](#TierAccountRequestResource) ⇐ GenericResource - * [new TierAccountRequestResource(client)](#new_TierAccountRequestResource_new) - * [.accept(id)](#TierAccountRequestResource+accept) ⇒ object - * [.ignore(id, reason)](#TierAccountRequestResource+ignore) ⇒ object - - - -### new TierAccountRequestResource(client) -Creates a new instance of the *TierAccountRequestResource* class. - -**Returns**: [TierAccountRequestResource](#TierAccountRequestResource) - An instance of the *TierAccountRequestResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### tierAccountRequestResource.accept(id) ⇒ object -Accept the TierAccountRequest. - -**Kind**: instance method of [TierAccountRequestResource](#TierAccountRequestResource) -**Returns**: object - The accepted TierAccountRequest object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierAccountRequest object. | - - - -### tierAccountRequestResource.ignore(id, reason) ⇒ object -Ignore the TierAccountRequest. - -**Kind**: instance method of [TierAccountRequestResource](#TierAccountRequestResource) -**Returns**: object - The ignored TierAccountRequest object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierAccountRequest object. | -| reason | string | The reason for which vendor ignore this request. | - diff --git a/mddocs/021_Class_ProductActionResource.md b/mddocs/021_Class_ProductActionResource.md deleted file mode 100644 index dc1d4c3..0000000 --- a/mddocs/021_Class_ProductActionResource.md +++ /dev/null @@ -1,210 +0,0 @@ -## 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.

-
-
ProductResource ⇐ GenericResource
-

The ProductResource class provides methods to access the products -endpoint of the Cloud Blue Connect API.

-
-
- - - -## ProductActionResource -The *ProductActionResource* class provides methods to access the -*Action* objects for a product. - -**Kind**: global class -**Category**: Resources - - -### productActionResource.link(id, assetId) ⇒ object -Returns the *ActionLink* object for a product and asset. - -**Kind**: instance method of [ProductActionResource](#ProductActionResource) -**Returns**: object - The *ActionLink* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Action*. | -| assetId | string | The unique identifier of the *Asset*. | - - - -## ProductVersionResource ⇐ GenericResource -The *ProductVersionResource* class provides methods to access the -*Version* objects for a product. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ProductVersionResource](#ProductVersionResource) ⇐ GenericResource - * [new ProductVersionResource(client, baseUri)](#new_ProductVersionResource_new) - * [.actions(id)](#ProductVersionResource+actions) ⇒ [ProductActionResource](#ProductActionResource) - - - -### new ProductVersionResource(client, baseUri) -Creates a new instance of the *ProductVersionResource* class. - -**Returns**: [ProductVersionResource](#ProductVersionResource) - An instance of the *ProductVersionResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | -| baseUri | string | The base uri for this resource. | - - - -### productVersionResource.actions(id) ⇒ [ProductActionResource](#ProductActionResource) -Returns an instance of the *ProductActionResource* class -to access the *Action* objects configured for a specific -version of a *Product*. - -**Kind**: instance method of [ProductVersionResource](#ProductVersionResource) -**Returns**: [ProductActionResource](#ProductActionResource) - The instance of the *ProductActionResource* - class for a product/version. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Version* object for a *Product*. | - - - -## ProductConfigurationResource ⇐ GenericResource -The *ProductConfigurationResource* class provides methods to access the -*ProductConfiguration* objects for a product. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -## ProductResource ⇐ GenericResource -The *ProductResource* class provides methods to access the products -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ProductResource](#ProductResource) ⇐ GenericResource - * [new ProductResource(client)](#new_ProductResource_new) - * [.actions(id)](#ProductResource+actions) ⇒ [ProductActionResource](#ProductActionResource) - * [.versions(id)](#ProductResource+versions) ⇒ [ProductVersionResource](#ProductVersionResource) - * [.configurations(id)](#ProductResource+configurations) ⇒ [ProductConfigurationResource](#ProductConfigurationResource) - * [.getTemplates(id)](#ProductResource+getTemplates) ⇒ Array - * [.getParameters(id)](#ProductResource+getParameters) ⇒ Array - * [.getItems(id)](#ProductResource+getItems) ⇒ Array - * [.getConnections(id)](#ProductResource+getConnections) ⇒ Array - - - -### new ProductResource(client) -Creates a new instance of the *ProductResource* class. - -**Returns**: [ProductResource](#ProductResource) - An instance of the *ProductResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | - - - -### productResource.actions(id) ⇒ [ProductActionResource](#ProductActionResource) -Returns an instance of the *ProductActionResource* for a *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductActionResource](#ProductActionResource) - An instance of the *ProductActionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.versions(id) ⇒ [ProductVersionResource](#ProductVersionResource) -Returns an instance of the *ProductVersionResource* for a *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductVersionResource](#ProductVersionResource) - An instance of the *ProductVersionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.configurations(id) ⇒ [ProductConfigurationResource](#ProductConfigurationResource) -Returns an instance of the *ProductConfigurationResource* for a *ProductConfiguration*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductConfigurationResource](#ProductConfigurationResource) - An instance of the *ProductConfigurationResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getTemplates(id) ⇒ Array -Returns the list of *Template* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Template* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getParameters(id) ⇒ Array -Returns the list of *Parameter* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Parameter* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getItems(id) ⇒ Array -Returns the list of *ProductItem* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *ProductItem* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getConnections(id) ⇒ Array -Returns the list of *Connection* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Connection* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - diff --git a/mddocs/022_Class_HubResource.md b/mddocs/022_Class_HubResource.md deleted file mode 100644 index 430d034..0000000 --- a/mddocs/022_Class_HubResource.md +++ /dev/null @@ -1,20 +0,0 @@ - - -## 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](#HubResource) - An instance of the *HubResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | - diff --git a/mddocs/023_Class_TierAccountVersionResource.md b/mddocs/023_Class_TierAccountVersionResource.md deleted file mode 100644 index bde38af..0000000 --- a/mddocs/023_Class_TierAccountVersionResource.md +++ /dev/null @@ -1,60 +0,0 @@ -## Classes - -
-
TierAccountVersionResource ⇐ GenericResource
-

The TierAccountVersionResource class provides methods to access the -Version objects for a tier account.

-
-
TierAccountResource ⇐ GenericResource
-

The TierAccountResource class provides methods to access the tier accounts -endpoint of the Cloud Blue Connect API.

-
-
- - - -## TierAccountVersionResource ⇐ GenericResource -The *TierAccountVersionResource* class provides methods to access the -*Version* objects for a tier account. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -## TierAccountResource ⇐ GenericResource -The *TierAccountResource* class provides methods to access the tier accounts -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [TierAccountResource](#TierAccountResource) ⇐ GenericResource - * [new TierAccountResource(client)](#new_TierAccountResource_new) - * [.versions(id)](#TierAccountResource+versions) ⇒ [TierAccountVersionResource](#TierAccountVersionResource) - - - -### new TierAccountResource(client) -Creates a new instance of the *TierAccountResource* class. - -**Returns**: [TierAccountResource](#TierAccountResource) - An instance of the *TierAccountResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### tierAccountResource.versions(id) ⇒ [TierAccountVersionResource](#TierAccountVersionResource) -Returns an instance of the *TierAccountVersionResource* for a *TierAccount*. - -**Kind**: instance method of [TierAccountResource](#TierAccountResource) -**Returns**: [TierAccountVersionResource](#TierAccountVersionResource) - An instance of the *TierAccountVersionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *TierAccount*. | - diff --git a/mddocs/024_Class_ProductResource.md b/mddocs/024_Class_ProductResource.md deleted file mode 100644 index dc1d4c3..0000000 --- a/mddocs/024_Class_ProductResource.md +++ /dev/null @@ -1,210 +0,0 @@ -## 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.

-
-
ProductResource ⇐ GenericResource
-

The ProductResource class provides methods to access the products -endpoint of the Cloud Blue Connect API.

-
-
- - - -## ProductActionResource -The *ProductActionResource* class provides methods to access the -*Action* objects for a product. - -**Kind**: global class -**Category**: Resources - - -### productActionResource.link(id, assetId) ⇒ object -Returns the *ActionLink* object for a product and asset. - -**Kind**: instance method of [ProductActionResource](#ProductActionResource) -**Returns**: object - The *ActionLink* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Action*. | -| assetId | string | The unique identifier of the *Asset*. | - - - -## ProductVersionResource ⇐ GenericResource -The *ProductVersionResource* class provides methods to access the -*Version* objects for a product. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ProductVersionResource](#ProductVersionResource) ⇐ GenericResource - * [new ProductVersionResource(client, baseUri)](#new_ProductVersionResource_new) - * [.actions(id)](#ProductVersionResource+actions) ⇒ [ProductActionResource](#ProductActionResource) - - - -### new ProductVersionResource(client, baseUri) -Creates a new instance of the *ProductVersionResource* class. - -**Returns**: [ProductVersionResource](#ProductVersionResource) - An instance of the *ProductVersionResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | -| baseUri | string | The base uri for this resource. | - - - -### productVersionResource.actions(id) ⇒ [ProductActionResource](#ProductActionResource) -Returns an instance of the *ProductActionResource* class -to access the *Action* objects configured for a specific -version of a *Product*. - -**Kind**: instance method of [ProductVersionResource](#ProductVersionResource) -**Returns**: [ProductActionResource](#ProductActionResource) - The instance of the *ProductActionResource* - class for a product/version. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Version* object for a *Product*. | - - - -## ProductConfigurationResource ⇐ GenericResource -The *ProductConfigurationResource* class provides methods to access the -*ProductConfiguration* objects for a product. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -## ProductResource ⇐ GenericResource -The *ProductResource* class provides methods to access the products -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ProductResource](#ProductResource) ⇐ GenericResource - * [new ProductResource(client)](#new_ProductResource_new) - * [.actions(id)](#ProductResource+actions) ⇒ [ProductActionResource](#ProductActionResource) - * [.versions(id)](#ProductResource+versions) ⇒ [ProductVersionResource](#ProductVersionResource) - * [.configurations(id)](#ProductResource+configurations) ⇒ [ProductConfigurationResource](#ProductConfigurationResource) - * [.getTemplates(id)](#ProductResource+getTemplates) ⇒ Array - * [.getParameters(id)](#ProductResource+getParameters) ⇒ Array - * [.getItems(id)](#ProductResource+getItems) ⇒ Array - * [.getConnections(id)](#ProductResource+getConnections) ⇒ Array - - - -### new ProductResource(client) -Creates a new instance of the *ProductResource* class. - -**Returns**: [ProductResource](#ProductResource) - An instance of the *ProductResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | - - - -### productResource.actions(id) ⇒ [ProductActionResource](#ProductActionResource) -Returns an instance of the *ProductActionResource* for a *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductActionResource](#ProductActionResource) - An instance of the *ProductActionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.versions(id) ⇒ [ProductVersionResource](#ProductVersionResource) -Returns an instance of the *ProductVersionResource* for a *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductVersionResource](#ProductVersionResource) - An instance of the *ProductVersionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.configurations(id) ⇒ [ProductConfigurationResource](#ProductConfigurationResource) -Returns an instance of the *ProductConfigurationResource* for a *ProductConfiguration*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductConfigurationResource](#ProductConfigurationResource) - An instance of the *ProductConfigurationResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getTemplates(id) ⇒ Array -Returns the list of *Template* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Template* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getParameters(id) ⇒ Array -Returns the list of *Parameter* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Parameter* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getItems(id) ⇒ Array -Returns the list of *ProductItem* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *ProductItem* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getConnections(id) ⇒ Array -Returns the list of *Connection* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Connection* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - diff --git a/mddocs/025_Class_TierAccountResource.md b/mddocs/025_Class_TierAccountResource.md deleted file mode 100644 index bde38af..0000000 --- a/mddocs/025_Class_TierAccountResource.md +++ /dev/null @@ -1,60 +0,0 @@ -## Classes - -
-
TierAccountVersionResource ⇐ GenericResource
-

The TierAccountVersionResource class provides methods to access the -Version objects for a tier account.

-
-
TierAccountResource ⇐ GenericResource
-

The TierAccountResource class provides methods to access the tier accounts -endpoint of the Cloud Blue Connect API.

-
-
- - - -## TierAccountVersionResource ⇐ GenericResource -The *TierAccountVersionResource* class provides methods to access the -*Version* objects for a tier account. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -## TierAccountResource ⇐ GenericResource -The *TierAccountResource* class provides methods to access the tier accounts -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [TierAccountResource](#TierAccountResource) ⇐ GenericResource - * [new TierAccountResource(client)](#new_TierAccountResource_new) - * [.versions(id)](#TierAccountResource+versions) ⇒ [TierAccountVersionResource](#TierAccountVersionResource) - - - -### new TierAccountResource(client) -Creates a new instance of the *TierAccountResource* class. - -**Returns**: [TierAccountResource](#TierAccountResource) - An instance of the *TierAccountResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### tierAccountResource.versions(id) ⇒ [TierAccountVersionResource](#TierAccountVersionResource) -Returns an instance of the *TierAccountVersionResource* for a *TierAccount*. - -**Kind**: instance method of [TierAccountResource](#TierAccountResource) -**Returns**: [TierAccountVersionResource](#TierAccountVersionResource) - An instance of the *TierAccountVersionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *TierAccount*. | - diff --git a/mddocs/026_Class_ProductVersionResource.md b/mddocs/026_Class_ProductVersionResource.md deleted file mode 100644 index dc1d4c3..0000000 --- a/mddocs/026_Class_ProductVersionResource.md +++ /dev/null @@ -1,210 +0,0 @@ -## 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.

-
-
ProductResource ⇐ GenericResource
-

The ProductResource class provides methods to access the products -endpoint of the Cloud Blue Connect API.

-
-
- - - -## ProductActionResource -The *ProductActionResource* class provides methods to access the -*Action* objects for a product. - -**Kind**: global class -**Category**: Resources - - -### productActionResource.link(id, assetId) ⇒ object -Returns the *ActionLink* object for a product and asset. - -**Kind**: instance method of [ProductActionResource](#ProductActionResource) -**Returns**: object - The *ActionLink* object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Action*. | -| assetId | string | The unique identifier of the *Asset*. | - - - -## ProductVersionResource ⇐ GenericResource -The *ProductVersionResource* class provides methods to access the -*Version* objects for a product. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ProductVersionResource](#ProductVersionResource) ⇐ GenericResource - * [new ProductVersionResource(client, baseUri)](#new_ProductVersionResource_new) - * [.actions(id)](#ProductVersionResource+actions) ⇒ [ProductActionResource](#ProductActionResource) - - - -### new ProductVersionResource(client, baseUri) -Creates a new instance of the *ProductVersionResource* class. - -**Returns**: [ProductVersionResource](#ProductVersionResource) - An instance of the *ProductVersionResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | -| baseUri | string | The base uri for this resource. | - - - -### productVersionResource.actions(id) ⇒ [ProductActionResource](#ProductActionResource) -Returns an instance of the *ProductActionResource* class -to access the *Action* objects configured for a specific -version of a *Product*. - -**Kind**: instance method of [ProductVersionResource](#ProductVersionResource) -**Returns**: [ProductActionResource](#ProductActionResource) - The instance of the *ProductActionResource* - class for a product/version. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Version* object for a *Product*. | - - - -## ProductConfigurationResource ⇐ GenericResource -The *ProductConfigurationResource* class provides methods to access the -*ProductConfiguration* objects for a product. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -## ProductResource ⇐ GenericResource -The *ProductResource* class provides methods to access the products -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [ProductResource](#ProductResource) ⇐ GenericResource - * [new ProductResource(client)](#new_ProductResource_new) - * [.actions(id)](#ProductResource+actions) ⇒ [ProductActionResource](#ProductActionResource) - * [.versions(id)](#ProductResource+versions) ⇒ [ProductVersionResource](#ProductVersionResource) - * [.configurations(id)](#ProductResource+configurations) ⇒ [ProductConfigurationResource](#ProductConfigurationResource) - * [.getTemplates(id)](#ProductResource+getTemplates) ⇒ Array - * [.getParameters(id)](#ProductResource+getParameters) ⇒ Array - * [.getItems(id)](#ProductResource+getItems) ⇒ Array - * [.getConnections(id)](#ProductResource+getConnections) ⇒ Array - - - -### new ProductResource(client) -Creates a new instance of the *ProductResource* class. - -**Returns**: [ProductResource](#ProductResource) - An instance of the *ProductResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the *ConnectClient* class. | - - - -### productResource.actions(id) ⇒ [ProductActionResource](#ProductActionResource) -Returns an instance of the *ProductActionResource* for a *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductActionResource](#ProductActionResource) - An instance of the *ProductActionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.versions(id) ⇒ [ProductVersionResource](#ProductVersionResource) -Returns an instance of the *ProductVersionResource* for a *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductVersionResource](#ProductVersionResource) - An instance of the *ProductVersionResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.configurations(id) ⇒ [ProductConfigurationResource](#ProductConfigurationResource) -Returns an instance of the *ProductConfigurationResource* for a *ProductConfiguration*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: [ProductConfigurationResource](#ProductConfigurationResource) - An instance of the *ProductConfigurationResource* - for the product. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getTemplates(id) ⇒ Array -Returns the list of *Template* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Template* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getParameters(id) ⇒ Array -Returns the list of *Parameter* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Parameter* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getItems(id) ⇒ Array -Returns the list of *ProductItem* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *ProductItem* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - - - -### productResource.getConnections(id) ⇒ Array -Returns the list of *Connection* objects configured for the *Product*. - -**Kind**: instance method of [ProductResource](#ProductResource) -**Returns**: Array - The list of *Connection* objects. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the *Product*. | - diff --git a/mddocs/027_Class_RequestResource.md b/mddocs/027_Class_RequestResource.md deleted file mode 100644 index 9ced552..0000000 --- a/mddocs/027_Class_RequestResource.md +++ /dev/null @@ -1,111 +0,0 @@ - - -## RequestResource ⇐ GenericResource -The *RequestResource* class provides methods to access the *Request* -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [RequestResource](#RequestResource) ⇐ GenericResource - * [new RequestResource(client)](#new_RequestResource_new) - * [.fail(id, reason)](#RequestResource+fail) ⇒ object - * [.inquire(id, request)](#RequestResource+inquire) ⇒ object - * [.approve(id, request)](#RequestResource+approve) ⇒ object - * [.pending(id)](#RequestResource+pending) ⇒ object - - - -### new RequestResource(client) -Creates a new instance of the *RequestResource* class. - -**Returns**: [RequestResource](#RequestResource) - An instance of the *RequestResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### requestResource.fail(id, reason) ⇒ object -Change the status of a *Request* to fail. - -**Kind**: instance method of [RequestResource](#RequestResource) -**Returns**: object - The updated Request object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| reason | string | The reason for which the Request has been failed. | - - - -### requestResource.inquire(id, request) ⇒ object -Change the status of a *Request* to inquire. -To change the status of the Request to inquire you must provide -either a template id or a template tile. - -**Kind**: instance method of [RequestResource](#RequestResource) -**Returns**: object - The updated Request object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| request | object | The request body. | - -**Example** -```js -// request body using a template id -{ - template_id: 'TL-827-840-476' -} -``` -**Example** -```js -// request body using an activation tile -{ - activation_tile: '' -} -``` - - -### requestResource.approve(id, request) ⇒ object -Change the status of a *Request* to approved. -To change the status of the Request to approved you must provide -either a template id or a template tile. - -**Kind**: instance method of [RequestResource](#RequestResource) -**Returns**: object - The updated Request object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | -| request | object | The request body. | - -**Example** -```js -// request body using a template id -{ - template_id: 'TL-827-840-476' -} -``` -**Example** -```js -// request body using an activation tile -{ - activation_tile: '' -} -``` - - -### requestResource.pending(id) ⇒ object -Change the status of a *Request* to pending. - -**Kind**: instance method of [RequestResource](#RequestResource) -**Returns**: object - The updated Request object. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the Request object. | - diff --git a/mddocs/028_Class_TierConfigRequestResource.md b/mddocs/028_Class_TierConfigRequestResource.md deleted file mode 100644 index 310f812..0000000 --- a/mddocs/028_Class_TierConfigRequestResource.md +++ /dev/null @@ -1,86 +0,0 @@ - - -## TierConfigRequestResource ⇐ GenericResource -The *TierConfigRequestResource* class provides methods to access the *TierConfigRequest* -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - -* [TierConfigRequestResource](#TierConfigRequestResource) ⇐ GenericResource - * [new TierConfigRequestResource(client)](#new_TierConfigRequestResource_new) - * [.fail(id, reason)](#TierConfigRequestResource+fail) - * [.inquire(id)](#TierConfigRequestResource+inquire) - * [.pending(id)](#TierConfigRequestResource+pending) - * [.approve(id, request)](#TierConfigRequestResource+approve) ⇒ object - - - -### new TierConfigRequestResource(client) -Creates a new instance of the *TierConfigRequestResource* class. - -**Returns**: [TierConfigRequestResource](#TierConfigRequestResource) - An instance of the *TierConfigRequestResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - - - -### tierConfigRequestResource.fail(id, reason) -Changes the status of a *TierConfigurationRequest* to fail. - -**Kind**: instance method of [TierConfigRequestResource](#TierConfigRequestResource) - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigurationRequest object. | -| reason | string | The reason for which the TierConfigurationRequest has been failed. | - - - -### tierConfigRequestResource.inquire(id) -Changes the status of a *TierConfigurationRequest* to inquire. - -**Kind**: instance method of [TierConfigRequestResource](#TierConfigRequestResource) - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigurationRequest object. | - - - -### tierConfigRequestResource.pending(id) -Changes the status of a *TierConfigurationRequest* to pending. - -**Kind**: instance method of [TierConfigRequestResource](#TierConfigRequestResource) - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigurationRequest object. | - - - -### tierConfigRequestResource.approve(id, request) ⇒ object -Change the status of a *TierConfigurationRequest* to approved. -To change the status of the TierConfigurationRequest to approved -you must provide a Template id. - -**Kind**: instance method of [TierConfigRequestResource](#TierConfigRequestResource) -**Returns**: object - The rendered Template. - -| Param | Type | Description | -| --- | --- | --- | -| id | string | The unique identifier of the TierConfigurationRequest object. | -| request | object | The request body. | - -**Example** -```js -// request body using a template id -{ - template: { - id: 'TL-000-000-000' - } -} -``` diff --git a/mddocs/029_Class_TierConfigResource.md b/mddocs/029_Class_TierConfigResource.md deleted file mode 100644 index 226e84d..0000000 --- a/mddocs/029_Class_TierConfigResource.md +++ /dev/null @@ -1,20 +0,0 @@ - - -## TierConfigResource ⇐ GenericResource -The *TierConfigRequestResource* class provides methods to access the *TierConfig* -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -### new TierConfigResource(client) -Creates a new instance of the *TierConfigResource* class. - -**Returns**: [TierConfigResource](#TierConfigResource) - An instance of the *TierConfigResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - diff --git a/mddocs/030_Class_WebhookResource.md b/mddocs/030_Class_WebhookResource.md deleted file mode 100644 index 8c38e91..0000000 --- a/mddocs/030_Class_WebhookResource.md +++ /dev/null @@ -1,20 +0,0 @@ - - -## WebhookResource ⇐ GenericResource -The *WebhookResource* class provides methods to access the webhooks -endpoint of the Cloud Blue Connect API. - -**Kind**: global class -**Extends**: GenericResource -**Category**: Resources - - -### new WebhookResource(client) -Creates a new instance of the *WebhookResource* class. - -**Returns**: [WebhookResource](#WebhookResource) - An instance of the *WebhookResource* class. - -| Param | Type | Description | -| --- | --- | --- | -| client | ConnectClient | An instance of the ConnectClient class. | - diff --git a/mddocs/report.json b/mddocs/report.json deleted file mode 100644 index 96958c4..0000000 --- a/mddocs/report.json +++ /dev/null @@ -1,253 +0,0 @@ -{ - "generated": "2020-03-05T15:21:41.529Z", - "pages": [ - { - "name": "Welcome", - "category": "Home", - "file": "README.md", - "idx": "0", - "outputFileName": "000_Welcome.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/000_Welcome.md" - }, - { - "name": "Getting started", - "category": "Tutorials", - "file": "docs-src/tutorials/getting_started.md", - "idx": "1", - "outputFileName": "001_Getting_started.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/001_Getting_started.md" - }, - { - "name": "Querying endpoints", - "category": "Tutorials", - "file": "docs-src/tutorials/searches.md", - "idx": "2", - "outputFileName": "002_Querying_endpoints.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/002_Querying_endpoints.md" - }, - { - "name": "Class APIError", - "category": "Base", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/errors.js", - "idx": "3", - "outputFileName": "003_Class_APIError.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/003_Class_APIError.md" - }, - { - "name": "Class AbstractHttpAdapter", - "category": "Base", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/http/adapter.js", - "idx": "4", - "outputFileName": "004_Class_AbstractHttpAdapter.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/004_Class_AbstractHttpAdapter.md" - }, - { - "name": "Class ConnectClient", - "category": "Base", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/client.js", - "idx": "5", - "outputFileName": "005_Class_ConnectClient.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/005_Class_ConnectClient.md" - }, - { - "name": "Class DefaultHttpAdapter", - "category": "Base", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/http/adapter.js", - "idx": "6", - "outputFileName": "006_Class_DefaultHttpAdapter.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/006_Class_DefaultHttpAdapter.md" - }, - { - "name": "Class HttpError", - "category": "Base", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/errors.js", - "idx": "7", - "outputFileName": "007_Class_HttpError.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/007_Class_HttpError.md" - }, - { - "name": "Class Directory", - "category": "Operations", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/ops/directory.js", - "idx": "8", - "outputFileName": "008_Class_Directory.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/008_Class_Directory.md" - }, - { - "name": "Class Fulfillment", - "category": "Operations", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/ops/fulfillment.js", - "idx": "9", - "outputFileName": "009_Class_Fulfillment.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/009_Class_Fulfillment.md" - }, - { - "name": "Class Inventory", - "category": "Operations", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/ops/inventory.js", - "idx": "10", - "outputFileName": "010_Class_Inventory.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/010_Class_Inventory.md" - }, - { - "name": "Class Subscriptions", - "category": "Operations", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/ops/subscriptions.js", - "idx": "11", - "outputFileName": "011_Class_Subscriptions.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/011_Class_Subscriptions.md" - }, - { - "name": "Class ProductConfigurationResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/products.js", - "idx": "12", - "outputFileName": "012_Class_ProductConfigurationResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/012_Class_ProductConfigurationResource.md" - }, - { - "name": "Class AccountUserResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/accounts.js", - "idx": "13", - "outputFileName": "013_Class_AccountUserResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/013_Class_AccountUserResource.md" - }, - { - "name": "Class AccountResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/accounts.js", - "idx": "14", - "outputFileName": "014_Class_AccountResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/014_Class_AccountResource.md" - }, - { - "name": "Class RecurringAssetResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/recurringAssets.js", - "idx": "15", - "outputFileName": "015_Class_RecurringAssetResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/015_Class_RecurringAssetResource.md" - }, - { - "name": "Class GenericResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/base.js", - "idx": "16", - "outputFileName": "016_Class_GenericResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/016_Class_GenericResource.md" - }, - { - "name": "Class BillingRequestResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/billingRequests.js", - "idx": "17", - "outputFileName": "017_Class_BillingRequestResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/017_Class_BillingRequestResource.md" - }, - { - "name": "Class ConversationResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/conversations.js", - "idx": "18", - "outputFileName": "018_Class_ConversationResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/018_Class_ConversationResource.md" - }, - { - "name": "Class AssetResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/assets.js", - "idx": "19", - "outputFileName": "019_Class_AssetResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/019_Class_AssetResource.md" - }, - { - "name": "Class TierAccountRequestResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/tierAccountRequests.js", - "idx": "20", - "outputFileName": "020_Class_TierAccountRequestResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/020_Class_TierAccountRequestResource.md" - }, - { - "name": "Class ProductActionResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/products.js", - "idx": "21", - "outputFileName": "021_Class_ProductActionResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/021_Class_ProductActionResource.md" - }, - { - "name": "Class HubResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/hubs.js", - "idx": "22", - "outputFileName": "022_Class_HubResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/022_Class_HubResource.md" - }, - { - "name": "Class TierAccountVersionResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/tierAccounts.js", - "idx": "23", - "outputFileName": "023_Class_TierAccountVersionResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/023_Class_TierAccountVersionResource.md" - }, - { - "name": "Class ProductResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/products.js", - "idx": "24", - "outputFileName": "024_Class_ProductResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/024_Class_ProductResource.md" - }, - { - "name": "Class TierAccountResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/tierAccounts.js", - "idx": "25", - "outputFileName": "025_Class_TierAccountResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/025_Class_TierAccountResource.md" - }, - { - "name": "Class ProductVersionResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/products.js", - "idx": "26", - "outputFileName": "026_Class_ProductVersionResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/026_Class_ProductVersionResource.md" - }, - { - "name": "Class RequestResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/requests.js", - "idx": "27", - "outputFileName": "027_Class_RequestResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/027_Class_RequestResource.md" - }, - { - "name": "Class TierConfigRequestResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/tierConfigRequests.js", - "idx": "28", - "outputFileName": "028_Class_TierConfigRequestResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/028_Class_TierConfigRequestResource.md" - }, - { - "name": "Class TierConfigResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/tierConfigs.js", - "idx": "29", - "outputFileName": "029_Class_TierConfigResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/029_Class_TierConfigResource.md" - }, - { - "name": "Class WebhookResource", - "category": "Resources", - "file": "/home/travis/build/cloudblue/connect-javascript-sdk/lib/connect/api/webhooks.js", - "idx": "30", - "outputFileName": "030_Class_WebhookResource.md", - "url": "https://raw.githubusercontent.com/cloudblue/connect-javascript-sdk/develop/mddocs/030_Class_WebhookResource.md" - } - ] -} \ No newline at end of file