stripe 15.5.0 → 15.6.0.pre.alpha.1

data/lib/stripe/resources/treasury/financial_account.rb

@@ -131,10 +131,13 @@ module Stripe
 
           class FinancialAddresses < Stripe::RequestParams
             class Aba < Stripe::RequestParams
+              # Requested bank partner
+              attr_accessor :bank
               # Whether the FinancialAccount should have the Feature.
               attr_accessor :requested
 
-              def initialize(requested: nil)
+              def initialize(bank: nil, requested: nil)
+                @bank = bank
                 @requested = requested
               end
             end
@@ -274,6 +277,8 @@ module Stripe
             @outbound_flows = outbound_flows
           end
         end
+        # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+        attr_accessor :display_name
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
         # Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.
@@ -288,6 +293,7 @@ module Stripe
         attr_accessor :supported_currencies
 
         def initialize(
+          display_name: nil,
           expand: nil,
           features: nil,
           metadata: nil,
@@ -295,6 +301,7 @@ module Stripe
           platform_restrictions: nil,
           supported_currencies: nil
         )
+          @display_name = display_name
           @expand = expand
           @features = features
           @metadata = metadata
@@ -326,10 +333,13 @@ module Stripe
 
           class FinancialAddresses < Stripe::RequestParams
             class Aba < Stripe::RequestParams
+              # Requested bank partner
+              attr_accessor :bank
               # Whether the FinancialAccount should have the Feature.
               attr_accessor :requested
 
-              def initialize(requested: nil)
+              def initialize(bank: nil, requested: nil)
+                @bank = bank
                 @requested = requested
               end
             end
@@ -484,6 +494,8 @@ module Stripe
             @outbound_flows = outbound_flows
           end
         end
+        # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+        attr_accessor :display_name
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
         # Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.
@@ -498,6 +510,7 @@ module Stripe
         attr_accessor :platform_restrictions
 
         def initialize(
+          display_name: nil,
           expand: nil,
           features: nil,
           forwarding_settings: nil,
@@ -505,6 +518,7 @@ module Stripe
           nickname: nil,
           platform_restrictions: nil
         )
+          @display_name = display_name
           @expand = expand
           @features = features
           @forwarding_settings = forwarding_settings
@@ -544,10 +558,13 @@ module Stripe
 
         class FinancialAddresses < Stripe::RequestParams
           class Aba < Stripe::RequestParams
+            # Requested bank partner
+            attr_accessor :bank
             # Whether the FinancialAccount should have the Feature.
             attr_accessor :requested
 
-            def initialize(requested: nil)
+            def initialize(bank: nil, requested: nil)
+              @bank = bank
               @requested = requested
             end
           end
@@ -713,6 +730,8 @@ module Stripe
       attr_reader :country
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
+      # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+      attr_reader :display_name
       # Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
       # Stripe or the platform can control Features via the requested field.
       attr_reader :features

data/lib/stripe/resources/treasury/financial_account_features.rb

@@ -55,6 +55,8 @@ module Stripe
             # The `platform_restrictions` that are restricting this Feature.
             attr_reader :restriction
           end
+          # Requested bank partner for this Financial Account
+          attr_reader :bank
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
           # Whether the Feature is operational.

data/lib/stripe/resources/treasury/outbound_transfer.rb

@@ -76,6 +76,17 @@ module Stripe
         attr_reader :us_bank_account
       end
 
+      class NetworkDetails < Stripe::StripeObject
+        class Ach < Stripe::StripeObject
+          # ACH Addenda record
+          attr_reader :addenda
+        end
+        # Details about an ACH transaction.
+        attr_reader :ach
+        # The type of flow that originated the OutboundTransfer.
+        attr_reader :type
+      end
+
       class ReturnedDetails < Stripe::StripeObject
         # Reason for the return.
         attr_reader :code
@@ -176,6 +187,26 @@ module Stripe
             @us_bank_account = us_bank_account
           end
         end
+
+        class NetworkDetails < Stripe::RequestParams
+          class Ach < Stripe::RequestParams
+            # Addenda record data associated with this OutboundTransfer.
+            attr_accessor :addenda
+
+            def initialize(addenda: nil)
+              @addenda = addenda
+            end
+          end
+          # Optional fields for `ach`.
+          attr_accessor :ach
+          # The type of flow that originated the OutboundTransfer.
+          attr_accessor :type
+
+          def initialize(ach: nil, type: nil)
+            @ach = ach
+            @type = type
+          end
+        end
         # Amount (in cents) to be transferred.
         attr_accessor :amount
         # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -194,6 +225,8 @@ module Stripe
         attr_accessor :financial_account
         # 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`.
         attr_accessor :metadata
