Merge pull request #841 from stripe/ob-more-phpdoc-fixes

More PHPDoc fixes
stripe · Jan 29, 2020 · 5ca8c27 · 5ca8c27
2 parents 6c23253 + a87db72
commit 5ca8c27
Show file tree

Hide file tree

Showing 16 changed files with 128 additions and 122 deletions.
diff --git a/lib/Account.php b/lib/Account.php
@@ -7,23 +7,23 @@
  *
  * @property string $id
  * @property string $object
- * @property mixed|null $business_profile
+ * @property \Stripe\StripeObject|null $business_profile
  * @property string|null $business_type
- * @property mixed $capabilities
+ * @property \Stripe\StripeObject $capabilities
  * @property bool $charges_enabled
- * @property mixed $company
+ * @property \Stripe\StripeObject $company
  * @property string $country
  * @property int $created
  * @property string $default_currency
  * @property bool $details_submitted
  * @property string|null $email
  * @property \Stripe\Collection $external_accounts
- * @property mixed $individual
+ * @property \Stripe\Person $individual
  * @property \Stripe\StripeObject $metadata
  * @property bool $payouts_enabled
- * @property mixed $requirements
- * @property mixed|null $settings
- * @property mixed $tos_acceptance
+ * @property \Stripe\StripeObject $requirements
+ * @property \Stripe\StripeObject|null $settings
+ * @property \Stripe\StripeObject $tos_acceptance
  * @property string $type
  *
  * @package Stripe
