stripe 17.0.1 → 19.0.0

data/lib/stripe/params/payment_link_update_params.rb

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PaymentLinkUpdateParams < Stripe::RequestParams
-    class AfterCompletion < Stripe::RequestParams
-      class HostedConfirmation < Stripe::RequestParams
+  class PaymentLinkUpdateParams < ::Stripe::RequestParams
+    class AfterCompletion < ::Stripe::RequestParams
+      class HostedConfirmation < ::Stripe::RequestParams
         # A custom message to display to the customer after the purchase is complete.
         attr_accessor :custom_message
 
@@ -13,8 +13,8 @@ module Stripe
         end
       end
 
-      class Redirect < Stripe::RequestParams
-        # The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.
+      class Redirect < ::Stripe::RequestParams
+        # The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included.
         attr_accessor :url
 
         def initialize(url: nil)
@@ -35,8 +35,8 @@ module Stripe
       end
     end
 
-    class AutomaticTax < Stripe::RequestParams
-      class Liability < Stripe::RequestParams
+    class AutomaticTax < ::Stripe::RequestParams
+      class Liability < ::Stripe::RequestParams
         # The connected account being referenced when `type` is `account`.
         attr_accessor :account
         # Type of the account referenced in the request.
@@ -60,9 +60,9 @@ module Stripe
       end
     end
 
-    class CustomField < Stripe::RequestParams
-      class Dropdown < Stripe::RequestParams
-        class Option < Stripe::RequestParams
+    class CustomField < ::Stripe::RequestParams
+      class Dropdown < ::Stripe::RequestParams
+        class Option < ::Stripe::RequestParams
           # The label for the option, displayed to the customer. Up to 100 characters.
           attr_accessor :label
           # The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
@@ -73,7 +73,7 @@ module Stripe
             @value = value
           end
         end
-        # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
+        # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array.
         attr_accessor :default_value
         # The options available for the customer to select. Up to 200 options allowed.
         attr_accessor :options
@@ -84,7 +84,7 @@ module Stripe
         end
       end
 
-      class Label < Stripe::RequestParams
+      class Label < ::Stripe::RequestParams
         # Custom text for the label, displayed to the customer. Up to 50 characters.
         attr_accessor :custom
         # The type of the label.
@@ -96,8 +96,8 @@ module Stripe
         end
       end
 
-      class Numeric < Stripe::RequestParams
-        # The value that will pre-fill the field on the payment page.
+      class Numeric < ::Stripe::RequestParams
+        # The value that pre-fills the field on the payment page.
         attr_accessor :default_value
         # The maximum character length constraint for the customer's input.
         attr_accessor :maximum_length
@@ -111,8 +111,8 @@ module Stripe
         end
       end
 
-      class Text < Stripe::RequestParams
-        # The value that will pre-fill the field on the payment page.
+      class Text < ::Stripe::RequestParams
+        # The value that pre-fills the field on the payment page.
         attr_accessor :default_value
         # The maximum character length constraint for the customer's input.
         attr_accessor :maximum_length
@@ -159,9 +159,9 @@ module Stripe
       end
     end
 
-    class CustomText < Stripe::RequestParams
-      class AfterSubmit < Stripe::RequestParams
-        # Text may be up to 1200 characters in length.
+    class CustomText < ::Stripe::RequestParams
+      class AfterSubmit < ::Stripe::RequestParams
+        # Text can be up to 1200 characters in length.
         attr_accessor :message
 
         def initialize(message: nil)
@@ -169,8 +169,8 @@ module Stripe
         end
       end
 
-      class ShippingAddress < Stripe::RequestParams
-        # Text may be up to 1200 characters in length.
+      class ShippingAddress < ::Stripe::RequestParams
+        # Text can be up to 1200 characters in length.
         attr_accessor :message
 
         def initialize(message: nil)
@@ -178,8 +178,8 @@ module Stripe
         end
       end
 
-      class Submit < Stripe::RequestParams
-        # Text may be up to 1200 characters in length.
+      class Submit < ::Stripe::RequestParams
+        # Text can be up to 1200 characters in length.
         attr_accessor :message
 
         def initialize(message: nil)
@@ -187,8 +187,8 @@ module Stripe
         end
       end
 
-      class TermsOfServiceAcceptance < Stripe::RequestParams
-        # Text may be up to 1200 characters in length.
+      class TermsOfServiceAcceptance < ::Stripe::RequestParams
+        # Text can be up to 1200 characters in length.
         attr_accessor :message
 
         def initialize(message: nil)
@@ -217,9 +217,9 @@ module Stripe
       end
     end
 
