Class: Merge::Crm::Account

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

Overview

# The Account Object

### Description
The `Account` object is used to represent a company in a CRM system.
### 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, name: OMIT, description: OMIT, industry: OMIT, website: OMIT, number_of_employees: OMIT, addresses: OMIT, phone_numbers: OMIT, last_activity_at: 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::Account

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::AccountOwner) (defaults to: OMIT) —

    The account’s owner.

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

    The account’s name.

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

    The account’s description.

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

    The account’s industry.

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

    The account’s website.

  • number_of_employees (Integer) (defaults to: OMIT) —

    The account’s number of employees.

  • addresses (Array<Merge::Crm::Address>) (defaults to: OMIT)
  • phone_numbers (Array<Merge::Crm::PhoneNumber>) (defaults to: OMIT)
  • last_activity_at (DateTime) (defaults to: OMIT) —

    The last date (either most recent or furthest in the future) of when an activity occurs in an account.

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

    When the CRM system account data was last modified by a user with a login.

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

    When the third party’s account 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



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
129
130
131
132
133
134
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 89

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, owner: OMIT, name: OMIT,
               description: OMIT, industry: OMIT, website: OMIT, number_of_employees: OMIT, addresses: OMIT, phone_numbers: OMIT, last_activity_at: 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
  @name = name if name != OMIT
  @description = description if description != OMIT
  @industry = industry if industry != OMIT
  @website = website if website != OMIT
  @number_of_employees = number_of_employees if number_of_employees != OMIT
  @addresses = addresses if addresses != OMIT
  @phone_numbers = phone_numbers if phone_numbers != OMIT
  @last_activity_at = last_activity_at if last_activity_at != 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,
    "name": name,
    "description": description,
    "industry": industry,
    "website": website,
    "number_of_employees": number_of_employees,
    "addresses": addresses,
    "phone_numbers": phone_numbers,
    "last_activity_at": last_activity_at,
    "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

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



60
61
62
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 60

def additional_properties
  @additional_properties
end

#addresses ⇒ Array<Merge::Crm::Address> (readonly)

Returns:



41
42
43
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 41

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



25
26
27
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 25

def created_at
  @created_at
end

#description ⇒ String (readonly)

Returns The account’s description.

Returns:

  • (String) —

    The account’s description.



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

def description
  @description
end

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

Returns:

  • (Hash{String => Object}) 


54
55
56
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 54

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


21
22
23
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 21

def id
  @id
end

#industry ⇒ String (readonly)

Returns The account’s industry.

Returns:

  • (String) —

    The account’s industry.



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

def industry
  @industry
end

#last_activity_at ⇒ DateTime (readonly)

Returns The last date (either most recent or furthest in the future) of when an activity occurs in an account.

Returns:

  • (DateTime) —

    The last date (either most recent or furthest in the future) of when an activity occurs in an account.



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

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



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

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The account’s name.

Returns:

  • (String) —

    The account’s name.



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

def name
  @name
end

#number_of_employees ⇒ Integer (readonly)

Returns The account’s number of employees.

Returns:

  • (Integer) —

    The account’s number of employees.



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

def number_of_employees
  @number_of_employees
end

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

Returns The account’s owner.

Returns:



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

def owner
  @owner
end

#phone_numbers ⇒ Array<Merge::Crm::PhoneNumber> (readonly)

Returns:



43
44
45
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 43

def phone_numbers
  @phone_numbers
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s account was created.

Returns:

  • (DateTime) —

    When the third party’s account was created.



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

def remote_created_at
  @remote_created_at
end

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

Returns:



56
57
58
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 56

def remote_data
  @remote_data
end

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

Returns:



58
59
60
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 58

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.



23
24
25
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 23

def remote_id
  @remote_id
end

#remote_updated_at ⇒ DateTime (readonly)

Returns When the CRM system account data was last modified by a user with a login.

Returns:

  • (DateTime) —

    When the CRM system account data was last modified by a user with a login.



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

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


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

def remote_was_deleted
  @remote_was_deleted
end

#website ⇒ String (readonly)

Returns The account’s website.

Returns:

  • (String) —

    The account’s website.



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

def website
  @website
end

Class Method Details

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

Deserialize a JSON object to an instance of Account

Parameters:

  • json_object (String)

Returns:



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
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 140

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::AccountOwner.from_json(json_object: owner)
  end
  name = parsed_json["name"]
  description = parsed_json["description"]
  industry = parsed_json["industry"]
  website = parsed_json["website"]
  number_of_employees = parsed_json["number_of_employees"]
  addresses = parsed_json["addresses"]&.map do |item|
    item = item.to_json
    Merge::Crm::Address.from_json(json_object: item)
  end
  phone_numbers = parsed_json["phone_numbers"]&.map do |item|
    item = item.to_json
    Merge::Crm::PhoneNumber.from_json(json_object: item)
  end
  last_activity_at = (DateTime.parse(parsed_json["last_activity_at"]) unless parsed_json["last_activity_at"].nil?)
  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,
    name: name,
    description: description,
    industry: industry,
    website: website,
    number_of_employees: number_of_employees,
    addresses: addresses,
    phone_numbers: phone_numbers,
    last_activity_at: last_activity_at,
    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) 


220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 220

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::AccountOwner.validate_raw(obj: obj.owner)
  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.industry&.is_a?(String) != false || raise("Passed value for field obj.industry is not the expected type, validation failed.")
  obj.website&.is_a?(String) != false || raise("Passed value for field obj.website is not the expected type, validation failed.")
  obj.number_of_employees&.is_a?(Integer) != false || raise("Passed value for field obj.number_of_employees is not the expected type, validation failed.")
  obj.addresses&.is_a?(Array) != false || raise("Passed value for field obj.addresses is not the expected type, validation failed.")
  obj.phone_numbers&.is_a?(Array) != false || raise("Passed value for field obj.phone_numbers is not the expected type, validation failed.")
  obj.last_activity_at&.is_a?(DateTime) != false || raise("Passed value for field obj.last_activity_at is not the expected type, validation failed.")
  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 Account to a JSON object

Returns:

  • (String) 


210
211
212
 
# File 'lib/merge_ruby_client/crm/types/account.rb', line 210

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