@@ -165,7 +165,7 @@ public function deauthorize($clientId = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Capability
+     * @return \Stripe\Capability
      */
     public static function retrieveCapability($id, $capabilityId, $params = null, $opts = null)
     {
@@ -180,7 +180,7 @@ public static function retrieveCapability($id, $capabilityId, $params = null, $o
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Capability
+     * @return \Stripe\Capability
      */
     public static function updateCapability($id, $capabilityId, $params = null, $opts = null)
     {
@@ -194,7 +194,7 @@ public static function updateCapability($id, $capabilityId, $params = null, $opt
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Collection The list of capabilities.
+     * @return \Stripe\Collection The list of capabilities.
      */
     public static function allCapabilities($id, $params = null, $opts = null)
     {
@@ -208,7 +208,7 @@ public static function allCapabilities($id, $params = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return BankAccount|Card
+     * @return \Stripe\BankAccount|\Stripe\Card
      */
     public static function createExternalAccount($id, $params = null, $opts = null)
     {
@@ -223,7 +223,7 @@ public static function createExternalAccount($id, $params = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return BankAccount|Card
+     * @return \Stripe\BankAccount|\Stripe\Card
      */
     public static function retrieveExternalAccount($id, $externalAccountId, $params = null, $opts = null)
     {
@@ -238,7 +238,7 @@ public static function retrieveExternalAccount($id, $externalAccountId, $params
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return BankAccount|Card
+     * @return \Stripe\BankAccount|\Stripe\Card
      */
     public static function updateExternalAccount($id, $externalAccountId, $params = null, $opts = null)
     {
@@ -253,7 +253,7 @@ public static function updateExternalAccount($id, $externalAccountId, $params =
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return BankAccount|Card
+     * @return \Stripe\BankAccount|\Stripe\Card
      */
     public static function deleteExternalAccount($id, $externalAccountId, $params = null, $opts = null)
     {
@@ -267,7 +267,7 @@ public static function deleteExternalAccount($id, $externalAccountId, $params =
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Collection The list of external accounts (BankAccount or Card).
+     * @return \Stripe\Collection The list of external accounts (BankAccount or Card).
      */
     public static function allExternalAccounts($id, $params = null, $opts = null)
     {
@@ -281,7 +281,7 @@ public static function allExternalAccounts($id, $params = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return LoginLink
+     * @return \Stripe\LoginLink
      */
     public static function createLoginLink($id, $params = null, $opts = null)
     {
@@ -294,7 +294,7 @@ public static function createLoginLink($id, $params = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Collection The list of persons.
+     * @return \Stripe\Collection The list of persons.
      */
     public function persons($params = null, $opts = null)
     {
@@ -312,7 +312,7 @@ public function persons($params = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Person
+     * @return \Stripe\Person
      */
     public static function createPerson($id, $params = null, $opts = null)
     {
@@ -327,7 +327,7 @@ public static function createPerson($id, $params = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Person
+     * @return \Stripe\Person
      */
     public static function retrievePerson($id, $personId, $params = null, $opts = null)
     {
@@ -342,7 +342,7 @@ public static function retrievePerson($id, $personId, $params = null, $opts = nu
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Person
+     * @return \Stripe\Person
      */
     public static function updatePerson($id, $personId, $params = null, $opts = null)
     {
@@ -357,7 +357,7 @@ public static function updatePerson($id, $personId, $params = null, $opts = null
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Person
+     * @return \Stripe\Person
      */
     public static function deletePerson($id, $personId, $params = null, $opts = null)
     {
@@ -371,7 +371,7 @@ public static function deletePerson($id, $personId, $params = null, $opts = null
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Collection The list of persons.
+     * @return \Stripe\Collection The list of persons.
      */
     public static function allPersons($id, $params = null, $opts = null)
     {

diff --git a/lib/ApplicationFee.php b/lib/ApplicationFee.php
@@ -39,7 +39,7 @@ class ApplicationFee extends ApiResource
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return ApplicationFeeRefund
+     * @return \Stripe\ApplicationFeeRefund
      */
     public static function createRefund($id, $params = null, $opts = null)
     {
@@ -54,7 +54,7 @@ public static function createRefund($id, $params = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return ApplicationFeeRefund
+     * @return \Stripe\ApplicationFeeRefund
      */
     public static function retrieveRefund($id, $refundId, $params = null, $opts = null)
     {
@@ -69,7 +69,7 @@ public static function retrieveRefund($id, $refundId, $params = null, $opts = nu
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return ApplicationFeeRefund
+     * @return \Stripe\ApplicationFeeRefund
      */
     public static function updateRefund($id, $refundId, $params = null, $opts = null)
     {
@@ -83,7 +83,7 @@ public static function updateRefund($id, $refundId, $params = null, $opts = null
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Collection The list of fee refunds.
+     * @return \Stripe\Collection The list of fee refunds.
      */
     public static function allRefunds($id, $params = null, $opts = null)
     {

diff --git a/lib/Charge.php b/lib/Charge.php
@@ -13,7 +13,7 @@
  * @property string|null $application_fee
  * @property int|null $application_fee_amount
  * @property string|null $balance_transaction
- * @property mixed $billing_details
+ * @property \Stripe\StripeObject $billing_details
  * @property bool $captured
  * @property int $created
  * @property string $currency
@@ -24,31 +24,31 @@
  * @property bool $disputed
  * @property string|null $failure_code
  * @property string|null $failure_message
- * @property mixed|null $fraud_details
+ * @property \Stripe\StripeObject|null $fraud_details
  * @property string|null $invoice
  * @property bool $livemode
  * @property \Stripe\StripeObject $metadata
  * @property string|null $on_behalf_of
  * @property string|null $order
- * @property mixed|null $outcome
+ * @property \Stripe\StripeObject|null $outcome
  * @property bool $paid
  * @property string|null $payment_intent
  * @property string|null $payment_method
- * @property mixed|null $payment_method_details
+ * @property \Stripe\StripeObject|null $payment_method_details
  * @property string|null $receipt_email
  * @property string|null $receipt_number
  * @property string $receipt_url
  * @property bool $refunded
  * @property \Stripe\Collection $refunds
  * @property string|null $review
- * @property mixed|null $shipping
- * @property mixed|null $source
+ * @property \Stripe\StripeObject|null $shipping
+ * @property \Stripe\StripeObject|null $source
  * @property string|null $source_transfer
  * @property string|null $statement_descriptor
  * @property string|null $statement_descriptor_suffix
  * @property string $status
  * @property string $transfer
- * @property mixed|null $transfer_data
+ * @property \Stripe\StripeObject|null $transfer_data
  * @property string|null $transfer_group
  *
  * @package Stripe

diff --git a/lib/CreditNote.php b/lib/CreditNote.php
@@ -12,15 +12,21 @@
  * @property string $currency
  * @property string $customer
  * @property string|null $customer_balance_transaction
+ * @property int $discount_amount
  * @property string $invoice
+ * @property \Stripe\Collection $lines
  * @property bool $livemode
  * @property string|null $memo
  * @property \Stripe\StripeObject $metadata
  * @property string $number
+ * @property int|null $out_of_band_amount
  * @property string $pdf
  * @property string|null $reason
  * @property string|null $refund
  * @property string $status
+ * @property int $subtotal
+ * @property \Stripe\StripeObject[] $tax_amounts
+ * @property int $total
  * @property string $type
  * @property int|null $voided_at
  *
@@ -67,7 +73,7 @@ class CreditNote extends ApiResource
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return CreditNote The previewed credit note.
+     * @return \Stripe\CreditNote The previewed credit note.
      */
     public static function preview($params = null, $opts = null)
     {
@@ -101,7 +107,7 @@ public function voidCreditNote($params = null, $opts = null)
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
      *
-     * @return Collection The list of lines (CreditNoteLineItem).
+     * @return \Stripe\Collection The list of credit note line items.
      */
     public static function allLines($id, $params = null, $opts = null)
     {