Merge pull request #790 from stripe/ob-nullable

Mark nullable fields in PHPDoc

lib/Account.php

@@ -7,22 +7,22 @@
  *
  * @property string $id
  * @property string $object
- * @property mixed $business_profile
- * @property string $business_type
+ * @property mixed|null $business_profile
+ * @property string|null $business_type
  * @property mixed $capabilities
  * @property bool $charges_enabled
  * @property mixed $company
  * @property string $country
  * @property int $created
  * @property string $default_currency
  * @property bool $details_submitted
- * @property string $email
- * @property Collection $external_accounts
+ * @property string|null $email
+ * @property \Stripe\Collection $external_accounts
  * @property mixed $individual
- * @property StripeObject $metadata
+ * @property \Stripe\StripeObject $metadata
  * @property bool $payouts_enabled
  * @property mixed $requirements
- * @property mixed $settings
+ * @property mixed|null $settings
  * @property mixed $tos_acceptance
  * @property string $type
  *

lib/ApplicationFee.php

@@ -11,14 +11,14 @@
  * @property int $amount
  * @property int $amount_refunded
  * @property string $application
- * @property string $balance_transaction
+ * @property string|null $balance_transaction
  * @property string $charge
  * @property int $created
  * @property string $currency
  * @property bool $livemode
- * @property string $originating_transaction
+ * @property string|null $originating_transaction
  * @property bool $refunded
- * @property Collection $refunds
+ * @property \Stripe\Collection $refunds
  *
  * @package Stripe
  */

lib/BalanceTransaction.php

@@ -11,12 +11,12 @@
  * @property int $available_on
  * @property int $created
  * @property string $currency
- * @property string $description
- * @property float $exchange_rate
+ * @property string|null $description
+ * @property float|null $exchange_rate
  * @property int $fee
  * @property mixed $fee_details
  * @property int $net
- * @property string $source
+ * @property string|null $source
  * @property string $status
  * @property string $type
  *

lib/BankAccount.php

@@ -7,18 +7,18 @@
  *
  * @property string $id
  * @property string $object
- * @property string $account
- * @property string $account_holder_name
- * @property string $account_holder_type
- * @property string $bank_name
+ * @property string|null $account
+ * @property string|null $account_holder_name
+ * @property string|null $account_holder_type
+ * @property string|null $bank_name
  * @property string $country
- * @property string $currency
- * @property string $customer
- * @property bool $default_for_currency
- * @property string $fingerprint
+ * @property string|null $currency
+ * @property string|null $customer
+ * @property bool|null $default_for_currency
+ * @property string|null $fingerprint
  * @property string $last4
- * @property StripeObject $metadata
- * @property string $routing_number
+ * @property \Stripe\StripeObject|null $metadata
+ * @property string|null $routing_number
  * @property string $status
  *
  * @package Stripe

lib/BitcoinReceiver.php

@@ -18,18 +18,18 @@
  * @property string $bitcoin_uri
  * @property int $created
  * @property string $currency
- * @property string $customer
- * @property string $description
- * @property string $email
+ * @property string|null $customer
+ * @property string|null $description
+ * @property string|null $email
  * @property bool $filled
  * @property string $inbound_address
  * @property bool $livemode
- * @property StripeObject $metadata
- * @property string $payment
- * @property string $refund_address
+ * @property \Stripe\StripeObject $metadata
+ * @property string|null $payment
+ * @property string|null $refund_address
  * @property mixed $transactions
  * @property bool $uncaptured_funds
- * @property bool $used_for_payment
+ * @property bool|null $used_for_payment
  *
  * @package Stripe
  */

lib/Card.php

@@ -7,32 +7,32 @@
  *
  * @property string $id
  * @property string $object
