Class: UltracartClient::ItemShippingMethod

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemShippingMethod

Initializes the object

Parameters:

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

    Model attributes in the form of hash



128
129
130
131
132
133
134
135
136
137
138
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
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
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 128

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?(:'cost')
    self.cost = attributes[:'cost']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cost ⇒ Object

Cost



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

def cost
  @cost
end

#each_additional_item_markup ⇒ Object

Each additional item markup



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

def each_additional_item_markup
  @each_additional_item_markup
end

#filter_to_if_available ⇒ Object

Filter to this method if available



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

def filter_to_if_available
  @filter_to_if_available
end

#first_item_markup ⇒ Object

First item markup



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

def first_item_markup
  @first_item_markup
end

#fixed_shipping_cost ⇒ Object

Fixed shipping cost



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

def fixed_shipping_cost
  @fixed_shipping_cost
end

#flat_fee_markup ⇒ Object

Flat fee markup



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

def flat_fee_markup
  @flat_fee_markup
end

#free_shipping ⇒ Object

Free shipping



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

def free_shipping
  @free_shipping
end

#per_item_fee_markup ⇒ Object

Per item fee markup



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

def per_item_fee_markup
  @per_item_fee_markup
end

#percentage_markup ⇒ Object

Percentage markup



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

def percentage_markup
  @percentage_markup
end

#percentage_of_item_markup ⇒ Object

Percentage of item markup



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

def percentage_of_item_markup
  @percentage_of_item_markup
end

#relax_restrictions_on_upsell ⇒ Object

Relax restrictions on upsell



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

def relax_restrictions_on_upsell
  @relax_restrictions_on_upsell
end

#shipping_method ⇒ Object

Shipping method name



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

def shipping_method
  @shipping_method
end

#shipping_method_oid ⇒ Object

Shipping method object identifier



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

def shipping_method_oid
  @shipping_method_oid
end

#shipping_method_validity ⇒ Object

Shipping method validity



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

def shipping_method_validity
  @shipping_method_validity
end

#signature_required ⇒ Object

Signature required



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

def signature_required
  @signature_required
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 85

def self.attribute_map
  {
    :'cost' => :'cost',
    :'each_additional_item_markup' => :'each_additional_item_markup',
    :'filter_to_if_available' => :'filter_to_if_available',
    :'first_item_markup' => :'first_item_markup',
    :'fixed_shipping_cost' => :'fixed_shipping_cost',
    :'flat_fee_markup' => :'flat_fee_markup',
    :'free_shipping' => :'free_shipping',
    :'per_item_fee_markup' => :'per_item_fee_markup',
    :'percentage_markup' => :'percentage_markup',
    :'percentage_of_item_markup' => :'percentage_of_item_markup',
    :'relax_restrictions_on_upsell' => :'relax_restrictions_on_upsell',
    :'shipping_method' => :'shipping_method',
    :'shipping_method_oid' => :'shipping_method_oid',
    :'shipping_method_validity' => :'shipping_method_validity',
    :'signature_required' => :'signature_required'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 106

def self.swagger_types
  {
    :'cost' => :'Float',
    :'each_additional_item_markup' => :'Float',
    :'filter_to_if_available' => :'BOOLEAN',
    :'first_item_markup' => :'Float',
    :'fixed_shipping_cost' => :'Float',
    :'flat_fee_markup' => :'Float',
    :'free_shipping' => :'BOOLEAN',
    :'per_item_fee_markup' => :'Float',
    :'percentage_markup' => :'Float',
    :'percentage_of_item_markup' => :'Float',
    :'relax_restrictions_on_upsell' => :'BOOLEAN',
    :'shipping_method' => :'String',
    :'shipping_method_oid' => :'Integer',
    :'shipping_method_validity' => :'String',
    :'signature_required' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cost == o.cost &&
      each_additional_item_markup == o.each_additional_item_markup &&
      filter_to_if_available == o.filter_to_if_available &&
      first_item_markup == o.first_item_markup &&
      fixed_shipping_cost == o.fixed_shipping_cost &&
      flat_fee_markup == o.flat_fee_markup &&
      free_shipping == o.free_shipping &&
      per_item_fee_markup == o.per_item_fee_markup &&
      percentage_markup == o.percentage_markup &&
      percentage_of_item_markup == o.percentage_of_item_markup &&
      relax_restrictions_on_upsell == o.relax_restrictions_on_upsell &&
      shipping_method == o.shipping_method &&
      shipping_method_oid == o.shipping_method_oid &&
      shipping_method_validity == o.shipping_method_validity &&
      signature_required == o.signature_required
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 278

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 344

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 257

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


244
245
246
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



250
251
252
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 250

def hash
  [cost, each_additional_item_markup, filter_to_if_available, first_item_markup, fixed_shipping_cost, flat_fee_markup, free_shipping, per_item_fee_markup, percentage_markup, percentage_of_item_markup, relax_restrictions_on_upsell, shipping_method, shipping_method_oid, shipping_method_validity, signature_required].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



197
198
199
200
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 197

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



324
325
326
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 324

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



330
331
332
333
334
335
336
337
338
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 330

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



318
319
320
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 318

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



204
205
206
207
208
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 204

def valid?
  shipping_method_validity_validator = EnumAttributeValidator.new('String', ['invalid for', 'valid for', 'valid only for'])
  return false unless shipping_method_validity_validator.valid?(@shipping_method_validity)
  true
end