Class: PaysecureApiDocumentationLive::S2SApiRequest

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

Overview

S2SApiRequest 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(cardholder_name:, card_number:, expires:, cvc:, remember_card:, remote_ip:, user_agent:, accept_header:, language:, java_enabled:, javascript_enabled:, color_depth:, utc_offset:, screen_width:, screen_height:, additional_properties: nil) ⇒ S2SApiRequest

Returns a new instance of S2SApiRequest.



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

def initialize(cardholder_name:, card_number:, expires:, cvc:,
               remember_card:, remote_ip:, user_agent:, accept_header:,
               language:, java_enabled:, javascript_enabled:, color_depth:,
               utc_offset:, screen_width:, screen_height:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @cardholder_name = cardholder_name
  @card_number = card_number
  @expires = expires
  @cvc = cvc
  @remember_card = remember_card
  @remote_ip = remote_ip
  @user_agent = user_agent
  @accept_header = accept_header
  @language = language
  @java_enabled = java_enabled
  @javascript_enabled = javascript_enabled
  @color_depth = color_depth
  @utc_offset = utc_offset
  @screen_width = screen_width
  @screen_height = screen_height
  @additional_properties = additional_properties
end

Instance Attribute Details

#accept_header ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def accept_header
  @accept_header
end

#card_number ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def card_number
  @card_number
end

#cardholder_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def cardholder_name
  @cardholder_name
end

#color_depth ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 58

def color_depth
  @color_depth
end

#cvc ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def cvc
  @cvc
end

#expires ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def expires
  @expires
end

#java_enabled ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def java_enabled
  @java_enabled
end

#javascript_enabled ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def javascript_enabled
  @javascript_enabled
end

#language ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def language
  @language
end

#remember_card ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def remember_card
  @remember_card
end

#remote_ip ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def remote_ip
  @remote_ip
end

#screen_height ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


70
71
72
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 70

def screen_height
  @screen_height
end

#screen_width ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


66
67
68
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 66

def screen_width
  @screen_width
end

#user_agent ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def user_agent
  @user_agent
end

#utc_offset ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 62

def utc_offset
  @utc_offset
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
175
176
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 130

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  cardholder_name =
    hash.key?('cardholder_name') ? hash['cardholder_name'] : nil
  card_number = hash.key?('card_number') ? hash['card_number'] : nil
  expires = hash.key?('expires') ? hash['expires'] : nil
  cvc = hash.key?('cvc') ? hash['cvc'] : nil
  remember_card = hash.key?('remember_card') ? hash['remember_card'] : nil
  remote_ip = hash.key?('remote_ip') ? hash['remote_ip'] : nil
  user_agent = hash.key?('user_agent') ? hash['user_agent'] : nil
  accept_header = hash.key?('accept_header') ? hash['accept_header'] : nil
  language = hash.key?('language') ? hash['language'] : nil
  java_enabled = hash.key?('java_enabled') ? hash['java_enabled'] : nil
  javascript_enabled =
    hash.key?('javascript_enabled') ? hash['javascript_enabled'] : nil
  color_depth = hash.key?('color_depth') ? hash['color_depth'] : nil
  utc_offset = hash.key?('utc_offset') ? hash['utc_offset'] : nil
  screen_width = hash.key?('screen_width') ? hash['screen_width'] : nil
  screen_height = hash.key?('screen_height') ? hash['screen_height'] : 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.
  S2SApiRequest.new(cardholder_name: cardholder_name,
                    card_number: card_number,
                    expires: expires,
                    cvc: cvc,
                    remember_card: remember_card,
                    remote_ip: remote_ip,
                    user_agent: user_agent,
                    accept_header: accept_header,
                    language: language,
                    java_enabled: java_enabled,
                    javascript_enabled: javascript_enabled,
                    color_depth: color_depth,
                    utc_offset: utc_offset,
                    screen_width: screen_width,
                    screen_height: screen_height,
                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['cardholder_name'] = 'cardholder_name'
  @_hash['card_number'] = 'card_number'
  @_hash['expires'] = 'expires'
  @_hash['cvc'] = 'cvc'
  @_hash['remember_card'] = 'remember_card'
  @_hash['remote_ip'] = 'remote_ip'
  @_hash['user_agent'] = 'user_agent'
  @_hash['accept_header'] = 'accept_header'
  @_hash['language'] = 'language'
  @_hash['java_enabled'] = 'java_enabled'
  @_hash['javascript_enabled'] = 'javascript_enabled'
  @_hash['color_depth'] = 'color_depth'
  @_hash['utc_offset'] = 'utc_offset'
  @_hash['screen_width'] = 'screen_width'
  @_hash['screen_height'] = 'screen_height'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



99
100
101
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 99

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



94
95
96
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 94

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 190

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} cardholder_name: #{@cardholder_name.inspect}, card_number:"\
  " #{@card_number.inspect}, expires: #{@expires.inspect}, cvc: #{@cvc.inspect},"\
  " remember_card: #{@remember_card.inspect}, remote_ip: #{@remote_ip.inspect}, user_agent:"\
  " #{@user_agent.inspect}, accept_header: #{@accept_header.inspect}, language:"\
  " #{@language.inspect}, java_enabled: #{@java_enabled.inspect}, javascript_enabled:"\
  " #{@javascript_enabled.inspect}, color_depth: #{@color_depth.inspect}, utc_offset:"\
  " #{@utc_offset.inspect}, screen_width: #{@screen_width.inspect}, screen_height:"\
  " #{@screen_height.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



179
180
181
182
183
184
185
186
187
 
# File 'lib/paysecure_api_documentation_live/models/s2_s_api_request.rb', line 179

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} cardholder_name: #{@cardholder_name}, card_number: #{@card_number},"\
  " expires: #{@expires}, cvc: #{@cvc}, remember_card: #{@remember_card}, remote_ip:"\
  " #{@remote_ip}, user_agent: #{@user_agent}, accept_header: #{@accept_header}, language:"\
  " #{@language}, java_enabled: #{@java_enabled}, javascript_enabled: #{@javascript_enabled},"\
  " color_depth: #{@color_depth}, utc_offset: #{@utc_offset}, screen_width: #{@screen_width},"\
  " screen_height: #{@screen_height}, additional_properties: #{@additional_properties}>"
end