Class: Merge::Accounting::RemoteData

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/remote_data.rb

Overview

# The RemoteData Object

### Description
The `RemoteData` object is used to represent the full data pulled from the
third-party API for an object.
### Usage Example
TODO

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path:, data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::RemoteData

Parameters:

  • path (String) —

    The third-party API path that is being called.

  • data (Object) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



31
32
33
34
35
36
37
38
 
# File 'lib/merge_ruby_client/accounting/types/remote_data.rb', line 31

def initialize(path:, data: OMIT, additional_properties: nil)
  @path = path
  @data = data if data != OMIT
  @additional_properties = additional_properties
  @_field_set = { "path": path, "data": data }.reject do |_k, v|
    v == OMIT
  end
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



20
21
22
 
# File 'lib/merge_ruby_client/accounting/types/remote_data.rb', line 20

def additional_properties
  @additional_properties
end

#data ⇒ Object (readonly)

Returns:

  • (Object) 


18
19
20
 
# File 'lib/merge_ruby_client/accounting/types/remote_data.rb', line 18

def data
  @data
end

#path ⇒ String (readonly)

Returns The third-party API path that is being called.

Returns:

  • (String) —

    The third-party API path that is being called.



16
17
18
 
# File 'lib/merge_ruby_client/accounting/types/remote_data.rb', line 16

def path
  @path
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Accounting::RemoteData

Deserialize a JSON object to an instance of RemoteData

Parameters:

  • json_object (String)

Returns:



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/merge_ruby_client/accounting/types/remote_data.rb', line 44

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  path = parsed_json["path"]
  data = parsed_json["data"]
  new(
    path: path,
    data: data,
    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) 


69
70
71
72
 
# File 'lib/merge_ruby_client/accounting/types/remote_data.rb', line 69

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of RemoteData to a JSON object

Returns:

  • (String) 


59
60
61
 
# File 'lib/merge_ruby_client/accounting/types/remote_data.rb', line 59

def to_json(*_args)
  @_field_set&.to_json
end