Class: OpenapiClient::PaymentUrlRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/payment_url_request.rb

Overview

Request to generate an embedded payment link.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentUrlRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 102

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#authenticate_transaction ⇒ Object

If 3D secure should be applied.



41
42
43
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 41

def authenticate_transaction
  @authenticate_transaction
end

#billing ⇒ Object

Returns the value of attribute billing.



30
31
32
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 30

def billing
  @billing
end

#client_locale ⇒ Object

Returns the value of attribute client_locale.



21
22
23
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 21

def client_locale
  @client_locale
end

#dynamic_merchant_name ⇒ Object

Dynamic merchant name for the cardholder’s statement.



44
45
46
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 44

def dynamic_merchant_name
  @dynamic_merchant_name
end

#expiration ⇒ Object

Time until payment URL expires.



38
39
40
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 38

def expiration
  @expiration
end

#hosted_payment_page_text ⇒ Object

The text to be displayed to the payer on the hosted payment page.



53
54
55
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 53

def hosted_payment_page_text
  @hosted_payment_page_text
end

#invoice_number ⇒ Object

Invoice number.



47
48
49
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 47

def invoice_number
  @invoice_number
end

#ip ⇒ Object

IPv4 or IPv6 network address.



56
57
58
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 56

def ip
  @ip
end

#order_id ⇒ Object

Client order ID if supplied by client, otherwise the order ID.



28
29
30
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 28

def order_id
  @order_id
end

#purchase_order_number ⇒ Object

Purchase order number.



50
51
52
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 50

def purchase_order_number
  @purchase_order_number
end

#shipping ⇒ Object

Returns the value of attribute shipping.



32
33
34
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 32

def shipping
  @shipping
end

#store_id ⇒ Object

An optional Outlet ID for clients that support multiple stores in the same developer app.



19
20
21
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 19

def store_id
  @store_id
end

#transaction_amount ⇒ Object

Returns the value of attribute transaction_amount.



23
24
25
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 23

def transaction_amount
  @transaction_amount
end

#transaction_notification_url ⇒ Object

URL for notifying merchant of payment result.



35
36
37
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 35

def transaction_notification_url
  @transaction_notification_url
end

#transaction_type ⇒ Object

Returns the value of attribute transaction_type.



25
26
27
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 25

def transaction_type
  @transaction_type
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 59

def self.attribute_map
  {
    :'store_id' => :'storeId',
    :'client_locale' => :'clientLocale',
    :'transaction_amount' => :'transactionAmount',
    :'transaction_type' => :'transactionType',
    :'order_id' => :'orderId',
    :'billing' => :'billing',
    :'shipping' => :'shipping',
    :'transaction_notification_url' => :'transactionNotificationURL',
    :'expiration' => :'expiration',
    :'authenticate_transaction' => :'authenticateTransaction',
    :'dynamic_merchant_name' => :'dynamicMerchantName',
    :'invoice_number' => :'invoiceNumber',
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'hosted_payment_page_text' => :'hostedPaymentPageText',
    :'ip' => :'ip'
  }
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



266
267
268
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 266

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 80

def self.openapi_types
  {
    :'store_id' => :'String',
    :'client_locale' => :'ClientLocale',
    :'transaction_amount' => :'Amount',
    :'transaction_type' => :'TransactionType',
    :'order_id' => :'String',
    :'billing' => :'Billing',
    :'shipping' => :'Shipping',
    :'transaction_notification_url' => :'String',
    :'expiration' => :'Integer',
    :'authenticate_transaction' => :'Boolean',
    :'dynamic_merchant_name' => :'String',
    :'invoice_number' => :'String',
    :'purchase_order_number' => :'String',
    :'hosted_payment_page_text' => :'String',
    :'ip' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      store_id == o.store_id &&
      client_locale == o.client_locale &&
      transaction_amount == o.transaction_amount &&
      transaction_type == o.transaction_type &&
      order_id == o.order_id &&
      billing == o.billing &&
      shipping == o.shipping &&
      transaction_notification_url == o.transaction_notification_url &&
      expiration == o.expiration &&
      authenticate_transaction == o.authenticate_transaction &&
      dynamic_merchant_name == o.dynamic_merchant_name &&
      invoice_number == o.invoice_number &&
      purchase_order_number == o.purchase_order_number &&
      hosted_payment_page_text == o.hosted_payment_page_text &&
      ip == o.ip
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
331
332
333
334
 
# File 'lib/openapi_client/models/payment_url_request.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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 368

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ 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/openapi_client/models/payment_url_request.rb', line 273

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


253
254
255
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 259

def hash
  [store_id, client_locale, transaction_amount, transaction_type, order_id, billing, shipping, transaction_notification_url, expiration, authenticate_transaction, dynamic_merchant_name, invoice_number, purchase_order_number, hosted_payment_page_text, ip].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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 178

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

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

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

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



344
345
346
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 344

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 350

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



338
339
340
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 338

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



201
202
203
204
205
206
207
 
# File 'lib/openapi_client/models/payment_url_request.rb', line 201

def valid?
  return false if !@store_id.nil? && @store_id.to_s.length > 20
  return false if @transaction_amount.nil?
  return false if @transaction_type.nil?
  return false if !@hosted_payment_page_text.nil? && @hosted_payment_page_text.to_s.length > 255
  true
end