baasic-sdk-angularjs
Version:
AngularJS SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
747 lines (721 loc) • 36.1 kB
JavaScript
/* globals module */
/**
* @module baasicNotificationsService
* @description Baasic Notifications Service provides an easy way to consume Baasic Notifications REST API end-points. In order to obtain needed routes `baasicNotificationsService` uses `baasicNotificationsRouteService`.
*/
(function (angular, module, undefined) {
'use strict';
module.service('baasicNotificationsService', ['baasicApp',
function (baasicApps) {
var baasicApp = baasicApps.get();
return {
publish: {
/**
* Returns a promise that is resolved once the create notification action has been performed; this action creates a new notification resource.
* @method publish.create
* @example
baasicNotificationsService.publish.create({
channels: ['<channel-name', '<channel-name>'],
moduleName: '<module-name>',
templateName: '<template-name>',
templateContext: {
prop1: '<prop1-value>',
prop2: '<prop2-value>'
}
})
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.publish.create(data);
},
batch: {
/**
* Returns a promise that is resolved once the create notification action has been performed; this action creates new notification resources.
* @method publish.batch.create
* @example
baasicNotificationsService.publish.create([{
channels: ['<channel-name', '<channel-name>'],
moduleName: '<module-name>',
templateName: '<template-name>',
templateContext: {
prop1: '<prop1-value>',
prop2: '<prop2-value>'
}
}])
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.publish.batch.create(data);
}
}
},
subscriptions: {
users: {
/**
* Returns a promise that is resolved once the create user subscription action has been performed; this action creates a new user subscription resource.
* @method subscriptions.users.create
* @example
baasicNotificationsService.subscriptions.users.create({
channel: '<channel-name>',
userId: '<user-id>'
})
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.subscriptions.users.create(data);
},
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of user subscription resources matching the given criteria.
* @method subscriptions.users.find
* @example
baasicNotificationsService.subscriptions.users.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>',
channels: '<channel-name1>,<channel-name2>',
userIds: '<user-id1>,<user-id2>',
embed: '<embed>'
})
.success(function (collection) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
find: function (options) {
return baasicApp.notificationModule.subscriptions.users.find(options);
},
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the specified user subscription resource.
* @method subscriptions.users.get
* @example
baasicNotificationsService.subscriptions.users.get('<subscription-id>')
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
get: function (id, options) {
return baasicApp.notificationModule.subscriptions.users.get(id, options);
},
/**
* Returns a promise that is resolved once the remove user subscription action has been performed. This action will remove a user subscription resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(subscription);
var uri = params['model'].links('delete').href;
```
* @method subscriptions.users.remove
* @example
// subscription is a resource previously fetched using get action.
baasicNotificationsService.subscriptions.users.remove(subscription)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
remove: function (data) {
return baasicApp.notificationModule.subscriptions.users.remove(data);
},
/**
* Returns a promise that is resolved once the update user subscription action has been performed; this action updates a user subscription resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.updateParams(subscription);
var uri = params['model'].links('put').href;
```
* @method subscriptions.users.update
* @example
// subscription is a resource previously fetched using get action.
subscription.channel = '<channel-name>';
baasicNotificationsService.subscriptions.users.update(subscription)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.subscriptions.users.update(data);
},
batch: {
/**
* Returns a promise that is resolved once the create user subscription action has been performed; this action creates new user subscription resources.
* @method subscriptions.users.batch.create
* @example
baasicNotificationsService.subscriptions.users.batch.create([{
channel: '<channel-name>',
userId: '<user-id>'
}])
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.subscriptions.batch.create(data);
},
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove user subscription resources from the system if successfully completed.
* @method subscriptions.users.batch.remove
* @example
baasicNotificationsService.subscriptions.users.batch.remove(subscriptionIds)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
remove: function (ids) {
return baasicApp.notificationModule.subscriptions.batch.remove(ids);
},
/**
* Returns a promise that is resolved once the update user subscriptions action has been performed; this action updates specified user subscription resources.
* @method subscriptions.users.batch.update
* @example
baasicNotificationsService.subscriptions.users.batch.update(subscriptions)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.subscriptions.batch.update(data);
}
}
},
anonymous: {
/**
* Returns a promise that is resolved once the create anonymous subscription action has been performed; this action creates a new anonymous subscription resource.
* @method subscriptions.anonymous.create
* @example
baasicNotificationsService.subscriptions.anonymous.create({
channel: '<channel-name>',
registrationId: '<registration-id>'
})
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.subscriptions.anonymous.create(data);
},
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of anonymous subscription resources matching the given criteria.
* @method subscriptions.anonymous.find
* @example
baasicNotificationsService.subscriptions.anonymous.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>',
channels: '<channel-name1>,<channel-name2>',
registrationIds: '<registration-id1>,<registration-id2>',
embed: '<embed>'
})
.success(function (collection) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
find: function (options) {
return baasicApp.notificationModule.subscriptions.anonymous.find(options);
},
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the specified anonymous subscription resource.
* @method subscriptions.anonymous.get
* @example
baasicNotificationsService.subscriptions.anonymous.get('<subscription-id>')
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
get: function (id, options) {
return baasicApp.notificationModule.subscriptions.anonymous.get(id, options);
},
/**
* Returns a promise that is resolved once the remove anonymous subscription action has been performed. This action will remove a anonymous subscription resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(subscription);
var uri = params['model'].links('delete').href;
```
* @method subscriptions.anonymous.remove
* @example
// subscription is a resource previously fetched using get action.
baasicNotificationsService.subscriptions.anonymous.remove(subscription)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
remove: function (data) {
return baasicApp.notificationModule.subscriptions.anonymous.remove(data);
},
/**
* Returns a promise that is resolved once the update anonymous subscription action has been performed; this action updates a anonymous subscription resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.updateParams(subscription);
var uri = params['model'].links('put').href;
```
* @method subscriptions.anonymous.update
* @example
// subscription is a resource previously fetched using get action.
subscription.channel = '<channel-name>';
baasicNotificationsService.update(subscription)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.subscriptions.anonymous.update(data);
},
batch: {
/**
* Returns a promise that is resolved once the create anonymous subscription action has been performed; this action creates new anonymous subscription resources.
* @method subscriptions.anonymous.batch.create
* @example
baasicNotificationsService.subscriptions.anonymous.batch.create([{
channel: '<channel-name>',
registrationId: '<registration-id>'
}])
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.subscriptions.anonymous.batch.create(data);
},
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove anonymous subscription resources from the system if successfully completed.
* @method subscriptions.anonymous.batch.remove
* @example
baasicNotificationsService.subscriptions.anonymous.batch.remove(subscriptionIds)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
remove: function (ids) {
return baasicApp.notificationModule.subscriptions.anonymous.batch.remove(ids);
},
/**
* Returns a promise that is resolved once the update anonymous subscriptions action has been performed; this action updates specified anonymous subscription resources.
* @method subscriptions.anonymous.batch.update
* @example
baasicNotificationsService.subscriptions.anonymous.batch.update(subscriptions)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.subscriptions.anonymous.batch.update(data);
}
}
}
},
registrations: {
users: {
/**
* Returns a promise that is resolved once the create user registration action has been performed; this action creates a new user registration resource.
* @method registrations.users.create
* @example
baasicNotificationsService.registrations.users.create({
provider: '<provider-name>',
providerData: <provider-data>,
userId: '<user-id>'
})
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.registrations.users.create(data);
},
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of user registrations resources matching the given criteria.
* @method registrations.users.find
* @example
baasicNotificationsService.registrations.users.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>',
providers: '<provider-name1>,<provider-name2>',
userIds: '<user-id1>,<user-id2>',
embed: '<embed>'
})
.success(function (collection) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
find: function (options) {
return baasicApp.notificationModule.registrations.users.find(options);
},
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the specified user registrations resource.
* @method registrations.users.get
* @example
baasicNotificationsService.registrations.users.get('<registration-id>')
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
get: function (id, options) {
return baasicApp.notificationModule.registrations.users.get(id, options);
},
/**
* Returns a promise that is resolved once the remove user registrations action has been performed. This action will remove a user registrations resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(registration);
var uri = params['model'].links('delete').href;
```
* @method registrations.users.remove
* @example
// registration is a resource previously fetched using get action.
baasicNotificationsService.registrations.users.remove(registration)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
remove: function (data) {
return baasicApp.notificationModule.registrations.users.remove(data);
},
/**
* Returns a promise that is resolved once the update user registration action has been performed; this action updates a user registration resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.updateParams(subsregistrationcription);
var uri = params['model'].links('put').href;
```
* @method registrations.users.update
* @example
// registration is a resource previously fetched using get action.
registration.provider = '<provider-name>';
baasicNotificationsService.registrations.users.update(registration)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.registrations.users.update(data);
},
batch: {
/**
* Returns a promise that is resolved once the create user registration action has been performed; this action creates new user registration resources.
* @method registrations.users.batch.create
* @example
baasicNotificationsService.registrations.users.batch.create([{
provider: '<provider-name>',
providerData: <provider-data>,
userId: '<user-id>'
}])
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.registrations.users.batch.create(data);
},
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove user registration resources from the system if successfully completed.
* @method registrations.users.batch.remove
* @example
baasicNotificationsService.registrations.users.batch.remove(subscriptionIds)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
remove: function (ids) {
return baasicApp.notificationModule.registrations.users.batch.remove(ids);
},
/**
* Returns a promise that is resolved once the update user registration action has been performed; this action updates specified user registration resources.
* @method registrations.users.batch.update
* @example
baasicNotificationsService.registrations.users.batch.update(registrations)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.registrations.users.batch.update(data);
}
}
},
anonymous: {
/**
* Returns a promise that is resolved once the create anonymous registration action has been performed; this action creates a new anonymous registration resource.
* @method registrations.anonymous.create
* @example
baasicNotificationsService.registrations.anonymous.create({
provider: '<provider-name>',
providerdata: <provider-data>,
expirationData: '<expiration-date>'
})
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.registrations.anonymous.create(data);
},
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of anonymous registration resources matching the given criteria.
* @method registrations.anonymous.find
* @example
baasicNotificationsService.registrations.anonymous.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>',
providers: '<provider-name1>,<provider-name2>',
embed: '<embed>'
})
.success(function (collection) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
find: function (options) {
return baasicApp.notificationModule.registrations.anonymous.find(options);
},
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the specified anonymous registration resource.
* @method registrations.anonymous.get
* @example
baasicNotificationsService.registrations.anonymous.get('<registration-id>')
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
get: function (id, options) {
return baasicApp.notificationModule.registrations.anonymous.get(id, options);
},
/**
* Returns a promise that is resolved once the remove anonymous registration action has been performed. This action will remove a anonymous registration resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(registration);
var uri = params['model'].links('delete').href;
```
* @method registrations.anonymous.remove
* @example
// registration is a resource previously fetched using get action.
baasicNotificationsService.registrations.anonymous.remove(registration)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
remove: function (data) {
return baasicApp.notificationModule.registrations.anonymous.remove(data);
},
/**
* Returns a promise that is resolved once the update anonymous registration action has been performed; this action updates a anonymous registration resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.updateParams(registration);
var uri = params['model'].links('put').href;
```
* @method registrations.anonymous.update
* @example
// registration is a resource previously fetched using get action.
subscription.provider = '<provider-name>';
baasicNotificationsService.update(registration)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.registrations.anonymous.update(data);
},
batch: {
/**
* Returns a promise that is resolved once the create anonymous registration action has been performed; this action creates new anonymous registration resources.
* @method registrations.anonymous.batch.create
* @example
baasicNotificationsService.registrations.anonymous.batch.create([{
provider: '<provider-name>',
providerData: <provider-data>,
expirationDate: <expiration-date>
}])
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
create: function (data) {
return baasicApp.notificationModule.registrations.anonymous.batch.create(data);
},
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove anonymous registration resources from the system if successfully completed.
* @method registrations.anonymous.batch.remove
* @example
baasicNotificationsService.registrations.anonymous.batch.remove(subscriptionIds)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
remove: function (ids) {
return baasicApp.notificationModule.registrations.anonymous.batch.remove(ids);
},
/**
* Returns a promise that is resolved once the update anonymous registration action has been performed; this action updates specified anonymous registration resources.
* @method registrations.anonymous.batch.update
* @example
baasicNotificationsService.registrations.anonymous.batch.update(registrations)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.registrations.anonymous.batch.update(data);
}
}
}
},
settings: {
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the specified setting resource.
* @method settings.get
* @example
baasicNotificationsService.settings.get('<provider-name>')
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
get: function (provider) {
return baasicApp.notificationModule.settings.get(provider);
},
/**
* Returns a promise that is resolved once the update settings action has been performed; this action updates a settings resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicNotificationsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.updateParams(settings);
var uri = params['model'].links('put').href;
```
* @method settings.update
* @example
// settings is a resource previously fetched using get action.
baasicNotificationsService.update(settings)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
*/
update: function (data) {
return baasicApp.notificationModule.settings.update(data);
}
},
/**
* Provides direct access to `baasicNotificationsRouteService`.
* @method
* @example baasicNotificationsService.routeService.publish.create({});
*/
routeService: baasicApp.notificationModule.routeDefinition
};
}
]);
}(angular, module));
/**
* @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.
*/