baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
39 lines (38 loc) • 1.98 kB
TypeScript
/**
* @module commerceProductSettingsRoute
* @description Baasic Product Settings Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic product Settings Route Service to obtain needed routes while other routes will be obtained through HAL. By convention, all route services use the same function names as their corresponding services.
*/
import { BaseRoute } from '../../../common';
import { IGetRequestOptions } from '../../../common/contracts';
import { IAppOptions } from '../../../core/contracts';
import { IProductSettings } from '.././contracts';
export declare class CommerceProductSettingsRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly getRoute: string;
readonly updateRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses get product settings route; this URI template doesn't expose any additional properties.
* @method
* @param options Options object that contains embed data.
* @example productSettingsRoute.get(options);
**/
get(options?: IGetRequestOptions): any;
/**
* Parses update product settings route; this URI template doesn't expose any additional properties.
* @method
* @param options Options object that contains embed data.
* @example productSettingsRoute.update(data);
**/
update(data: IProductSettings): any;
}
/**
* @copyright (c) 2017 Mono Ltd
* @license MIT
* @author Mono Ltd
* @overview
***Notes:**
- Refer to the [Baasic REST API](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
- [URI Template](https://github.com/Baasic/uritemplate-js) syntax enables expanding the Baasic route templates to Baasic REST URIs providing it with an object that contains URI parameters.
- All end-point objects are transformed by the associated route service.
*/