Class: Merge::Crm::Opportunity

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

Overview

# The Opportunity Object

### Description
The `Opportunity` object is used to represent a deal opportunity 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, name: OMIT, description: OMIT, amount: OMIT, owner: OMIT, account: OMIT, stage: OMIT, status: OMIT, last_activity_at: OMIT, close_date: OMIT, remote_created_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Crm::Opportunity

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.

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

    The opportunity’s name.

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

    The opportunity’s description.

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

    The opportunity’s amount.

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

    The opportunity’s owner.

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

    The account of the opportunity.

  • stage (Merge::Crm::OpportunityStage) (defaults to: OMIT) —

    The stage of the opportunity.

  • status (Merge::Crm::OpportunityStatusEnum) (defaults to: OMIT) —

    The opportunity’s status.

    • ‘OPEN` - OPEN

    • ‘WON` - WON

    • ‘LOST` - LOST

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

    When the opportunity’s last activity occurred.

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

    When the opportunity was closed.

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

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



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
135
 
# File 'lib/merge_ruby_client/crm/types/opportunity.rb', line 92

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, description: OMIT,
               amount: OMIT, owner: OMIT, account: OMIT, stage: OMIT, status: OMIT, last_activity_at: OMIT, close_date: 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
  @name = name if name != OMIT
  @description = description if description != OMIT
  @amount = amount if amount != OMIT
  @owner = owner if owner != OMIT
  @account =  if  != OMIT
  @stage = stage if stage != OMIT
  @status = status if status != OMIT
  @last_activity_at = last_activity_at if last_activity_at != OMIT
  @close_date = close_date if close_date != 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,
    "name": name,
    "description": description,
    "amount": amount,
    "owner": owner,
    "account": ,
    "stage": stage,
    "status": status,
    "last_activity_at": last_activity_at,
    "close_date": close_date,
    "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::OpportunityAccount (readonly)

Returns The account of the opportunity.

Returns:



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

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



62
63
64
 
# File 'lib/merge_ruby_client/crm/types/opportunity.rb', line 62

def additional_properties
  @additional_properties
end

#amount ⇒ Integer (readonly)

Returns The opportunity’s amount.

Returns:

  • (Integer) —

    The opportunity’s amount.



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

def amount
  @amount
end

#close_date ⇒ DateTime (readonly)

Returns When the opportunity was closed.

Returns:

  • (DateTime) —

    When the opportunity was closed.



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

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



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

def created_at
  @created_at
end

#description ⇒ String (readonly)

Returns The opportunity’s description.

Returns:

  • (String) —

    The opportunity’s description.



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

def description
  @description
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#last_activity_at ⇒ DateTime (readonly)

Returns When the opportunity’s last activity occurred.

Returns:

  • (DateTime) —

    When the opportunity’s last activity occurred.



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

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.



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

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The opportunity’s name.

Returns:

  • (String) —

    The opportunity’s name.



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

def name
  @name
end

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

Returns The opportunity’s owner.

Returns:



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

def owner
  @owner
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s opportunity was created.

Returns:

  • (DateTime) —

    When the third party’s opportunity was created.



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

def remote_created_at
  @remote_created_at
end

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

Returns:



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

def remote_data
  @remote_data
end

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

Returns:



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

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.



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

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


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

def remote_was_deleted
  @remote_was_deleted
end

#stage ⇒ Merge::Crm::OpportunityStage (readonly)

Returns The stage of the opportunity.

Returns:



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

def stage
  @stage
end

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

Returns The opportunity’s status.

  • ‘OPEN` - OPEN

  • ‘WON` - WON

  • ‘LOST` - LOST.

Returns:



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

def status
  @status
end

Class Method Details

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

Deserialize a JSON object to an instance of Opportunity

Parameters:

  • json_object (String)

Returns:



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
206
 
# File 'lib/merge_ruby_client/crm/types/opportunity.rb', line 141

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?)
  name = parsed_json["name"]
  description = parsed_json["description"]
  amount = parsed_json["amount"]
  if parsed_json["owner"].nil?
    owner = nil
  else
    owner = parsed_json["owner"].to_json
    owner = Merge::Crm::OpportunityOwner.from_json(json_object: owner)
  end
  if parsed_json["account"].nil?
     = nil
  else
     = parsed_json["account"].to_json
     = Merge::Crm::OpportunityAccount.from_json(json_object: )
  end
  if parsed_json["stage"].nil?
    stage = nil
  else
    stage = parsed_json["stage"].to_json
    stage = Merge::Crm::OpportunityStage.from_json(json_object: stage)
  end
  status = parsed_json["status"]
  last_activity_at = (DateTime.parse(parsed_json["last_activity_at"]) unless parsed_json["last_activity_at"].nil?)
  close_date = (DateTime.parse(parsed_json["close_date"]) unless parsed_json["close_date"].nil?)
  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,
    name: name,
    description: description,
    amount: amount,
    owner: owner,
    account: ,
    stage: stage,
    status: status,
    last_activity_at: last_activity_at,
    close_date: close_date,
    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) 


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/opportunity.rb', line 221

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.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.amount&.is_a?(Integer) != false || raise("Passed value for field obj.amount is not the expected type, validation failed.")
  obj.owner.nil? || Merge::Crm::OpportunityOwner.validate_raw(obj: obj.owner)
  obj..nil? || Merge::Crm::OpportunityAccount.validate_raw(obj: obj.)
  obj.stage.nil? || Merge::Crm::OpportunityStage.validate_raw(obj: obj.stage)
  obj.status&.is_a?(Merge::Crm::OpportunityStatusEnum) != false || raise("Passed value for field obj.status 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.close_date&.is_a?(DateTime) != false || raise("Passed value for field obj.close_date 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 Opportunity to a JSON object

Returns:

  • (String) 


211
212
213
 
# File 'lib/merge_ruby_client/crm/types/opportunity.rb', line 211

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