Class: Merge::Crm::Note

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

Overview

# The Note Object

### Description
The `Note` object is used to represent a note on another 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(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, owner: OMIT, content: OMIT, contact: OMIT, account: OMIT, opportunity: OMIT, remote_updated_at: OMIT, remote_created_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Crm::Note

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.

  • owner (Merge::Crm::NoteOwner) (defaults to: OMIT) —

    The note’s owner.

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

    The note’s content.

  • contact (Merge::Crm::NoteContact) (defaults to: OMIT) —

    The note’s contact.

  • account (Merge::Crm::NoteAccount) (defaults to: OMIT) —

    The note’s account.

  • opportunity (Merge::Crm::NoteOpportunity) (defaults to: OMIT) —

    The note’s opportunity.

  • remote_updated_at (DateTime) (defaults to: OMIT) —

    When the third party’s lead was updated.

  • remote_created_at (DateTime) (defaults to: OMIT) —

    When the third party’s lead was created.

  • remote_was_deleted (Boolean) (defaults to: OMIT)
  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Crm::RemoteData>) (defaults to: OMIT)
  • remote_fields (Array<Merge::Crm::RemoteField>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 76

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, owner: OMIT, content: OMIT,
               contact: OMIT, account: OMIT, opportunity: OMIT, remote_updated_at: OMIT, remote_created_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: 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
  @owner = owner if owner != OMIT
  @content = content if content != OMIT
  @contact = contact if contact != OMIT
  @account =  if  != OMIT
  @opportunity = opportunity if opportunity != OMIT
  @remote_updated_at = remote_updated_at if remote_updated_at != OMIT
  @remote_created_at = remote_created_at if remote_created_at != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != 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,
    "owner": owner,
    "content": content,
    "contact": contact,
    "account": ,
    "opportunity": opportunity,
    "remote_updated_at": remote_updated_at,
    "remote_created_at": remote_created_at,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data,
    "remote_fields": remote_fields
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#account ⇒ Merge::Crm::NoteAccount (readonly)

Returns The note’s account.

Returns:



36
37
38
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 36

def 
  @account
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



52
53
54
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 52

def additional_properties
  @additional_properties
end

#contact ⇒ Merge::Crm::NoteContact (readonly)

Returns The note’s contact.

Returns:



34
35
36
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 34

def contact
  @contact
end

#content ⇒ String (readonly)

Returns The note’s content.

Returns:

  • (String) —

    The note’s content.



32
33
34
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 32

def content
  @content
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.



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

def created_at
  @created_at
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


46
47
48
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 46

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

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.



28
29
30
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 28

def modified_at
  @modified_at
end

#opportunity ⇒ Merge::Crm::NoteOpportunity (readonly)

Returns The note’s opportunity.

Returns:



38
39
40
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 38

def opportunity
  @opportunity
end

#owner ⇒ Merge::Crm::NoteOwner (readonly)

Returns The note’s owner.

Returns:



30
31
32
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 30

def owner
  @owner
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s lead was created.

Returns:

  • (DateTime) —

    When the third party’s lead was created.



42
43
44
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 42

def remote_created_at
  @remote_created_at
end

#remote_data ⇒ Array<Merge::Crm::RemoteData> (readonly)

Returns:



48
49
50
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 48

def remote_data
  @remote_data
end

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

Returns:



50
51
52
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 50

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.



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

def remote_id
  @remote_id
end

#remote_updated_at ⇒ DateTime (readonly)

Returns When the third party’s lead was updated.

Returns:

  • (DateTime) —

    When the third party’s lead was updated.



40
41
42
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 40

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 44

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of Note

Parameters:

  • json_object (String)

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 119

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?)
  if parsed_json["owner"].nil?
    owner = nil
  else
    owner = parsed_json["owner"].to_json
    owner = Merge::Crm::NoteOwner.from_json(json_object: owner)
  end
  content = parsed_json["content"]
  if parsed_json["contact"].nil?
    contact = nil
  else
    contact = parsed_json["contact"].to_json
    contact = Merge::Crm::NoteContact.from_json(json_object: contact)
  end
  if parsed_json["account"].nil?
     = nil
  else
     = parsed_json["account"].to_json
     = Merge::Crm::NoteAccount.from_json(json_object: )
  end
  if parsed_json["opportunity"].nil?
    opportunity = nil
  else
    opportunity = parsed_json["opportunity"].to_json
    opportunity = Merge::Crm::NoteOpportunity.from_json(json_object: opportunity)
  end
  remote_updated_at = unless parsed_json["remote_updated_at"].nil?
                        DateTime.parse(parsed_json["remote_updated_at"])
                      end
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Crm::RemoteData.from_json(json_object: item)
  end
  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,
    owner: owner,
    content: content,
    contact: contact,
    account: ,
    opportunity: opportunity,
    remote_updated_at: remote_updated_at,
    remote_created_at: remote_created_at,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    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) 


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 200

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.owner.nil? || Merge::Crm::NoteOwner.validate_raw(obj: obj.owner)
  obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
  obj.contact.nil? || Merge::Crm::NoteContact.validate_raw(obj: obj.contact)
  obj..nil? || Merge::Crm::NoteAccount.validate_raw(obj: obj.)
  obj.opportunity.nil? || Merge::Crm::NoteOpportunity.validate_raw(obj: obj.opportunity)
  obj.remote_updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_updated_at is not the expected type, validation failed.")
  obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data 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 Note to a JSON object

Returns:

  • (String) 


190
191
192
 
# File 'lib/merge_ruby_client/crm/types/note.rb', line 190

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