Class: AdvancedBilling::UpdatedPaymentProfile

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

Overview

UpdatedPaymentProfile Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id = SKIP, first_name = SKIP, last_name = SKIP, card_type = SKIP, expiration_month = SKIP, expiration_year = SKIP, customer_id = SKIP, current_vault = SKIP, vault_token = SKIP, billing_address = SKIP, billing_address_2 = SKIP, billing_city = SKIP, billing_state = SKIP, billing_zip = SKIP, billing_country = SKIP, payment_type = SKIP, site_gateway_setting_id = SKIP, gateway_handle = SKIP, masked_card_number = SKIP, customer_vault_token = SKIP) ⇒ UpdatedPaymentProfile

Returns a new instance of UpdatedPaymentProfile.



165
166
167
168
169
170
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
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 165

def initialize(id = SKIP, first_name = SKIP, last_name = SKIP,
               card_type = SKIP, expiration_month = SKIP,
               expiration_year = SKIP, customer_id = SKIP,
               current_vault = SKIP, vault_token = SKIP,
               billing_address = SKIP, billing_address_2 = SKIP,
               billing_city = SKIP, billing_state = SKIP,
               billing_zip = SKIP, billing_country = SKIP,
               payment_type = SKIP, site_gateway_setting_id = SKIP,
               gateway_handle = SKIP, masked_card_number = SKIP,
               customer_vault_token = SKIP)
  @id = id unless id == SKIP
  @first_name = first_name unless first_name == SKIP
  @last_name = last_name unless last_name == SKIP
  @card_type = card_type unless card_type == SKIP
  @expiration_month = expiration_month unless expiration_month == SKIP
  @expiration_year = expiration_year unless expiration_year == SKIP
  @customer_id = customer_id unless customer_id == SKIP
  @current_vault = current_vault unless current_vault == SKIP
  @vault_token = vault_token unless vault_token == SKIP
  @billing_address = billing_address unless billing_address == SKIP
  @billing_address_2 = billing_address_2 unless billing_address_2 == SKIP
  @billing_city = billing_city unless billing_city == SKIP
  @billing_state = billing_state unless billing_state == SKIP
  @billing_zip = billing_zip unless billing_zip == SKIP
  @billing_country = billing_country unless billing_country == SKIP
  @payment_type = payment_type unless payment_type == SKIP
  @site_gateway_setting_id = site_gateway_setting_id unless site_gateway_setting_id == SKIP
  @gateway_handle = gateway_handle unless gateway_handle == SKIP
  @masked_card_number = masked_card_number unless masked_card_number == SKIP
  @customer_vault_token = customer_vault_token unless customer_vault_token == SKIP
end

Instance Attribute Details

#billing_address ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


53
54
55
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 53

def billing_address
  @billing_address
end

#billing_address_2 ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


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

def billing_address_2
  @billing_address_2
end

#billing_city ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


63
64
65
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 63

def billing_city
  @billing_city
end

#billing_country ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


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

def billing_country
  @billing_country
end

#billing_state ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


68
69
70
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 68

def billing_state
  @billing_state
end

#billing_zip ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


73
74
75
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 73

def billing_zip
  @billing_zip
end

#card_type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def card_type
  @card_type
end

#current_vault ⇒ CurrentVault

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:



43
44
45
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 43

def current_vault
  @current_vault
end

#customer_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def customer_id
  @customer_id
end

#customer_vault_token ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


103
104
105
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 103

def customer_vault_token
  @customer_vault_token
end

#expiration_month ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def expiration_year
  @expiration_year
end

#first_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def first_name
  @first_name
end

#gateway_handle ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


93
94
95
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 93

def gateway_handle
  @gateway_handle
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#last_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def last_name
  @last_name
end

#masked_card_number ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


98
99
100
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 98

def masked_card_number
  @masked_card_number
end

#payment_type ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


83
84
85
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 83

def payment_type
  @payment_type
end

#site_gateway_setting_id ⇒ Integer

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (Integer) 


88
89
90
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 88

