knockapi 0.6.1 → 1.1.0

data/sig/knockapi/models/message_get_content_response.rbs

@@ -0,0 +1,316 @@
+module Knockapi
+  module Models
+    type message_get_content_response =
+      {
+        _typename: String,
+        data: Knockapi::Models::MessageGetContentResponse::data,
+        inserted_at: Time,
+        message_id: String
+      }
+
+    class MessageGetContentResponse < Knockapi::Internal::Type::BaseModel
+      attr_accessor _typename: String
+
+      attr_accessor data: Knockapi::Models::MessageGetContentResponse::data
+
+      attr_accessor inserted_at: Time
+
+      attr_accessor message_id: String
+
+      def initialize: (
+        _typename: String,
+        data: Knockapi::Models::MessageGetContentResponse::data,
+        inserted_at: Time,
+        message_id: String
+      ) -> void
+
+      type data =
+        Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent
+        | Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent
+        | Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent
+        | Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent
+        | Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent
+
+      module Data
+        extend Knockapi::Internal::Type::Union
+
+        type message_email_content =
+          {
+            _typename: String,
+            from: String,
+            html_body: String,
+            subject_line: String,
+            text_body: String,
+            to: String,
+            bcc: String?,
+            cc: String?,
+            reply_to: String?
+          }
+
+        class MessageEmailContent < Knockapi::Internal::Type::BaseModel
+          attr_accessor _typename: String
+
+          attr_accessor from: String
+
+          attr_accessor html_body: String
+
+          attr_accessor subject_line: String
+
+          attr_accessor text_body: String
+
+          attr_accessor to: String
+
+          attr_accessor bcc: String?
+
+          attr_accessor cc: String?
+
+          attr_accessor reply_to: String?
+
+          def initialize: (
+            _typename: String,
+            from: String,
+            html_body: String,
+            subject_line: String,
+            text_body: String,
+            to: String,
+            ?bcc: String?,
+            ?cc: String?,
+            ?reply_to: String?
+          ) -> void
+        end
+
+        type message_sms_content =
+          { _typename: String, body: String, to: String }
+
+        class MessageSMSContent < Knockapi::Internal::Type::BaseModel
+          attr_accessor _typename: String
+
+          attr_accessor body: String
+
+          attr_accessor to: String
+
+          def initialize: (_typename: String, body: String, to: String) -> void
+        end
+
+        type message_push_content =
+          {
+            token: String,
+            _typename: String,
+            body: String,
+            title: String,
+            data: ::Hash[Symbol, top]?
+          }
+
+        class MessagePushContent < Knockapi::Internal::Type::BaseModel
+          attr_accessor token: String
+
+          attr_accessor _typename: String
+
+          attr_accessor body: String
+
+          attr_accessor title: String
+
+          attr_accessor data: ::Hash[Symbol, top]?
+
+          def initialize: (
+            token: String,
+            _typename: String,
+            body: String,
+            title: String,
+            ?data: ::Hash[Symbol, top]?
+          ) -> void
+        end
+
+        type message_chat_content =
+          {
+            _typename: String,
+            connection: ::Hash[Symbol, top],
+            template: Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template,
+            metadata: ::Hash[Symbol, top]?
+          }
+
+        class MessageChatContent < Knockapi::Internal::Type::BaseModel
+          attr_accessor _typename: String
+
+          attr_accessor connection: ::Hash[Symbol, top]
+
+          attr_accessor template: Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template
+
+          attr_accessor metadata: ::Hash[Symbol, top]?
+
+          def initialize: (
+            _typename: String,
+            connection: ::Hash[Symbol, top],
+            template: Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template,
+            ?metadata: ::Hash[Symbol, top]?
+          ) -> void
+
+          type template =
+            {
+              blocks: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block]?,
+              json_content: ::Hash[Symbol, top]?,
+              summary: String?
+            }
+
+          class Template < Knockapi::Internal::Type::BaseModel
+            attr_accessor blocks: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block]?
+
+            attr_accessor json_content: ::Hash[Symbol, top]?
+
+            attr_accessor summary: String?
+
+            def initialize: (
+              ?blocks: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block]?,
+              ?json_content: ::Hash[Symbol, top]?,
+              ?summary: String?
+            ) -> void
+
+            type block =
+              {
+                content: String,
+                name: String,
+                type: Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::type_
+              }
+
+            class Block < Knockapi::Internal::Type::BaseModel
+              attr_accessor content: String
+
+              attr_accessor name: String
+
+              attr_accessor type: Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::type_
+
+              def initialize: (
+                content: String,
+                name: String,
+                type: Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::type_
+              ) -> void
+
+              type type_ = :text | :markdown
+
+              module Type
+                extend Knockapi::Internal::Type::Enum
+
+                TEXT: :text
+                MARKDOWN: :markdown
+
+                def self?.values: -> ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::type_]
+              end
+            end
+          end
+        end
+
+        type message_in_app_feed_content =
+          {
+            _typename: String,
+            blocks: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::block]
+          }
+
+        class MessageInAppFeedContent < Knockapi::Internal::Type::BaseModel
+          attr_accessor _typename: String
+
+          attr_accessor blocks: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::block]
+
+          def initialize: (
+            _typename: String,
+            blocks: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::block]
+          ) -> void
+
+          type block =
+            Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock
+            | Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::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::MessageGetContentResponse::Data::MessageInAppFeedContent::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::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::type_
+
+              def initialize: (
+                content: String,
+                name: String,
+                rendered: String,
+                type: Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::type_
+              ) -> void
+
+              type type_ = :markdown | :text
+
+              module Type
+                extend Knockapi::Internal::Type::Enum
+
+                MARKDOWN: :markdown
+                TEXT: :text
+
+                def self?.values: -> ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::type_]
+              end
+            end
+
+            type message_in_app_feed_button_set_block =
+              {
+                buttons: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button],
+                name: String,
+                type: Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::type_
+              }
+
+            class MessageInAppFeedButtonSetBlock < Knockapi::Internal::Type::BaseModel
+              attr_accessor buttons: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button]
+
+              attr_accessor name: String
+
+              attr_accessor type: Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::type_
+
+              def initialize: (
+                buttons: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button],
+                name: String,
+                type: Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::type_
+              ) -> void
+
+              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
+              end
+
+              type type_ = :button_set
+
+              module Type
+                extend Knockapi::Internal::Type::Enum
+
+                BUTTON_SET: :button_set
+
+                def self?.values: -> ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::type_]
+              end
+            end
+
+            def self?.variants: -> ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::block]
+          end
+        end
+
+        def self?.variants: -> ::Array[Knockapi::Models::MessageGetContentResponse::data]
+      end
+    end
+  end
+end

