class LaunchDarklyApi::AuditLogApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/launchdarkly_api/api/audit_log_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_audit_log_entries(opts = {}) click to toggle source

List audit log feature flag entries Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. @param [Hash] opts the optional parameters @option opts [Integer] :before A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp. @option opts [Integer] :after A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. @option opts [String] :q Text to search for. You can search for the full or partial name of the resource, or full or partial email address of the member who made a change. @option opts [Integer] :limit A limit on the number of audit log entries that return. Set between 1 and 20. @option opts [String] :spec A resource specifier that lets you filter audit log listings by resource @return [AuditLogEntryListingRepCollection]

# File lib/launchdarkly_api/api/audit_log_api.rb, line 31
def get_audit_log_entries(opts = {})
  data, _status_code, _headers = get_audit_log_entries_with_http_info(opts)
  data
end
get_audit_log_entries_with_http_info(opts = {}) click to toggle source

List audit log feature flag entries Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. @param [Hash] opts the optional parameters @option opts [Integer] :before A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp. @option opts [Integer] :after A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. @option opts [String] :q Text to search for. You can search for the full or partial name of the resource, or full or partial email address of the member who made a change. @option opts [Integer] :limit A limit on the number of audit log entries that return. Set between 1 and 20. @option opts [String] :spec A resource specifier that lets you filter audit log listings by resource @return [Array<(AuditLogEntryListingRepCollection, Integer, Hash)>] AuditLogEntryListingRepCollection data, response status code and response headers

# File lib/launchdarkly_api/api/audit_log_api.rb, line 45
def get_audit_log_entries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLogApi.get_audit_log_entries ...'
  end
  # resource path
  local_var_path = '/api/v2/auditlog'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'spec'] = opts[:'spec'] if !opts[:'spec'].nil?

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

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

  new_options = opts.merge(
    :operation => :"AuditLogApi.get_audit_log_entries",
    :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: AuditLogApi#get_audit_log_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_audit_log_entry(id, opts = {}) click to toggle source

Get audit log entry Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation: - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity @param id [String] The ID of the audit log entry @param [Hash] opts the optional parameters @return [AuditLogEntryRep]

# File lib/launchdarkly_api/api/audit_log_api.rb, line 99
def get_audit_log_entry(id, opts = {})
  data, _status_code, _headers = get_audit_log_entry_with_http_info(id, opts)
  data
end
get_audit_log_entry_with_http_info(id, opts = {}) click to toggle source

Get audit log entry Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation: - &#x60;delta&#x60;: the JSON patch body that was used in the request to update the entity - &#x60;previousVersion&#x60;: a JSON representation of the previous version of the entity - &#x60;currentVersion&#x60;: a JSON representation of the current version of the entity @param id [String] The ID of the audit log entry @param [Hash] opts the optional parameters @return [Array<(AuditLogEntryRep, Integer, Hash)>] AuditLogEntryRep data, response status code and response headers

# File lib/launchdarkly_api/api/audit_log_api.rb, line 109
def get_audit_log_entry_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLogApi.get_audit_log_entry ...'
  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 AuditLogApi.get_audit_log_entry"
  end
  # resource path
  local_var_path = '/api/v2/auditlog/{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'])

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

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

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

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

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