- * @property string $account
- * @property string $address_city
- * @property string $address_country
- * @property string $address_line1
- * @property string $address_line1_check
- * @property string $address_line2
- * @property string $address_state
- * @property string $address_zip
- * @property string $address_zip_check
- * @property string[] $available_payout_methods
+ * @property string|null $account
+ * @property string|null $address_city
+ * @property string|null $address_country
+ * @property string|null $address_line1
+ * @property string|null $address_line1_check
+ * @property string|null $address_line2
+ * @property string|null $address_state
+ * @property string|null $address_zip
+ * @property string|null $address_zip_check
+ * @property string[]|null $available_payout_methods
  * @property string $brand
- * @property string $country
- * @property string $currency
- * @property string $customer
- * @property string $cvc_check
- * @property bool $default_for_currency
- * @property string $dynamic_last4
+ * @property string|null $country
+ * @property string|null $currency
+ * @property string|null $customer
+ * @property string|null $cvc_check
+ * @property bool|null $default_for_currency
+ * @property string|null $dynamic_last4
  * @property int $exp_month
  * @property int $exp_year
- * @property string $fingerprint
+ * @property string|null $fingerprint
  * @property string $funding
  * @property string $last4
- * @property StripeObject $metadata
- * @property string $name
- * @property string $recipient
- * @property string $tokenization_method
+ * @property \Stripe\StripeObject $metadata
+ * @property string|null $name
+ * @property string|null $recipient
+ * @property string|null $tokenization_method
  *
  * @package Stripe
  */

lib/Charge.php

@@ -9,46 +9,46 @@
  * @property string $object
  * @property int $amount
  * @property int $amount_refunded
- * @property string $application
- * @property string $application_fee
- * @property int $application_fee_amount
- * @property string $balance_transaction
+ * @property string|null $application
+ * @property string|null $application_fee
+ * @property int|null $application_fee_amount
+ * @property string|null $balance_transaction
  * @property mixed $billing_details
  * @property bool $captured
  * @property int $created
  * @property string $currency
- * @property string $customer
- * @property string $description
- * @property string $destination
- * @property string $dispute
- * @property string $failure_code
- * @property string $failure_message
- * @property mixed $fraud_details
- * @property string $invoice
+ * @property string|null $customer
+ * @property string|null $description
+ * @property string|null $destination
+ * @property string|null $dispute
+ * @property string|null $failure_code
+ * @property string|null $failure_message
+ * @property mixed|null $fraud_details
+ * @property string|null $invoice
  * @property bool $livemode
- * @property StripeObject $metadata
- * @property string $on_behalf_of
- * @property string $order
- * @property mixed $outcome
+ * @property \Stripe\StripeObject $metadata
+ * @property string|null $on_behalf_of
+ * @property string|null $order
+ * @property mixed|null $outcome
  * @property bool $paid
- * @property string $payment_intent
- * @property string $payment_method
- * @property mixed $payment_method_details
- * @property string $receipt_email
- * @property string $receipt_number
+ * @property string|null $payment_intent
+ * @property string|null $payment_method
+ * @property mixed|null $payment_method_details
+ * @property string|null $receipt_email
+ * @property string|null $receipt_number
  * @property string $receipt_url
  * @property bool $refunded
- * @property Collection $refunds
- * @property string $review
- * @property mixed $shipping
- * @property mixed $source
- * @property string $source_transfer
- * @property string $statement_descriptor
- * @property string $statement_descriptor_suffix
+ * @property \Stripe\Collection $refunds
+ * @property string|null $review
+ * @property mixed|null $shipping
+ * @property mixed|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 $transfer_data
- * @property string $transfer_group
+ * @property mixed|null $transfer_data
+ * @property string|null $transfer_group
  *
  * @package Stripe
  */

lib/Checkout/Session.php

@@ -8,17 +8,17 @@
  * @property string $id
  * @property string $object
  * @property string $cancel_url
- * @property string $client_reference_id
- * @property string $customer
- * @property string $customer_email
- * @property mixed $display_items
+ * @property string|null $client_reference_id
+ * @property string|null $customer
+ * @property string|null $customer_email
+ * @property mixed|null $display_items
  * @property bool $livemode
- * @property string $mode
- * @property string $payment_intent
+ * @property string|null $mode
+ * @property string|null $payment_intent
  * @property string[] $payment_method_types
