Class: SunshineConversationsClient::MessagesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MessagesApi

Returns a new instance of MessagesApi.



16
17
18
 
# File 'lib/sunshine-conversations-client/api/messages_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/messages_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

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

Delete All Messages Delete all messages of a particular conversation.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:

  • (Object) 


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

def delete_all_messages(app_id, conversation_id, opts = {})
  data, _status_code, _headers = delete_all_messages_with_http_info(app_id, conversation_id, opts)
  data
end

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

Delete All Messages Delete all messages of a particular conversation.

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



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
 
# File 'lib/sunshine-conversations-client/api/messages_api.rb', line 36

def delete_all_messages_with_http_info(app_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.delete_all_messages ...'
  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 MessagesApi.delete_all_messages"
  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 MessagesApi.delete_all_messages"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations/{conversationId}/messages'.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: MessagesApi#delete_all_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Message Delete a single message of a particular conversation.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

  • message_id (String) —

    The id of the message.

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

    the optional parameters

Returns:

  • (Object) 


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

def delete_message(app_id, conversation_id, message_id, opts = {})
  data, _status_code, _headers = delete_message_with_http_info(app_id, conversation_id, message_id, opts)
  data
end

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

Delete Message Delete a single message of a particular conversation.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

  • message_id (String) —

    The id of the message.

  • 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
156
157
158
159
 
# File 'lib/sunshine-conversations-client/api/messages_api.rb', line 106

def delete_message_with_http_info(app_id, conversation_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.delete_message ...'
  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 MessagesApi.delete_message"
  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 MessagesApi.delete_message"
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling MessagesApi.delete_message"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations/{conversationId}/messages/{messageId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'conversationId' + '}', CGI.escape(conversation_id.to_s)).sub('{' + 'messageId' + '}', CGI.escape(message_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: MessagesApi#delete_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_messages(app_id, conversation_id, opts = {}) ⇒ MessageListResponse

List Messages List all messages for a particular conversation. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits), in the backwards direction, with the most recent (i.e. last) page of messages being returned by default. The ‘hasMore` flag indicates whether more messages exist in the direction you are currently paginating through. To page backwards in the history, use the `beforeCursor` or follow the `prev` link. The page size limit is fixed at 100 messages per page. “`shell /v2/apps/:appId/conversations/:conversationId/messages?page=5f32b88acf6bf25073b2be56 “`

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Options Hash (opts):

  • :page (Page) —

    Contains parameters for applying cursor pagination.

Returns:



168
169
170
171
 
# File 'lib/sunshine-conversations-client/api/messages_api.rb', line 168

def list_messages(app_id, conversation_id, opts = {})
  data, _status_code, _headers = list_messages_with_http_info(app_id, conversation_id, opts)
  data
end

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

List Messages List all messages for a particular conversation. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits), in the backwards direction, with the most recent (i.e. last) page of messages being returned by default. The &#x60;hasMore&#x60; flag indicates whether more messages exist in the direction you are currently paginating through. To page backwards in the history, use the &#x60;beforeCursor&#x60; or follow the &#x60;prev&#x60; link. The page size limit is fixed at 100 messages per page. &#x60;&#x60;&#x60;shell /v2/apps/:appId/conversations/:conversationId/messages?page&#x3D;5f32b88acf6bf25073b2be56 &#x60;&#x60;&#x60;

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Options Hash (opts):

  • :page (Page) —

    Contains parameters for applying cursor pagination.

Returns:

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

    MessageListResponse data, response status code and response headers



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
 
# File 'lib/sunshine-conversations-client/api/messages_api.rb', line 180

def list_messages_with_http_info(app_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.list_messages ...'
  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 MessagesApi.list_messages"
  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 MessagesApi.list_messages"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations/{conversationId}/messages'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'conversationId' + '}', CGI.escape(conversation_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'MessageListResponse' 

  # 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: MessagesApi#list_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_message(app_id, conversation_id, message_post, opts = {}) ⇒ MessagePostResponse

Post Message Send a message in a particular conversation.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:



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

def post_message(app_id, conversation_id, message_post, opts = {})
  data, _status_code, _headers = post_message_with_http_info(app_id, conversation_id, message_post, opts)
  data
end

#post_message_with_http_info(app_id, conversation_id, message_post, opts = {}) ⇒ Array<(MessagePostResponse, Integer, Hash)>

Post Message Send a message in a particular conversation.

Parameters:

  • app_id (String) —

    Identifies the app.

  • conversation_id (String) —

    Identifies the conversation.

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

    the optional parameters

Returns:

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

    MessagePostResponse data, response status code and response headers



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
300
301
302
303
304
305
306
 
# File 'lib/sunshine-conversations-client/api/messages_api.rb', line 251

def post_message_with_http_info(app_id, conversation_id, message_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.post_message ...'
  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 MessagesApi.post_message"
  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 MessagesApi.post_message"
  end
  # verify the required parameter 'message_post' is set
  if @api_client.config.client_side_validation && message_post.nil?
    fail ArgumentError, "Missing the required parameter 'message_post' when calling MessagesApi.post_message"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/conversations/{conversationId}/messages'.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(message_post) 

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

  # 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: MessagesApi#post_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end