Class: PaysecureApiDocumentationLive::Client1

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/paysecure_api_documentation_live/models/client1.rb

Overview

Client1 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(customer_id:, email:, phone:, street_address:, country:, city:, zip_code:, cc:, bcc:, state_code:, additional_properties: nil) ⇒ Client1

Returns a new instance of Client1.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 78

def initialize(customer_id:, email:, phone:, street_address:, country:,
               city:, zip_code:, cc:, bcc:, state_code:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @customer_id = customer_id
  @email = email
  @phone = phone
  @street_address = street_address
  @country = country
  @city = city
  @zip_code = zip_code
  @cc = cc
  @bcc = bcc
  @state_code = state_code
  @additional_properties = additional_properties
end

Instance Attribute Details

#bcc ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


46
47
48
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 46

def bcc
  @bcc
end

#cc ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


42
43
44
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 42

def cc
  @cc
end

#city ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


34
35
36
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 34

def city
  @city
end

#country ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 30

def country
  @country
end

#customer_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 14

def customer_id
  @customer_id
end

#email ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 18

def email
  @email
end

#phone ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


22
23
24
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 22

def phone
  @phone
end

#state_code ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


50
51
52
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 50

def state_code
  @state_code
end

#street_address ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 26

def street_address
  @street_address
end

#zip_code ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


38
39
40
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 38

def zip_code
  @zip_code
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 98

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  customer_id = hash.key?('customerId') ? hash['customerId'] : nil
  email = hash.key?('email') ? hash['email'] : nil
  phone = hash.key?('phone') ? hash['phone'] : nil
  street_address =
    hash.key?('street_address') ? hash['street_address'] : nil
  country = hash.key?('country') ? hash['country'] : nil
  city = hash.key?('city') ? hash['city'] : nil
  zip_code = hash.key?('zip_code') ? hash['zip_code'] : nil
  cc = hash.key?('cc') ? hash['cc'] : nil
  bcc = hash.key?('bcc') ? hash['bcc'] : nil
  state_code = hash.key?('stateCode') ? hash['stateCode'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Client1.new(customer_id: customer_id,
              email: email,
              phone: phone,
              street_address: street_address,
              country: country,
              city: city,
              zip_code: zip_code,
              cc: cc,
              bcc: bcc,
              state_code: state_code,
              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 53

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['customer_id'] = 'customerId'
  @_hash['email'] = 'email'
  @_hash['phone'] = 'phone'
  @_hash['street_address'] = 'street_address'
  @_hash['country'] = 'country'
  @_hash['city'] = 'city'
  @_hash['zip_code'] = 'zip_code'
  @_hash['cc'] = 'cc'
  @_hash['bcc'] = 'bcc'
  @_hash['state_code'] = 'stateCode'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



74
75
76
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 74

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



69
70
71
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 69

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



145
146
147
148
149
150
151
152
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 145

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} customer_id: #{@customer_id.inspect}, email: #{@email.inspect}, phone:"\
  " #{@phone.inspect}, street_address: #{@street_address.inspect}, country:"\
  " #{@country.inspect}, city: #{@city.inspect}, zip_code: #{@zip_code.inspect}, cc:"\
  " #{@cc.inspect}, bcc: #{@bcc.inspect}, state_code: #{@state_code.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



136
137
138
139
140
141
142
 
# File 'lib/paysecure_api_documentation_live/models/client1.rb', line 136

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} customer_id: #{@customer_id}, email: #{@email}, phone: #{@phone},"\
  " street_address: #{@street_address}, country: #{@country}, city: #{@city}, zip_code:"\
  " #{@zip_code}, cc: #{@cc}, bcc: #{@bcc}, state_code: #{@state_code}, additional_properties:"\
  " #{@additional_properties}>"
end