Class: Inttegro::Order::Customer

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/order/customer.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.

Instance Attribute Summary collapse

Instance Attribute Details

#billing_address ⇒ Inttegro::Order::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:



60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/order/customer.rb', line 60

class Customer < T::Struct
  const :id, String
  const :guest, T::Boolean
  const :name, String
  const :email_address, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :billing_address, T.nilable(Inttegro::Order::Address), default: nil
  const :shipping_address, T.nilable(Inttegro::Order::Address), 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) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/order/customer.rb', line 60

class Customer < T::Struct
  const :id, String
  const :guest, T::Boolean
  const :name, String
  const :email_address, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :billing_address, T.nilable(Inttegro::Order::Address), default: nil
  const :shipping_address, T.nilable(Inttegro::Order::Address), 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) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/order/customer.rb', line 60

class Customer < T::Struct
  const :id, String
  const :guest, T::Boolean
  const :name, String
  const :email_address, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :billing_address, T.nilable(Inttegro::Order::Address), default: nil
  const :shipping_address, T.nilable(Inttegro::Order::Address), 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) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/order/customer.rb', line 60

class Customer < T::Struct
  const :id, String
  const :guest, T::Boolean
  const :name, String
  const :email_address, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :billing_address, T.nilable(Inttegro::Order::Address), default: nil
  const :shipping_address, T.nilable(Inttegro::Order::Address), 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) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/order/customer.rb', line 60

class Customer < T::Struct
  const :id, String
  const :guest, T::Boolean
  const :name, String
  const :email_address, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :billing_address, T.nilable(Inttegro::Order::Address), default: nil
  const :shipping_address, T.nilable(Inttegro::Order::Address), 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) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/order/customer.rb', line 60

class Customer < T::Struct
  const :id, String
  const :guest, T::Boolean
  const :name, String
  const :email_address, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :billing_address, T.nilable(Inttegro::Order::Address), default: nil
  const :shipping_address, T.nilable(Inttegro::Order::Address), default: nil
end

#shipping_address ⇒ Inttegro::Order::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:



60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/order/customer.rb', line 60

class Customer < T::Struct
  const :id, String
  const :guest, T::Boolean
  const :name, String
  const :email_address, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :billing_address, T.nilable(Inttegro::Order::Address), default: nil
  const :shipping_address, T.nilable(Inttegro::Order::Address), default: nil
end