stripe 10.1.0 → 12.6.0

data/lib/stripe/resources/entitlements/active_entitlement.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    # An active entitlement describes access to a feature for a customer.
+    class ActiveEntitlement < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "entitlements.active_entitlement"
+      def self.object_name
+        "entitlements.active_entitlement"
+      end
+
+      # Retrieve a list of active entitlements for a customer
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/entitlements/active_entitlements",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/entitlements/feature.rb

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    # A feature represents a monetizable ability or functionality in your system.
+    # Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
+    class Feature < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "entitlements.feature"
+      def self.object_name
+        "entitlements.feature"
+      end
+
+      # Creates a feature
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/entitlements/features",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieve a list of features
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/entitlements/features",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Update a feature's metadata or permanently deactivate it.
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/entitlements/features/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/ephemeral_key.rb

@@ -7,6 +7,29 @@ module Stripe
     include Stripe::APIOperations::Delete
 
     OBJECT_NAME = "ephemeral_key"
+    def self.object_name
+      "ephemeral_key"
+    end
+
+    # Invalidates a short-lived API key for a given resource.
+    def self.delete(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/ephemeral_keys/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Invalidates a short-lived API key for a given resource.
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/ephemeral_keys/%<key>s", { key: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
 
     def self.create(params = {}, opts = {})
       opts = Util.normalize_opts(opts)

data/lib/stripe/resources/event.rb

@@ -23,10 +23,10 @@ module Stripe
   # `Event` objects directly to an endpoint on your server. You can manage
   # webhooks in your
   # [account settings](https://dashboard.stripe.com/account/webhooks). Learn how
-  # to [listen for events]
-  # (/docs/webhooks) so that your integration can automatically trigger reactions.
+  # to [listen for events](https://docs.stripe.com/webhooks)
+  # so that your integration can automatically trigger reactions.
   #
-  # When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications
+  # When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications
   # that occur in connected accounts. For these events, there's an
   # additional `account` attribute in the received `Event` object.
   #
@@ -36,5 +36,13 @@ module Stripe
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "event"
+    def self.object_name
+      "event"
+    end
+
+    # 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 self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/events", params: filters, opts: opts)
+    end
   end
 end

data/lib/stripe/resources/exchange_rate.rb

@@ -32,5 +32,13 @@ module Stripe
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "exchange_rate"
+    def self.object_name
+      "exchange_rate"
+    end
+
+    # 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 self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/exchange_rates", params: filters, opts: opts)
+    end
   end
 end

data/lib/stripe/resources/file.rb

@@ -5,7 +5,7 @@ module Stripe
   # This object represents files hosted on Stripe's servers. You can upload
   # files with the [create file](https://stripe.com/docs/api#create_file) request
   # (for example, when uploading dispute evidence). Stripe also
-  # creates files independetly (for example, the results of a [Sigma scheduled
+  # creates files independently (for example, the results of a [Sigma scheduled
   # query](https://stripe.com/docs/api#scheduled_queries)).
   #
   # Related guide: [File upload guide](https://stripe.com/docs/file-upload)
@@ -14,30 +14,43 @@ module Stripe
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "file"
+    def self.object_name
+      "file"
+    end
+
+    # 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 self.create(params = {}, opts = {})
+      config = opts[:client]&.config || Stripe.config
+      upload_base = config.uploads_base
+      opts = { api_base: upload_base }.merge(Util.normalize_opts(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_stripe_object(method: :post, path: "/v1/files", params: params, opts: opts)
+    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 self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/files", params: filters, opts: opts)
+    end
 
     # This resource can have two different object names. In latter API
     # versions, only `file` is used, but since stripe-ruby may be used with
     # any API version, we need to support deserializing the older
     # `file_upload` object into the same class.
     OBJECT_NAME_ALT = "file_upload"
+    def self.object_name_alt
+      "file_upload"
+    end
 
     def self.resource_url
       "/v1/files"
     end
-
-    def self.create(params = {}, opts = {})
-      if params[:file] && !params[:file].is_a?(String)
-        unless params[:file].respond_to?(:read)
-          raise ArgumentError, "file must respond to `#read`"
-        end
-      end
-
-      config = opts[:client]&.config || Stripe.config
-      opts = {
-        api_base: config.uploads_base,
-        content_type: MultipartEncoder::MULTIPART_FORM_DATA,
-      }.merge(Util.normalize_opts(opts))
-      super
-    end
   end
 end

data/lib/stripe/resources/file_link.rb

@@ -11,5 +11,28 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "file_link"
+    def self.object_name
+      "file_link"
+    end
+
+    # Creates a new file link object.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/file_links", params: params, opts: opts)
+    end
+
+    # Returns a list of file links.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/file_links", params: filters, opts: opts)
+    end
+
+    # Updates an existing file link object. Expired links can no longer be updated.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/file_links/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/financial_connections/account.rb

@@ -8,7 +8,11 @@ module Stripe
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "financial_connections.account"
+      def self.object_name
+        "financial_connections.account"
+      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(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -18,6 +22,27 @@ module Stripe
         )
       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 self.disconnect(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of Financial Connections Account objects.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/financial_connections/accounts",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Lists all owners for a given Account
       def list_owners(params = {}, opts = {})
         request_stripe_object(
           method: :get,
@@ -27,6 +52,17 @@ module Stripe
         )
       end
 
+      # Lists all owners for a given Account
+      def self.list_owners(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Refreshes the data associated with a Financial Connections Account.
       def refresh_account(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -36,28 +72,51 @@ module Stripe
         )
       end
 
-      def self.disconnect(account, params = {}, opts = {})
+      # Refreshes the data associated with a Financial Connections Account.
+      def self.refresh_account(account, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(account) }),
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(account) }),
           params: params,
           opts: opts
         )
       end
 
-      def self.list_owners(account, params = {}, opts = {})
+      # Subscribes to periodic refreshes of data associated with a Financial Connections Account.
+      def subscribe(params = {}, opts = {})
         request_stripe_object(
-          method: :get,
-          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(account) }),
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      def self.refresh_account(account, params = {}, opts = {})
+      # Subscribes to periodic refreshes of data associated with a Financial Connections Account.
+      def self.subscribe(account, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(account) }),
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
+      def unsubscribe(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
+      def self.unsubscribe(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(account) }),
           params: params,
           opts: opts
         )

