stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/resources/v2/core/event.rb

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      # Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate [thin events](https://docs.stripe.com/event-destinations#benefits-of-thin-events) which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. [Retrieve the event object](https://docs.stripe.com/event-destinations#fetch-data) for additional data about the event. Use the related object ID in the event payload to [fetch the API resource](https://docs.stripe.com/event-destinations#retrieve-the-object-associated-with-thin-events) of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload.
+      class Event < APIResource
+        OBJECT_NAME = "v2.core.event"
+        def self.object_name
+          "v2.core.event"
+        end
+
+        class Reason < ::Stripe::StripeObject
+          class Request < ::Stripe::StripeObject
+            # ID of the API request that caused the event.
+            attr_reader :id
+            # The idempotency key transmitted during the request.
+            attr_reader :idempotency_key
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Event reason type.
+          attr_reader :type
+          # Information on the API request that instigated the event.
+          attr_reader :request
+
+          def self.inner_class_types
+            @inner_class_types = { request: Request }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Before and after changes for the primary related object.
+        attr_reader :changes
+        # Authentication context needed to fetch the event or related object.
+        attr_reader :context
+        # Time at which the object was created.
+        attr_reader :created
+        # Unique identifier for the event.
+        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 of the object field.
+        attr_reader :object
+        # Reason for the event.
+        attr_reader :reason
+        # The type of the event.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { reason: Reason }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/core/event_destination.rb

