Codegen for openapi feecc8d (#871)

lib/Checkout/Session.php

@@ -5,24 +5,24 @@
 /**
  * Class Session
  *
- * @property string $id <p>Unique identifier for the object. Used to pass to <code>redirectToCheckout</code></p><p>in Stripe.js.</p>
+ * @property string $id Unique identifier for the object. Used to pass to <code>redirectToCheckout</code> in Stripe.js.
  * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property string|null $billing_address_collection <p>The value (<code>auto</code> or <code>required</code>) for whether Checkout collected the</p><p>customer's billing address.</p>
+ * @property string|null $billing_address_collection The value (<code>auto</code> or <code>required</code>) for whether Checkout collected the customer's billing address.
  * @property string $cancel_url The URL the customer will be directed to if they decide to cancel payment and return to your website.
- * @property string|null $client_reference_id <p>A unique string to reference the Checkout Session. This can be a</p><p>customer ID, a cart ID, or similar, and can be used to reconcile the</p><p>session with your internal systems.</p>
- * @property string|\Stripe\Customer|null $customer <p>The ID of the customer for this session.</p><p>For Checkout Sessions in <code>payment</code> or <code>subscription</code> mode, Checkout</p><p>will create a new customer object based on information provided</p><p>during the session unless an existing customer was provided when</p><p>the session was created.</p>
- * @property string|null $customer_email <p>If provided, this value will be used when the Customer object is created.</p><p>If not provided, customers will be asked to enter their email address.</p><p>Use this parameter to prefill customer data if you already have an email</p><p>on file. To access information about the customer once a session is</p><p>complete, use the <code>customer</code> field.</p>
+ * @property string|null $client_reference_id A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
+ * @property string|\Stripe\Customer|null $customer The ID of the customer for this session. For Checkout Sessions in <code>payment</code> or <code>subscription</code> mode, Checkout will create a new customer object based on information provided during the session unless an existing customer was provided when the session was created.
+ * @property string|null $customer_email If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete, use the <code>customer</code> field.
  * @property \Stripe\StripeObject[]|null $display_items The line items, plans, or SKUs purchased by the customer.
  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  * @property string|null $locale The IETF language tag of the locale Checkout is displayed in. If blank or <code>auto</code>, the browser's locale is used.
  * @property \Stripe\StripeObject|null $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
  * @property string|null $mode The mode of the Checkout Session, one of <code>payment</code>, <code>setup</code>, or <code>subscription</code>.
  * @property string|\Stripe\PaymentIntent|null $payment_intent The ID of the PaymentIntent for Checkout Sessions in <code>payment</code> mode.
- * @property string[] $payment_method_types <p>A list of the types of payment methods (e.g. card) this Checkout</p><p>Session is allowed to accept.</p>
+ * @property string[] $payment_method_types A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.
  * @property string|\Stripe\SetupIntent|null $setup_intent The ID of the SetupIntent for Checkout Sessions in <code>setup</code> mode.
- * @property string|null $submit_type <p>Describes the type of transaction being performed by Checkout in order to customize</p><p>relevant text on the page, such as the submit button. <code>submit_type</code> can only be</p><p>specified on Checkout Sessions in <code>payment</code> mode, but not Checkout Sessions</p><p>in <code>subscription</code> or <code>setup</code> mode.</p>
+ * @property string|null $submit_type Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. <code>submit_type</code> can only be specified on Checkout Sessions in <code>payment</code> mode, but not Checkout Sessions in <code>subscription</code> or <code>setup</code> mode.
  * @property string|\Stripe\Subscription|null $subscription The ID of the subscription for Checkout Sessions in <code>subscription</code> mode.
- * @property string $success_url <p>The URL the customer will be directed to after the payment or</p><p>subscription creation is successful.</p>
+ * @property string $success_url The URL the customer will be directed to after the payment or subscription creation is successful.
  *
  * @package Stripe\Checkout
  */

lib/Payout.php

@@ -21,7 +21,7 @@
  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
  * @property string $method The method used to send this payout, which can be <code>standard</code> or <code>instant</code>. <code>instant</code> is only supported for payouts to debit cards. (See <a href="https://stripe.com/blog/instant-payouts-for-marketplaces">Instant payouts for marketplaces</a> for more information.)
- * @property string $source_type The source balance this payout came from. One of <code>card</code> or <code>bank_account</code>.
+ * @property string $source_type The source balance this payout came from. One of <code>card</code>, <code>fpx</code>, or <code>bank_account</code>.
  * @property string|null $statement_descriptor Extra information about a payout to be displayed on the user's bank statement.
  * @property string $status Current status of the payout (<code>paid</code>, <code>pending</code>, <code>in_transit</code>, <code>canceled</code> or <code>failed</code>). A payout will be <code>pending</code> until it is submitted to the bank, at which point it becomes <code>in_transit</code>. It will then change to <code>paid</code> if the transaction goes through. If it does not go through successfully, its status will change to <code>failed</code> or <code>canceled</code>.
  * @property string $type Can be <code>bank_account</code> or <code>card</code>.

lib/Plan.php

@@ -8,23 +8,23 @@
  * @property string $id Unique identifier for the object.
  * @property string $object String representing the object's type. Objects of the same type share the same value.
  * @property bool $active Whether the plan is currently available for new subscriptions.
- * @property string|null $aggregate_usage Specifies a usage aggregation strategy for plans of <code>usage_type=metered</code>. Allowed values are <code>sum</code> for summing up all usage during a period, <code>last_during_period</code> for picking the last usage record reported within a period, <code>last_ever</code> for picking the last usage record ever (across period bounds) or <code>max</code> which picks the usage record with the maximum reported usage during a period. Defaults to <code>sum</code>.
+ * @property string|null $aggregate_usage Specifies a usage aggregation strategy for plans of <code>usage_type=metered</code>. Allowed values are <code>sum</code> for summing up all usage during a period, <code>last_during_period</code> for using the last usage record reported within a period, <code>last_ever</code> for using the last usage record ever (across period bounds) or <code>max</code> which uses the usage record with the maximum reported usage during a period. Defaults to <code>sum</code>.
  * @property int|null $amount The amount in %s to be charged on the interval specified.
  * @property string|null $amount_decimal Same as <code>amount</code>, but contains a decimal value with at most 12 decimal places.
  * @property string|null $billing_scheme Describes how to compute the price per period. Either <code>per_unit</code> or <code>tiered</code>. <code>per_unit</code> indicates that the fixed amount (specified in <code>amount</code>) will be charged per unit in <code>quantity</code> (for plans with <code>usage_type=licensed</code>), or per unit of total usage (for plans with <code>usage_type=metered</code>). <code>tiered</code> indicates that the unit pricing will be computed using a tiering strategy as defined using the <code>tiers</code> and <code>tiers_mode</code> attributes.
  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
- * @property string $interval One of <code>day</code>, <code>week</code>, <code>month</code> or <code>year</code>. The frequency with which a subscription should be billed.
- * @property int $interval_count The number of intervals (specified in the <code>interval</code> property) between subscription billings. For example, <code>interval=month</code> and <code>interval_count=3</code> bills every 3 months.
+ * @property string $interval The frequency at which a subscription is billed. One of <code>day</code>, <code>week</code>, <code>month</code> or <code>year</code>.
+ * @property int $interval_count The number of intervals (specified in the <code>interval</code> attribute) between subscription billings. For example, <code>interval=month</code> and <code>interval_count=3</code> bills every 3 months.
  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
  * @property string|null $nickname A brief description of the plan, hidden from customers.
  * @property string|\Stripe\Product|null $product The product whose pricing this plan determines.
  * @property \Stripe\StripeObject[]|null $tiers Each element represents a pricing tier. This parameter requires <code>billing_scheme</code> to be set to <code>tiered</code>. See also the documentation for <code>billing_scheme</code>.
- * @property string|null $tiers_mode Defines if the tiering price should be <code>graduated</code> or <code>volume</code> based. In <code>volume</code>-based tiering, the maximum quantity within a period determines the per unit price, in <code>graduated</code> tiering pricing can successively change as the quantity grows.
- * @property \Stripe\StripeObject|null $transform_usage Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with <code>tiers</code>.
+ * @property string|null $tiers_mode Defines if the tiering price should be <code>graduated</code> or <code>volume</code> based. In <code>volume</code>-based tiering, the maximum quantity within a period determines the per unit price. In <code>graduated</code> tiering, pricing can change as the quantity grows.
+ * @property \Stripe\StripeObject|null $transform_usage Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with <code>tiers</code>.
  * @property int|null $trial_period_days Default number of trial days when subscribing a customer to this plan using <a href="https://stripe.com/docs/api#create_subscription-trial_from_plan"><code>trial_from_plan=true</code></a>.
- * @property string $usage_type Configures how the quantity per period should be determined, can be either <code>metered</code> or <code>licensed</code>. <code>licensed</code> will automatically bill the <code>quantity</code> set when adding it to a subscription, <code>metered</code> will aggregate the total usage based on usage records. Defaults to <code>licensed</code>.
+ * @property string $usage_type Configures how the quantity per period should be determined. Can be either <code>metered</code> or <code>licensed</code>. <code>licensed</code> automatically bills the <code>quantity</code> set when adding it to a subscription. <code>metered</code> aggregates the total usage based on usage records. Defaults to <code>licensed</code>.
  *
  * @package Stripe
  */

lib/Reporting/ReportRun.php

@@ -8,13 +8,13 @@
  * @property string $id Unique identifier for the object.
  * @property string $object String representing the object's type. Objects of the same type share the same value.
  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string|null $error <p>If something should go wrong during the run, a message about the failure (populated when</p><p><code>status=failed</code>).</p>
+ * @property string|null $error If something should go wrong during the run, a message about the failure (populated when <code>status=failed</code>).
  * @property bool $livemode Always <code>true</code>: reports can only be run on live-mode data.
  * @property \Stripe\StripeObject $parameters
  * @property string $report_type The ID of the <a href="https://stripe.com/docs/reporting/statements/api#report-types">report type</a> to run, such as <code>&quot;balance.summary.1&quot;</code>.
- * @property \Stripe\File|null $result <p>The file object representing the result of the report run (populated when</p><p><code>status=succeeded</code>).</p>
- * @property string $status <p>Status of this report run. This will be <code>pending</code> when the run is initially created.</p><p>When the run finishes, this will be set to <code>succeeded</code> and the <code>result</code> field will be populated.</p><p>Rarely, we may encounter an error, at which point this will be set to <code>failed</code> and the <code>error</code> field will be populated.</p>
- * @property int|null $succeeded_at <p>Timestamp at which this run successfully finished (populated when</p><p><code>status=succeeded</code>). Measured in seconds since the Unix epoch.</p>
+ * @property \Stripe\File|null $result The file object representing the result of the report run (populated when <code>status=succeeded</code>).
+ * @property string $status Status of this report run. This will be <code>pending</code> when the run is initially created. When the run finishes, this will be set to <code>succeeded</code> and the <code>result</code> field will be populated. Rarely, we may encounter an error, at which point this will be set to <code>failed</code> and the <code>error</code> field will be populated.
+ * @property int|null $succeeded_at Timestamp at which this run successfully finished (populated when <code>status=succeeded</code>). Measured in seconds since the Unix epoch.
  *
  * @package Stripe\Reporting
  */

lib/Transfer.php

@@ -20,7 +20,7 @@
  * @property \Stripe\Collection $reversals A list of reversals that have been applied to the transfer.
  * @property bool $reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
  * @property string|\Stripe\Charge|null $source_transaction ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.
- * @property string|null $source_type The source balance this transfer came from. One of <code>card</code> or <code>bank_account</code>.
+ * @property string|null $source_type The source balance this transfer came from. One of <code>card</code>, <code>fpx</code>, or <code>bank_account</code>.
  * @property string|null $transfer_group A string that identifies this transaction as part of a group. See the <a href="https://stripe.com/docs/connect/charges-transfers#grouping-transactions">Connect documentation</a> for details.
  *
  * @package Stripe