stripe 17.0.0 → 17.1.0.pre.alpha.1

data/lib/stripe/params/v2/billing/bill_settings/version_list_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module BillSettings
+        class VersionListParams < ::Stripe::RequestParams
+          # Optionally set the maximum number of results per page. Defaults to 20.
+          attr_accessor :limit
+
+          def initialize(limit: nil)
+            @limit = limit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/bill_settings/version_retrieve_params.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module BillSettings
+        class VersionRetrieveParams < ::Stripe::RequestParams; end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/cadence_cancel_params.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class CadenceCancelParams < ::Stripe::RequestParams
+        # Additional resource to include in the response.
+        attr_accessor :include
+
+        def initialize(include: nil)
+          @include = include
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/cadence_create_params.rb

@@ -0,0 +1,257 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class CadenceCreateParams < ::Stripe::RequestParams
+        class BillingCycle < ::Stripe::RequestParams
+          class Day < ::Stripe::RequestParams
+            class Time < ::Stripe::RequestParams
+              # The hour at which the billing cycle ends.
+              # This must be an integer between 0 and 23, inclusive.
+              # 0 represents midnight, and 23 represents 11 PM.
+              attr_accessor :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_accessor :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_accessor :second
+
+              def initialize(hour: nil, minute: nil, second: nil)
+                @hour = hour
+                @minute = minute
+                @second = second
+              end
+            end
+            # The time at which the billing cycle ends.
+            # This field is optional, and if not provided, it will default to
+            # the time at which the cadence was created in UTC timezone.
+            attr_accessor :time
+
+            def initialize(time: nil)
+              @time = time
+            end
+          end
+
+          class Month < ::Stripe::RequestParams
+            class Time < ::Stripe::RequestParams
+              # The hour at which the billing cycle ends.
+              # This must be an integer between 0 and 23, inclusive.
+              # 0 represents midnight, and 23 represents 11 PM.
+              attr_accessor :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_accessor :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_accessor :second
+
+              def initialize(hour: nil, minute: nil, second: nil)
+                @hour = hour
+                @minute = minute
+                @second = second
+              end
+            end
+            # The day to anchor the billing on for a type="month" billing cycle from
+            # 1-31. If this number is greater than the number of days in the month being
+            # billed, this will anchor to the last day of the month. If not provided,
+            # this will default to the day the cadence was created.
+            attr_accessor :day_of_month
+            # The month to anchor the billing on for a type="month" billing cycle from
+            # 1-12. If not provided, this will default to the month the cadence was created.
+            # This setting can only be used for monthly billing cycles with `interval_count` of 2, 3, 4 or 6.
+            # All occurrences will be calculated from month provided.
+            attr_accessor :month_of_year
+            # The time at which the billing cycle ends.
+            # This field is optional, and if not provided, it will default to
+            # the time at which the cadence was created in UTC timezone.
+            attr_accessor :time
+
+            def initialize(day_of_month: nil, month_of_year: nil, time: nil)
+              @day_of_month = day_of_month
+              @month_of_year = month_of_year
+              @time = time
+            end
+          end
+
+          class Week < ::Stripe::RequestParams
+            class Time < ::Stripe::RequestParams
+              # The hour at which the billing cycle ends.
+              # This must be an integer between 0 and 23, inclusive.
+              # 0 represents midnight, and 23 represents 11 PM.
+              attr_accessor :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_accessor :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_accessor :second
+
+              def initialize(hour: nil, minute: nil, second: nil)
+                @hour = hour
+                @minute = minute
+                @second = second
+              end
+            end
+            # The day of the week to bill the type=week billing cycle on.
+            # Numbered from 1-7 for Monday to Sunday respectively, based on the ISO-8601
+            # week day numbering. If not provided, this will default to the day the
+            # cadence was created.
+            attr_accessor :day_of_week
+            # The time at which the billing cycle ends.
+            # This field is optional, and if not provided, it will default to
+            # the time at which the cadence was created in UTC timezone.
+            attr_accessor :time
+
+            def initialize(day_of_week: nil, time: nil)
+              @day_of_week = day_of_week
+              @time = time
+            end
+          end
+
+          class Year < ::Stripe::RequestParams
+            class Time < ::Stripe::RequestParams
+              # The hour at which the billing cycle ends.
+              # This must be an integer between 0 and 23, inclusive.
+              # 0 represents midnight, and 23 represents 11 PM.
+              attr_accessor :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_accessor :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_accessor :second
+
+              def initialize(hour: nil, minute: nil, second: nil)
+                @hour = hour
+                @minute = minute
+                @second = second
+              end
+            end
+            # The day to anchor the billing on for a type="month" billing cycle from
+            # 1-31. If this number is greater than the number of days in the month being
+            # billed, this will anchor to the last day of the month. If not provided,
+            # this will default to the day the cadence was created.
+            attr_accessor :day_of_month
+            # The month to bill on from 1-12. If not provided, this will default to the
+            # month the cadence was created.
+            attr_accessor :month_of_year
+            # The time at which the billing cycle ends.
+            # This field is optional, and if not provided, it will default to
+            # the time at which the cadence was created in UTC timezone.
+            attr_accessor :time
+
+            def initialize(day_of_month: nil, month_of_year: nil, time: nil)
+              @day_of_month = day_of_month
+              @month_of_year = month_of_year
+              @time = time
+            end
+          end
+          # The number of intervals (specified in the interval attribute) between
+          # cadence billings. For example, type=month and interval_count=3 bills every
+          # 3 months. If this is not provided, it will default to 1.
+          attr_accessor :interval_count
+          # The frequency at which a cadence bills.
+          attr_accessor :type
+          # Specific configuration for determining billing dates when type=day.
+          attr_accessor :day
+          # Specific configuration for determining billing dates when type=month.
+          attr_accessor :month
+          # Specific configuration for determining billing dates when type=week.
+          attr_accessor :week
+          # Specific configuration for determining billing dates when type=year.
+          attr_accessor :year
+
+          def initialize(interval_count: nil, type: nil, day: nil, month: nil, week: nil, year: nil)
+            @interval_count = interval_count
+            @type = type
+            @day = day
+            @month = month
+            @week = week
+            @year = year
+          end
+        end
+
+        class Payer < ::Stripe::RequestParams
+          # The ID of the Billing Profile object which determines how a bill will be paid.
+          attr_accessor :billing_profile
+
+          def initialize(billing_profile: nil)
+            @billing_profile = billing_profile
+          end
+        end
+
+        class Settings < ::Stripe::RequestParams
+          class Bill < ::Stripe::RequestParams
+            # The ID of the referenced settings object.
+            attr_accessor :id
+            # An optional field to specify the version of the Settings to use.
+            # If not provided, this will always default to the live version any time the settings are used.
+            attr_accessor :version
+
+            def initialize(id: nil, version: nil)
+              @id = id
+              @version = version
+            end
+          end
+
+          class Collection < ::Stripe::RequestParams
+            # The ID of the referenced settings object.
+            attr_accessor :id
+            # An optional field to specify the version of the Settings to use.
+            # If not provided, this will always default to the live version any time the settings are used.
+            attr_accessor :version
+
+            def initialize(id: nil, version: nil)
+              @id = id
+              @version = version
+            end
+          end
+          # Settings that configure bill generation, which includes calculating totals, tax, and presenting invoices.
+          # If no setting is provided here, the settings from the customer referenced on the payer will be used.
+          # If no customer settings are present, the merchant default settings will be used.
+          attr_accessor :bill
+          # Settings that configure and manage the behavior of collecting payments.
+          # If no setting is provided here, the settings from the customer referenced from the payer will be used if they exist.
+          # If no customer settings are present, the merchant default settings will be used.
+          attr_accessor :collection
+
+          def initialize(bill: nil, collection: nil)
+            @bill = bill
+            @collection = collection
+          end
+        end
+        # The billing cycle is the object that defines future billing cycle dates.
+        attr_accessor :billing_cycle
+        # Additional resource to include in the response.
+        attr_accessor :include
+        # A lookup key used to retrieve cadences dynamically from a static string. Maximum length of 200 characters.
+        attr_accessor :lookup_key
+        # Set of [key-value pairs](/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.
+        attr_accessor :metadata
+        # The payer determines the entity financially responsible for the bill.
+        attr_accessor :payer
+        # The settings associated with the cadence.
+        attr_accessor :settings
+
+        def initialize(
+          billing_cycle: nil,
+          include: nil,
+          lookup_key: nil,
+          metadata: nil,
+          payer: nil,
+          settings: nil
+        )
+          @billing_cycle = billing_cycle
+          @include = include
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @payer = payer
+          @settings = settings
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/cadence_list_params.rb

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class CadenceListParams < ::Stripe::RequestParams
+        class Payer < ::Stripe::RequestParams
+          # The ID of the Customer object. If provided, only cadences that specifically reference the provided customer ID will be returned.
+          attr_accessor :customer
+          # A string identifying the type of the payer. Currently the only supported value is `customer`.
+          attr_accessor :type
+
+          def initialize(customer: nil, type: nil)
+            @customer = customer
+            @type = type
+          end
+        end
+        # Additional resource to include in the response.
+        attr_accessor :include
+        # Optionally set the maximum number of results per page. Defaults to 20.
+        attr_accessor :limit
+        # Only return the cadences with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
+        # Mutually exclusive with `test_clock` and `payer`.
+        attr_accessor :lookup_keys
+        # If provided, only cadences that specifically reference the payer will be returned. Mutually exclusive with `test_clock` and `lookup_keys`.
+        attr_accessor :payer
+        # If provided, only cadences that specifically reference the provided test clock ID (via the
+        # customer's test clock) will be returned.
+        # Mutually exclusive with `payer`.
+        attr_accessor :test_clock
+
+        def initialize(include: nil, limit: nil, lookup_keys: nil, payer: nil, test_clock: nil)
+          @include = include
+          @limit = limit
+          @lookup_keys = lookup_keys
+          @payer = payer
+          @test_clock = test_clock
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/cadence_retrieve_params.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class CadenceRetrieveParams < ::Stripe::RequestParams
+        # Additional resource to include in the response.
+        attr_accessor :include
+
+        def initialize(include: nil)
+          @include = include
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/cadence_update_params.rb

