baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
63 lines (62 loc) • 3.23 kB
TypeScript
/**
* @module articleSettingsClient
* @description Article Settings Client provides an easy way to consume Article Settings REST API end-points. In order to obtain needed routes `articleSettingsClient` uses `articleSettingsRoute`.
*/
import { IGetRequestOptions } from '../../common/contracts';
import { ApiClient, IHttpResponse } from '../../httpApi';
import { ArticleSettingsRoute } from './';
import { IArticleSettings } from './contracts';
export declare class ArticleSettingsClient {
protected articleSettingsRoute: ArticleSettingsRoute;
protected apiClient: ApiClient;
/**
* Provides direct access to `baasicArticleSettingsRouteService`.
* @method
* @example articleSettingsClient.routeDefinition.get().expand(expandObject);
**/
readonly routeDefinition: ArticleSettingsRoute;
constructor(articleSettingsRoute: ArticleSettingsRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the article settings.
* @method
* @param options Options object that contains embed data.
* @returns A promise that is resolved once the get action has been performed.
* @example articleSettingsClient.get()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(options?: IGetRequestOptions): PromiseLike<IHttpResponse<any>>;
/**
* Returns a promise that is resolved once the update article settings action has been performed; this action updates article settings. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleSettingsRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(articleSettings);
* let uri = params['model'].links('put').href;
* ```
* @method
* @param options Options object that contains embed data.
* @returns A promise that is resolved once the update article settings action has been performed.
* @example // articleSettings is a resource previously fetched using get action.
articleSettings.allowArchive = true;
articleSettingsClient.update(articleSettings)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: IArticleSettings): PromiseLike<IHttpResponse<void>>;
}
/**
* @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.
- All end-point objects are transformed by the associated route service.
*/