Class: OpenapiClient::AuditElementsDataApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/audit_elements_data_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuditElementsDataApi

Returns a new instance of AuditElementsDataApi.



19
20
21
 
# File 'lib/openapi_client/api/audit_elements_data_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_client/api/audit_elements_data_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#elements_list_audit_logs(proj_id, env_id, elements_config_id, opts = {}) ⇒ PaginatedResultAuditLog

List audit logs Lists audit logs for for specific elements config (tenant scope)

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Text search for the email field

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:



32
33
34
35
 
# File 'lib/openapi_client/api/audit_elements_data_api.rb', line 32

def elements_list_audit_logs(proj_id, env_id, elements_config_id, opts = {})
  data, _status_code, _headers = elements_list_audit_logs_with_http_info(proj_id, env_id, elements_config_id, opts)
  data
end

#elements_list_audit_logs_with_http_info(proj_id, env_id, elements_config_id, opts = {}) ⇒ Array<(PaginatedResultAuditLog, Integer, Hash)>

List audit logs Lists audit logs for for specific elements config (tenant scope)

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Text search for the email field

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:

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

    PaginatedResultAuditLog data, response status code and response headers



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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/openapi_client/api/audit_elements_data_api.rb', line 47

def elements_list_audit_logs_with_http_info(proj_id, env_id, elements_config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditElementsDataApi.elements_list_audit_logs ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling AuditElementsDataApi.elements_list_audit_logs"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling AuditElementsDataApi.elements_list_audit_logs"
  end
  # verify the required parameter 'elements_config_id' is set
  if @api_client.config.client_side_validation && elements_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'elements_config_id' when calling AuditElementsDataApi.elements_list_audit_logs"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AuditElementsDataApi.elements_list_audit_logs, must be greater than or equal to 1.'
  end

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

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

  # resource path
  local_var_path = '/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/audit_logs'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'elements_config_id' + '}', CGI.escape(elements_config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'PaginatedResultAuditLog'

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

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