@@ -0,0 +1,78 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class CadenceUpdateParams < ::Stripe::RequestParams
+        class Payer < ::Stripe::RequestParams
+          # The ID of the Billing Profile object which determines how a bill will be paid.
+          attr_accessor :billing_profile
+
+          def initialize(billing_profile: nil)
+            @billing_profile = billing_profile
+          end
+        end
+
+        class Settings < ::Stripe::RequestParams
+          class Bill < ::Stripe::RequestParams
+            # The ID of the referenced settings object.
+            attr_accessor :id
+            # An optional field to specify the version of Settings to use.
+            # If not provided, this will always default to the `live_version` specified on the setting, any time the settings are used.
+            # Using a specific version here will prevent the settings from updating, and is discouraged for cadences.
+            # To clear a pinned version, set the version to null.
+            attr_accessor :version
+
+            def initialize(id: nil, version: nil)
+              @id = id
+              @version = version
+            end
+          end
+
+          class Collection < ::Stripe::RequestParams
+            # The ID of the referenced settings object.
+            attr_accessor :id
+            # An optional field to specify the version of Settings to use.
+            # If not provided, this will always default to the `live_version` specified on the setting, any time the settings are used.
+            # Using a specific version here will prevent the settings from updating, and is discouraged for cadences.
+            # To clear a pinned version, set the version to null.
+            attr_accessor :version
+
+            def initialize(id: nil, version: nil)
+              @id = id
+              @version = version
+            end
+          end
+          # Settings that configure bills generation, which includes calculating totals, tax, and presenting invoices. If null is provided, the current bill settings will be removed from the billing cadence.
+          attr_accessor :bill
+          # Settings that configure and manage the behavior of collecting payments. If null is provided, the current collection settings will be removed from the billing cadence.
+          attr_accessor :collection
+
+          def initialize(bill: nil, collection: nil)
+            @bill = bill
+            @collection = collection
+          end
+        end
+        # Additional resource to include in the response.
+        attr_accessor :include
+        # A lookup key used to retrieve cadences dynamically from a static string. Maximum length of 200 characters.
+        attr_accessor :lookup_key
+        # Set of [key-value pairs](/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.
+        attr_accessor :metadata
+        # The payer determines the entity financially responsible for the bill.
+        attr_accessor :payer
+        # The settings associated with the cadence.
+        attr_accessor :settings
+
+        def initialize(include: nil, lookup_key: nil, metadata: nil, payer: nil, settings: nil)
+          @include = include
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @payer = payer
+          @settings = settings
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/collection_setting_create_params.rb

