Class: UltracartClient::ConversationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/api/conversation_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConversationApi

Returns a new instance of ConversationApi.



19
20
21
 
# File 'lib/ultracart_api/api/conversation_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/ultracart_api/api/conversation_api.rb', line 17

def api_client
  @api_client
end

Class Method Details

.new_using_api_key(simple_key, verify_ssl = true, debugging = false) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 23

def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
  api_config = Configuration.new
  api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
  api_config.api_version = '2017-03-01'
  api_config.verify_ssl = verify_ssl

  api_client = ApiClient.new(api_config)
  api_client.config.debugging = debugging

  UltracartClient::ConversationApi.new(api_client)
end

Instance Method Details

#delete_conversation_canned_message(conversation_canned_message_oid, opts = {}) ⇒ nil

Delete a conversation canned message Delete a conversation canned message

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


40
41
42
43
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 40

def delete_conversation_canned_message(conversation_canned_message_oid, opts = {})
  delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts)
  nil
end

#delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a conversation canned message Delete a conversation canned message

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 50

def delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.delete_conversation_canned_message ...'
  end
  # verify the required parameter 'conversation_canned_message_oid' is set
  if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.delete_conversation_canned_message"
  end
  # resource path
  local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#delete_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_department(conversation_department_oid, opts = {}) ⇒ nil

Delete a conversation department Delete a conversation department

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 94

def delete_department(conversation_department_oid, opts = {})
  delete_department_with_http_info(conversation_department_oid, opts)
  nil
end

#delete_department_with_http_info(conversation_department_oid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a conversation department Delete a conversation department

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
138
139
140
141
142
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 104

def delete_department_with_http_info(conversation_department_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.delete_department ...'
  end
  # verify the required parameter 'conversation_department_oid' is set
  if @api_client.config.client_side_validation && conversation_department_oid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.delete_department"
  end
  # resource path
  local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#delete_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_engagement(conversation_engagement_oid, opts = {}) ⇒ nil

Delete a conversation engagement Delete a conversation engagement

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


148
149
150
151
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 148

def delete_engagement(conversation_engagement_oid, opts = {})
  delete_engagement_with_http_info(conversation_engagement_oid, opts)
  nil
end

#delete_engagement_with_http_info(conversation_engagement_oid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a conversation engagement Delete a conversation engagement

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 158

def delete_engagement_with_http_info(conversation_engagement_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.delete_engagement ...'
  end
  # verify the required parameter 'conversation_engagement_oid' is set
  if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.delete_engagement"
  end
  # resource path
  local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#delete_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_agent_keep_alive(opts = {}) ⇒ nil

Agent keep alive Called periodically by the conversation API to keep the session alive.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


201
202
203
204
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 201

def get_agent_keep_alive(opts = {})
  get_agent_keep_alive_with_http_info(opts)
  nil
end

#get_agent_keep_alive_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Agent keep alive Called periodically by the conversation API to keep the session alive.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 210

def get_agent_keep_alive_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_keep_alive ...'
  end
  # resource path
  local_var_path = '/conversation/agent/keepalive'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_agent_keep_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_agent_profile(opts = {}) ⇒ ConversationAgentProfileResponse

Get agent profile Retrieve the agents profile

Parameters:

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

    the optional parameters

Returns:



249
250
251
252
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 249

def get_agent_profile(opts = {})
  data, _status_code, _headers = get_agent_profile_with_http_info(opts)
  data
end

#get_agent_profile_with_http_info(opts = {}) ⇒ Array<(ConversationAgentProfileResponse, Fixnum, Hash)>

Get agent profile Retrieve the agents profile

Parameters:

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

    the optional parameters

Returns:



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
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 258

def get_agent_profile_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profile ...'
  end
  # resource path
  local_var_path = '/conversation/agent/profile'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationAgentProfileResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_agent_websocket_authorization(opts = {}) ⇒ ConversationAgentAuthResponse

Get agent websocket authorization Retrieve a JWT to authorize an agent to make a websocket connection.

Parameters:

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

    the optional parameters

Returns:



298
299
300
301
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 298

def get_agent_websocket_authorization(opts = {})
  data, _status_code, _headers = get_agent_websocket_authorization_with_http_info(opts)
  data
end

#get_agent_websocket_authorization_with_http_info(opts = {}) ⇒ Array<(ConversationAgentAuthResponse, Fixnum, Hash)>

Get agent websocket authorization Retrieve a JWT to authorize an agent to make a websocket connection.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 307

def get_agent_websocket_authorization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_websocket_authorization ...'
  end
  # resource path
  local_var_path = '/conversation/agent/auth'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationAgentAuthResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_agent_websocket_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation(conversation_uuid, opts = {}) ⇒ ConversationResponse

Retrieve a conversation Retrieve a conversation including the participants and messages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)

Returns:



349
350
351
352
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 349

def get_conversation(conversation_uuid, opts = {})
  data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
  data
end

#get_conversation_canned_messages(opts = {}) ⇒ ConversationCannedMessagesResponse

Retrieve a list of canned messages ordered by short_code Retrieve a list of canned messages ordered by short_code

Parameters:

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

    the optional parameters

Returns:



405
406
407
408
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 405

def get_conversation_canned_messages(opts = {})
  data, _status_code, _headers = get_conversation_canned_messages_with_http_info(opts)
  data
end

#get_conversation_canned_messages_with_http_info(opts = {}) ⇒ Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>

Retrieve a list of canned messages ordered by short_code Retrieve a list of canned messages ordered by short_code

Parameters:

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

    the optional parameters

Returns:



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 414

def get_conversation_canned_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_canned_messages ...'
  end
  # resource path
  local_var_path = '/conversation/canned_messages'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationCannedMessagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_context(conversation_uuid, opts = {}) ⇒ ConversationWebchatContext

Get a webchat conversation context Get a webchat conversation context

Parameters:

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

    the optional parameters

Returns:



455
456
457
458
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 455

def get_conversation_context(conversation_uuid, opts = {})
  data, _status_code, _headers = get_conversation_context_with_http_info(conversation_uuid, opts)
  data
end

#get_conversation_context_with_http_info(conversation_uuid, opts = {}) ⇒ Array<(ConversationWebchatContext, Fixnum, Hash)>

Get a webchat conversation context Get a webchat conversation context

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ConversationWebchatContext, Fixnum, Hash)>) —

    ConversationWebchatContext data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 465

