Class: Merge::Crm::PatchedOpportunityRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/types/patched_opportunity_request.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(name: OMIT, description: OMIT, amount: OMIT, owner: OMIT, account: OMIT, stage: OMIT, status: OMIT, last_activity_at: OMIT, close_date: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Crm::PatchedOpportunityRequest

Parameters:

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

    The opportunity’s owner.

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

    The account of the opportunity.

  • stage (String) (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.

  • 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



70
71
72
73
74
75
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
 
# File 'lib/merge_ruby_client/crm/types/patched_opportunity_request.rb', line 70

def initialize(name: OMIT, description: OMIT, amount: OMIT, owner: OMIT, account: OMIT, stage: OMIT,
               status: OMIT, last_activity_at: OMIT, close_date: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil)
  @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
  @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 = {
    "name": name,
    "description": description,
    "amount": amount,
    "owner": owner,
    "account": ,
    "stage": stage,
    "status": status,
    "last_activity_at": last_activity_at,
    "close_date": close_date,
    "integration_params": integration_params,
    "linked_account_params": ,
    "remote_fields": remote_fields
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#account ⇒ String (readonly)

Returns The account of the opportunity.

Returns:

  • (String) —

    The account of the opportunity.



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

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



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

def additional_properties
  @additional_properties
end

#amount ⇒ Integer (readonly)

Returns The opportunity’s amount.

Returns:

  • (Integer) —

    The opportunity’s amount.



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

def amount
  @amount
end

#close_date ⇒ DateTime (readonly)

Returns When the opportunity was closed.

Returns:

  • (DateTime) —

    When the opportunity was closed.



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

def close_date
  @close_date
end

#description ⇒ String (readonly)

Returns The opportunity’s description.

Returns:

  • (String) —

    The opportunity’s description.



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

def description
  @description
end

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

Returns:

  • (Hash{String => Object}) 


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

def integration_params
  @integration_params
end

#last_activity_at ⇒ DateTime (readonly)

Returns When the opportunity’s last activity occurred.

Returns:

  • (DateTime) —

    When the opportunity’s last activity occurred.



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

def last_activity_at
  @last_activity_at
end

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

Returns:

  • (Hash{String => Object}) 


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

def 
  @linked_account_params
end

#name ⇒ String (readonly)

Returns The opportunity’s name.

Returns:

  • (String) —

    The opportunity’s name.



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

def name
  @name
end

#owner ⇒ String (readonly)

Returns The opportunity’s owner.

Returns:

  • (String) —

    The opportunity’s owner.



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

def owner
  @owner
end

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

Returns:



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

def remote_fields
  @remote_fields
end

#stage ⇒ String (readonly)

Returns The stage of the opportunity.

Returns:

  • (String) —

    The stage of the opportunity.



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

def stage
  @stage
end

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

Returns The opportunity’s status.

  • ‘OPEN` - OPEN

  • ‘WON` - WON

  • ‘LOST` - LOST.

Returns:



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

def status
  @status
end

Class Method Details

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

Deserialize a JSON object to an instance of PatchedOpportunityRequest

Parameters:

  • json_object (String)

Returns:



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
138
139
140
 
# File 'lib/merge_ruby_client/crm/types/patched_opportunity_request.rb', line 107

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  name = parsed_json["name"]
  description = parsed_json["description"]
  amount = parsed_json["amount"]
  owner = parsed_json["owner"]
   = parsed_json["account"]
  stage = parsed_json["stage"]
  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?)
  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(
    name: name,
    description: description,
    amount: amount,
    owner: owner,
    account: ,
    stage: stage,
    status: status,
    last_activity_at: last_activity_at,
    close_date: close_date,
    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) 


155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/merge_ruby_client/crm/types/patched_opportunity_request.rb', line 155

def self.validate_raw(obj:)
  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&.is_a?(String) != false || raise("Passed value for field obj.owner is not the expected type, validation failed.")
  obj.&.is_a?(String) != false || raise("Passed value for field obj.account is not the expected type, validation failed.")
  obj.stage&.is_a?(String) != false || raise("Passed value for field obj.stage is not the expected type, validation failed.")
  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.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 PatchedOpportunityRequest to a JSON object

Returns:

  • (String) 


145
146
147
 
# File 'lib/merge_ruby_client/crm/types/patched_opportunity_request.rb', line 145

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