Class: PaysecureApiDocumentationLive::PurchaseRequest4

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

Overview

PurchaseRequest4 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:, status:, brand_id:, skip_capture:, merchant_ref:, success_redirect:, pending_redirect:, failure_redirect:, success_callback:, failure_callback:, additional_properties: nil) ⇒ PurchaseRequest4

Returns a new instance of PurchaseRequest4.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/paysecure_api_documentation_live/models/purchase_request4.rb', line 83

def initialize(client:, purchase:, status:, brand_id:, skip_capture:,
               merchant_ref:, 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
  @status = status
  @brand_id = brand_id
  @skip_capture = skip_capture
  @merchant_ref = merchant_ref
  @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_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def brand_id
  @brand_id
end

#client ⇒ Client65

TODO: Write general description for this method

Returns:



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

def client
  @client
end

#failure_callback ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


54
55
56
 
# File 'lib/paysecure_api_documentation_live/models/purchase_request4.rb', line 54

def failure_callback
  @failure_callback
end

#failure_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def failure_redirect
  @failure_redirect
end

#merchant_ref ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def merchant_ref
  @merchant_ref
end

#pending_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def pending_redirect
  @pending_redirect
end

#purchase ⇒ Purchase52

TODO: Write general description for this method

Returns:



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

def purchase
  @purchase
end

#skip_capture ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def skip_capture
  @skip_capture
end

#status ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def status
  @status
end

#success_callback ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def success_callback
  @success_callback
end

#success_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def success_redirect
  @success_redirect
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/paysecure_api_documentation_live/models/purchase_request4.rb', line 105

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  client = Client65.from_hash(hash['client']) if hash['client']
  purchase = Purchase52.from_hash(hash['purchase']) if hash['purchase']
  status = hash.key?('status') ? hash['status'] : nil
  brand_id = hash.key?('brand_id') ? hash['brand_id'] : nil
  skip_capture = hash.key?('skip_capture') ? hash['skip_capture'] : nil
  merchant_ref = hash.key?('merchantRef') ? hash['merchantRef'] : 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.
  PurchaseRequest4.new(client: client,
                       purchase: purchase,
                       status: status,
                       brand_id: brand_id,
                       skip_capture: skip_capture,
                       merchant_ref: merchant_ref,
                       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

.names ⇒ Object

A mapping from model property names to API property names.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/paysecure_api_documentation_live/models/purchase_request4.rb', line 57

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client'] = 'client'
  @_hash['purchase'] = 'purchase'
  @_hash['status'] = 'status'
  @_hash['brand_id'] = 'brand_id'
  @_hash['skip_capture'] = 'skip_capture'
  @_hash['merchant_ref'] = 'merchantRef'
  @_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

.nullables ⇒ Object

An array for nullable fields



79
80
81
 
# File 'lib/paysecure_api_documentation_live/models/purchase_request4.rb', line 79

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/paysecure_api_documentation_live/models/purchase_request4.rb', line 159

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client: #{@client.inspect}, purchase: #{@purchase.inspect}, status:"\
  " #{@status.inspect}, brand_id: #{@brand_id.inspect}, skip_capture:"\
  " #{@skip_capture.inspect}, merchant_ref: #{@merchant_ref.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_s ⇒ Object

Provides a human-readable string representation of the object.



149
150
151
152
153
154
155
156
 
# File 'lib/paysecure_api_documentation_live/models/purchase_request4.rb', line 149

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client: #{@client}, purchase: #{@purchase}, status: #{@status}, brand_id:"\
  " #{@brand_id}, skip_capture: #{@skip_capture}, merchant_ref: #{@merchant_ref},"\
  " 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