knockapi 0.6.1 → 1.0.0

data/sig/knockapi/models/user_update_params.rbs

@@ -0,0 +1,15 @@
+module Knockapi
+  module Models
+    type user_update_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserUpdateParams < Knockapi::Models::IdentifyUserRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Knockapi::request_opts) -> void
+
+      def to_hash: -> Knockapi::Models::user_update_params
+    end
+  end
+end

data/sig/knockapi/models/users/bulk_delete_params.rbs

@@ -0,0 +1,23 @@
+module Knockapi
+  module Models
+    module Users
+      type bulk_delete_params =
+        { user_ids: ::Array[String] }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkDeleteParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor user_ids: ::Array[String]
+
+        def initialize: (
+          user_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::bulk_delete_params
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/bulk_identify_params.rbs

@@ -0,0 +1,23 @@
+module Knockapi
+  module Models
+    module Users
+      type bulk_identify_params =
+        { users: ::Array[Knockapi::Models::InlineIdentifyUserRequest] }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkIdentifyParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor users: ::Array[Knockapi::Models::InlineIdentifyUserRequest]
+
+        def initialize: (
+          users: ::Array[Knockapi::Models::InlineIdentifyUserRequest],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::bulk_identify_params
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/bulk_set_preferences_params.rbs

@@ -0,0 +1,29 @@
+module Knockapi
+  module Models
+    module Users
+      type bulk_set_preferences_params =
+        {
+          preferences: Knockapi::Models::Recipients::PreferenceSetRequest,
+          user_ids: ::Array[String]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkSetPreferencesParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor preferences: Knockapi::Models::Recipients::PreferenceSetRequest
+
+        attr_accessor user_ids: ::Array[String]
+
+        def initialize: (
+          preferences: Knockapi::Models::Recipients::PreferenceSetRequest,
+          user_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::bulk_set_preferences_params
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/feed_get_settings_params.rbs

@@ -0,0 +1,17 @@
+module Knockapi
+  module Models
+    module Users
+      type feed_get_settings_params =
+        {  } & Knockapi::Internal::Type::request_parameters
+
+      class FeedGetSettingsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Knockapi::request_opts) -> void
+
+        def to_hash: -> Knockapi::Models::Users::feed_get_settings_params
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/feed_get_settings_response.rbs

@@ -0,0 +1,28 @@
+module Knockapi
+  module Models
+    module Users
+      type feed_get_settings_response =
+        { features: Knockapi::Models::Users::FeedGetSettingsResponse::Features }
+
+      class FeedGetSettingsResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor features: Knockapi::Models::Users::FeedGetSettingsResponse::Features
+
+        def initialize: (
+          features: Knockapi::Models::Users::FeedGetSettingsResponse::Features
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::feed_get_settings_response
+
+        type features = { branding_required: bool }
+
+        class Features < Knockapi::Internal::Type::BaseModel
+          attr_accessor branding_required: bool
+
+          def initialize: (branding_required: bool) -> void
+
+          def to_hash: -> Knockapi::Models::Users::FeedGetSettingsResponse::features
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/feed_list_items_params.rbs

@@ -0,0 +1,111 @@
+module Knockapi
+  module Models
+    module Users
+      type feed_list_items_params =
+        {
+          after: String,
+          archived: Knockapi::Models::Users::FeedListItemsParams::archived,
+          before: String,
+          has_tenant: bool,
+          page_size: Integer,
+          source: String,
+          status: Knockapi::Models::Users::FeedListItemsParams::status,
+          tenant: String,
+          trigger_data: String,
+          workflow_categories: ::Array[String]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class FeedListItemsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_reader after: String?
+
+        def after=: (String) -> String
+
+        attr_reader archived: Knockapi::Models::Users::FeedListItemsParams::archived?
+
+        def archived=: (
+          Knockapi::Models::Users::FeedListItemsParams::archived
+        ) -> Knockapi::Models::Users::FeedListItemsParams::archived
+
+        attr_reader before: String?
+
+        def before=: (String) -> String
+
+        attr_reader has_tenant: bool?
+
+        def has_tenant=: (bool) -> bool
+
+        attr_reader page_size: Integer?
+
+        def page_size=: (Integer) -> Integer
+
+        attr_reader source: String?
+
+        def source=: (String) -> String
+
+        attr_reader status: Knockapi::Models::Users::FeedListItemsParams::status?
+
+        def status=: (
+          Knockapi::Models::Users::FeedListItemsParams::status
+        ) -> Knockapi::Models::Users::FeedListItemsParams::status
+
+        attr_reader tenant: String?
+
+        def tenant=: (String) -> String
+
+        attr_reader trigger_data: String?
+
+        def trigger_data=: (String) -> String
+
+        attr_reader workflow_categories: ::Array[String]?
+
+        def workflow_categories=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          ?after: String,
+          ?archived: Knockapi::Models::Users::FeedListItemsParams::archived,
+          ?before: String,
+          ?has_tenant: bool,
+          ?page_size: Integer,
+          ?source: String,
+          ?status: Knockapi::Models::Users::FeedListItemsParams::status,
+          ?tenant: String,
+          ?trigger_data: String,
+          ?workflow_categories: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::feed_list_items_params
+
+        type archived = :exclude | :include | :only
+
+        module Archived
+          extend Knockapi::Internal::Type::Enum
+
+          EXCLUDE: :exclude
+          INCLUDE: :include
+          ONLY: :only
+
+          def self?.values: -> ::Array[Knockapi::Models::Users::FeedListItemsParams::archived]
+        end
+
+        type status = :unread | :read | :unseen | :seen | :all
+
+        module Status
+          extend Knockapi::Internal::Type::Enum
+
+          UNREAD: :unread
+          READ: :read
+          UNSEEN: :unseen
+          SEEN: :seen
+          ALL: :all
+
+          def self?.values: -> ::Array[Knockapi::Models::Users::FeedListItemsParams::status]
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/feed_list_items_response.rbs

@@ -0,0 +1,214 @@
+module Knockapi
+  module Models
+    module Users
+      type feed_list_items_response =
+        {
+          id: String,
+          _typename: String,
+          activities: ::Array[Knockapi::Models::Activity],
+          actors: ::Array[Knockapi::Models::recipient],
+          blocks: ::Array[Knockapi::Models::Users::FeedListItemsResponse::block],
+          data: ::Hash[Symbol, top]?,
+          inserted_at: String,
+          source: Knockapi::Models::Users::FeedListItemsResponse::Source,
+          tenant: String?,
+          total_activities: Integer,
+          total_actors: Integer,
+          updated_at: String,
+          archived_at: String?,
+          clicked_at: String?,
+          interacted_at: String?,
+          link_clicked_at: String?,
+          read_at: String?,
+          seen_at: String?
+        }
+
+      class FeedListItemsResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor _typename: String
+
+        attr_accessor activities: ::Array[Knockapi::Models::Activity]
+
+        attr_accessor actors: ::Array[Knockapi::Models::recipient]
+
+        attr_accessor blocks: ::Array[Knockapi::Models::Users::FeedListItemsResponse::block]
+
+        attr_accessor data: ::Hash[Symbol, top]?
+
+        attr_accessor inserted_at: String
+
+        attr_accessor source: Knockapi::Models::Users::FeedListItemsResponse::Source
+
+        attr_accessor tenant: String?
+
+        attr_accessor total_activities: Integer
+
+        attr_accessor total_actors: Integer
+
+        attr_accessor updated_at: String
+
+        attr_accessor archived_at: String?
+
+        attr_accessor clicked_at: String?
+
+        attr_accessor interacted_at: String?
+
+        attr_accessor link_clicked_at: String?
+
+        attr_accessor read_at: String?
+
+        attr_accessor seen_at: String?
+
+        def initialize: (
+          id: String,
+          _typename: String,
+          activities: ::Array[Knockapi::Models::Activity],
+          actors: ::Array[Knockapi::Models::recipient],
+          blocks: ::Array[Knockapi::Models::Users::FeedListItemsResponse::block],
+          data: ::Hash[Symbol, top]?,
+          inserted_at: String,
+          source: Knockapi::Models::Users::FeedListItemsResponse::Source,
+          tenant: String?,
+          total_activities: Integer,
+          total_actors: Integer,
+          updated_at: String,
+          ?archived_at: String?,
+          ?clicked_at: String?,
+          ?interacted_at: String?,
+          ?link_clicked_at: String?,
+          ?read_at: String?,
+          ?seen_at: String?
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::feed_list_items_response
+
+        type block =
+          Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock
+          | Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock
+
+        module Block
+          extend Knockapi::Internal::Type::Union
+
+          type message_in_app_feed_content_block =
+            {
+              content: String,
+              name: String,
+              rendered: String,
+              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_
+            }
+
+          class MessageInAppFeedContentBlock < Knockapi::Internal::Type::BaseModel
+            attr_accessor content: String
+
+            attr_accessor name: String
+
+            attr_accessor rendered: String
+
+            attr_accessor type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_
+
+            def initialize: (
+              content: String,
+              name: String,
+              rendered: String,
+              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_
+            ) -> void
+
+            def to_hash: -> Knockapi::Models::Users::FeedListItemsResponse::Block::message_in_app_feed_content_block
+
+            type type_ = :markdown | :text
+
+            module Type
+              extend Knockapi::Internal::Type::Enum
+
+              MARKDOWN: :markdown
+              TEXT: :text
+
+              def self?.values: -> ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_]
+            end
+          end
+
+          type message_in_app_feed_button_set_block =
+            {
+              buttons: ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button],
+              name: String,
+              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_
+            }
+
+          class MessageInAppFeedButtonSetBlock < Knockapi::Internal::Type::BaseModel
+            attr_accessor buttons: ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button]
+
+            attr_accessor name: String
+
+            attr_accessor type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_
+
+            def initialize: (
+              buttons: ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button],
+              name: String,
+              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_
+            ) -> void
+
+            def to_hash: -> Knockapi::Models::Users::FeedListItemsResponse::Block::message_in_app_feed_button_set_block
+
+            type button = { action: String, label: String, name: String }
+
+            class Button < Knockapi::Internal::Type::BaseModel
+              attr_accessor action: String
+
+              attr_accessor label: String
+
+              attr_accessor name: String
+
+              def initialize: (
+                action: String,
+                label: String,
+                name: String
+              ) -> void
+
+              def to_hash: -> Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::button
+            end
+
+            type type_ = :button_set
+
+            module Type
+              extend Knockapi::Internal::Type::Enum
+
+              BUTTON_SET: :button_set
+
+              def self?.values: -> ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_]
+            end
+          end
+
+          def self?.variants: -> [Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock]
+        end
+
+        type source =
+          {
+            _typename: String,
+            categories: ::Array[String],
+            key: String,
+            version_id: String
+          }
+
+        class Source < Knockapi::Internal::Type::BaseModel
+          attr_accessor _typename: String
+
+          attr_accessor categories: ::Array[String]
+
+          attr_accessor key: String
+
+          attr_accessor version_id: String
+
+          def initialize: (
+            _typename: String,
+            categories: ::Array[String],
+            key: String,
+            version_id: String
+          ) -> void
+
+          def to_hash: -> Knockapi::Models::Users::FeedListItemsResponse::source
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/guide_get_channel_params.rbs

@@ -0,0 +1,35 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_get_channel_params =
+        { data: String, tenant: String, type: String }
+        & Knockapi::Internal::Type::request_parameters
+
+      class GuideGetChannelParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_reader data: String?
+
+        def data=: (String) -> String
+
+        attr_reader tenant: String?
+
+        def tenant=: (String) -> String
+
+        attr_reader type: String?
+
+        def type=: (String) -> String
+
+        def initialize: (
+          ?data: String,
+          ?tenant: String,
+          ?type: String,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::guide_get_channel_params
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/guide_get_channel_response.rbs

@@ -0,0 +1,71 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_get_channel_response =
+        {
+          guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Guide],
+          recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
+        }
+
+      class GuideGetChannelResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Guide]
+
+        attr_accessor recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
+
+        def initialize: (
+          guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Guide],
+          ?recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::guide_get_channel_response
+
+        type guide =
+          {
+            id: String,
+            content: String,
+            metadata: ::Hash[Symbol, top],
+            title: String
+          }
+
+        class Guide < Knockapi::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          attr_reader content: String?
+
+          def content=: (String) -> String
+
+          attr_reader metadata: ::Hash[Symbol, top]?
+
+          def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          attr_reader title: String?
+
+          def title=: (String) -> String
+
+          def initialize: (
+            ?id: String,
+            ?content: String,
+            ?metadata: ::Hash[Symbol, top],
+            ?title: String
+          ) -> void
+
+          def to_hash: -> Knockapi::Models::Users::GuideGetChannelResponse::guide
+        end
+
+        type recipient = { id: String }
+
+        class Recipient < Knockapi::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          def initialize: (?id: String) -> void
+
+          def to_hash: -> Knockapi::Models::Users::GuideGetChannelResponse::recipient
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs

