Class

Directory

Directory(client) → {Directory}

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

Constructor

# new Directory(client) → {Directory}

Creates an instance of the Directory class.

Parameters:
Name Type Description
client ConnectClient

An instance of the ConnectClient class.

An instance of the Directory class.

Directory

Methods

# async acceptTierAccountRequest(id) → {object}

Accept the TierAccountRequest object identified by its id.

Parameters:
Name Type Description
id string

The unique identifier of the TierAccountRequest object.

The TierAccountRequest object.

object

# async createTierAccountRequest(request) → {object}

Creates a new TierAccountRequest

Parameters:
Name Type Description
request object

The TierAccountRequest object.

The created TierAccountRequest object.

object

# async getAssetsByProductIdExternalId(productId, externalId) → {Array}

Returns a list of Asset objects based on the productId and the Asset externalId.

Parameters:
Name Type Description
productId string

The unique id of the Product related to this Asset.
externalId string

The external identifier of the Asset.

An array of Asset objects.

Array

# async getTierAccount(id) → {object}

Retrieve a TierAccount by its id.

Parameters:
Name Type Description
id string

The unique identifier of the TierAccount object.

The TierAccount object.

object

# async getTierAccountRequest(id) → {object}

Retrieve the TierAccountRequest object identified by its id.

Parameters:
Name Type Description
id string

The unique identifier of the TierAccountRequest object.

The TierAccountRequest object.

object

# async getTierAccountVersion(id, version) → {object}

Returns the specified version of the TierAccount object identified by its id.

Parameters:
Name Type Description
id string

The unique identifier of the TierAccount object.
version string

The version to be retrieved.

The TierAccount object.

object

# async ignoreTierAccountRequest(id, reason) → {object}

Ignore the TierAccountRequest object identified by its id.

Parameters:
Name Type Description
id string

The unique identifier of the TierAccountRequest object.
reason string

The reason for which this request has been ignored.

The TierAccountRequest object.

object

# async searchAssets(query) → {Array}

Returns a list of Asset objects that match the provided (optional) query.

Parameters:
Name Type Description
query object

The optional query to filter results.

An array of Asset object optionally matching the provided query.

Array

# async searchTierAccountRequests(query) → {Array}

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

Parameters:
Name Type Description
query object

A RQL query.

An array of TierAccountRequest objects that match the provided filters.

Array

# async searchTierAccounts(query) → {Array}

Returns a list of TierAccount objects that match the provided (optional) query.

Parameters:
Name Type Description
query object

The optional query to filter results.

An array of TierAccount object optionally matching the provided query.

Array

# async searchTierConfigurations(query) → {Array}

Returns a list of TierConfiguration objects that match the provided (optional) query.

Parameters:
Name Type Description
query object

The optional query to filter results.

An array of TierConfiguration object optionally matching the provided query.

Array