- * @property string $setup_intent
- * @property string $submit_type
- * @property string $subscription
+ * @property string|null $setup_intent
+ * @property string|null $submit_type
+ * @property string|null $subscription
  * @property string $success_url
  *
  * @package Stripe\Checkout

lib/Coupon.php

@@ -7,17 +7,17 @@
  *
  * @property string $id
  * @property string $object
- * @property int $amount_off
+ * @property int|null $amount_off
  * @property int $created
- * @property string $currency
+ * @property string|null $currency
  * @property string $duration
- * @property int $duration_in_months
+ * @property int|null $duration_in_months
  * @property bool $livemode
- * @property int $max_redemptions
- * @property StripeObject $metadata
- * @property string $name
- * @property float $percent_off
- * @property int $redeem_by
+ * @property int|null $max_redemptions
+ * @property \Stripe\StripeObject $metadata
+ * @property string|null $name
+ * @property float|null $percent_off
+ * @property int|null $redeem_by
  * @property int $times_redeemed
  * @property bool $valid
  *

lib/CreditNote.php

@@ -11,18 +11,18 @@
  * @property int $created
  * @property string $currency
  * @property string $customer
- * @property string $customer_balance_transaction
+ * @property string|null $customer_balance_transaction
  * @property string $invoice
  * @property bool $livemode
- * @property string $memo
- * @property StripeObject $metadata
+ * @property string|null $memo
+ * @property \Stripe\StripeObject $metadata
  * @property string $number
  * @property string $pdf
- * @property string $reason
- * @property string $refund
+ * @property string|null $reason
+ * @property string|null $refund
  * @property string $status
  * @property string $type
- * @property int $voided_at
+ * @property int|null $voided_at
  *
  * @package Stripe
  */

lib/Customer.php

@@ -7,27 +7,27 @@
  *
  * @property string $id
  * @property string $object
- * @property mixed $address
+ * @property mixed|null $address
  * @property int $balance
  * @property int $created
- * @property string $currency
- * @property string $default_source
- * @property bool $delinquent
- * @property string $description
- * @property Discount $discount
- * @property string $email
- * @property string $invoice_prefix
+ * @property string|null $currency
+ * @property string|null $default_source
+ * @property bool|null $delinquent
+ * @property string|null $description
+ * @property \Stripe\Discount|null $discount
+ * @property string|null $email
+ * @property string|null $invoice_prefix
  * @property mixed $invoice_settings
  * @property bool $livemode
- * @property StripeObject $metadata
- * @property string $name
- * @property string $phone
- * @property string[] $preferred_locales
- * @property mixed $shipping
- * @property Collection $sources
- * @property Collection $subscriptions
- * @property string $tax_exempt
- * @property Collection $tax_ids
+ * @property \Stripe\StripeObject $metadata
+ * @property string|null $name
+ * @property string|null $phone
+ * @property string[]|null $preferred_locales
+ * @property mixed|null $shipping
+ * @property \Stripe\Collection $sources
+ * @property \Stripe\Collection $subscriptions
+ * @property string|null $tax_exempt
+ * @property \Stripe\Collection $tax_ids
  *
  * @package Stripe
  */

lib/Dispute.php

@@ -16,8 +16,8 @@
  * @property mixed $evidence_details
  * @property bool $is_charge_refundable
  * @property bool $livemode
- * @property StripeObject $metadata
- * @property string $network_reason_code
+ * @property \Stripe\StripeObject $metadata
+ * @property string|null $network_reason_code
  * @property string $reason
  * @property string $status
  *

lib/Event.php

@@ -8,12 +8,12 @@
  * @property string $id
  * @property string $object
  * @property string $account
- * @property string $api_version
+ * @property string|null $api_version
  * @property int $created
  * @property mixed $data
  * @property bool $livemode
  * @property int $pending_webhooks
- * @property mixed $request
+ * @property mixed|null $request
  * @property string $type
  *
  * @package Stripe