Class

UsageRecordResource

UsageRecordResource(client) → {UsageRecordResource}

The UsageFileResource class provides methods to access the usage file endpoint of the Cloud Blue Connect API.

Constructor

# new UsageRecordResource(client) → {UsageRecordResource}

Creates a new instance of the UsageRecordResource class.

Parameters:
Name Type Description
client ConnectClient

An instance of the ConnectClient class.

An instance of the UsageFileResource class.

UsageRecordResource

Extends

Members

string

# baseUri

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

Overrides:

Methods

# async close(id, externalBillingId, externalBillingNote) → {UsageChunkResource}

Close all Record File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.
externalBillingId string

Id of the billing to close record
externalBillingNote string

Note of the billing to close record

An instance of the UsageChunkResource.

UsageChunkResource

# async closeRecords(id, recordId, externalBillingId, externalBillingNote) → {UsageChunkResource}

Close Records Record File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.
recordId string

Id of the record to close
externalBillingId string

Id of the billing to close record
externalBillingNote string

Note of the billing to close record

An instance of the UsageChunkResource.

UsageChunkResource

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

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