stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/services/event_service.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class EventService < StripeService
+    # List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/events", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/events/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/exchange_rate_service.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ExchangeRateService < StripeService
+    # [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.
+    #
+    # Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/exchange_rates",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.
+    #
+    # Retrieves the exchange rates from the given currency to every supported currency.
+    def retrieve(rate_id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/exchange_rates/%<rate_id>s", { rate_id: CGI.escape(rate_id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/external_account_service.rb

@@ -0,0 +1,68 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ExternalAccountService < StripeService
+    # Create an external account for a given connected account.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/external_accounts",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Delete a specified external account for a given account.
+    def delete(id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/external_accounts/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # List external accounts for an account.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/external_accounts",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieve a specified external account for a given account.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/external_accounts/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the metadata, account holder name, account holder type of a bank account belonging to
+    # a connected account and optionally sets it as the default for its currency. Other bank account
+    # details are not editable by design.
+    #
+    # You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
+    #
+    # You can re-enable a disabled bank account by performing an update call without providing any
+    # arguments or changes.
+    def update(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/external_accounts/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/file_link_service.rb

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FileLinkService < StripeService
+    # Creates a new file link object.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/file_links", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of file links.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/file_links", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the file link with the given ID.
+    def retrieve(link, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/file_links/%<link>s", { link: CGI.escape(link) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing file link object. Expired links can no longer be updated.
+    def update(link, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/file_links/%<link>s", { link: CGI.escape(link) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/file_service.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FileService < StripeService
+    # To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
+    #
+    # All of Stripe's officially supported Client libraries support sending multipart/form-data.
+    def create(params = {}, opts = {})
+      if params[:file] && !params[:file].is_a?(String) && !params[:file].respond_to?(:read)
+        raise ArgumentError, "file must respond to `#read`"
+      end
+
+      opts = { content_type: MultipartEncoder::MULTIPART_FORM_DATA }.merge(Util.normalize_opts(opts))
+
+      request(method: :post, path: "/v1/files", params: params, opts: opts, base_address: :files)
+    end
+
+    # Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/files", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://docs.stripe.com/docs/file-upload#download-file-contents).
+    def retrieve(file, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/files/%<file>s", { file: CGI.escape(file) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountInferredBalanceService < StripeService
+      # Lists the recorded inferred balances for a Financial Connections Account.
+      def list(account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/inferred_balances", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountOwnerService < StripeService
+      # 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,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountService < StripeService
+      attr_reader :inferred_balances, :owners
+
+      def initialize(requestor)
+        super
+        @inferred_balances = Stripe::FinancialConnections::AccountInferredBalanceService
+                             .new(@requestor)
+        @owners = Stripe::FinancialConnections::AccountOwnerService.new(@requestor)
+      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. When the account status is active, data is typically refreshed once a day.
+      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/institution_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class InstitutionService < StripeService
+      # Returns a list of Financial Connections Institution objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/financial_connections/institutions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Financial Connections Institution.
+      def retrieve(institution, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/institutions/%<institution>s", { institution: CGI.escape(institution) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class SessionService < StripeService
+      # 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,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class TransactionService < StripeService
+      # 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,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FinancialConnectionsService < StripeService
+    attr_reader :accounts, :institutions, :sessions, :transactions
+
+    def initialize(requestor)
+      super
+      @accounts = Stripe::FinancialConnections::AccountService.new(@requestor)
+      @institutions = Stripe::FinancialConnections::InstitutionService.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,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Forwarding
+    class RequestService < StripeService
+      # 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
+      @requests = Stripe::Forwarding::RequestService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/fx_quote_service.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FxQuoteService < StripeService
+    # Creates an FX Quote object
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/fx_quotes", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/fx_quotes", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieve an FX Quote object
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/fx_quotes/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationReportService < StripeService
+      # 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

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

@@ -0,0 +1,106 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSessionService < StripeService
+      # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
+      #
+      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
+      def cancel(session, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s/cancel", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a VerificationSession object.
+      #
+      # After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session's url.
+      #
+      # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
+      #
+      # Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/identity/verification_sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of VerificationSessions
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/identity/verification_sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Redact a VerificationSession to remove all collected information from Stripe. This will redact
+      # the VerificationSession and all objects related to it, including VerificationReports, Events,
+      # request logs, etc.
+      #
+      # A VerificationSession object can be redacted when it is in requires_input or verified
+      # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
+      # state will automatically cancel it.
+      #
+      # The redaction process may take up to four days. When the redaction process is in progress, the
+      # VerificationSession's redaction.status field will be set to processing; when the process is
+      # finished, it will change to redacted and an identity.verification_session.redacted event
+      # will be emitted.
+      #
+      # Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
+      # fields that contain personal data will be replaced by the string [redacted] or a similar
+      # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
+      # used for any purpose.
+      #
+      # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
+      def redact(session, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s/redact", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a VerificationSession that was previously created.
+      #
+      # When the session status is requires_input, you can use this method to retrieve a valid
+      # client_secret or url to allow re-submission.
+      def retrieve(session, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/identity/verification_sessions/%<session>s", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a VerificationSession object.
+      #
+      # When the session status is requires_input, you can use this method to update the
+      # verification check and options.
+      def update(session, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/identity_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class IdentityService < StripeService
+    attr_reader :verification_reports, :verification_sessions
+
+    def initialize(requestor)
+      super
+      @verification_reports = Stripe::Identity::VerificationReportService.new(@requestor)
+      @verification_sessions = Stripe::Identity::VerificationSessionService.new(@requestor)
+    end
+  end
+end