Class: Merge::Crm::EngagementType

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

Overview

# The Engagement Type Object

### Description
The `Engagement Type` object is used to represent an interaction activity. A
given `Engagement` typically has an `Engagement Type` object represented in the
engagement_type field.
### 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, activity_type: OMIT, name: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Crm::EngagementType

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.

  • activity_type (Merge::Crm::ActivityTypeEnum) (defaults to: OMIT) —

    The engagement type’s activity type.

    • ‘CALL` - CALL

    • ‘MEETING` - MEETING

    • ‘EMAIL` - EMAIL

  • name (String) (defaults to: OMIT) —

    The engagement type’s name.

  • remote_fields (Array<Merge::Crm::RemoteField>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/merge_ruby_client/crm/types/engagement_type.rb', line 56

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, activity_type: OMIT, name: OMIT,
               remote_fields: 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
  @activity_type = activity_type if activity_type != OMIT
  @name = name if name != OMIT
  @remote_fields = remote_fields if remote_fields != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "activity_type": activity_type,
    "name": name,
    "remote_fields": remote_fields
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#activity_type ⇒ Merge::Crm::ActivityTypeEnum (readonly)

Returns The engagement type’s activity type.

  • ‘CALL` - CALL

  • ‘MEETING` - MEETING

  • ‘EMAIL` - EMAIL.

Returns:



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

def activity_type
  @activity_type
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



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

def additional_properties
  @additional_properties
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



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

def created_at
  @created_at
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



26
27
28
 
# File 'lib/merge_ruby_client/crm/types/engagement_type.rb', line 26

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The engagement type’s name.

Returns:

  • (String) —

    The engagement type’s name.



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

def name
  @name
end

#remote_fields ⇒ Array<Merge::Crm::RemoteField> (readonly)

Returns:



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

def remote_fields
  @remote_fields
end

#remote_id ⇒ String (readonly)

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

Returns:

  • (String) —

    The third-party API ID of the matching object.



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

def remote_id
  @remote_id
end

Class Method Details

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

Deserialize a JSON object to an instance of EngagementType

Parameters:

  • json_object (String)

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/merge_ruby_client/crm/types/engagement_type.rb', line 83

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?)
  activity_type = parsed_json["activity_type"]
  name = parsed_json["name"]
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Crm::RemoteField.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    activity_type: activity_type,
    name: name,
    remote_fields: remote_fields,
    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) 


121
122
123
124
125
126
127
128
129
 
# File 'lib/merge_ruby_client/crm/types/engagement_type.rb', line 121

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.activity_type&.is_a?(Merge::Crm::ActivityTypeEnum) != false || raise("Passed value for field obj.activity_type is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.remote_fields&.is_a?(Array) != false || raise("Passed value for field obj.remote_fields is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of EngagementType to a JSON object

Returns:

  • (String) 


111
112
113
 
# File 'lib/merge_ruby_client/crm/types/engagement_type.rb', line 111

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