playbasis
Version:
Playbasis Javascript SDK
196 lines (176 loc) • 8.47 kB
JavaScript
;
/**
* Playbasis Goods API
* @namespace Playbasis.goodsApi
*/
module.exports = function(Playbasis) {
// utilize
var http = Playbasis.http;
var helpers = Playbasis.helpers;
// api base url
var apiMethod = "Goods";
// global object
var api = Playbasis.goodsApi = {};
/**
* Returns information about all available goods for the current site.
* @param {Object} options (**optional**) options as object.
* It can include
* {
* `player_id`: *String* = player id
* `active_filter`: *Boolean* = filter only active goods items based on today. It will include only item that has been started but not yet expired, but not include items that has not yet started or have a start date in the future. It can be set to true | false.
* `name`: *String* = name or group name of goods to search
* `date_start`: *String* = date start in the format YYYY-MM-DD (i.e. 1982-09-29) to filter goods whose valid start date is in specified range
* `date_end`: *String* = date expire in the format YYYY-MM-DD (i.e. 1982-09-29) to filter goods whose valid end date is in specified range
* `offset`: *String* = paging offset. Default is 0.
* `limit`: *Number* = paging limit. Default is unlimited.
* `tags`: *String* = delimit by comma
* `custom_param`: *String* = specific custom param(s) to filter for results. It needs to be in format `key` or `key|operator|value` in which operator can be "<", "<=", ">", ">=", "=", "!=". Such key needs to be set prior on dashboard first.
* `not_custom_param`: *String* = specific custom param(s) to filter for results. It needs to be in format `key` or `key|operator|value` in which operator can be "<", "<=", ">", ">=", "=", "!=". Such key needs to be set prior on dashboard first.
* }.
* @return {Object} Promise object
* @method goodsListInfo
* @memberOf Playbasis.goodsApi
*/
api.goodsListInfo = function(options)
{
var keys = ["player_id", "active_filter", "name", "date_start", "date_end", "offset", "limit", "tags", "custom_param", "not_custom_param"];
var defaultValues = [null, null, null, null, null, null, null, null, null, null];
return http.getJsonAsync(helpers.createApiUrl(apiMethod) + helpers.appendAndJoinIfNotNullAsUrlParam2(keys, defaultValues, options));
}
/**
* Return information about all available goods for the current site.
* @param {Object} options (**optional**) options as object.
* It can include
* {
* `player_id`: *String* = player id
* `selected_field`: *String* = fields that will be included result payload, delimited with comma and with no space i.e. field1,field2,field3.
* `active_filter`: *Boolean* = filter only active goods items based on today. It will include only item that has been started but not yet expired, but not include items that has not yet started or have a start date in the future. It can be set to true | false.
* `date_start`: *String* = date start in the format YYYY-MM-DD (i.e. 1982-09-29) to filter goods whose valid start date is in specified range
* `date_end`: *String* = date expire in the format YYYY-MM-DD (i.e. 1982-09-29) to filter goods whose valid end date is in specified range
* `offset`: *String* = paging offset. Default is 0.
* `limit`: *Number* = paging limit. Default is unlimited.
* `tags`: *String* = delimit by comma
* `custom_param`: *String* = specific custom param(s) to filter for results. It needs to be in format `key` or `key|operator|value` in which operator can be "<", "<=", ">", ">=", "=", "!=". Such key needs to be set prior on dashboard first.
* `not_custom_param`: *String* = specific custom param(s) to filter for results. It needs to be in format `key` or `key|operator|value` in which operator can be "<", "<=", ">", ">=", "=", "!=". Such key needs to be set prior on dashboard first.
* }
* @return {Object} Promise object
* @method goodsListInfoWithSelectedFields
* @memberOf Playbasis.goodsApi
*/
api.goodsListInfoWithSelectedFields = function(options)
{
var keys = ["player_id", "selected_field", "active_filter", "date_start", "date_end", "offset", "limit", "tags", "custom_param", "not_custom_param"];
var defaultValues = [null, null, null, null, null, null, null, null, null, null];
return http.getJsonAsync(helpers.createApiUrl(apiMethod, "field") + helpers.appendAndJoinIfNotNullAsUrlParam2(keys, defaultValues, options));
}
/**
* Returns information about the goods with the specified id.
* @param {String} goodsId goods id
* @param {Object} options (**optional**) options as object.
* It can include
* {
* `player_id`: *String*
* }
* @return {Object} Promise object
* @method goodsInfo
* @memberOf Playbasis.goodsApi
*/
api.goodsInfo = function(goodsId, options)
{
var keys = ["player_id"];
var dvalues = [null];
return http.getJsonAsync(helpers.createApiUrl(apiMethod, goodsId) + helpers.appendAndJoinIfNotNullAsUrlParam2(keys, dvalues, options));
}
/**
* Find number of available Goods given group.
* @param {String} playerId player id
* @param {String} group goods group
* @param {Object} options (**optional**) options as object.
* It can include
* {
* `amount`: *Number* = amount of the goods to redeem
* }
* @return {Object} Promise object
* @method goodsGroupAvailable
* @memberOf Playbasis.goodsApi
*/
api.goodsGroupAvailable = function(playerId, group, options)
{
var keys = ["player_id", "group", "amount"];
var dvalues = [playerId, group, null];
return http.getJsonAsync(helpers.createApiUrl("Redeem", "goodsGroup") + helpers.appendAndJoinIfNotNullAsUrlParam2(keys, dvalues, options));
}
/**
* Return information about all available sponsored goods.
* @return {Object} Promise object
* @method sponsoredGoodsListInfo
* @memberOf Playbasis.sponsoredGoodsListInfo
*/
api.sponsoredGoodsListInfo = function()
{
return http.getJsonAsync(helpers.createApiUrl(apiMethod, "sponsor"));
}
/**
* Returns information about the sponsored goods with the specified id.
* @param {String} goodsId goods id
* @return {Object} Promise object
* @method sponsoredGoodsInfo
* @memberOf Playbasis.sponsoredGoodsInfo
*/
api.sponsoredGoodsInfo = function(goodsId)
{
return http.getJsonAsync(helpers.createApiUrl(apiMethod, "sponsor", goodsId));
}
/**
* Find number of available sponsored Goods given group.
* @param {String} playerId player id
* @param {String} group goods group
* @param {Object} options (**optional**) options as object.
* It can include
* {
* `amount`: *Number* = amount of goods to redeem
* }
* @return {Object} Promise object
* @method sponsoredGoodsGroupAvailable
* @memberOf Playbasis.sponsoredGoodsGroupAvailable
*/
api.sponsoredGoodsGroupAvailable = function(playerId, group, options)
{
var keys = ["player_id", "group", "amount"];
var dvalues = [playerId, group, null];
return http.getJsonAsync(helpers.createApiUrl("Redeem", "sponsorGroup") + helpers.appendAndJoinIfNotNullAsUrlParam2(keys, dvalues, options));
}
/**
* Verify coupon code available.
* @param {String} goodsId goods id
* @param {String} couponCode coupon code of goods to verify
* @param {Object} options (**optional**) options as object.
* It can include
* {
* `player_id`: *String* = player id
* }
* @return {Object} Promise object
* @method verifyCoupon
* @memberOf Playbasis.verfiyCoupon
*/
api.verifyCoupon = function(goodsId, couponCode, options)
{
var keys = ["goods_id", "coupon_code", "player_id"];
var dvalues = [goodsId, couponCode, null];
return http.getJsonAsync(helpers.createApiUrl(apiMethod, "couponVerify") + helpers.appendAndJoinIfNotNullAsUrlParam2(keys, dvalues, options));
}
/**
* Verify coupon code available and redeem.
* @param {String} goodsId goods id
* @param {String} couponCode coupon code
* @param {String} playerId player id
* @return {Object} Promise object
* @method verifyCouponWithRedeem
* @memberOf Playbasis.verifyCouponWithRedeem
*/
api.verifyCouponWithRedeem = function(goodsId, couponCode, playerId)
{
var postObj = { token: Playbasis.env.global.token, goods_id: goodsId, coupon_code: couponCode, player_id: playerId };
return http.postJsonAsync(helpers.createApiUrl(apiMethod, "couponVerify"), postObj);
}
}