Class: PCPServerSDK::APIError

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/api_error.rb

Overview

Contains detailed information on one single error.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ APIError

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PCPServerSDK::APIError` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PCPServerSDK::APIError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'error_code')
    self.error_code = attributes[:'error_code']
  else
    self.error_code = nil
  end

  if attributes.key?(:'category')
    self.category = attributes[:'category']
  end

  if attributes.key?(:'http_status_code')
    self.http_status_code = attributes[:'http_status_code']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'property_name')
    self.property_name = attributes[:'property_name']
  end
end

Instance Attribute Details

#category ⇒ Object

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: * DIRECT_PLATFORM_ERROR - indicating that a functional error has occurred in the platform. * PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the payment platform. * IO_ERROR - indicating that a technical error has occurred within the payment platform or between the payment platform and third party systems. * COMMERCE_PLATFORM_ERROR - indicating an error originating from the Commerce Platform. * COMMERCE_PORTAL_BACKEND_ERROR - indicating an error originating from the Commerce Portal Backend.



23
24
25
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 23

def category
  @category
end

#error_code ⇒ Object

Error code



20
21
22
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 20

def error_code
  @error_code
end

#http_status_code ⇒ Object

HTTP status code for this error that can be used to determine the type of error



26
27
28
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 26

def http_status_code
  @http_status_code
end

#id ⇒ Object

ID of the error. This is a short human-readable message that briefly describes the error.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 29

def id
  @id
end

#message ⇒ Object

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud



32
33
34
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 32

def message
  @message
end

#property_name ⇒ Object

Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: * a.b selects the value of property b of root property a, * a selects the first element of the array in root property a, * a[b=‘some value’] selects all elements of the array in root property a that have a property b with value ‘some value’.



35
36
37
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 35

def property_name
  @property_name
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 186

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  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
    # models (e.g. Pet) or oneOf
    klass = PCPServerSDK.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 38

def self.attribute_map
  {
    :'error_code' => :'errorCode',
    :'category' => :'category',
    :'http_status_code' => :'httpStatusCode',
    :'id' => :'id',
    :'message' => :'message',
    :'property_name' => :'propertyName'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 162

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 67

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 55

def self.openapi_types
  {
    :'error_code' => :'String',
    :'category' => :'String',
    :'http_status_code' => :'Integer',
    :'id' => :'String',
    :'message' => :'String',
    :'property_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_code == o.error_code &&
      category == o.category &&
      http_status_code == o.http_status_code &&
      id == o.id &&
      message == o.message &&
      property_name == o.property_name
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • Any valid value

Returns:

  • Returns the value in the form of hash



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 257

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

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


149
150
151
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



155
156
157
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 155

def hash
  [error_code, category, http_status_code, id, message, property_name].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



116
117
118
119
120
121
122
123
124
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 116

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @error_code.nil?
    invalid_properties.push('invalid value for "error_code", error_code cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



233
234
235
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 233

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 239

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • String presentation of the object



227
228
229
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 227

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



128
129
130
131
132
 
# File 'lib/PCP-server-Ruby-SDK/models/api_error.rb', line 128

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @error_code.nil?
  true
end