From 8f1d9f89ab6034b3ef7cca7bf466d3ac8c5dad54 Mon Sep 17 00:00:00 2001 From: aman-barbaria Date: Fri, 21 Feb 2020 18:05:50 +0530 Subject: [PATCH 1/8] Added module for redemptions & redeemable skus management OST APIs. --- .env.example | 4 +- CHANGELOG.md | 6 ++ README.md | 101 ++++++++++++++++++++++++++ VERSION | 2 +- src/Services/Base.php | 24 ++++++ src/Services/Manifest.php | 10 +++ src/Services/RedeemableSkus.php | 44 +++++++++++ src/Services/Redemptions.php | 45 ++++++++++++ tests/Services/RedeemableSkusTest.php | 47 ++++++++++++ tests/Services/RedemptionsTest.php | 49 +++++++++++++ tests/Services/ServiceTestBase.php | 4 +- 11 files changed, 333 insertions(+), 3 deletions(-) create mode 100644 src/Services/RedeemableSkus.php create mode 100644 src/Services/Redemptions.php create mode 100644 tests/Services/RedeemableSkusTest.php create mode 100644 tests/Services/RedemptionsTest.php diff --git a/.env.example b/.env.example index 6b1aae9..06558fe 100644 --- a/.env.example +++ b/.env.example @@ -9,4 +9,6 @@ OST_KIT_RECOVERY_OWNER_ADDRESS=RecoveryOwnerAddressOfUser OST_KIT_SESSION_ADDRESS=SessionAddressOfUser OST_KIT_RULE_ADDRESS=AddressForExecutingRule OST_KIT_USER2_TOKEN_HOLDER_ADDRESS=TokenHolderAddressForReceiver -OST_KIT_TRANSACTION_ID=TransactionIdUsedToTestGet \ No newline at end of file +OST_KIT_TRANSACTION_ID=TransactionIdUsedToTestGet +OST_KIT_REDEMPTION_ID=RedemptionIdUsedToTestGet +OST_KIT_REDEEMABLE_SKU_ID=RedeemableSkuIdUsedToTestGet \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ebe342..4487c46 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +[OST PHP SDK v2.2.3](https://github.com/ostdotcom/ost-sdk-php/tree/v2.2.3) +--- + +* Added redemptions module to call redemptions management OST APIs. +* Added redeemable sku module to call redeemable sku management OST APIs. + [OST PHP SDK v2.2.2](https://github.com/ostdotcom/ost-sdk-php/tree/v2.2.2) --- diff --git a/README.md b/README.md index fa9754e..0f117f8 100644 --- a/README.md +++ b/README.md @@ -610,6 +610,107 @@ For executing transactions, you need to understand the 4 modules described below echo json_encode($response, JSON_PRETTY_PRINT); ``` + +#### Redemptions Module + +* Initialize Redemptions service object to perform redemption specific actions. + + ```php + $redemptionsService = $ostObj->services->redemptions; + ``` + +* Get Redemption Detail using userId and redemptionId. + + ```php + // Mandatory API parameters + + // UserId of end-user. + $userId = 'ee8___'; + + // Unique identifier of the redemption to be retrieved. + redemptionId = 'f1d___'; + + $getParams = array(); + $getParams['user_id'] = $userId; + $getParams['redemption_id'] = $redemptionId; + $response = $redemptionsService->get($getParams)->wait(); + echo json_encode($response, JSON_PRETTY_PRINT); + ``` + +* Get User Redemption using userId. Pagination is supported by this API. + + ```php + // Mandatory API parameters + + // UserId of end-user. + $userId = 'ee89___'; + + // Optional API parameters + + // Array of redemption uuid values. + $userRedemptionUuids = array('aa79a057-3afc-4988-b7d3-b5bab0df5730'); + + // Limit. + $limit = 10; + + // Pagination identifier from the previous API call response. Not needed for page one. + $paginationIdentifier = 'eyJsY___'; + + $getParams = array(); + $getParams['user_id'] = $userId; + $getParams['user_redemption_uuids'] = $userRedemptionUuids; + $getParams['limit'] = $limit; + $getParams['pagination_identifier'] = $paginationIdentifier; + + $response = $redemptionsService->getList($getParams)->wait(); + echo json_encode($response, JSON_PRETTY_PRINT); + ``` + +#### RedeemableSkus Module + +* Initialize RedeemableSkus service object to perform redeemable skus specific actions. + + ```php + $redeemableSkusService = $ostObj->services->redeemableSkus; + ``` + +* Get RedeemableSkus Detail using redeemableSkuId. + + ```php + // Mandatory API parameters + + // Unique identifier of the redemption to be retrieved. + redeemableSkuId = 'f1d___'; + + $getParams = array(); + $getParams['redeemable_sku_id'] = redeemableSkuId; + $response = $redeemableSkusService->get($getParams)->wait(); + echo json_encode($response, JSON_PRETTY_PRINT); + ``` + +* Get List of RedeemableSkus using redeemableSkuId. Pagination is supported by this API. + + ```php + // Mandatory API parameters + + // Optional API parameters + + // Limit. + $limit = 10; + + // Pagination identifier from the previous API call response. Not needed for page one. + $paginationIdentifier = 'eyJsY___'; + + $getParams = array(); + $getParams['statuses'] = $statusesArray; + $getParams['limit'] = $limit; + $getParams['pagination_identifier'] = $paginationIdentifier; + + $response = $redeemableSkusService->getList($getParams)->wait(); + echo json_encode($response, JSON_PRETTY_PRINT); + ``` + + ### Tokens Module * Initialize Tokens service object to perform tokens specific actions. diff --git a/VERSION b/VERSION index b1b25a5..6b4d157 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.2.2 +2.2.3 \ No newline at end of file diff --git a/src/Services/Base.php b/src/Services/Base.php index c7c4c45..eeb13f8 100644 --- a/src/Services/Base.php +++ b/src/Services/Base.php @@ -131,6 +131,30 @@ protected function getTransactionId(array $params) return $this->getValueForKey($params, "transaction_id"); } + /** + * getRedemptionId from params array + * + * @param array $params request object which would fire API calls + * + * @return string + */ + protected function getRedemptionId(array $params) + { + return $this->getValueForKey($params, "redemption_id"); + } + + /** + * getRedeemableSkuId from params array + * + * @param array $params request object which would fire API calls + * + * @return string + */ + protected function getRedeemableSkuId(array $params) + { + return $this->getValueForKey($params, "redeemable_sku_id"); + } + /** * getRecoveryOwnerAddress from params array * diff --git a/src/Services/Manifest.php b/src/Services/Manifest.php index 33c59ce..dd9d467 100644 --- a/src/Services/Manifest.php +++ b/src/Services/Manifest.php @@ -32,6 +32,12 @@ class Manifest /** @var RecoveryOwners object which has methods to fire API's belonging to RecoveryOwners module */ public $recoveryOwners; + /** @var Redemptions object which has methods to fire API's belonging to Redemptions module */ + public $redemptions; + + /** @var RedeemableSkus object which has methods to fire API's belonging to RedeemableSkus module */ + public $redeemableSkus; + /** @var Rules object which has methods to fire API's belonging to Rules module */ public $rules; @@ -83,6 +89,10 @@ public function __construct($params) $this->recoveryOwners = new RecoveryOwners($requestObj); + $this->redemptions = new Redemptions($requestObj); + + $this->redeemableSkus = new RedeemableSkus($requestObj); + $this->rules = new Rules($requestObj); $this->sessions = new Sessions($requestObj); diff --git a/src/Services/RedeemableSkus.php b/src/Services/RedeemableSkus.php new file mode 100644 index 0000000..33bb1dd --- /dev/null +++ b/src/Services/RedeemableSkus.php @@ -0,0 +1,44 @@ +requestObj->get($this->getPrefix() . '/' . $this->getSuffix() . '/', $params); + } + + /** + * Get RedeemableSku details of a uuid + * + * @param array $params params for fetching details of a redeemable sku + * + * @return object + * + */ + public function get(array $params = array()) + { + return $this->requestObj->get($this->getPrefix() . '/' . $this->getSuffix() . '/' . $this->getRedeemableSkuId($params) . '/', $params); + } + +} diff --git a/src/Services/Redemptions.php b/src/Services/Redemptions.php new file mode 100644 index 0000000..fd1f0d4 --- /dev/null +++ b/src/Services/Redemptions.php @@ -0,0 +1,45 @@ +requestObj->get($this->getPrefix() . '/' . $this->getUserId($params) . $this->getSuffix() . '/', $params); + } + + /** + * Get Redemption details of a uuid + * + * @param array $params params for fetching details of a redemption + * + * @return object + * + */ + public function get(array $params = array()) + { + return $this->requestObj->get($this->getPrefix() . '/' . $this->getUserId($params) . $this->getSuffix() . '/' . $this->getRedemptionId($params) . '/', $params); + } + +} diff --git a/tests/Services/RedeemableSkusTest.php b/tests/Services/RedeemableSkusTest.php new file mode 100644 index 0000000..8c2a3b9 --- /dev/null +++ b/tests/Services/RedeemableSkusTest.php @@ -0,0 +1,47 @@ +ostObj->services->redeemableSkus; + $params = array(); + $params['redeemable_sku_id'] = $this->environmentVariables['redeemableSkuId']; + $response = $redeemableSkusService->get($params)->wait(); + $this->isSuccessResponse($response); + } + + /** + * + * Get all redeemableSkus + * + * @test + * + * @throws Exception + */ + public function getList() + { + $ostObj = $this->instantiateOSTSDKForV2Api(); + $redeemableSkusService = $ostObj->services->redeemableSkus; + $params = array(); + $response = $redeemableSkusService->getList($params)->wait(); + $this->isSuccessResponse($response); + } + +} diff --git a/tests/Services/RedemptionsTest.php b/tests/Services/RedemptionsTest.php new file mode 100644 index 0000000..5dff5af --- /dev/null +++ b/tests/Services/RedemptionsTest.php @@ -0,0 +1,49 @@ +ostObj->services->redemptions; + $params = array(); + $params['user_id'] = $this->environmentVariables['userId']; + $params['redemption_id'] = $this->environmentVariables['redemptionId']; + $response = $redemptionsService->get($params)->wait(); + $this->isSuccessResponse($response); + } + + /** + * + * Get all redemptions for a user + * + * @test + * + * @throws Exception + */ + public function getList() + { + $ostObj = $this->instantiateOSTSDKForV2Api(); + $redemptionsService = $ostObj->services->redemptions; + $params = array(); + $params['user_id'] = $this->environmentVariables['userId']; + $response = $redemptionsService->getList($params)->wait(); + $this->isSuccessResponse($response); + } + +} diff --git a/tests/Services/ServiceTestBase.php b/tests/Services/ServiceTestBase.php index b52a03c..157c16c 100644 --- a/tests/Services/ServiceTestBase.php +++ b/tests/Services/ServiceTestBase.php @@ -55,6 +55,8 @@ public function setEnvironmentVariables() $tempEnvironmentVariables['user2TokenHolderAddress'] = getenv('OST_KIT_USER2_TOKEN_HOLDER_ADDRESS'); $tempEnvironmentVariables['transactionId'] = getenv('OST_KIT_TRANSACTION_ID'); + $tempEnvironmentVariables['redemptionId'] = getenv('OST_KIT_REDEMPTION_ID'); + $tempEnvironmentVariables['redeemableSkuId'] = getenv('OST_KIT_REDEEMABLE_SKU_ID'); $tempEnvironmentVariables['companyUserId'] = getenv('OST_KIT_COMPANY_USER_ID'); return $tempEnvironmentVariables; } @@ -114,4 +116,4 @@ public function generateRandomAddress() { return "0x".$randomString; } -} \ No newline at end of file +} From c547c24bd1c6cf9aac19efff61861cc6e0509f4b Mon Sep 17 00:00:00 2001 From: aman-barbaria Date: Mon, 24 Feb 2020 15:48:09 +0530 Subject: [PATCH 2/8] readme changes for api param key change --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0f117f8..7f3d248 100644 --- a/README.md +++ b/README.md @@ -628,7 +628,7 @@ For executing transactions, you need to understand the 4 modules described below $userId = 'ee8___'; // Unique identifier of the redemption to be retrieved. - redemptionId = 'f1d___'; + $redemptionId = 'aa79a057-3afc-4988-b7d3-b5bab0df5730'; $getParams = array(); $getParams['user_id'] = $userId; @@ -648,7 +648,7 @@ For executing transactions, you need to understand the 4 modules described below // Optional API parameters // Array of redemption uuid values. - $userRedemptionUuids = array('aa79a057-3afc-4988-b7d3-b5bab0df5730'); + $redemptionIds = array('aa79a057-3afc-4988-b7d3-b5bab0df5730'); // Limit. $limit = 10; @@ -658,7 +658,7 @@ For executing transactions, you need to understand the 4 modules described below $getParams = array(); $getParams['user_id'] = $userId; - $getParams['user_redemption_uuids'] = $userRedemptionUuids; + $getParams['redemption_ids'] = $redemptionIds; $getParams['limit'] = $limit; $getParams['pagination_identifier'] = $paginationIdentifier; @@ -680,7 +680,7 @@ For executing transactions, you need to understand the 4 modules described below // Mandatory API parameters // Unique identifier of the redemption to be retrieved. - redeemableSkuId = 'f1d___'; + redeemableSkuId = '1'; $getParams = array(); $getParams['redeemable_sku_id'] = redeemableSkuId; @@ -701,8 +701,11 @@ For executing transactions, you need to understand the 4 modules described below // Pagination identifier from the previous API call response. Not needed for page one. $paginationIdentifier = 'eyJsY___'; + // Array of redeemable sku ids values. + $redeemableSkuIds = array('1'); + $getParams = array(); - $getParams['statuses'] = $statusesArray; + $getParams['redeemable_sku_ids'] = redeemableSkuIds; $getParams['limit'] = $limit; $getParams['pagination_identifier'] = $paginationIdentifier; From 80d7e30be3a8ee9e9d6134205efdd362dcf9575e Mon Sep 17 00:00:00 2001 From: shlokgilda Date: Tue, 25 Feb 2020 13:24:44 +0530 Subject: [PATCH 3/8] Updated readme. Signed-off-by: shlokgilda --- README.md | 206 +++++++++++++++++++++++++++--------------------------- 1 file changed, 102 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index 7f3d248..3132aa8 100644 --- a/README.md +++ b/README.md @@ -610,110 +610,6 @@ For executing transactions, you need to understand the 4 modules described below echo json_encode($response, JSON_PRETTY_PRINT); ``` - -#### Redemptions Module - -* Initialize Redemptions service object to perform redemption specific actions. - - ```php - $redemptionsService = $ostObj->services->redemptions; - ``` - -* Get Redemption Detail using userId and redemptionId. - - ```php - // Mandatory API parameters - - // UserId of end-user. - $userId = 'ee8___'; - - // Unique identifier of the redemption to be retrieved. - $redemptionId = 'aa79a057-3afc-4988-b7d3-b5bab0df5730'; - - $getParams = array(); - $getParams['user_id'] = $userId; - $getParams['redemption_id'] = $redemptionId; - $response = $redemptionsService->get($getParams)->wait(); - echo json_encode($response, JSON_PRETTY_PRINT); - ``` - -* Get User Redemption using userId. Pagination is supported by this API. - - ```php - // Mandatory API parameters - - // UserId of end-user. - $userId = 'ee89___'; - - // Optional API parameters - - // Array of redemption uuid values. - $redemptionIds = array('aa79a057-3afc-4988-b7d3-b5bab0df5730'); - - // Limit. - $limit = 10; - - // Pagination identifier from the previous API call response. Not needed for page one. - $paginationIdentifier = 'eyJsY___'; - - $getParams = array(); - $getParams['user_id'] = $userId; - $getParams['redemption_ids'] = $redemptionIds; - $getParams['limit'] = $limit; - $getParams['pagination_identifier'] = $paginationIdentifier; - - $response = $redemptionsService->getList($getParams)->wait(); - echo json_encode($response, JSON_PRETTY_PRINT); - ``` - -#### RedeemableSkus Module - -* Initialize RedeemableSkus service object to perform redeemable skus specific actions. - - ```php - $redeemableSkusService = $ostObj->services->redeemableSkus; - ``` - -* Get RedeemableSkus Detail using redeemableSkuId. - - ```php - // Mandatory API parameters - - // Unique identifier of the redemption to be retrieved. - redeemableSkuId = '1'; - - $getParams = array(); - $getParams['redeemable_sku_id'] = redeemableSkuId; - $response = $redeemableSkusService->get($getParams)->wait(); - echo json_encode($response, JSON_PRETTY_PRINT); - ``` - -* Get List of RedeemableSkus using redeemableSkuId. Pagination is supported by this API. - - ```php - // Mandatory API parameters - - // Optional API parameters - - // Limit. - $limit = 10; - - // Pagination identifier from the previous API call response. Not needed for page one. - $paginationIdentifier = 'eyJsY___'; - - // Array of redeemable sku ids values. - $redeemableSkuIds = array('1'); - - $getParams = array(); - $getParams['redeemable_sku_ids'] = redeemableSkuIds; - $getParams['limit'] = $limit; - $getParams['pagination_identifier'] = $paginationIdentifier; - - $response = $redeemableSkusService->getList($getParams)->wait(); - echo json_encode($response, JSON_PRETTY_PRINT); - ``` - - ### Tokens Module * Initialize Tokens service object to perform tokens specific actions. @@ -911,3 +807,105 @@ For executing transactions, you need to understand the 4 modules described below $response = $webhooksService->verifySignature($params); echo json_encode($response, JSON_PRETTY_PRINT); ``` + +### Redemptions Module + +* Initialize Redemptions service object to perform user redemption specific actions. + + ```php + $redemptionsService = $ostObj->services->redemptions; + ``` + +* Get User redemption detail using the userId and redemptionId. + + ```php + // Mandatory API parameters + + // UserId of user for whom redemption details needs to be fetched. + $userId = 'ee8___'; + + // RedemptionId of user. + $redemptionId = 'aa79a057-3afc-4988-b7d3-b5bab0df5730'; + + $getParams = array(); + $getParams['user_id'] = $userId; + $getParams['redemption_id'] = $redemptionId; + $response = $redemptionsService->get($getParams)->wait(); + echo json_encode($response, JSON_PRETTY_PRINT); + ``` + +* Get User Redemptions List. Pagination is supported by this API. + + ```php + // Mandatory API parameters + + // UserId of user for whom redemption details needs to be fetched. + $userId = 'ee89___'; + + // Optional API parameters + + // Array of user redemption uuids. + $redemptionIds = array('a743___', 'a743___'); + + // Limit. + $limit = 10; + + // Pagination identifier from the previous API call response. Not needed for page one. + $paginationIdentifier = 'eyJsY___'; + + $getParams = array(); + $getParams['user_id'] = $userId; + $getParams['redemption_ids'] = $redemptionIds; + $getParams['limit'] = $limit; + $getParams['pagination_identifier'] = $paginationIdentifier; + + $response = $redemptionsService->getList($getParams)->wait(); + echo json_encode($response, JSON_PRETTY_PRINT); + ``` + +#### RedeemableSkus Module + +* Initialize RedeemableSkus service object to perform redeemable skus specific actions. + + ```php + $redeemableSkusService = $ostObj->services->redeemableSkus; + ``` + +* Get Redeemable SKU detail using the redeemable SKU id. + + ```php + // Mandatory API parameters + + // RedeemableSkuId of product for whom details needs to be fetched. + redeemableSkuId = '1'; + + $getParams = array(); + $getParams['redeemable_sku_id'] = redeemableSkuId; + $response = $redeemableSkusService->get($getParams)->wait(); + echo json_encode($response, JSON_PRETTY_PRINT); + ``` + +* Get Redeemable SKUs List. Pagination is supported by this API. + + ```php + // Mandatory API parameters + + // Optional API parameters + + // Limit. + $limit = 10; + + // Pagination identifier from the previous API call response. Not needed for page one. + $paginationIdentifier = 'eyJsY___'; + + // Array of redeemable SKU ids. + $redeemableSkuIds = array('1'); + + $getParams = array(); + $getParams['redeemable_sku_ids'] = redeemableSkuIds; + $getParams['limit'] = $limit; + $getParams['pagination_identifier'] = $paginationIdentifier; + + $response = $redeemableSkusService->getList($getParams)->wait(); + echo json_encode($response, JSON_PRETTY_PRINT); + ``` From a31b7f36e0d1b57e188c626b7a80013dd2eaf4b4 Mon Sep 17 00:00:00 2001 From: shlokgilda Date: Tue, 25 Feb 2020 13:35:40 +0530 Subject: [PATCH 4/8] Updated readme. Signed-off-by: shlokgilda --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3132aa8..5e345bc 100644 --- a/README.md +++ b/README.md @@ -825,7 +825,7 @@ For executing transactions, you need to understand the 4 modules described below $userId = 'ee8___'; // RedemptionId of user. - $redemptionId = 'aa79a057-3afc-4988-b7d3-b5bab0df5730'; + $redemptionId = 'aa___'; $getParams = array(); $getParams['user_id'] = $userId; @@ -863,7 +863,7 @@ For executing transactions, you need to understand the 4 modules described below echo json_encode($response, JSON_PRETTY_PRINT); ``` -#### RedeemableSkus Module +### RedeemableSkus Module * Initialize RedeemableSkus service object to perform redeemable skus specific actions. From cb856f9729acf69566bbcb29228a7a73231e4fb4 Mon Sep 17 00:00:00 2001 From: shlokgilda Date: Tue, 25 Feb 2020 13:48:30 +0530 Subject: [PATCH 5/8] Bug fix. Signed-off-by: shlokgilda --- README.md | 6 +++--- src/Services/RedeemableSkus.php | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5e345bc..e4135e6 100644 --- a/README.md +++ b/README.md @@ -877,10 +877,10 @@ For executing transactions, you need to understand the 4 modules described below // Mandatory API parameters // RedeemableSkuId of product for whom details needs to be fetched. - redeemableSkuId = '1'; + $redeemableSkuId = '1'; $getParams = array(); - $getParams['redeemable_sku_id'] = redeemableSkuId; + $getParams['redeemable_sku_id'] = $redeemableSkuId; $response = $redeemableSkusService->get($getParams)->wait(); echo json_encode($response, JSON_PRETTY_PRINT); ``` @@ -902,7 +902,7 @@ For executing transactions, you need to understand the 4 modules described below $redeemableSkuIds = array('1'); $getParams = array(); - $getParams['redeemable_sku_ids'] = redeemableSkuIds; + $getParams['redeemable_sku_ids'] = $redeemableSkuIds; $getParams['limit'] = $limit; $getParams['pagination_identifier'] = $paginationIdentifier; diff --git a/src/Services/RedeemableSkus.php b/src/Services/RedeemableSkus.php index 33bb1dd..6fc8eb7 100644 --- a/src/Services/RedeemableSkus.php +++ b/src/Services/RedeemableSkus.php @@ -25,7 +25,7 @@ class RedeemableSkus extends Base */ public function getList(array $params = array()) { - return $this->requestObj->get($this->getPrefix() . '/' . $this->getSuffix() . '/', $params); + return $this->requestObj->get($this->getPrefix() . '/', $params); } /** @@ -38,7 +38,7 @@ public function getList(array $params = array()) */ public function get(array $params = array()) { - return $this->requestObj->get($this->getPrefix() . '/' . $this->getSuffix() . '/' . $this->getRedeemableSkuId($params) . '/', $params); + return $this->requestObj->get($this->getPrefix() . '/' . $this->getRedeemableSkuId($params) . '/', $params); } } From 62a46bcd576f797178f8ca149ec2da615d908e9e Mon Sep 17 00:00:00 2001 From: shlokgilda Date: Tue, 25 Feb 2020 15:32:38 +0530 Subject: [PATCH 6/8] Updated readme. Signed-off-by: shlokgilda --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e4135e6..a4ff870 100644 --- a/README.md +++ b/README.md @@ -899,7 +899,7 @@ For executing transactions, you need to understand the 4 modules described below $paginationIdentifier = 'eyJsY___'; // Array of redeemable SKU ids. - $redeemableSkuIds = array('1'); + $redeemableSkuIds = array('1', '2'); $getParams = array(); $getParams['redeemable_sku_ids'] = $redeemableSkuIds; From fd1ebf0cc58af6b0e10b820bd312a289781c4840 Mon Sep 17 00:00:00 2001 From: Dhananjay8 Date: Thu, 27 Feb 2020 16:04:57 +0530 Subject: [PATCH 7/8] updated readme --- README.md | 108 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 56 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index a4ff870..4efc11b 100644 --- a/README.md +++ b/README.md @@ -808,104 +808,108 @@ For executing transactions, you need to understand the 4 modules described below echo json_encode($response, JSON_PRETTY_PRINT); ``` -### Redemptions Module + +### Redemption Modules -* Initialize Redemptions service object to perform user redemption specific actions. +Two modules of redemption, "Redeemable SKUs" and "User Redemptions", are described below. + +#### Redeemable SKUs Module + +* Initialize Redeemable SKUs service object to perform redeemable skus specific actions. ```php - $redemptionsService = $ostObj->services->redemptions; + $redeemableSkusService = $ostObj->services->redeemableSkus; ``` - -* Get User redemption detail using the userId and redemptionId. + +* Get Redeemable SKU detail using the redeemable sku id. ```php // Mandatory API parameters - // UserId of user for whom redemption details needs to be fetched. - $userId = 'ee8___'; - - // RedemptionId of user. - $redemptionId = 'aa___'; - + // Fetch details of following redeemable sku. + $redeemableSkuId = '1'; + $getParams = array(); - $getParams['user_id'] = $userId; - $getParams['redemption_id'] = $redemptionId; - $response = $redemptionsService->get($getParams)->wait(); + $getParams['redeemable_sku_id'] = $redeemableSkuId; + $response = $redeemableSkusService->get($getParams)->wait(); echo json_encode($response, JSON_PRETTY_PRINT); ``` -* Get User Redemptions List. Pagination is supported by this API. +* Get Redeemable SKUs List. Pagination is supported by this API. ```php // Mandatory API parameters - - // UserId of user for whom redemption details needs to be fetched. - $userId = 'ee89___'; - + // NOTE: No mandatory parameters. + // Optional API parameters - - // Array of user redemption uuids. - $redemptionIds = array('a743___', 'a743___'); // Limit. $limit = 10; - // Pagination identifier from the previous API call response. Not needed for page one. - $paginationIdentifier = 'eyJsY___'; + // Array of redeemable SKU ids. + $redeemableSkuIds = array('1', '2'); + // Pagination identifier from the previous API call response. Not needed for page one. + $paginationIdentifier = 'eyJsY___'; + $getParams = array(); - $getParams['user_id'] = $userId; - $getParams['redemption_ids'] = $redemptionIds; + $getParams['redeemable_sku_ids'] = $redeemableSkuIds; $getParams['limit'] = $limit; $getParams['pagination_identifier'] = $paginationIdentifier; - - $response = $redemptionsService->getList($getParams)->wait(); + + $response = $redeemableSkusService->getList($getParams)->wait(); echo json_encode($response, JSON_PRETTY_PRINT); ``` + +#### User Redemptions Module -### RedeemableSkus Module - -* Initialize RedeemableSkus service object to perform redeemable skus specific actions. +* Initialize Redemptions service object to perform user redemption specific actions. ```php - $redeemableSkusService = $ostObj->services->redeemableSkus; + $redemptionsService = $ostObj->services->redemptions; ``` - -* Get Redeemable SKU detail using the redeemable SKU id. + +* Get User redemption details using the userId and redemptionId. ```php // Mandatory API parameters - - // RedeemableSkuId of product for whom details needs to be fetched. - $redeemableSkuId = '1'; - + + // UserId of user for whom redemption details needs to be fetched. + $userId = 'ee8___'; + + // Unique identifier of the redemption of user. + $redemptionId = 'aa___'; + $getParams = array(); - $getParams['redeemable_sku_id'] = $redeemableSkuId; - $response = $redeemableSkusService->get($getParams)->wait(); + $getParams['user_id'] = $userId; + $getParams['redemption_id'] = $redemptionId; + $response = $redemptionsService->get($getParams)->wait(); echo json_encode($response, JSON_PRETTY_PRINT); ``` -* Get Redeemable SKUs List. Pagination is supported by this API. +* Get User Redemptions List. Pagination is supported by this API. ```php // Mandatory API parameters - + $userId = 'ee89___'; + // Optional API parameters - + // Limit. $limit = 10; - + + // Array of user redemption uuids. + $redemptionIds = array('a743___', 'a743___'); + // Pagination identifier from the previous API call response. Not needed for page one. $paginationIdentifier = 'eyJsY___'; - - // Array of redeemable SKU ids. - $redeemableSkuIds = array('1', '2'); - + $getParams = array(); - $getParams['redeemable_sku_ids'] = $redeemableSkuIds; + $getParams['user_id'] = $userId; + $getParams['redemption_ids'] = $redemptionIds; $getParams['limit'] = $limit; $getParams['pagination_identifier'] = $paginationIdentifier; - - $response = $redeemableSkusService->getList($getParams)->wait(); + + $response = $redemptionsService->getList($getParams)->wait(); echo json_encode($response, JSON_PRETTY_PRINT); - ``` + ``` \ No newline at end of file From 5d2eeb4a1361b4b4144f71353458d23e54a73bad Mon Sep 17 00:00:00 2001 From: shlokgilda Date: Tue, 3 Mar 2020 21:21:40 +0530 Subject: [PATCH 8/8] Updated travis.yml Signed-off-by: shlokgilda --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 2326538..109ae36 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,7 +16,7 @@ php: - 5.6 - 7.0 - 7.1 - - 7.2 + - 7.3 env: - BUILD_ENV=TRAVIS before_install: