stripe 13.3.0 → 13.4.0.pre.beta.1

data/rbi/stripe/resources/treasury/transaction_entry.rbi

@@ -0,0 +1,234 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Treasury
+    # TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions).
+    class TransactionEntry < APIResource
+      class BalanceImpact < Stripe::StripeObject
+        # The change made to funds the user can spend right now.
+        sig { returns(Integer) }
+        attr_reader :cash
+
+        # The change made to funds that are not spendable yet, but will become available at a later time.
+        sig { returns(Integer) }
+        attr_reader :inbound_pending
+
+        # The change made to funds in the account, but not spendable because they are being held for pending outbound flows.
+        sig { returns(Integer) }
+        attr_reader :outbound_pending
+      end
+      class FlowDetails < Stripe::StripeObject
+        # You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
+        sig { returns(Stripe::Treasury::CreditReversal) }
+        attr_reader :credit_reversal
+
+        # You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
+        sig { returns(Stripe::Treasury::DebitReversal) }
+        attr_reader :debit_reversal
+
+        # Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
+        #
+        # Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)
+        sig { returns(Stripe::Treasury::InboundTransfer) }
+        attr_reader :inbound_transfer
+
+        # When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`
+        # object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the
+        # purchase to be completed successfully.
+        #
+        # Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)
+        sig { returns(Stripe::Issuing::Authorization) }
+        attr_reader :issuing_authorization
+
+        # Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
+        #
+        # Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
+        #
+        # Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
+        sig { returns(Stripe::Treasury::OutboundPayment) }
+        attr_reader :outbound_payment
+
+        # Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
+        #
+        # Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
+        #
+        # Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
+        sig { returns(Stripe::Treasury::OutboundTransfer) }
+        attr_reader :outbound_transfer
+
+        # ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
+        sig { returns(Stripe::Treasury::ReceivedCredit) }
+        attr_reader :received_credit
+
+        # ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
+        sig { returns(Stripe::Treasury::ReceivedDebit) }
+        attr_reader :received_debit
+
+        # Type of the flow that created the Transaction. Set to the same value as `flow_type`.
+        sig { returns(String) }
+        attr_reader :type
+      end
+      # Change to a FinancialAccount's balance
+      sig { returns(BalanceImpact) }
+      attr_reader :balance_impact
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      sig { returns(Integer) }
+      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).
+      sig { returns(String) }
+      attr_reader :currency
+
+      # When the TransactionEntry will impact the FinancialAccount's balance.
+      sig { returns(Integer) }
+      attr_reader :effective_at
+
+      # The FinancialAccount associated with this object.
+      sig { returns(String) }
+      attr_reader :financial_account
+
+      # Token of the flow associated with the TransactionEntry.
+      sig { returns(T.nilable(String)) }
+      attr_reader :flow
+
+      # Details of the flow associated with the TransactionEntry.
+      sig { returns(T.nilable(FlowDetails)) }
+      attr_reader :flow_details
+
+      # Type of the flow associated with the TransactionEntry.
+      sig { returns(String) }
+      attr_reader :flow_type
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      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.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+
+      # The Transaction associated with this object.
+      sig { returns(T.any(String, Stripe::Treasury::Transaction)) }
+      attr_reader :transaction
+
+      # The specific money movement that generated the TransactionEntry.
+      sig { returns(String) }
+      attr_reader :type
+
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :gt
+
+          # Minimum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :gte
+
+          # Maximum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :lt
+
+          # Maximum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :lte
+
+          sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+        end
+        class EffectiveAt < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :gt
+
+          # Minimum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :gte
+
+          # Maximum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :lt
+
+          # Maximum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :lte
+
+          sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+        end
+        # Only return TransactionEntries that were created during the given date interval.
+        sig { returns(T.any(::Stripe::Treasury::TransactionEntry::ListParams::Created, Integer)) }
+        attr_accessor :created
+
+        # Attribute for param field effective_at
+        sig {
+          returns(T.any(::Stripe::Treasury::TransactionEntry::ListParams::EffectiveAt, Integer))
+         }
+        attr_accessor :effective_at
+
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        sig { returns(String) }
+        attr_accessor :ending_before
+
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+
+        # Returns objects associated with this FinancialAccount.
+        sig { returns(String) }
+        attr_accessor :financial_account
+
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        sig { returns(Integer) }
+        attr_accessor :limit
+
+        # The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.
+        sig { returns(String) }
+        attr_accessor :order_by
+
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        sig { returns(String) }
+        attr_accessor :starting_after
+
+        # Only return TransactionEntries associated with this Transaction.
+        sig { returns(String) }
+        attr_accessor :transaction
+
+        sig {
+          params(created: T.any(::Stripe::Treasury::TransactionEntry::ListParams::Created, Integer), effective_at: T.any(::Stripe::Treasury::TransactionEntry::ListParams::EffectiveAt, Integer), ending_before: String, expand: T::Array[String], financial_account: String, limit: Integer, order_by: String, starting_after: String, transaction: String).void
+         }
+        def initialize(
+          created: nil,
+          effective_at: nil,
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          order_by: nil,
+          starting_after: nil,
+          transaction: nil
+        ); end
+      end
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+      # Retrieves a list of TransactionEntry objects.
+      sig {
+        params(params: T.any(::Stripe::Treasury::TransactionEntry::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/resources/usage_record.rbi

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Usage records allow you to report customer usage and metrics to Stripe for
+  # metered billing of subscription prices.
+  #
+  # Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)
+  #
+  # This is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based).
+  class UsageRecord < APIResource
+    # Unique identifier for the object.
+    sig { returns(String) }
+    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.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # The usage quantity for the specified date.
+    sig { returns(Integer) }
+    attr_reader :quantity
+
+    # The ID of the subscription item this usage record contains data for.
+    sig { returns(String) }
+    attr_reader :subscription_item
+
+    # The timestamp when this usage occurred.
+    sig { returns(Integer) }
+    attr_reader :timestamp
+  end
+end

data/rbi/stripe/resources/usage_record_summary.rbi

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.
+  class UsageRecordSummary < StripeObject
+    class Period < Stripe::StripeObject
+      # The end date of this usage period. All usage up to and including this point in time is included.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :end
+
+      # The start date of this usage period. All usage after this point in time is included.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :start
+    end
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+
+    # The invoice in which this usage period has been billed for.
+    sig { returns(T.nilable(String)) }
+    attr_reader :invoice
+
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # Attribute for field period
+    sig { returns(Period) }
+    attr_reader :period
+
+    # The ID of the subscription item this summary is describing.
+    sig { returns(String) }
+    attr_reader :subscription_item
+
+    # The total usage within this usage period.
+    sig { returns(Integer) }
+    attr_reader :total_usage
+  end
+end

data/rbi/stripe/resources/v2/amount.rbi

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# typed: true
+
+module Stripe
+  module V2
+    class Amount
+      sig { returns(Integer) }
+      attr_reader :value
+
+      sig { returns(String) }
+      attr_reader :currency
+    end
+  end
+end

data/rbi/stripe/resources/v2/billing/meter_event.rbi

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module V2
+    module Billing
+      # Fix me empty_doc_string.
+      class MeterEvent < APIResource
+        # The creation time of this meter event.
+        sig { returns(String) }
+        attr_reader :created
+
+        # The name of the meter event. Corresponds with the `event_name` field on a meter.
+        sig { returns(String) }
+        attr_reader :event_name
+
+        # A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We’ll enforce uniqueness within a rolling 24 hour period.
+        sig { returns(String) }
+        attr_reader :identifier
+
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        sig { returns(T::Boolean) }
+        attr_reader :livemode
+
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        sig { returns(String) }
+        attr_reader :object
+
+        # The payload of the event. This must contain the fields corresponding to a meter’s
+        # `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and
+        # `value_settings.event_payload_key` (default is `value`). Read more about the payload.
+        sig { returns(T::Hash[String, String]) }
+        attr_reader :payload
+
+        # The time of the event. Must be within the past 35 calendar days or up to
+        # 5 minutes in the future. Defaults to current timestamp if not specified.
+        sig { returns(String) }
+        attr_reader :timestamp
+      end
+    end
+  end
+end

data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module V2
+    module Billing
+      class MeterEventAdjustment < APIResource
+        class Cancel < Stripe::StripeObject
+          # Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+          sig { returns(String) }
+          attr_reader :identifier
+        end
+        # Specifies which event to cancel.
+        sig { returns(Cancel) }
+        attr_reader :cancel
+
+        # The time the adjustment was created.
+        sig { returns(String) }
+        attr_reader :created
+
+        # The name of the meter event. Corresponds with the `event_name` field on a meter.
+        sig { returns(String) }
+        attr_reader :event_name
+
+        # The unique id of this meter event adjustment.
+        sig { returns(String) }
+        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.
+        sig { returns(T::Boolean) }
+        attr_reader :livemode
+
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        sig { returns(String) }
+        attr_reader :object
+
+        # Open Enum. The meter event adjustment’s status.
+        sig { returns(String) }
+        attr_reader :status
+
+        # Open Enum. Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+        sig { returns(String) }
+        attr_reader :type
+      end
+    end
+  end
+end

data/rbi/stripe/resources/v2/billing/meter_event_session.rbi

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module V2
+    module Billing
+      class MeterEventSession < APIResource
+        # The authentication token for this session.  Use this token when calling the
+        # high-throughput meter event API.
+        sig { returns(String) }
+        attr_reader :authentication_token
+
+        # The creation time of this session.
+        sig { returns(String) }
+        attr_reader :created
+
+        # The time at which this session will expire.
+        sig { returns(String) }
+        attr_reader :expires_at
+
+        # The unique id of this auth session.
+        sig { returns(String) }
+        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.
+        sig { returns(T::Boolean) }
+        attr_reader :livemode
+
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        sig { returns(String) }
+        attr_reader :object
+      end
+    end
+  end
+end

data/rbi/stripe/resources/v2/event.rbi

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module V2
+    class Event < APIResource
+      class Reason < Stripe::StripeObject
+        class Request < Stripe::StripeObject
+          # ID of the API request that caused the event.
+          sig { returns(String) }
+          attr_reader :id
+
+          # The idempotency key transmitted during the request.
+          sig { returns(String) }
+          attr_reader :idempotency_key
+        end
+        # Event reason type.
+        sig { returns(String) }
+        attr_reader :type
+
+        # Information on the API request that instigated the event.
+        sig { returns(T.nilable(Request)) }
+        attr_reader :request
+      end
+      # Authentication context needed to fetch the event or related object.
+      sig { returns(T.nilable(String)) }
+      attr_reader :context
+
+      # Time at which the object was created.
+      sig { returns(String) }
+      attr_reader :created
+
+      # Unique identifier for the event.
+      sig { returns(String) }
+      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.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      sig { returns(String) }
+      attr_reader :object
+
+      # Reason for the event.
+      sig { returns(T.nilable(Reason)) }
+      attr_reader :reason
+
+      # The type of the event.
+      sig { returns(String) }
+      attr_reader :type
+    end
+  end
+end

data/rbi/stripe/resources/v2/event_destination.rbi

@@ -0,0 +1,109 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module V2
+    class EventDestination < APIResource
+      class StatusDetails < Stripe::StripeObject
+        class Disabled < Stripe::StripeObject
+          # Reason event destination has been disabled.
+          sig { returns(String) }
+          attr_reader :reason
+        end
+        # Details about why the event destination has been disabled.
+        sig { returns(T.nilable(Disabled)) }
+        attr_reader :disabled
+      end
+      class AmazonEventbridge < Stripe::StripeObject
+        # The AWS account ID.
+        sig { returns(String) }
+        attr_reader :aws_account_id
+
+        # The ARN of the AWS event source.
+        sig { returns(String) }
+        attr_reader :aws_event_source_arn
+
+        # The state of the AWS event source.
+        sig { returns(String) }
+        attr_reader :aws_event_source_status
+      end
+      class WebhookEndpoint < Stripe::StripeObject
+        # The signing secret of the webhook endpoint, only includable on creation.
+        sig { returns(T.nilable(String)) }
+        attr_reader :signing_secret
+
+        # The URL of the webhook endpoint, includable.
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+      end
+      # Time at which the object was created.
+      sig { returns(String) }
+      attr_reader :created
+
+      # An optional description of what the event destination is used for.
+      sig { returns(String) }
+      attr_reader :description
+
+      # The list of events to enable for this endpoint.
+      sig { returns(T::Array[String]) }
+      attr_reader :enabled_events
+
+      # Payload type of events being subscribed to.
+      sig { returns(String) }
+      attr_reader :event_payload
+
+      # Where events should be routed from.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :events_from
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      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.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+
+      # Metadata.
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_reader :metadata
+
+      # Event destination name.
+      sig { returns(String) }
+      attr_reader :name
+
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      sig { returns(String) }
+      attr_reader :object
+
+      # If using the snapshot event payload, the API version events are rendered as.
+      sig { returns(T.nilable(String)) }
+      attr_reader :snapshot_api_version
+
+      # Status. It can be set to either enabled or disabled.
+      sig { returns(String) }
+      attr_reader :status
+
+      # Additional information about event destination status.
+      sig { returns(T.nilable(StatusDetails)) }
+      attr_reader :status_details
+
+      # Event destination type.
+      sig { returns(String) }
+      attr_reader :type
+
+      # Time at which the object was last updated.
+      sig { returns(String) }
+      attr_reader :updated
+
+      # Amazon EventBridge configuration.
+      sig { returns(T.nilable(AmazonEventbridge)) }
+      attr_reader :amazon_eventbridge
+
+      # Webhook endpoint configuration.
+      sig { returns(T.nilable(WebhookEndpoint)) }
+      attr_reader :webhook_endpoint
+    end
+  end
+end