Class: Straddle::Models::CustomerUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/straddle/models/customer_update_params.rb,
sig/straddle/models/customer_update_params.rbs

Overview

See Also:

  • Straddle::Resources::Customers#update

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(id:, device:, email:, name:, phone:, status:, address: nil, compliance_profile: 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::CustomerUpdateParams for more details.

Parameters:

  • id (String)
  • 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.

  • status (Symbol, Straddle::Models::CustomerStatus)
  • 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)
  • 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_update_params.rb', line 91

Instance Attribute Details

#address ⇒ Straddle::Models::CustomerAddress?

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

Parameters:

Returns:



48
 
# File 'lib/straddle/models/customer_update_params.rb', line 48

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

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

Parameters:

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

Returns:



53
 
# File 'lib/straddle/models/customer_update_params.rb', line 53

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

#correlation_id ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


71
 
# File 'lib/straddle/models/customer_update_params.rb', line 71

optional :correlation_id, String

#device ⇒ Straddle::Models::CustomerDevice

Parameters:

Returns:



18
 
# File 'lib/straddle/models/customer_update_params.rb', line 18

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

#email ⇒ String

Customer email address.

Parameters:

  • value (String)

Returns:

  • (String) 


24
 
# File 'lib/straddle/models/customer_update_params.rb', line 24

required :email, String

#external_id ⇒ String?

Unique identifier for the customer in your system.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


59
 
# File 'lib/straddle/models/customer_update_params.rb', line 59

optional :external_id, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#idempotency_key ⇒ String?

Optional client-generated key for an idempotent request.

Parameters:

  • (String)

Returns:

  • (String, nil) 


77
 
# File 'lib/straddle/models/customer_update_params.rb', line 77

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) 


65
 
# File 'lib/straddle/models/customer_update_params.rb', line 65

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) 


30
 
# File 'lib/straddle/models/customer_update_params.rb', line 30

required :name, String

#phone ⇒ String

Customer phone number in E.164 format.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :phone, String

#request_id ⇒ String?

Optional client-generated identifier for tracing one request.

Parameters:

  • (String)

Returns:

  • (String, nil) 


83
 
# File 'lib/straddle/models/customer_update_params.rb', line 83

optional :request_id, String

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

Parameters:

  • value (Straddle::Models::customer_status)

Returns:



41
 
# File 'lib/straddle/models/customer_update_params.rb', line 41

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

#straddle_account_id ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


89
 
# File 'lib/straddle/models/customer_update_params.rb', line 89

optional :straddle_account_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


80
 
# File 'sig/straddle/models/customer_update_params.rbs', line 80

def to_hash: -> {