baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
106 lines (105 loc) • 5.84 kB
TypeScript
/**
* @module userWorkClient
* @description User Work Client provides route templates which can be expanded to REST URIs. Various services can use User Work Route Client 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 { IQueryModel, IGetRequestOptions, IOptions } from '../../../common/contracts';
import { ApiClient, IHttpResponse } from '../../../httpApi';
import { UserWorkRoute } from './';
import { IUserWork } from './contracts';
export declare class UserWorkClient {
protected userWorkRoute: UserWorkRoute;
protected apiClient: ApiClient;
readonly routeDefinition: UserWorkRoute;
constructor(userWorkRoute: UserWorkRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of user work 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 userWorkClient.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<IUserWork>>>;
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the user work resource.
* @method
* @param id User work id which uniquely identifies resource that needs to be retrieved.
* @param options Query resource options object.
* @example userWorkClient.get()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(id: string, options?: IGetRequestOptions): PromiseLike<IHttpResponse<IUserWork>>;
/**
* Returns a promise that is resolved once the create user work action has been performed; this action creates a new user work resource.
* @method
* @param data An user work object that needs to be inserted into the system.
* @returns A promise that is resolved once the create user work action has been performed.
* @example userWorkClient.create({ companyName : '<company-name>', userId: '<user-id>' })
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
create(data: IUserWork): PromiseLike<IHttpResponse<IUserWork>>;
/**
* Returns a promise that is resolved once the update user work action has been performed; this action updates a user work resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `userWorkRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(work);
* let uri = params['model'].links('put').href;
* ```
* @method
* @param data An user work object used to update specified user work resource.
* @returns A promise that is resolved once the update user work action has been performed.
* @example // work is a resource previously fetched using get action.
work.companyName = '<company-name>';
userWorkClient.update(work)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: IUserWork): PromiseLike<IHttpResponse<void>>;
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove a user work resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `userWorkRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(work);
* let uri = params['model'].links('delete').href;
* ```
* @method
* @example // work is a resource previously fetched using get action.
userWorkClient.remove(work)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
remove(data: IUserWork): 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 definition.
*/