stripe 19.2.0 → 19.3.0.pre.alpha.1

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

@@ -0,0 +1,136 @@
+# 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 AlternativeReference < ::Stripe::StripeObject
+            # The ID of the alternative resource being referenced.
+            attr_reader :id
+            # The type of the alternative reference (e.g., external_account for V1 external accounts).
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          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
+          # The alternative reference for this payout method, if it's a projected payout method.
+          attr_reader :alternative_reference
+          # 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
+          # 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
+          # The Sort Code of the bank account.
+          attr_reader :sort_code
+          # The list of currencies supported by this bank account.
+          attr_reader :supported_currencies
+
+          def self.inner_class_types
+            @inner_class_types = {
+              alternative_reference: AlternativeReference,
+              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,105 @@
+# 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 AlternativeReference < ::Stripe::StripeObject
+            # The ID of the alternative resource being referenced.
+            attr_reader :id
+            # The type of the alternative reference (e.g., external_account for V1 external accounts).
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          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
+          # The alternative reference for this payout method, if it's a projected payout method.
+          attr_reader :alternative_reference
+          # 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
+          # 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
+          # The ACH routing number of the bank account.
+          attr_reader :routing_number
+          # The list of currencies supported by this bank account.
+          attr_reader :supported_currencies
+          # The bank account verification details.
+          attr_reader :verification
+
+          def self.inner_class_types
+            @inner_class_types = {
+              alternative_reference: AlternativeReference,
+              verification: Verification,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/data/analytics/metric_query_result.rb

@@ -0,0 +1,106 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Data
+      module Analytics
+        # The result of a metric query.
+        class MetricQueryResult < APIResource
+          OBJECT_NAME = "v2.data.analytics.metric_query_result"
+          def self.object_name
+            "v2.data.analytics.metric_query_result"
+          end
+
+          class Data < ::Stripe::StripeObject
+            class Result < ::Stripe::StripeObject
+              # If this is a monetary metric, the currency it is returned in. Otherwise null.
+              attr_reader :currency
+              # The ID of this metric.
+              attr_reader :metric
+              # The common name of this metric.
+              attr_reader :name
+              # The numeric value of this metric.
+              attr_reader :value
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+
+              def self.field_encodings
+                @field_encodings = { value: :int64_string }
+              end
+            end
+            # A hash of dimension type to dimension instance, if group_by was specified.
+            attr_reader :dimensions
+            # A unique identifier for this row.
+            attr_reader :id
+            # Array of metric values returned from this query.
+            attr_reader :results
+            # Timestamp denoting the start of this time bucket.
+            attr_reader :timestamp
+
+            def self.inner_class_types
+              @inner_class_types = { results: Result }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = {
+                results: { kind: :array, element: { kind: :object, fields: { value: :int64_string } } },
+              }
+            end
+          end
+          # The timestamp at which this metric query result was created.
+          attr_reader :created
+          # An array of timeseries data rows.
+          attr_reader :data
+          # The unique identifier of this metric query result.
+          attr_reader :id
+          # Whether this query was run in live mode.
+          attr_reader :livemode
+          # Pagination future-proofing: URL to fetch the next page; always null for now.
+          attr_reader :next_page_url
+          # String representing the object's type. Objects of the same type share the same value of the object field.
+          attr_reader :object
+          # Pagination future-proofing: URL to fetch the previous page; always null for now.
+          attr_reader :previous_page_url
+          # A timestamp representing the freshness of the data this metric is aggregated from.
+          attr_reader :refreshed_at
+
+          def self.inner_class_types
+            @inner_class_types = { data: Data }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = {
+              data: {
+                kind: :array,
+                element: {
+                  kind: :object,
+                  fields: {
+                    results: {
+                      kind: :array,
+                      element: { kind: :object, fields: { value: :int64_string } },
+                    },
+                  },
+                },
+              },
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/data/reporting/query_run.rb

@@ -0,0 +1,142 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Data
+      module Reporting
+        # The `QueryRun` object represents an ad-hoc SQL execution. Once created, Stripe processes the query. When
+        # the query has finished running, the object provides a reference to the results.
+        class QueryRun < APIResource
+          OBJECT_NAME = "v2.data.reporting.query_run"
+          def self.object_name
+            "v2.data.reporting.query_run"
+          end
+
+          class Result < ::Stripe::StripeObject
+            class File < ::Stripe::StripeObject
+              class DownloadUrl < ::Stripe::StripeObject
+                # The time that the URL expires.
+                attr_reader :expires_at
+                # The URL that can be used for accessing the file.
+                attr_reader :url
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # The content type of the file.
+              attr_reader :content_type
+              # A pre-signed URL that allows secure, time-limited access to download the file.
+              attr_reader :download_url
+              # The total size of the file in bytes.
+              attr_reader :size
+
+              def self.inner_class_types
+                @inner_class_types = { download_url: DownloadUrl }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+
+              def self.field_encodings
+                @field_encodings = { size: :int64_string }
+              end
+            end
+            # Contains metadata about the file produced by the `ReportRun` or `QueryRun`, including
+            # its content type, size, and a URL to download its contents.
+            attr_reader :file
+            # The type of the `ReportRun` or `QueryRun` result.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = { file: File }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = { file: { kind: :object, fields: { size: :int64_string } } }
+            end
+          end
+
+          class ResultOptions < ::Stripe::StripeObject
+            # If set, the generated results file will be compressed into a ZIP folder.
+            # This is useful for reducing file size and download time for large results.
+            attr_reader :compress_file
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class StatusDetails < ::Stripe::StripeObject
+            # Error code categorizing the reason the `QueryRun` failed.
+            attr_reader :error_code
+            # Error message with additional details about the failure.
+            attr_reader :error_message
+
+            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
+          # The unique identifier of the `QueryRun` 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 of the object field.
+          attr_reader :object
+          # Details how to retrieve the results of a successfully completed `QueryRun`.
+          attr_reader :result
+          # The options specified for customizing the output of the `QueryRun`.
+          attr_reader :result_options
+          # The SQL that was executed.
+          attr_reader :sql
+          # The current status of the `QueryRun`.
+          attr_reader :status
+          # Additional details about the current state of the `QueryRun`. Populated when the `QueryRun`
+          # is in the `failed` state, providing more information about why the query failed.
+          attr_reader :status_details
+
+          def self.inner_class_types
+            @inner_class_types = {
+              result: Result,
+              result_options: ResultOptions,
+              status_details: StatusDetails,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = {
+              result: {
+                kind: :object,
+                fields: { file: { kind: :object, fields: { size: :int64_string } } },
+              },
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/extend/workflow.rb

@@ -0,0 +1,80 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Extend
+      # A Stripe Workflow is a sequence of actions, like Stripe API calls, that are taken in response to an initiating trigger.
+      # A trigger can be a Stripe API event, or a manual invocation.
+      class Workflow < APIResource
+        OBJECT_NAME = "v2.extend.workflow"
+        def self.object_name
+          "v2.extend.workflow"
+        end
+
+        class Trigger < ::Stripe::StripeObject
+          class EventTrigger < ::Stripe::StripeObject
+            # Specifies which accounts' events will trigger this Workflow.
+            attr_reader :events_from
+            # The Stripe event type that will trigger this Workflow.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Manual < ::Stripe::StripeObject
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The Workflow can be launched when Stripe emits a certain event.
+          attr_reader :event_trigger
+          # The Workflow can be launched through a direct call, using either the Dashboard or the Stripe API.
+          attr_reader :manual
+          # Which type of trigger this is.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { event_trigger: EventTrigger, manual: Manual }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # When the Workflow was created.
+        attr_reader :created
+        # The unique ID of the Workflow.
+        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
+        # Whether this Workflow is active, inactive, or in some other state. Only active Workflows may be invoked.
+        attr_reader :status
+        # Workflow title.
+        attr_reader :title
+        # Under what conditions will this Workflow launch.
+        attr_reader :triggers
+
+        def self.inner_class_types
+          @inner_class_types = { triggers: Trigger }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end