Class: OpenAI::Models::Admin::Organization::AuditLogListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Admin::Organization::AuditLogListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/admin/organization/audit_log_list_params.rb

Overview

See Also:

• Resources::Admin::Organization::AuditLogs#list

Defined Under Namespace

Modules: EventType Classes: EffectiveAt

Instance Attribute Summary

• #actor_emails ⇒ Array<String>^?

  Return only events performed by users with these emails.

• #actor_ids ⇒ Array<String>^?

  Return only events performed by these actors.

• #after ⇒ String^?

  A cursor for use in pagination.

• #before ⇒ String^?

  A cursor for use in pagination.

• #effective_at ⇒ OpenAI::Models::Admin::Organization::AuditLogListParams::EffectiveAt^?

  Return only events whose ‘effective_at` (Unix seconds) is in this range.

• #event_types ⇒ Array<Symbol, OpenAI::Models::Admin::Organization::AuditLogListParams::EventType>^?

  Return only events with a ‘type` in one of these values.

• #limit ⇒ Integer^?

  A limit on the number of objects to be returned.

• #project_ids ⇒ Array<String>^?

  Return only events for these projects.

• #resource_ids ⇒ Array<String>^?

  Return only events performed on these targets.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(gt: nil, gte: nil, lt: nil, lte: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see EffectiveAt for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(gt: nil, gte: nil, lt: nil, lte: nil) ⇒ Object

Some parameter documentations has been truncated, see EffectiveAt for more details.

Return only events whose ‘effective_at` (Unix seconds) is in this range.

Parameters:

• gt (Integer) (defaults to: nil) —

  Return only events whose ‘effective_at` (Unix seconds) is greater than this valu

• gte (Integer) (defaults to: nil) —

  Return only events whose ‘effective_at` (Unix seconds) is greater than or equal

• lt (Integer) (defaults to: nil) —

  Return only events whose ‘effective_at` (Unix seconds) is less than this value.

• lte (Integer) (defaults to: nil) —

  Return only events whose ‘effective_at` (Unix seconds) is less than or equal to

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 130

Instance Attribute Details

#actor_emails ⇒ Array<String>^?

Return only events performed by users with these emails.

Returns:

• (Array<String>, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 16

optional :actor_emails, OpenAI::Internal::Type::ArrayOf[String]

#actor_ids ⇒ Array<String>^?

Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.

Returns:

• (Array<String>, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 23

optional :actor_ids, OpenAI::Internal::Type::ArrayOf[String]

#after ⇒ String^?

A cursor for use in pagination. ‘after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Returns:

• (String, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 32

optional :after, String

#before ⇒ String^?

A cursor for use in pagination. ‘before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Returns:

• (String, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 41

optional :before, String

#effective_at ⇒ OpenAI::Models::Admin::Organization::AuditLogListParams::EffectiveAt^?

Return only events whose ‘effective_at` (Unix seconds) is in this range.

Returns:

• (OpenAI::Models::Admin::Organization::AuditLogListParams::EffectiveAt, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 47

optional :effective_at, -> { OpenAI::Admin::Organization::AuditLogListParams::EffectiveAt }

#event_types ⇒ Array<Symbol, OpenAI::Models::Admin::Organization::AuditLogListParams::EventType>^?

Return only events with a ‘type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](platform.openai.com/docs/api-reference/audit-logs/object).

Returns:

• (Array<Symbol, OpenAI::Models::Admin::Organization::AuditLogListParams::EventType>, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 55

optional :event_types,
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Admin::Organization::AuditLogListParams::EventType] }

#limit ⇒ Integer^?

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Returns:

• (Integer, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 63

optional :limit, Integer

#project_ids ⇒ Array<String>^?

Return only events for these projects.

Returns:

• (Array<String>, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 69

optional :project_ids, OpenAI::Internal::Type::ArrayOf[String]

#resource_ids ⇒ Array<String>^?

Return only events performed on these targets. For example, a project ID updated.

Returns:

• (Array<String>, nil)

# File 'lib/openai/models/admin/organization/audit_log_list_params.rb', line 76

optional :resource_ids, OpenAI::Internal::Type::ArrayOf[String]