Class: PaysecureApiDocumentationLive::PurchasesRequest2

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/paysecure_api_documentation_live/models/purchases_request2.rb

Overview

PurchasesRequest2 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(client:, purchase:, payment_method:, merchant_ref:, brand_id:, success_redirect:, pending_redirect:, failure_redirect:, success_callback:, failure_callback:, additional_properties: nil) ⇒ PurchasesRequest2

Returns a new instance of PurchasesRequest2.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 78

def initialize(client:, purchase:, payment_method:, merchant_ref:,
               brand_id:, success_redirect:, pending_redirect:,
               failure_redirect:, success_callback:, failure_callback:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @client = client
  @purchase = purchase
  @payment_method = payment_method
  @merchant_ref = merchant_ref
  @brand_id = brand_id
  @success_redirect = success_redirect
  @pending_redirect = pending_redirect
  @failure_redirect = failure_redirect
  @success_callback = success_callback
  @failure_callback = failure_callback
  @additional_properties = additional_properties
end

Instance Attribute Details

#brand_idString

TODO: Write general description for this method

Returns:

  • (String)


30
31
32
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 30

def brand_id
  @brand_id
end

#clientClient24

TODO: Write general description for this method

Returns:



14
15
16
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 14

def client
  @client
end

#failure_callbackString

TODO: Write general description for this method

Returns:

  • (String)


50
51
52
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 50

def failure_callback
  @failure_callback
end

#failure_redirectString

TODO: Write general description for this method

Returns:

  • (String)


42
43
44
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 42

def failure_redirect
  @failure_redirect
end

#merchant_refString

TODO: Write general description for this method

Returns:

  • (String)


26
27
28
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 26

def merchant_ref
  @merchant_ref
end

#payment_methodString

TODO: Write general description for this method

Returns:

  • (String)


22
23
24
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 22

def payment_method
  @payment_method
end

#pending_redirectString

TODO: Write general description for this method

Returns:

  • (String)


38
39
40
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 38

def pending_redirect
  @pending_redirect
end

#purchasePurchase10

TODO: Write general description for this method

Returns:



18
19
20
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 18

def purchase
  @purchase
end

#success_callbackString

TODO: Write general description for this method

Returns:

  • (String)


46
47
48
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 46

def success_callback
  @success_callback
end

#success_redirectString

TODO: Write general description for this method

Returns:

  • (String)


34
35
36
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 34

def success_redirect
  @success_redirect
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 99

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  client = Client24.from_hash(hash['client']) if hash['client']
  purchase = Purchase10.from_hash(hash['purchase']) if hash['purchase']
  payment_method = hash.key?('paymentMethod') ? hash['paymentMethod'] : nil
  merchant_ref = hash.key?('merchantRef') ? hash['merchantRef'] : nil
  brand_id = hash.key?('brand_id') ? hash['brand_id'] : nil
  success_redirect =
    hash.key?('success_redirect') ? hash['success_redirect'] : nil
  pending_redirect =
    hash.key?('pending_redirect') ? hash['pending_redirect'] : nil
  failure_redirect =
    hash.key?('failure_redirect') ? hash['failure_redirect'] : nil
  success_callback =
    hash.key?('success_callback') ? hash['success_callback'] : nil
  failure_callback =
    hash.key?('failure_callback') ? hash['failure_callback'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  PurchasesRequest2.new(client: client,
                        purchase: purchase,
                        payment_method: payment_method,
                        merchant_ref: merchant_ref,
                        brand_id: brand_id,
                        success_redirect: success_redirect,
                        pending_redirect: pending_redirect,
                        failure_redirect: failure_redirect,
                        success_callback: success_callback,
                        failure_callback: failure_callback,
                        additional_properties: additional_properties)
end

.namesObject

A mapping from model property names to API property names.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 53

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client'] = 'client'
  @_hash['purchase'] = 'purchase'
  @_hash['payment_method'] = 'paymentMethod'
  @_hash['merchant_ref'] = 'merchantRef'
  @_hash['brand_id'] = 'brand_id'
  @_hash['success_redirect'] = 'success_redirect'
  @_hash['pending_redirect'] = 'pending_redirect'
  @_hash['failure_redirect'] = 'failure_redirect'
  @_hash['success_callback'] = 'success_callback'
  @_hash['failure_callback'] = 'failure_callback'
  @_hash
end

.nullablesObject

An array for nullable fields



74
75
76
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 74

def self.nullables
  []
end

.optionalsObject

An array for optional fields



69
70
71
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 69

def self.optionals
  []
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



151
152
153
154
155
156
157
158
159
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 151

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client: #{@client.inspect}, purchase: #{@purchase.inspect}, payment_method:"\
  " #{@payment_method.inspect}, merchant_ref: #{@merchant_ref.inspect}, brand_id:"\
  " #{@brand_id.inspect}, success_redirect: #{@success_redirect.inspect}, pending_redirect:"\
  " #{@pending_redirect.inspect}, failure_redirect: #{@failure_redirect.inspect},"\
  " success_callback: #{@success_callback.inspect}, failure_callback:"\
  " #{@failure_callback.inspect}, additional_properties: #{@additional_properties}>"
end

#to_sObject

Provides a human-readable string representation of the object.



141
142
143
144
145
146
147
148
# File 'lib/paysecure_api_documentation_live/models/purchases_request2.rb', line 141

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client: #{@client}, purchase: #{@purchase}, payment_method:"\
  " #{@payment_method}, merchant_ref: #{@merchant_ref}, brand_id: #{@brand_id},"\
  " success_redirect: #{@success_redirect}, pending_redirect: #{@pending_redirect},"\
  " failure_redirect: #{@failure_redirect}, success_callback: #{@success_callback},"\
  " failure_callback: #{@failure_callback}, additional_properties: #{@additional_properties}>"
end