Class: AdvancedBilling::PayerAttributes

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/advanced_billing/models/payer_attributes.rb

Overview

PayerAttributes Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(first_name: SKIP, last_name: SKIP, email: SKIP, cc_emails: SKIP, organization: SKIP, reference: SKIP, address: SKIP, address_2: SKIP, city: SKIP, state: SKIP, zip: SKIP, country: SKIP, phone: SKIP, locale: SKIP, vat_number: SKIP, tax_exempt: SKIP, tax_exempt_reason: SKIP, metafields: SKIP, additional_properties: {}) ⇒ PayerAttributes

Returns a new instance of PayerAttributes.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 139

def initialize(first_name: SKIP, last_name: SKIP, email: SKIP,
               cc_emails: SKIP, organization: SKIP, reference: SKIP,
               address: SKIP, address_2: SKIP, city: SKIP, state: SKIP,
               zip: SKIP, country: SKIP, phone: SKIP, locale: SKIP,
               vat_number: SKIP, tax_exempt: SKIP, tax_exempt_reason: SKIP,
               metafields: SKIP, additional_properties: {})
  @first_name = first_name unless first_name == SKIP
  @last_name = last_name unless last_name == SKIP
  @email = email unless email == SKIP
  @cc_emails = cc_emails unless cc_emails == SKIP
  @organization = organization unless organization == SKIP
  @reference = reference unless reference == SKIP
  @address = address unless address == SKIP
  @address_2 = address_2 unless address_2 == SKIP
  @city = city unless city == SKIP
  @state = state unless state == SKIP
  @zip = zip unless zip == SKIP
  @country = country unless country == SKIP
  @phone = phone unless phone == SKIP
  @locale = locale unless locale == SKIP
  @vat_number = vat_number unless vat_number == SKIP
  @tax_exempt = tax_exempt unless tax_exempt == SKIP
  @tax_exempt_reason = tax_exempt_reason unless tax_exempt_reason == SKIP
  @metafields = metafields unless metafields == SKIP

  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end
end

Instance Attribute Details

#address ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


38
39
40
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 38

def address
  @address
end

#address_2 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


42
43
44
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 42

def address_2
  @address_2
end

#cc_emails ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 26

def cc_emails
  @cc_emails
end

#city ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


46
47
48
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 46

def city
  @city
end

#country ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


58
59
60
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 58

def country
  @country
end

#email ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


22
23
24
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 22

def email
  @email
end

#first_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 14

def first_name
  @first_name
end

#last_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 18

def last_name
  @last_name
end

#locale ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


66
67
68
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 66

def locale
  @locale
end

#metafields ⇒ Hash[String, String]

(Optional) A set of key/value pairs representing custom fields and their values. Metafields will be created “on-the-fly” in your site for a given key, if they have not been created yet.

Returns:

  • (Hash[String, String]) 


84
85
86
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 84

def metafields
  @metafields
end

#organization ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 30

def organization
  @organization
end

#phone ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


62
63
64
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 62

def phone
  @phone
end

#reference ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


34
35
36
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 34

def reference
  @reference
end

#state ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


50
51
52
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 50

def state
  @state
end

#tax_exempt ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


74
75
76
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 74

def tax_exempt
  @tax_exempt
end

#tax_exempt_reason ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


78
79
80
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 78

def tax_exempt_reason
  @tax_exempt_reason
end

#vat_number ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


70
71
72
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 70

def vat_number
  @vat_number
end

#zip ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


54
55
56
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 54

def zip
  @zip
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 171

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
  last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
  email = hash.key?('email') ? hash['email'] : SKIP
  cc_emails = hash.key?('cc_emails') ? hash['cc_emails'] : SKIP
  organization = hash.key?('organization') ? hash['organization'] : SKIP
  reference = hash.key?('reference') ? hash['reference'] : SKIP
  address = hash.key?('address') ? hash['address'] : SKIP
  address_2 = hash.key?('address_2') ? hash['address_2'] : SKIP
  city = hash.key?('city') ? hash['city'] : SKIP
  state = hash.key?('state') ? hash['state'] : SKIP
  zip = hash.key?('zip') ? hash['zip'] : SKIP
  country = hash.key?('country') ? hash['country'] : SKIP
  phone = hash.key?('phone') ? hash['phone'] : SKIP
  locale = hash.key?('locale') ? hash['locale'] : SKIP
  vat_number = hash.key?('vat_number') ? hash['vat_number'] : SKIP
  tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : SKIP
  tax_exempt_reason =
    hash.key?('tax_exempt_reason') ? hash['tax_exempt_reason'] : SKIP
  metafields = hash.key?('metafields') ? hash['metafields'] : SKIP

  # Clean out expected properties from Hash.
  names.each_value { |k| hash.delete(k) }

  # Create object from extracted values.
  PayerAttributes.new(first_name: first_name,
                      last_name: last_name,
                      email: email,
                      cc_emails: cc_emails,
                      organization: organization,
                      reference: reference,
                      address: address,
                      address_2: address_2,
                      city: city,
                      state: state,
                      zip: zip,
                      country: country,
                      phone: phone,
                      locale: locale,
                      vat_number: vat_number,
                      tax_exempt: tax_exempt,
                      tax_exempt_reason: tax_exempt_reason,
                      metafields: metafields,
                      additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 87

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['first_name'] = 'first_name'
  @_hash['last_name'] = 'last_name'
  @_hash['email'] = 'email'
  @_hash['cc_emails'] = 'cc_emails'
  @_hash['organization'] = 'organization'
  @_hash['reference'] = 'reference'
  @_hash['address'] = 'address'
  @_hash['address_2'] = 'address_2'
  @_hash['city'] = 'city'
  @_hash['state'] = 'state'
  @_hash['zip'] = 'zip'
  @_hash['country'] = 'country'
  @_hash['phone'] = 'phone'
  @_hash['locale'] = 'locale'
  @_hash['vat_number'] = 'vat_number'
  @_hash['tax_exempt'] = 'tax_exempt'
  @_hash['tax_exempt_reason'] = 'tax_exempt_reason'
  @_hash['metafields'] = 'metafields'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



135
136
137
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 135

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 111

def self.optionals
  %w[
    first_name
    last_name
    email
    cc_emails
    organization
    reference
    address
    address_2
    city
    state
    zip
    country
    phone
    locale
    vat_number
    tax_exempt
    tax_exempt_reason
    metafields
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (PayerAttributes | Hash) —

    value against the validation is performed.



222
223
224
225
226
227
228
 
# File 'lib/advanced_billing/models/payer_attributes.rb', line 222

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end