Class TierConfigRequestResource

Updated: March 5, 2020
Contents

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

new TierConfigRequestResource(client)

Creates a new instance of the TierConfigRequestResource class.

Returns: TierConfigRequestResource – An instance of the TierConfigRequestResource class.

ParamTypeDescription
clientConnectClientAn instance of the ConnectClient class.

tierConfigRequestResource.fail(id, reason)

Changes the status of a TierConfigurationRequest to fail.

Kind: instance method of TierConfigRequestResource

ParamTypeDescription
idstringThe unique identifier of the TierConfigurationRequest object.
reasonstringThe reason for which the TierConfigurationRequest has been failed.

tierConfigRequestResource.inquire(id)

Changes the status of a TierConfigurationRequest to inquire.

Kind: instance method of TierConfigRequestResource

ParamTypeDescription
idstringThe unique identifier of the TierConfigurationRequest object.

tierConfigRequestResource.pending(id)

Changes the status of a TierConfigurationRequest to pending.

Kind: instance method of TierConfigRequestResource

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

ParamTypeDescription
idstringThe unique identifier of the TierConfigurationRequest object.
requestobjectThe request body.

Example

// request body using a template id
{
  template: {
    id: 'TL-000-000-000'
  }
}
Is this page helpful?
Translate with Google
Copied to clipboard