Class: BillingApi::LocationAvailabilityDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_billing_api/models/location_availability_detail.rb

Overview

Info about location, solutions and availability for a product.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LocationAvailabilityDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `BillingApi::LocationAvailabilityDetail` 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 `BillingApi::LocationAvailabilityDetail`. 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?(:'location')
    self.location = attributes[:'location']
  else
    self.location = nil
  end

  if attributes.key?(:'min_quantity_requested')
    self.min_quantity_requested = attributes[:'min_quantity_requested']
  else
    self.min_quantity_requested = nil
  end

  if attributes.key?(:'min_quantity_available')
    self.min_quantity_available = attributes[:'min_quantity_available']
  else
    self.min_quantity_available = nil
  end

  if attributes.key?(:'available_quantity')
    self.available_quantity = attributes[:'available_quantity']
  else
    self.available_quantity = nil
  end

  if attributes.key?(:'solutions')
    if (value = attributes[:'solutions']).is_a?(Array)
      self.solutions = value
    end
  else
    self.solutions = nil
  end
end

Instance Attribute Details

#available_quantity ⇒ Object

Total available quantity of product in specific location. Max value is 10.



28
29
30
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 28

def available_quantity
  @available_quantity
end

#location ⇒ Object

Returns the value of attribute location.



19
20
21
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 19

def location
  @location
end

#min_quantity_available ⇒ Object

Is product available in specific location for requested quantity



25
26
27
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 25

def min_quantity_available
  @min_quantity_available
end

#min_quantity_requested ⇒ Object

Requested quantity.



22
23
24
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 22

def min_quantity_requested
  @min_quantity_requested
end

#solutions ⇒ Object

Solutions supported in specific location for a product.



31
32
33
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 31

def solutions
  @solutions
end

Class Method Details

._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



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
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 227

def self._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 = BillingApi.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 56

def self.attribute_map
  {
    :'location' => :'location',
    :'min_quantity_requested' => :'minQuantityRequested',
    :'min_quantity_available' => :'minQuantityAvailable',
    :'available_quantity' => :'availableQuantity',
    :'solutions' => :'solutions'
  }
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 203

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 72

def self.openapi_types
  {
    :'location' => :'LocationEnum',
    :'min_quantity_requested' => :'Float',
    :'min_quantity_available' => :'Boolean',
    :'available_quantity' => :'Float',
    :'solutions' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      location == o.location &&
      min_quantity_requested == o.min_quantity_requested &&
      min_quantity_available == o.min_quantity_available &&
      available_quantity == o.available_quantity &&
      solutions == o.solutions
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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 298

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



196
197
198
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 196

def hash
  [location, min_quantity_requested, min_quantity_available, available_quantity, solutions].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



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
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 138

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @location.nil?
    invalid_properties.push('invalid value for "location", location cannot be nil.')
  end

  if @min_quantity_requested.nil?
    invalid_properties.push('invalid value for "min_quantity_requested", min_quantity_requested cannot be nil.')
  end

  if @min_quantity_available.nil?
    invalid_properties.push('invalid value for "min_quantity_available", min_quantity_available cannot be nil.')
  end

  if @available_quantity.nil?
    invalid_properties.push('invalid value for "available_quantity", available_quantity cannot be nil.')
  end

  if @solutions.nil?
    invalid_properties.push('invalid value for "solutions", solutions cannot be nil.')
  end

  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



274
275
276
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 274

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 280

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



268
269
270
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 268

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



166
167
168
169
170
171
172
173
174
 
# File 'lib/pnap_billing_api/models/location_availability_detail.rb', line 166

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @location.nil?
  return false if @min_quantity_requested.nil?
  return false if @min_quantity_available.nil?
  return false if @available_quantity.nil?
  return false if @solutions.nil?
  true
end