def site_gateway_setting_id
  @site_gateway_setting_id
end

#vault_token ⇒ String

The vault that stores the payment profile with the provided ‘vault_token`. Use `bogus` for testing.

Returns:

  • (String) 


48
49
50
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 48

def vault_token
  @vault_token
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 198

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : SKIP
  first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
  last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
  card_type = hash.key?('card_type') ? hash['card_type'] : SKIP
  expiration_month =
    hash.key?('expiration_month') ? hash['expiration_month'] : SKIP
  expiration_year =
    hash.key?('expiration_year') ? hash['expiration_year'] : SKIP
  customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
  current_vault = hash.key?('current_vault') ? hash['current_vault'] : SKIP
  vault_token = hash.key?('vault_token') ? hash['vault_token'] : SKIP
  billing_address =
    hash.key?('billing_address') ? hash['billing_address'] : SKIP
  billing_address_2 =
    hash.key?('billing_address_2') ? hash['billing_address_2'] : SKIP
  billing_city = hash.key?('billing_city') ? hash['billing_city'] : SKIP
  billing_state = hash.key?('billing_state') ? hash['billing_state'] : SKIP
  billing_zip = hash.key?('billing_zip') ? hash['billing_zip'] : SKIP
  billing_country =
    hash.key?('billing_country') ? hash['billing_country'] : SKIP
  payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
  site_gateway_setting_id =
    hash.key?('site_gateway_setting_id') ? hash['site_gateway_setting_id'] : SKIP
  gateway_handle =
    hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
  masked_card_number =
    hash.key?('masked_card_number') ? hash['masked_card_number'] : SKIP
  customer_vault_token =
    hash.key?('customer_vault_token') ? hash['customer_vault_token'] : SKIP

  # Create object from extracted values.
  UpdatedPaymentProfile.new(id,
                            first_name,
                            last_name,
                            card_type,
                            expiration_month,
                            expiration_year,
                            customer_id,
                            current_vault,
                            vault_token,
                            billing_address,
                            billing_address_2,
                            billing_city,
                            billing_state,
                            billing_zip,
                            billing_country,
                            payment_type,
                            site_gateway_setting_id,
                            gateway_handle,
                            masked_card_number,
                            customer_vault_token)
end

.names ⇒ Object

A mapping from model property names to API property names.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 106

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['first_name'] = 'first_name'
  @_hash['last_name'] = 'last_name'
  @_hash['card_type'] = 'card_type'
  @_hash['expiration_month'] = 'expiration_month'
  @_hash['expiration_year'] = 'expiration_year'
  @_hash['customer_id'] = 'customer_id'
  @_hash['current_vault'] = 'current_vault'
  @_hash['vault_token'] = 'vault_token'
  @_hash['billing_address'] = 'billing_address'
  @_hash['billing_address_2'] = 'billing_address_2'
  @_hash['billing_city'] = 'billing_city'
  @_hash['billing_state'] = 'billing_state'
  @_hash['billing_zip'] = 'billing_zip'
  @_hash['billing_country'] = 'billing_country'
  @_hash['payment_type'] = 'payment_type'
  @_hash['site_gateway_setting_id'] = 'site_gateway_setting_id'
  @_hash['gateway_handle'] = 'gateway_handle'
  @_hash['masked_card_number'] = 'masked_card_number'
  @_hash['customer_vault_token'] = 'customer_vault_token'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



158
159
160
161
162
163
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 158

def self.nullables
  %w[
    gateway_handle
    customer_vault_token
  ]
end

.optionals ⇒ Object

An array for optional fields



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/advanced_billing/models/updated_payment_profile.rb', line 132

def self.optionals
  %w[
    id
    first_name
    last_name
    card_type
    expiration_month
    expiration_year
    customer_id
    current_vault
    vault_token
    billing_address
    billing_address_2
    billing_city
    billing_state
    billing_zip
    billing_country
    payment_type
    site_gateway_setting_id
    gateway_handle
    masked_card_number
    customer_vault_token
  ]
end