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



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 140

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ItemShippingMethod` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ItemShippingMethod`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'cost')
    self.cost = attributes[:'cost']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cost ⇒ Object

Cost



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

def cost
  @cost
end

#each_additional_item_markup ⇒ Object

Each additional item markup



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

def each_additional_item_markup
  @each_additional_item_markup
end

#filter_to_if_available ⇒ Object

Filter to this method if available



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

def filter_to_if_available
  @filter_to_if_available
end

#first_item_markup ⇒ Object

First item markup



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

def first_item_markup
  @first_item_markup
end

#fixed_shipping_cost ⇒ Object

Fixed shipping cost



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

def fixed_shipping_cost
  @fixed_shipping_cost
end

#flat_fee_markup ⇒ Object

Flat fee markup



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

def flat_fee_markup
  @flat_fee_markup
end

#free_shipping ⇒ Object

Free shipping



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

def free_shipping
  @free_shipping
end

#per_item_fee_markup ⇒ Object

Per item fee markup



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

def per_item_fee_markup
  @per_item_fee_markup
end

#percentage_markup ⇒ Object

Percentage markup



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

def percentage_markup
  @percentage_markup
end

#percentage_of_item_markup ⇒ Object

Percentage of item markup



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

def percentage_of_item_markup
  @percentage_of_item_markup
end

#relax_restrictions_on_upsell ⇒ Object

Relax restrictions on upsell



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

def relax_restrictions_on_upsell
  @relax_restrictions_on_upsell
end

#shipping_method ⇒ Object

Shipping method name



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

def shipping_method
  @shipping_method
end

#shipping_method_oid ⇒ Object

Shipping method object identifier



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

def shipping_method_oid
  @shipping_method_oid
end

#shipping_method_validity ⇒ Object

Shipping method validity



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

def shipping_method_validity
  @shipping_method_validity
end

#signature_required ⇒ Object

Signature required



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

def signature_required
  @signature_required
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.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



276
277
278
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 276

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 133

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 241

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 307

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 378

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 283

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


263
264
265
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



269
270
271
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 269

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



216
217
218
219
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 216

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



354
355
356
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 360

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



348
349
350
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 348

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



223
224
225
226
227
 
# File 'lib/ultracart_api/models/item_shipping_method.rb', line 223

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