-    class InvoiceCreation < Stripe::RequestParams
-      class InvoiceData < Stripe::RequestParams
-        class CustomField < Stripe::RequestParams
+    class InvoiceCreation < ::Stripe::RequestParams
+      class InvoiceData < ::Stripe::RequestParams
+        class CustomField < ::Stripe::RequestParams
           # The name of the custom field. This may be up to 40 characters.
           attr_accessor :name
           # The value of the custom field. This may be up to 140 characters.
@@ -231,7 +231,7 @@ module Stripe
           end
         end
 
-        class Issuer < Stripe::RequestParams
+        class Issuer < ::Stripe::RequestParams
           # The connected account being referenced when `type` is `account`.
           attr_accessor :account
           # Type of the account referenced in the request.
@@ -243,7 +243,7 @@ module Stripe
           end
         end
 
-        class RenderingOptions < Stripe::RequestParams
+        class RenderingOptions < ::Stripe::RequestParams
           # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
           attr_accessor :amount_tax_display
           # ID of the invoice rendering template to use for this invoice.
@@ -264,7 +264,7 @@ module Stripe
         attr_accessor :footer
         # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
         attr_accessor :issuer
-        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+        # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         attr_accessor :metadata
         # Default options for invoice PDF rendering for this customer.
         attr_accessor :rendering_options
@@ -298,8 +298,8 @@ module Stripe
       end
     end
 
-    class LineItem < Stripe::RequestParams
-      class AdjustableQuantity < Stripe::RequestParams
+    class LineItem < ::Stripe::RequestParams
+      class AdjustableQuantity < ::Stripe::RequestParams
         # Set to true if the quantity can be adjusted to any non-negative Integer.
         attr_accessor :enabled
         # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
@@ -327,10 +327,74 @@ module Stripe
       end
     end
 
-    class PaymentIntentData < Stripe::RequestParams
+    class NameCollection < ::Stripe::RequestParams
+      class Business < ::Stripe::RequestParams
+        # Enable business name collection on the payment link. Defaults to `false`.
+        attr_accessor :enabled
+        # Whether the customer is required to provide their business name before checking out. Defaults to `false`.
+        attr_accessor :optional
+
+        def initialize(enabled: nil, optional: nil)
+          @enabled = enabled
+          @optional = optional
+        end
+      end
+
+      class Individual < ::Stripe::RequestParams
+        # Enable individual name collection on the payment link. Defaults to `false`.
+        attr_accessor :enabled
+        # Whether the customer is required to provide their full name before checking out. Defaults to `false`.
+        attr_accessor :optional
+
+        def initialize(enabled: nil, optional: nil)
+          @enabled = enabled
+          @optional = optional
+        end
+      end
+      # Controls settings applied for collecting the customer's business name.
+      attr_accessor :business
+      # Controls settings applied for collecting the customer's individual name.
+      attr_accessor :individual
+
+      def initialize(business: nil, individual: nil)
+        @business = business
+        @individual = individual
+      end
+    end
+
+    class OptionalItem < ::Stripe::RequestParams
+      class AdjustableQuantity < ::Stripe::RequestParams
+        # Set to true if the quantity can be adjusted to any non-negative integer.
+        attr_accessor :enabled
+        # The maximum quantity of this item the customer can purchase. By default this value is 99.
+        attr_accessor :maximum
+        # The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
+        attr_accessor :minimum
+
+        def initialize(enabled: nil, maximum: nil, minimum: nil)
+          @enabled = enabled
+          @maximum = maximum
+          @minimum = minimum
+        end
+      end
+      # When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
+      attr_accessor :adjustable_quantity
+      # The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object.
+      attr_accessor :price
+      # The initial quantity of the line item created when a customer chooses to add this optional item to their order.
+      attr_accessor :quantity
+
+      def initialize(adjustable_quantity: nil, price: nil, quantity: nil)
+        @adjustable_quantity = adjustable_quantity
+        @price = price
+        @quantity = quantity
+      end
+    end
+
+    class PaymentIntentData < ::Stripe::RequestParams
       # An arbitrary string attached to the object. Often useful for displaying to users.
       attr_accessor :description
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
       attr_accessor :metadata
       # Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
       #
@@ -338,7 +402,7 @@ module Stripe
       attr_accessor :statement_descriptor
       # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
       attr_accessor :statement_descriptor_suffix
