stripe 13.6.0.pre.beta.1 → 14.0.0

data/rbi/stripe/services/account_external_account_service.rbi

@@ -9,80 +9,80 @@ module Stripe
     end
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
-      sig { params(expand: T::Array[String]).void }
+      sig { params(expand: T.nilable(T::Array[String])).void }
       def initialize(expand: nil); end
     end
     class UpdateParams < Stripe::RequestParams
       class Documents < Stripe::RequestParams
         class BankAccountOwnershipVerification < Stripe::RequestParams
           # One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
-          sig { returns(T::Array[String]) }
+          sig { returns(T.nilable(T::Array[String])) }
           attr_accessor :files
-          sig { params(files: T::Array[String]).void }
+          sig { params(files: T.nilable(T::Array[String])).void }
           def initialize(files: nil); end
         end
         # One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
         sig {
-          returns(::Stripe::AccountExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification)
+          returns(T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification))
          }
         attr_accessor :bank_account_ownership_verification
         sig {
-          params(bank_account_ownership_verification: ::Stripe::AccountExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification).void
+          params(bank_account_ownership_verification: T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification)).void
          }
         def initialize(bank_account_ownership_verification: nil); end
       end
       # The name of the person or business that owns the bank account.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :account_holder_name
       # The type of entity that holds the account. This can be either `individual` or `company`.
-      sig { returns(T.nilable(String)) }
+      sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
       attr_accessor :account_holder_type
       # The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :account_type
       # City/District/Suburb/Town/Village.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :address_city
       # Billing address country, if provided when creating card.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :address_country
       # Address line 1 (Street address/PO Box/Company name).
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :address_line1
       # Address line 2 (Apartment/Suite/Unit/Building).
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :address_line2
       # State/County/Province/Region.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :address_state
       # ZIP or postal code.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :address_zip
       # When set to true, this becomes the default external account for its currency.
-      sig { returns(T::Boolean) }
+      sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :default_for_currency
       # Documents that may be submitted to satisfy various informational requests.
-      sig { returns(::Stripe::AccountExternalAccountService::UpdateParams::Documents) }
+      sig { returns(T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents)) }
       attr_accessor :documents
       # Two digit number representing the card’s expiration month.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :exp_month
       # Four digit number representing the card’s expiration year.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :exp_year
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       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`.
-      sig { returns(T.nilable(T::Hash[String, String])) }
+      sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
       attr_accessor :metadata
       # Cardholder name.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :name
       sig {
-        params(account_holder_name: String, account_holder_type: T.nilable(String), account_type: String, address_city: String, address_country: String, address_line1: String, address_line2: String, address_state: String, address_zip: String, default_for_currency: T::Boolean, documents: ::Stripe::AccountExternalAccountService::UpdateParams::Documents, exp_month: String, exp_year: String, expand: T::Array[String], metadata: T.nilable(T::Hash[String, String]), name: String).void
+        params(account_holder_name: T.nilable(String), account_holder_type: T.nilable(T.nilable(T.any(String, String))), account_type: T.nilable(String), address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), default_for_currency: T.nilable(T::Boolean), documents: T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents), exp_month: T.nilable(String), exp_year: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String)).void
        }
       def initialize(
         account_holder_name: nil,
@@ -105,22 +105,22 @@ module Stripe
     end
     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.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :ending_before
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       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.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :limit
       # Filter external accounts according to a particular object type.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :object
       # 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.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :starting_after
       sig {
-        params(ending_before: String, expand: T::Array[String], limit: Integer, object: String, starting_after: String).void
+        params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), object: T.nilable(String), starting_after: T.nilable(String)).void
        }
       def initialize(
         ending_before: nil,
@@ -136,10 +136,10 @@ module Stripe
         sig { returns(String) }
         attr_accessor :object
         # The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :account_holder_name
         # The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :account_holder_type
         # The account number for the bank account, in string form. Must be a checking account.
         sig { returns(String) }
@@ -148,13 +148,13 @@ module Stripe
         sig { returns(String) }
         attr_accessor :country
         # The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :currency
         # The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :routing_number
         sig {
-          params(object: String, account_holder_name: String, account_holder_type: String, account_number: String, country: String, currency: String, routing_number: String).void
+          params(object: String, account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, country: String, currency: T.nilable(String), routing_number: T.nilable(String)).void
          }
         def initialize(
           object: nil,
@@ -171,28 +171,28 @@ module Stripe
         sig { returns(String) }
         attr_accessor :object
         # Attribute for param field address_city
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :address_city
         # Attribute for param field address_country
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :address_country
         # Attribute for param field address_line1
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :address_line1
         # Attribute for param field address_line2
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :address_line2
         # Attribute for param field address_state
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :address_state
         # Attribute for param field address_zip
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :address_zip
         # Attribute for param field currency
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :currency
         # Attribute for param field cvc
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :cvc
         # Attribute for param field exp_month
         sig { returns(Integer) }
@@ -201,16 +201,16 @@ module Stripe
         sig { returns(Integer) }
         attr_accessor :exp_year
         # Attribute for param field name
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :name
         # Attribute for param field number
         sig { returns(String) }
         attr_accessor :number
         # 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.
-        sig { returns(T::Hash[String, String]) }
+        sig { returns(T.nilable(T::Hash[String, String])) }
         attr_accessor :metadata
         sig {
-          params(object: String, address_city: String, address_country: String, address_line1: String, address_line2: String, address_state: String, address_zip: String, currency: String, cvc: String, exp_month: Integer, exp_year: Integer, name: String, number: String, metadata: T::Hash[String, String]).void
+          params(object: String, address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, name: T.nilable(String), number: String, metadata: T.nilable(T::Hash[String, String])).void
          }
         def initialize(
           object: nil,
@@ -234,30 +234,30 @@ module Stripe
         sig { returns(String) }
         attr_accessor :object
         # Attribute for param field currency
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :currency
         # Attribute for param field token
         sig { returns(String) }
         attr_accessor :token
-        sig { params(object: String, currency: String, token: String).void }
+        sig { params(object: String, currency: T.nilable(String), token: String).void }
         def initialize(object: nil, currency: nil, token: nil); end
       end
       # When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
-      sig { returns(T::Boolean) }
+      sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :default_for_currency
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
-      # Please refer to full [documentation](https://stripe.com/docs/api) instead.
+      # A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead.
       sig {
         returns(T.any(String, ::Stripe::AccountExternalAccountService::CreateParams::Card, ::Stripe::AccountExternalAccountService::CreateParams::BankAccount, ::Stripe::AccountExternalAccountService::CreateParams::CardToken))
        }
       attr_accessor :external_account
       # 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`.