+        # Details about the network used for the OutboundTransfer.
+        attr_accessor :network_details
         # Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
         attr_accessor :statement_descriptor
 
@@ -207,6 +240,7 @@ module Stripe
           expand: nil,
           financial_account: nil,
           metadata: nil,
+          network_details: nil,
           statement_descriptor: nil
         )
           @amount = amount
@@ -218,6 +252,7 @@ module Stripe
           @expand = expand
           @financial_account = financial_account
           @metadata = metadata
+          @network_details = network_details
           @statement_descriptor = statement_descriptor
         end
       end
@@ -343,6 +378,8 @@ module Stripe
       attr_reader :livemode
       # 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.
       attr_reader :metadata
+      # Details about the network used for the OutboundTransfer.
+      attr_reader :network_details
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Details about a returned OutboundTransfer. Only set when the status is `returned`.

data/lib/stripe/resources/treasury/received_credit.rb

@@ -107,6 +107,17 @@ module Stripe
         attr_reader :source_flow_type
       end
 
+      class NetworkDetails < Stripe::StripeObject
+        class Ach < Stripe::StripeObject
+          # ACH Addenda record
+          attr_reader :addenda
+        end
+        # Details about an ACH transaction.
+        attr_reader :ach
+        # The type of flow that originated the ReceivedCredit.
+        attr_reader :type
+      end
+
       class ReversalDetails < Stripe::StripeObject
         # Time before which a ReceivedCredit can be reversed.
         attr_reader :deadline
@@ -183,6 +194,26 @@ module Stripe
             @us_bank_account = us_bank_account
           end
         end
+
+        class NetworkDetails < Stripe::RequestParams
+          class Ach < Stripe::RequestParams
+            # ACH Addenda record
+            attr_accessor :addenda
+
+            def initialize(addenda: nil)
+              @addenda = addenda
+            end
+          end
+          # Optional fields for `ach`.
+          attr_accessor :ach
+          # The type of flow that originated the ReceivedCredit.
+          attr_accessor :type
+
+          def initialize(ach: nil, type: nil)
+            @ach = ach
+            @type = type
+          end
+        end
         # Amount (in cents) to be transferred.
         attr_accessor :amount
         # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -197,6 +228,8 @@ module Stripe
         attr_accessor :initiating_payment_method_details
         # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
         attr_accessor :network
+        # Details about the network used for the ReceivedCredit.
+        attr_accessor :network_details
 
         def initialize(
           amount: nil,
@@ -205,7 +238,8 @@ module Stripe
           expand: nil,
           financial_account: nil,
           initiating_payment_method_details: nil,
-          network: nil
+          network: nil,
+          network_details: nil
         )
           @amount = amount
           @currency = currency
@@ -214,6 +248,7 @@ module Stripe
           @financial_account = financial_account
           @initiating_payment_method_details = initiating_payment_method_details
           @network = network
+          @network_details = network_details
         end
       end
       # Amount (in cents) transferred.
@@ -240,6 +275,8 @@ module Stripe
       attr_reader :livemode
       # The rails used to send the funds.
       attr_reader :network
+      # Details specific to the money movement rails.
+      attr_reader :network_details
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Details describing when a ReceivedCredit may be reversed.

data/lib/stripe/resources/treasury/received_debit.rb

@@ -76,6 +76,19 @@ module Stripe
         attr_reader :issuing_transaction
         # Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
         attr_reader :payout
+        # The ReceivedCredit that Capital withheld from
+        attr_reader :received_credit_capital_withholding
+      end
+
+      class NetworkDetails < Stripe::StripeObject
+        class Ach < Stripe::StripeObject
+          # ACH Addenda record
+          attr_reader :addenda
+        end
+        # Details about an ACH transaction.
+        attr_reader :ach
+        # The type of flow that originated the ReceivedDebit.
+        attr_reader :type
       end
 
       class ReversalDetails < Stripe::StripeObject
@@ -142,6 +155,26 @@ module Stripe
             @us_bank_account = us_bank_account
           end
         end