@@ -0,0 +1,223 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class CollectionSettingCreateParams < ::Stripe::RequestParams
+        class EmailDelivery < ::Stripe::RequestParams
+          class PaymentDue < ::Stripe::RequestParams
+            # If true an email for the invoice would be generated and sent out.
+            attr_accessor :enabled
+            # If true the payment link to hosted invocie page would be included in email and PDF of the invoice.
+            attr_accessor :include_payment_link
+
+            def initialize(enabled: nil, include_payment_link: nil)
+              @enabled = enabled
+              @include_payment_link = include_payment_link
+            end
+          end
+          # Controls emails for when the payment is due. For example after the invoice is finilized and transition to Open state.
+          attr_accessor :payment_due
+
+          def initialize(payment_due: nil)
+            @payment_due = payment_due
+          end
+        end
+
+        class PaymentMethodOptions < ::Stripe::RequestParams
+          class AcssDebit < ::Stripe::RequestParams
+            class MandateOptions < ::Stripe::RequestParams
+              # Transaction type of the mandate.
+              attr_accessor :transaction_type
+
+              def initialize(transaction_type: nil)
+                @transaction_type = transaction_type
+              end
+            end
+            # Additional fields for Mandate creation.
+            attr_accessor :mandate_options
+            # Verification method.
+            attr_accessor :verification_method
+
+            def initialize(mandate_options: nil, verification_method: nil)
+              @mandate_options = mandate_options
+              @verification_method = verification_method
+            end
+          end
+
+          class Bancontact < ::Stripe::RequestParams
+            # Preferred language of the Bancontact authorization page that the customer is redirected to.
+            attr_accessor :preferred_language
+
+            def initialize(preferred_language: nil)
+              @preferred_language = preferred_language
+            end
+          end
+
+          class Card < ::Stripe::RequestParams
+            class MandateOptions < ::Stripe::RequestParams
+              # Amount to be charged for future payments.
+              attr_accessor :amount
+              # The AmountType for the mandate. One of `fixed` or `maximum`.
+              attr_accessor :amount_type
+              # A description of the mandate that is meant to be displayed to the customer.
+              attr_accessor :description
+
+              def initialize(amount: nil, amount_type: nil, description: nil)
+                @amount = amount
+                @amount_type = amount_type
+                @description = description
+              end
+            end
+            # Configuration options for setting up an eMandate for cards issued in India.
+            attr_accessor :mandate_options
+            # Selected network to process the payment on. Depends on the available networks of the card.
+            attr_accessor :network
+            # An advanced option 3D Secure. We strongly recommend that you rely on our SCA Engine to automatically prompt your customers
+            # for authentication based on risk level and [other requirements](https://docs.corp.stripe.com/strong-customer-authentication).
+            # However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
+            # Read our guide on [manually requesting 3D Secure](https://docs.corp.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
+            attr_accessor :request_three_d_secure
+
+            def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil)
+              @mandate_options = mandate_options
+              @network = network
+              @request_three_d_secure = request_three_d_secure
+            end
+          end
+
+          class CustomerBalance < ::Stripe::RequestParams
+            class BankTransfer < ::Stripe::RequestParams
+              class EuBankTransfer < ::Stripe::RequestParams
+                # The desired country code of the bank account information.
+                attr_accessor :country
+
+                def initialize(country: nil)
+                  @country = country
+                end
+              end
+              # Configuration for `eu_bank_transfer` funding type. Required if `type` is `eu_bank_transfer`.
+              attr_accessor :eu_bank_transfer
+              # The bank transfer type that can be used for funding.
+              attr_accessor :type
+
+              def initialize(eu_bank_transfer: nil, type: nil)
+                @eu_bank_transfer = eu_bank_transfer
+                @type = type
+              end
+            end
+            # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
+            attr_accessor :bank_transfer
+            # The funding method type to be used when there are not enough funds in the customer balance. Currently the only supported value is `bank_transfer`.
+            attr_accessor :funding_type
+
+            def initialize(bank_transfer: nil, funding_type: nil)
+              @bank_transfer = bank_transfer
+              @funding_type = funding_type
+            end
+          end
+
+          class UsBankAccount < ::Stripe::RequestParams
+            class FinancialConnections < ::Stripe::RequestParams
+              class Filters < ::Stripe::RequestParams
+                # The account subcategories to use to filter for selectable accounts.
+                attr_accessor :account_subcategories
+
+                def initialize(account_subcategories: nil)
+                  @account_subcategories = account_subcategories
+                end
+              end
+              # Provide filters for the linked accounts that the customer can select for the payment method.
+              attr_accessor :filters
+              # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included.
+              attr_accessor :permissions
+              # List of data features that you would like to retrieve upon account creation.
+              attr_accessor :prefetch
+
+              def initialize(filters: nil, permissions: nil, prefetch: nil)
+                @filters = filters
+                @permissions = permissions
+                @prefetch = prefetch
+              end
+            end
+            # Additional fields for Financial Connections Session creation.
+            attr_accessor :financial_connections
+            # Verification method.
+            attr_accessor :verification_method
+
+            def initialize(financial_connections: nil, verification_method: nil)
+              @financial_connections = financial_connections
+              @verification_method = verification_method
+            end
+          end
+          # This sub-hash contains details about the Canadian pre-authorized debit payment method options.
+          attr_accessor :acss_debit
+          # This sub-hash contains details about the Bancontact payment method.
+          attr_accessor :bancontact
+          # This sub-hash contains details about the Card payment method options.
+          attr_accessor :card
+          # This sub-hash contains details about the Bank transfer payment method options.
+          attr_accessor :customer_balance
+          # This sub-hash contains details about the Konbini payment method options.
+          attr_accessor :konbini
+          # This sub-hash contains details about the SEPA Direct Debit payment method options.
+          attr_accessor :sepa_debit
+          # This sub-hash contains details about the ACH direct debit payment method options.
+          attr_accessor :us_bank_account
+
+          def initialize(
+            acss_debit: nil,
+            bancontact: nil,
+            card: nil,
+            customer_balance: nil,
+            konbini: nil,
+            sepa_debit: nil,
+            us_bank_account: nil
+          )
+            @acss_debit = acss_debit
+            @bancontact = bancontact
+            @card = card
+            @customer_balance = customer_balance
+            @konbini = konbini
+            @sepa_debit = sepa_debit
+            @us_bank_account = us_bank_account
+          end
+        end
+        # Either automatic, or send_invoice. When charging automatically, Stripe will attempt to pay this
+        # bill at the end of the period using the payment method attached to the payer profile. When sending an invoice,
+        # Stripe will email your payer profile an invoice with payment instructions.
+        # Defaults to automatic.
+        attr_accessor :collection_method
+        # An optional customer-facing display name for the CollectionSetting object.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # Email delivery setting.
+        attr_accessor :email_delivery
+        # A lookup key used to retrieve settings dynamically from a static string.
+        # This may be up to 200 characters.
+        attr_accessor :lookup_key
+        # The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers.
+        attr_accessor :payment_method_configuration
+        # Payment Method specific configuration to be stored on the object.
+        attr_accessor :payment_method_options
+
+        def initialize(
+          collection_method: nil,
+          display_name: nil,
+          email_delivery: nil,
+          lookup_key: nil,
+          payment_method_configuration: nil,
+          payment_method_options: nil
+        )
+          @collection_method = collection_method
+          @display_name = display_name
+          @email_delivery = email_delivery
+          @lookup_key = lookup_key
+          @payment_method_configuration = payment_method_configuration
+          @payment_method_options = payment_method_options
+        end
+      end
+    end
+  end
+end