Class: Inttegro::Customer::AddressInput

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/customer/address_input.rb

Overview

Typed representation of the address input 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

#city ⇒ String? (readonly)

Value of the city field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/customer/address_input.rb', line 65

class AddressInput < T::Struct
  const :city, T.nilable(String), default: nil
  const :country, String
  const :line1, T.nilable(String), default: nil
  const :line2, T.nilable(String), default: nil
  const :name, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :post_code, T.nilable(String), default: nil
  const :region, T.nilable(String), default: nil
end

#country ⇒ String (readonly)

Value of the country field in the Inttegro API payload.

Required in the API payload. Wire name: country.

Returns:

  • (String) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/customer/address_input.rb', line 65

class AddressInput < T::Struct
  const :city, T.nilable(String), default: nil
  const :country, String
  const :line1, T.nilable(String), default: nil
  const :line2, T.nilable(String), default: nil
  const :name, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :post_code, T.nilable(String), default: nil
  const :region, T.nilable(String), default: nil
end

#line1 ⇒ String? (readonly)

Value of the line1 field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/customer/address_input.rb', line 65

class AddressInput < T::Struct
  const :city, T.nilable(String), default: nil
  const :country, String
  const :line1, T.nilable(String), default: nil
  const :line2, T.nilable(String), default: nil
  const :name, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :post_code, T.nilable(String), default: nil
  const :region, T.nilable(String), default: nil
end

#line2 ⇒ String? (readonly)

Value of the line2 field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/customer/address_input.rb', line 65

class AddressInput < T::Struct
  const :city, T.nilable(String), default: nil
  const :country, String
  const :line1, T.nilable(String), default: nil
  const :line2, T.nilable(String), default: nil
  const :name, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :post_code, T.nilable(String), default: nil
  const :region, T.nilable(String), default: nil
end

#name ⇒ String? (readonly)

Value of the name field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/customer/address_input.rb', line 65

class AddressInput < T::Struct
  const :city, T.nilable(String), default: nil
  const :country, String
  const :line1, T.nilable(String), default: nil
  const :line2, T.nilable(String), default: nil
  const :name, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :post_code, T.nilable(String), default: nil
  const :region, T.nilable(String), 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) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/customer/address_input.rb', line 65

class AddressInput < T::Struct
  const :city, T.nilable(String), default: nil
  const :country, String
  const :line1, T.nilable(String), default: nil
  const :line2, T.nilable(String), default: nil
  const :name, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :post_code, T.nilable(String), default: nil
  const :region, T.nilable(String), default: nil
end

#post_code ⇒ String? (readonly)

Value of the post_code field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/customer/address_input.rb', line 65

class AddressInput < T::Struct
  const :city, T.nilable(String), default: nil
  const :country, String
  const :line1, T.nilable(String), default: nil
  const :line2, T.nilable(String), default: nil
  const :name, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :post_code, T.nilable(String), default: nil
  const :region, T.nilable(String), default: nil
end

#region ⇒ String? (readonly)

Value of the region field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/customer/address_input.rb', line 65

class AddressInput < T::Struct
  const :city, T.nilable(String), default: nil
  const :country, String
  const :line1, T.nilable(String), default: nil
  const :line2, T.nilable(String), default: nil
  const :name, T.nilable(String), default: nil
  const :phone_number, T.nilable(String), default: nil
  const :post_code, T.nilable(String), default: nil
  const :region, T.nilable(String), default: nil
end