Class Directory

Updated: March 10, 2021
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.

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
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
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
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
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
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
Returns: object – The created TierAccountRequest object.

Param Type Description
request object The TierAccountRequest object.

directory.searchTierAccountRequests(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.

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
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
Returns: object – The TierAccountRequest object.

Param Type Description
id string The unique identifier of the TierAccountRequest object.

directory.ignoreTierAccountRequest(id, reason) ⇒ object

Ignore the TierAccountRequest object identified by its id.

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

Param Type Description
id string The unique identifier of the TierAccountRequest object.
reason string The reason for which this request has been ignored.

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.

Param Type Description
id string The unique identifier of the TierAccount object.
version string The version to be retrieved.
Is this page helpful?
Translate with Google
Copied to clipboard