Class: Spatio::FoldersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/spatio-sdk/api/folders_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FoldersApi

Returns a new instance of FoldersApi.



19
20
21
 
# File 'lib/spatio-sdk/api/folders_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/spatio-sdk/api/folders_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_email_folder(create_email_folder_request, opts = {}) ⇒ EmailFolder

Create an email folder.

Parameters:

Returns:



26
27
28
29
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 26

def create_email_folder(create_email_folder_request, opts = {})
  data, _status_code, _headers = create_email_folder_with_http_info(create_email_folder_request, opts)
  data
end

#create_email_folder_with_http_info(create_email_folder_request, opts = {}) ⇒ Array<(EmailFolder, Integer, Hash)>

Create an email folder.

Parameters:

Returns:

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

    EmailFolder data, response status code and response headers



35
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
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 35

def create_email_folder_with_http_info(create_email_folder_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.create_email_folder ...'
  end
  # verify the required parameter 'create_email_folder_request' is set
  if @api_client.config.client_side_validation && create_email_folder_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_email_folder_request' when calling FoldersApi.create_email_folder"
  end
  # resource path
  local_var_path = '/v1/folders'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"FoldersApi.create_email_folder",
    :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: FoldersApi#create_email_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_folder(id, opts = {}) ⇒ nil

Delete an email folder.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 92

def delete_email_folder(id, opts = {})
  delete_email_folder_with_http_info(id, opts)
  nil
end

#delete_email_folder_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an email folder.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



101
102
103
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
143
144
145
146
147
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 101

def delete_email_folder_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.delete_email_folder ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FoldersApi.delete_email_folder"
  end
  # resource path
  local_var_path = '/v1/folders/{id}'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"FoldersApi.delete_email_folder",
    :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: FoldersApi#delete_email_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_email_folders(opts = {}) ⇒ EmailFolderListResponse

List the caller’s email folders.

Parameters:

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 152

def list_email_folders(opts = {})
  data, _status_code, _headers = list_email_folders_with_http_info(opts)
  data
end

#list_email_folders_with_http_info(opts = {}) ⇒ Array<(EmailFolderListResponse, Integer, Hash)>

List the caller&#39;s email folders.

Parameters:

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

    the optional parameters

Returns:

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

    EmailFolderListResponse data, response status code and response headers



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 160

def list_email_folders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.list_email_folders ...'
  end
  # resource path
  local_var_path = '/v1/folders'

  # 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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"FoldersApi.list_email_folders",
    :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: FoldersApi#list_email_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_folder_emails(id, opts = {}) ⇒ Hash<String, Object>

List emails inside a folder.

Parameters:

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


208
209
210
211
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 208

def list_folder_emails(id, opts = {})
  data, _status_code, _headers = list_folder_emails_with_http_info(id, opts)
  data
end

#list_folder_emails_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

List emails inside a folder.

Parameters:

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

    the optional parameters

Returns:

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

    Hash<String, Object> data, response status code and response headers



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 217

def list_folder_emails_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.list_folder_emails ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FoldersApi.list_folder_emails"
  end
  # resource path
  local_var_path = '/v1/folders/{id}/emails'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

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

  new_options = opts.merge(
    :operation => :"FoldersApi.list_folder_emails",
    :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: FoldersApi#list_folder_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_emails_to_folder(id, move_emails_request, opts = {}) ⇒ Hash<String, Object>

Move emails into a folder.

Parameters:

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


270
271
272
273
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 270

def move_emails_to_folder(id, move_emails_request, opts = {})
  data, _status_code, _headers = move_emails_to_folder_with_http_info(id, move_emails_request, opts)
  data
end

#move_emails_to_folder_with_http_info(id, move_emails_request, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Move emails into a folder.

Parameters:

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

    the optional parameters

Returns:

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

    Hash<String, Object> data, response status code and response headers



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
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
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 280

def move_emails_to_folder_with_http_info(id, move_emails_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.move_emails_to_folder ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FoldersApi.move_emails_to_folder"
  end
  # verify the required parameter 'move_emails_request' is set
  if @api_client.config.client_side_validation && move_emails_request.nil?
    fail ArgumentError, "Missing the required parameter 'move_emails_request' when calling FoldersApi.move_emails_to_folder"
  end
  # resource path
  local_var_path = '/v1/folders/{id}/emails'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

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

  new_options = opts.merge(
    :operation => :"FoldersApi.move_emails_to_folder",
    :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: FoldersApi#move_emails_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_folder(id, update_email_folder_request, opts = {}) ⇒ EmailFolder

Update an email folder.

Parameters:

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

    the optional parameters

Returns:



342
343
344
345
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 342

def update_email_folder(id, update_email_folder_request, opts = {})
  data, _status_code, _headers = update_email_folder_with_http_info(id, update_email_folder_request, opts)
  data
end

#update_email_folder_with_http_info(id, update_email_folder_request, opts = {}) ⇒ Array<(EmailFolder, Integer, Hash)>

Update an email folder.

Parameters:

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

    the optional parameters

Returns:

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

    EmailFolder data, response status code and response headers



352
353
354
355
356
357
358
359
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
401
402
403
404
405
406
407
 
# File 'lib/spatio-sdk/api/folders_api.rb', line 352

def update_email_folder_with_http_info(id, update_email_folder_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.update_email_folder ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FoldersApi.update_email_folder"
  end
  # verify the required parameter 'update_email_folder_request' is set
  if @api_client.config.client_side_validation && update_email_folder_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_email_folder_request' when calling FoldersApi.update_email_folder"
  end
  # resource path
  local_var_path = '/v1/folders/{id}'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"FoldersApi.update_email_folder",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FoldersApi#update_email_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end