Class: PaysecureApiDocumentationLive::PurchasesRequest

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

Overview

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

Returns a new instance of PurchasesRequest.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/paysecure_api_documentation_live/models/purchases_request.rb', line 73

def initialize(client:, purchase:, payment_method:, 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
  @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_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def brand_id
  @brand_id
end

#client ⇒ Client8

TODO: Write general description for this method

Returns:



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

def client
  @client
end

#failure_callback ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def failure_callback
  @failure_callback
end

#failure_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def failure_redirect
  @failure_redirect
end

#payment_method ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def payment_method
  @payment_method
end

#pending_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def pending_redirect
  @pending_redirect
end

#purchase ⇒ Purchase7

TODO: Write general description for this method

Returns:



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

def purchase
  @purchase
end

#success_callback ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def success_callback
  @success_callback
end

#success_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def success_redirect
  @success_redirect
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



93
94
95
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
124
125
126
127
128
129
130
 
# File 'lib/paysecure_api_documentation_live/models/purchases_request.rb', line 93

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  client = Client8.from_hash(hash['client']) if hash['client']
  purchase = Purchase7.from_hash(hash['purchase']) if hash['purchase']
  payment_method = hash.key?('paymentMethod') ? hash['paymentMethod'] : 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.
  PurchasesRequest.new(client: client,
                       purchase: purchase,
                       payment_method: payment_method,
                       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

.names ⇒ Object

A mapping from model property names to API property names.



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/paysecure_api_documentation_live/models/purchases_request.rb', line 49

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client'] = 'client'
  @_hash['purchase'] = 'purchase'
  @_hash['payment_method'] = 'paymentMethod'
  @_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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



64
65
66
 
# File 'lib/paysecure_api_documentation_live/models/purchases_request.rb', line 64

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



143
144
145
146
147
148
149
150
151
 
# File 'lib/paysecure_api_documentation_live/models/purchases_request.rb', line 143

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

Provides a human-readable string representation of the object.



133
134
135
136
137
138
139
140
 
# File 'lib/paysecure_api_documentation_live/models/purchases_request.rb', line 133

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