Class

GenericResource

GenericResource(client, baseUri)

The GenericResource map a generic endpoint of the CloudBlue Connect API. Each API endpoint should extend this class and implements endpoint specific actions and subresources access.

Constructor

# new GenericResource(client, baseUri)

Parameters:
Name Type Description
client ConnectClient

A ConnectClient instance.
baseUri string

The base URI of the resource

Members

string

# baseUri

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

Methods

# async create(obj) → {object}

Create a new resource.

Parameters:
Name Type Description
obj object

The resource to create.

The created resource.

object

# async delete(id)

Delete a resource.

Parameters:
Name Type Description
id string

The unique identifier of the resource to delete.

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

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

The resource.

object

Search for a resource.

Parameters:
Name Type Description
filters object

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

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.

The updated resource.

object