Constructor
# new Listings(client) → {Listings}
Creates an instance of the Listings class.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
ConnectClient | An instance of the ConnectClient class. |
An instance of the Listings class.
Methods
# async cancelListingRequest(id) → {object}
Cancel the ListingRequest object identified by its id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The unique identifier of the ListingRequest object. |
The ListingRequest object.
# async completeListingRequest(id) → {object}
Complete the ListingRequest object identified by its id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The unique identifier of the ListingRequest object. |
The ListingRequest object.
# async createListingRequest(request) → {object}
Creates a new ListingRequest
Parameters:
| Name | Type | Description |
|---|---|---|
request |
object | The ListingRequest object. |
The created ListingRequest object.
# async deployListingRequest(id) → {object}
Deploy the ListingRequest object identified by its id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The unique identifier of the ListingRequest object. |
The ListingRequest object.
# async getListingRequest(id) → {object}
Retrieve the ListingRequest object identified by its id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The unique identifier of the ListingRequest object. |
The ListingRequest object.
# async refineListingRequest(id) → {object}
Refine the ListingRequest object identified by its id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The unique identifier of the ListingRequest object. |
The ListingRequest object.
# async searchListingRequests(query) → {Array}
Returns a list of ListingRequest objects that match the provided (optional) query.
Parameters:
| Name | Type | Description |
|---|---|---|
query |
object | The optional query to filter results. |
An array of ListingRequest object optionally matching the provided query.
# async submitListingRequest(id) → {object}
Submit the ListingRequest object identified by its id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The unique identifier of the ListingRequest object. |
The ListingRequest object.