Class: UltracartClient::CartCustomerProfile

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/cart_customer_profile.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CartCustomerProfile

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
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
196
197
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
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 141

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'allow_3rd_party_billing')
    self.allow_3rd_party_billing = attributes[:'allow_3rd_party_billing']
  end

  if attributes.has_key?(:'allow_cod')
    self.allow_cod = attributes[:'allow_cod']
  end

  if attributes.has_key?(:'allow_purchase_order')
    self.allow_purchase_order = attributes[:'allow_purchase_order']
  end

  if attributes.has_key?(:'billing_addresses')
    if (value = attributes[:'billing_addresses']).is_a?(Array)
      self.billing_addresses = value
    end
  end

  if attributes.has_key?(:'credit_cards')
    if (value = attributes[:'credit_cards']).is_a?(Array)
      self.credit_cards = value
    end
  end

  if attributes.has_key?(:'customer_profile_oid')
    self.customer_profile_oid = attributes[:'customer_profile_oid']
  end

  if attributes.has_key?(:'dhl_account_number')
    self. = attributes[:'dhl_account_number']
  end

  if attributes.has_key?(:'dhl_duty_account_number')
    self. = attributes[:'dhl_duty_account_number']
  end

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'fedex_account_number')
    self. = attributes[:'fedex_account_number']
  end

  if attributes.has_key?(:'free_shipping')
    self.free_shipping = attributes[:'free_shipping']
  end

  if attributes.has_key?(:'free_shipping_minimum')
    self.free_shipping_minimum = attributes[:'free_shipping_minimum']
  end

  if attributes.has_key?(:'maximum_item_count')
    self.maximum_item_count = attributes[:'maximum_item_count']
  end

  if attributes.has_key?(:'minimum_item_count')
    self.minimum_item_count = attributes[:'minimum_item_count']
  end

  if attributes.has_key?(:'minimum_subtotal')
    self.minimum_subtotal = attributes[:'minimum_subtotal']
  end

  if attributes.has_key?(:'no_coupons')
    self.no_coupons = attributes[:'no_coupons']
  end

  if attributes.has_key?(:'no_free_shipping')
    self.no_free_shipping = attributes[:'no_free_shipping']
  end

  if attributes.has_key?(:'no_realtime_charge')
    self.no_realtime_charge = attributes[:'no_realtime_charge']
  end

  if attributes.has_key?(:'pricing_tiers')
    if (value = attributes[:'pricing_tiers']).is_a?(Array)
      self.pricing_tiers = value
    end
  end

  if attributes.has_key?(:'shipping_addresses')
    if (value = attributes[:'shipping_addresses']).is_a?(Array)
      self.shipping_addresses = value
    end
  end

  if attributes.has_key?(:'tax_exempt')
    self.tax_exempt = attributes[:'tax_exempt']
  end

  if attributes.has_key?(:'ups_account_number')
    self. = attributes[:'ups_account_number']
  end
end

Instance Attribute Details

#allow_3rd_party_billing ⇒ Object

True if profile is allowed to bill to their 3rd party shipping account



18
19
20
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 18

def allow_3rd_party_billing
  @allow_3rd_party_billing
end

#allow_cod ⇒ Object

True if this profile is allowed to use a COD



21
22
23
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 21

def allow_cod
  @allow_cod
end

#allow_purchase_order ⇒ Object

True if this profile is allowed to use a purchase order



24
25
26
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 24

def allow_purchase_order
  @allow_purchase_order
end

#billing_addresses ⇒ Object

Billing addresses on file for this profile



27
28
29
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 27

def billing_addresses
  @billing_addresses
end

#credit_cards ⇒ Object

Credit cards on file for this profile (masked)



30
31
32
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 30

def credit_cards
  @credit_cards
end

#customer_profile_oid ⇒ Object

Unique identifier



33
34
35
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 33

def customer_profile_oid
  @customer_profile_oid
end

#dhl_account_number ⇒ Object

DHL account number on file



36
37
38
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 36

def 
  @dhl_account_number
end

#dhl_duty_account_number ⇒ Object

DHL duty account number on file



39
40
41
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 39

def 
  @dhl_duty_account_number
end

#email ⇒ Object

Email



42
43
44
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 42

def email
  @email
end

#fedex_account_number ⇒ Object

FedEx account number on file



45
46
47
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 45

def 
  @fedex_account_number
end

#free_shipping ⇒ Object

True if this profile always qualifies for free shipping



48
49
50
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 48

def free_shipping
  @free_shipping
end

#free_shipping_minimum ⇒ Object

The minimum aount that this profile has to purchase to qualify for free shipping



51
52
53
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 51

def free_shipping_minimum
  @free_shipping_minimum
end

#maximum_item_count ⇒ Object

Maximum item count this profile can purchase



54
55
56
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 54

def maximum_item_count
  @maximum_item_count
end

#minimum_item_count ⇒ Object

Minimum item count this profile must purchase



57
58
59
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 57

def minimum_item_count
  @minimum_item_count
end

#minimum_subtotal ⇒ Object

Minimum subtotal this profile must purchase



60
61
62
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 60

def minimum_subtotal
  @minimum_subtotal
end

#no_coupons ⇒ Object

