Class: Courier::Models::WorkspacePreferenceListLogsParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/courier/models/workspace_preference_list_logs_params.rb,
sig/courier/models/workspace_preference_list_logs_params.rbs

Overview

See Also:

  • Courier::Resources::WorkspacePreferences#list_logs

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(cursor: nil, limit: nil, since: nil, tenant_id: nil, user_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::WorkspacePreferenceListLogsParams for more details.

Parameters:

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

    A cursor from a previous response's paging.cursor. Continue only while paging.mo

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

    How many entries to return. Defaults to 25.

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

    Return only changes at or after this time, as an ISO-8601 date or date-time. A d

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

    Narrow to the changes this user made in one tenant context. Only valid together

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

    Return only this user's changes. Omit it to read every change in the environment

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


# File 'lib/courier/models/workspace_preference_list_logs_params.rb', line 44

Instance Attribute Details

#cursor ⇒ String?

A cursor from a previous response's paging.cursor. Continue only while paging.more is true; the cursor is omitted on the last page.

Parameters:

  • (String)

Returns:

  • (String, nil)


15
# File 'lib/courier/models/workspace_preference_list_logs_params.rb', line 15

optional :cursor, String

#limit ⇒ Integer?

How many entries to return. Defaults to 25.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


21
# File 'lib/courier/models/workspace_preference_list_logs_params.rb', line 21

optional :limit, Integer

#since ⇒ String?

Return only changes at or after this time, as an ISO-8601 date or date-time. A date alone is read as the start of that day in UTC.

Parameters:

  • (String)

Returns:

  • (String, nil)


28
# File 'lib/courier/models/workspace_preference_list_logs_params.rb', line 28

optional :since, String

#tenant_id ⇒ String?

Narrow to the changes this user made in one tenant context. Only valid together with user_id.

Parameters:

  • (String)

Returns:

  • (String, nil)


35
# File 'lib/courier/models/workspace_preference_list_logs_params.rb', line 35

optional :tenant_id, String

#user_id ⇒ String?

Return only this user's changes. Omit it to read every change in the environment.

Parameters:

  • (String)

Returns:

  • (String, nil)


42
# File 'lib/courier/models/workspace_preference_list_logs_params.rb', line 42

optional :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({)


46
# File 'sig/courier/models/workspace_preference_list_logs_params.rbs', line 46

def to_hash: -> {