+
+        class NetworkDetails < Stripe::RequestParams
+          class Ach < Stripe::RequestParams
+            # Addenda record data associated with this ReceivedDebit.
+            attr_accessor :addenda
+
+            def initialize(addenda: nil)
+              @addenda = addenda
+            end
+          end
+          # Optional fields for `ach`.
+          attr_accessor :ach
+          # The type of flow that originated the ReceivedDebit.
+          attr_accessor :type
+
+          def initialize(ach: nil, type: nil)
+            @ach = ach
+            @type = type
+          end
+        end
         # Amount (in cents) to be transferred.
         attr_accessor :amount
         # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -156,6 +189,8 @@ module Stripe
         attr_accessor :initiating_payment_method_details
         # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
         attr_accessor :network
+        # Details about the network used for the ReceivedDebit.
+        attr_accessor :network_details
 
         def initialize(
           amount: nil,
@@ -164,7 +199,8 @@ module Stripe
           expand: nil,
           financial_account: nil,
           initiating_payment_method_details: nil,
-          network: nil
+          network: nil,
+          network_details: nil
         )
           @amount = amount
           @currency = currency
@@ -173,6 +209,7 @@ module Stripe
           @financial_account = financial_account
           @initiating_payment_method_details = initiating_payment_method_details
           @network = network
+          @network_details = network_details
         end
       end
       # Amount (in cents) transferred.
@@ -199,6 +236,8 @@ module Stripe
       attr_reader :livemode
       # The network used for the ReceivedDebit.
       attr_reader :network
+      # Details specific to the money movement rails.
+      attr_reader :network_details
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Details describing when a ReceivedDebit might be reversed.

data/lib/stripe/resources/v2/billing/bill_setting.rb

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # BillSetting is responsible for settings which dictate generating bills, which include settings for calculating totals on bills, tax on bill items, as well as how to generate and present invoices.
+      class BillSetting < APIResource
+        OBJECT_NAME = "v2.billing.bill_setting"
+        def self.object_name
+          "v2.billing.bill_setting"
+        end
+
+        class Calculation < Stripe::StripeObject
+          class Tax < Stripe::StripeObject
+            # Determines if tax will be calculated automatically based on a PTC or manually based on rules defined by the merchant. Defaults to "manual".
+            attr_reader :type
+          end
+          # Settings for calculating tax.
+          attr_reader :tax
+        end
+
+        class Invoice < Stripe::StripeObject
+          class TimeUntilDue < Stripe::StripeObject
+            # The interval unit for the time until due.
+            attr_reader :interval
+            # The number of interval units. For example, if interval=day and interval_count=30,
+            # the invoice will be due in 30 days.
+            attr_reader :interval_count
+          end
+          # The amount of time until the invoice will be overdue for payment.
+          attr_reader :time_until_due
+        end
+        # Settings related to calculating a bill.
+        attr_reader :calculation
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # An optional field for adding a display name for the BillSetting object.
+        attr_reader :display_name
+        # The ID of the BillSetting object.
+        attr_reader :id
+        # Settings related to invoice behavior.
+        attr_reader :invoice
+        # The ID of the invoice rendering template to be used when generating invoices.
+        attr_reader :invoice_rendering_template
+        # The latest version of the current settings object. This will be
+        # Updated every time an attribute of the settings is updated.
+        attr_reader :latest_version
+        # The current live version of the settings object. This can be different from
+        # latest_version if settings are updated without setting live_version='latest'.
+        attr_reader :live_version
+        # A lookup key used to retrieve settings dynamically from a static string.
+        # This may be up to 200 characters.
+        attr_reader :lookup_key
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/bill_setting_version.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class BillSettingVersion < APIResource
+        OBJECT_NAME = "v2.billing.bill_setting_version"
+        def self.object_name
+          "v2.billing.bill_setting_version"
+        end
+
+        class Calculation < Stripe::StripeObject
+          class Tax < Stripe::StripeObject
+            # Determines if tax will be calculated automatically based on a PTC or manually based on rules defined by the merchant. Defaults to "manual".
+            attr_reader :type
+          end
+          # Settings for calculating tax.
+          attr_reader :tax
+        end
+
+        class Invoice < Stripe::StripeObject
+          class TimeUntilDue < Stripe::StripeObject
+            # The interval unit for the time until due.
+            attr_reader :interval
+            # The number of interval units. For example, if interval=day and interval_count=30,
+            # the invoice will be due in 30 days.
+            attr_reader :interval_count
+          end
+          # The amount of time until the invoice will be overdue for payment.
+          attr_reader :time_until_due
+        end
+        # Settings related to calculating a bill.
+        attr_reader :calculation
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # The ID of the BillSettingVersion object.
+        attr_reader :id
+        # Settings related to invoice behavior.
+        attr_reader :invoice
+        # The ID of the invoice rendering template to be used when generating invoices.
+        attr_reader :invoice_rendering_template
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/cadence.rb

