Class: XeroRuby::AppStore::Product

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/app_store/product.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Product

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
110
111
112
113
114
115
116
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 84

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

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

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

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

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

Instance Attribute Details

#id ⇒ Object

The unique identifier for the product



20
21
22
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 20

def id
  @id
end

#name ⇒ Object

The name of the product



23
24
25
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 23

def name
  @name
end

#seat_unit ⇒ Object

The unit of the per seat product. e.g. "user", "organisation", "SMS", etc



26
27
28
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 26

def seat_unit
  @seat_unit
end

#type ⇒ Object

The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase * METERED: Customers are charged per use of this product * SIMPLE: Customers are charged on a fixed amount for each billing period with an optional add-on feature



29
30
31
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 29

def type
  @type
end

#usage_unit ⇒ Object

The unit of the usage product. e.g. "user", "minutes", "SMS", etc



36
37
38
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 36

def usage_unit
  @usage_unit
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 61

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'seat_unit' => :'seatUnit',
    :'type' => :'type',
    :'usage_unit' => :'usageUnit'
  }
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



170
171
172
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 170

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 72

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'seat_unit' => :'String',
    :'type' => :'String',
    :'usage_unit' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      seat_unit == o.seat_unit &&
      type == o.type &&
      usage_unit == o.usage_unit
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



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
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 198

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::AppStore.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 271

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 177

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


157
158
159
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 163

def hash
  [id, name, seat_unit, type, usage_unit].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



120
121
122
123
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 287

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributes ⇒ Object

Returns the object in the form of hash with snake_case



263
264
265
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 263

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 245

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 251

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



239
240
241
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 239

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



127
128
129
130
131
 
# File 'lib/xero-ruby/models/app_store/product.rb', line 127

def valid?
  type_validator = EnumAttributeValidator.new('String', ["FIXED", "PER_SEAT", "METERED", "SIMPLE"])
  return false unless type_validator.valid?(@type)
  true
end