baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
81 lines (80 loc) • 4.52 kB
TypeScript
/**
* @module commerceInvoiceClient
* @description Commerce Invoice Client provides an easy way to consume Commerce REST API end-points. In order to obtain a needed routes `commerceInvoiceClient` uses `commerceInvoiceRoute`.
*/
import { IQueryModel, IGetRequestOptions, IOptions } from '../../../common/contracts';
import { ApiClient, IHttpResponse } from '../../../httpApi';
import { CommerceInvoiceRoute, CommerceInvoiceStreamsClient } from '../';
export declare class CommerceInvoiceClient {
protected commerceInvoiceRoute: CommerceInvoiceRoute;
protected commerceInvoiceStreamsClient: CommerceInvoiceStreamsClient;
protected apiClient: ApiClient;
readonly routeDefinition: CommerceInvoiceRoute;
readonly streams: CommerceInvoiceStreamsClient;
constructor(commerceInvoiceRoute: CommerceInvoiceRoute, commerceInvoiceStreamsClient: CommerceInvoiceStreamsClient, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of commerce resources matching the given criteria.
* @method
* @example commerceInvoiceClient.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>'
})
.then(function (collection) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
find(options?: IOptions): PromiseLike<IHttpResponse<IQueryModel<any>>>;
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the commerce resource.
* @method
* @example commerceInvoiceClient.get()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(id: string, options?: IGetRequestOptions): PromiseLike<IHttpResponse<any>>;
/**
* Returns a promise that is resolved once the update commerce action has been performed; this action updates a commerce resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `commerceInvoiceRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(commerceInvoice);
* let uri = params['model'].links('put').href;
* ```
* @method
* @example // commerceInvoice is a resource previously fetched using get action.
commerceInvoice.invoiceStatusId : '<new-invoice-status-id>';
commerceInvoiceClient.update(commerceInvoice)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: any): PromiseLike<IHttpResponse<void>>;
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove a commerce resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `commerceInvoiceRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(commerceInvoice);
* let uri = params['model'].links('delete').href;
* ```
* @method
* @example // commerceInvoice is a resource previously fetched using get action.
commerceInvoiceClient.remove(commerceInvoice)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
remove(data: any): PromiseLike<IHttpResponse<void>>;
}