Class: MergeHRISClient::AuditTrailApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/api/audit_trail_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuditTrailApi

Returns a new instance of AuditTrailApi.



19
20
21
 
# File 'lib/merge_hris_client/api/audit_trail_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/merge_hris_client/api/audit_trail_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#audit_trail_list(opts = {}) ⇒ PaginatedAuditLogEventList

Gets a list of audit trail events.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    The pagination cursor value.

  • :end_date (String) —

    If included, will only include audit trail events that occurred before this time

  • :event_type (String) —

    If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`

  • :page_size (Integer) —

    Number of results to return per page.

  • :start_date (String) —

    If included, will only include audit trail events that occurred after this time

  • :user_email (String) —

    If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.

Returns:



31
32
33
34
 
# File 'lib/merge_hris_client/api/audit_trail_api.rb', line 31

def audit_trail_list(opts = {})
  data, _status_code, _headers = audit_trail_list_with_http_info(opts)
  data
end

#audit_trail_list_with_http_info(opts = {}) ⇒ Array<(PaginatedAuditLogEventList, Integer, Hash)>

Gets a list of audit trail events.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    The pagination cursor value.

  • :end_date (String) —

    If included, will only include audit trail events that occurred before this time

  • :event_type (String) —

    If included, will only include events with the given event type. Possible values include: &#x60;CREATED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;DELETED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;CREATED_TEST_API_KEY&#x60;, &#x60;DELETED_TEST_API_KEY&#x60;, &#x60;REGENERATED_PRODUCTION_API_KEY&#x60;, &#x60;INVITED_USER&#x60;, &#x60;TWO_FACTOR_AUTH_ENABLED&#x60;, &#x60;TWO_FACTOR_AUTH_DISABLED&#x60;, &#x60;DELETED_LINKED_ACCOUNT&#x60;, &#x60;CREATED_DESTINATION&#x60;, &#x60;DELETED_DESTINATION&#x60;, &#x60;CHANGED_DESTINATION&#x60;, &#x60;CHANGED_SCOPES&#x60;, &#x60;CHANGED_PERSONAL_INFORMATION&#x60;, &#x60;CHANGED_ORGANIZATION_SETTINGS&#x60;, &#x60;ENABLED_INTEGRATION&#x60;, &#x60;DISABLED_INTEGRATION&#x60;, &#x60;ENABLED_CATEGORY&#x60;, &#x60;DISABLED_CATEGORY&#x60;, &#x60;CHANGED_PASSWORD&#x60;, &#x60;RESET_PASSWORD&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;CREATED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;CREATED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;CHANGED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;CHANGED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;DELETED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;DELETED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;FORCED_LINKED_ACCOUNT_RESYNC&#x60;, &#x60;MUTED_ISSUE&#x60;, &#x60;GENERATED_MAGIC_LINK&#x60;, &#x60;ENABLED_MERGE_WEBHOOK&#x60;, &#x60;DISABLED_MERGE_WEBHOOK&#x60;, &#x60;MERGE_WEBHOOK_TARGET_CHANGED&#x60;, &#x60;END_USER_CREDENTIALS_ACCESSED&#x60;

  • :page_size (Integer) —

    Number of results to return per page.

  • :start_date (String) —

    If included, will only include audit trail events that occurred after this time

  • :user_email (String) —

    If provided, this will return events associated with the specified user email. Please note that the email address reflects the user&#39;s email at the time of the event, and may not be their current email.

Returns:

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

    PaginatedAuditLogEventList data, response status code and response headers



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
89
90
91
92
93
 
# File 'lib/merge_hris_client/api/audit_trail_api.rb', line 45

def audit_trail_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditTrailApi.audit_trail_list ...'
  end
  # resource path
  local_var_path = '/audit-trail'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'event_type'] = opts[:'event_type'] if !opts[:'event_type'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'user_email'] = opts[:'user_email'] if !opts[:'user_email'].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] || 'PaginatedAuditLogEventList'

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

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