sharpetronics/stripe-ruby
1
0
Fork 0
mirror of https://github.com/stripe/stripe-ruby.git synced 2025-12-07 00:00:35 -05:00
Code Issues Projects Releases Wiki Activity

Handle external_account field (#1572)

Browse Source
This commit is contained in:
Michael Broshi 2025-04-07 22:18:52 -07:00 committed by GitHub
parent 5d6dd96e0f
commit f4374068ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 342 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
lib/stripe/services/external_account_service.rb
View File

@ -124,6 +124,118 @@ module Stripe
end
class CreateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
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.
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.
attr_accessor :account_holder_type
# The account number for the bank account, in string form. Must be a checking account.
attr_accessor :account_number
# The country in which the bank account is located.
attr_accessor :country
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
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.
attr_accessor :routing_number
def initialize(
object: nil,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
)
@object = object
@account_holder_name = account_holder_name
@account_holder_type = account_holder_type
@account_number = account_number
@country = country
@currency = currency
@routing_number = routing_number
end
end
class Card < Stripe::RequestParams
# Attribute for param field object
attr_accessor :object
# Attribute for param field address_city
attr_accessor :address_city
# Attribute for param field address_country
attr_accessor :address_country
# Attribute for param field address_line1
attr_accessor :address_line1
# Attribute for param field address_line2
attr_accessor :address_line2
# Attribute for param field address_state
attr_accessor :address_state
# Attribute for param field address_zip
attr_accessor :address_zip
# Attribute for param field currency
attr_accessor :currency
# Attribute for param field cvc
attr_accessor :cvc
# Attribute for param field exp_month
attr_accessor :exp_month
# Attribute for param field exp_year
attr_accessor :exp_year
# Attribute for param field name
attr_accessor :name
# Attribute for param field number
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.
attr_accessor :metadata
def initialize(
object: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil
)
@object = object
@address_city = address_city
@address_country = address_country
@address_line1 = address_line1
@address_line2 = address_line2
@address_state = address_state
@address_zip = address_zip
@currency = currency
@cvc = cvc
@exp_month = exp_month
@exp_year = exp_year
@name = name
@number = number
@metadata = metadata
end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
attr_accessor :object
# Attribute for param field currency
attr_accessor :currency
# Attribute for param field token
attr_accessor :token
def initialize(object: nil, currency: nil, token: nil)
@object = object
@currency = currency
@token = token
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.
attr_accessor :default_for_currency
# Specifies which fields in the response should be expanded.

117
rbi/stripe.rbi
View File

@ -181834,6 +181834,117 @@ module Stripe
); end
end
class CreateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
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(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(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) }
attr_accessor :account_number
# The country in which the bank account is located.
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(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(T.nilable(String)) }
attr_accessor :routing_number
sig {
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,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
); end
end
class Card < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
attr_accessor :object
# Attribute for param field address_city
sig { returns(T.nilable(String)) }
attr_accessor :address_city
# Attribute for param field address_country
sig { returns(T.nilable(String)) }
attr_accessor :address_country
# Attribute for param field address_line1
sig { returns(T.nilable(String)) }
attr_accessor :address_line1
# Attribute for param field address_line2
sig { returns(T.nilable(String)) }
attr_accessor :address_line2
# Attribute for param field address_state
sig { returns(T.nilable(String)) }
attr_accessor :address_state
# Attribute for param field address_zip
sig { returns(T.nilable(String)) }
attr_accessor :address_zip
# Attribute for param field currency
sig { returns(T.nilable(String)) }
attr_accessor :currency
# Attribute for param field cvc
sig { returns(T.nilable(String)) }
attr_accessor :cvc
# Attribute for param field exp_month
sig { returns(Integer) }
attr_accessor :exp_month
# Attribute for param field exp_year
sig { returns(Integer) }
attr_accessor :exp_year
# Attribute for param field name
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.nilable(T::Hash[String, String])) }
attr_accessor :metadata
sig {
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,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil
); end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
attr_accessor :object
# Attribute for param field currency
sig { returns(T.nilable(String)) }
attr_accessor :currency
# Attribute for param field token
sig { returns(String) }
attr_accessor :token
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.nilable(T::Boolean)) }
attr_accessor :default_for_currency
@ -181841,13 +181952,15 @@ module Stripe
sig { returns(T.nilable(T::Array[String])) }
attr_accessor :expand
# Either 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).
sig { returns(String) }
sig {
returns(T.any(String, ::Stripe::ExternalAccountService::CreateParams::Card, ::Stripe::ExternalAccountService::CreateParams::BankAccount, ::Stripe::ExternalAccountService::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.nilable(T::Hash[String, String])) }
attr_accessor :metadata
sig {
params(default_for_currency: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), external_account: String, metadata: T.nilable(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::ExternalAccountService::CreateParams::Card, ::Stripe::ExternalAccountService::CreateParams::BankAccount, ::Stripe::ExternalAccountService::CreateParams::CardToken), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(
default_for_currency: nil,

117
rbi/stripe/services/external_account_service.rbi
View File

@ -131,6 +131,117 @@ module Stripe
); end
end
class CreateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
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(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(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) }
attr_accessor :account_number
# The country in which the bank account is located.
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(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(T.nilable(String)) }
attr_accessor :routing_number
sig {
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,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
); end
end
class Card < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
attr_accessor :object
# Attribute for param field address_city
sig { returns(T.nilable(String)) }
attr_accessor :address_city
# Attribute for param field address_country
sig { returns(T.nilable(String)) }
attr_accessor :address_country
# Attribute for param field address_line1
sig { returns(T.nilable(String)) }
attr_accessor :address_line1
# Attribute for param field address_line2
sig { returns(T.nilable(String)) }
attr_accessor :address_line2
# Attribute for param field address_state
sig { returns(T.nilable(String)) }
attr_accessor :address_state
# Attribute for param field address_zip
sig { returns(T.nilable(String)) }
attr_accessor :address_zip
# Attribute for param field currency
sig { returns(T.nilable(String)) }
attr_accessor :currency
# Attribute for param field cvc
sig { returns(T.nilable(String)) }
attr_accessor :cvc
# Attribute for param field exp_month
sig { returns(Integer) }
attr_accessor :exp_month
# Attribute for param field exp_year
sig { returns(Integer) }
attr_accessor :exp_year
# Attribute for param field name
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.nilable(T::Hash[String, String])) }
attr_accessor :metadata
sig {
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,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil
); end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
attr_accessor :object
# Attribute for param field currency
sig { returns(T.nilable(String)) }
attr_accessor :currency
# Attribute for param field token
sig { returns(String) }
attr_accessor :token
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.nilable(T::Boolean)) }
attr_accessor :default_for_currency
@ -138,13 +249,15 @@ module Stripe
sig { returns(T.nilable(T::Array[String])) }
attr_accessor :expand
# Either 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).
sig { returns(String) }
sig {
returns(T.any(String, ::Stripe::ExternalAccountService::CreateParams::Card, ::Stripe::ExternalAccountService::CreateParams::BankAccount, ::Stripe::ExternalAccountService::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.nilable(T::Hash[String, String])) }
attr_accessor :metadata
sig {
params(default_for_currency: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), external_account: String, metadata: T.nilable(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::ExternalAccountService::CreateParams::Card, ::Stripe::ExternalAccountService::CreateParams::BankAccount, ::Stripe::ExternalAccountService::CreateParams::CardToken), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(
default_for_currency: nil,