Class

UsageFileResource

UsageFileResource(client) → {UsageFileResource}

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

Constructor

# new UsageFileResource(client) → {UsageFileResource}

Creates a new instance of the UsageFileResource class.

Parameters:
Name Type Description
client ConnectClient

An instance of the ConnectClient class.

An instance of the UsageFileResource class.

UsageFileResource

Extends

Members

string

# baseUri

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

Overrides:

Methods

# async accept(id, acceptanceNote) → {UsageFileResource}

Accept Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.
acceptanceNote string

Acceptance Note

An instance of the UsageFileResource.

UsageFileResource

# async approveAll(id) → {UsageFileResource}

Approve all Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.

An instance of the UsageFileResource

UsageFileResource

# categories(id) → {CategoryUsageFileResource}

Returns an instance of the CategoryUsageFileResource for a UsageFile.

Parameters:
Name Type Description
id string

The unique identifier of the UsageFile.

An instance of the CategoryUsageFileResource for the case.

CategoryUsageFileResource

# async close(id) → {UsageFileResource}

Close Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.

An instance of the UsageFileResource

UsageFileResource

# 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) → {UsageFileResource}

Delete Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.
Overrides:

An instance of the UsageFileResource

UsageFileResource

# 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 reconciliation(id, reconFile) → {UsageFileResource}

Reconciliation Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.
reconFile binary

Reconciliation binary file

An instance of the UsageFileResource.

UsageFileResource

# async reject(id, rejectionNote) → {UsageFileResource}

Reject Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.
rejectionNote text

Rejection note

An instance of the UsageFileResource.

UsageFileResource

# async reprocess(id) → {UsageFileResource}

Reprocess Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.

An instance of the UsageFileResource

UsageFileResource

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 submit(id) → {UsageFileResource}

Submit Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.

An instance of the UsageFileResource

UsageFileResource

# 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

# async upload(id, usageFile) → {UsageFileResource}

Upload Usage File.

Parameters:
Name Type Description
id string

The unique identifier of the Usage File.
usageFile binary

File to upload

An instance of the UsageFileResource.

UsageFileResource