Class: MetronomeSDK::Models::V1::AuditLogListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/audit_log_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Sort

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(ending_before: nil, limit: nil, next_page: nil, resource_id: nil, resource_type: nil, sort: nil, starting_on: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::AuditLogListParams for more details.

Parameters:

  • ending_before (Time) (defaults to: nil) —

    RFC 3339 timestamp (exclusive). Cannot be used with ‘next_page’.

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

    Max number of results that should be returned

  • next_page (String) (defaults to: nil) —

    Cursor that indicates where the next page of results should start.

  • resource_id (String) (defaults to: nil) —

    Optional parameter that can be used to filter which audit logs are returned. If

  • resource_type (String) (defaults to: nil) —

    Optional parameter that can be used to filter which audit logs are returned. If

  • sort (Symbol, MetronomeSDK::Models::V1::AuditLogListParams::Sort) (defaults to: nil) —

    Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.

  • starting_on (Time) (defaults to: nil) —

    RFC 3339 timestamp of the earliest audit log to return. Cannot be used with ‘nex

  • request_options (MetronomeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/metronome_sdk/models/v1/audit_log_list_params.rb', line 56

Instance Attribute Details

#ending_before ⇒ Time?

RFC 3339 timestamp (exclusive). Cannot be used with ‘next_page’.

Returns:

  • (Time, nil) 


15
 
# File 'lib/metronome_sdk/models/v1/audit_log_list_params.rb', line 15

optional :ending_before, Time

#limit ⇒ Integer?

Max number of results that should be returned

Returns:

  • (Integer, nil) 


21
 
# File 'lib/metronome_sdk/models/v1/audit_log_list_params.rb', line 21

optional :limit, Integer

#next_page ⇒ String?

Cursor that indicates where the next page of results should start.

Returns:

  • (String, nil) 


27
 
# File 'lib/metronome_sdk/models/v1/audit_log_list_params.rb', line 27

optional :next_page, String

#resource_id ⇒ String?

Optional parameter that can be used to filter which audit logs are returned. If you specify resource_id, you must also specify resource_type.

Returns:

  • (String, nil) 


34
 
# File 'lib/metronome_sdk/models/v1/audit_log_list_params.rb', line 34

optional :resource_id, String

#resource_type ⇒ String?

Optional parameter that can be used to filter which audit logs are returned. If you specify resource_type, you must also specify resource_id.

Returns:

  • (String, nil) 


41
 
# File 'lib/metronome_sdk/models/v1/audit_log_list_params.rb', line 41

optional :resource_type, String

#sort ⇒ Symbol, ...

Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.

Returns:



47
 
# File 'lib/metronome_sdk/models/v1/audit_log_list_params.rb', line 47

optional :sort, enum: -> { MetronomeSDK::V1::AuditLogListParams::Sort }

#starting_on ⇒ Time?

RFC 3339 timestamp of the earliest audit log to return. Cannot be used with ‘next_page’.

Returns:

  • (Time, nil) 


54
 
# File 'lib/metronome_sdk/models/v1/audit_log_list_params.rb', line 54

optional :starting_on, Time