stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2

data/rbi/stripe/services/issuing/cardholder_service.rbi

@@ -10,58 +10,45 @@ module Stripe
           # Minimum value to filter by (exclusive)
           sig { returns(Integer) }
           attr_accessor :gt
-
           # Minimum value to filter by (inclusive)
           sig { returns(Integer) }
           attr_accessor :gte
-
           # Maximum value to filter by (exclusive)
           sig { returns(Integer) }
           attr_accessor :lt
-
           # Maximum value to filter by (inclusive)
           sig { returns(Integer) }
           attr_accessor :lte
-
           sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
           def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
         end
         # Only return cardholders that were created during the given date interval.
         sig { returns(T.any(::Stripe::Issuing::CardholderService::ListParams::Created, Integer)) }
         attr_accessor :created
-
         # Only return cardholders that have the given email address.
         sig { returns(String) }
         attr_accessor :email
-
         # 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) }
         attr_accessor :ending_before
-
         # Specifies which fields in the response should be expanded.
         sig { returns(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) }
         attr_accessor :limit
-
         # Only return cardholders that have the given phone number.
         sig { returns(String) }
         attr_accessor :phone_number
-
         # 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) }
         attr_accessor :starting_after
-
         # Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.
         sig { returns(String) }
         attr_accessor :status
-
         # Only return cardholders that have the given type. One of `individual` or `company`.
         sig { returns(String) }
         attr_accessor :type
-
         sig {
           params(created: T.any(::Stripe::Issuing::CardholderService::ListParams::Created, Integer), email: String, ending_before: String, expand: T::Array[String], limit: Integer, phone_number: String, starting_after: String, status: String, type: String).void
          }
@@ -83,27 +70,21 @@ module Stripe
             # City, district, suburb, town, or village.
             sig { returns(String) }
             attr_accessor :city
-
             # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
             sig { returns(String) }
             attr_accessor :country
-
             # Address line 1 (e.g., street, PO Box, or company name).
             sig { returns(String) }
             attr_accessor :line1
-
             # Address line 2 (e.g., apartment, suite, unit, or building).
             sig { returns(String) }
             attr_accessor :line2
-
             # ZIP or postal code.
             sig { returns(String) }
             attr_accessor :postal_code
-
             # State, county, province, or region.
             sig { returns(String) }
             attr_accessor :state
-
             sig {
               params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
              }
@@ -119,7 +100,6 @@ module Stripe
           # The cardholder’s billing address.
           sig { returns(::Stripe::Issuing::CardholderService::CreateParams::Billing::Address) }
           attr_accessor :address
-
           sig {
             params(address: ::Stripe::Issuing::CardholderService::CreateParams::Billing::Address).void
            }
@@ -129,7 +109,6 @@ module Stripe
           # The entity's business ID number.
           sig { returns(String) }
           attr_accessor :tax_id
-
           sig { params(tax_id: String).void }
           def initialize(tax_id: nil); end
         end
@@ -139,15 +118,12 @@ module Stripe
               # The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
               sig { returns(Integer) }
               attr_accessor :date
-
               # The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
               sig { returns(String) }
               attr_accessor :ip
-
               # The user agent of the browser from which the cardholder accepted the Authorized User Terms.
               sig { returns(T.nilable(String)) }
               attr_accessor :user_agent
-
               sig { params(date: Integer, ip: String, user_agent: T.nilable(String)).void }
               def initialize(date: nil, ip: nil, user_agent: nil); end
             end
@@ -156,7 +132,6 @@ module Stripe
               returns(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing::UserTermsAcceptance)
              }
             attr_accessor :user_terms_acceptance
-
             sig {
               params(user_terms_acceptance: ::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing::UserTermsAcceptance).void
              }
@@ -166,15 +141,12 @@ module Stripe
             # The day of birth, between 1 and 31.
             sig { returns(Integer) }
             attr_accessor :day
-
             # The month of birth, between 1 and 12.
             sig { returns(Integer) }
             attr_accessor :month
-
             # The four-digit year of birth.
             sig { returns(Integer) }
             attr_accessor :year
