RubyGems - stripe - Versions diffs - 18.1.0.pre.beta.1 → 18.1.0 - Mend

stripe 18.1.0.pre.beta.1 → 18.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (660) hide show

data/lib/stripe/resources/file.rb CHANGED Viewed

@@ -3,12 +3,12 @@
 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
+  # files with the [create file](https://api.stripe.com#create_file) request
   # (for example, when uploading dispute evidence). Stripe also
   # creates files independently (for example, the results of a [Sigma scheduled
   # query](https://docs.stripe.com/api#scheduled_queries)).
   #
-  # Related guide: [File upload guide](https://stripe.com/docs/file-upload)
+  # Related guide: [File upload guide](https://docs.stripe.com/file-upload)
   class File < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -26,11 +26,11 @@ module Stripe
     attr_reader :filename
     # Unique identifier for the object.
     attr_reader :id
-    # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
+    # A list of [file links](https://api.stripe.com#file_links) that point at this file.
     attr_reader :links
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object
-    # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
+    # The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file.
     attr_reader :purpose
     # The size of the file object in bytes.
     attr_reader :size

data/lib/stripe/resources/file_link.rb CHANGED Viewed

@@ -27,7 +27,7 @@ module Stripe
     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
-    # 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.
+    # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
     attr_reader :metadata
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object

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

@@ -6,19 +6,16 @@ module Stripe
     # A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
     class Account < APIResource
       extend Stripe::APIOperations::List
-      extend Stripe::APIOperations::NestedResource
       OBJECT_NAME = "financial_connections.account"
       def self.object_name
         "financial_connections.account"
       end
-      nested_resource_class_methods :inferred_balance, operations: %i[list]
       class AccountHolder < ::Stripe::StripeObject
-        # The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
+        # The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.
         attr_reader :account
-        # ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
+        # The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`.
         attr_reader :customer
         # Attribute for field customer_account
         attr_reader :customer_account
@@ -128,23 +125,6 @@ module Stripe
         end
       end
-      class InferredBalancesRefresh < ::Stripe::StripeObject
-        # The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
-        attr_reader :last_attempted_at
-        # Time at which the next inferred balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
-        attr_reader :next_refresh_available_at
-        # The status of the last refresh attempt.
-        attr_reader :status
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
       class OwnershipRefresh < ::Stripe::StripeObject
         # The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
         attr_reader :last_attempted_at
@@ -196,10 +176,6 @@ module Stripe
       attr_reader :display_name
       # Unique identifier for the object.
       attr_reader :id
-      # The state of the most recent attempt to refresh the account's inferred balance history.
-      attr_reader :inferred_balances_refresh
-      # The ID of the Financial Connections Institution this account belongs to. Note that this relationship may sometimes change in rare circumstances (e.g. institution mergers).
-      attr_reader :institution
       # The name of the institution that holds this account.
       attr_reader :institution_name
       # The last 4 digits of the account number. If present, this will be 4 numeric characters.
@@ -233,7 +209,7 @@ module Stripe
       attr_reader :subcategory
       # The list of data refresh subscriptions requested on this account.
       attr_reader :subscriptions
-      # The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
+      # The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
       attr_reader :supported_payment_method_types
       # The state of the most recent attempt to refresh the account transactions.
       attr_reader :transaction_refresh
@@ -354,7 +330,6 @@ module Stripe
           account_numbers: AccountNumber,
           balance: Balance,
           balance_refresh: BalanceRefresh,
-          inferred_balances_refresh: InferredBalancesRefresh,
           ownership_refresh: OwnershipRefresh,
           transaction_refresh: TransactionRefresh,
         }

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

@@ -13,9 +13,9 @@ module Stripe
       end
       class AccountHolder < ::Stripe::StripeObject
-        # The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
+        # The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.
         attr_reader :account
-        # ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
+        # The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`.
         attr_reader :customer
         # Attribute for field customer_account
         attr_reader :customer_account
@@ -36,8 +36,6 @@ module Stripe
         attr_reader :account_subcategories
         # List of countries from which to filter accounts.
         attr_reader :countries
-        # Stripe ID of the institution with which the customer should be directed to log in.
-        attr_reader :institution
         def self.inner_class_types
           @inner_class_types = {}
@@ -47,54 +45,6 @@ module Stripe
           @field_remappings = {}
         end
       end
-      class Limits < ::Stripe::StripeObject
-        # The number of accounts that can be linked in this Session.
-        attr_reader :accounts
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      class ManualEntry < ::Stripe::StripeObject
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      class StatusDetails < ::Stripe::StripeObject
-        class Cancelled < ::Stripe::StripeObject
-          # The reason for the Session being cancelled.
-          attr_reader :reason
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # Attribute for field cancelled
-        attr_reader :cancelled
-        def self.inner_class_types
-          @inner_class_types = { cancelled: Cancelled }
-        end
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
       # The account holder for whom accounts are collected in this session.
       attr_reader :account_holder
       # The accounts that were collected as part of this Session.
@@ -105,12 +55,8 @@ module Stripe
       attr_reader :filters
       # Unique identifier for the object.
       attr_reader :id
-      # Attribute for field limits
-      attr_reader :limits
       # 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
-      # Attribute for field manual_entry
-      attr_reader :manual_entry
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Permissions requested for accounts collected during this session.
@@ -119,10 +65,6 @@ module Stripe
       attr_reader :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_reader :return_url
