baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
115 lines (114 loc) • 6.3 kB
TypeScript
/**
* @module languageClient
* @description Language Client provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Language 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 { IGetRequestOptions, IOptions, IQueryModel } from '../../common/contracts';
import { ApiClient, IHttpResponse } from '../../httpApi';
import { LanguageBatchClient, LanguageRoute } from './';
import { ILanguage } from './contracts';
export declare class LanguageClient {
protected languageBatchClient: LanguageBatchClient;
protected languageRoute: LanguageRoute;
protected apiClient: ApiClient;
readonly routeDefinition: LanguageRoute;
readonly batch: LanguageBatchClient;
constructor(languageBatchClient: LanguageBatchClient, languageRoute: LanguageRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of company resources matching the given criteria.
* @method
* @param options Query resource options object.
* @returns A promise that is resolved once the find action has been performed.
* @example languageClient.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<ILanguage>>>;
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the company resource.
* @method
* @param id Company id which uniquely identifies resource that needs to be retrieved.
* @returns A promise that is resolved once the get action has been performed.
* @param options Query resource options object.
* @example languageClient.get()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(id: string, options?: IGetRequestOptions): PromiseLike<IHttpResponse<ILanguage>>;
/**
* Returns a promise that is resolved once the create company action has been performed; this action creates a new company resource.
* @method
* @param data A company object that needs to be inserted into the system.
* @returns A promise that is resolved once the create company action has been performed.
* @example languageClient.create({
description : '<description>',
name : '<name>',
slug: '<slug>'
})
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
create(data: ILanguage): PromiseLike<IHttpResponse<ILanguage>>;
/**
* Returns a promise that is resolved once the update company action has been performed; this action updates a company resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `companyRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(company);
* let uri = params['model'].links('put').href;
* ```
* @method
* @param data A company object used to update specified company resource.
* @returns A promise that is resolved once the update company action has been performed.
* @example // company is a resource previously fetched using get action.
company.description = '<description>';
baasicCompanyService.update(company)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: ILanguage): PromiseLike<IHttpResponse<void>>;
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove a company resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `companyRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(company);
* let uri = params['model'].links('delete').href;
* ```
* @method
* @param data A company object used to delete specified company resource.
* @returns A promise that is resolved once the remove action has been performed.
* @example // company is a resource previously fetched using get action.
languageClient.remove(company)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
remove(data: ILanguage): PromiseLike<IHttpResponse<void>>;
}
/**
* @overview
***Notes:**
- Refer to the [REST API documentation](https://github.com/Baasic/baasic-rest-api/wiki) for detailed information about available Baasic REST API end-points.
- All end-point objects are transformed by the associated route service.
*/