baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
64 lines (63 loc) • 3.46 kB
TypeScript
/**
* @module organizationBatchClient
* @description Organization Batch Client provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Organization Batch Route Definition 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 { ApiClient, IHttpResponse } from '../../httpApi';
import { OrganizationBatchRoute } from './';
import { IOrganization } from './contracts';
export declare class OrganizationBatchClient {
protected organizationBatchRoute: OrganizationBatchRoute;
protected apiClient: ApiClient;
readonly routeDefinition: OrganizationBatchRoute;
constructor(organizationBatchRoute: OrganizationBatchRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the create organization action has been performed; this action creates new organization resources.
* @method
* @param data A collection of organization objects that need to be inserted into the system.
* @returns A promise that is resolved once the create organization action has been performed.
* @example organizationBatchClient.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: IOrganization[]): PromiseLike<IHttpResponse<any>>;
/**
* Returns a promise that is resolved once the update organization action has been performed; this action updates specified organization resources.
* @method
* @param data A collection of organization objects used to update specified organization resources.
* @returns A promise that is resolved once the update organization action has been performed.
* @example organizationBatchClient.update(organizations)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: IOrganization[]): PromiseLike<IHttpResponse<void>>;
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove organization resources from the system if successfully completed.
* @method
* @example organizationBatchClient.remove(organizationIds)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
remove(ids: string[]): 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.
*/