Class Listings

Listings

The Listings class exposes specialized methods to help
developers to handle listings and listing requests.

Kind: global class
Category: Operations

• Listings
  • new Listings(client)
  • .searchListingRequests(query) ⇒ Array
  • .createListingRequest(request) ⇒ object
  • .getListingRequest(id) ⇒ object
  • .submitListingRequest(id) ⇒ object
  • .cancelListingRequest(id) ⇒ object
  • .refineListingRequest(id) ⇒ object
  • .completeListingRequest(id) ⇒ object
  • .deployListingRequest(id) ⇒ object

new Listings(client)

Creates an instance of the Listings class.

Returns: Listings – An instance of the Listings class.

Param	Type	Description
client	ConnectClient	An instance of the ConnectClient class.

listings.searchListingRequests(query) ⇒ Array

Returns a list of ListingRequest objects that match the provided
(optional) query.

Kind: instance method of Listings
Returns: Array – An array of ListingRequest object optionally matching
the provided query.

Param	Type	Description
query	object	The optional query to filter results.

listings.createListingRequest(request) ⇒ object

Creates a new ListingRequest

Kind: instance method of Listings
Returns: object – The created ListingRequest object.

Param	Type	Description
request	object	The ListingRequest object.

listings.getListingRequest(id) ⇒ object

Retrieve the ListingRequest object identified by its id.

Kind: instance method of Listings
Returns: object – The ListingRequest object.

Param	Type	Description
id	string	The unique identifier of the ListingRequest object.

listings.submitListingRequest(id) ⇒ object

Submit the ListingRequest object identified by its id.

Kind: instance method of Listings
Returns: object – The ListingRequest object.

Param	Type	Description
id	string	The unique identifier of the ListingRequest object.

listings.cancelListingRequest(id) ⇒ object

Cancel the ListingRequest object identified by its id.

Kind: instance method of Listings
Returns: object – The ListingRequest object.

Param	Type	Description
id	string	The unique identifier of the ListingRequest object.

listings.refineListingRequest(id) ⇒ object

Refine the ListingRequest object identified by its id.

Kind: instance method of Listings
Returns: object – The ListingRequest object.

Param	Type	Description
id	string	The unique identifier of the ListingRequest object.

listings.completeListingRequest(id) ⇒ object

Complete the ListingRequest object identified by its id.

Kind: instance method of Listings
Returns: object – The ListingRequest object.

Param	Type	Description
id	string	The unique identifier of the ListingRequest object.

listings.deployListingRequest(id) ⇒ object

Deploy the ListingRequest object identified by its id.

Kind: instance method of Listings
Returns: object – The ListingRequest object.

Param	Type	Description
id	string	The unique identifier of the ListingRequest object.