Commit c0103f9

authored

Merge pull request #299 from whobutsb/feature/giftcard-adjustments

Gift Card Adjustment Resource

2 parents eb26e68 + 589ebb8 commit c0103f9Copy full SHA for c0103f9

File tree

+52

-1

lines changed

+52

-1

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -357,6 +357,7 @@ Some resources are available directly, some resources are only available through`
`357`	`357`	`- FulfillmentOrder -> [FulfillmentRequest](https://shopify.dev/api/admin-rest/2023-01/resources/fulfillmentrequest)`
`358`	`358`	`- FulfillmentOrder -> [Fulfillment](https://shopify.dev/api/admin-rest/2023-01/resources/fulfillment)`
`359`	`359`	`- [GiftCard](https://help.shopify.com/api/reference/gift_card) _(Shopify Plus Only)_`
	`360`	`+- GiftCard -> [Adjustment](https://shopify.dev/docs/api/admin-rest/2023-01/resources/gift-card-adjustment) _(Shopify Plus Only)_`
`360`	`361`	`- [InventoryItem](https://help.shopify.com/api/reference/inventoryitem)`
`361`	`362`	`- [InventoryLevel](https://help.shopify.com/api/reference/inventorylevel)`
`362`	`363`	`- [Location](https://help.shopify.com/api/reference/location/) _(read only)_`

Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -45,4 +45,11 @@ public function disable()`
`45`	`45`
`46`	`46`	`return $this->post($dataArray, $url);`
`47`	`47`	`}`
`48`		`-}`
	`48`	`+`
	`49`	`+ /**`
	`50`	`+ * @inheritDoc`
	`51`	`+ */`
	`52`	`+ protected $childResource = array(`
	`53`	`+ 'GiftCardAdjustment' => 'Adjustment'`
	`54`	`+ );`
	`55`	`+}`

Lines changed: 40 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,40 @@`
	`1`	`+<?php`
	`2`	`+/**`
	`3`	`+ * Created by PhpStorm.`
	`4`	`+ * @author Tareq Mahmood <tareqtms@yahoo.com>`
	`5`	`+ * Created at: 8/21/16 8:39 AM UTC+06:00`
	`6`	`+ *`
	`7`	`+ * @see https://shopify.dev/docs/api/admin-rest/2023-01/resources/gift-card-adjustment Shopify API Reference for Gift Card Adjustment`
	`8`	`+ * @note - requires gift_card_adjustments access scope enabled by Shopify Support`
	`9`	`+ *`
	`10`	`+ * @usage:`
	`11`	`+ *`
	`12`	`+ $shopify = \PHPShopify\ShopifySDK::config($config);`
	`13`	`+`
	`14`	`+ $gift_card_id = 88888888888;`
	`15`	`+`
	`16`	`+ $gift_card_adjustment_id = 999999999999;`
	`17`	`+`
	`18`	`+ // Get all gift card adjustments`
	`19`	`+ $shopify->GiftCard($gift_card_id)->Adjustment()->get();`
	`20`	`+`
	`21`	`+ // Get a single gift card adjustment`
	`22`	`+ $shopify->GiftCard($gift_card_id)->Adjustment($gift_card_adjustment_id)->get();`
	`23`	`+`
	`24`	`+ // Create a gift card adjustment`
	`25`	`+ $shopify->GiftCard($gift_card_id)->Adjustment()->post([`
	`26`	`+ 'amount' => 5,`
	`27`	`+ 'note' => 'Add 5ドル to gift card'`
	`28`	`+ ]);`
	`29`	`+ */`
	`30`	`+`
	`31`	`+namespace PHPShopify;`
	`32`	`+`
	`33`	`+`
	`34`	`+class GiftCardAdjustment extends ShopifyResource`
	`35`	`+{`
	`36`	`+ /**`
	`37`	`+ * @inheritDoc`
	`38`	`+ */`
	`39`	`+ protected $resourceKey = 'adjustment';`
	`40`	`+}`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,7 @@`
`90`	`90`	`* @property-read Fulfillment $Fulfillment`
`91`	`91`	`* @property-read FulfillmentService $FulfillmentService`
`92`	`92`	`* @property-read GiftCard $GiftCard`
	`93`	`+ * @property-read GiftCardAdjustment $GiftCardAdjustment`
`93`	`94`	`* @property-read InventoryItem $InventoryItem`
`94`	`95`	`* @property-read InventoryLevel $InventoryLevel`
`95`	`96`	`* @property-read Location $Location`
`@@ -140,6 +141,7 @@`
`140`	`141`	`* @method FulfillmentService FulfillmentService(integer $id = null)`
`141`	`142`	`* @method FulfillmentOrder FulfillmentOrder(integer $id = null)`
`142`	`143`	`* @method GiftCard GiftCard(integer $id = null)`
	`144`	`+ * @method GiftCardAdjustment GiftCardAdjustment(integer $id = null)`
`143`	`145`	`* @method InventoryItem InventoryItem(integer $id = null)`
`144`	`146`	`* @method InventoryLevel InventoryLevel(integer $id = null)`
`145`	`147`	`* @method Location Location(integer $id = null)`
`@@ -261,6 +263,7 @@ class ShopifySDK`
`261`	`263`	`'Dispute' => 'ShopifyPayment',`
`262`	`264`	`'Fulfillment' => 'Order',`
`263`	`265`	`'FulfillmentEvent' => 'Fulfillment',`
	`266`	`+ 'GiftCardAdjustment'=> 'GiftCard',`
`264`	`267`	`'OrderRisk' => 'Order',`
`265`	`268`	`'Payouts' => 'ShopifyPayment',`
`266`	`269`	`'ProductImage' => 'Product',`

Comments

(0)