-
             sig { params(day: Integer, month: Integer, year: Integer).void }
             def initialize(day: nil, month: nil, year: nil); end
           end
@@ -183,11 +155,9 @@ module Stripe
               # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
               sig { returns(String) }
               attr_accessor :back
-
               # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
               sig { returns(String) }
               attr_accessor :front
-
               sig { params(back: String, front: String).void }
               def initialize(back: nil, front: nil); end
             end
@@ -196,7 +166,6 @@ module Stripe
               returns(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification::Document)
              }
             attr_accessor :document
-
             sig {
               params(document: ::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification::Document).void
              }
@@ -207,25 +176,20 @@ module Stripe
             returns(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing)
            }
           attr_accessor :card_issuing
-
           # The date of birth of this cardholder. Cardholders must be older than 13 years old.
           sig { returns(::Stripe::Issuing::CardholderService::CreateParams::Individual::Dob) }
           attr_accessor :dob
-
           # The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
           sig { returns(String) }
           attr_accessor :first_name
-
           # The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
           sig { returns(String) }
           attr_accessor :last_name
-
           # Government-issued ID document for this cardholder.
           sig {
             returns(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification)
            }
           attr_accessor :verification
-
           sig {
             params(card_issuing: ::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing, dob: ::Stripe::Issuing::CardholderService::CreateParams::Individual::Dob, first_name: String, last_name: String, verification: ::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification).void
            }
@@ -242,44 +206,35 @@ module Stripe
             # Maximum amount allowed to spend per interval.
             sig { returns(Integer) }
             attr_accessor :amount
-
             # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
             sig { returns(T::Array[String]) }
             attr_accessor :categories
-
             # Interval (or event) to which the amount applies.
             sig { returns(String) }
             attr_accessor :interval
-
             sig { params(amount: Integer, categories: T::Array[String], interval: String).void }
             def initialize(amount: nil, categories: nil, interval: nil); end
           end
           # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
           sig { returns(T::Array[String]) }
           attr_accessor :allowed_categories
-
           # Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
           sig { returns(T::Array[String]) }
           attr_accessor :allowed_merchant_countries
-
           # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
           sig { returns(T::Array[String]) }
           attr_accessor :blocked_categories
-
           # Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
           sig { returns(T::Array[String]) }
           attr_accessor :blocked_merchant_countries
-
           # Limit spending with amount-based rules that apply across this cardholder's cards.
           sig {
             returns(T::Array[::Stripe::Issuing::CardholderService::CreateParams::SpendingControls::SpendingLimit])
            }
           attr_accessor :spending_limits
-
           # Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.
           sig { returns(String) }
           attr_accessor :spending_limits_currency
-
           sig {
             params(allowed_categories: T::Array[String], allowed_merchant_countries: T::Array[String], blocked_categories: T::Array[String], blocked_merchant_countries: T::Array[String], spending_limits: T::Array[::Stripe::Issuing::CardholderService::CreateParams::SpendingControls::SpendingLimit], spending_limits_currency: String).void
            }
@@ -295,53 +250,41 @@ module Stripe
         # The cardholder's billing address.
         sig { returns(::Stripe::Issuing::CardholderService::CreateParams::Billing) }
         attr_accessor :billing
-
         # Additional information about a `company` cardholder.
         sig { returns(::Stripe::Issuing::CardholderService::CreateParams::Company) }
         attr_accessor :company
-
         # The cardholder's email address.
         sig { returns(String) }
         attr_accessor :email
-
         # Specifies which fields in the response should be expanded.
         sig { returns(T::Array[String]) }
         attr_accessor :expand
-
         # Additional information about an `individual` cardholder.
         sig { returns(::Stripe::Issuing::CardholderService::CreateParams::Individual) }
         attr_accessor :individual
-
         # 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]) }
         attr_accessor :metadata
-
         # The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.
         sig { returns(String) }
         attr_accessor :name
-
         # The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.
         #  While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.
         sig { returns(String) }
         attr_accessor :phone_number
