Class: Inttegro::Customer::Data

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

Overview

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

#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:



49
50
51
52
53
54
55
 
# File 'lib/inttegro/customer/data.rb', line 49

class Data < T::Struct
  const :name, String
  const :email_address, String
  const :phone_number, String
  const :reference, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
end

#email_address ⇒ String (readonly)

Customer's email address

Required in the API payload. Wire name: email_address.

Returns:

  • (String) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/customer/data.rb', line 49

class Data < T::Struct
  const :name, String
  const :email_address, String
  const :phone_number, String
  const :reference, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
end

#name ⇒ String (readonly)

Customer's full name

Required in the API payload. Wire name: name.

Returns:

  • (String) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/customer/data.rb', line 49

class Data < T::Struct
  const :name, String
  const :email_address, String
  const :phone_number, String
  const :reference, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
end

#phone_number ⇒ String (readonly)

Customer's phone number

Required in the API payload. Wire name: phone_number.

Returns:

  • (String) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/customer/data.rb', line 49

class Data < T::Struct
  const :name, String
  const :email_address, String
  const :phone_number, String
  const :reference, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
end

#reference ⇒ String? (readonly)

External reference ID for the customer

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

Returns:

  • (String, nil) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/customer/data.rb', line 49

class Data < T::Struct
  const :name, String
  const :email_address, String
  const :phone_number, String
  const :reference, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
end