Class: Hubspot::Cms::AuditLogs::AuditLogsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/cms/audit-logs/api/audit_logs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuditLogsApi 



21
22
23
 
# File 'lib/hubspot/codegen/cms/audit-logs/api/audit_logs_api.rb', line 21

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/cms/audit-logs/api/audit_logs_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#get_page(opts = {}) ⇒ CollectionResponsePublicAuditLog

Query audit logs Returns audit logs based on filters.

Options Hash (opts):

  • :object_id (Array<String>) —

    Comma separated list of object ids to filter by.

  • :user_id (Array<String>) —

    Comma separated list of user ids to filter by.

  • :after (String) —

    Timestamp after which audit logs will be returned

  • :before (String) —

    Timestamp before which audit logs will be returned

  • :sort (Array<String>) —

    The sort direction for the audit logs. (Can only sort by timestamp).

  • :event_type (Array<String>) —

    Comma separated list of event types to filter by (CREATED, UPDATED, PUBLISHED, DELETED, UNPUBLISHED).

  • :limit (Integer) —

    The number of logs to return.

  • :object_type (Array<String>) —

    Comma separated list of object types to filter by (BLOG, LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.)



36
37
38
39
 
# File 'lib/hubspot/codegen/cms/audit-logs/api/audit_logs_api.rb', line 36

def get_page(opts = {})
  data, _status_code, _headers = get_page_with_http_info(opts)
  data
end

#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponsePublicAuditLog, Integer, Hash)>

Query audit logs Returns audit logs based on filters.

Options Hash (opts):

  • :object_id (Array<String>) —

    Comma separated list of object ids to filter by.

  • :user_id (Array<String>) —

    Comma separated list of user ids to filter by.

  • :after (String) —

    Timestamp after which audit logs will be returned

  • :before (String) —

    Timestamp before which audit logs will be returned

  • :sort (Array<String>) —

    The sort direction for the audit logs. (Can only sort by timestamp).

  • :event_type (Array<String>) —

    Comma separated list of event types to filter by (CREATED, UPDATED, PUBLISHED, DELETED, UNPUBLISHED).

  • :limit (Integer) —

    The number of logs to return.

  • :object_type (Array<String>) —

    Comma separated list of object types to filter by (BLOG, LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.)



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
 
# File 'lib/hubspot/codegen/cms/audit-logs/api/audit_logs_api.rb', line 53

def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLogsApi.get_page ...'
  end
  # resource path
  local_var_path = '/cms/v3/audit-logs/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'objectId'] = @api_client.build_collection_param(opts[:'object_id'], :multi) if !opts[:'object_id'].nil?
  query_params[:'userId'] = @api_client.build_collection_param(opts[:'user_id'], :multi) if !opts[:'user_id'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
  query_params[:'eventType'] = @api_client.build_collection_param(opts[:'event_type'], :multi) if !opts[:'event_type'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'objectType'] = @api_client.build_collection_param(opts[:'object_type'], :multi) if !opts[:'object_type'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'CollectionResponsePublicAuditLog' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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