@@ -0,0 +1,119 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      # Set up an event destination to receive events from Stripe across multiple destination types, including [webhook endpoints](https://docs.stripe.com/webhooks) and [Amazon EventBridge](https://docs.stripe.com/event-destinations/eventbridge). Event destinations support receiving [thin events](https://docs.stripe.com/api/v2/events) and [snapshot events](https://docs.stripe.com/api/events).
+      class EventDestination < APIResource
+        OBJECT_NAME = "v2.core.event_destination"
+        def self.object_name
+          "v2.core.event_destination"
+        end
+
+        class StatusDetails < ::Stripe::StripeObject
+          class Disabled < ::Stripe::StripeObject
+            # Reason event destination has been disabled.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Details about why the event destination has been disabled.
+          attr_reader :disabled
+
+          def self.inner_class_types
+            @inner_class_types = { disabled: Disabled }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class AmazonEventbridge < ::Stripe::StripeObject
+          # The AWS account ID.
+          attr_reader :aws_account_id
+          # The ARN of the AWS event source.
+          attr_reader :aws_event_source_arn
+          # The state of the AWS event source.
+          attr_reader :aws_event_source_status
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class WebhookEndpoint < ::Stripe::StripeObject
+          # The signing secret of the webhook endpoint, only includable on creation.
+          attr_reader :signing_secret
+          # The URL of the webhook endpoint, includable.
+          attr_reader :url
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Time at which the object was created.
+        attr_reader :created
+        # An optional description of what the event destination is used for.
+        attr_reader :description
+        # The list of events to enable for this endpoint.
+        attr_reader :enabled_events
+        # Payload type of events being subscribed to.
+        attr_reader :event_payload
+        # Where events should be routed from.
+        attr_reader :events_from
+        # Unique identifier for the object.
+        attr_reader :id
+        # Metadata.
+        attr_reader :metadata
+        # Event destination name.
+        attr_reader :name
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # If using the snapshot event payload, the API version events are rendered as.
+        attr_reader :snapshot_api_version
+        # Status. It can be set to either enabled or disabled.
+        attr_reader :status
+        # Additional information about event destination status.
+        attr_reader :status_details
+        # Event destination type.
+        attr_reader :type
+        # Time at which the object was last updated.
+        attr_reader :updated
+        # 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
+        # Amazon EventBridge configuration.
+        attr_reader :amazon_eventbridge
+        # Webhook endpoint configuration.
+        attr_reader :webhook_endpoint
+
+        def self.inner_class_types
+          @inner_class_types = {
+            status_details: StatusDetails,
+            amazon_eventbridge: AmazonEventbridge,
+            webhook_endpoint: WebhookEndpoint,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/core/event_notification.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventReasonRequest
+        attr_reader :id, :idempotency_key
+
+        def initialize(event_reason_request_payload = {})
+          @id = event_reason_request_payload[:id]
+          @idempotency_key = event_reason_request_payload[:idempotency_key]
+        end
+      end
+
+      class EventReason
+        attr_reader :type, :request
+
+        def initialize(event_reason_payload = {})
+          @type = event_reason_payload[:type]
+          @request = EventReasonRequest.new(event_reason_payload[:request])
+        end
+      end
+
+      class RelatedObject
+        attr_reader :id, :type, :url
+
+        def initialize(related_object)
+          @id = related_object[:id]
+          @type = related_object[:type]
+          @url = related_object[:url]
+        end
+      end
+
+      class EventNotification
+        attr_reader :id, :type, :created, :context, :livemode, :reason
+
+        def initialize(event_payload, client)
+          @id = event_payload[:id]
+          @type = event_payload[:type]
+          @created = event_payload[:created]
+          @livemode = event_payload[:livemode]
+          @reason = EventReason.new(event_payload[:reason]) if event_payload[:reason]
+          if event_payload[:context] && !event_payload[:context].empty?
+            @context = StripeContext.parse(event_payload[:context])
+          end
+          # private unless a child declares an attr_reader
+          @related_object = RelatedObject.new(event_payload[:related_object]) if event_payload[:related_object]
+
+          # internal use
+          @client = client
+        end
+
+        # Retrieves the Event that generated this EventNotification.
+        def fetch_event
+          resp = @client.raw_request(:get, "/v2/core/events/#{id}", opts: { stripe_context: context },
+                                                                    usage: ["fetch_event"])
+          @client.deserialize(resp.http_body, api_mode: :v2)
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb

@@ -0,0 +1,114 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      module Vault
+        # Use the GBBankAccounts API to create and manage GB bank account objects
+        class GbBankAccount < APIResource
+          OBJECT_NAME = "v2.core.vault.gb_bank_account"
+          def self.object_name
+            "v2.core.vault.gb_bank_account"
+          end
+
+          class ConfirmationOfPayee < ::Stripe::StripeObject
+            class Result < ::Stripe::StripeObject
+              class Matched < ::Stripe::StripeObject
+                # The business type given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
+                # Closed enum.
+                attr_reader :business_type
+                # The name given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
+                attr_reader :name
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+
+              class Provided < ::Stripe::StripeObject
+                # The provided or Legal Entity business type to match against the CoP service. Closed enum.
+                attr_reader :business_type
+                # The provided or Legal Entity name to match against the CoP service.
+                attr_reader :name
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # When the CoP result was created.
+              attr_reader :created
+              # Whether or not the information of the bank account matches what you have provided. Closed enum.
+              attr_reader :match_result
+              # The fields that CoP service matched against. Only has value if MATCH or PARTIAL_MATCH, empty otherwise.
+              attr_reader :matched
+              # Human-readable message describing the match result.
+              attr_reader :message
+              # The fields that are matched against what the network has on file.
+              attr_reader :provided
+
+              def self.inner_class_types
+                @inner_class_types = { matched: Matched, provided: Provided }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The result of the Confirmation of Payee check, once the check has been initiated. Closed enum.
+            attr_reader :result
+            # The current state of Confirmation of Payee on this bank account. Closed enum.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = { result: Result }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Whether this bank account object was archived. Bank account objects can be archived through
+          # the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects
+          # cannot be used as outbound destinations and will not appear in the outbound destination list.
+          attr_reader :archived
+          # Closed Enum. The type of the bank account (checking or savings).
+          attr_reader :bank_account_type
+          # The name of the bank.
+          attr_reader :bank_name
+          # Information around the status of Confirmation of Payee matching done on this bank account.
+          # Confirmation of Payee is a name matching service that must be done before making OutboundPayments in the UK.
+          attr_reader :confirmation_of_payee
+          # Creation time.
+          attr_reader :created
+          # The ID of the GBBankAccount object.
+          attr_reader :id
+          # The last 4 digits of the account number or IBAN.
+          attr_reader :last4
+          # String representing the object's type. Objects of the same type share the same value of the object field.
+          attr_reader :object
+          # The Sort Code of the bank account.
+          attr_reader :sort_code
+          # 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
+
+          def self.inner_class_types
+            @inner_class_types = { confirmation_of_payee: ConfirmationOfPayee }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/core/vault/us_bank_account.rb

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      module Vault
+        # Use the USBankAccounts API to create and manage US bank accounts objects that you can use to receive funds. Note that these are not interchangeable with v1 Tokens.
+        class UsBankAccount < APIResource
+          OBJECT_NAME = "v2.core.vault.us_bank_account"
+          def self.object_name
+            "v2.core.vault.us_bank_account"
+          end
+
+          class Verification < ::Stripe::StripeObject
+            class MicrodepositVerificationDetails < ::Stripe::StripeObject
+              # Time when microdeposits will expire and have to be re-sent.
+              attr_reader :expires
+              # Microdeposit type can be amounts or descriptor_type.
+              attr_reader :microdeposit_type
+              # Time when microdeposits were sent.
+              attr_reader :sent
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The microdeposit verification details if the status is awaiting verification.
+            attr_reader :microdeposit_verification_details
+            # The bank account verification status.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = {
+                microdeposit_verification_details: MicrodepositVerificationDetails,
+              }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Whether this USBankAccount object was archived.
+          attr_reader :archived
+          # Closed Enum. The type of bank account (checking or savings).
+          attr_reader :bank_account_type
+          # The name of the bank this bank account belongs to. This field is populated automatically by Stripe based on the routing number.
+          attr_reader :bank_name
+          # Creation time of the object.
+          attr_reader :created
+          # The fedwire routing number of the bank account.
+          attr_reader :fedwire_routing_number
+          # The ID of the Financial Connections Account used to create the bank account.
+          attr_reader :financial_connections_account
+          # The ID of the USBankAccount object.
+          attr_reader :id
+          # The last 4 digits of the account number.
+          attr_reader :last4
+          # String representing the object's type. Objects of the same type share the same value of the object field.
+          attr_reader :object
+          # The ACH routing number of the bank account.
+          attr_reader :routing_number
+          # The bank account verification details.
+          attr_reader :verification
+          # 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
+
+          def self.inner_class_types
+            @inner_class_types = { verification: Verification }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/deleted_object.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class DeletedObject < APIResource
+      # String representing the type of the object that has been deleted. Objects of the same type share the same value of the object field.
+      attr_reader :object
+      # The ID of the object that's being deleted.
+      attr_reader :id
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/financial_address_credit_simulation.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class FinancialAddressCreditSimulation < APIResource
+      OBJECT_NAME = "financial_address_credit_simulation"
+      def self.object_name
+        "financial_address_credit_simulation"
+      end
+
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      attr_reader :object
+      # The status of the request, signifying whether a simulated credit was initiated.
+      attr_reader :status
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class FinancialAddressGeneratedMicrodeposits < APIResource
+      OBJECT_NAME = "financial_address_generated_microdeposits"
+      def self.object_name
+        "financial_address_generated_microdeposits"
+      end
+
+      class Amount < ::Stripe::StripeObject
+        # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+        attr_reader :value
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The amounts of the microdeposits that were generated.
+      attr_reader :amounts
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      attr_reader :object
+      # Closed Enum. The status of the request.
+      attr_reader :status
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = { amounts: Amount }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/money_management/adjustment.rb

