Class: LiteLLMClient::AuditLoggingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/api/audit_logging_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuditLoggingApi

Returns a new instance of AuditLoggingApi.



19
20
21
 
# File 'lib/litellm_client/api/audit_logging_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/litellm_client/api/audit_logging_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_audit_log_by_id_audit_id_get(id, opts = {}) ⇒ AuditLogResponse

Get Audit Log By Id Get detailed information about a specific audit log entry by its ID. Args: id (str): The unique identifier of the audit log entry Returns: AuditLogResponse: Detailed information about the audit log entry Raises: HTTPException: If the audit log is not found or if there’s a database connection error

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/litellm_client/api/audit_logging_api.rb', line 27

def get_audit_log_by_id_audit_id_get(id, opts = {})
  data, _status_code, _headers = get_audit_log_by_id_audit_id_get_with_http_info(id, opts)
  data
end

#get_audit_log_by_id_audit_id_get_with_http_info(id, opts = {}) ⇒ Array<(AuditLogResponse, Integer, Hash)>

Get Audit Log By Id Get detailed information about a specific audit log entry by its ID. Args: id (str): The unique identifier of the audit log entry Returns: AuditLogResponse: Detailed information about the audit log entry Raises: HTTPException: If the audit log is not found or if there&#39;s a database connection error

Parameters:

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

    the optional parameters

Returns:

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

    AuditLogResponse 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
 
# File 'lib/litellm_client/api/audit_logging_api.rb', line 37

def get_audit_log_by_id_audit_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLoggingApi.get_audit_log_by_id_audit_id_get ...'
  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 AuditLoggingApi.get_audit_log_by_id_audit_id_get"
  end
  # resource path
  local_var_path = '/audit/{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] || 'AuditLogResponse'

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

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

#get_audit_logs_audit_get(opts = {}) ⇒ PaginatedAuditLogResponse

Get Audit Logs Get all audit logs with filtering and pagination. Returns a paginated response of audit logs matching the specified filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 10
  • :changed_by (String) —

    Filter by user or system that performed the action

  • :changed_by_api_key (String) —

    Filter by API key hash that performed the action

  • :action (String) —

    Filter by action type (create, update, delete)

  • :table_name (String) —

    Filter by table name that was modified

  • :object_id (String) —

    Filter by ID of the object that was modified

  • :start_date (String) —

    Filter logs after this date

  • :end_date (String) —

    Filter logs before this date

  • :sort_by (String) —

    Column to sort by (e.g. &#39;updated_at&#39;, &#39;action&#39;, &#39;table_name&#39;)

  • :sort_order (String) —

    Sort order (&#39;asc&#39; or &#39;desc&#39;) (default to ‘desc’)

Returns:



100
101
102
103
 
# File 'lib/litellm_client/api/audit_logging_api.rb', line 100

def get_audit_logs_audit_get(opts = {})
  data, _status_code, _headers = get_audit_logs_audit_get_with_http_info(opts)
  data
end

#get_audit_logs_audit_get_with_http_info(opts = {}) ⇒ Array<(PaginatedAuditLogResponse, Integer, Hash)>

Get Audit Logs Get all audit logs with filtering and pagination. Returns a paginated response of audit logs matching the specified filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 10
  • :changed_by (String) —

    Filter by user or system that performed the action

  • :changed_by_api_key (String) —

    Filter by API key hash that performed the action

  • :action (String) —

    Filter by action type (create, update, delete)

  • :table_name (String) —

    Filter by table name that was modified

  • :object_id (String) —

    Filter by ID of the object that was modified

  • :start_date (String) —

    Filter logs after this date

  • :end_date (String) —

    Filter logs before this date

  • :sort_by (String) —

    Column to sort by (e.g. &#39;updated_at&#39;, &#39;action&#39;, &#39;table_name&#39;)

  • :sort_order (String) —

    Sort order (&#39;asc&#39; or &#39;desc&#39;) (default to ‘desc’)

Returns:

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

    PaginatedAuditLogResponse data, response status code and response headers



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
159
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
 
# File 'lib/litellm_client/api/audit_logging_api.rb', line 120

def get_audit_logs_audit_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLoggingApi.get_audit_logs_audit_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AuditLoggingApi.get_audit_logs_audit_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AuditLoggingApi.get_audit_logs_audit_get, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AuditLoggingApi.get_audit_logs_audit_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/audit'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'changed_by'] = opts[:'changed_by'] if !opts[:'changed_by'].nil?
  query_params[:'changed_by_api_key'] = opts[:'changed_by_api_key'] if !opts[:'changed_by_api_key'].nil?
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'table_name'] = opts[:'table_name'] if !opts[:'table_name'].nil?
  query_params[:'object_id'] = opts[:'object_id'] if !opts[:'object_id'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].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] || 'PaginatedAuditLogResponse'

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

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