Class: MergeCRMClient::OpportunitiesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_crm_client/api/opportunities_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OpportunitiesApi

Returns a new instance of OpportunitiesApi.



19
20
21
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#opportunities_create(x_account_token, opportunity_endpoint_request, opts = {}) ⇒ OpportunityResponse

Creates an ‘Opportunity` object with the given values.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opportunity_endpoint_request (OpportunityEndpointRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_debug_mode (Boolean) —

    Whether to include debug fields (such as log file links) in the response.

  • :run_async (Boolean) —

    Whether or not third-party updates should be run asynchronously.

Returns:



29
30
31
32
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 29

def opportunities_create(, opportunity_endpoint_request, opts = {})
  data, _status_code, _headers = opportunities_create_with_http_info(, opportunity_endpoint_request, opts)
  data
end

#opportunities_create_with_http_info(x_account_token, opportunity_endpoint_request, opts = {}) ⇒ Array<(OpportunityResponse, Integer, Hash)>

Creates an &#x60;Opportunity&#x60; object with the given values.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opportunity_endpoint_request (OpportunityEndpointRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_debug_mode (Boolean) —

    Whether to include debug fields (such as log file links) in the response.

  • :run_async (Boolean) —

    Whether or not third-party updates should be run asynchronously.

Returns:

  • (Array<(OpportunityResponse, Integer, Hash)>) —

    OpportunityResponse data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
93
94
95
96
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 41

def opportunities_create_with_http_info(, opportunity_endpoint_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunitiesApi.opportunities_create ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling OpportunitiesApi.opportunities_create"
  end
  # verify the required parameter 'opportunity_endpoint_request' is set
  if @api_client.config.client_side_validation && opportunity_endpoint_request.nil?
    fail ArgumentError, "Missing the required parameter 'opportunity_endpoint_request' when calling OpportunitiesApi.opportunities_create"
  end
  # resource path
  local_var_path = '/opportunities'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil?
  query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opportunity_endpoint_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OpportunityResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"OpportunitiesApi.opportunities_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#opportunities_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#opportunities_list(x_account_token, opts = {}) ⇒ PaginatedOpportunityList

Returns a list of ‘Opportunity` objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    If provided, will only return opportunities with this account.

  • :created_after (Time) —

    If provided, will only return objects created after this datetime.

  • :created_before (Time) —

    If provided, will only return objects created before this datetime.

  • :cursor (String) —

    The pagination cursor value.

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :modified_after (Time) —

    If provided, will only return objects modified after this datetime.

  • :modified_before (Time) —

    If provided, will only return objects modified before this datetime.

  • :owner_id (String) —

    If provided, will only return opportunities with this owner.

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_fields (String) —

    Which fields should be returned in non-normalized form.

  • :remote_id (String) —

    The API provider&#39;s ID for the given object.

  • :stage_id (String) —

    If provided, will only return opportunities with this stage.

  • :status (String) —

    If provided, will only return opportunities with this status. Options: (&#39;OPEN&#39;, &#39;WON&#39;, &#39;LOST&#39;)

Returns:



117
118
119
120
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 117

def opportunities_list(, opts = {})
  data, _status_code, _headers = opportunities_list_with_http_info(, opts)
  data
end

#opportunities_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedOpportunityList, Integer, Hash)>

Returns a list of &#x60;Opportunity&#x60; objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    If provided, will only return opportunities with this account.

  • :created_after (Time) —

    If provided, will only return objects created after this datetime.

  • :created_before (Time) —

    If provided, will only return objects created before this datetime.

  • :cursor (String) —

    The pagination cursor value.

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :modified_after (Time) —

    If provided, will only return objects modified after this datetime.

  • :modified_before (Time) —

    If provided, will only return objects modified before this datetime.

  • :owner_id (String) —

    If provided, will only return opportunities with this owner.

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_fields (String) —

    Which fields should be returned in non-normalized form.

  • :remote_id (String) —

    The API provider&#39;s ID for the given object.

  • :stage_id (String) —

    If provided, will only return opportunities with this stage.

  • :status (String) —

    If provided, will only return opportunities with this status. Options: (&#39;OPEN&#39;, &#39;WON&#39;, &#39;LOST&#39;)

Returns:

  • (Array<(PaginatedOpportunityList, Integer, Hash)>) —

    PaginatedOpportunityList data, response status code and response headers



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
207
208
209
210
211
212
213
214
215
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 141

def opportunities_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunitiesApi.opportunities_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling OpportunitiesApi.opportunities_list"
  end
  allowable_values = ["account", "owner", "owner,account", "owner,stage", "owner,stage,account", "stage", "stage,account"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  allowable_values = ["status"]
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
    fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
  end
  allowable_values = ["LOST", "OPEN", "WON"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/opportunities'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
  query_params[:'owner_id'] = opts[:'owner_id'] if !opts[:'owner_id'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
  query_params[:'stage_id'] = opts[:'stage_id'] if !opts[:'stage_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedOpportunityList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"OpportunitiesApi.opportunities_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#opportunities_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#opportunities_meta_patch_retrieve(x_account_token, id, opts = {}) ⇒ MetaResponse

Returns metadata for ‘Opportunity` PATCHs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



222
223
224
225
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 222

def opportunities_meta_patch_retrieve(, id, opts = {})
  data, _status_code, _headers = opportunities_meta_patch_retrieve_with_http_info(, id, opts)
  data
end

#opportunities_meta_patch_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>

Returns metadata for &#x60;Opportunity&#x60; PATCHs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MetaResponse, Integer, Hash)>) —

    MetaResponse data, response status code and response headers



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 232

def opportunities_meta_patch_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunitiesApi.opportunities_meta_patch_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling OpportunitiesApi.opportunities_meta_patch_retrieve"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.opportunities_meta_patch_retrieve"
  end
  # resource path
  local_var_path = '/opportunities/meta/patch/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"OpportunitiesApi.opportunities_meta_patch_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#opportunities_meta_patch_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#opportunities_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse

Returns metadata for ‘Opportunity` POSTs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 289

def opportunities_meta_post_retrieve(, opts = {})
  data, _status_code, _headers = opportunities_meta_post_retrieve_with_http_info(, opts)
  data
end

#opportunities_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>

Returns metadata for &#x60;Opportunity&#x60; POSTs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MetaResponse, Integer, Hash)>) —

    MetaResponse data, response status code and response headers



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 298

def opportunities_meta_post_retrieve_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunitiesApi.opportunities_meta_post_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling OpportunitiesApi.opportunities_meta_post_retrieve"
  end
  # resource path
  local_var_path = '/opportunities/meta/post'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"OpportunitiesApi.opportunities_meta_post_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#opportunities_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#opportunities_partial_update(x_account_token, id, patched_opportunity_endpoint_request, opts = {}) ⇒ OpportunityResponse

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • patched_opportunity_endpoint_request (PatchedOpportunityEndpointRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_debug_mode (Boolean) —

    Whether to include debug fields (such as log file links) in the response.

  • :run_async (Boolean) —

    Whether or not third-party updates should be run asynchronously.

Returns:



354
355
356
357
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 354

def opportunities_partial_update(, id, patched_opportunity_endpoint_request, opts = {})
  data, _status_code, _headers = opportunities_partial_update_with_http_info(, id, patched_opportunity_endpoint_request, opts)
  data
end

#opportunities_partial_update_with_http_info(x_account_token, id, patched_opportunity_endpoint_request, opts = {}) ⇒ Array<(OpportunityResponse, Integer, Hash)>

Returns OpportunityResponse data, response status code and response headers.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • patched_opportunity_endpoint_request (PatchedOpportunityEndpointRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_debug_mode (Boolean) —

    Whether to include debug fields (such as log file links) in the response.

  • :run_async (Boolean) —

    Whether or not third-party updates should be run asynchronously.

Returns:

  • (Array<(OpportunityResponse, Integer, Hash)>) —

    OpportunityResponse data, response status code and response headers



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 366

def opportunities_partial_update_with_http_info(, id, patched_opportunity_endpoint_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunitiesApi.opportunities_partial_update ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling OpportunitiesApi.opportunities_partial_update"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.opportunities_partial_update"
  end
  # verify the required parameter 'patched_opportunity_endpoint_request' is set
  if @api_client.config.client_side_validation && patched_opportunity_endpoint_request.nil?
    fail ArgumentError, "Missing the required parameter 'patched_opportunity_endpoint_request' when calling OpportunitiesApi.opportunities_partial_update"
  end
  # resource path
  local_var_path = '/opportunities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil?
  query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patched_opportunity_endpoint_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OpportunityResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"OpportunitiesApi.opportunities_partial_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#opportunities_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#opportunities_retrieve(x_account_token, id, opts = {}) ⇒ Opportunity

Returns an ‘Opportunity` object with the given `id`.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :remote_fields (String) —

    Which fields should be returned in non-normalized form.

Returns:



435
436
437
438
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 435

def opportunities_retrieve(, id, opts = {})
  data, _status_code, _headers = opportunities_retrieve_with_http_info(, id, opts)
  data
end

#opportunities_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Opportunity, Integer, Hash)>

Returns an &#x60;Opportunity&#x60; object with the given &#x60;id&#x60;.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :remote_fields (String) —

    Which fields should be returned in non-normalized form.

Returns:

  • (Array<(Opportunity, Integer, Hash)>) —

    Opportunity data, response status code and response headers



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/merge_crm_client/api/opportunities_api.rb', line 448

def opportunities_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunitiesApi.opportunities_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling OpportunitiesApi.opportunities_retrieve"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.opportunities_retrieve"
  end
  allowable_values = ["account", "owner", "owner,account", "owner,stage", "owner,stage,account", "stage", "stage,account"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  allowable_values = ["status"]
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
    fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/opportunities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Opportunity'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"OpportunitiesApi.opportunities_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#opportunities_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end