Class: Knockapi::Models::Activity

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::Activity

Defined in:

lib/knockapi/models/activity.rb

Overview

See Also:

• Resources::Messages#list_activities

Instance Attribute Summary

• #_typename ⇒ String^?

  The typename of the schema.

• #actor ⇒ Knockapi::Models::User, ...

  A recipient of a notification, which is either a user or an object.

• #data ⇒ Hash{Symbol=>Object}^?

  The workflow trigger ‘data` payload associated with the activity.

• #id ⇒ String^?

  Unique identifier for the activity.

• #inserted_at ⇒ Time^?

  Timestamp when the activity was created.

• #recipient ⇒ Knockapi::Models::User, ...

  A recipient of a notification, which is either a user or an object.

• #updated_at ⇒ Time^?

  Timestamp when the activity was last updated.

Instance Method Summary

• #initialize(id: nil, _typename: nil, actor: nil, data: nil, inserted_at: nil, recipient: nil, updated_at: nil) ⇒ Object constructor

  An activity associated with a workflow trigger request.

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: nil, _typename: nil, actor: nil, data: nil, inserted_at: nil, recipient: nil, updated_at: nil) ⇒ Object

An activity associated with a workflow trigger request. Messages produced after a [batch step](/designing-workflows/batch-function) can be associated with one or more activities. Non-batched messages will always be associated with a single activity.

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

Instance Attribute Details

#_typename ⇒ String^?

The typename of the schema.

# File 'lib/knockapi/models/activity.rb', line 17

optional :_typename, String, api_name: :__typename

#actor ⇒ Knockapi::Models::User, ...

A recipient of a notification, which is either a user or an object.

# File 'lib/knockapi/models/activity.rb', line 23

optional :actor, union: -> { Knockapi::Recipient }, nil?: true

#data ⇒ Hash{Symbol=>Object}^?

The workflow trigger ‘data` payload associated with the activity.

# File 'lib/knockapi/models/activity.rb', line 29

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

#id ⇒ String^?

Unique identifier for the activity.

# File 'lib/knockapi/models/activity.rb', line 11

optional :id, String

#inserted_at ⇒ Time^?

Timestamp when the activity was created.

# File 'lib/knockapi/models/activity.rb', line 35

optional :inserted_at, Time

#recipient ⇒ Knockapi::Models::User, ...

A recipient of a notification, which is either a user or an object.

# File 'lib/knockapi/models/activity.rb', line 41

optional :recipient, union: -> { Knockapi::Recipient }

#updated_at ⇒ Time^?

Timestamp when the activity was last updated.

# File 'lib/knockapi/models/activity.rb', line 47

optional :updated_at, Time