Merge pull request #54 from cloudblue/v19-dev

Changes for v19
cloudblue · Mar 19, 2020 · 76f4ee6 · 76f4ee6
2 parents f55566f + c6aa4b6
commit 76f4ee6
Show file tree

Hide file tree

Showing 202 changed files with 4,079 additions and 329 deletions.
diff --git a/README.md b/README.md
@@ -163,6 +163,7 @@ class UploadUsage extends \Connect\UsageAutomation
             //This is for Provider XYZ, also can be seen from $listing->provider->id and parametrized further via marketplace available at $listing->marketplace->id
             date_default_timezone_set('UTC'); //reporting must be always based on UTC
             $usages = [];
+            //Creating QT SCHEMA records, pplease check Connect\Usage\FileUsageRecord for further possible data to be passed
             array_push($usages, new Connect\Usage\FileUsageRecord([
                 'record_id' => 'unique record value',
                 'item_search_criteria' => 'item.mpn', //Possible values are item.mpn or item.local_id
@@ -174,7 +175,10 @@ class UploadUsage extends \Connect\UsageAutomation
                 'asset_search_value' => 'tenant2'
             ]));
             $usageFile = new \Connect\Usage\File([
-                'name' => 'sdk test',
+                "period" => [
+                        "from"=> date('Y-m-d H:i:s', strtotime("-1 days")),
+                        "to"=> date("Y-m-d H:i:s")
+                    ],
                 'product' => new \Connect\Product(
                     ['id' => $listing->product->id]
                 ),
@@ -248,6 +252,40 @@ try {
 }
 ```
 
+## A simple Example of automating workflow for Tier Account Requests
+```php
+
+require_once "vendor/autoload.php";
+class ProcessTAR extends \Connect\TierAccountRequestsAutomation
+{
+    public function processTierAccountRequest(\Connect\TierAccountRequest $request)
+    {
+        //$request is instance of \Connect\TierAccountRequest
+       try{
+            //Get changes
+            $changes = $request->account->diffWithPreviousVersion();
+
+            //Do something with external system to change TA data
+
+            throw new \Connect\TierAccountRequestAccept("Proocessed");
+       } 
+       catch (Exception $e){
+            throw new \Connect\TierAccountRequestIgnore("Issue while processing, we ignore");
+        }
+    }
+
+}
+
+//Main Code Block
+
+try{
+    $tarProcessor = new ProcessTar();
+    $tarProcessor->process();
+} catch (Exception $e) {
+    print "error ".$e->getMessage();
+}
+```
+
 ## Client class
 
 Starting with the Connect PHP SDK version 17 the Client class has been introduced. This class allows running multiple operations in Connect like get the list of requests, configurations, etc. Client class may be instantiated from any application to obtain information needed to run an operation, like, for example, get the Asset information in the context of an action. Client will provide access to:
@@ -337,3 +375,60 @@ $requests = $connect->fulfillment->listRequests(['status' => 'approved']);
 $connect = new Connect\ConnectClient();
 $request = $connect->fulfillment->getRequest('PR-XXXX-XXXX-XXXXX');
 ```
+
+* List all Tier Accoounts
+
+```php
+<?php
+$connect = new Connect\ConnectClient();
+//List all tier accounts from a given marketplace
+$tierAccounts = $connect->directory->listTierAccounts(['marketplace' => 'MP-XXXXXXX']);
+```
+
+* Get concrete Tier Account
+
+```php
+<?php
+$connect = new Connect\ConnectClient();
+$tierAccounts = $connect->directory->getTierAccountById('TA-XXXXXX-XXXXX');
+```
+
+* List tier account requests
+
+```php
+<?php
+$connect = new Connect\ConnectClient();
+$tar = $connect->directory->listTierAccountRequests(['status' => 'pending']);
+```
+
+* List Asset Subscriptions
+
+```php
+<?php
+$connect = new Connect\ConnectClient();
+$billingAssets = $connect->subscriptions->listSubscriptionAssets();
+```
+
+* Get Subscription Asset
+
+```php
+<?php
+$connect = new Connect\ConnectClient();
+$billingAsset = $connect->subscriptions->getSubscriptionAssetById('AS-1234-1234');
+```
+
+* Get Billing Subscription Requests
+
+```php
+<?php
+$connect = new Connect\ConnectClient();
+$billingRequests = $connect->subscriptions->listSubscriptionRequests();
+```
+
+* Get concrete Billing request
+
+```php
+<?php
+$connect = new Connect\ConnectClient();
+$billingAsset = $connect->subscriptions->getSubscriptionRequestById('PR-XXXXX-XXXXX-XXXXX');
+```
diff --git a/composer.json b/composer.json
@@ -12,12 +12,12 @@
         "psr/log": "^1.0.0",
         "pimple/pimple": "^3.0",
         "guzzlehttp/guzzle": "~6.0",
-        "phpoffice/phpspreadsheet": "^1.6"
+        "phpoffice/phpspreadsheet": "^1.6",
+        "lukascivil/treewalker": "^0.9"
     },
     "require-dev": {
         "phpunit/phpunit": "^5.7",
-        "mockery/mockery": "^1.0",
-	"lukascivil/treewalker": "^0.9"
+        "mockery/mockery": "^1.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpunit.xml b/phpunit.xml
@@ -10,9 +10,17 @@
     </logging>
     <testsuites>
         <testsuite name="Directory Services">
-            <file> tests/Unit/DirectoryTests/AssetTest.php</file>
-            <file> tests/Unit/DirectoryTests/ProductTest.php</file>
-            <file> tests/Unit/DirectoryTests/TierConfigTest.php</file>
+            <file>tests/Unit/DirectoryTests/AssetTest.php</file>
+            <file>tests/Unit/DirectoryTests/ProductTest.php</file>
+            <file>tests/Unit/DirectoryTests/TierConfigTest.php</file>
+            <file>tests/Unit/DirectoryTests/TierAccountsTest.php</file>
+        </testsuite>
+        <testsuite name="Subscription Services">
+            <file>tests/Unit/SubscriptionTests/SubscriptionRequestTest.php</file>
+        </testsuite>
+        <testsuite name="Tier Account Requests">
+            <file>tests/Unit/TierAccountRequests/ResponsesTest.php</file>
+            <file>tests/Unit/TierAccountRequests/TierAccountRequestsBasicsTest.php</file>
         </testsuite>
         <testsuite name="Fail">
             <file>tests/Unit/FulfillmentTests/FailTest.php</file>

diff --git a/src/Account.php b/src/Account.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Activation.php b/src/Activation.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/ActivationTemplateResponse.php b/src/ActivationTemplateResponse.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/ActivationTileResponse.php b/src/ActivationTileResponse.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Agreement.php b/src/Agreement.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Asset.php b/src/Asset.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/AutomationEngine.php b/src/AutomationEngine.php
@@ -3,12 +3,13 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;
 
 use Connect\Modules\Fulfillment;
+use Connect\Modules\Subscriptions;
 use Connect\Modules\TierConfiguration;
 use Connect\Modules\Usage;
 use Connect\Modules\Directory;
@@ -27,6 +28,7 @@
  * @property TierConfiguration $tierConfiguration
  * @property Usage $usage
  * @property Directory $directory
+ * @property Subscriptions $subscriptions
  * @package Connect
  */
 abstract class AutomationEngine

diff --git a/src/By.php b/src/By.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Choice.php b/src/Choice.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Config.php b/src/Config.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;
@@ -76,7 +76,8 @@ class Config extends Model
         'fulfillment' => '\Connect\Runtime\Providers\FulfillmentServiceProvider',
         'tierConfiguration' => '\Connect\Runtime\Providers\TierConfigurationServiceProvider',
         'usage' => '\Connect\Runtime\Providers\UsageServiceProvider',
-        'directory' => '\Connect\Runtime\Providers\DirectoryServiceProvider'
+        'directory' => '\Connect\Runtime\Providers\DirectoryServiceProvider',
+        'subscriptions' => '\Connect\Runtime\Providers\SubscriptionsServiceProvider'
     ];
 
     /**

diff --git a/src/Config/VaultConfig.php b/src/Config/VaultConfig.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect\Config;

diff --git a/src/ConfigException.php b/src/ConfigException.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/ConfigPropertyMissed.php b/src/ConfigPropertyMissed.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Configuration.php b/src/Configuration.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/ConnectClient.php b/src/ConnectClient.php
@@ -2,7 +2,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2018. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Connection.php b/src/Connection.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Constants.php b/src/Constants.php
@@ -2,7 +2,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2018. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;
@@ -11,10 +11,18 @@ class Constants
 {
     const USAGE_FILES_PATH = '/usage/files/';
     const SPREADSHEET_SHEET_NAME = 'usage_records';
+    const SPREADSHEET_SHEET_CATEGORIES = 'categories';
     const TIER_CONFIG_REQUESTS_PATH = '/tier/config-requests/';
     const REQUESTS_PATH = '/requests/';
     const APPROVE_SUFFIX = '/approve';
     const INQUIRE_SUFFIX = '/inquire';
     const FAIL_SUFFIX = '/fail';
+    const PRODUCTS_PATH = '/products/';
+    const TIER_ACCOUNTS_PATH = '/tier/accounts/';
+    const TIER_CONFIG_PATH = '/tier/configs/';
+    const TIER_ACCOUNT_REQUESTS_PATH = '/tier/account-requests/';
     const GENERIC_CONVERSATION_ERROR_MESSAGE = 'Error while saving result on conversation for request ';
+    const SUBSCRIPTIONS_ASSETS_PATH = '/subscriptions/assets/';
+    const SUBSCRIPTIONS_REQUESTS_PATH = '/subscriptions/requests/';
+    const ASSETS_PATH = '/assets/';
 }
diff --git a/src/Constraints.php b/src/Constraints.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Contact.php b/src/Contact.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/ContactInfo.php b/src/ContactInfo.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;

diff --git a/src/Contract.php b/src/Contract.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of the Ingram Micro Cloud Blue Connect SDK.
  *
- * @copyright (c) 2019. Ingram Micro. All Rights Reserved.
+ * @copyright (c) 2018-2020. Ingram Micro. All Rights Reserved.
  */
 
 namespace Connect;