Class: TrieveRubyClient::OrganizationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/api/organization_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationApi

Returns a new instance of OrganizationApi.



19
20
21
 
# File 'lib/trieve_ruby_client/api/organization_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/trieve_ruby_client/api/organization_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_organization(create_organization_data, opts = {}) ⇒ Organization

Create Organization Create a new organization. The auth’ed user who creates the organization will be the default owner of the organization.

Parameters:

  • create_organization_data (CreateOrganizationData) —

    The organization data that you want to create

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 27

def create_organization(create_organization_data, opts = {})
  data, _status_code, _headers = create_organization_with_http_info(create_organization_data, opts)
  data
end

#create_organization_with_http_info(create_organization_data, opts = {}) ⇒ Array<(Organization, Integer, Hash)>

Create Organization Create a new organization. The auth&#39;ed user who creates the organization will be the default owner of the organization.

Parameters:

  • create_organization_data (CreateOrganizationData) —

    The organization data that you want to create

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

    the optional parameters

Returns:

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

    Organization data, response status code and response headers



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
88
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 37

def create_organization_with_http_info(create_organization_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.create_organization ...'
  end
  # verify the required parameter 'create_organization_data' is set
  if @api_client.config.client_side_validation && create_organization_data.nil?
    fail ArgumentError, "Missing the required parameter 'create_organization_data' when calling OrganizationApi.create_organization"
  end
  # resource path
  local_var_path = '/api/organization'

  # 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'
  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_organization_data)

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

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

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

#delete_organization(tr_organization, organization_id, opts = {}) ⇒ nil

Delete Organization Delete an organization by its id. The auth’ed user must be an owner of the organization to delete it.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    The id of the organization you want to fetch.

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

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 96

def delete_organization(tr_organization, organization_id, opts = {})
  delete_organization_with_http_info(tr_organization, organization_id, opts)
  nil
end

#delete_organization_with_http_info(tr_organization, organization_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Organization Delete an organization by its id. The auth&#39;ed user must be an owner of the organization to delete it.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    The id of the organization you want to fetch.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 107

def delete_organization_with_http_info(tr_organization, organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.delete_organization ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.delete_organization"
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationApi.delete_organization"
  end
  # resource path
  local_var_path = '/api/organization/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_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'])
  header_params[:'TR-Organization'] = tr_organization

  # 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] || ['ApiKey']

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

#get_organization(tr_organization, organization_id, opts = {}) ⇒ Organization

Get Organization Fetch the details of an organization by its id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    The id of the organization you want to fetch.

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

    the optional parameters

Returns:



166
167
168
169
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 166

def get_organization(tr_organization, organization_id, opts = {})
  data, _status_code, _headers = get_organization_with_http_info(tr_organization, organization_id, opts)
  data
end

#get_organization_usage(tr_organization, organization_id, opts = {}) ⇒ OrganizationUsageCount

Get Organization Usage Fetch the current usage specification of an organization by its id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    The id of the organization you want to fetch the usage of.

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

    the optional parameters

Returns:



236
237
238
239
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 236

def get_organization_usage(tr_organization, organization_id, opts = {})
  data, _status_code, _headers = get_organization_usage_with_http_info(tr_organization, organization_id, opts)
  data
end

#get_organization_usage_with_http_info(tr_organization, organization_id, opts = {}) ⇒ Array<(OrganizationUsageCount, Integer, Hash)>

Get Organization Usage Fetch the current usage specification of an organization by its id. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    The id of the organization you want to fetch the usage of.

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

    the optional parameters

Returns:

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

    OrganizationUsageCount data, response status code and response headers



247
248
249
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
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 247

def get_organization_usage_with_http_info(tr_organization, organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.get_organization_usage ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.get_organization_usage"
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationApi.get_organization_usage"
  end
  # resource path
  local_var_path = '/api/organization/usage/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_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'])
  header_params[:'TR-Organization'] = tr_organization

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

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

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

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

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

#get_organization_users(tr_organization, organization_id, opts = {}) ⇒ Array<SlimUser>

Get Organization Users Fetch the users of an organization by its id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    The id of the organization you want to fetch the users of.

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

    the optional parameters

Returns:



306
307
308
309
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 306

def get_organization_users(tr_organization, organization_id, opts = {})
  data, _status_code, _headers = get_organization_users_with_http_info(tr_organization, organization_id, opts)
  data
end

#get_organization_users_with_http_info(tr_organization, organization_id, opts = {}) ⇒ Array<(Array<SlimUser>, Integer, Hash)>

Get Organization Users Fetch the users of an organization by its id. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    The id of the organization you want to fetch the users of.

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

    the optional parameters

Returns:

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

    Array<SlimUser> data, response status code and response headers



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
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
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 317

def get_organization_users_with_http_info(tr_organization, organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.get_organization_users ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.get_organization_users"
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationApi.get_organization_users"
  end
  # resource path
  local_var_path = '/api/organization/users/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_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'])
  header_params[:'TR-Organization'] = tr_organization

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<SlimUser>'

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

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

#get_organization_with_http_info(tr_organization, organization_id, opts = {}) ⇒ Array<(Organization, Integer, Hash)>

Get Organization Fetch the details of an organization by its id. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    The id of the organization you want to fetch.

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

    the optional parameters

Returns:

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

    Organization data, response status code and response headers



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
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 177

def get_organization_with_http_info(tr_organization, organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.get_organization ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.get_organization"
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationApi.get_organization"
  end
  # resource path
  local_var_path = '/api/organization/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_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'])
  header_params[:'TR-Organization'] = tr_organization

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

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

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

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

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

#update_organization(tr_organization, update_organization_data, opts = {}) ⇒ Organization

Update Organization Update an organization. Only the owner of the organization can update it.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • update_organization_data (UpdateOrganizationData) —

    The organization data that you want to update

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

    the optional parameters

Returns:



376
377
378
379
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 376

def update_organization(tr_organization, update_organization_data, opts = {})
  data, _status_code, _headers = update_organization_with_http_info(tr_organization, update_organization_data, opts)
  data
end

#update_organization_with_http_info(tr_organization, update_organization_data, opts = {}) ⇒ Array<(Organization, Integer, Hash)>

Update Organization Update an organization. Only the owner of the organization can update it.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • update_organization_data (UpdateOrganizationData) —

    The organization data that you want to update

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

    the optional parameters

Returns:

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

    Organization data, response status code and response headers



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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/trieve_ruby_client/api/organization_api.rb', line 387

def update_organization_with_http_info(tr_organization, update_organization_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.update_organization ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.update_organization"
  end
  # verify the required parameter 'update_organization_data' is set
  if @api_client.config.client_side_validation && update_organization_data.nil?
    fail ArgumentError, "Missing the required parameter 'update_organization_data' when calling OrganizationApi.update_organization"
  end
  # resource path
  local_var_path = '/api/organization'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'TR-Organization'] = tr_organization

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

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

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

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

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