Class: PostFinanceCheckout::ShopifySubscriptionCreationRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShopifySubscriptionCreationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#billing_configuration ⇒ Object

Returns the value of attribute billing_configuration.



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

def billing_configuration
  @billing_configuration
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#external_id ⇒ Object

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



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

def external_id
  @external_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_creation_request.rb', line 36

def initial_execution_date
  @initial_execution_date
end

#integration ⇒ Object

Returns the value of attribute integration.



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

def integration
  @integration
end

#items ⇒ Object

Returns the value of attribute items.



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

def items
  @items
end

#language ⇒ Object

Returns the value of attribute language.



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

def language
  @language
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



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

def shipping_address
  @shipping_address
end

#shipping_method_name ⇒ Object

Returns the value of attribute shipping_method_name.



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

def shipping_method_name
  @shipping_method_name
end

#space_view_id ⇒ Object

Returns the value of attribute space_view_id.



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

def space_view_id
  @space_view_id
end

#store_order_confirmation_email_enabled ⇒ Object

Returns the value of attribute store_order_confirmation_email_enabled.



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

def store_order_confirmation_email_enabled
  @store_order_confirmation_email_enabled
end

#subscriber ⇒ Object

Returns the value of attribute subscriber.



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

def subscriber
  @subscriber
end

#subscriber_suspension_allowed ⇒ Object

Returns the value of attribute subscriber_suspension_allowed.



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

def subscriber_suspension_allowed
  @subscriber_suspension_allowed
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 66

def self.attribute_map
  {
    :'billing_address' => :'billingAddress',
    :'billing_configuration' => :'billingConfiguration',
    :'currency' => :'currency',
    :'external_id' => :'externalId',
    :'initial_execution_date' => :'initialExecutionDate',
    :'integration' => :'integration',
    :'items' => :'items',
    :'language' => :'language',
    :'shipping_address' => :'shippingAddress',
    :'shipping_method_name' => :'shippingMethodName',
    :'space_view_id' => :'spaceViewId',
    :'store_order_confirmation_email_enabled' => :'storeOrderConfirmationEmailEnabled',
    :'subscriber' => :'subscriber',
    :'subscriber_suspension_allowed' => :'subscriberSuspensionAllowed'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 86

def self.swagger_types
  {
    :'billing_address' => :'ShopifySubscriptionAddressCreate',
    :'billing_configuration' => :'ShopifySubscriptionModelBillingConfiguration',
    :'currency' => :'String',
    :'external_id' => :'String',
    :'initial_execution_date' => :'DateTime',
    :'integration' => :'Integer',
    :'items' => :'Array<ShopifySubscriptionModelItem>',
    :'language' => :'String',
    :'shipping_address' => :'ShopifySubscriptionAddressCreate',
    :'shipping_method_name' => :'String',
    :'space_view_id' => :'Integer',
    :'store_order_confirmation_email_enabled' => :'BOOLEAN',
    :'subscriber' => :'ShopifySubscriberCreation',
    :'subscriber_suspension_allowed' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      billing_address == o.billing_address &&
      billing_configuration == o.billing_configuration &&
      currency == o.currency &&
      external_id == o.external_id &&
      initial_execution_date == o.initial_execution_date &&
      integration == o.integration &&
      items == o.items &&
      language == o.language &&
      shipping_address == o.shipping_address &&
      shipping_method_name == o.shipping_method_name &&
      space_view_id == o.space_view_id &&
      store_order_confirmation_email_enabled == o.store_order_confirmation_email_enabled &&
      subscriber == o.subscriber &&
      subscriber_suspension_allowed == o.subscriber_suspension_allowed
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



282
283
284
285
286
287
288
289
290
291
292
293
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 282

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 348

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 261

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


248
249
250
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



254
255
256
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 254

def hash
  [billing_address, billing_configuration, currency, external_id, initial_execution_date, integration, items, language, shipping_address, shipping_method_name, space_view_id, store_order_confirmation_email_enabled, subscriber, subscriber_suspension_allowed].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



174
175
176
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 174

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

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

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

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

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

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

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

  if @subscriber.nil?
    invalid_properties.push('invalid value for "subscriber", subscriber 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



328
329
330
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 328

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



334
335
336
337
338
339
340
341
342
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 334

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



322
323
324
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 322

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



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_creation_request.rb', line 213

def valid?
  return false if @billing_address.nil?
  return false if @currency.nil?
  return false if @external_id.nil?
  return false if @integration.nil?
  return false if @items.nil?
  return false if @language.nil?
  return false if @shipping_address.nil?
  return false if @subscriber.nil?
  true
end