Update retrieve method documentation to accept arrays

Retrieve methods can take an array in some cases like when an expansion is requested. This patch updates documentation to better show that. Fixes stripe#346.
kanasite · May 10, 2017 · 343b3da · 343b3da
1 parent 0757eb4
commit 343b3da
Show file tree

Hide file tree

Showing 28 changed files with 28 additions and 28 deletions.
diff --git a/lib/Account.php b/lib/Account.php
@@ -47,7 +47,7 @@ public function instanceUrl()
     }
 
     /**
-     * @param string|null $id
+     * @param array|string|null $id
      * @param array|string|null $opts
      *
      * @return Account

diff --git a/lib/ApplePayDomain.php b/lib/ApplePayDomain.php
@@ -20,7 +20,7 @@ public static function classUrl()
     }
 
     /**
-     * @param string $id The ID of the domain to retrieve.
+     * @param array|string $id The ID of the domain to retrieve.
      * @param array|string|null $opts
      *
      * @return ApplePayDomain

diff --git a/lib/ApplicationFee.php b/lib/ApplicationFee.php
@@ -21,7 +21,7 @@ public static function className()
     }
 
     /**
-     * @param string $id The ID of the application fee to retrieve.
+     * @param array|string $id The ID of the application fee to retrieve.
      * @param array|string|null $opts
      *
      * @return ApplicationFee

diff --git a/lib/BalanceTransaction.php b/lib/BalanceTransaction.php
@@ -34,7 +34,7 @@ public static function classUrl()
     }
 
     /**
-     * @param string $id The ID of the balance transaction to retrieve.
+     * @param array|string $id The ID of the balance transaction to retrieve.
      * @param array|string|null $opts
      *
      * @return BalanceTransaction

diff --git a/lib/BitcoinReceiver.php b/lib/BitcoinReceiver.php
@@ -37,7 +37,7 @@ public function instanceUrl()
     }
 
     /**
-     * @param string $id The ID of the Bitcoin Receiver to retrieve.
+     * @param array|string $id The ID of the Bitcoin Receiver to retrieve.
      * @param array|string|null $opts
      *
      * @return BitcoinReceiver

diff --git a/lib/Charge.php b/lib/Charge.php
@@ -41,7 +41,7 @@
 class Charge extends ApiResource
 {
     /**
-     * @param string $id The ID of the charge to retrieve.
+     * @param array|string $id The ID of the charge to retrieve.
      * @param array|string|null $options
      *
      * @return Charge

diff --git a/lib/CountrySpec.php b/lib/CountrySpec.php
@@ -21,7 +21,7 @@ public static function className()
     }
 
     /**
-     * @param string $country The ISO country code of the country we retrieve the CountrySpec for.
+     * @param array|string $country The ISO country code of the country we retrieve the CountrySpec for.
      * @param array|string|null $opts
      *
      * @return CountrySpec

diff --git a/lib/Coupon.php b/lib/Coupon.php
@@ -10,7 +10,7 @@
 class Coupon extends ApiResource
 {
     /**
-     * @param string $id The ID of the coupon to retrieve.
+     * @param array|string $id The ID of the coupon to retrieve.
      * @param array|string|null $opts
      *
      * @return Coupon

diff --git a/lib/Customer.php b/lib/Customer.php
@@ -27,7 +27,7 @@
 class Customer extends ApiResource
 {
     /**
-     * @param string $id The ID of the customer to retrieve.
+     * @param array|string $id The ID of the customer to retrieve.
      * @param array|string|null $opts
      *
      * @return Customer

diff --git a/lib/Dispute.php b/lib/Dispute.php
@@ -25,7 +25,7 @@
 class Dispute extends ApiResource
 {
     /**
-     * @param string $id The ID of the dispute to retrieve.
+     * @param array|string $id The ID of the dispute to retrieve.
      * @param array|string|null $options
      *
      * @return Dispute

diff --git a/lib/Event.php b/lib/Event.php
@@ -20,7 +20,7 @@
 class Event extends ApiResource
 {
     /**
-     * @param string $id The ID of the event to retrieve.
+     * @param array|string $id The ID of the event to retrieve.
      * @param array|string|null $opts
      *
      * @return Event

diff --git a/lib/FileUpload.php b/lib/FileUpload.php
@@ -27,7 +27,7 @@ public static function className()
     }
 
     /**
-     * @param string $id The ID of the file upload to retrieve.
+     * @param array|string $id The ID of the file upload to retrieve.
      * @param array|string|null $opts
      *
      * @return FileUpload

diff --git a/lib/Invoice.php b/lib/Invoice.php
@@ -21,7 +21,7 @@ public static function create($params = null, $opts = null)
     }
 
     /**
-     * @param string $id The ID of the invoice to retrieve.
+     * @param array|string $id The ID of the invoice to retrieve.
      * @param array|string|null $opts
      *
      * @return Invoice

diff --git a/lib/InvoiceItem.php b/lib/InvoiceItem.php
@@ -10,7 +10,7 @@
 class InvoiceItem extends ApiResource
 {
     /**
-     * @param string $id The ID of the invoice item to retrieve.
+     * @param array|string $id The ID of the invoice item to retrieve.
      * @param array|string|null $opts
      *
      * @return InvoiceItem

diff --git a/lib/Order.php b/lib/Order.php
@@ -10,7 +10,7 @@
 class Order extends ApiResource
 {
     /**
-     * @param string $id The ID of the Order to retrieve.
+     * @param array|string $id The ID of the Order to retrieve.
      * @param array|string|null $opts
      *
      * @return Order

diff --git a/lib/OrderReturn.php b/lib/OrderReturn.php
@@ -10,7 +10,7 @@
 class OrderReturn extends ApiResource
 {
     /**
-     * @param string $id The ID of the OrderReturn to retrieve.
+     * @param array|string $id The ID of the OrderReturn to retrieve.
      * @param array|string|null $opts
      *
      * @return Order

diff --git a/lib/Payout.php b/lib/Payout.php
@@ -30,7 +30,7 @@
 class Payout extends ApiResource
 {
     /**
-     * @param string $id The ID of the payout to retrieve.
+     * @param array|string $id The ID of the payout to retrieve.
      * @param array|string|null $opts
      *
      * @return Payout

diff --git a/lib/Plan.php b/lib/Plan.php
@@ -23,7 +23,7 @@
 class Plan extends ApiResource
 {
     /**
-     * @param string $id The ID of the plan to retrieve.
+     * @param array|string $id The ID of the plan to retrieve.
      * @param array|string|null $opts
      *
      * @return Plan

diff --git a/lib/Product.php b/lib/Product.php
@@ -10,7 +10,7 @@
 class Product extends ApiResource
 {
     /**
-     * @param string $id The ID of the Product to retrieve.
+     * @param array|string $id The ID of the Product to retrieve.
      * @param array|string|null $opts
      *
      * @return Product

diff --git a/lib/Recipient.php b/lib/Recipient.php
@@ -10,7 +10,7 @@
 class Recipient extends ApiResource
 {
     /**
-     * @param string $id The ID of the recipient to retrieve.
+     * @param array|string $id The ID of the recipient to retrieve.
      * @param array|string|null $opts
      *
      * @return Recipient

diff --git a/lib/Refund.php b/lib/Refund.php
@@ -23,7 +23,7 @@ class Refund extends ApiResource
 {
 
     /**
-     * @param string $id The ID of the refund to retrieve.
+     * @param array|string $id The ID of the refund to retrieve.
      * @param array|string|null $options
      *
      * @return Refund

diff --git a/lib/SKU.php b/lib/SKU.php
@@ -10,7 +10,7 @@
 class SKU extends ApiResource
 {
     /**
-     * @param string $id The ID of the SKU to retrieve.
+     * @param array|string $id The ID of the SKU to retrieve.
      * @param array|string|null $opts
      *
      * @return SKU

diff --git a/lib/Source.php b/lib/Source.php
@@ -10,7 +10,7 @@
 class Source extends ApiResource
 {
     /**
-     * @param string $id The ID of the Source to retrieve.
+     * @param array|string $id The ID of the Source to retrieve.
      * @param array|string|null $opts
      *
      * @return Source

diff --git a/lib/Subscription.php b/lib/Subscription.php
@@ -21,7 +21,7 @@ class Subscription extends ApiResource
     const STATUS_UNPAID = 'unpaid';
 
     /**
-     * @param string $id The ID of the subscription to retrieve.
+     * @param array|string $id The ID of the subscription to retrieve.
      * @param array|string|null $opts
      *
      * @return Subscription

diff --git a/lib/SubscriptionItem.php b/lib/SubscriptionItem.php
@@ -21,7 +21,7 @@ public static function className()
     }
 
     /**
-     * @param string $id The ID of the subscription item to retrieve.
+     * @param array|string $id The ID of the subscription item to retrieve.
      * @param array|string|null $opts
      *
      * @return SubscriptionItem

diff --git a/lib/ThreeDSecure.php b/lib/ThreeDSecure.php
@@ -13,7 +13,7 @@ public static function classUrl()
     }
 
     /**
-     * @param string $id The ID of the 3DS auth to retrieve.
+     * @param array|string $id The ID of the 3DS auth to retrieve.
      * @param array|string|null $options
      *
      * @return ThreeDSecure

diff --git a/lib/Token.php b/lib/Token.php
@@ -20,7 +20,7 @@
 class Token extends ApiResource
 {
     /**
-     * @param string $id The ID of the token to retrieve.
+     * @param array|string $id The ID of the token to retrieve.
      * @param array|string|null $opts
      *
      * @return Token

diff --git a/lib/Transfer.php b/lib/Transfer.php
@@ -26,7 +26,7 @@
 class Transfer extends ApiResource
 {
     /**
-     * @param string $id The ID of the transfer to retrieve.
+     * @param array|string $id The ID of the transfer to retrieve.
      * @param array|string|null $opts
      *
      * @return Transfer