Class: Paid::Error

Inherits:
Object
  • Object
show all
Defined in:
lib/paid_ruby/types/error.rb

Overview

An error response from the Paid API

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error:, additional_properties: nil) ⇒ Paid::Error

Parameters:

  • error (Paid::ApiError)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



22
23
24
25
26
 
# File 'lib/paid_ruby/types/error.rb', line 22

def initialize(error:, additional_properties: nil)
  @error = error
  @additional_properties = additional_properties
  @_field_set = { "error": error }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



12
13
14
 
# File 'lib/paid_ruby/types/error.rb', line 12

def additional_properties
  @additional_properties
end

#error ⇒ Paid::ApiError (readonly)

Returns:



10
11
12
 
# File 'lib/paid_ruby/types/error.rb', line 10

def error
  @error
end

Class Method Details

.from_json(json_object:) ⇒ Paid::Error

Parameters:

  • json_object (String)

Returns:



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/paid_ruby/types/error.rb', line 31

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  unless parsed_json["error"].nil?
    error = parsed_json["error"].to_json
    error = Paid::ApiError.from_json(json_object: error)
  else
    error = nil
  end
  new(error: error, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


54
55
56
 
# File 'lib/paid_ruby/types/error.rb', line 54

def self.validate_raw(obj:)
  Paid::ApiError.validate_raw(obj: obj.error)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


45
46
47
 
# File 'lib/paid_ruby/types/error.rb', line 45

def to_json
  @_field_set&.to_json
end