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

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/knockapi/models/users/feed_list_items_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Archived, Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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(after: nil, archived: nil, before: nil, has_tenant: nil, locale: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Users::FeedListItemsParams for more details.

Parameters:

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

    The cursor to fetch entries after.

  • archived (Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived) (defaults to: nil) —

    The archived status of the feed items.

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

    The cursor to fetch entries before.

  • has_tenant (Boolean) (defaults to: nil) —

    Whether the feed items have a tenant.

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

    The locale to render the feed items in. Must be in the IETF 5646 format (e.g. ‘e

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

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

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

    The workflow key associated with the message in the feed.

  • status (Symbol, Knockapi::Models::Users::FeedListItemsParams::Status) (defaults to: nil) —

    The status of the feed items.

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

    The tenant associated with the feed items.

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

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

  • workflow_categories (Array<String>) (defaults to: nil) —

    The workflow categories of the feed items.

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



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

Instance Attribute Details

#after ⇒ String?

The cursor to fetch entries after.

Returns:

  • (String, nil) 


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

optional :after, String

#archived ⇒ Symbol, ...

The archived status of the feed items.

Returns:



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

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

#before ⇒ String?

The cursor to fetch entries before.

Returns:

  • (String, nil) 


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

optional :before, String

#has_tenant ⇒ Boolean?

Whether the feed items have a tenant.

Returns:

  • (Boolean, nil) 


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

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

#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.

Returns:

  • (String, nil) 


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

optional :locale, String

#page_size ⇒ Integer?

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

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#source ⇒ String?

The workflow key associated with the message in the feed.

Returns:

  • (String, nil) 


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

optional :source, String

#status ⇒ Symbol, ...

The status of the feed items.

Returns:



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

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

#tenant ⇒ String?

The tenant associated with the feed items.

Returns:

  • (String, nil) 


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

optional :tenant, String

#trigger_data ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :trigger_data, String

#workflow_categories ⇒ Array<String>?

The workflow categories of the feed items.

Returns:

  • (Array<String>, nil) 


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

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 116