Class: Asana::Resources::AuditLogAPIBase

Inherits:
Resource
  • Object
show all
Defined in:
lib/asana/resources/gen/audit_log_api_base.rb

Direct Known Subclasses

AuditLogAPI

Class Method Summary collapse

Methods inherited from Resource

#initialize, #method_missing, #refresh, #respond_to_missing?, #to_h, #to_s

Methods included from ResponseHelper

#parse

Constructor Details

This class inherits a constructor from Asana::Resources::Resource

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Asana::Resources::Resource

Class Method Details

.get_audit_log_events(client, workspace_gid: required("workspace_gid"), start_at: nil, end_at: nil, event_type: nil, actor_type: nil, actor_gid: nil, resource_gid: nil, options: {}) ⇒ Object

Get audit log events

Parameters:

  • workspace_gid (str) (defaults to: required("workspace_gid")) —

    (required) Globally unique identifier for the workspace or organization.

  • start_at (datetime) (defaults to: nil) —

    Filter to events created after this time (inclusive).

  • end_at (datetime) (defaults to: nil) —

    Filter to events created before this time (exclusive).

  • event_type (str) (defaults to: nil) —

    Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values.

  • actor_type (str) (defaults to: nil) —

    Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If ‘actor_gid` is included, this should be excluded.

  • actor_gid (str) (defaults to: nil) —

    Filter to events triggered by the actor with this ID.

  • resource_gid (str) (defaults to: nil) —

    Filter to events with this resource ID.

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

    the request I/O options

  • str (>]'Note: You can only pass in an offset that was returned to you via a previously paginated request.') —

    offset [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. ‘Note: You can only pass in an offset that was returned to you via a previously paginated request.’

  • int (>]) —

    limit [int] Results per page. The number of objects to return per page. The value must be between 1 and 100.



27
28
29
30
31
32
 
# File 'lib/asana/resources/gen/audit_log_api_base.rb', line 27

def get_audit_log_events(client, workspace_gid: required("workspace_gid"), start_at: nil, end_at: nil, event_type: nil, actor_type: nil, actor_gid: nil, resource_gid: nil, options: {})
  path = "/workspaces/{workspace_gid}/audit_log_events"
  path["{workspace_gid}"] = workspace_gid
  params = { start_at: start_at, end_at: end_at, event_type: event_type, actor_type: actor_type, actor_gid: actor_gid, resource_gid: resource_gid }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
end

.inherited(base) ⇒ Object 



10
11
12
 
# File 'lib/asana/resources/gen/audit_log_api_base.rb', line 10

def self.inherited(base)
  Registry.register(base)
end