UNPKG

baasic-sdk-angularjs

Version:

AngularJS SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).

194 lines (137 loc) 5.45 kB
# baasicCommerceCountryService Baasic Commerce Country Service provides an easy way to consume Baasic Commerce REST API end-points. In order to obtain a needed routes `baasicCommerceCountryService` uses `baasicCommerceCountryRouteService`. * * * ### baasicCommerceCountryService.find() Returns a promise that is resolved once the find action has been performed. Success response returns a list of commerce resources matching the given criteria. **Example**: ```js baasicCommerceCountryService.find({ pageNumber : 1, pageSize : 10, orderBy : '<field>', orderDirection : '<asc|desc>', search : '<search-phrase>' }) .success(function (collection) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicCommerceCountryService.get() Returns a promise that is resolved once the get action has been performed. Success response returns the commerce resource. **Example**: ```js baasicCommerceCountryService.get('<country-id>') .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicCommerceCountryService.create() Returns a promise that is resolved once the create commerce action has been performed; this action creates a new commerce resource. **Example**: ```js baasicCommerceCountryService.create({ name : '<name>', abrv: '<abbreviation>', description: '<description>' }) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicCommerceCountryService.update() Returns a promise that is resolved once the update commerce action has been performed; this action updates a commerce resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicCommerceCountryRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects: ``` var params = baasicApiService.removeParams(commerceCountry); var uri = params['model'].links('put').href; ``` **Example**: ```js // commerceCountry is a resource previously fetched using get action. commerceCountry.phoneCode = '<phone-code>'; baasicCommerceCountryService.update(commerceCountry) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicCommerceCountryService.remove() Returns a promise that is resolved once the remove action has been performed. This action will remove a commerce resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicCommerceCountryRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects: ``` var params = baasicApiService.removeParams(commerceCountry); var uri = params['model'].links('delete').href; ``` **Example**: ```js // commerceCountry is a resource previously fetched using get action. baasicCommerceCountryService.remove(commerceCountry) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicCommerceCountryService.batch.create() Returns a promise that is resolved once the create commerce action has been performed; this action creates a new commerce resources. **Example**: ```js baasicCommerceCountryService.batch.create([{ name : '<name>', abrv: '<abbreviation>', description: '<description>' }]) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicCommerceCountryService.batch.remove() Returns a promise that is resolved once the remove commerce action has been performed. This action will remove commerce resources from the system if successfully completed. **Example**: ```js baasicCommerceCountryService.batch.remove(commerceCountryIds) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicCommerceCountryService.batch.update() Returns a promise that is resolved once the update commerce action has been performed; this action updates specified commerce resources. **Example**: ```js baasicCommerceCountryService.batch.update(commerceCountries) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicCommerceCountryService.routeService() Provides direct access to `routeService`. **Example**: ```js baasicCommerceCountryService.routeService.get(expandObject); ``` * * * **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. *(c) 2017 Mono Ltd* **Author:** Mono Ltd **License:** MIT