data/lib/stripe/resources/financial_connections/account_owner.rb

@@ -6,6 +6,9 @@ module Stripe
     # Describes an owner of an account.
     class AccountOwner < StripeObject
       OBJECT_NAME = "financial_connections.account_owner"
+      def self.object_name
+        "financial_connections.account_owner"
+      end
     end
   end
 end

data/lib/stripe/resources/financial_connections/account_ownership.rb

@@ -6,6 +6,9 @@ module Stripe
     # Describes a snapshot of the owners of an account at a particular point in time.
     class AccountOwnership < StripeObject
       OBJECT_NAME = "financial_connections.account_ownership"
+      def self.object_name
+        "financial_connections.account_ownership"
+      end
     end
   end
 end

data/lib/stripe/resources/financial_connections/session.rb

@@ -8,6 +8,19 @@ module Stripe
       extend Stripe::APIOperations::Create
 
       OBJECT_NAME = "financial_connections.session"
+      def self.object_name
+        "financial_connections.session"
+      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 self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/financial_connections/sessions",
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/financial_connections/transaction.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # A Transaction represents a real transaction that affects a Financial Connections Account balance.
+    class Transaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "financial_connections.transaction"
+      def self.object_name
+        "financial_connections.transaction"
+      end
+
+      # Returns a list of Financial Connections Transaction objects.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/financial_connections/transactions",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/forwarding/request.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Forwarding
+    # Instructs Stripe to make a request on your behalf using the destination URL. The destination URL
+    # is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials
+    # provided during onboarding, and injects card details from the payment_method into the request.
+    #
+    # Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers,
+    # before storing the request and response data in the forwarding Request object, which are subject to a
+    # 30-day retention period.
+    #
+    # You can provide a Stripe idempotency key to make sure that requests with the same key result in only one
+    # outbound request. The Stripe idempotency key provided should be unique and different from any idempotency
+    # keys provided on the underlying third-party request.
+    #
+    # Forwarding Requests are synchronous requests that return a response or time out according to
+    # Stripe's limits.
+    #
+    # Related guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).
+    class Request < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "forwarding.request"
+      def self.object_name
+        "forwarding.request"
+      end
+
+      # Creates a ForwardingRequest object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/forwarding/requests",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Lists all ForwardingRequest objects.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/forwarding/requests",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/funding_instructions.rb

@@ -9,6 +9,9 @@ module Stripe
   # Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)
   class FundingInstructions < APIResource
     OBJECT_NAME = "funding_instructions"
+    def self.object_name
+      "funding_instructions"
+    end
 
     def resource_url
       if !respond_to?(:customer) || customer.nil?

data/lib/stripe/resources/identity/verification_report.rb

@@ -13,11 +13,24 @@ module Stripe
     # API. To configure and create VerificationReports, use the
     # [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.
     #
-    # Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).
+    # Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).
     class VerificationReport < APIResource
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "identity.verification_report"
+      def self.object_name
+        "identity.verification_report"
+      end
+
+      # List all verification reports.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/identity/verification_reports",
+          params: filters,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/identity/verification_session.rb

@@ -20,7 +20,13 @@ module Stripe
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "identity.verification_session"
+      def self.object_name
+        "identity.verification_session"
+      end
 
+      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+      #
+      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -30,24 +36,91 @@ module Stripe
         )
       end
 
-      def redact(params = {}, opts = {})
+      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+      #
+      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
+      def self.cancel(session, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/identity/verification_sessions/%<session>s/redact", { session: CGI.escape(self["id"]) }),
+          path: format("/v1/identity/verification_sessions/%<session>s/cancel", { session: CGI.escape(session) }),
           params: params,
           opts: opts
         )
       end
 
-      def self.cancel(session, params = {}, opts = {})
+      # 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://stripe.com/docs/identity/verify-identity-documents)
+      def self.create(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/identity/verification_sessions/%<session>s/cancel", { session: CGI.escape(session) }),
+          path: "/v1/identity/verification_sessions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of VerificationSessions
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/identity/verification_sessions",
+          params: filters,
+          opts: opts
+        )
+      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://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://stripe.com/docs/identity/verification-sessions#redact).
+      def redact(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s/redact", { session: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       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://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://stripe.com/docs/identity/verification-sessions#redact).
       def self.redact(session, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -56,6 +129,19 @@ module Stripe
           opts: opts
         )
       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 self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end