Class: WhiteLabelMachineName::ShopifySubscriptionVersion

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShopifySubscriptionVersion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
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
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/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 177

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_address ⇒ Object

Returns the value of attribute billing_address.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 24

def billing_address
  @billing_address
end

#billing_day_of_month ⇒ Object

Returns the value of attribute billing_day_of_month.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 27

def billing_day_of_month
  @billing_day_of_month
end

#billing_interval_amount ⇒ Object

Returns the value of attribute billing_interval_amount.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 30

def billing_interval_amount
  @billing_interval_amount
end

#billing_interval_unit ⇒ Object

Returns the value of attribute billing_interval_unit.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 33

def billing_interval_unit
  @billing_interval_unit
end

#billing_reference_date ⇒ Object

Returns the value of attribute billing_reference_date.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 36

def billing_reference_date
  @billing_reference_date
end

#billing_weekday ⇒ Object

Returns the value of attribute billing_weekday.



39
40
41
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 39

def billing_weekday
  @billing_weekday
end

#created_by ⇒ Object

Returns the value of attribute created_by.



42
43
44
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 42

def created_by
  @created_by
end

#created_on ⇒ Object

Returns the value of attribute created_on.



45
46
47
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 45

def created_on
  @created_on
end

#currency ⇒ Object

Returns the value of attribute currency.



48
49
50
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 48

def currency
  @currency
end

#discharged_by ⇒ Object

Returns the value of attribute discharged_by.



51
52
53
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 51

def discharged_by
  @discharged_by
end

#discharged_on ⇒ Object

Returns the value of attribute discharged_on.



54
55
56
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 54

def discharged_on
  @discharged_on
end

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



57
58
59
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 57

def id
  @id
end

#items ⇒ Object

Returns the value of attribute items.



60
61
62
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 60

def items
  @items
end

#linked_space_id ⇒ Object

The linked space id holds the ID of the space to which the entity belongs to.



63
64
65
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 63

def linked_space_id
  @linked_space_id
end

#maximal_billing_cycles ⇒ Object

Returns the value of attribute maximal_billing_cycles.



66
67
68
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 66

def maximal_billing_cycles
  @maximal_billing_cycles
end

#maximal_suspendable_cycles ⇒ Object

Returns the value of attribute maximal_suspendable_cycles.



69
70
71
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 69

def maximal_suspendable_cycles
  @maximal_suspendable_cycles
end

#minimal_billing_cycles ⇒ Object

Returns the value of attribute minimal_billing_cycles.



72
73
74
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 72

def minimal_billing_cycles
  @minimal_billing_cycles
end

#payment_gateway ⇒ Object

Returns the value of attribute payment_gateway.



75
76
77
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 75

def payment_gateway
  @payment_gateway
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



78
79
80
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 78

def shipping_address
  @shipping_address
end

#shipping_rate ⇒ Object

Returns the value of attribute shipping_rate.



81
82
83
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 81

def shipping_rate
  @shipping_rate
end

#shop ⇒ Object

Returns the value of attribute shop.



84
85
86
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 84

def shop
  @shop
end

#state ⇒ Object

Returns the value of attribute state.



87
88
89
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 87

def state
  @state
end

#store_order_confirmation_email_enabled ⇒ Object

Returns the value of attribute store_order_confirmation_email_enabled.



90
91
92
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 90

def store_order_confirmation_email_enabled
  @store_order_confirmation_email_enabled
end

#subscriber_suspension_allowed ⇒ Object

Returns the value of attribute subscriber_suspension_allowed.



93
94
95
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 93

def subscriber_suspension_allowed
  @subscriber_suspension_allowed
end

#subscription ⇒ Object

Returns the value of attribute subscription.



96
97
98
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 96

def subscription
  @subscription
end

#termination_billing_cycles ⇒ Object

Returns the value of attribute termination_billing_cycles.



99
100
101
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 99

def termination_billing_cycles
  @termination_billing_cycles
end

#token ⇒ Object

Returns the value of attribute token.



102
103
104
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 102

def token
  @token
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



105
106
107
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 105

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 108

