Class

CaseResource

CaseResource(client) → {CaseResource}

The CaseResource class provides methods to access the case endpoint of the CloudBlue Connect API.

Constructor

# new CaseResource(client) → {CaseResource}

Creates a new instance of the CaseResource class.

Parameters:
Name Type Description
client ConnectClient

An instance of the ConnectClient class.

An instance of the CaseResource class.

CaseResource

Extends

Members

string

# baseUri

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

Overrides:

Methods

# attachments(id) → {CaseAttachmentsResource}

Returns an instance of the CaseAttachmentsResource for a Case.

Parameters:
Name Type Description
id string

The unique identifier of the Case.

An instance of the CaseAttachmentsResource for the case.

CaseAttachmentsResource

# async close(id, rating, feedback) → {CaseCommentsResource}

Set Case to close status.

Parameters:
Name Type Description
id string

The unique identifier of the Case.
rating rating

Rating of the case
feedback string

Feedback message

An instance of the CaseCommentsResource for the case.

CaseCommentsResource

# 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

# async inquire(id) → {CaseCommentsResource}

Set Case to inquire status.

Parameters:
Name Type Description
id string

The unique identifier of the Case.

An instance of the CaseCommentsResource for the case.

CaseCommentsResource

# async pend(id) → {CaseCommentsResource}

Set Case to pend status.

Parameters:
Name Type Description
id string

The unique identifier of the Case.

An instance of the CaseCommentsResource for the case.

CaseCommentsResource

# async resolve(id) → {CaseCommentsResource}

Set Case to resolve status.

Parameters:
Name Type Description
id string

The unique identifier of the Case.

An instance of the CaseCommentsResource for the case.

CaseCommentsResource

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

# settings(id) → {CaseSettingsResource}

Returns an instance of the CaseSettinsResource for a Case.

Parameters:
Name Type Description
id string

The unique identifier of the Case.

An instance of the CaseSettingsResource for the case.

CaseSettingsResource

# 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