-
         # The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
         #  This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.
         sig { returns(T::Array[String]) }
         attr_accessor :preferred_locales
-
         # Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
         sig { returns(::Stripe::Issuing::CardholderService::CreateParams::SpendingControls) }
         attr_accessor :spending_controls
-
         # Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.
         sig { returns(String) }
         attr_accessor :status
-
         # One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.
         sig { returns(String) }
         attr_accessor :type
-
         sig {
           params(billing: ::Stripe::Issuing::CardholderService::CreateParams::Billing, company: ::Stripe::Issuing::CardholderService::CreateParams::Company, email: String, expand: T::Array[String], individual: ::Stripe::Issuing::CardholderService::CreateParams::Individual, metadata: T::Hash[String, String], name: String, phone_number: String, preferred_locales: T::Array[String], spending_controls: ::Stripe::Issuing::CardholderService::CreateParams::SpendingControls, status: String, type: String).void
          }
@@ -364,7 +307,6 @@ module Stripe
         # Specifies which fields in the response should be expanded.
         sig { returns(T::Array[String]) }
         attr_accessor :expand
-
         sig { params(expand: T::Array[String]).void }
         def initialize(expand: nil); end
       end
@@ -374,27 +316,21 @@ module Stripe
             # City, district, suburb, town, or village.
             sig { returns(String) }
             attr_accessor :city
-
             # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
             sig { returns(String) }
             attr_accessor :country
-
             # Address line 1 (e.g., street, PO Box, or company name).
             sig { returns(String) }
             attr_accessor :line1
-
             # Address line 2 (e.g., apartment, suite, unit, or building).
             sig { returns(String) }
             attr_accessor :line2
-
             # ZIP or postal code.
             sig { returns(String) }
             attr_accessor :postal_code
-
             # State, county, province, or region.
             sig { returns(String) }
             attr_accessor :state
-
             sig {
               params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
              }
@@ -410,7 +346,6 @@ module Stripe
           # The cardholder’s billing address.
           sig { returns(::Stripe::Issuing::CardholderService::UpdateParams::Billing::Address) }
           attr_accessor :address
-
           sig {
             params(address: ::Stripe::Issuing::CardholderService::UpdateParams::Billing::Address).void
            }
@@ -420,7 +355,6 @@ module Stripe
           # The entity's business ID number.
           sig { returns(String) }
           attr_accessor :tax_id
-
           sig { params(tax_id: String).void }
           def initialize(tax_id: nil); end
         end
@@ -430,15 +364,12 @@ module Stripe
               # The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
               sig { returns(Integer) }
               attr_accessor :date
-
               # The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
               sig { returns(String) }
               attr_accessor :ip
-
               # The user agent of the browser from which the cardholder accepted the Authorized User Terms.
               sig { returns(T.nilable(String)) }
               attr_accessor :user_agent
-
               sig { params(date: Integer, ip: String, user_agent: T.nilable(String)).void }
               def initialize(date: nil, ip: nil, user_agent: nil); end
             end
@@ -447,7 +378,6 @@ module Stripe
               returns(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing::UserTermsAcceptance)
              }
             attr_accessor :user_terms_acceptance
-
             sig {
               params(user_terms_acceptance: ::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing::UserTermsAcceptance).void
              }
@@ -457,15 +387,12 @@ module Stripe
             # The day of birth, between 1 and 31.
             sig { returns(Integer) }
             attr_accessor :day
-
             # The month of birth, between 1 and 12.
             sig { returns(Integer) }
             attr_accessor :month
-
             # The four-digit year of birth.
             sig { returns(Integer) }
             attr_accessor :year
-
             sig { params(day: Integer, month: Integer, year: Integer).void }
             def initialize(day: nil, month: nil, year: nil); end
           end
@@ -474,11 +401,9 @@ module Stripe
               # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
               sig { returns(String) }
               attr_accessor :back
-
               # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
               sig { returns(String) }
               attr_accessor :front
-
               sig { params(back: String, front: String).void }
               def initialize(back: nil, front: nil); end
             end
