Class: SunshineConversationsClient::ConversationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/api/conversations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConversationsApi

Returns a new instance of ConversationsApi.



16
17
18
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_conversation(app_id, conversation_create_body, opts = {}) ⇒ ConversationResponse

Create Conversation Create a conversation for the specified user(s).

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 25

def create_conversation(app_id, conversation_create_body, opts = {})
  data, _status_code, _headers = create_conversation_with_http_info(app_id, conversation_create_body, opts)
  data
end

#create_conversation_with_http_info(app_id, conversation_create_body, opts = {}) ⇒ Array<(ConversationResponse, Integer, Hash)>

Create Conversation Create a conversation for the specified user(s).

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

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

    ConversationResponse data, response status code and response headers



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 36

def create_conversation_with_http_info(app_id, conversation_create_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.create_conversation ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling ConversationsApi.create_conversation"
  end
  # verify the required parameter 'conversation_create_body' is set
  if @api_client.config.client_side_validation && conversation_create_body.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_create_body' when calling ConversationsApi.create_conversation"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ConversationResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

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

#delete_conversation(app_id, conversation_id, opts = {}) ⇒ Object

Delete Conversation Delete an entire conversation record, along with its messages and attachments. Note that the default conversation cannot be deleted, but the messages contained [can be](#deleteAllMessages).

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:

  • (Object) 


95
96
97
98
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 95

def delete_conversation(app_id, conversation_id, opts = {})
  data, _status_code, _headers = delete_conversation_with_http_info(app_id, conversation_id, opts)
  data
end

#delete_conversation_with_http_info(app_id, conversation_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete Conversation Delete an entire conversation record, along with its messages and attachments. Note that the default conversation cannot be deleted, but the messages contained [can be](#deleteAllMessages).

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 106

def delete_conversation_with_http_info(app_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.delete_conversation ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling ConversationsApi.delete_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.delete_conversation"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations/{conversationId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'conversationId' + '}', CGI.escape(conversation_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'Object' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

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

#download_message_ref(app_id, conversation_id, download_message_ref_body, opts = {}) ⇒ Object

Download Message Ref When a third party channel provides a reference of a data, this API can be used to download the reference and fetch the full data. Currently, only apple channel is supported.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:

  • (Object) 


164
165
166
167
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 164

def download_message_ref(app_id, conversation_id, download_message_ref_body, opts = {})
  data, _status_code, _headers = download_message_ref_with_http_info(app_id, conversation_id, download_message_ref_body, opts)
  data
end

#download_message_ref_with_http_info(app_id, conversation_id, download_message_ref_body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Download Message Ref When a third party channel provides a reference of a data, this API can be used to download the reference and fetch the full data. Currently, only apple channel is supported.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 176

def download_message_ref_with_http_info(app_id, conversation_id, download_message_ref_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.download_message_ref ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling ConversationsApi.download_message_ref"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.download_message_ref"
  end
  # verify the required parameter 'download_message_ref_body' is set
  if @api_client.config.client_side_validation && download_message_ref_body.nil?
    fail ArgumentError, "Missing the required parameter 'download_message_ref_body' when calling ConversationsApi.download_message_ref"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations/{conversationId}/download'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'conversationId' + '}', CGI.escape(conversation_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'Object' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

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

#get_conversation(app_id, conversation_id, opts = {}) ⇒ ConversationResponse

Get Conversation Fetches an individual conversation.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:



239
240
241
242
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 239

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

#get_conversation_with_http_info(app_id, conversation_id, opts = {}) ⇒ Array<(ConversationResponse, Integer, Hash)>

Get Conversation Fetches an individual conversation.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:

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

    ConversationResponse data, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 250

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

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ConversationResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

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

#list_conversations(app_id, filter, opts = {}) ⇒ ConversationListResponse

List Conversations Lists all conversations that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). “‘shell /v2/apps/:appId/conversations?filter=42589ad070d43be9b00ff7e5 “`

Parameters:

  • app_id (String) —

    Identifies the app.

  • filter (ConversationListFilter) —

    Contains parameters for filtering the results.

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

    the optional parameters

Options Hash (opts):

  • :page (Page) —

    Contains parameters for applying cursor pagination.

Returns:



308
309
310
311
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 308

def list_conversations(app_id, filter, opts = {})
  data, _status_code, _headers = list_conversations_with_http_info(app_id, filter, opts)
  data
end

#list_conversations_with_http_info(app_id, filter, opts = {}) ⇒ Array<(ConversationListResponse, Integer, Hash)>

List Conversations Lists all conversations that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). &#x60;&#x60;&#x60;shell /v2/apps/:appId/conversations?filter&#x3D;42589ad070d43be9b00ff7e5 &#x60;&#x60;&#x60;

Parameters:

  • app_id (String) —

    Identifies the app.

  • filter (ConversationListFilter) —

    Contains parameters for filtering the results.

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

    the optional parameters

Options Hash (opts):

  • :page (Page) —

    Contains parameters for applying cursor pagination.

Returns:

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

    ConversationListResponse data, response status code and response headers



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 320

def list_conversations_with_http_info(app_id, filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.list_conversations ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling ConversationsApi.list_conversations"
  end
  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling ConversationsApi.list_conversations"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ConversationListResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

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

#update_conversation(app_id, conversation_id, conversation_update_body, opts = {}) ⇒ ConversationResponse

Update Conversation Updates a conversation record.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:



380
381
382
383
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 380

def update_conversation(app_id, conversation_id, conversation_update_body, opts = {})
  data, _status_code, _headers = update_conversation_with_http_info(app_id, conversation_id, conversation_update_body, opts)
  data
end

#update_conversation_with_http_info(app_id, conversation_id, conversation_update_body, opts = {}) ⇒ Array<(ConversationResponse, Integer, Hash)>

Update Conversation Updates a conversation record.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:

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

    ConversationResponse data, response status code and response headers



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/sunshine-conversations-client/api/conversations_api.rb', line 392

def update_conversation_with_http_info(app_id, conversation_id, conversation_update_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.update_conversation ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling ConversationsApi.update_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.update_conversation"
  end
  # verify the required parameter 'conversation_update_body' is set
  if @api_client.config.client_side_validation && conversation_update_body.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_update_body' when calling ConversationsApi.update_conversation"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations/{conversationId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'conversationId' + '}', CGI.escape(conversation_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ConversationResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

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