stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/apple_pay_domain.rb

@@ -13,6 +13,19 @@ module Stripe
       "apple_pay_domain"
     end
 
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Attribute for field domain_name
+    attr_reader :domain_name
+    # Unique identifier for the object.
+    attr_reader :id
+    # 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
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Always true for a deleted object
+    attr_reader :deleted
+
     # Create an apple pay domain.
     def self.create(params = {}, opts = {})
       request_stripe_object(
@@ -51,5 +64,13 @@ module Stripe
     def self.resource_url
       "/v1/apple_pay/domains"
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/application.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Application < APIResource
+    OBJECT_NAME = "application"
+    def self.object_name
+      "application"
+    end
+
+    # Unique identifier for the object.
+    attr_reader :id
+    # The name of the application.
+    attr_reader :name
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Always true for a deleted object
+    attr_reader :deleted
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/application_fee.rb

@@ -13,9 +13,64 @@ module Stripe
 
     nested_resource_class_methods :refund, operations: %i[create retrieve update list]
 
+    class FeeSource < Stripe::StripeObject
+      # Charge ID that created this application fee.
+      attr_reader :charge
+      # Payout ID that created this application fee.
+      attr_reader :payout
+      # Type of object that created the application fee.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # ID of the Stripe account this fee was taken from.
+    attr_reader :account
+    # Amount earned, in cents (or local equivalent).
+    attr_reader :amount
+    # Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)
+    attr_reader :amount_refunded
+    # ID of the Connect application that earned the fee.
+    attr_reader :application
+    # Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
+    attr_reader :balance_transaction
+    # ID of the charge that the application fee was taken from.
+    attr_reader :charge
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # 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).
+    attr_reader :currency
+    # Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.
+    attr_reader :fee_source
+    # Unique identifier for the object.
+    attr_reader :id
+    # 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
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.
+    attr_reader :originating_transaction
+    # Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
+    attr_reader :refunded
+    # A list of refunds that have been applied to the fee.
+    attr_reader :refunds
+
     # Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
     def self.list(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/application_fees", params: params, opts: opts)
     end
+
+    def self.inner_class_types
+      @inner_class_types = { fee_source: FeeSource }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/application_fee_refund.rb

@@ -15,6 +15,23 @@ module Stripe
       "fee_refund"
     end
 
+    # Amount, in cents (or local equivalent).
+    attr_reader :amount
+    # Balance transaction that describes the impact on your account balance.
+    attr_reader :balance_transaction
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # 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).
+    attr_reader :currency
+    # ID of the application fee that was refunded.
+    attr_reader :fee
+    # Unique identifier for the object.
+    attr_reader :id
+    # 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
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+
     def resource_url
       "#{ApplicationFee.resource_url}/#{CGI.escape(fee)}/refunds" \
         "/#{CGI.escape(id)}"
@@ -34,5 +51,13 @@ module Stripe
             "application fee ID. Retrieve an application fee refund using " \
             "`ApplicationFee.retrieve_refund('fee_id', 'refund_id')`"
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/apps/secret.rb

@@ -21,6 +21,39 @@ module Stripe
         "apps.secret"
       end
 
+      class Scope < Stripe::StripeObject
+        # The secret scope type.
+        attr_reader :type
+        # The user ID, if type is set to "user"
+        attr_reader :user
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # If true, indicates that this secret has been deleted
+      attr_reader :deleted
+      # The Unix timestamp for the expiry time of the secret, after which the secret deletes.
+      attr_reader :expires_at
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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
+      # A name for the secret that's unique within the scope.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The plaintext secret value to be stored.
+      attr_reader :payload
+      # Attribute for field scope
+      attr_reader :scope
+
       # Create or replace a secret in the secret store.
       def self.create(params = {}, opts = {})
         request_stripe_object(method: :post, path: "/v1/apps/secrets", params: params, opts: opts)
@@ -50,6 +83,14 @@ module Stripe
       def self.list(params = {}, opts = {})
         request_stripe_object(method: :get, path: "/v1/apps/secrets", params: params, opts: opts)
       end
+
+      def self.inner_class_types
+        @inner_class_types = { scope: Scope }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

data/lib/stripe/resources/balance.rb

@@ -5,18 +5,336 @@ module Stripe
   # This is an object representing your Stripe balance. You can retrieve it to see
   # the balance currently on your Stripe account.
   #
-  # You can also retrieve the balance history, which contains a list of
-  # [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance
-  # (charges, payouts, and so forth).
+  # The top-level `available` and `pending` comprise your "payments balance."
   #
-  # The available and pending amounts for each currency are broken down further by
-  # payment source types.
-  #
-  # Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
+  # Related guide: [Balances and settlement time](https://stripe.com/docs/payments/balances), [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
   class Balance < SingletonAPIResource
     OBJECT_NAME = "balance"
     def self.object_name
       "balance"
     end
+
+    class Available < Stripe::StripeObject
+      class SourceTypes < Stripe::StripeObject
+        # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+        attr_reader :bank_account
+        # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+        attr_reader :card
+        # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+        attr_reader :fpx
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Balance amount.
+      attr_reader :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).
+      attr_reader :currency
+      # Attribute for field source_types
+      attr_reader :source_types
+
+      def self.inner_class_types
+        @inner_class_types = { source_types: SourceTypes }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class ConnectReserved < Stripe::StripeObject
+      class SourceTypes < Stripe::StripeObject
+        # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+        attr_reader :bank_account
+        # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+        attr_reader :card
+        # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+        attr_reader :fpx
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Balance amount.
+      attr_reader :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).
+      attr_reader :currency
+      # Attribute for field source_types
+      attr_reader :source_types
+
+      def self.inner_class_types
+        @inner_class_types = { source_types: SourceTypes }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class InstantAvailable < Stripe::StripeObject
+      class NetAvailable < Stripe::StripeObject
+        class SourceTypes < Stripe::StripeObject
+          # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+          attr_reader :bank_account
+          # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+          attr_reader :card
+          # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+          attr_reader :fpx
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Net balance amount, subtracting fees from platform-set pricing.
+        attr_reader :amount
+        # ID of the external account for this net balance (not expandable).
+        attr_reader :destination
+        # Attribute for field source_types
+        attr_reader :source_types
+
+        def self.inner_class_types
+          @inner_class_types = { source_types: SourceTypes }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class SourceTypes < Stripe::StripeObject
+        # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+        attr_reader :bank_account
+        # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+        attr_reader :card
+        # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+        attr_reader :fpx
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Balance amount.
+      attr_reader :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).
+      attr_reader :currency
+      # Breakdown of balance by destination.
+      attr_reader :net_available
+      # Attribute for field source_types
+      attr_reader :source_types
+
+      def self.inner_class_types
+        @inner_class_types = { net_available: NetAvailable, source_types: SourceTypes }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Issuing < Stripe::StripeObject
+      class Available < Stripe::StripeObject
+        class SourceTypes < Stripe::StripeObject
+          # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+          attr_reader :bank_account
+          # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+          attr_reader :card
+          # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+          attr_reader :fpx
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Balance amount.
+        attr_reader :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).
+        attr_reader :currency
+        # Attribute for field source_types
+        attr_reader :source_types
+
+        def self.inner_class_types
+          @inner_class_types = { source_types: SourceTypes }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Funds that are available for use.
+      attr_reader :available
+
+      def self.inner_class_types
+        @inner_class_types = { available: Available }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Pending < Stripe::StripeObject
+      class SourceTypes < Stripe::StripeObject
+        # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+        attr_reader :bank_account
+        # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+        attr_reader :card
+        # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+        attr_reader :fpx
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Balance amount.
+      attr_reader :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).
+      attr_reader :currency
+      # Attribute for field source_types
+      attr_reader :source_types
+
+      def self.inner_class_types
+        @inner_class_types = { source_types: SourceTypes }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class RefundAndDisputePrefunding < Stripe::StripeObject
+      class Available < Stripe::StripeObject
+        class SourceTypes < Stripe::StripeObject
+          # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+          attr_reader :bank_account
+          # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+          attr_reader :card
+          # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+          attr_reader :fpx
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Balance amount.
+        attr_reader :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).
+        attr_reader :currency
+        # Attribute for field source_types
+        attr_reader :source_types
+
+        def self.inner_class_types
+          @inner_class_types = { source_types: SourceTypes }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Pending < Stripe::StripeObject
+        class SourceTypes < Stripe::StripeObject
+          # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+          attr_reader :bank_account
+          # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+          attr_reader :card
+          # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+          attr_reader :fpx
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Balance amount.
+        attr_reader :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).
+        attr_reader :currency
+        # Attribute for field source_types
+        attr_reader :source_types
+
+        def self.inner_class_types
+          @inner_class_types = { source_types: SourceTypes }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Funds that are available for use.
+      attr_reader :available
+      # Funds that are pending
+      attr_reader :pending
+
+      def self.inner_class_types
+        @inner_class_types = { available: Available, pending: Pending }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.
+    attr_reader :available
+    # Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.
+    attr_reader :connect_reserved
+    # Funds that you can pay out using Instant Payouts.
+    attr_reader :instant_available
+    # Attribute for field issuing
+    attr_reader :issuing
+    # 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
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.
+    attr_reader :pending
+    # Attribute for field refund_and_dispute_prefunding
+    attr_reader :refund_and_dispute_prefunding
+
+    def self.inner_class_types
+      @inner_class_types = {
+        available: Available,
+        connect_reserved: ConnectReserved,
+        instant_available: InstantAvailable,
+        issuing: Issuing,
+        pending: Pending,
+        refund_and_dispute_prefunding: RefundAndDisputePrefunding,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/balance_settings.rb

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Options for customizing account balances and payout settings for a Stripe platform's connected accounts.
+  class BalanceSettings < SingletonAPIResource
+    include Stripe::APIOperations::SingletonSave
+
+    OBJECT_NAME = "balance_settings"
+    def self.object_name
+      "balance_settings"
+    end
+
+    class Payments < Stripe::StripeObject
+      class Payouts < Stripe::StripeObject
+        class Schedule < Stripe::StripeObject
+          # How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
+          attr_reader :interval
+          # The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
+          attr_reader :monthly_payout_days
+          # The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
+          attr_reader :weekly_payout_days
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).
+        attr_reader :minimum_balance_by_currency
+        # Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation for details.
+        attr_reader :schedule
+        # The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
+        attr_reader :statement_descriptor
+        # Whether the funds in this account can be paid out.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { schedule: Schedule }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class SettlementTiming < Stripe::StripeObject
+        # The number of days charge funds are held before becoming available.
+        attr_reader :delay_days
+        # The number of days charge funds are held before becoming available. If present, overrides the default, or minimum available, for the account.
+        attr_reader :delay_days_override
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
+      attr_reader :debit_negative_balances
+      # Settings specific to the account's payouts.
+      attr_reader :payouts
+      # Attribute for field settlement_timing
+      attr_reader :settlement_timing
+
+      def self.inner_class_types
+        @inner_class_types = { payouts: Payouts, settlement_timing: SettlementTiming }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Attribute for field payments
+    attr_reader :payments
+
+    def self.inner_class_types
+      @inner_class_types = { payments: Payments }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end