Class: PostFinanceCheckout::ShopifyIntegration

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

Overview

A Shopify Integration allows to connect a Shopify shop.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShopifyIntegration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'additionalLineItemData')
    if (value = attributes[:'additionalLineItemData']).is_a?(Array)
      self.additional_line_item_data = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_line_item_data ⇒ Object

Returns the value of attribute additional_line_item_data.



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

def additional_line_item_data
  @additional_line_item_data
end

#allow_invoice_download ⇒ Object

Returns the value of attribute allow_invoice_download.



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

def allow_invoice_download
  @allow_invoice_download
end

#allowed_payment_method_configurations ⇒ Object

Returns the value of attribute allowed_payment_method_configurations.



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

def allowed_payment_method_configurations
  @allowed_payment_method_configurations
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#integrated_payment_form_enabled ⇒ Object

Enabling the integrated payment form will embed the payment form in the Shopify shop. The app needs to be installed for this to be possible.



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

def integrated_payment_form_enabled
  @integrated_payment_form_enabled
end

#language ⇒ Object

The checkout language forces a specific language in the checkout. Without a checkout language the browser setting of the buyer is used to determine the language.



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

def language
  @language
end

#login_name ⇒ Object

The login name is used to link a specific Shopify payment gateway to this integration.This login name is to be filled into the appropriate field in the shops payment gateway configuration.



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

def 
  @login_name
end

#name ⇒ Object

The integration name is used internally to identify a specific integration.For example the name is used withinsearch fields and hence it should be distinct and descriptive.



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

def name
  @name
end

#payment_app_version ⇒ Object

Returns the value of attribute payment_app_version.



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

def payment_app_version
  @payment_app_version
end

#payment_installed ⇒ Object

Returns the value of attribute payment_installed.



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

def payment_installed
  @payment_installed
end

#payment_proxy_path ⇒ Object

Define the path of the proxy URL. This only needs to be changed if the apps proxy URL is overwritten in the Shopify store.



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

def payment_proxy_path
  @payment_proxy_path
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



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

def planned_purge_date
  @planned_purge_date
end

#replace_payment_method_image ⇒ Object

Returns the value of attribute replace_payment_method_image.



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

def replace_payment_method_image
  @replace_payment_method_image
end

#shop_name ⇒ Object

The store address is used to link a specific Shopify shop to this integration. This is the name used in the Shopifys admin URL: [storeAddress].myshopify.com



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

def shop_name
  @shop_name
end

#show_payment_information ⇒ Object

Returns the value of attribute show_payment_information.



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

def show_payment_information
  @show_payment_information
end

#show_subscription_information ⇒ Object

Returns the value of attribute show_subscription_information.



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

def show_subscription_information
  @show_subscription_information
end

#space_id ⇒ Object

Returns the value of attribute space_id.



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

def space_id
  @space_id
end

#space_view_id ⇒ Object

Returns the value of attribute space_view_id.



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#subscription_app_version ⇒ Object

Returns the value of attribute subscription_app_version.



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

def subscription_app_version
  @subscription_app_version
end

#subscription_installed ⇒ Object

Returns the value of attribute subscription_installed.



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

def subscription_installed
  @subscription_installed
end

#subscription_proxy_path ⇒ Object

Define the path of the proxy URL. This only needs to be changed if the apps proxy URL is overwritten in the Shopify store.



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

def subscription_proxy_path
  @subscription_proxy_path
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'additional_line_item_data' => :'additionalLineItemData',
    :'allow_invoice_download' => :'allowInvoiceDownload',
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'currency' => :'currency',
    :'id' => :'id',
    :'integrated_payment_form_enabled' => :'integratedPaymentFormEnabled',
    :'language' => :'language',
    :'login_name' => :'loginName',
    :'name' => :'name',
    :'payment_app_version' => :'paymentAppVersion',
    :'payment_installed' => :'paymentInstalled',
    :'payment_proxy_path' => :'paymentProxyPath',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'replace_payment_method_image' => :'replacePaymentMethodImage',
    :'shop_name' => :'shopName',
    :'show_payment_information' => :'showPaymentInformation',
    :'show_subscription_information' => :'showSubscriptionInformation',
    :'space_id' => :'spaceId',
    :'space_view_id' => :'spaceViewId',
    :'state' => :'state',
    :'subscription_app_version' => :'subscriptionAppVersion',
    :'subscription_installed' => :'subscriptionInstalled',
    :'subscription_proxy_path' => :'subscriptionProxyPath',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'additional_line_item_data' => :'Array<ShopifyAdditionalLineItemData>',
    :'allow_invoice_download' => :'BOOLEAN',
    :'allowed_payment_method_configurations' => :'Array<PaymentMethodConfiguration>',
    :'currency' => :'String',
    :'id' => :'Integer',
    :'integrated_payment_form_enabled' => :'BOOLEAN',
    :'language' => :'String',
    :'login_name' => :'String',
    :'name' => :'String',
    :'payment_app_version' => :'ShopifyIntegrationPaymentAppVersion',
    :'payment_installed' => :'BOOLEAN',
    :'payment_proxy_path' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'replace_payment_method_image' => :'BOOLEAN',
    :'shop_name' => :'String',
    :'show_payment_information' => :'BOOLEAN',
    :'show_subscription_information' => :'BOOLEAN',
    :'space_id' => :'Integer',
    :'space_view_id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'subscription_app_version' => :'ShopifyIntegrationSubscriptionAppVersion',
    :'subscription_installed' => :'BOOLEAN',
    :'subscription_proxy_path' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 324

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_line_item_data == o.additional_line_item_data &&
      allow_invoice_download == o.allow_invoice_download &&
      allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
      currency == o.currency &&
      id == o.id &&
      integrated_payment_form_enabled == o.integrated_payment_form_enabled &&
      language == o.language &&
       == o. &&
      name == o.name &&
      payment_app_version == o.payment_app_version &&
      payment_installed == o.payment_installed &&
      payment_proxy_path == o.payment_proxy_path &&
      planned_purge_date == o.planned_purge_date &&
      replace_payment_method_image == o.replace_payment_method_image &&
      shop_name == o.shop_name &&
      show_payment_information == o.show_payment_information &&
      show_subscription_information == o.show_subscription_information &&
      space_id == o.space_id &&
      space_view_id == o.space_view_id &&
      state == o.state &&
      subscription_app_version == o.subscription_app_version &&
      subscription_installed == o.subscription_installed &&
      subscription_proxy_path == o.subscription_proxy_path &&
      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



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
419
420
421
422
423
424
425
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 389

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



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 455

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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 368

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


355
356
357
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 355

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



361
362
363
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 361

def hash
  [additional_line_item_data, allow_invoice_download, allowed_payment_method_configurations, currency, id, integrated_payment_form_enabled, language, , name, payment_app_version, payment_installed, payment_proxy_path, planned_purge_date, replace_payment_method_image, shop_name, show_payment_information, show_subscription_information, space_id, space_view_id, state, subscription_app_version, subscription_installed, subscription_proxy_path, 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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 266

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

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

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



435
436
437
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 435

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



441
442
443
444
445
446
447
448
449
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 441

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



429
430
431
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 429

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



285
286
287
288
289
290
 
# File 'lib/postfinancecheckout-ruby-sdk/models/shopify_integration.rb', line 285

def valid?
  return false if !@login_name.nil? && @login_name.to_s.length > 100
  return false if !@name.nil? && @name.to_s.length > 100
  return false if !@shop_name.nil? && @shop_name.to_s.length > 100
  true
end