-      # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
+      # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
       attr_accessor :transfer_group
 
       def initialize(
@@ -356,7 +420,7 @@ module Stripe
       end
     end
 
-    class PhoneNumberCollection < Stripe::RequestParams
+    class PhoneNumberCollection < ::Stripe::RequestParams
       # Set to `true` to enable phone number collection.
       attr_accessor :enabled
 
@@ -365,8 +429,8 @@ module Stripe
       end
     end
 
-    class Restrictions < Stripe::RequestParams
-      class CompletedSessions < Stripe::RequestParams
+    class Restrictions < ::Stripe::RequestParams
+      class CompletedSessions < ::Stripe::RequestParams
         # The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
         attr_accessor :limit
 
@@ -382,7 +446,7 @@ module Stripe
       end
     end
 
-    class ShippingAddressCollection < Stripe::RequestParams
+    class ShippingAddressCollection < ::Stripe::RequestParams
       # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
       # shipping locations.
       attr_accessor :allowed_countries
@@ -392,9 +456,9 @@ module Stripe
       end
     end
 
-    class SubscriptionData < Stripe::RequestParams
-      class InvoiceSettings < Stripe::RequestParams
-        class Issuer < Stripe::RequestParams
+    class SubscriptionData < ::Stripe::RequestParams
+      class InvoiceSettings < ::Stripe::RequestParams
+        class Issuer < ::Stripe::RequestParams
           # The connected account being referenced when `type` is `account`.
           attr_accessor :account
           # Type of the account referenced in the request.
@@ -413,8 +477,8 @@ module Stripe
         end
       end
 
-      class TrialSettings < Stripe::RequestParams
-        class EndBehavior < Stripe::RequestParams
+      class TrialSettings < ::Stripe::RequestParams
+        class EndBehavior < ::Stripe::RequestParams
           # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
           attr_accessor :missing_payment_method
 
@@ -431,7 +495,7 @@ module Stripe
       end
       # All invoices will be billed using the specified settings.
       attr_accessor :invoice_settings
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
       attr_accessor :metadata
       # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
       attr_accessor :trial_period_days
@@ -451,10 +515,10 @@ module Stripe
       end
     end
 
-    class TaxIdCollection < Stripe::RequestParams
+    class TaxIdCollection < ::Stripe::RequestParams
       # Enable tax ID collection during checkout. Defaults to `false`.
       attr_accessor :enabled
-      # Describes whether a tax ID is required during checkout. Defaults to `never`.
+      # Describes whether a tax ID is required during checkout. Defaults to `never`. You can't set this parameter if `ui_mode` is `custom`.
       attr_accessor :required
 
       def initialize(enabled: nil, required: nil)
@@ -472,11 +536,11 @@ module Stripe
     attr_accessor :automatic_tax
     # Configuration for collecting the customer's billing address. Defaults to `auto`.
     attr_accessor :billing_address_collection
-    # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
+    # Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`.
     attr_accessor :custom_fields
-    # Display additional text for your customers using custom text.
+    # Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `custom`.
     attr_accessor :custom_text
-    # Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
+    # Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers).
     attr_accessor :customer_creation
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
@@ -486,15 +550,21 @@ module Stripe
     attr_accessor :invoice_creation
     # The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
     attr_accessor :line_items
-    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
+    # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.
     attr_accessor :metadata
+    # Controls settings applied for collecting the customer's name.
+    attr_accessor :name_collection
+    # A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices).
+    # There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.
+    # There is a maximum of 20 combined line items and optional items.
+    attr_accessor :optional_items
     # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
     attr_accessor :payment_intent_data
     # Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
     #
     # Can only be set in `subscription` mode. Defaults to `always`.
     #
-    # If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
+    # If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://docs.stripe.com/payments/checkout/free-trials).
     attr_accessor :payment_method_collection
     # The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
     attr_accessor :payment_method_types
@@ -506,7 +576,7 @@ module Stripe
     attr_accessor :restrictions
     # Configuration for collecting the customer's shipping address.
     attr_accessor :shipping_address_collection
-    # Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
+    # Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
     attr_accessor :submit_type
     # When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
     attr_accessor :subscription_data
@@ -527,6 +597,8 @@ module Stripe
       invoice_creation: nil,
       line_items: nil,
       metadata: nil,
+      name_collection: nil,
+      optional_items: nil,
       payment_intent_data: nil,
       payment_method_collection: nil,
       payment_method_types: nil,
@@ -550,6 +622,8 @@ module Stripe
       @invoice_creation = invoice_creation
       @line_items = line_items
       @metadata = metadata
+      @name_collection = name_collection
+      @optional_items = optional_items
       @payment_intent_data = payment_intent_data
       @payment_method_collection = payment_method_collection
       @payment_method_types = payment_method_types

data/lib/stripe/params/payment_method_attach_params.rb

@@ -2,14 +2,17 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PaymentMethodAttachParams < Stripe::RequestParams
+  class PaymentMethodAttachParams < ::Stripe::RequestParams
     # The ID of the customer to which to attach the PaymentMethod.
     attr_accessor :customer
+    # The ID of the Account representing the customer to which to attach the PaymentMethod.
+    attr_accessor :customer_account
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
 
-    def initialize(customer: nil, expand: nil)
+    def initialize(customer: nil, customer_account: nil, expand: nil)
       @customer = customer
+      @customer_account = customer_account
       @expand = expand
     end
   end