Class: TrieveRubyClient::UserApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserApi

Returns a new instance of UserApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_user_api_key(api_key_id, opts = {}) ⇒ nil

Delete User Api Key Delete an api key for the auth’ed user.

Parameters:

  • api_key_id (String) —

    The id of the api key to delete

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_user_api_key(api_key_id, opts = {})
  delete_user_api_key_with_http_info(api_key_id, opts)
  nil
end

#delete_user_api_key_with_http_info(api_key_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete User Api Key Delete an api key for the auth&#39;ed user.

Parameters:

  • api_key_id (String) —

    The id of the api key to delete

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

    the optional parameters

Returns:

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

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

def delete_user_api_key_with_http_info(api_key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.delete_user_api_key ...'
  end
  # verify the required parameter 'api_key_id' is set
  if @api_client.config.client_side_validation && api_key_id.nil?
    fail ArgumentError, "Missing the required parameter 'api_key_id' when calling UserApi.delete_user_api_key"
  end
  # resource path
  local_var_path = '/api/user/api_key/{api_key_id}'.sub('{' + 'api_key_id' + '}', CGI.escape(api_key_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#set_user_api_key(set_user_api_key_request, opts = {}) ⇒ SetUserApiKeyResponse

Set User Api Key Create a new api key for the auth’ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth’ed user who calls this endpoint.

Parameters:

  • set_user_api_key_request (SetUserApiKeyRequest) —

    JSON request payload to create a new user api key

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/trieve_ruby_client/api/user_api.rb', line 90

def set_user_api_key(set_user_api_key_request, opts = {})
  data, _status_code, _headers = set_user_api_key_with_http_info(set_user_api_key_request, opts)
  data
end

#set_user_api_key_with_http_info(set_user_api_key_request, opts = {}) ⇒ Array<(SetUserApiKeyResponse, Integer, Hash)>

Set User Api Key Create a new api key for the auth&#39;ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth&#39;ed user who calls this endpoint.

Parameters:

  • set_user_api_key_request (SetUserApiKeyRequest) —

    JSON request payload to create a new user api key

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

    the optional parameters

Returns:

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

    SetUserApiKeyResponse data, response status code and response headers



100
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
148
149
150
151
 
# File 'lib/trieve_ruby_client/api/user_api.rb', line 100

def set_user_api_key_with_http_info(set_user_api_key_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.set_user_api_key ...'
  end
  # verify the required parameter 'set_user_api_key_request' is set
  if @api_client.config.client_side_validation && set_user_api_key_request.nil?
    fail ArgumentError, "Missing the required parameter 'set_user_api_key_request' when calling UserApi.set_user_api_key"
  end
  # resource path
  local_var_path = '/api/user/api_key'

  # 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(set_user_api_key_request)

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

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

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

#update_user(update_user_org_role_data, opts = {}) ⇒ nil

Update User Update a user’s information. If the user_id is not provided, the auth’ed user will be updated. If the user_id is provided, the role of the auth’ed user or api key must be an admin (1) or owner (2) of the organization.

Parameters:

  • update_user_org_role_data (UpdateUserOrgRoleData) —

    JSON request payload to update user information for the auth&#39;ed user

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

    the optional parameters

Returns:

  • (nil) 


158
159
160
161
 
# File 'lib/trieve_ruby_client/api/user_api.rb', line 158

def update_user(update_user_org_role_data, opts = {})
  update_user_with_http_info(update_user_org_role_data, opts)
  nil
end

#update_user_with_http_info(update_user_org_role_data, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update User Update a user&#39;s information. If the user_id is not provided, the auth&#39;ed user will be updated. If the user_id is provided, the role of the auth&#39;ed user or api key must be an admin (1) or owner (2) of the organization.

Parameters:

  • update_user_org_role_data (UpdateUserOrgRoleData) —

    JSON request payload to update user information for the auth&#39;ed user

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/trieve_ruby_client/api/user_api.rb', line 168

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

  # 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(update_user_org_role_data)

  # return_type
  return_type = opts[:debug_return_type]

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

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