stripe 12.5.0 → 15.0.0

data/lib/stripe/services/financial_connections/account_owner_service.rb

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountOwnerService < StripeService
+      class ListParams < Stripe::RequestParams
+        # 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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # The ID of the ownership object to fetch owners from.
+        attr_accessor :ownership
+        # 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.
+        attr_accessor :starting_after
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          ownership: nil,
+          starting_after: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @ownership = ownership
+          @starting_after = starting_after
+        end
+      end
+
+      # Lists all owners for a given Account
+      def list(account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections/account_service.rb

@@ -0,0 +1,177 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountService < StripeService
+      attr_reader :owners
+
+      def initialize(requestor)
+        super(requestor)
+        @owners = Stripe::FinancialConnections::AccountOwnerService.new(@requestor)
+      end
+
+      class ListParams < Stripe::RequestParams
+        class AccountHolder < Stripe::RequestParams
+          # The ID of the Stripe account whose accounts will be retrieved.
+          attr_accessor :account
+          # The ID of the Stripe customer whose accounts will be retrieved.
+          attr_accessor :customer
+
+          def initialize(account: nil, customer: nil)
+            @account = account
+            @customer = customer
+          end
+        end
+        # If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
+        attr_accessor :account_holder
+        # 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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # If present, only return accounts that were collected as part of the given session.
+        attr_accessor :session
+        # 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.
+        attr_accessor :starting_after
+
+        def initialize(
+          account_holder: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          session: nil,
+          starting_after: nil
+        )
+          @account_holder = account_holder
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @session = session
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class DisconnectParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class RefreshParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The list of account features that you would like to refresh.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        end
+      end
+
+      class SubscribeParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The list of account features to which you would like to subscribe.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        end
+      end
+
+      class UnsubscribeParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The list of account features from which you would like to unsubscribe.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        end
+      end
+
+      # Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
+      def disconnect(account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of Financial Connections Account objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/financial_connections/accounts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Refreshes the data associated with a Financial Connections Account.
+      def refresh(account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an Financial Connections Account.
+      def retrieve(account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Subscribes to periodic refreshes of data associated with a Financial Connections Account.
+      def subscribe(account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
+      def unsubscribe(account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections/session_service.rb

@@ -0,0 +1,98 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class SessionService < StripeService
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class AccountHolder < Stripe::RequestParams
+          # The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`.
+          attr_accessor :account
+          # The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.
+          attr_accessor :customer
+          # Type of account holder to collect accounts for.
+          attr_accessor :type
+
+          def initialize(account: nil, customer: nil, type: nil)
+            @account = account
+            @customer = customer
+            @type = type
+          end
+        end
+
+        class Filters < Stripe::RequestParams
+          # Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
+          attr_accessor :account_subcategories
+          # List of countries from which to collect accounts.
+          attr_accessor :countries
+
+          def initialize(account_subcategories: nil, countries: nil)
+            @account_subcategories = account_subcategories
+            @countries = countries
+          end
+        end
+        # The account holder to link accounts for.
+        attr_accessor :account_holder
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Filters to restrict the kinds of accounts to collect.
+        attr_accessor :filters
+        # List of data features that you would like to request access to.
+        #
+        # Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
+        attr_accessor :permissions
+        # List of data features that you would like to retrieve upon account creation.
+        attr_accessor :prefetch
+        # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
+        attr_accessor :return_url
+
+        def initialize(
+          account_holder: nil,
+          expand: nil,
+          filters: nil,
+          permissions: nil,
+          prefetch: nil,
+          return_url: nil
+        )
+          @account_holder = account_holder
+          @expand = expand
+          @filters = filters
+          @permissions = permissions
+          @prefetch = prefetch
+          @return_url = return_url
+        end
+      end
+
+      # To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/financial_connections/sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Financial Connections Session
+      def retrieve(session, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/sessions/%<session>s", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections/transaction_service.rb

@@ -0,0 +1,100 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class TransactionService < StripeService
+      class ListParams < Stripe::RequestParams
+        class TransactedAt < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+
+        class TransactionRefresh < Stripe::RequestParams
+          # Return results where the transactions were created or updated by a refresh that took place after this refresh (non-inclusive).
+          attr_accessor :after
+
+          def initialize(after: nil)
+            @after = after
+          end
+        end
+        # The ID of the Financial Connections Account whose transactions will be retrieved.
+        attr_accessor :account
+        # 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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # 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.
+        attr_accessor :starting_after
+        # A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
+        attr_accessor :transacted_at
+        # A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:
+        attr_accessor :transaction_refresh
+
+        def initialize(
+          account: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          transacted_at: nil,
+          transaction_refresh: nil
+        )
+          @account = account
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @transacted_at = transacted_at
+          @transaction_refresh = transaction_refresh
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Returns a list of Financial Connections Transaction objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/financial_connections/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Financial Connections Transaction
+      def retrieve(transaction, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/transactions/%<transaction>s", { transaction: CGI.escape(transaction) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FinancialConnectionsService < StripeService
+    attr_reader :accounts, :sessions, :transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @accounts = Stripe::FinancialConnections::AccountService.new(@requestor)
+      @sessions = Stripe::FinancialConnections::SessionService.new(@requestor)
+      @transactions = Stripe::FinancialConnections::TransactionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/forwarding/request_service.rb

@@ -0,0 +1,147 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Forwarding
+    class RequestService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Return results where the `created` field is greater than this value.
+          attr_accessor :gt
+          # Return results where the `created` field is greater than or equal to this value.
+          attr_accessor :gte
+          # Return results where the `created` field is less than this value.
+          attr_accessor :lt
+          # Return results where the `created` field is less than or equal to this value.
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+        # Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
+        attr_accessor :created
+        # A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
+        attr_accessor :starting_after
+
+        def initialize(
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        )
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class Request < Stripe::RequestParams
+          class Header < Stripe::RequestParams
+            # The header name.
+            attr_accessor :name
+            # The header value.
+            attr_accessor :value
+
+            def initialize(name: nil, value: nil)
+              @name = name
+              @value = value
+            end
+          end
+          # The body payload to send to the destination endpoint.
+          attr_accessor :body
+          # The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
+          attr_accessor :headers
+
+          def initialize(body: nil, headers: nil)
+            @body = body
+            @headers = headers
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+        attr_accessor :metadata
+        # The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
+        attr_accessor :payment_method
+        # The field kinds to be replaced in the forwarded request.
+        attr_accessor :replacements
+        # The request body and headers to be sent to the destination endpoint.
+        attr_accessor :request
+        # The destination URL for the forwarded request. Must be supported by the config.
+        attr_accessor :url
+
+        def initialize(
+          expand: nil,
+          metadata: nil,
+          payment_method: nil,
+          replacements: nil,
+          request: nil,
+          url: nil
+        )
+          @expand = expand
+          @metadata = metadata
+          @payment_method = payment_method
+          @replacements = replacements
+          @request = request
+          @url = url
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Creates a ForwardingRequest object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/forwarding/requests",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Lists all ForwardingRequest objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/forwarding/requests",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a ForwardingRequest object.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/forwarding/requests/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/forwarding_service.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ForwardingService < StripeService
+    attr_reader :requests
+
+    def initialize(requestor)
+      super(requestor)
+      @requests = Stripe::Forwarding::RequestService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/identity/verification_report_service.rb

@@ -0,0 +1,95 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationReportService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+        # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
+        attr_accessor :client_reference_id
+        # Only return VerificationReports that were created during the given date interval.
+        attr_accessor :created
+        # 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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # 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.
+        attr_accessor :starting_after
+        # Only return VerificationReports of this type
+        attr_accessor :type
+        # Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
+        attr_accessor :verification_session
+
+        def initialize(
+          client_reference_id: nil,
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          type: nil,
+          verification_session: nil
+        )
+          @client_reference_id = client_reference_id
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @type = type
+          @verification_session = verification_session
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # List all verification reports.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/identity/verification_reports",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves an existing VerificationReport
+      def retrieve(report, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/identity/verification_reports/%<report>s", { report: CGI.escape(report) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end