@@ -0,0 +1,65 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_mark_message_as_archived_params =
+        {
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          content: ::Hash[Symbol, top],
+          data: ::Hash[Symbol, top],
+          is_final: bool,
+          metadata: ::Hash[Symbol, top],
+          tenant: String?
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class GuideMarkMessageAsArchivedParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor channel_id: String
+
+        attr_accessor guide_id: String
+
+        attr_accessor guide_key: String
+
+        attr_accessor guide_step_ref: String
+
+        attr_reader content: ::Hash[Symbol, top]?
+
+        def content=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader data: ::Hash[Symbol, top]?
+
+        def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader is_final: bool?
+
+        def is_final=: (bool) -> bool
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_accessor tenant: String?
+
+        def initialize: (
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          ?content: ::Hash[Symbol, top],
+          ?data: ::Hash[Symbol, top],
+          ?is_final: bool,
+          ?metadata: ::Hash[Symbol, top],
+          ?tenant: String?,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Users::guide_mark_message_as_archived_params
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs

@@ -0,0 +1,15 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_mark_message_as_archived_response = { status: String }
+
+      class GuideMarkMessageAsArchivedResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor status: String
+
+        def initialize: (status: String) -> void
+
+        def to_hash: -> Knockapi::Models::Users::guide_mark_message_as_archived_response
+      end
+    end
+  end
+end