Class

TierConfigRequestResource

TierConfigRequestResource(client) → {TierConfigRequestResource}

The TierConfigRequestResource class provides methods to access the TierConfigRequest endpoint of the Cloud Blue Connect API.

Constructor

# new TierConfigRequestResource(client) → {TierConfigRequestResource}

Creates a new instance of the TierConfigRequestResource class.

Parameters:
Name Type Description
client ConnectClient

An instance of the ConnectClient class.

An instance of the TierConfigRequestResource class.

TierConfigRequestResource

Extends

Members

string

# baseUri

Returns the base URI of the resource mapped by this class.

Overrides:

Methods

# async 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.

Parameters:
Name Type Description
id string

The unique identifier of the TierConfigurationRequest object.
request object

The request body.

The rendered Template.

object
Example
// request body using a template id
{
  template: {
    id: 'TL-000-000-000'
  }
}

# async create(obj) → {object}

Create a new resource.

Parameters:
Name Type Description
obj object

The resource to create.
Overrides:

The created resource.

object

# async delete(id)

Delete a resource.

Parameters:
Name Type Description
id string

The unique identifier of the resource to delete.
Overrides:

# async fail(id, reason)

Changes the status of a TierConfigurationRequest to fail.

Parameters:
Name Type Description
id string

The unique identifier of the TierConfigurationRequest object.
reason string

The reason for which the TierConfigurationRequest has been failed.

# async fetch(url, options)

Fetch the URL and returns a response.

Parameters:
Name Type Description
url string

the URL to fetch.
options object

the request options.
Overrides:

# async get(id) → {object}

Retrieve a resource by its unique identifier.

Parameters:
Name Type Description
id string

The unique identifier of the resource to retrieve.
Overrides:

The resource.

object

# async inquire(id)

Changes the status of a TierConfigurationRequest to inquire.

Parameters:
Name Type Description
id string

The unique identifier of the TierConfigurationRequest object.

# async pending(id)

Changes the status of a TierConfigurationRequest to pending.

Parameters:
Name Type Description
id string

The unique identifier of the TierConfigurationRequest object.

Search for a resource.

Parameters:
Name Type Description
filters object

The query to send to the server as a RQL object.
Overrides:

An array of resources that match the provided filters.

Array

# async update(id, obj) → {object}

Update a resource.

Parameters:
Name Type Description
id string

The unique identifier of the resource to update.
obj object

The eventually partial resource to update.
Overrides:

The updated resource.

object