Class: Merge::Crm::AssociationType

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

Overview

# The AssociationType Object

### Description
The `Association Type` object represents the relationship between two objects.
### Usage Example
TODO

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, source_object_class: OMIT, target_object_classes: OMIT, remote_key_name: OMIT, display_name: OMIT, cardinality: OMIT, is_required: OMIT, additional_properties: nil) ⇒ Merge::Crm::AssociationType

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT)

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT)

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT)

    The datetime that this object was modified by Merge.

  • source_object_class (Hash{String => Object}) (defaults to: OMIT)

    The class of the source object (Custom Object or Common Model) for the association type.

  • target_object_classes (Array<Merge::Crm::AssociationSubType>) (defaults to: OMIT)
  • remote_key_name (String) (defaults to: OMIT)
  • display_name (String) (defaults to: OMIT)
  • cardinality (Merge::Crm::CardinalityEnum) (defaults to: OMIT)
  • is_required (Boolean) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition

[View source]

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 59

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, source_object_class: OMIT,
               target_object_classes: OMIT, remote_key_name: OMIT, display_name: OMIT, cardinality: OMIT, is_required: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @source_object_class = source_object_class if source_object_class != OMIT
  @target_object_classes = target_object_classes if target_object_classes != OMIT
  @remote_key_name = remote_key_name if remote_key_name != OMIT
  @display_name = display_name if display_name != OMIT
  @cardinality = cardinality if cardinality != OMIT
  @is_required = is_required if is_required != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "source_object_class": source_object_class,
    "target_object_classes": target_object_classes,
    "remote_key_name": remote_key_name,
    "display_name": display_name,
    "cardinality": cardinality,
    "is_required": is_required
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_propertiesOpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct)

    Additional properties unmapped to the current class definition


39
40
41
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 39

def additional_properties
  @additional_properties
end

#cardinalityMerge::Crm::CardinalityEnum (readonly)


35
36
37
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 35

def cardinality
  @cardinality
end

#created_atDateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime)

    The datetime that this object was created by Merge.


22
23
24
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 22

def created_at
  @created_at
end

#display_nameString (readonly)

Returns:

  • (String)

33
34
35
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 33

def display_name
  @display_name
end

#idString (readonly)

Returns:

  • (String)

18
19
20
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 18

def id
  @id
end

#is_requiredBoolean (readonly)

Returns:

  • (Boolean)

37
38
39
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 37

def is_required
  @is_required
end

#modified_atDateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime)

    The datetime that this object was modified by Merge.


24
25
26
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 24

def modified_at
  @modified_at
end

#remote_idString (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String)

    The third-party API ID of the matching object.


20
21
22
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 20

def remote_id
  @remote_id
end

#remote_key_nameString (readonly)

Returns:

  • (String)

31
32
33
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 31

def remote_key_name
  @remote_key_name
end

#source_object_classHash{String => Object} (readonly)

Returns The class of the source object (Custom Object or Common Model) for the association type.

Returns:

  • (Hash{String => Object})

    The class of the source object (Custom Object or Common Model) for the association type.


27
28
29
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 27

def source_object_class
  @source_object_class
end

#target_object_classesArray<Merge::Crm::AssociationSubType> (readonly)

Returns:


29
30
31
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 29

def target_object_classes
  @target_object_classes
end

Class Method Details

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

Deserialize a JSON object to an instance of AssociationType

Parameters:

  • json_object (String)

Returns:

[View source]

92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 92

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  source_object_class = parsed_json["source_object_class"]
  target_object_classes = parsed_json["target_object_classes"]&.map do |item|
    item = item.to_json
    Merge::Crm::AssociationSubType.from_json(json_object: item)
  end
  remote_key_name = parsed_json["remote_key_name"]
  display_name = parsed_json["display_name"]
  cardinality = parsed_json["cardinality"]
  is_required = parsed_json["is_required"]
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    source_object_class: source_object_class,
    target_object_classes: target_object_classes,
    remote_key_name: remote_key_name,
    display_name: display_name,
    cardinality: cardinality,
    is_required: is_required,
    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)
[View source]

136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 136

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.source_object_class&.is_a?(Hash) != false || raise("Passed value for field obj.source_object_class is not the expected type, validation failed.")
  obj.target_object_classes&.is_a?(Array) != false || raise("Passed value for field obj.target_object_classes is not the expected type, validation failed.")
  obj.remote_key_name&.is_a?(String) != false || raise("Passed value for field obj.remote_key_name is not the expected type, validation failed.")
  obj.display_name&.is_a?(String) != false || raise("Passed value for field obj.display_name is not the expected type, validation failed.")
  obj.cardinality&.is_a?(Merge::Crm::CardinalityEnum) != false || raise("Passed value for field obj.cardinality is not the expected type, validation failed.")
  obj.is_required&.is_a?(Boolean) != false || raise("Passed value for field obj.is_required is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of AssociationType to a JSON object

Returns:

  • (String)
[View source]

126
127
128
# File 'lib/merge_ruby_client/crm/types/association_type.rb', line 126

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