Class: OrbipayPaymentsapiClient::InvocationContext

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(secret: nil, idempotent_request_key: nil, x_opay_headers: nil, api_key: nil, auth_scheme: nil) ⇒ InvocationContext

Returns a new instance of InvocationContext.

Parameters:

  • secret (String) (defaults to: nil) —

    attribute in the form of String.

  • idempotent_request_key (String) (defaults to: nil) —

    attribute in the form of String.

  • x_opay_headers (String) (defaults to: nil) —

    attribute in the form of String.

  • api_key (String) (defaults to: nil) —

    attribute in the form of String.

  • auth_scheme (String) (defaults to: nil) —

    attribute in the form of String.



88
89
90
91
92
93
94
95
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 88

def initialize(secret: nil, idempotent_request_key: nil, x_opay_headers: nil, api_key: nil, auth_scheme: nil)
	@product = "orbipay_payments"
	@secret = secret
	@idempotent_request_key = idempotent_request_key
	@x_opay_headers = x_opay_headers
	@api_key = api_key
	@auth_scheme = auth_scheme
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



39
40
41
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 39

def api_key
  @api_key
end

#auth_scheme ⇒ Object (readonly)

Returns the value of attribute auth_scheme.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 41

def auth_scheme
  @auth_scheme
end

#channel ⇒ Object (readonly)

The channel through which the API is invoked.



23
24
25
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 23

def channel
  @channel
end

#client_key ⇒ Object (readonly)

The unique identifier assigned by EBPP to the client.



5
6
7
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 5

def client_key
  @client_key
end

#idempotent_request_key ⇒ Object (readonly)

The unique token that clients can generate and maintain in order to identify an API request.



17
18
19
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 17

def idempotent_request_key
  @idempotent_request_key
end

#product ⇒ Object (readonly)

The product identifier corresponding to the API.



8
9
10
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 8

def product
  @product
end

#request_uuid ⇒ Object (readonly)

The unique ID for the request, generated by EBPP, that can be used for tracing and audit trail.



20
21
22
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 20

def request_uuid
  @request_uuid
end

#requestor ⇒ Object (readonly)

The identifier for the requestor of the API. If the requestor_type is system, requestor is optional.



32
33
34
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 32

def requestor
  @requestor
end

#requestor_type ⇒ Object (readonly)

Type of the requestor of the API.



14
15
16
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 14

def requestor_type
  @requestor_type
end

#response_codes ⇒ Object (readonly)

Codes corresponding to any additional information or warning, pertaining to the API call, in a comma separated format, that are returned in the response.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 26

def response_codes
  @response_codes
end

#response_text ⇒ Object (readonly)

The text detailing any additional information or warning, pertaining to the API call, in a pipe separated format, that is returned in the response.



29
30
31
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 29

def response_text
  @response_text
end

#secret ⇒ Object (readonly)

Returns the value of attribute secret.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 37

def secret
  @secret
end

#timestamp ⇒ Object (readonly)

The timestamp for the moment when the API request is created.



35
36
37
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 35

def timestamp
  @timestamp
end

#x_opay_headers ⇒ Object (readonly)

Intended for the future use.



11
12
13
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 11

def x_opay_headers
  @x_opay_headers
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 45

def self.attribute_map
  {
    :'client_key' => :'client_key',	
    :'product' => :'product',	
    :'x_opay_headers' => :'X-OPAY-Headers',	
    :'requestor_type' => :'requestor_type',	
    :'idempotent_request_key' => :'idempotent_request_key',	
    :'request_uuid' => :'request_uuid',	
    :'channel' => :'channel',	
    :'response_codes' => :'response_codes',	
    :'response_text' => :'response_text',	
    :'requestor' => :'requestor',	
    :'timestamp' => :'timestamp',	
    :'secret' => :'secret',	
    :'api_key' => :'api_key',	
    :'auth_scheme' => :'auth_scheme'	
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 65

def self.swagger_types
  {
    :'client_key' => :'String',	
    :'product' => :'String',	
    :'x_opay_headers' => :'String',	
    :'requestor_type' => :'String',	
    :'idempotent_request_key' => :'String',	
    :'request_uuid' => :'String',	
    :'channel' => :'String',	
    :'response_codes' => :'String',	
    :'response_text' => :'String',	
    :'requestor' => :'String',	
    :'timestamp' => :'String',	
    :'secret' => :'String',	
    :'api_key' => :'String',	
    :'auth_scheme' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    The Object to be compared



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 108

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_key == o.client_key &&
      product == o.product &&
      x_opay_headers == o.x_opay_headers &&
      requestor_type == o.requestor_type &&
      idempotent_request_key == o.idempotent_request_key &&
      request_uuid == o.request_uuid &&
      channel == o.channel &&
      response_codes == o.response_codes &&
      response_text == o.response_text &&
      requestor == o.requestor &&
      timestamp == o.timestamp &&
      secret == o.secret &&
      api_key == o.api_key &&
      auth_scheme == o.auth_scheme
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (string) —

    Data type

  • value (string) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 163

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    if value.nil?
      value
    else
      value.to_s
    end
  when :Integer
    if value.nil?
      value
    else
      value.to_i
    end
  when :Float
    if value.nil?
      value
    else
      value.to_f
    end
  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
    temp_model = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash, Object

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

  • (Object) —

    Returns the object if it cannot be converted to hash



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 242

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 142

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        set_values(key => attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      set_values(key => _deserialize(type, attributes[self.class.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:

  • o (Object) —

    The Object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


129
130
131
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 129

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 135

def hash
  [client_key, product, x_opay_headers, requestor_type, idempotent_request_key, request_uuid, channel, response_codes, response_text, requestor, timestamp, secret, api_key, auth_scheme].hash
end

#set_values(args) ⇒ Object 



98
99
100
101
102
103
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 98

def set_values(args)
  args.each do |attr, arg|
    (class << self; self; end).send(:attr_reader, attr.to_sym)
    instance_variable_set("@#{attr}", arg)
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 221

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



227
228
229
230
231
232
233
234
235
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 227

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



215
216
217
 
# File 'lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb', line 215

def to_s
  to_hash.to_s
end