Class: Knockapi::Models::Users::FeedListItemsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::Users::FeedListItemsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/knockapi/models/users/feed_list_items_params.rb,
sig/knockapi/models/users/feed_list_items_params.rbs

Overview

See Also:

• Knockapi::Resources::Users::Feeds#list_items

Defined Under Namespace

Modules: Archived, Mode, Status Classes: InsertedAt

Instance Attribute Summary

• #after ⇒ String^?

  The cursor to fetch entries after.

• #archived ⇒ Symbol, ...

  The archived status of the feed items.

• #before ⇒ String^?

  The cursor to fetch entries before.

• #exclude ⇒ String^?

  Comma-separated list of field paths to exclude from the response.

• #has_tenant ⇒ Boolean^?

  Whether the feed items have a tenant.

• #id ⇒ String
• #inserted_at ⇒ Knockapi::Models::Users::FeedListItemsParams::InsertedAt^?
• #locale ⇒ String^?

  The locale to render the feed items in.

• #mode ⇒ Symbol, ...

  The mode to render the feed items in.

• #page_size ⇒ Integer^?

  The number of items per page (defaults to 50).

• #source ⇒ String^?

  The workflow key associated with the message in the feed.

• #status ⇒ Symbol, ...

  The status of the feed items.

• #tenant ⇒ String^?

  The tenant associated with the feed items.

• #trigger_data ⇒ String^?

  The trigger data of the feed items (as a JSON string).

• #user_id ⇒ String
• #workflow_categories ⇒ Array<String>^?

  The workflow categories of the feed items.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

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

Parameters:

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

  Limits the results to items inserted after the given date.

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

  Limits the results to items inserted after or on the given date.

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

  Limits the results to items inserted before the given date.

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

  Limits the results to items inserted before or on the given date.

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 112

Instance Attribute Details

#after ⇒ String^?

The cursor to fetch entries after.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 25

optional :after, String

#archived ⇒ Symbol, ...

The archived status of the feed items.

Returns:

• (Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 31

optional :archived, enum: -> { Knockapi::Users::FeedListItemsParams::Archived }

#before ⇒ String^?

The cursor to fetch entries before.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 37

optional :before, String

#exclude ⇒ String^?

Comma-separated list of field paths to exclude from the response. Use dot notation for nested fields (e.g., entries.archived_at). Limited to 3 levels deep.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 45

optional :exclude, String

#has_tenant ⇒ Boolean^?

Whether the feed items have a tenant.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 51

optional :has_tenant, Knockapi::Internal::Type::Boolean

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 19

required :id, String

#inserted_at ⇒ Knockapi::Models::Users::FeedListItemsParams::InsertedAt^?

Returns:

• (Knockapi::Models::Users::FeedListItemsParams::InsertedAt, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 56

optional :inserted_at, -> { Knockapi::Users::FeedListItemsParams::InsertedAt }

#locale ⇒ String^?

The locale to render the feed items in. Must be in the IETF 5646 format (e.g. en-US). When not provided, will default to the locale that the feed items were rendered in. Only available for enterprise plan customers using custom translations.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 65

optional :locale, String

#mode ⇒ Symbol, ...

The mode to render the feed items in. Can be compact or rich. Defaults to rich. When mode is compact, feed items will not have activities and total_activities fields; the data field will not include nested arrays and objects; and the actors field will only have up to one actor.

Returns:

• (Symbol, Knockapi::Models::Users::FeedListItemsParams::Mode, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 74

optional :mode, enum: -> { Knockapi::Users::FeedListItemsParams::Mode }

#page_size ⇒ Integer^?

The number of items per page (defaults to 50).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 80

optional :page_size, Integer

#source ⇒ String^?

The workflow key associated with the message in the feed.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 86

optional :source, String

#status ⇒ Symbol, ...

The status of the feed items.

Returns:

• (Symbol, Knockapi::Models::Users::FeedListItemsParams::Status, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 92

optional :status, enum: -> { Knockapi::Users::FeedListItemsParams::Status }

#tenant ⇒ String^?

The tenant associated with the feed items.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 98

optional :tenant, String

#trigger_data ⇒ String^?

The trigger data of the feed items (as a JSON string).

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 104

optional :trigger_data, String

#user_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 14

required :user_id, String

#workflow_categories ⇒ Array<String>^?

The workflow categories of the feed items.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 110

optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/knockapi/models/users/feed_list_items_params.rb', line 158

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/knockapi/models/users/feed_list_items_params.rbs', line 117

def to_hash: -> {