Class: Merge::Crm::ExternalTargetFieldApi

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: OMIT, description: OMIT, is_mapped: OMIT, additional_properties: nil) ⇒ Merge::Crm::ExternalTargetFieldApi

Parameters:

  • name (String) (defaults to: OMIT)
  • description (String) (defaults to: OMIT)
  • is_mapped (String) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(name: OMIT, description: OMIT, is_mapped: OMIT, additional_properties: nil)
  @name = name if name != OMIT
  @description = description if description != OMIT
  @is_mapped = is_mapped if is_mapped != OMIT
  @additional_properties = additional_properties
  @_field_set = { "name": name, "description": description, "is_mapped": is_mapped }.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



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

def additional_properties
  @additional_properties
end

#description ⇒ String (readonly)

Returns:

  • (String) 


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

def description
  @description
end

#is_mapped ⇒ String (readonly)

Returns:

  • (String) 


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

def is_mapped
  @is_mapped
end

#name ⇒ String (readonly)

Returns:

  • (String) 


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

def name
  @name
end

Class Method Details

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

Deserialize a JSON object to an instance of ExternalTargetFieldApi

Parameters:

  • json_object (String)

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/merge_ruby_client/crm/types/external_target_field_api.rb', line 42

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  name = parsed_json["name"]
  description = parsed_json["description"]
  is_mapped = parsed_json["is_mapped"]
  new(
    name: name,
    description: description,
    is_mapped: is_mapped,
    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
73
 
# File 'lib/merge_ruby_client/crm/types/external_target_field_api.rb', line 69

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ExternalTargetFieldApi to a JSON object

Returns:

  • (String) 


59
60
61
 
# File 'lib/merge_ruby_client/crm/types/external_target_field_api.rb', line 59

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