Class: Straddle::Models::CustomerCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Straddle::Resources::Customers#create

Constant Summary

Straddle =

Returns:

• (:CustomerConfiguration)

Instance Attribute Summary

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

  Customer postal address.

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

  Customer compliance profile.

• #config ⇒ Straddle::Models::CustomerConfiguration^?
• #correlation_id ⇒ String^?

  Optional client-generated identifier for tracing a series of related requests.

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

  Customer email address.

• #external_id ⇒ String^?

  Unique identifier for the customer in your system.

• #idempotency_key ⇒ String^?

  Optional client-generated key for an idempotent request.

• #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

  Customer phone number in E.164 format.

• #request_id ⇒ String^?

  Optional client-generated identifier for tracing one request.

• #straddle_account_id ⇒ String^?

  For platform requests, the embedded account UUID that sets the request scope.

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

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(device:, email:, name:, phone:, type:, address: nil, compliance_profile: nil, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(device:, email:, name:, phone:, type:, address: nil, compliance_profile: nil, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• device (Straddle::Models::CustomerDevice)
• email (String) —

  Customer email address.

• name (String) —

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

• phone (String) —

  Customer phone number in E.164 format. A mobile number is preferred.

• type (Symbol, Straddle::Models::CustomerType)
• 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) —

  Customer compliance profile. When provided, the object must include all fields r

• config (Straddle::Models::CustomerConfiguration) (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.

• correlation_id (String) (defaults to: nil) —

  Optional client-generated identifier for tracing a series of related requests.

• idempotency_key (String) (defaults to: nil) —

  Optional client-generated key for an idempotent request.

• request_id (String) (defaults to: nil) —

  Optional client-generated identifier for tracing one request.

• straddle_account_id (String) (defaults to: nil) —

  For platform requests, the embedded account UUID that sets the request scope.

• request_options (Straddle::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/straddle/models/customer_create_params.rb', line 93

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/customer_create_params.rb', line 43

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

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

Customer compliance profile. When provided, the object must include all fields required for the customer type.

Parameters:

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

Returns:

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

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

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

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

Returns:

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

# File 'lib/straddle/models/customer_create_params.rb', line 55

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

#correlation_id ⇒ String^?

Optional client-generated identifier for tracing a series of related requests.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/customer_create_params.rb', line 73

optional :correlation_id, String

#device ⇒ Straddle::Models::CustomerDevice

Parameters:

• value (Straddle::CustomerDevice)

Returns:

• (Straddle::Models::CustomerDevice)

# File 'lib/straddle/models/customer_create_params.rb', line 13

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

#email ⇒ String

Customer email address.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/customer_create_params.rb', line 19

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/customer_create_params.rb', line 61

optional :external_id, String, nil?: true

#idempotency_key ⇒ String^?

Optional client-generated key for an idempotent request.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/customer_create_params.rb', line 79

optional :idempotency_key, 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/customer_create_params.rb', line 67

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/customer_create_params.rb', line 25

required :name, String

#phone ⇒ String

Customer phone number in E.164 format. A mobile number is preferred.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/customer_create_params.rb', line 31

required :phone, String

#request_id ⇒ String^?

Optional client-generated identifier for tracing one request.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/customer_create_params.rb', line 85

optional :request_id, String

#straddle_account_id ⇒ String^?

For platform requests, the embedded account UUID that sets the request scope.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/customer_create_params.rb', line 91

optional :straddle_account_id, String

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

Parameters:

• value (Straddle::Models::customer_type)

Returns:

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

# File 'lib/straddle/models/customer_create_params.rb', line 36

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/straddle/models/customer_create_params.rbs', line 84

def to_hash: -> {