Class: Inttegro::Customer::CreateRequest

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

Overview

Typed representation of the create request 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::Customer::AddressInput? (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:



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/inttegro/customer/create_request.rb', line 68

class CreateRequest < T::Struct
  const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :email_address, T.nilable(String), default: nil
  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::AddressInput), default: nil
  const :title, T.nilable(String), default: nil
end

#custom_data ⇒ Inttegro::CustomDataInput? (readonly)

Merchant-defined values accepted on resource creation. Values are serialized to strings before storage.

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

Returns:



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/inttegro/customer/create_request.rb', line 68

class CreateRequest < T::Struct
  const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :email_address, T.nilable(String), default: nil
  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::AddressInput), default: nil
  const :title, T.nilable(String), 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) 


68
69
70
71
72
73
74
75
76
77
 
# File 'lib/inttegro/customer/create_request.rb', line 68

class CreateRequest < T::Struct
  const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :email_address, T.nilable(String), default: nil
  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::AddressInput), default: nil
  const :title, T.nilable(String), 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) 


68
69
70
71
72
73
74
75
76
77
 
# File 'lib/inttegro/customer/create_request.rb', line 68

class CreateRequest < T::Struct
  const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :email_address, T.nilable(String), default: nil
  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::AddressInput), default: nil
  const :title, 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) 


68
69
70
71
72
73
74
75
76
77
 
# File 'lib/inttegro/customer/create_request.rb', line 68

class CreateRequest < T::Struct
  const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :email_address, T.nilable(String), default: nil
  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::AddressInput), default: nil
  const :title, T.nilable(String), 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) 


68
69
70
71
72
73
74
75
76
77
 
# File 'lib/inttegro/customer/create_request.rb', line 68

class CreateRequest < T::Struct
  const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :email_address, T.nilable(String), default: nil
  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::AddressInput), default: nil
  const :title, T.nilable(String), default: nil
end

#shipping_address ⇒ Inttegro::Customer::AddressInput? (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:



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/inttegro/customer/create_request.rb', line 68

class CreateRequest < T::Struct
  const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :email_address, T.nilable(String), default: nil
  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::AddressInput), default: nil
  const :title, T.nilable(String), 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) 


68
69
70
71
72
73
74
75
76
77
 
# File 'lib/inttegro/customer/create_request.rb', line 68

class CreateRequest < T::Struct
  const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :email_address, T.nilable(String), default: nil
  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::AddressInput), default: nil
  const :title, T.nilable(String), default: nil
end