Class: PostFinanceCheckout::ShopifySubscription

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShopifySubscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 122

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'orderRecurrenceNumber')
    self.order_recurrence_number = attributes[:'orderRecurrenceNumber']
  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?(:'subscriber')
    self.subscriber = attributes[:'subscriber']
  end

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

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

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

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

Instance Attribute Details

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

Returns the value of attribute created_on.



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

def created_on
  @created_on
end

#external_id ⇒ Object

The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#initial_execution_date ⇒ Object

Returns the value of attribute initial_execution_date.



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

def initial_execution_date
  @initial_execution_date
end

#initial_payment_transaction ⇒ Object

Returns the value of attribute initial_payment_transaction.



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

def initial_payment_transaction
  @initial_payment_transaction
end

#initial_shopify_transaction ⇒ Object

Returns the value of attribute initial_shopify_transaction.



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

def initial_shopify_transaction
  @initial_shopify_transaction
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#order_recurrence_number ⇒ Object

Returns the value of attribute order_recurrence_number.



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

def order_recurrence_number
  @order_recurrence_number
end

#shop ⇒ Object

Returns the value of attribute shop.



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

def shop
  @shop
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#subscriber ⇒ Object

Returns the value of attribute subscriber.



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

def subscriber
  @subscriber
end

#terminated_by ⇒ Object

Returns the value of attribute terminated_by.



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

def terminated_by
  @terminated_by
end

#terminated_on ⇒ Object

Returns the value of attribute terminated_on.



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

def terminated_on
  @terminated_on
end

#termination_request_date ⇒ Object

Returns the value of attribute termination_request_date.



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

def termination_request_date
  @termination_request_date
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 75

def self.attribute_map
  {
    :'created_by' => :'createdBy',
    :'created_on' => :'createdOn',
    :'external_id' => :'externalId',
    :'id' => :'id',
    :'initial_execution_date' => :'initialExecutionDate',
    :'initial_payment_transaction' => :'initialPaymentTransaction',
    :'initial_shopify_transaction' => :'initialShopifyTransaction',
    :'language' => :'language',
    :'linked_space_id' => :'linkedSpaceId',
    :'order_recurrence_number' => :'orderRecurrenceNumber',
    :'shop' => :'shop',
    :'state' => :'state',
    :'subscriber' => :'subscriber',
    :'terminated_by' => :'terminatedBy',
    :'terminated_on' => :'terminatedOn',
    :'termination_request_date' => :'terminationRequestDate',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 98

def self.swagger_types
  {
    :'created_by' => :'Integer',
    :'created_on' => :'DateTime',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'initial_execution_date' => :'DateTime',
    :'initial_payment_transaction' => :'Integer',
    :'initial_shopify_transaction' => :'Integer',
    :'language' => :'String',
    :'linked_space_id' => :'Integer',
    :'order_recurrence_number' => :'Integer',
    :'shop' => :'Integer',
    :'state' => :'ShopifySubscriptionState',
    :'subscriber' => :'ShopifySubscriber',
    :'terminated_by' => :'Integer',
    :'terminated_on' => :'DateTime',
    :'termination_request_date' => :'DateTime',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      external_id == o.external_id &&
      id == o.id &&
      initial_execution_date == o.initial_execution_date &&
      initial_payment_transaction == o.initial_payment_transaction &&
      initial_shopify_transaction == o.initial_shopify_transaction &&
      language == o.language &&
      linked_space_id == o.linked_space_id &&
      order_recurrence_number == o.order_recurrence_number &&
      shop == o.shop &&
      state == o.state &&
      subscriber == o.subscriber &&
      terminated_by == o.terminated_by &&
      terminated_on == o.terminated_on &&
      termination_request_date == o.termination_request_date &&
      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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 294

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 360

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 273

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


260
261
262
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 266

def hash
  [created_by, created_on, external_id, id, initial_execution_date, initial_payment_transaction, initial_shopify_transaction, language, linked_space_id, order_recurrence_number, shop, state, subscriber, terminated_by, terminated_on, termination_request_date, 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



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 199

def list_invalid_properties
  invalid_properties = Array.new
  if !@external_id.nil? && @external_id.to_s.length > 100
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 100.')
  end

  if !@external_id.nil? && @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  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



340
341
342
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 340

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



346
347
348
349
350
351
352
353
354
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 346

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



334
335
336
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 334

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



214
215
216
217
218
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription.rb', line 214

def valid?
  return false if !@external_id.nil? && @external_id.to_s.length > 100
  return false if !@external_id.nil? && @external_id.to_s.length < 1
  true
end