Class: Courier::Bulk::BulkIngestError

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/bulk/types/bulk_ingest_error.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user:, error:, additional_properties: nil) ⇒ Bulk::BulkIngestError

Parameters:

  • user (Object)
  • error (Object)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



14
15
16
17
18
19
20
21
 
# File 'lib/trycourier/bulk/types/bulk_ingest_error.rb', line 14

def initialize(user:, error:, additional_properties: nil)
  # @type [Object]
  @user = user
  # @type [Object]
  @error = error
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



8
9
10
 
# File 'lib/trycourier/bulk/types/bulk_ingest_error.rb', line 8

def additional_properties
  @additional_properties
end

#error ⇒ Object (readonly)

Returns the value of attribute error.



8
9
10
 
# File 'lib/trycourier/bulk/types/bulk_ingest_error.rb', line 8

def error
  @error
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



8
9
10
 
# File 'lib/trycourier/bulk/types/bulk_ingest_error.rb', line 8

def user
  @user
end

Class Method Details

.from_json(json_object:) ⇒ Bulk::BulkIngestError

Deserialize a JSON object to an instance of BulkIngestError

Parameters:

  • json_object (JSON)

Returns:



27
28
29
30
31
32
33
 
# File 'lib/trycourier/bulk/types/bulk_ingest_error.rb', line 27

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  user = struct.user
  error = struct.error
  new(user: user, error: error, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


46
47
48
49
 
# File 'lib/trycourier/bulk/types/bulk_ingest_error.rb', line 46

def self.validate_raw(obj:)
  obj.user.is_a?(Object) != false || raise("Passed value for field obj.user is not the expected type, validation failed.")
  obj.error.is_a?(Object) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of BulkIngestError to a JSON object

Returns:

  • (JSON) 


38
39
40
 
# File 'lib/trycourier/bulk/types/bulk_ingest_error.rb', line 38

def to_json(*_args)
  { "user": @user, "error": @error }.to_json
end