def self.attribute_map
  {
    :'billing_address' => :'billingAddress',
    :'billing_day_of_month' => :'billingDayOfMonth',
    :'billing_interval_amount' => :'billingIntervalAmount',
    :'billing_interval_unit' => :'billingIntervalUnit',
    :'billing_reference_date' => :'billingReferenceDate',
    :'billing_weekday' => :'billingWeekday',
    :'created_by' => :'createdBy',
    :'created_on' => :'createdOn',
    :'currency' => :'currency',
    :'discharged_by' => :'dischargedBy',
    :'discharged_on' => :'dischargedOn',
    :'id' => :'id',
    :'items' => :'items',
    :'linked_space_id' => :'linkedSpaceId',
    :'maximal_billing_cycles' => :'maximalBillingCycles',
    :'maximal_suspendable_cycles' => :'maximalSuspendableCycles',
    :'minimal_billing_cycles' => :'minimalBillingCycles',
    :'payment_gateway' => :'paymentGateway',
    :'shipping_address' => :'shippingAddress',
    :'shipping_rate' => :'shippingRate',
    :'shop' => :'shop',
    :'state' => :'state',
    :'store_order_confirmation_email_enabled' => :'storeOrderConfirmationEmailEnabled',
    :'subscriber_suspension_allowed' => :'subscriberSuspensionAllowed',
    :'subscription' => :'subscription',
    :'termination_billing_cycles' => :'terminationBillingCycles',
    :'token' => :'token',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 142

def self.swagger_types
  {
    :'billing_address' => :'ShopifySubscriptionAddress',
    :'billing_day_of_month' => :'Integer',
    :'billing_interval_amount' => :'Integer',
    :'billing_interval_unit' => :'ShopifySubscriptionBillingIntervalUnit',
    :'billing_reference_date' => :'DateTime',
    :'billing_weekday' => :'ShopifySubscriptionWeekday',
    :'created_by' => :'Integer',
    :'created_on' => :'DateTime',
    :'currency' => :'String',
    :'discharged_by' => :'Integer',
    :'discharged_on' => :'DateTime',
    :'id' => :'Integer',
    :'items' => :'Array<ShopifySubscriptionVersionItem>',
    :'linked_space_id' => :'Integer',
    :'maximal_billing_cycles' => :'Integer',
    :'maximal_suspendable_cycles' => :'Integer',
    :'minimal_billing_cycles' => :'Integer',
    :'payment_gateway' => :'String',
    :'shipping_address' => :'ShopifySubscriptionAddress',
    :'shipping_rate' => :'String',
    :'shop' => :'Integer',
    :'state' => :'ShopifySubscriptionVersionState',
    :'store_order_confirmation_email_enabled' => :'BOOLEAN',
    :'subscriber_suspension_allowed' => :'BOOLEAN',
    :'subscription' => :'ShopifySubscription',
    :'termination_billing_cycles' => :'Integer',
    :'token' => :'Integer',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      billing_address == o.billing_address &&
      billing_day_of_month == o.billing_day_of_month &&
      billing_interval_amount == o.billing_interval_amount &&
      billing_interval_unit == o.billing_interval_unit &&
      billing_reference_date == o.billing_reference_date &&
      billing_weekday == o.billing_weekday &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      currency == o.currency &&
      discharged_by == o.discharged_by &&
      discharged_on == o.discharged_on &&
      id == o.id &&
      items == o.items &&
      linked_space_id == o.linked_space_id &&
      maximal_billing_cycles == o.maximal_billing_cycles &&
      maximal_suspendable_cycles == o.maximal_suspendable_cycles &&
      minimal_billing_cycles == o.minimal_billing_cycles &&
      payment_gateway == o.payment_gateway &&
      shipping_address == o.shipping_address &&
      shipping_rate == o.shipping_rate &&
      shop == o.shop &&
      state == o.state &&
      store_order_confirmation_email_enabled == o.store_order_confirmation_email_enabled &&
      subscriber_suspension_allowed == o.subscriber_suspension_allowed &&
      subscription == o.subscription &&
      termination_billing_cycles == o.termination_billing_cycles &&
      token == o.token &&
      version == o.version
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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 382

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 = WhiteLabelMachineName.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



448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 448

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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 361

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


348
349
350
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



354
355
356
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 354

def hash
  [billing_address, billing_day_of_month, billing_interval_amount, billing_interval_unit, billing_reference_date, billing_weekday, created_by, created_on, currency, discharged_by, discharged_on, id, items, linked_space_id, maximal_billing_cycles, maximal_suspendable_cycles, minimal_billing_cycles, payment_gateway, shipping_address, shipping_rate, shop, state, store_order_confirmation_email_enabled, subscriber_suspension_allowed, subscription, termination_billing_cycles, token, version].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



300
301
302
303
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 300

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



428
429
430
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 428

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



434
435
436
437
438
439
440
441
442
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 434

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



422
423
424
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 422

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



307
308
309
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_version.rb', line 307

def valid?
  true
end