Class: Merge::Crm::Task

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

Overview

# The Task Object

### Description
The `Task` object is used to represent a task, such as a to-do item.
### 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, subject: OMIT, content: OMIT, owner: OMIT, account: OMIT, opportunity: OMIT, completed_date: OMIT, due_date: OMIT, status: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Crm::Task 



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/merge_ruby_client/crm/types/task.rb', line 89

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, subject: OMIT, content: OMIT,
               owner: OMIT, account: OMIT, opportunity: OMIT, completed_date: OMIT, due_date: OMIT, status: 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
  @subject = subject if subject != OMIT
  @content = content if content != OMIT
  @owner = owner if owner != OMIT
  @account =  if  != OMIT
  @opportunity = opportunity if opportunity != OMIT
  @completed_date = completed_date if completed_date != OMIT
  @due_date = due_date if due_date != OMIT
  @status = status if status != 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,
    "subject": subject,
    "content": content,
    "owner": owner,
    "account": ,
    "opportunity": opportunity,
    "completed_date": completed_date,
    "due_date": due_date,
    "status": status,
    "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::TaskAccount (readonly) 



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

def 
  @account
end

#additional_properties ⇒ OpenStruct (readonly) 



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

def additional_properties
  @additional_properties
end

#completed_date ⇒ DateTime (readonly) 



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

def completed_date
  @completed_date
end

#content ⇒ String (readonly) 



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

def content
  @content
end

#created_at ⇒ DateTime (readonly) 



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

def created_at
  @created_at
end

#due_date ⇒ DateTime (readonly) 



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

def due_date
  @due_date
end

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



53
54
55
 
# File 'lib/merge_ruby_client/crm/types/task.rb', line 53

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly) 



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

def id
  @id
end

#modified_at ⇒ DateTime (readonly) 



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

def modified_at
  @modified_at
end

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



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

def opportunity
  @opportunity
end

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



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

def owner
  @owner
end

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



55
56
57
 
# File 'lib/merge_ruby_client/crm/types/task.rb', line 55

def remote_data
  @remote_data
end

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



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

def remote_fields
  @remote_fields
end

#remote_id ⇒ String (readonly) 



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

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly) 



51
52
53
 
# File 'lib/merge_ruby_client/crm/types/task.rb', line 51

def remote_was_deleted
  @remote_was_deleted
end

#status ⇒ Merge::Crm::TaskStatusEnum (readonly) 



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

def status
  @status
end

#subject ⇒ String (readonly) 



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

def subject
  @subject
end

Class Method Details

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

Deserialize a JSON object to an instance of Task



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
186
187
188
189
190
191
192
193
 
# File 'lib/merge_ruby_client/crm/types/task.rb', line 134

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?)
  subject = parsed_json["subject"]
  content = parsed_json["content"]
  if parsed_json["owner"].nil?
    owner = nil
  else
    owner = parsed_json["owner"].to_json
    owner = Merge::Crm::TaskOwner.from_json(json_object: owner)
  end
  if parsed_json["account"].nil?
     = nil
  else
     = parsed_json["account"].to_json
     = Merge::Crm::TaskAccount.from_json(json_object: )
  end
  if parsed_json["opportunity"].nil?
    opportunity = nil
  else
    opportunity = parsed_json["opportunity"].to_json
    opportunity = Merge::Crm::TaskOpportunity.from_json(json_object: opportunity)
  end
  completed_date = (DateTime.parse(parsed_json["completed_date"]) unless parsed_json["completed_date"].nil?)
  due_date = (DateTime.parse(parsed_json["due_date"]) unless parsed_json["due_date"].nil?)
  status = parsed_json["status"]
  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,
    subject: subject,
    content: content,
    owner: owner,
    account: ,
    opportunity: opportunity,
    completed_date: completed_date,
    due_date: due_date,
    status: status,
    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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/merge_ruby_client/crm/types/task.rb', line 208

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.subject&.is_a?(String) != false || raise("Passed value for field obj.subject is not the expected type, validation failed.")
  obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
  obj.owner.nil? || Merge::Crm::TaskOwner.validate_raw(obj: obj.owner)
  obj..nil? || Merge::Crm::TaskAccount.validate_raw(obj: obj.)
  obj.opportunity.nil? || Merge::Crm::TaskOpportunity.validate_raw(obj: obj.opportunity)
  obj.completed_date&.is_a?(DateTime) != false || raise("Passed value for field obj.completed_date is not the expected type, validation failed.")
  obj.due_date&.is_a?(DateTime) != false || raise("Passed value for field obj.due_date is not the expected type, validation failed.")
  obj.status&.is_a?(Merge::Crm::TaskStatusEnum) != false || raise("Passed value for field obj.status 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 Task to a JSON object



198
199
200
 
# File 'lib/merge_ruby_client/crm/types/task.rb', line 198

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