Class: Knockapi::Models::Users::FeedListItemsResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/users/feed_list_items_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Block Classes: Source

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(id:, _typename:, activities:, actors:, blocks:, data:, inserted_at:, source:, tenant:, total_activities:, total_actors:, updated_at:, archived_at: nil, clicked_at: nil, interacted_at: nil, link_clicked_at: nil, read_at: nil, seen_at: nil) ⇒ Object

An in-app feed message in a user’s feed.

Parameters:

  • id (String) —

    Unique identifier for the feed.

  • _typename (String) —

    The typename of the schema.

  • activities (Array<Knockapi::Models::Activity>) —

    List of activities associated with this feed item.

  • actors (Array<Knockapi::Models::User, Knockapi::Models::Object>) —

    List of actors associated with this feed item.

  • blocks (Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock>) —

    Content blocks that make up the feed item.

  • data (Hash{Symbol=>Object}, nil) —

    Additional data associated with the feed item.

  • inserted_at (String) —

    Timestamp when the resource was created.

  • source (Knockapi::Models::Users::FeedListItemsResponse::Source) —

    Source information for the feed item.

  • tenant (String, nil) —

    Tenant ID that the feed item belongs to.

  • total_activities (Integer) —

    Total number of activities related to this feed item.

  • total_actors (Integer) —

    Total number of actors related to this feed item.

  • updated_at (String) —

    The timestamp when the resource was last updated.

  • archived_at (String, nil) (defaults to: nil) —

    Timestamp when the feed item was archived.

  • clicked_at (String, nil) (defaults to: nil) —

    Timestamp when the feed item was clicked.

  • interacted_at (String, nil) (defaults to: nil) —

    Timestamp when the feed item was interacted with.

  • link_clicked_at (String, nil) (defaults to: nil) —

    Timestamp when a link within the feed item was clicked.

  • read_at (String, nil) (defaults to: nil) —

    Timestamp when the feed item was marked as read.

  • seen_at (String, nil) (defaults to: nil) —

    Timestamp when the feed item was marked as seen.




# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 117

Instance Attribute Details

#_typename ⇒ String

The typename of the schema.

Returns:

  • (String) 


18
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 18

required :_typename, String, api_name: :__typename

#activities ⇒ Array<Knockapi::Models::Activity>

List of activities associated with this feed item.

Returns:



24
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 24

required :activities, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Activity] }

#actors ⇒ Array<Knockapi::Models::User, Knockapi::Models::Object>

List of actors associated with this feed item.

Returns:



30
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 30

required :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipient] }

#archived_at ⇒ String?

Timestamp when the feed item was archived.

Returns:

  • (String, nil) 


85
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 85

optional :archived_at, String, nil?: true

#blocks ⇒ Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock>

Content blocks that make up the feed item.

Returns:



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

required :blocks,
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::Users::FeedListItemsResponse::Block] }

#clicked_at ⇒ String?

Timestamp when the feed item was clicked.

Returns:

  • (String, nil) 


91
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 91

optional :clicked_at, String, nil?: true

#data ⇒ Hash{Symbol=>Object}?

Additional data associated with the feed item.

Returns:



43
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 43

required :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true

#id ⇒ String

Unique identifier for the feed.

Returns:

  • (String) 


12
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 12

required :id, String

#inserted_at ⇒ String

Timestamp when the resource was created.

Returns:

  • (String) 


49
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 49

required :inserted_at, String

#interacted_at ⇒ String?

Timestamp when the feed item was interacted with.

Returns:

  • (String, nil) 


97
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 97

optional :interacted_at, String, nil?: true

#link_clicked_at ⇒ String?

Timestamp when a link within the feed item was clicked.

Returns:

  • (String, nil) 


103
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 103

optional :link_clicked_at, String, nil?: true

#read_at ⇒ String?

Timestamp when the feed item was marked as read.

Returns:

  • (String, nil) 


109
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 109

optional :read_at, String, nil?: true

#seen_at ⇒ String?

Timestamp when the feed item was marked as seen.

Returns:

  • (String, nil) 


115
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 115

optional :seen_at, String, nil?: true

#source ⇒ Knockapi::Models::Users::FeedListItemsResponse::Source

Source information for the feed item.

Returns:



55
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 55

required :source, -> { Knockapi::Models::Users::FeedListItemsResponse::Source }

#tenant ⇒ String?

Tenant ID that the feed item belongs to.

Returns:

  • (String, nil) 


61
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 61

required :tenant, String, nil?: true

#total_activities ⇒ Integer

Total number of activities related to this feed item.

Returns:

  • (Integer) 


67
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 67

required :total_activities, Integer

#total_actors ⇒ Integer

Total number of actors related to this feed item.

Returns:

  • (Integer) 


73
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 73

required :total_actors, Integer

#updated_at ⇒ String

The timestamp when the resource was last updated.

Returns:

  • (String) 


79
 
# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 79

required :updated_at, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 284

.variants ⇒ Array(Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock)

Returns:




# File 'lib/knockapi/models/users/feed_list_items_response.rb', line 289