Class: Merge::Crm::AccountRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/types/account_request.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(owner: OMIT, name: OMIT, description: OMIT, industry: OMIT, website: OMIT, number_of_employees: OMIT, addresses: OMIT, last_activity_at: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Crm::AccountRequest

Parameters:

  • owner (Merge::Crm::AccountRequestOwner) (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::AddressRequest>) (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.

  • integration_params (Hash{String => Object}) (defaults to: OMIT)
  • linked_account_params (Hash{String => Object}) (defaults to: OMIT)
  • remote_fields (Array<Merge::Crm::RemoteFieldRequest>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/merge_ruby_client/crm/types/account_request.rb', line 63

def initialize(owner: OMIT, name: OMIT, description: OMIT, industry: OMIT, website: OMIT,
               number_of_employees: OMIT, addresses: OMIT, last_activity_at: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil)
  @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
  @last_activity_at = last_activity_at if last_activity_at != OMIT
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params =  if  != OMIT
  @remote_fields = remote_fields if remote_fields != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "owner": owner,
    "name": name,
    "description": description,
    "industry": industry,
    "website": website,
    "number_of_employees": number_of_employees,
    "addresses": addresses,
    "last_activity_at": last_activity_at,
    "integration_params": integration_params,
    "linked_account_params": ,
    "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



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

def additional_properties
  @additional_properties
end

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

Returns:



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

def addresses
  @addresses
end

#description ⇒ String (readonly)

Returns The account’s description.

Returns:

  • (String) —

    The account’s description.



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

def description
  @description
end

#industry ⇒ String (readonly)

Returns The account’s industry.

Returns:

  • (String) —

    The account’s industry.



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

def industry
  @industry
end

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

Returns:

  • (Hash{String => Object}) 


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

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



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

def last_activity_at
  @last_activity_at
end

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

Returns:

  • (Hash{String => Object}) 


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

def 
  @linked_account_params
end

#name ⇒ String (readonly)

Returns The account’s name.

Returns:

  • (String) —

    The account’s name.



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

def name
  @name
end

#number_of_employees ⇒ Integer (readonly)

Returns The account’s number of employees.

Returns:

  • (Integer) —

    The account’s number of employees.



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

def number_of_employees
  @number_of_employees
end

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

Returns The account’s owner.

Returns:



19
20
21
 
# File 'lib/merge_ruby_client/crm/types/account_request.rb', line 19

def owner
  @owner
end

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

Returns:



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

def remote_fields
  @remote_fields
end

#website ⇒ String (readonly)

Returns The account’s website.

Returns:

  • (String) —

    The account’s website.



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

def website
  @website
end

Class Method Details

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

Deserialize a JSON object to an instance of AccountRequest

Parameters:

  • json_object (String)

Returns:



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
135
136
137
 
# File 'lib/merge_ruby_client/crm/types/account_request.rb', line 98

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["owner"].nil?
    owner = nil
  else
    owner = parsed_json["owner"].to_json
    owner = Merge::Crm::AccountRequestOwner.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::AddressRequest.from_json(json_object: item)
  end
  last_activity_at = (DateTime.parse(parsed_json["last_activity_at"]) unless parsed_json["last_activity_at"].nil?)
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Crm::RemoteFieldRequest.from_json(json_object: item)
  end
  new(
    owner: owner,
    name: name,
    description: description,
    industry: industry,
    website: website,
    number_of_employees: number_of_employees,
    addresses: addresses,
    last_activity_at: last_activity_at,
    integration_params: integration_params,
    linked_account_params: ,
    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) 


152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/merge_ruby_client/crm/types/account_request.rb', line 152

def self.validate_raw(obj:)
  obj.owner.nil? || Merge::Crm::AccountRequestOwner.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.last_activity_at&.is_a?(DateTime) != false || raise("Passed value for field obj.last_activity_at is not the expected type, validation failed.")
  obj.integration_params&.is_a?(Hash) != false || raise("Passed value for field obj.integration_params is not the expected type, validation failed.")
  obj.&.is_a?(Hash) != false || raise("Passed value for field obj.linked_account_params 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 AccountRequest to a JSON object

Returns:

  • (String) 


142
143
144
 
# File 'lib/merge_ruby_client/crm/types/account_request.rb', line 142

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