Class: XeroRuby::AppStore::Subscription

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Subscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 98

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

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

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

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

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

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

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

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

Instance Attribute Details

#current_period_end ⇒ Object

End of the current period that the subscription has been invoiced for.



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

def current_period_end
  @current_period_end
end

#end_date ⇒ Object

If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled



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

def end_date
  @end_date
end

#id ⇒ Object

The unique identifier of the subscription



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

def id
  @id
end

#organisation_id ⇒ Object

The Xero generated unique identifier for the organisation



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

def organisation_id
  @organisation_id
end

#plans ⇒ Object

List of plans for the subscription.



32
33
34
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 32

def plans
  @plans
end

#start_date ⇒ Object

Date when the subscription was first created.



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

def start_date
  @start_date
end

#status ⇒ Object

Status of the subscription. Available statuses are ACTIVE, CANCELED, and PAST_DUE.



38
39
40
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 38

def status
  @status
end

#test_mode ⇒ Object

Boolean used to indicate if the subscription is in test mode



44
45
46
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 44

def test_mode
  @test_mode
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'current_period_end' => :'currentPeriodEnd',
    :'end_date' => :'endDate',
    :'id' => :'id',
    :'organisation_id' => :'organisationId',
    :'plans' => :'plans',
    :'start_date' => :'startDate',
    :'status' => :'status',
    :'test_mode' => :'testMode'
  }
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



231
232
233
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 231

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 83

def self.openapi_types
  {
    :'current_period_end' => :'DateTime',
    :'end_date' => :'DateTime',
    :'id' => :'String',
    :'organisation_id' => :'String',
    :'plans' => :'Array<Plan>',
    :'start_date' => :'DateTime',
    :'status' => :'String',
    :'test_mode' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      current_period_end == o.current_period_end &&
      end_date == o.end_date &&
      id == o.id &&
      organisation_id == o.organisation_id &&
      plans == o.plans &&
      start_date == o.start_date &&
      status == o.status &&
      test_mode == o.test_mode
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



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
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 259

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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 332

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 238

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


218
219
220
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



224
225
226
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 224

def hash
  [current_period_end, end_date, id, organisation_id, plans, start_date, status, test_mode].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @current_period_end.nil?
    invalid_properties.push('invalid value for "current_period_end", current_period_end cannot be nil.')
  end

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

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

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 348

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



324
325
326
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 324

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



306
307
308
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 306

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



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 312

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



300
301
302
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 300

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



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/xero-ruby/models/app_store/subscription.rb', line 179

def valid?
  return false if @current_period_end.nil?
  return false if @id.nil?
  return false if @organisation_id.nil?
  return false if @plans.nil?
  return false if @start_date.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "CANCELED", "PAST_DUE"])
  return false unless status_validator.valid?(@status)
  true
end