Merge branch 'master' into master

Author: tareqtms

README.md

@@ -485,6 +485,15 @@ The custom methods are specific to some resources which may not be available for
     - [current()](https://help.shopify.com/api/reference/user#current)
     Get the current logged-in user
 
+### Shopify API features headers
+To send `X-Shopify-Api-Features` headers while using the SDK, you can use the following:
+
+```
+$config['ShopifyApiFeatures'] = ['include-presentment-prices'];
+$shopify = new PHPShopify\ShopifySDK($config);
+```
+
+
 ## Reference
 - [Shopify API Reference](https://help.shopify.com/api/reference/)
 

lib/Balance.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * @author Robert Jacobson <rjacobson@thexroadz.com>
+ * @author Matthew Crigger <mcrigger@thexroadz.com>
+ *
+ * @see https://help.shopify.com/en/api/reference/shopify_payments/balance Shopify API Reference for Shopify Payment Balance
+ */
+
+namespace PHPShopify;
+
+/**
+ * --------------------------------------------------------------------------
+ * ShopifyPayment -> Child Resources
+ * --------------------------------------------------------------------------
+ *
+ *
+ */
+class Balance extends ShopifyResource
+{
+    /**
+     * @inheritDoc
+     */
+    protected $resourceKey = 'balance';
+
+    /**
+     * Get the pluralized version of the resource key
+     *
+     * Normally its the same as $resourceKey appended with 's', when it's different, the specific resource class will override this function
+     *
+     * @return string
+     */
+    protected function pluralizeKey()
+    {
+        return $this->resourceKey;
+    }
+
+    /**
+     * If the resource is read only. (No POST / PUT / DELETE actions)
+     *
+     * @var boolean
+     */
+    public $readOnly = true;
+
+    /**
+     * @inheritDoc
+     */
+    protected $childResource = array(
+        'Transactions'
+    );
+}

lib/Customer.php

@@ -22,7 +22,7 @@
  * --------------------------------------------------------------------------
  * Customer -> Custom actions
  * --------------------------------------------------------------------------
- * @method array search()      Search for customers matching supplied query
+ * @method array search(string $query = '')      Search for customers matching supplied query
  */
 class Customer extends ShopifyResource
 {
@@ -77,4 +77,4 @@ public function account_activation_url($customer_id = 0)
         $url = $this->generateUrl(array(), $customer_id.'/account_activation_url');
         return $this->post(array(), $url, false);
     }
-}
+}

lib/Payouts.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * @author Robert Jacobson <rjacobson@thexroadz.com>
+ * @author Matthew Crigger <mcrigger@thexroadz.com>
+ *
+ * @see https://help.shopify.com/en/api/reference/shopify_payments/payout Shopify API Reference for Shopify Payment Payouts
+ */
+
+namespace PHPShopify;
+
+/**
+ * --------------------------------------------------------------------------
+ * ShopifyPayment -> Child Resources
+ * --------------------------------------------------------------------------
+ *
+ *
+ */
+class Payouts extends ShopifyResource
+{
+    /**
+     * @inheritDoc
+     */
+    protected $resourceKey = 'payout';
+}

lib/Refund.php

@@ -14,7 +14,7 @@
  * --------------------------------------------------------------------------
  * Refund -> Custom actions
  * --------------------------------------------------------------------------
- * @method array calculate()      Calculate a Refund.
+ * @method array calculate(array $calculation = null)      Calculate a Refund.
  *
  */
 class Refund extends ShopifyResource
@@ -30,4 +30,4 @@ class Refund extends ShopifyResource
     protected $customPostActions = array (
         'calculate',
     );
-}
+}

lib/ShopifyPayment.php

@@ -18,6 +18,15 @@
  *
  * @method ShopifyResource Dispute(integer $id = null)
  *
+ * @property-read ShopifyResource $Balance
+ *
+ * @method ShopifyResource Balance(integer $id = null)
+ *
+ * @property-read ShopifyResource $Payouts
+ *
+ * @method ShopifyResource Payouts(integer $id = null)
+ *
+
  */
 class ShopifyPayment extends ShopifyResource
 {
@@ -26,10 +35,19 @@ class ShopifyPayment extends ShopifyResource
      */
     public $resourceKey = 'shopify_payment';
 
+    /**
+     * If the resource is read only. (No POST / PUT / DELETE actions)
+     *
+     * @var boolean
+     */
+    public $readOnly = true;
+
     /**
      * @inheritDoc
      */
     protected $childResource = array(
-        'Dispute'
+        'Balance',
+        'Dispute',
+        'Payouts',
     );
 }

lib/ShopifyResource.php

@@ -149,6 +149,12 @@ public function __construct($id = null, $parentResourceUrl = '')
         } elseif (!isset($config['ApiKey']) || !isset($config['Password'])) {
             throw new SdkException("Either AccessToken or ApiKey+Password Combination (in case of private API) is required to access the resources. Please check SDK configuration!");
         }
+
+        if (isset($config['ShopifyApiFeatures'])) {
+            foreach($config['ShopifyApiFeatures'] as $apiFeature) {
+                $this->httpHeaders['X-Shopify-Api-Features'] = $apiFeature;
+            }
+        }
     }
 
     /**

lib/ShopifySDK.php

@@ -146,6 +146,7 @@
  * @method ScriptTag ScriptTag(integer $id = null)
  * @method ShippingZone ShippingZone(integer $id = null)
  * @method Shop Shop(integer $id = null)
+ * @method ShopifyPayment ShopifyPayment()
  * @method SmartCollection SmartCollection(integer $id = null)
  * @method Theme Theme(int $id = null)
  * @method User User(integer $id = null)
@@ -235,16 +236,20 @@ class ShopifySDK
     protected $childResources = array(
         'Article'           => 'Blog',
         'Asset'             => 'Theme',
+        'Balance'           => 'ShopifyPayment',
         'CustomerAddress'   => 'Customer',
+        'Dispute'           => 'ShopifyPayment',
         'Fulfillment'       => 'Order',
         'FulfillmentEvent'  => 'Fulfillment',
         'OrderRisk'         => 'Order',
+        'Payouts'           => 'ShopifyPayment',
         'ProductImage'      => 'Product',
         'ProductVariant'    => 'Product',
         'DiscountCode'      => 'PriceRule',
         'Province'          => 'Country',
         'Refund'            => 'Order',
         'Transaction'       => 'Order',
+        'Transactions'      => 'Balance',
         'UsageCharge'       => 'RecurringApplicationCharge',
     );
 

lib/Transactions.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * @author Robert Jacobson <rjacobson@thexroadz.com>
+ * @author Matthew Crigger <mcrigger@thexroadz.com>
+ *
+ * @see https://help.shopify.com/en/api/reference/shopify_payments/transaction Shopify API Reference for Shopify Payment Transactions
+ */
+
+namespace PHPShopify;
+
+
+class Transactions extends ShopifyResource
+{
+    /**
+     * @inheritDoc
+     */
+    protected $resourceKey = 'transaction';
+
+    /**
+     * If the resource is read only. (No POST / PUT / DELETE actions)
+     *
+     * @var boolean
+     */
+    public $readOnly = true;
+}