Class Directory

Updated: March 5, 2020
Contents

Directory

The Directory class exposes specialized methods to help
developers to access the directory (assets, tier configs, tier accounts).

Kind: global class
Category: Operations

new Directory(client)

Creates an instance of the Directory class.

Returns: Directory – An instance of the Directory class.

ParamTypeDescription
clientConnectClientAn 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
Returns: Array – An array of Asset object optionally matching the provided query.

ParamTypeDescription
queryobjectThe 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
Returns: Array – An array of TierConfiguration object optionally
matching the provided query.

ParamTypeDescription
queryobjectThe 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
Returns: Array – An array of TierAccount object optionally matching the provided query.

ParamTypeDescription
queryobjectThe optional query to filter results.

directory.getTierAccount(id) ⇒ object

Retrieve a TierAccount by its id.

Kind: instance method of Directory
Returns: object – The TierAccount object.

ParamTypeDescription
idstringThe 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
Returns: Array – An array of Asset objects.

ParamTypeDescription
productIdstringThe unique id of the Product related to this Asset.
externalIdstringThe external identifier of the Asset.

directory.createTierAccountRequest(request) ⇒ object

Creates a new TierAccountRequest

Kind: instance method of Directory
Returns: object – The created TierAccountRequest object.

ParamTypeDescription
requestobjectThe TierAccountRequest object.

directory.searchTierAccountRequest(query) ⇒ Array

Returns a list of TierAccountRequest objects that match the provided
filters.

Kind: instance method of Directory
Returns: Array – An array of TierAccountRequest objects
that match the provided filters.

ParamTypeDescription
queryobjectA RQL query.

directory.getTierAccountRequest(id) ⇒ object

Retrieve the TierAccountRequest object identified by its id.

Kind: instance method of Directory
Returns: object – The TierAccountRequest object.

ParamTypeDescription
idstringThe unique identifier of the TierAccountRequest object.

directory.acceptTierAccountRequest(id) ⇒ object

Accept the TierAccountRequest object identified by its id.

Kind: instance method of Directory
Returns: object – The TierAccountRequest object.

ParamTypeDescription
idstringThe unique identifier of the TierAccountRequest object.

directory.ignoreTierAccountRequest(id) ⇒ object

Ignore the TierAccountRequest object identified by its id.

Kind: instance method of Directory
Returns: object – The TierAccountRequest object.

ParamTypeDescription
idstringThe 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
Returns: object – The TierAccount object.

ParamTypeDescription
idstringThe unique identifier of the TierAccount object.
versionstringThe version to be retrieved.
Is this page helpful?
Translate with Google
Copied to clipboard