Class: Mudbase::DataApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mudbase/api/data_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataApi

Returns a new instance of DataApi.



19
20
21
 
# File 'lib/mudbase/api/data_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/mudbase/api/data_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#data_create(project_id, collection_id, body, opts = {}) ⇒ DataResponse

Create data in collection Create a new document in a collection. Request body must match the collection schema. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

  • body (Object) —

    Document fields matching the collection schema.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/mudbase/api/data_api.rb', line 29

def data_create(project_id, collection_id, body, opts = {})
  data, _status_code, _headers = data_create_with_http_info(project_id, collection_id, body, opts)
  data
end

#data_create_with_http_info(project_id, collection_id, body, opts = {}) ⇒ Array<(DataResponse, Integer, Hash)>

Create data in collection Create a new document in a collection. Request body must match the collection schema. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

  • body (Object) —

    Document fields matching the collection schema.

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

    the optional parameters

Returns:

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

    DataResponse data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/mudbase/api/data_api.rb', line 41

def data_create_with_http_info(project_id, collection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.data_create ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling DataApi.data_create"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling DataApi.data_create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DataApi.data_create"
  end
  # resource path
  local_var_path = '/api/data/projects/{projectId}/collections/{collectionId}/data'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_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(body)

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

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

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

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

#data_delete(project_id, collection_id, document_id, opts = {}) ⇒ MessageResponse

Delete document Delete a document from a collection. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

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

    the optional parameters

Returns:



109
110
111
112
 
# File 'lib/mudbase/api/data_api.rb', line 109

def data_delete(project_id, collection_id, document_id, opts = {})
  data, _status_code, _headers = data_delete_with_http_info(project_id, collection_id, document_id, opts)
  data
end

#data_delete_with_http_info(project_id, collection_id, document_id, opts = {}) ⇒ Array<(MessageResponse, Integer, Hash)>

Delete document Delete a document from a collection. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

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

    the optional parameters

Returns:

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

    MessageResponse data, response status code and response headers



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/mudbase/api/data_api.rb', line 121

def data_delete_with_http_info(project_id, collection_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.data_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling DataApi.data_delete"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling DataApi.data_delete"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling DataApi.data_delete"
  end
  # resource path
  local_var_path = '/api/data/projects/{projectId}/collections/{collectionId}/data/{documentId}'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s)).sub('{' + 'documentId' + '}', CGI.escape(document_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] || 'MessageResponse'

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

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

#data_get(project_id, collection_id, document_id, opts = {}) ⇒ DataResponse

Get single document Get a document by ID from a collection. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

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

    the optional parameters

Returns:



184
185
186
187
 
# File 'lib/mudbase/api/data_api.rb', line 184

def data_get(project_id, collection_id, document_id, opts = {})
  data, _status_code, _headers = data_get_with_http_info(project_id, collection_id, document_id, opts)
  data
end

#data_get_with_http_info(project_id, collection_id, document_id, opts = {}) ⇒ Array<(DataResponse, Integer, Hash)>

Get single document Get a document by ID from a collection. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

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

    the optional parameters

Returns:

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

    DataResponse data, response status code and response headers



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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/mudbase/api/data_api.rb', line 196

def data_get_with_http_info(project_id, collection_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.data_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling DataApi.data_get"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling DataApi.data_get"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling DataApi.data_get"
  end
  # resource path
  local_var_path = '/api/data/projects/{projectId}/collections/{collectionId}/data/{documentId}'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s)).sub('{' + 'documentId' + '}', CGI.escape(document_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] || 'DataResponse'

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

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

#data_list(project_id, collection_id, opts = {}) ⇒ DataListResponse

List data in collection List all documents in a collection with optional pagination, sort, and filter. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (1-based). (default to 1)

  • :limit (Integer) —

    Number of documents per page. (default to 20)

  • :sort (String) —

    Sort field and order (e.g. -createdAt, name). (default to ‘-createdAt’)

  • :filter (String) —

    JSON string for filtering documents (e.g. \&quot;status\&quot;:\&quot;active\&quot;).

Returns:



262
263
264
265
 
# File 'lib/mudbase/api/data_api.rb', line 262

def data_list(project_id, collection_id, opts = {})
  data, _status_code, _headers = data_list_with_http_info(project_id, collection_id, opts)
  data
end

#data_list_with_http_info(project_id, collection_id, opts = {}) ⇒ Array<(DataListResponse, Integer, Hash)>

List data in collection List all documents in a collection with optional pagination, sort, and filter. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (1-based). (default to 1)

  • :limit (Integer) —

    Number of documents per page. (default to 20)

  • :sort (String) —

    Sort field and order (e.g. -createdAt, name). (default to ‘-createdAt’)

  • :filter (String) —

    JSON string for filtering documents (e.g. \&quot;status\&quot;:\&quot;active\&quot;).

Returns:

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

    DataListResponse data, response status code and response headers



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
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/mudbase/api/data_api.rb', line 277

def data_list_with_http_info(project_id, collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.data_list ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling DataApi.data_list"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling DataApi.data_list"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DataApi.data_list, must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/api/data/projects/{projectId}/collections/{collectionId}/data'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

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

  # 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] || 'DataListResponse'

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

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

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

#data_update(project_id, collection_id, document_id, body, opts = {}) ⇒ DataResponse

Update document Update a document in a collection. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

  • body (Object) —

    Partial document fields to update.

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

    the optional parameters

Returns:



345
346
347
348
 
# File 'lib/mudbase/api/data_api.rb', line 345

def data_update(project_id, collection_id, document_id, body, opts = {})
  data, _status_code, _headers = data_update_with_http_info(project_id, collection_id, document_id, body, opts)
  data
end

#data_update_with_http_info(project_id, collection_id, document_id, body, opts = {}) ⇒ Array<(DataResponse, Integer, Hash)>

Update document Update a document in a collection. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

Parameters:

  • project_id (String) —

    Project ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

  • body (Object) —

    Partial document fields to update.

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

    the optional parameters

Returns:

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

    DataResponse data, response status code and response headers



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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/mudbase/api/data_api.rb', line 358

def data_update_with_http_info(project_id, collection_id, document_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.data_update ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling DataApi.data_update"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling DataApi.data_update"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling DataApi.data_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DataApi.data_update"
  end
  # resource path
  local_var_path = '/api/data/projects/{projectId}/collections/{collectionId}/data/{documentId}'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s)).sub('{' + 'documentId' + '}', CGI.escape(document_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(body)

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

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

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

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