-      sig { returns(T::Hash[String, String]) }
+      sig { returns(T.nilable(T::Hash[String, String])) }
       attr_accessor :metadata
       sig {
-        params(default_for_currency: T::Boolean, expand: T::Array[String], external_account: T.any(String, ::Stripe::AccountExternalAccountService::CreateParams::Card, ::Stripe::AccountExternalAccountService::CreateParams::BankAccount, ::Stripe::AccountExternalAccountService::CreateParams::CardToken), metadata: T::Hash[String, String]).void
+        params(default_for_currency: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), external_account: T.any(String, ::Stripe::AccountExternalAccountService::CreateParams::Card, ::Stripe::AccountExternalAccountService::CreateParams::BankAccount, ::Stripe::AccountExternalAccountService::CreateParams::CardToken), metadata: T.nilable(T::Hash[String, String])).void
        }
       def initialize(
         default_for_currency: nil,

data/rbi/stripe/services/account_link_service.rbi

@@ -7,37 +7,37 @@ module Stripe
     class CreateParams < Stripe::RequestParams
       class CollectionOptions < Stripe::RequestParams
         # Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :fields
         # Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :future_requirements
-        sig { params(fields: String, future_requirements: String).void }
+        sig { params(fields: T.nilable(String), future_requirements: T.nilable(String)).void }
         def initialize(fields: nil, future_requirements: nil); end
       end
       # The identifier of the account to create an account link for.
       sig { returns(String) }
       attr_accessor :account
       # The collect parameter is deprecated. Use `collection_options` instead.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :collect
       # Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.
-      sig { returns(::Stripe::AccountLinkService::CreateParams::CollectionOptions) }
+      sig { returns(T.nilable(::Stripe::AccountLinkService::CreateParams::CollectionOptions)) }
       attr_accessor :collection_options
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
       # The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :refresh_url
       # The URL that the user will be redirected to upon leaving or completing the linked flow.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :return_url
       # The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`.
       sig { returns(String) }
       attr_accessor :type
       sig {
-        params(account: String, collect: String, collection_options: ::Stripe::AccountLinkService::CreateParams::CollectionOptions, expand: T::Array[String], refresh_url: String, return_url: String, type: String).void
+        params(account: String, collect: T.nilable(String), collection_options: T.nilable(::Stripe::AccountLinkService::CreateParams::CollectionOptions), expand: T.nilable(T::Array[String]), refresh_url: T.nilable(String), return_url: T.nilable(String), type: String).void
        }
       def initialize(
         account: nil,

data/rbi/stripe/services/account_login_link_service.rbi

@@ -6,9 +6,9 @@ module Stripe
   class AccountLoginLinkService < StripeService
     class CreateParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
-      sig { params(expand: T::Array[String]).void }
+      sig { params(expand: T.nilable(T::Array[String])).void }
       def initialize(expand: nil); end
     end
     # Creates a login link for a connected account to access the Express Dashboard.