def get_conversation_context_with_http_info(conversation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_context ...'
  end
  # verify the required parameter 'conversation_uuid' is set
  if @api_client.config.client_side_validation && conversation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_context"
  end
  # resource path
  local_var_path = '/conversation/conversations/{conversation_uuid}/context'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationWebchatContext')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_department_member_list(opts = {}) ⇒ ConversationDepartmentMembersResponse

Retrieve a list of possible department members Retrieve a list of possible department members

Parameters:

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

    the optional parameters

Returns:



509
510
511
512
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 509

def get_conversation_department_member_list(opts = {})
  data, _status_code, _headers = get_conversation_department_member_list_with_http_info(opts)
  data
end

#get_conversation_department_member_list_with_http_info(opts = {}) ⇒ Array<(ConversationDepartmentMembersResponse, Fixnum, Hash)>

Retrieve a list of possible department members Retrieve a list of possible department members

Parameters:

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

    the optional parameters

Returns:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 518

def get_conversation_department_member_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_department_member_list ...'
  end
  # resource path
  local_var_path = '/conversation/department_members'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationDepartmentMembersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_department_member_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_departments(opts = {}) ⇒ ConversationDepartmentsResponse

Retrieve a list of departments ordered by name Retrieve a list of departments ordered by name

Parameters:

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

    the optional parameters

Returns:



558
559
560
561
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 558

def get_conversation_departments(opts = {})
  data, _status_code, _headers = get_conversation_departments_with_http_info(opts)
  data
end

#get_conversation_departments_with_http_info(opts = {}) ⇒ Array<(ConversationDepartmentsResponse, Fixnum, Hash)>

Retrieve a list of departments ordered by name Retrieve a list of departments ordered by name

Parameters:

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

    the optional parameters

Returns:



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 567

def get_conversation_departments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_departments ...'
  end
  # resource path
  local_var_path = '/conversation/departments'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationDepartmentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_departments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_engagement(conversation_engagement_oid, opts = {}) ⇒ ConversationEngagementResponse

Retrieve an engagement Retrieve an engagement

Parameters:

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

    the optional parameters

Returns:



608
609
610
611
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 608

def get_conversation_engagement(conversation_engagement_oid, opts = {})
  data, _status_code, _headers = get_conversation_engagement_with_http_info(conversation_engagement_oid, opts)
  data
end

#get_conversation_engagement_with_http_info(conversation_engagement_oid, opts = {}) ⇒ Array<(ConversationEngagementResponse, Fixnum, Hash)>

Retrieve an engagement Retrieve an engagement

Parameters:

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

    the optional parameters

Returns:



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 618

def get_conversation_engagement_with_http_info(conversation_engagement_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagement ...'
  end
  # verify the required parameter 'conversation_engagement_oid' is set
  if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.get_conversation_engagement"
  end
  # resource path
  local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationEngagementResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_engagements(opts = {}) ⇒ ConversationEngagementsResponse

Retrieve a list of engagements ordered by name Retrieve a list of engagements ordered by name

Parameters:

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

    the optional parameters

Returns:



662
663
664
665
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 662

def get_conversation_engagements(opts = {})
  data, _status_code, _headers = get_conversation_engagements_with_http_info(opts)
  data
end

#get_conversation_engagements_with_http_info(opts = {}) ⇒ Array<(ConversationEngagementsResponse, Fixnum, Hash)>

Retrieve a list of engagements ordered by name Retrieve a list of engagements ordered by name

Parameters:

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

    the optional parameters

Returns:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 671

def get_conversation_engagements_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagements ...'
  end
  # resource path
  local_var_path = '/conversation/engagements'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationEngagementsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_messages(conversation_uuid, since, opts = {}) ⇒ ConversationMessagesResponse

Retrieve conversation messages Retrieve conversation messages since a particular time

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)

Returns:



714
715
716
717
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 714

def get_conversation_messages(conversation_uuid, since, opts = {})
  data, _status_code, _headers = get_conversation_messages_with_http_info(conversation_uuid, since, opts)
  data
end

#get_conversation_messages_with_http_info(conversation_uuid, since, opts = {}) ⇒ Array<(ConversationMessagesResponse, Fixnum, Hash)>

Retrieve conversation messages Retrieve conversation messages since a particular time

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 726

def get_conversation_messages_with_http_info(conversation_uuid, since, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_messages ...'
  end
  # verify the required parameter 'conversation_uuid' is set
  if @api_client.config.client_side_validation && conversation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_messages"
  end
  # verify the required parameter 'since' is set
  if @api_client.config.client_side_validation && since.nil?
    fail ArgumentError, "Missing the required parameter 'since' when calling ConversationApi.get_conversation_messages"
  end
  # resource path
  local_var_path = '/conversation/conversations/{conversation_uuid}/messages/{since}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s).sub('{' + 'since' + '}', since.to_s)

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

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationMessagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_multimedia_upload_url(extension, opts = {}) ⇒ ConversationMultimediaUploadUrlResponse

Get a presigned conversation multimedia upload URL Get a presigned conversation multimedia upload URL

Parameters:

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

    the optional parameters

Returns:



776
777
778
779
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 776

def get_conversation_multimedia_upload_url(extension, opts = {})
  data, _status_code, _headers = get_conversation_multimedia_upload_url_with_http_info(extension, opts)
  data
end

#get_conversation_multimedia_upload_url_with_http_info(extension, opts = {}) ⇒ Array<(ConversationMultimediaUploadUrlResponse, Fixnum, Hash)>

Get a presigned conversation multimedia upload URL Get a presigned conversation multimedia upload URL

Parameters:

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

    the optional parameters

Returns:



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 786

def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
  end
  # verify the required parameter 'extension' is set
  if @api_client.config.client_side_validation && extension.nil?
    fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_multimedia_upload_url"
  end
  # resource path
  local_var_path = '/conversation/upload_url/{extension}'.sub('{' + 'extension' + '}', extension.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationMultimediaUploadUrlResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_multimedia_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_permissions(opts = {}) ⇒ ConversationPermissionsResponse

Retrieve conversation permissions Retrieve conversation permissions

Parameters:

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

    the optional parameters

Returns:



830
831
832
833
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 830

def get_conversation_permissions(opts = {})
  data, _status_code, _headers = get_conversation_permissions_with_http_info(opts)
  data
end

#get_conversation_permissions_with_http_info(opts = {}) ⇒ Array<(ConversationPermissionsResponse, Fixnum, Hash)>

Retrieve conversation permissions Retrieve conversation permissions

Parameters:

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

    the optional parameters

Returns:



839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 839

def get_conversation_permissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_permissions ...'
  end
  # resource path
  local_var_path = '/conversation/permissions'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationPermissionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_webchat_queue_statuses(opts = {}) ⇒ ConversationWebchatQueueStatusesResponse

Retrieve a conversation webchat queue statuses Retrieve a conversation webchat queue statuses including agent status and queue entries

Parameters:

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

    the optional parameters

Returns:



879
880
881
882
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 879

def get_conversation_webchat_queue_statuses(opts = {})
  data, _status_code, _headers = get_conversation_webchat_queue_statuses_with_http_info(opts)
  data
end

#get_conversation_webchat_queue_statuses_with_http_info(opts = {}) ⇒ Array<(ConversationWebchatQueueStatusesResponse, Fixnum, Hash)>

Retrieve a conversation webchat queue statuses Retrieve a conversation webchat queue statuses including agent status and queue entries

Parameters:

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

    the optional parameters

Returns:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 888

def get_conversation_webchat_queue_statuses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_webchat_queue_statuses ...'
  end
  # resource path
  local_var_path = '/conversation/conversations/queues/statuses'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationWebchatQueueStatusesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation_webchat_queue_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_with_http_info(conversation_uuid, opts = {}) ⇒ Array<(ConversationResponse, Fixnum, Hash)>

Retrieve a conversation Retrieve a conversation including the participants and messages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)

Returns:

  • (Array<(ConversationResponse, Fixnum, Hash)>) —

    ConversationResponse data, response status code and response headers



360
361
362
363
364
365
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
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 360

def get_conversation_with_http_info(conversation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation ...'
  end
  # verify the required parameter 'conversation_uuid' is set
  if @api_client.config.client_side_validation && conversation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation"
  end
  # resource path
  local_var_path = '/conversation/conversations/{conversation_uuid}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)

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

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversations(opts = {}) ⇒ ConversationsResponse

Retrieve a list of conversation summaries newest to oldest Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :medium (String)
  • :before (String)
  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Max 200) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

Returns:



932
933
934
935
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 932

def get_conversations(opts = {})
  data, _status_code, _headers = get_conversations_with_http_info(opts)
  data
end

#get_conversations_autocomplete(autocomplete_request, opts = {}) ⇒ ConversationAutocompleteResponse

Retrieve a list of matching terms for a search field Retrieve a list of matching terms for a search field

Parameters:

  • autocomplete_request —

    Autocomplete Request

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

    the optional parameters

Returns:



990
991
992
993
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 990

def get_conversations_autocomplete(autocomplete_request, opts = {})
  data, _status_code, _headers = get_conversations_autocomplete_with_http_info(autocomplete_request, opts)
  data
end

#get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {}) ⇒ Array<(ConversationAutocompleteResponse, Fixnum, Hash)>

Retrieve a list of matching terms for a search field Retrieve a list of matching terms for a search field

Parameters:

  • autocomplete_request —

    Autocomplete Request

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

    the optional parameters

Returns:



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1000

def get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_autocomplete ...'
  end
  # verify the required parameter 'autocomplete_request' is set
  if @api_client.config.client_side_validation && autocomplete_request.nil?
    fail ArgumentError, "Missing the required parameter 'autocomplete_request' when calling ConversationApi.get_conversations_autocomplete"
  end
  # resource path
  local_var_path = '/conversation/conversations/autocomplete'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(autocomplete_request)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationAutocompleteResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversations_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversations_search(search_request, opts = {}) ⇒ ConversationSearchResponse

Search conversations Search conversations

Parameters:

  • search_request —

    Search Request

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

    the optional parameters

Returns:



1045
1046
1047
1048
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1045

def get_conversations_search(search_request, opts = {})
  data, _status_code, _headers = get_conversations_search_with_http_info(search_request, opts)
  data
end

#get_conversations_search_with_http_info(search_request, opts = {}) ⇒ Array<(ConversationSearchResponse, Fixnum, Hash)>

Search conversations Search conversations

Parameters:

  • search_request —

    Search Request

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

    the optional parameters

Returns:

  • (Array<(ConversationSearchResponse, Fixnum, Hash)>) —

    ConversationSearchResponse data, response status code and response headers



1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1055

def get_conversations_search_with_http_info(search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_search ...'
  end
  # verify the required parameter 'search_request' is set
  if @api_client.config.client_side_validation && search_request.nil?
    fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.get_conversations_search"
  end
  # resource path
  local_var_path = '/conversation/conversations/search'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(search_request)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversations_with_http_info(opts = {}) ⇒ Array<(ConversationsResponse, Fixnum, Hash)>

Retrieve a list of conversation summaries newest to oldest Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :medium (String)
  • :before (String)
  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Max 200)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

Returns:

  • (Array<(ConversationsResponse, Fixnum, Hash)>) —

    ConversationsResponse data, response status code and response headers



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 945

def get_conversations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations ...'
  end
  # resource path
  local_var_path = '/conversation/conversations'

  # query parameters
  query_params = {}
  query_params[:'medium'] = opts[:'medium'] if !opts[:'medium'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_locations_for_engagement(opts = {}) ⇒ ConversationLocationsResponse

Get location data for engagement configuration Get location data for engagement configuration

Parameters:

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

    the optional parameters

Returns:



1099
1100
1101
1102
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1099

def get_locations_for_engagement(opts = {})
  data, _status_code, _headers = get_locations_for_engagement_with_http_info(opts)
  data
end

#get_locations_for_engagement_with_http_info(opts = {}) ⇒ Array<(ConversationLocationsResponse, Fixnum, Hash)>

Get location data for engagement configuration Get location data for engagement configuration

Parameters:

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

    the optional parameters

Returns:



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1108

def get_locations_for_engagement_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.get_locations_for_engagement ...'
  end
  # resource path
  local_var_path = '/conversation/locations'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationLocationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#get_locations_for_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_conversation_canned_message(canned_message, opts = {}) ⇒ ConversationCannedMessageResponse

Insert a canned message Insert a canned message

Parameters:

  • canned_message —

    Canned message

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

    the optional parameters

Returns:



1149
1150
1151
1152
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1149

def insert_conversation_canned_message(canned_message, opts = {})
  data, _status_code, _headers = insert_conversation_canned_message_with_http_info(canned_message, opts)
  data
end

#insert_conversation_canned_message_with_http_info(canned_message, opts = {}) ⇒ Array<(ConversationCannedMessageResponse, Fixnum, Hash)>

Insert a canned message Insert a canned message

Parameters:

  • canned_message —

    Canned message

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

    the optional parameters

Returns:



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1159

def insert_conversation_canned_message_with_http_info(canned_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_canned_message ...'
  end
  # verify the required parameter 'canned_message' is set
  if @api_client.config.client_side_validation && canned_message.nil?
    fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.insert_conversation_canned_message"
  end
  # resource path
  local_var_path = '/conversation/canned_messages'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(canned_message)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationCannedMessageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_conversation_department(department, opts = {}) ⇒ ConversationDepartmentResponse

Insert a department Insert a department

Parameters:

  • department —

    Department

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

    the optional parameters

Returns:



1204
1205
1206
1207
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1204

def insert_conversation_department(department, opts = {})
  data, _status_code, _headers = insert_conversation_department_with_http_info(department, opts)
  data
end

#insert_conversation_department_with_http_info(department, opts = {}) ⇒ Array<(ConversationDepartmentResponse, Fixnum, Hash)>

Insert a department Insert a department

Parameters:

  • department —

    Department

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

    the optional parameters

Returns:



1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1214

def insert_conversation_department_with_http_info(department, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_department ...'
  end
  # verify the required parameter 'department' is set
  if @api_client.config.client_side_validation && department.nil?
    fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.insert_conversation_department"
  end
  # resource path
  local_var_path = '/conversation/departments'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(department)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationDepartmentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_conversation_engagement(engagement, opts = {}) ⇒ ConversationEngagementResponse

Insert a engagement Insert a engagement

Parameters:

  • engagement —

    Engagement

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

    the optional parameters

Returns:



1259
1260
1261
1262
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1259

def insert_conversation_engagement(engagement, opts = {})
  data, _status_code, _headers = insert_conversation_engagement_with_http_info(engagement, opts)
  data
end

#insert_conversation_engagement_with_http_info(engagement, opts = {}) ⇒ Array<(ConversationEngagementResponse, Fixnum, Hash)>

Insert a engagement Insert a engagement

Parameters:

  • engagement —

    Engagement

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

    the optional parameters

Returns:



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1269

def insert_conversation_engagement_with_http_info(engagement, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_engagement ...'
  end
  # verify the required parameter 'engagement' is set
  if @api_client.config.client_side_validation && engagement.nil?
    fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.insert_conversation_engagement"
  end
  # resource path
  local_var_path = '/conversation/engagements'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(engagement)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationEngagementResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#join_conversation(conversation_uuid, opts = {}) ⇒ nil

Join a conversation Join a conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1315
1316
1317
1318
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1315

def join_conversation(conversation_uuid, opts = {})
  join_conversation_with_http_info(conversation_uuid, opts)
  nil
end

#join_conversation_with_http_info(conversation_uuid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Join a conversation Join a conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1326

def join_conversation_with_http_info(conversation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.join_conversation ...'
  end
  # verify the required parameter 'conversation_uuid' is set
  if @api_client.config.client_side_validation && conversation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.join_conversation"
  end
  # resource path
  local_var_path = '/conversation/conversations/{conversation_uuid}/join'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'join_request'])
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#join_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#leave_conversation(conversation_uuid, opts = {}) ⇒ nil

Leave a conversation Leave a conversation

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1370
1371
1372
1373
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1370

def leave_conversation(conversation_uuid, opts = {})
  leave_conversation_with_http_info(conversation_uuid, opts)
  nil
end

#leave_conversation_with_http_info(conversation_uuid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Leave a conversation Leave a conversation

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1380

def leave_conversation_with_http_info(conversation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.leave_conversation ...'
  end
  # verify the required parameter 'conversation_uuid' is set
  if @api_client.config.client_side_validation && conversation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.leave_conversation"
  end
  # resource path
  local_var_path = '/conversation/conversations/{conversation_uuid}/leave'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#leave_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mark_read_conversation(conversation_uuid, opts = {}) ⇒ nil

Mark a conversation as read Mark a conversation as read

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1424
1425
1426
1427
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1424

def mark_read_conversation(conversation_uuid, opts = {})
  mark_read_conversation_with_http_info(conversation_uuid, opts)
  nil
end

#mark_read_conversation_with_http_info(conversation_uuid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Mark a conversation as read Mark a conversation as read

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1434

def mark_read_conversation_with_http_info(conversation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.mark_read_conversation ...'
  end
  # verify the required parameter 'conversation_uuid' is set
  if @api_client.config.client_side_validation && conversation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.mark_read_conversation"
  end
  # resource path
  local_var_path = '/conversation/conversations/{conversation_uuid}/markread'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#mark_read_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_conversation_canned_messages(search_request, opts = {}) ⇒ ConversationCannedMessagesResponse

Search for canned messages by short_code Search for canned messages by short_code

Parameters:

  • search_request —

    Search request

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

    the optional parameters

Returns:



1478
1479
1480
1481
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1478

def search_conversation_canned_messages(search_request, opts = {})
  data, _status_code, _headers = search_conversation_canned_messages_with_http_info(search_request, opts)
  data
end

#search_conversation_canned_messages_with_http_info(search_request, opts = {}) ⇒ Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>

Search for canned messages by short_code Search for canned messages by short_code

Parameters:

  • search_request —

    Search request

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

    the optional parameters

Returns:



1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1488

def search_conversation_canned_messages_with_http_info(search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.search_conversation_canned_messages ...'
  end
  # verify the required parameter 'search_request' is set
  if @api_client.config.client_side_validation && search_request.nil?
    fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.search_conversation_canned_messages"
  end
  # resource path
  local_var_path = '/conversation/canned_messages/search'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(search_request)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationCannedMessagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#search_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sms_unsubscribe_conversation(conversation_uuid, opts = {}) ⇒ nil

Unsubscribe any SMS participants in this conversation Unsubscribe any SMS participants in this conversation

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1533
1534
1535
1536
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1533

def sms_unsubscribe_conversation(conversation_uuid, opts = {})
  sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
  nil
end

#sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Unsubscribe any SMS participants in this conversation Unsubscribe any SMS participants in this conversation

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1543

def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
  end
  # verify the required parameter 'conversation_uuid' is set
  if @api_client.config.client_side_validation && conversation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
  end
  # resource path
  local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#start_conversation(start_request, opts = {}) ⇒ ConversationStartResponse

Start a conversation Start a new conversation

Parameters:

  • start_request —

    Start request

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

    the optional parameters

Returns:



1587
1588
1589
1590
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1587

def start_conversation(start_request, opts = {})
  data, _status_code, _headers = start_conversation_with_http_info(start_request, opts)
  data
end

#start_conversation_with_http_info(start_request, opts = {}) ⇒ Array<(ConversationStartResponse, Fixnum, Hash)>

Start a conversation Start a new conversation

Parameters:

  • start_request —

    Start request

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

    the optional parameters

Returns:

  • (Array<(ConversationStartResponse, Fixnum, Hash)>) —

    ConversationStartResponse data, response status code and response headers



1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1597

def start_conversation_with_http_info(start_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.start_conversation ...'
  end
  # verify the required parameter 'start_request' is set
  if @api_client.config.client_side_validation && start_request.nil?
    fail ArgumentError, "Missing the required parameter 'start_request' when calling ConversationApi.start_conversation"
  end
  # resource path
  local_var_path = '/conversation/conversations'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(start_request)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationStartResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#start_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_agent_profile(profile_request, opts = {}) ⇒ ConversationAgentProfileResponse

Update agent profile Update agent profile

Parameters:

  • profile_request —

    Profile request

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

    the optional parameters

Returns:



1642
1643
1644
1645
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1642

def update_agent_profile(profile_request, opts = {})
  data, _status_code, _headers = update_agent_profile_with_http_info(profile_request, opts)
  data
end

#update_agent_profile_with_http_info(profile_request, opts = {}) ⇒ Array<(ConversationAgentProfileResponse, Fixnum, Hash)>

Update agent profile Update agent profile

Parameters:

  • profile_request —

    Profile request

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

    the optional parameters

Returns:



1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1652

def update_agent_profile_with_http_info(profile_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile ...'
  end
  # verify the required parameter 'profile_request' is set
  if @api_client.config.client_side_validation && profile_request.nil?
    fail ArgumentError, "Missing the required parameter 'profile_request' when calling ConversationApi.update_agent_profile"
  end
  # resource path
  local_var_path = '/conversation/agent/profile'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(profile_request)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationAgentProfileResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#update_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_conversation_canned_message(conversation_canned_message_oid, canned_message, opts = {}) ⇒ ConversationCannedMessageResponse

Update a canned message Update a canned message

Parameters:

  • conversation_canned_message_oid
  • canned_message —

    Canned message

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

    the optional parameters

Returns:



1698
1699
1700
1701
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1698

def update_conversation_canned_message(conversation_canned_message_oid, canned_message, opts = {})
  data, _status_code, _headers = update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts)
  data
end

#update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts = {}) ⇒ Array<(ConversationCannedMessageResponse, Fixnum, Hash)>

Update a canned message Update a canned message

Parameters:

  • conversation_canned_message_oid
  • canned_message —

    Canned message

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

    the optional parameters

Returns:



1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1709

def update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_canned_message ...'
  end
  # verify the required parameter 'conversation_canned_message_oid' is set
  if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.update_conversation_canned_message"
  end
  # verify the required parameter 'canned_message' is set
  if @api_client.config.client_side_validation && canned_message.nil?
    fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.update_conversation_canned_message"
  end
  # resource path
  local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(canned_message)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationCannedMessageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#update_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_conversation_department(conversation_department_oid, department, opts = {}) ⇒ ConversationDepartmentResponse

Update a department Update a department

Parameters:

  • conversation_department_oid
  • department —

    Department

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

    the optional parameters

Returns:



1759
1760
1761
1762
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1759

def update_conversation_department(conversation_department_oid, department, opts = {})
  data, _status_code, _headers = update_conversation_department_with_http_info(conversation_department_oid, department, opts)
  data
end

#update_conversation_department_with_http_info(conversation_department_oid, department, opts = {}) ⇒ Array<(ConversationDepartmentResponse, Fixnum, Hash)>

Update a department Update a department

Parameters:

  • conversation_department_oid
  • department —

    Department

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

    the optional parameters

Returns:



1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1770

def update_conversation_department_with_http_info(conversation_department_oid, department, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_department ...'
  end
  # verify the required parameter 'conversation_department_oid' is set
  if @api_client.config.client_side_validation && conversation_department_oid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.update_conversation_department"
  end
  # verify the required parameter 'department' is set
  if @api_client.config.client_side_validation && department.nil?
    fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.update_conversation_department"
  end
  # resource path
  local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(department)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationDepartmentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#update_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_conversation_engagement(conversation_engagement_oid, engagement, opts = {}) ⇒ ConversationEngagementResponse

Update a engagement Update a engagement

Parameters:

  • conversation_engagement_oid
  • engagement —

    Engagement

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

    the optional parameters

Returns:



1820
1821
1822
1823
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1820

def update_conversation_engagement(conversation_engagement_oid, engagement, opts = {})
  data, _status_code, _headers = update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts)
  data
end

#update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts = {}) ⇒ Array<(ConversationEngagementResponse, Fixnum, Hash)>

Update a engagement Update a engagement

Parameters:

  • conversation_engagement_oid
  • engagement —

    Engagement

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

    the optional parameters

Returns:



1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1831

def update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_engagement ...'
  end
  # verify the required parameter 'conversation_engagement_oid' is set
  if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.update_conversation_engagement"
  end
  # verify the required parameter 'engagement' is set
  if @api_client.config.client_side_validation && engagement.nil?
    fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.update_conversation_engagement"
  end
  # resource path
  local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(engagement)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationEngagementResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#update_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_conversation_webchat_queue_status(queue_name, status_request, opts = {}) ⇒ nil

Update status within the queue Update status within the queue

Parameters:

  • queue_name
  • status_request —

    Status request

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

    the optional parameters

Returns:

  • (nil) 


1881
1882
1883
1884
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1881

def update_conversation_webchat_queue_status(queue_name, status_request, opts = {})
  update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts)
  nil
end

#update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update status within the queue Update status within the queue

Parameters:

  • queue_name
  • status_request —

    Status request

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
 
# File 'lib/ultracart_api/api/conversation_api.rb', line 1892

def update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_webchat_queue_status ...'
  end
  # verify the required parameter 'queue_name' is set
  if @api_client.config.client_side_validation && queue_name.nil?
    fail ArgumentError, "Missing the required parameter 'queue_name' when calling ConversationApi.update_conversation_webchat_queue_status"
  end
  # verify the required parameter 'status_request' is set
  if @api_client.config.client_side_validation && status_request.nil?
    fail ArgumentError, "Missing the required parameter 'status_request' when calling ConversationApi.update_conversation_webchat_queue_status"
  end
  # resource path
  local_var_path = '/conversation/conversations/queues/{queue_name}/status'.sub('{' + 'queue_name' + '}', queue_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(status_request)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationApi#update_conversation_webchat_queue_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end