-      # The current state of the session.
-      attr_reader :status
-      # Attribute for field status_details
-      attr_reader :status_details
       # 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 = {})
@@ -135,13 +77,7 @@ module Stripe
       end
       def self.inner_class_types
-        @inner_class_types = {
-          account_holder: AccountHolder,
-          filters: Filters,
-          limits: Limits,
-          manual_entry: ManualEntry,
-          status_details: StatusDetails,
-        }
+        @inner_class_types = { account_holder: AccountHolder, filters: Filters }
       end
       def self.field_remappings

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

@@ -110,7 +110,7 @@ module Stripe
       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
-      # 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.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
       attr_reader :metadata
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object

data/lib/stripe/resources/funding_instructions.rb CHANGED Viewed

@@ -2,11 +2,11 @@
 # frozen_string_literal: true
 module Stripe
-  # Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is
+  # Each customer has a [`balance`](https://docs.stripe.com/api/customers/object#customer_object-balance) that is
   # automatically applied to future invoices and payments using the `customer_balance` payment method.
   # Customers can fund this balance by initiating a bank transfer to any account in the
   # `financial_addresses` field.
-  # Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)
+  # Related guide: [Customer balance funding instructions](https://docs.stripe.com/payments/customer-balance/funding-instructions)
   class FundingInstructions < APIResource
     OBJECT_NAME = "funding_instructions"
     def self.object_name
@@ -27,7 +27,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -50,7 +50,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -100,7 +100,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -123,7 +123,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -171,7 +171,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -194,7 +194,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -240,7 +240,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -263,7 +263,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -311,7 +311,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -334,7 +334,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -384,7 +384,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -407,7 +407,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types

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

@@ -9,11 +9,11 @@ module Stripe
     # appropriate sub-resource: `document`, `id_number`, `selfie`.
     #
     # Each VerificationReport contains a copy of any data collected by the user as well as
-    # reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)
+    # reference IDs which can be used to access collected images through the [FileUpload](https://docs.stripe.com/api/files)
     # API. To configure and create VerificationReports, use the
-    # [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.
+    # [VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API.
     #
-    # Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).
+    # Related guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results).
     class VerificationReport < APIResource
       extend Stripe::APIOperations::List
@@ -34,7 +34,7 @@ module Stripe
           attr_reader :line2
           # ZIP or postal code.
           attr_reader :postal_code
-          # State, county, province, or region.
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_reader :state
           def self.inner_class_types
@@ -119,7 +119,7 @@ module Stripe
         attr_reader :error
         # Expiration date of the document.
         attr_reader :expiration_date
-        # Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.
+        # Array of [File](https://docs.stripe.com/api/files) ids containing images for this document.
         attr_reader :files
         # First name as it appears in the document.
         attr_reader :first_name
@@ -248,11 +248,11 @@ module Stripe
         class Document < ::Stripe::StripeObject
           # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
           attr_reader :allowed_types
-          # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
+          # Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
           attr_reader :require_id_number
           # Disable image uploads, identity document images have to be captured using the device’s camera.
           attr_reader :require_live_capture
-          # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
+          # Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).
           attr_reader :require_matching_selfie
           def self.inner_class_types
@@ -333,11 +333,11 @@ module Stripe
             @field_remappings = {}
           end
         end
-        # ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.
+        # ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check.
         attr_reader :document
         # Details on the verification error. Present when status is `unverified`.
         attr_reader :error
-        # ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.
+        # ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check.
         attr_reader :selfie
         # Status of this `selfie` check.
         attr_reader :status

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

@@ -13,7 +13,7 @@ module Stripe
     # the verification flow. The VerificationSession contains the user's verified data after
     # verification checks are complete.
     #
-    # Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)
+    # Related guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)
     class VerificationSession < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
@@ -43,11 +43,11 @@ module Stripe
         class Document < ::Stripe::StripeObject
           # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
           attr_reader :allowed_types
-          # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
+          # Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
           attr_reader :require_id_number
           # Disable image uploads, identity document images have to be captured using the device’s camera.
           attr_reader :require_live_capture
-          # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
+          # Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).
           attr_reader :require_matching_selfie
           def self.inner_class_types
@@ -190,7 +190,7 @@ module Stripe
           attr_reader :line2
           # ZIP or postal code.
           attr_reader :postal_code
-          # State, county, province, or region.
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_reader :state
           def self.inner_class_types
@@ -251,7 +251,7 @@ module Stripe
       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_reader :client_reference_id
-      # The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.
+      # The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more.
       attr_reader :client_secret
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
@@ -259,11 +259,11 @@ module Stripe
       attr_reader :id
       # If present, this property tells you the last error encountered when processing the verification.
       attr_reader :last_error
-      # ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)
+      # ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)
       attr_reader :last_verification_report
       # 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
-      # 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.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
       attr_reader :metadata
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
@@ -275,15 +275,15 @@ module Stripe
       attr_reader :redaction
       # Customer ID
       attr_reader :related_customer
-      # Token referencing a Customer Account resource.
+      # The ID of the Account representing a customer.
       attr_reader :related_customer_account
       # Attribute for field related_person
       attr_reader :related_person
-      # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
+      # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
       attr_reader :status
-      # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
+      # The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
       attr_reader :type
-      # The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
+      # The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
       attr_reader :url
       # The configuration token of a verification flow from the dashboard.
       attr_reader :verification_flow