True if this profile is prevented from using coupons



63
64
65
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 63

def no_coupons
  @no_coupons
end

#no_free_shipping ⇒ Object

True if this profile is never given free shipping



66
67
68
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 66

def no_free_shipping
  @no_free_shipping
end

#no_realtime_charge ⇒ Object

True if this customers orders are not charged in real-time



69
70
71
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 69

def no_realtime_charge
  @no_realtime_charge
end

#pricing_tiers ⇒ Object

Pricing tier names this profile qualifies for



72
73
74
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 72

def pricing_tiers
  @pricing_tiers
end

#shipping_addresses ⇒ Object

Shipping addresses on file for this profile



75
76
77
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 75

def shipping_addresses
  @shipping_addresses
end

#tax_exempt ⇒ Object

True if this profile is exempt from sales tax



78
79
80
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 78

def tax_exempt
  @tax_exempt
end

#ups_account_number ⇒ Object

UPS account number on file



81
82
83
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 81

def 
  @ups_account_number
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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

def self.attribute_map
  {
    :'allow_3rd_party_billing' => :'allow_3rd_party_billing',
    :'allow_cod' => :'allow_cod',
    :'allow_purchase_order' => :'allow_purchase_order',
    :'billing_addresses' => :'billing_addresses',
    :'credit_cards' => :'credit_cards',
    :'customer_profile_oid' => :'customer_profile_oid',
    :'dhl_account_number' => :'dhl_account_number',
    :'dhl_duty_account_number' => :'dhl_duty_account_number',
    :'email' => :'email',
    :'fedex_account_number' => :'fedex_account_number',
    :'free_shipping' => :'free_shipping',
    :'free_shipping_minimum' => :'free_shipping_minimum',
    :'maximum_item_count' => :'maximum_item_count',
    :'minimum_item_count' => :'minimum_item_count',
    :'minimum_subtotal' => :'minimum_subtotal',
    :'no_coupons' => :'no_coupons',
    :'no_free_shipping' => :'no_free_shipping',
    :'no_realtime_charge' => :'no_realtime_charge',
    :'pricing_tiers' => :'pricing_tiers',
    :'shipping_addresses' => :'shipping_addresses',
    :'tax_exempt' => :'tax_exempt',
    :'ups_account_number' => :'ups_account_number'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 112

def self.swagger_types
  {
    :'allow_3rd_party_billing' => :'BOOLEAN',
    :'allow_cod' => :'BOOLEAN',
    :'allow_purchase_order' => :'BOOLEAN',
    :'billing_addresses' => :'Array<CartCustomerProfileAddress>',
    :'credit_cards' => :'Array<CartCustomerProfileCreditCard>',
    :'customer_profile_oid' => :'Integer',
    :'dhl_account_number' => :'String',
    :'dhl_duty_account_number' => :'String',
    :'email' => :'String',
    :'fedex_account_number' => :'String',
    :'free_shipping' => :'BOOLEAN',
    :'free_shipping_minimum' => :'Float',
    :'maximum_item_count' => :'Integer',
    :'minimum_item_count' => :'Integer',
    :'minimum_subtotal' => :'Float',
    :'no_coupons' => :'BOOLEAN',
    :'no_free_shipping' => :'BOOLEAN',
    :'no_realtime_charge' => :'BOOLEAN',
    :'pricing_tiers' => :'Array<String>',
    :'shipping_addresses' => :'Array<CartCustomerProfileAddress>',
    :'tax_exempt' => :'BOOLEAN',
    :'ups_account_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 259

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_3rd_party_billing == o.allow_3rd_party_billing &&
      allow_cod == o.allow_cod &&
      allow_purchase_order == o.allow_purchase_order &&
      billing_addresses == o.billing_addresses &&
      credit_cards == o.credit_cards &&
      customer_profile_oid == o.customer_profile_oid &&
       == o. &&
       == o. &&
      email == o.email &&
       == o. &&
      free_shipping == o.free_shipping &&
      free_shipping_minimum == o.free_shipping_minimum &&
      maximum_item_count == o.maximum_item_count &&
      minimum_item_count == o.minimum_item_count &&
      minimum_subtotal == o.minimum_subtotal &&
      no_coupons == o.no_coupons &&
      no_free_shipping == o.no_free_shipping &&
      no_realtime_charge == o.no_realtime_charge &&
      pricing_tiers == o.pricing_tiers &&
      shipping_addresses == o.shipping_addresses &&
      tax_exempt == o.tax_exempt &&
       == o.
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 322

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 388

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 301

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


288
289
290
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 288

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



294
295
296
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 294

def hash
  [allow_3rd_party_billing, allow_cod, allow_purchase_order, billing_addresses, credit_cards, customer_profile_oid, , , email, , free_shipping, free_shipping_minimum, maximum_item_count, minimum_item_count, minimum_subtotal, no_coupons, no_free_shipping, no_realtime_charge, pricing_tiers, shipping_addresses, tax_exempt, ].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



246
247
248
249
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 246

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



368
369
370
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 368

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



374
375
376
377
378
379
380
381
382
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 374

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



362
363
364
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 362

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



253
254
255
 
# File 'lib/ultracart_api/models/cart_customer_profile.rb', line 253

def valid?
  true
end