@@ -0,0 +1,82 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Adjustments represent Stripe-initiated credits or debits to a user balance. They might be used to amend balances due to technical or operational error.
+      class Adjustment < APIResource
+        OBJECT_NAME = "v2.money_management.adjustment"
+        def self.object_name
+          "v2.money_management.adjustment"
+        end
+
+        class AdjustedFlow < ::Stripe::StripeObject
+          # Closed Enum. If applicable, the type of flow linked to this Adjustment. The field matching this value will contain the ID of the flow.
+          attr_reader :type
+          # If applicable, the ID of the Adjustment linked to this Adjustment.
+          attr_reader :adjustment
+          # If applicable, the ID of the InboundTransfer linked to this Adjustment.
+          attr_reader :inbound_transfer
+          # If applicable, the ID of the OutboundPayment linked to this Adjustment.
+          attr_reader :outbound_payment
+          # If applicable, the ID of the OutboundTransfer linked to this Adjustment.
+          attr_reader :outbound_transfer
+          # If applicable, the ID of the ReceivedCredit linked to this Adjustment.
+          attr_reader :received_credit
+          # If applicable, the ID of the ReceivedDebit linked to this Adjustment.
+          attr_reader :received_debit
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Amount < ::Stripe::StripeObject
+          # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+          attr_reader :value
+          # 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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # If applicable, contains information about the original flow linked to this Adjustment.
+        attr_reader :adjusted_flow
+        # The amount of the Adjustment.
+        attr_reader :amount
+        # Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :created
+        # Description of the Adjustment and what it was used for.
+        attr_reader :description
+        # The FinancialAccount that this adjustment is for.
+        attr_reader :financial_account
+        # Unique identifier for the object.
+        attr_reader :id
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # A link to the Stripe-hosted receipt that is provided when money movement is considered regulated under Stripe’s money transmission licenses. The receipt link remains active for 60 days from the Adjustment creation date. After this period, the link will expire and the receipt url value will be null.
+        attr_reader :receipt_url
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = { adjusted_flow: AdjustedFlow, amount: Amount }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end