data/sig/knockapi/models/message_get_params.rbs

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

data/sig/knockapi/models/message_list_activities_params.rbs

@@ -0,0 +1,41 @@
+module Knockapi
+  module Models
+    type message_list_activities_params =
+      {
+        after: String,
+        before: String,
+        page_size: Integer,
+        trigger_data: String
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class MessageListActivitiesParams < 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 before: String?
+
+      def before=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader trigger_data: String?
+
+      def trigger_data=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?trigger_data: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/message_list_delivery_logs_params.rbs

@@ -0,0 +1,31 @@
+module Knockapi
+  module Models
+    type message_list_delivery_logs_params =
+      { after: String, before: String, page_size: Integer }
+      & Knockapi::Internal::Type::request_parameters
+
+    class MessageListDeliveryLogsParams < 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 before: String?
+
+      def before=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/message_list_events_params.rbs

@@ -0,0 +1,31 @@
+module Knockapi
+  module Models
+    type message_list_events_params =
+      { after: String, before: String, page_size: Integer }
+      & Knockapi::Internal::Type::request_parameters
+
+    class MessageListEventsParams < 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 before: String?
+
+      def before=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/message_list_params.rbs

@@ -0,0 +1,172 @@
+module Knockapi
+  module Models
+    type message_list_params =
+      {
+        after: String,
+        before: String,
+        channel_id: String,
+        engagement_status: ::Array[Knockapi::MessageListParams::engagement_status],
+        inserted_at: Knockapi::MessageListParams::InsertedAt,
+        message_ids: ::Array[String],
+        page_size: Integer,
+        source: String,
+        status: ::Array[Knockapi::MessageListParams::status],
+        tenant: String,
+        trigger_data: String,
+        workflow_categories: ::Array[String],
+        workflow_recipient_run_id: String,
+        workflow_run_id: String
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class MessageListParams < 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 before: String?
+
+      def before=: (String) -> String
+
+      attr_reader channel_id: String?
+
+      def channel_id=: (String) -> String
+
+      attr_reader engagement_status: ::Array[Knockapi::MessageListParams::engagement_status]?
+
+      def engagement_status=: (
+        ::Array[Knockapi::MessageListParams::engagement_status]
+      ) -> ::Array[Knockapi::MessageListParams::engagement_status]
+
+      attr_reader inserted_at: Knockapi::MessageListParams::InsertedAt?
+
+      def inserted_at=: (
+        Knockapi::MessageListParams::InsertedAt
+      ) -> Knockapi::MessageListParams::InsertedAt
+
+      attr_reader message_ids: ::Array[String]?
+
+      def message_ids=: (::Array[String]) -> ::Array[String]
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader source: String?
+
+      def source=: (String) -> String
+
+      attr_reader status: ::Array[Knockapi::MessageListParams::status]?
+
+      def status=: (
+        ::Array[Knockapi::MessageListParams::status]
+      ) -> ::Array[Knockapi::MessageListParams::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]
+
+      attr_reader workflow_recipient_run_id: String?
+
+      def workflow_recipient_run_id=: (String) -> String
+
+      attr_reader workflow_run_id: String?
+
+      def workflow_run_id=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?channel_id: String,
+        ?engagement_status: ::Array[Knockapi::MessageListParams::engagement_status],
+        ?inserted_at: Knockapi::MessageListParams::InsertedAt,
+        ?message_ids: ::Array[String],
+        ?page_size: Integer,
+        ?source: String,
+        ?status: ::Array[Knockapi::MessageListParams::status],
+        ?tenant: String,
+        ?trigger_data: String,
+        ?workflow_categories: ::Array[String],
+        ?workflow_recipient_run_id: String,
+        ?workflow_run_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      type engagement_status =
+        :seen | :read | :interacted | :link_clicked | :archived
+
+      module EngagementStatus
+        extend Knockapi::Internal::Type::Enum
+
+        SEEN: :seen
+        READ: :read
+        INTERACTED: :interacted
+        LINK_CLICKED: :link_clicked
+        ARCHIVED: :archived
+
+        def self?.values: -> ::Array[Knockapi::MessageListParams::engagement_status]
+      end
+
+      type inserted_at = { gt: String, gte: String, lt: String, lte: String }
+
+      class InsertedAt < Knockapi::Internal::Type::BaseModel
+        attr_reader gt: String?
+
+        def gt=: (String) -> String
+
+        attr_reader gte: String?
+
+        def gte=: (String) -> String
+
+        attr_reader lt: String?
+
+        def lt=: (String) -> String
+
+        attr_reader lte: String?
+
+        def lte=: (String) -> String
+
+        def initialize: (
+          ?gt: String,
+          ?gte: String,
+          ?lt: String,
+          ?lte: String
+        ) -> void
+      end
+
+      type status =
+        :queued
+        | :sent
+        | :delivered
+        | :delivery_attempted
+        | :undelivered
+        | :not_sent
+        | :bounced
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED: :queued
+        SENT: :sent
+        DELIVERED: :delivered
+        DELIVERY_ATTEMPTED: :delivery_attempted
+        UNDELIVERED: :undelivered
+        NOT_SENT: :not_sent
+        BOUNCED: :bounced
+
+        def self?.values: -> ::Array[Knockapi::MessageListParams::status]
+      end
+    end
+  end
+end

data/sig/knockapi/models/message_mark_as_interacted_params.rbs

@@ -0,0 +1,21 @@
+module Knockapi
+  module Models
+    type message_mark_as_interacted_params =
+      { metadata: ::Hash[Symbol, top] }
+      & Knockapi::Internal::Type::request_parameters
+
+    class MessageMarkAsInteractedParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_reader metadata: ::Hash[Symbol, top]?
+
+      def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      def initialize: (
+        ?metadata: ::Hash[Symbol, top],
+        ?request_options: Knockapi::request_opts
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/message_mark_as_read_params.rbs

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

data/sig/knockapi/models/message_mark_as_seen_params.rbs

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

data/sig/knockapi/models/message_mark_as_unread_params.rbs

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

data/sig/knockapi/models/message_mark_as_unseen_params.rbs

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

data/sig/knockapi/models/message_unarchive_params.rbs

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