@@ -0,0 +1,182 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class Cadence < APIResource
+        OBJECT_NAME = "v2.billing.cadence"
+        def self.object_name
+          "v2.billing.cadence"
+        end
+
+        class BillingCycle < Stripe::StripeObject
+          class Day < Stripe::StripeObject
+            class Time < Stripe::StripeObject
+              # 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_reader :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :second
+            end
+            # The time at which the billing cycle ends.
+            attr_reader :time
+          end
+
+          class Month < Stripe::StripeObject
+            class Time < Stripe::StripeObject
+              # 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_reader :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :second
+            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.
+            attr_reader :day_of_month
+            # The time at which the billing cycle ends.
+            attr_reader :time
+          end
+
+          class Week < Stripe::StripeObject
+            class Time < Stripe::StripeObject
+              # 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_reader :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :second
+            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.
+            attr_reader :day_of_week
+            # The time at which the billing cycle ends.
+            attr_reader :time
+          end
+
+          class Year < Stripe::StripeObject
+            class Time < Stripe::StripeObject
+              # 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_reader :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :second
+            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.
+            attr_reader :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_reader :month_of_year
+            # The time at which the billing cycle ends.
+            attr_reader :time
+          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.
+          attr_reader :interval_count
+          # The frequency at which a cadence bills.
+          attr_reader :type
+          # Specific configuration for determining billing dates when type=day.
+          attr_reader :day
+          # Specific configuration for determining billing dates when type=month.
+          attr_reader :month
+          # Specific configuration for determining billing dates when type=week.
+          attr_reader :week
+          # Specific configuration for determining billing dates when type=year.
+          attr_reader :year
+        end
+
+        class InvoiceDiscountRule < Stripe::StripeObject
+          class PercentOff < Stripe::StripeObject
+            class MaximumApplications < Stripe::StripeObject
+              # Max applications type of this discount, ex: indefinite.
+              attr_reader :type
+            end
+            # The maximum applications configuration for this discount.
+            attr_reader :maximum_applications
+            # Percent that will be taken off of the amount. For example, percent_off of 50.0 will make $100 amount $50 instead.
+            attr_reader :percent_off
+          end
+          # Unique identifier for the object.
+          attr_reader :id
+          # The type of the discount.
+          attr_reader :type
+          # Details if the discount is a percentage off.
+          attr_reader :percent_off
+        end
+
+        class Payer < Stripe::StripeObject
+          # The ID of the Billing Profile object which determines how a bill will be paid.
+          attr_reader :billing_profile
+          # The ID of the Customer object.
+          attr_reader :customer
+          # A string identifying the type of the payer. Currently the only supported value is `customer`.
+          attr_reader :type
+        end
+
+        class Settings < Stripe::StripeObject
+          class Bill < Stripe::StripeObject
+            # The ID of the referenced settings object.
+            attr_reader :id
+            # Returns the Settings Version when the cadence is pinned to a specific version.
+            attr_reader :version
+          end
+
+          class Collection < Stripe::StripeObject
+            # The ID of the referenced settings object.
+            attr_reader :id
+            # Returns the Settings Version when the cadence is pinned to a specific version.
+            attr_reader :version
+          end
+          # Settings that configure bills generation, which includes calculating totals, tax, and presenting invoices.
+          attr_reader :bill
+          # Settings that configure and manage the behavior of collecting payments.
+          attr_reader :collection
+        end
+        # The billing cycle is the object that defines future billing cycle dates.
+        attr_reader :billing_cycle
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Unique identifier for the object.
+        attr_reader :id
+        # The discount rules applied to all invoices for the cadence.
+        attr_reader :invoice_discount_rules
+        # 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_reader :metadata
+        # The date that the billing cadence will next bill. Null if the cadence is not active.
+        attr_reader :next_billing_date
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The payer determines the entity financially responsible for the bill.
+        attr_reader :payer
+        # The settings associated with the cadence.
+        attr_reader :settings
+        # The current status of the cadence.
+        attr_reader :status
+        # The ID of the Test Clock.
+        attr_reader :test_clock
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+      end
+    end
+  end
+end