Class: Straddle::Models::UnmaskedCustomer

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Straddle::Models::UnmaskedCustomer

Defined in:

lib/straddle/models/unmasked_customer.rb,
sig/straddle/models/unmasked_customer.rbs

Constant Summary

Straddle =

Returns:

• (:CustomerConfiguration)

Instance Attribute Summary

• #address ⇒ Straddle::Models::CustomerAddress^?

  Customer postal address.

• #compliance_profile ⇒ Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, ...
• #config ⇒ Straddle::Models::CustomerConfiguration^?
• #created_at ⇒ Time

  Timestamp of when the customer record was created.

• #device ⇒ Straddle::Models::CustomerDevice^?
• #email ⇒ String

  The customer's email address.

• #external_id ⇒ String^?

  Unique identifier for the customer in your system.

• #id ⇒ String

  Unique identifier for the customer.

• #metadata ⇒ Hash{Symbol=>String}^?

  Up to 20 user-defined key-value pairs associated with the customer.

• #name ⇒ String

  Full name for an individual customer or business name for a business customer.

• #phone ⇒ String

  The customer's phone number in E.164 format.

• #status ⇒ Symbol, Straddle::Models::CustomerStatus
• #type ⇒ Symbol, Straddle::Models::CustomerType
• #updated_at ⇒ Time

  Timestamp of the most recent update to the customer record.

Instance Method Summary

• #initialize(id:, created_at:, email:, name:, phone:, status:, type:, updated_at:, address: nil, compliance_profile: nil, config: nil, device: nil, external_id: nil, metadata: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see UnmaskedCustomer for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, created_at:, email:, name:, phone:, status:, type:, updated_at:, address: nil, compliance_profile: nil, config: nil, device: nil, external_id: nil, metadata: nil) ⇒ Object

Some parameter documentations has been truncated, see Straddle::Models::UnmaskedCustomer for more details.

Parameters:

• id (String) —

  Unique identifier for the customer.

• created_at (Time) —

  Timestamp of when the customer record was created.

• email (String) —

  The customer's email address.

• name (String) —

  Full name for an individual customer or business name for a business customer.

• phone (String) —

  The customer's phone number in E.164 format.

• status (Symbol, Straddle::Models::CustomerStatus)
• type (Symbol, Straddle::Models::CustomerType)
• updated_at (Time) —

  Timestamp of the most recent update to the customer record.

• address (Straddle::Models::CustomerAddress, nil) (defaults to: nil) —

  Customer postal address. When provided, the object must include all required fie

• compliance_profile (Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, Straddle::Models::UnmaskedComplianceProfile::BusinessComplianceProfile, nil) (defaults to: nil)
• config (Straddle::Models::CustomerConfiguration) (defaults to: nil)
• device (Straddle::Models::CustomerDevice) (defaults to: nil)
• external_id (String, nil) (defaults to: nil) —

  Unique identifier for the customer in your system.

• metadata (Hash{Symbol=>String}, nil) (defaults to: nil) —

  Up to 20 user-defined key-value pairs associated with the customer.

# File 'lib/straddle/models/unmasked_customer.rb', line 86

Instance Attribute Details

#address ⇒ Straddle::Models::CustomerAddress^?

Customer postal address. When provided, the object must include all required fields.

Parameters:

• value (Straddle::CustomerAddress, nil)

Returns:

• (Straddle::Models::CustomerAddress, nil)

# File 'lib/straddle/models/unmasked_customer.rb', line 57

optional :address, -> { Straddle::CustomerAddress }, nil?: true

#compliance_profile ⇒ Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, ...

Parameters:

• value (Straddle::Models::unmasked_compliance_profile, nil)

Returns:

• (Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, Straddle::Models::UnmaskedComplianceProfile::BusinessComplianceProfile, nil)

# File 'lib/straddle/models/unmasked_customer.rb', line 62

optional :compliance_profile, union: -> { Straddle::UnmaskedComplianceProfile }, nil?: true

#config ⇒ Straddle::Models::CustomerConfiguration^?

Returns:

• (Straddle::Models::CustomerConfiguration, nil)

# File 'lib/straddle/models/unmasked_customer.rb', line 67

optional :config, -> { Straddle::CustomerConfiguration }

#created_at ⇒ Time

Timestamp of when the customer record was created.

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/straddle/models/unmasked_customer.rb', line 16

required :created_at, Time

#device ⇒ Straddle::Models::CustomerDevice^?

Parameters:

• (Straddle::CustomerDevice)

Returns:

• (Straddle::Models::CustomerDevice, nil)

# File 'lib/straddle/models/unmasked_customer.rb', line 72

optional :device, -> { Straddle::CustomerDevice }

#email ⇒ String

The customer's email address.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/unmasked_customer.rb', line 22

required :email, String

#external_id ⇒ String^?

Unique identifier for the customer in your system.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/straddle/models/unmasked_customer.rb', line 78

optional :external_id, String, nil?: true

#id ⇒ String

Unique identifier for the customer.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/unmasked_customer.rb', line 10

required :id, String

#metadata ⇒ Hash{Symbol=>String}^?

Up to 20 user-defined key-value pairs associated with the customer.

Parameters:

• value (::Hash[Symbol, String], nil)

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/straddle/models/unmasked_customer.rb', line 84

optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true

#name ⇒ String

Full name for an individual customer or business name for a business customer.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/unmasked_customer.rb', line 28

required :name, String

#phone ⇒ String

The customer's phone number in E.164 format.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/unmasked_customer.rb', line 34

required :phone, String

#status ⇒ Symbol, Straddle::Models::CustomerStatus

Parameters:

• value (Straddle::Models::customer_status)

Returns:

• (Symbol, Straddle::Models::CustomerStatus)

# File 'lib/straddle/models/unmasked_customer.rb', line 39

required :status, enum: -> { Straddle::CustomerStatus }

#type ⇒ Symbol, Straddle::Models::CustomerType

Parameters:

• value (Straddle::Models::customer_type)

Returns:

• (Symbol, Straddle::Models::CustomerType)

# File 'lib/straddle/models/unmasked_customer.rb', line 44

required :type, enum: -> { Straddle::CustomerType }

#updated_at ⇒ Time

Timestamp of the most recent update to the customer record.

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/straddle/models/unmasked_customer.rb', line 50

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/straddle/models/unmasked_customer.rbs', line 73

def to_hash: -> {