Class: Inttegro::Customer

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/customer/customer.rb,
lib/inttegro/customer/base.rb,
lib/inttegro/customer/data.rb,
lib/inttegro/customer/page.rb,
lib/inttegro/customer/address.rb,
lib/inttegro/customer/response.rb,
lib/inttegro/customer/page_request.rb,
lib/inttegro/customer/address_input.rb,
lib/inttegro/customer/balance_value.rb,
lib/inttegro/customer/page_response.rb,
lib/inttegro/customer/create_request.rb,
lib/inttegro/customer/lookup_request.rb,
lib/inttegro/customer/update_request.rb

Overview

Typed representation of the customer object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Defined Under Namespace

Classes: Address, AddressInput, BalanceValue, CreateRequest, Data, LookupRequest, Page, PageRequest, PageResponse, Response, UpdateRequest

Instance Attribute Summary collapse

Instance Attribute Details

#balance ⇒ Hash{String => Inttegro::Customer::BalanceValue} (readonly)

Available customer balances keyed by lowercase currency code.

Required in the API payload. Wire name: balance.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#billing_address ⇒ Inttegro::Customer::Address? (readonly)

Value of the billing_address field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: billing_address.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#created_at ⇒ Time (readonly)

Value of the created_at field in the Inttegro API payload.

Required in the API payload. Wire name: created_at.

Returns:

  • (Time) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#custom_data ⇒ Inttegro::CustomData? (readonly)

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.

Optional in the API payload; omitted values default to nil. Wire name: custom_data.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#email_address ⇒ String? (readonly)

Value of the email_address field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: email_address.

Returns:

  • (String, nil) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#fingerprint ⇒ String (readonly)

Application-scoped value for spotting possible duplicate customer records. Matching nonempty fingerprints within the same application indicate that the records likely belong to the same buyer. Compare fingerprints only within that application, and continue to use each customer ID for API operations.

Required in the API payload. Wire name: fingerprint.

Returns:

  • (String) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#guest ⇒ Boolean (readonly)

Value of the guest field in the Inttegro API payload.

Required in the API payload. Wire name: guest.

Returns:

  • (Boolean) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#id ⇒ String (readonly)

Value of the id field in the Inttegro API payload.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#name ⇒ String (readonly)

Value of the name field in the Inttegro API payload.

Required in the API payload. Wire name: name.

Returns:

  • (String) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#phone_number ⇒ String? (readonly)

Value of the phone_number field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: phone_number.

Returns:

  • (String, nil) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#reference ⇒ String? (readonly)

Value of the reference field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: reference.

Returns:

  • (String, nil) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#shipping_address ⇒ Inttegro::Customer::Address? (readonly)

Value of the shipping_address field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: shipping_address.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#suffix ⇒ String? (readonly)

Value of the suffix field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: suffix.

Returns:

  • (String, nil) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#title ⇒ String? (readonly)

Value of the title field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: title.

Returns:

  • (String, nil) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end

#updated_at ⇒ Time? (readonly)

Value of the updated_at field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: updated_at.

Returns:

  • (Time, nil) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inttegro/customer/customer.rb', line 113

class Customer
  const :balance, T::Hash[String, Inttegro::Customer::BalanceValue]
  const :billing_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :email_address, T.nilable(String), default: nil
  const :fingerprint, String
  const :guest, T::Boolean
  const :id, String
  const :name, String
  const :phone_number, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :shipping_address, T.nilable(Inttegro::Customer::Address), default: nil
  const :suffix, T.nilable(String), default: nil
  const :title, T.nilable(String), default: nil
  const :updated_at, T.nilable(Time), default: nil
end