Class: OpenApiOpenAIClient::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_openai/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
 
# File 'lib/openapi_openai/api/default_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/openapi_openai/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#admin_api_keys_create(admin_api_keys_create_request, opts = {}) ⇒ AdminApiKey

Create an organization admin API key Create a new admin-level API key for the organization.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/openapi_openai/api/default_api.rb', line 27

def admin_api_keys_create(admin_api_keys_create_request, opts = {})
  data, _status_code, _headers = admin_api_keys_create_with_http_info(admin_api_keys_create_request, opts)
  data
end

#admin_api_keys_create_with_http_info(admin_api_keys_create_request, opts = {}) ⇒ Array<(AdminApiKey, Integer, Hash)>

Create an organization admin API key Create a new admin-level API key for the organization.

Parameters:

Returns:

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

    AdminApiKey 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/openapi_openai/api/default_api.rb', line 37

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

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

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

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

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

#admin_api_keys_delete(key_id, opts = {}) ⇒ AdminApiKeysDelete200Response

Delete an organization admin API key Delete the specified admin API key.

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/openapi_openai/api/default_api.rb', line 95

def admin_api_keys_delete(key_id, opts = {})
  data, _status_code, _headers = admin_api_keys_delete_with_http_info(key_id, opts)
  data
end

#admin_api_keys_delete_with_http_info(key_id, opts = {}) ⇒ Array<(AdminApiKeysDelete200Response, Integer, Hash)>

Delete an organization admin API key Delete the specified admin API key.

Parameters:

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

    the optional parameters

Returns:



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/openapi_openai/api/default_api.rb', line 105

def admin_api_keys_delete_with_http_info(key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.admin_api_keys_delete ...'
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling DefaultApi.admin_api_keys_delete"
  end
  # resource path
  local_var_path = '/organization/admin_api_keys/{key_id}'.sub('{' + 'key_id' + '}', CGI.escape(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']) 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] || 'AdminApiKeysDelete200Response'

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

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

#admin_api_keys_get(key_id, opts = {}) ⇒ AdminApiKey

Retrieve a single organization API key Get details for a specific organization API key by its ID.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/openapi_openai/api/default_api.rb', line 158

def admin_api_keys_get(key_id, opts = {})
  data, _status_code, _headers = admin_api_keys_get_with_http_info(key_id, opts)
  data
end

#admin_api_keys_get_with_http_info(key_id, opts = {}) ⇒ Array<(AdminApiKey, Integer, Hash)>

Retrieve a single organization API key Get details for a specific organization API key by its ID.

Parameters:

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

    the optional parameters

Returns:

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

    AdminApiKey data, 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
 
# File 'lib/openapi_openai/api/default_api.rb', line 168

def admin_api_keys_get_with_http_info(key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.admin_api_keys_get ...'
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling DefaultApi.admin_api_keys_get"
  end
  # resource path
  local_var_path = '/organization/admin_api_keys/{key_id}'.sub('{' + 'key_id' + '}', CGI.escape(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']) 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] || 'AdminApiKey'

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

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

#admin_api_keys_list(opts = {}) ⇒ ApiKeyList

List organization API keys Retrieve a paginated list of organization admin API keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (String)
  • :order (String) — default: default to 'asc'
  • :limit (Integer) — default: default to 20

Returns:



223
224
225
226
 
# File 'lib/openapi_openai/api/default_api.rb', line 223

def admin_api_keys_list(opts = {})
  data, _status_code, _headers = admin_api_keys_list_with_http_info(opts)
  data
end

#admin_api_keys_list_with_http_info(opts = {}) ⇒ Array<(ApiKeyList, Integer, Hash)>

List organization API keys Retrieve a paginated list of organization admin API keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (String)
  • :order (String) — default: default to 'asc'
  • :limit (Integer) — default: default to 20

Returns:

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

    ApiKeyList data, response status code and response headers



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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/openapi_openai/api/default_api.rb', line 235

def admin_api_keys_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.admin_api_keys_list ...'
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
    fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/organization/admin_api_keys'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'ApiKeyList'

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

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