knockapi 0.6.1 → 1.0.0

data/lib/knockapi/models/users/feed_list_items_params.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Feeds#list_items
+      class FeedListItemsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute after
+        #   The cursor to fetch entries after.
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute archived
+        #   The archived status of the feed items.
+        #
+        #   @return [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived, nil]
+        optional :archived, enum: -> { Knockapi::Models::Users::FeedListItemsParams::Archived }
+
+        # @!attribute before
+        #   The cursor to fetch entries before.
+        #
+        #   @return [String, nil]
+        optional :before, String
+
+        # @!attribute has_tenant
+        #   Whether the feed items have a tenant.
+        #
+        #   @return [Boolean, nil]
+        optional :has_tenant, Knockapi::Internal::Type::Boolean
+
+        # @!attribute page_size
+        #   The number of items per page.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute source
+        #   The source of the feed items.
+        #
+        #   @return [String, nil]
+        optional :source, String
+
+        # @!attribute status
+        #   The status of the feed items.
+        #
+        #   @return [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status, nil]
+        optional :status, enum: -> { Knockapi::Models::Users::FeedListItemsParams::Status }
+
+        # @!attribute tenant
+        #   The tenant associated with the feed items.
+        #
+        #   @return [String, nil]
+        optional :tenant, String
+
+        # @!attribute trigger_data
+        #   The trigger data of the feed items (as a JSON string).
+        #
+        #   @return [String, nil]
+        optional :trigger_data, String
+
+        # @!attribute workflow_categories
+        #   The workflow categories of the feed items.
+        #
+        #   @return [Array<String>, nil]
+        optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(after: nil, archived: nil, before: nil, has_tenant: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
+        #   @param after [String] The cursor to fetch entries after.
+        #
+        #   @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.
+        #
+        #   @param before [String] The cursor to fetch entries before.
+        #
+        #   @param has_tenant [Boolean] Whether the feed items have a tenant.
+        #
+        #   @param page_size [Integer] The number of items per page.
+        #
+        #   @param source [String] The source of the feed items.
+        #
+        #   @param status [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status] The status of the feed items.
+        #
+        #   @param tenant [String] The tenant associated with the feed items.
+        #
+        #   @param trigger_data [String] The trigger data of the feed items (as a JSON string).
+        #
+        #   @param workflow_categories [Array<String>] The workflow categories of the feed items.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        # The archived status of the feed items.
+        module Archived
+          extend Knockapi::Internal::Type::Enum
+
+          EXCLUDE = :exclude
+          INCLUDE = :include
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the feed items.
+        module Status
+          extend Knockapi::Internal::Type::Enum
+
+          UNREAD = :unread
+          READ = :read
+          UNSEEN = :unseen
+          SEEN = :seen
+          ALL = :all
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/feed_list_items_response.rb

@@ -0,0 +1,333 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Feeds#list_items
+      class FeedListItemsResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the feed.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute _typename
+        #   The typename of the schema.
+        #
+        #   @return [String]
+        required :_typename, String, api_name: :__typename
+
+        # @!attribute activities
+        #   List of activities associated with this feed item.
+        #
+        #   @return [Array<Knockapi::Models::Activity>]
+        required :activities, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Activity] }
+
+        # @!attribute actors
+        #   List of actors associated with this feed item.
+        #
+        #   @return [Array<Knockapi::Models::User, Knockapi::Models::Object>]
+        required :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::Recipient] }
+
+        # @!attribute blocks
+        #   Content blocks that make up the feed item.
+        #
+        #   @return [Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock>]
+        required :blocks,
+                 -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::Users::FeedListItemsResponse::Block] }
+
+        # @!attribute data
+        #   Additional data associated with the feed item.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        required :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+        # @!attribute inserted_at
+        #   Timestamp when the resource was created.
+        #
+        #   @return [String]
+        required :inserted_at, String
+
+        # @!attribute source
+        #   Source information for the feed item.
+        #
+        #   @return [Knockapi::Models::Users::FeedListItemsResponse::Source]
+        required :source, -> { Knockapi::Models::Users::FeedListItemsResponse::Source }
+
+        # @!attribute tenant
+        #   Tenant ID that the feed item belongs to.
+        #
+        #   @return [String, nil]
+        required :tenant, String, nil?: true
+
+        # @!attribute total_activities
+        #   Total number of activities related to this feed item.
+        #
+        #   @return [Integer]
+        required :total_activities, Integer
+
+        # @!attribute total_actors
+        #   Total number of actors related to this feed item.
+        #
+        #   @return [Integer]
+        required :total_actors, Integer
+
+        # @!attribute updated_at
+        #   The timestamp when the resource was last updated.
+        #
+        #   @return [String]
+        required :updated_at, String
+
+        # @!attribute archived_at
+        #   Timestamp when the feed item was archived.
+        #
+        #   @return [String, nil]
+        optional :archived_at, String, nil?: true
+
+        # @!attribute clicked_at
+        #   Timestamp when the feed item was clicked.
+        #
+        #   @return [String, nil]
+        optional :clicked_at, String, nil?: true
+
+        # @!attribute interacted_at
+        #   Timestamp when the feed item was interacted with.
+        #
+        #   @return [String, nil]
+        optional :interacted_at, String, nil?: true
+
+        # @!attribute link_clicked_at
+        #   Timestamp when a link within the feed item was clicked.
+        #
+        #   @return [String, nil]
+        optional :link_clicked_at, String, nil?: true
+
+        # @!attribute read_at
+        #   Timestamp when the feed item was marked as read.
+        #
+        #   @return [String, nil]
+        optional :read_at, String, nil?: true
+
+        # @!attribute seen_at
+        #   Timestamp when the feed item was marked as seen.
+        #
+        #   @return [String, nil]
+        optional :seen_at, String, nil?: true
+
+        # @!method 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)
+        #   An in-app feed message in a user's feed.
+        #
+        #   @param id [String] Unique identifier for the feed.
+        #
+        #   @param _typename [String] The typename of the schema.
+        #
+        #   @param activities [Array<Knockapi::Models::Activity>] List of activities associated with this feed item.
+        #
+        #   @param actors [Array<Knockapi::Models::User, Knockapi::Models::Object>] List of actors associated with this feed item.
+        #
+        #   @param blocks [Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock>] Content blocks that make up the feed item.
+        #
+        #   @param data [Hash{Symbol=>Object}, nil] Additional data associated with the feed item.
+        #
+        #   @param inserted_at [String] Timestamp when the resource was created.
+        #
+        #   @param source [Knockapi::Models::Users::FeedListItemsResponse::Source] Source information for the feed item.
+        #
+        #   @param tenant [String, nil] Tenant ID that the feed item belongs to.
+        #
+        #   @param total_activities [Integer] Total number of activities related to this feed item.
+        #
+        #   @param total_actors [Integer] Total number of actors related to this feed item.
+        #
+        #   @param updated_at [String] The timestamp when the resource was last updated.
+        #
+        #   @param archived_at [String, nil] Timestamp when the feed item was archived.
+        #
+        #   @param clicked_at [String, nil] Timestamp when the feed item was clicked.
+        #
+        #   @param interacted_at [String, nil] Timestamp when the feed item was interacted with.
+        #
+        #   @param link_clicked_at [String, nil] Timestamp when a link within the feed item was clicked.
+        #
+        #   @param read_at [String, nil] Timestamp when the feed item was marked as read.
+        #
+        #   @param seen_at [String, nil] Timestamp when the feed item was marked as seen.
+
+        # A content block for the feed, can be content or a button set.
+        module Block
+          extend Knockapi::Internal::Type::Union
+
+          # A block in a message in an app feed.
+          variant -> { Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock }
+
+          # A button set block in a message in an app feed.
+          variant -> { Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock }
+
+          class MessageInAppFeedContentBlock < Knockapi::Internal::Type::BaseModel
+            # @!attribute content
+            #   The content of the block in a message in an app feed.
+            #
+            #   @return [String]
+            required :content, String
+
+            # @!attribute name
+            #   The name of the block in a message in an app feed.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute rendered
+            #   The rendered HTML version of the content.
+            #
+            #   @return [String]
+            required :rendered, String
+
+            # @!attribute type
+            #   The type of block in a message in an app feed.
+            #
+            #   @return [Symbol, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type]
+            required :type,
+                     enum: -> { Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type }
+
+            # @!method initialize(content:, name:, rendered:, type:)
+            #   A block in a message in an app feed.
+            #
+            #   @param content [String] The content of the block in a message in an app feed.
+            #
+            #   @param name [String] The name of the block in a message in an app feed.
+            #
+            #   @param rendered [String] The rendered HTML version of the content.
+            #
+            #   @param type [Symbol, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type] The type of block in a message in an app feed.
+
+            # The type of block in a message in an app feed.
+            #
+            # @see Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock#type
+            module Type
+              extend Knockapi::Internal::Type::Enum
+
+              MARKDOWN = :markdown
+              TEXT = :text
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class MessageInAppFeedButtonSetBlock < Knockapi::Internal::Type::BaseModel
+            # @!attribute buttons
+            #   A list of buttons in an in app feed message.
+            #
+            #   @return [Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button>]
+            required :buttons,
+                     -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button] }
+
+            # @!attribute name
+            #   The name of the button set in a message in an app feed.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute type
+            #   The type of block in a message in an app feed.
+            #
+            #   @return [Symbol, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type]
+            required :type,
+                     enum: -> { Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type }
+
+            # @!method initialize(buttons:, name:, type:)
+            #   A button set block in a message in an app feed.
+            #
+            #   @param buttons [Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button>] A list of buttons in an in app feed message.
+            #
+            #   @param name [String] The name of the button set in a message in an app feed.
+            #
+            #   @param type [Symbol, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type] The type of block in a message in an app feed.
+
+            class Button < Knockapi::Internal::Type::BaseModel
+              # @!attribute action
+              #   The action to take when the button is clicked.
+              #
+              #   @return [String]
+              required :action, String
+
+              # @!attribute label
+              #   The label of the button.
+              #
+              #   @return [String]
+              required :label, String
+
+              # @!attribute name
+              #   The name of the button.
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!method initialize(action:, label:, name:)
+              #   A button in an in app feed message.
+              #
+              #   @param action [String] The action to take when the button is clicked.
+              #
+              #   @param label [String] The label of the button.
+              #
+              #   @param name [String] The name of the button.
+            end
+
+            # The type of block in a message in an app feed.
+            #
+            # @see Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock#type
+            module Type
+              extend Knockapi::Internal::Type::Enum
+
+              BUTTON_SET = :button_set
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock)]
+        end
+
+        # @see Knockapi::Models::Users::FeedListItemsResponse#source
+        class Source < Knockapi::Internal::Type::BaseModel
+          # @!attribute _typename
+          #   The typename of the schema.
+          #
+          #   @return [String]
+          required :_typename, String, api_name: :__typename
+
+          # @!attribute categories
+          #   Categories this workflow belongs to.
+          #
+          #   @return [Array<String>]
+          required :categories, Knockapi::Internal::Type::ArrayOf[String]
+
+          # @!attribute key
+          #   The key of the workflow.
+          #
+          #   @return [String]
+          required :key, String
+
+          # @!attribute version_id
+          #   The workflow version ID.
+          #
+          #   @return [String]
+          required :version_id, String
+
+          # @!method initialize(_typename:, categories:, key:, version_id:)
+          #   Source information for the feed item.
+          #
+          #   @param _typename [String] The typename of the schema.
+          #
+          #   @param categories [Array<String>] Categories this workflow belongs to.
+          #
+          #   @param key [String] The key of the workflow.
+          #
+          #   @param version_id [String] The workflow version ID.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/guide_get_channel_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Guides#get_channel
+      class GuideGetChannelParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute data
+        #   The data (JSON encoded object) to use for targeting and rendering guides.
+        #
+        #   @return [String, nil]
+        optional :data, String
+
+        # @!attribute tenant
+        #   The tenant ID to use for targeting and rendering guides.
+        #
+        #   @return [String, nil]
+        optional :tenant, String
+
+        # @!attribute type
+        #   The type of guides to filter by.
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!method initialize(data: nil, tenant: nil, type: nil, request_options: {})
+        #   @param data [String] The data (JSON encoded object) to use for targeting and rendering guides.
+        #
+        #   @param tenant [String] The tenant ID to use for targeting and rendering guides.
+        #
+        #   @param type [String] The type of guides to filter by.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/guide_get_channel_response.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Guides#get_channel
+      class GuideGetChannelResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute guides
+        #   A list of guides.
+        #
+        #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Guide>]
+        required :guides,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Guide] }
+
+        # @!attribute recipient
+        #   The recipient of the guide.
+        #
+        #   @return [Knockapi::Models::Users::GuideGetChannelResponse::Recipient, nil]
+        optional :recipient, -> { Knockapi::Models::Users::GuideGetChannelResponse::Recipient }, nil?: true
+
+        # @!method initialize(guides:, recipient: nil)
+        #   A response for a list of guides.
+        #
+        #   @param guides [Array<Knockapi::Models::Users::GuideGetChannelResponse::Guide>] A list of guides.
+        #
+        #   @param recipient [Knockapi::Models::Users::GuideGetChannelResponse::Recipient, nil] The recipient of the guide.
+
+        class Guide < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the guide.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute content
+          #   The content of the guide.
+          #
+          #   @return [String, nil]
+          optional :content, String
+
+          # @!attribute metadata
+          #   The metadata of the guide.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+          # @!attribute title
+          #   The title of the guide.
+          #
+          #   @return [String, nil]
+          optional :title, String
+
+          # @!method initialize(id: nil, content: nil, metadata: nil, title: nil)
+          #   @param id [String] The unique identifier for the guide.
+          #
+          #   @param content [String] The content of the guide.
+          #
+          #   @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
+          #
+          #   @param title [String] The title of the guide.
+        end
+
+        # @see Knockapi::Models::Users::GuideGetChannelResponse#recipient
+        class Recipient < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the recipient.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!method initialize(id: nil)
+          #   The recipient of the guide.
+          #
+          #   @param id [String] Unique identifier for the recipient.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/guide_mark_message_as_archived_params.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Guides#mark_message_as_archived
+      class GuideMarkMessageAsArchivedParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute channel_id
+        #   The unique identifier for the channel.
+        #
+        #   @return [String]
+        required :channel_id, String
+
+        # @!attribute guide_id
+        #   The unique identifier for the guide.
+        #
+        #   @return [String]
+        required :guide_id, String
+
+        # @!attribute guide_key
+        #   The key of the guide.
+        #
+        #   @return [String]
+        required :guide_key, String
+
+        # @!attribute guide_step_ref
+        #   The step reference of the guide.
+        #
+        #   @return [String]
+        required :guide_step_ref, String
+
+        # @!attribute content
+        #   The content of the guide.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :content, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!attribute data
+        #   The data of the guide.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!attribute is_final
+        #   Whether the guide is final.
+        #
+        #   @return [Boolean, nil]
+        optional :is_final, Knockapi::Internal::Type::Boolean
+
+        # @!attribute metadata
+        #   The metadata of the guide.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!attribute tenant
+        #   The tenant ID of the guide.
+        #
+        #   @return [String, nil]
+        optional :tenant, String, nil?: true
+
+        # @!method initialize(channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        #   @param channel_id [String] The unique identifier for the channel.
+        #
+        #   @param guide_id [String] The unique identifier for the guide.
+        #
+        #   @param guide_key [String] The key of the guide.
+        #
+        #   @param guide_step_ref [String] The step reference of the guide.
+        #
+        #   @param content [Hash{Symbol=>Object}] The content of the guide.
+        #
+        #   @param data [Hash{Symbol=>Object}] The data of the guide.
+        #
+        #   @param is_final [Boolean] Whether the guide is final.
+        #
+        #   @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
+        #
+        #   @param tenant [String, nil] The tenant ID of the guide.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/guide_mark_message_as_archived_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Guides#mark_message_as_archived
+      class GuideMarkMessageAsArchivedResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute status
+        #   The status of a guide's action.
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!method initialize(status:)
+        #   A response for a guide action.
+        #
+        #   @param status [String] The status of a guide's action.
+      end
+    end
+  end
+end