Class

ListingRequestResource

ListingRequestResource(client) → {ListingRequestResource}

The ListingRequestResource class provides methods to access the listing requests endpoint of the Cloud Blue Connect API.

Constructor

# new ListingRequestResource(client) → {ListingRequestResource}

Creates a new instance of the ListingRequestResource class.

Parameters:
Name Type Description
client ConnectClient

An instance of the ConnectClient class.

An instance of the ListingRequestResource class.

ListingRequestResource

Extends

Members

string

# baseUri

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

Overrides:

Methods

# async cancel(id)

Cancel the ListingRequest.

Parameters:
Name Type Description
id string

The unique identifier of the ListingRequest object.

# async complete(id)

Complete the ListingRequest.

Parameters:
Name Type Description
id string

The unique identifier of the ListingRequest object.

# 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 deploy(id)

Deploy the ListingRequest.

Parameters:
Name Type Description
id string

The unique identifier of the ListingRequest object.

# 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 refine(id)

Refine the ListingRequest.

Parameters:
Name Type Description
id string

The unique identifier of the ListingRequest 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 submit(id)

Submit the ListingRequest.

Parameters:
Name Type Description
id string

The unique identifier of the ListingRequest object.

# 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