@@ -487,7 +412,6 @@ module Stripe
               returns(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification::Document)
              }
             attr_accessor :document
-
             sig {
               params(document: ::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification::Document).void
              }
@@ -498,25 +422,20 @@ module Stripe
             returns(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing)
            }
           attr_accessor :card_issuing
-
           # The date of birth of this cardholder. Cardholders must be older than 13 years old.
           sig { returns(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Dob) }
           attr_accessor :dob
-
           # The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
           sig { returns(String) }
           attr_accessor :first_name
-
           # The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
           sig { returns(String) }
           attr_accessor :last_name
-
           # Government-issued ID document for this cardholder.
           sig {
             returns(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification)
            }
           attr_accessor :verification
-
           sig {
             params(card_issuing: ::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing, dob: ::Stripe::Issuing::CardholderService::UpdateParams::Individual::Dob, first_name: String, last_name: String, verification: ::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification).void
            }
@@ -533,44 +452,35 @@ module Stripe
             # Maximum amount allowed to spend per interval.
             sig { returns(Integer) }
             attr_accessor :amount
-
             # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
             sig { returns(T::Array[String]) }
             attr_accessor :categories
-
             # Interval (or event) to which the amount applies.
             sig { returns(String) }
             attr_accessor :interval
-
             sig { params(amount: Integer, categories: T::Array[String], interval: String).void }
             def initialize(amount: nil, categories: nil, interval: nil); end
           end
           # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
           sig { returns(T::Array[String]) }
           attr_accessor :allowed_categories
-
           # Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
           sig { returns(T::Array[String]) }
           attr_accessor :allowed_merchant_countries
-
           # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
           sig { returns(T::Array[String]) }
           attr_accessor :blocked_categories
-
           # Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
           sig { returns(T::Array[String]) }
           attr_accessor :blocked_merchant_countries
-
           # Limit spending with amount-based rules that apply across this cardholder's cards.
           sig {
             returns(T::Array[::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls::SpendingLimit])
            }
           attr_accessor :spending_limits
-
           # Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.
           sig { returns(String) }
           attr_accessor :spending_limits_currency
-
           sig {
             params(allowed_categories: T::Array[String], allowed_merchant_countries: T::Array[String], blocked_categories: T::Array[String], blocked_merchant_countries: T::Array[String], spending_limits: T::Array[::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls::SpendingLimit], spending_limits_currency: String).void
            }
@@ -586,44 +496,34 @@ module Stripe
         # The cardholder's billing address.
         sig { returns(::Stripe::Issuing::CardholderService::UpdateParams::Billing) }
         attr_accessor :billing
-
         # Additional information about a `company` cardholder.
         sig { returns(::Stripe::Issuing::CardholderService::UpdateParams::Company) }
         attr_accessor :company
-
         # The cardholder's email address.
         sig { returns(String) }
         attr_accessor :email
-
         # Specifies which fields in the response should be expanded.
         sig { returns(T::Array[String]) }
         attr_accessor :expand
-
         # Additional information about an `individual` cardholder.
         sig { returns(::Stripe::Issuing::CardholderService::UpdateParams::Individual) }
         attr_accessor :individual
-
         # 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]) }
         attr_accessor :metadata
-
         # The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.
         sig { returns(String) }
         attr_accessor :phone_number
-
         # The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
         #  This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.
         sig { returns(T::Array[String]) }
         attr_accessor :preferred_locales
-
         # Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
         sig { returns(::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls) }
         attr_accessor :spending_controls
-
         # Specifies whether to permit authorizations on this cardholder's cards.
         sig { returns(String) }
         attr_accessor :status
-
         sig {
           params(billing: ::Stripe::Issuing::CardholderService::UpdateParams::Billing, company: ::Stripe::Issuing::CardholderService::UpdateParams::Company, email: String, expand: T::Array[String], individual: ::Stripe::Issuing::CardholderService::UpdateParams::Individual, metadata: T::Hash[String, String], phone_number: String, preferred_locales: T::Array[String], spending_controls: ::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls, status: String).void
          }