Class: Merge::Crm::RemoteEndpointInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/types/remote_endpoint_info.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method:, url_path:, field_traversal_path:, additional_properties: nil) ⇒ Merge::Crm::RemoteEndpointInfo

Parameters:

  • method (String)
  • url_path (String)
  • field_traversal_path (Array<Object>)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



28
29
30
31
32
33
34
 
# File 'lib/merge_ruby_client/crm/types/remote_endpoint_info.rb', line 28

def initialize(method:, url_path:, field_traversal_path:, additional_properties: nil)
  @method = method
  @url_path = url_path
  @field_traversal_path = field_traversal_path
  @additional_properties = additional_properties
  @_field_set = { "method": method, "url_path": url_path, "field_traversal_path": field_traversal_path }
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



16
17
18
 
# File 'lib/merge_ruby_client/crm/types/remote_endpoint_info.rb', line 16

def additional_properties
  @additional_properties
end

#field_traversal_path ⇒ Array<Object> (readonly)

Returns:

  • (Array<Object>) 


14
15
16
 
# File 'lib/merge_ruby_client/crm/types/remote_endpoint_info.rb', line 14

def field_traversal_path
  @field_traversal_path
end

#method ⇒ String (readonly)

Returns:

  • (String) 


10
11
12
 
# File 'lib/merge_ruby_client/crm/types/remote_endpoint_info.rb', line 10

def method
  @method
end

#url_path ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/merge_ruby_client/crm/types/remote_endpoint_info.rb', line 12

def url_path
  @url_path
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Crm::RemoteEndpointInfo

Deserialize a JSON object to an instance of RemoteEndpointInfo

Parameters:

  • json_object (String)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/merge_ruby_client/crm/types/remote_endpoint_info.rb', line 40

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


67
68
69
70
71
 
# File 'lib/merge_ruby_client/crm/types/remote_endpoint_info.rb', line 67

def self.validate_raw(obj:)
  obj.method.is_a?(String) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
  obj.url_path.is_a?(String) != false || raise("Passed value for field obj.url_path is not the expected type, validation failed.")
  obj.field_traversal_path.is_a?(Array) != false || raise("Passed value for field obj.field_traversal_path is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of RemoteEndpointInfo to a JSON object

Returns:

  • (String) 


57
58
59
 
# File 'lib/merge_ruby_client/crm/types/remote_endpoint_info.rb', line 57

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