knockapi 0.6.1 → 1.0.0

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

@@ -0,0 +1,65 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_mark_message_as_interacted_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 GuideMarkMessageAsInteractedParams < 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_interacted_params
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,65 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_mark_message_as_seen_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 GuideMarkMessageAsSeenParams < 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_seen_params
+      end
+    end
+  end
+end

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

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

data/sig/knockapi/models/workflow_cancel_params.rbs

@@ -0,0 +1,27 @@
+module Knockapi
+  module Models
+    type workflow_cancel_params =
+      {
+        cancellation_key: String,
+        recipients: ::Array[Knockapi::Models::recipient_reference]?
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class WorkflowCancelParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor cancellation_key: String
+
+      attr_accessor recipients: ::Array[Knockapi::Models::recipient_reference]?
+
+      def initialize: (
+        cancellation_key: String,
+        ?recipients: ::Array[Knockapi::Models::recipient_reference]?,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::workflow_cancel_params
+    end
+  end
+end

data/sig/knockapi/models/workflow_trigger_params.rbs

@@ -0,0 +1,39 @@
+module Knockapi
+  module Models
+    type workflow_trigger_params =
+      {
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        actor: Knockapi::Models::recipient_request?,
+        cancellation_key: String?,
+        data: ::Hash[Symbol, top]?,
+        tenant: Knockapi::Models::inline_tenant_request?
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor recipients: ::Array[Knockapi::Models::recipient_request]
+
+      attr_accessor actor: Knockapi::Models::recipient_request?
+
+      attr_accessor cancellation_key: String?
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_accessor tenant: Knockapi::Models::inline_tenant_request?
+
+      def initialize: (
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        ?actor: Knockapi::Models::recipient_request?,
+        ?cancellation_key: String?,
+        ?data: ::Hash[Symbol, top]?,
+        ?tenant: Knockapi::Models::inline_tenant_request?,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::workflow_trigger_params
+    end
+  end
+end

data/sig/knockapi/models/workflow_trigger_response.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Models
+    type workflow_trigger_response = { workflow_run_id: String }
+
+    class WorkflowTriggerResponse < Knockapi::Internal::Type::BaseModel
+      attr_accessor workflow_run_id: String
+
+      def initialize: (workflow_run_id: String) -> void
+
+      def to_hash: -> Knockapi::Models::workflow_trigger_response
+    end
+  end
+end

data/sig/knockapi/request_options.rbs

@@ -0,0 +1,34 @@
+module Knockapi
+  type request_opts =
+    Knockapi::RequestOptions | Knockapi::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < Knockapi::Internal::Type::BaseModel
+    def self.validate!: (self | ::Hash[Symbol, top] opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?Knockapi::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/knockapi/resources/audiences.rbs

@@ -0,0 +1,24 @@
+module Knockapi
+  module Resources
+    class Audiences
+      def add_members: (
+        String key,
+        members: ::Array[Knockapi::Models::AudienceAddMembersParams::Member],
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def list_members: (
+        String key,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::AudienceListMembersResponse
+
+      def remove_members: (
+        String key,
+        members: ::Array[Knockapi::Models::AudienceRemoveMembersParams::Member],
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/bulk_operations.rbs

@@ -0,0 +1,12 @@
+module Knockapi
+  module Resources
+    class BulkOperations
+      def get: (
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::BulkOperation
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/channels/bulk.rbs

@@ -0,0 +1,25 @@
+module Knockapi
+  module Resources
+    class Channels
+      class Bulk
+        def update_message_status: (
+          String channel_id,
+          Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action action,
+          ?archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
+          ?delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
+          ?engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,
+          ?has_tenant: bool,
+          ?newer_than: Time,
+          ?older_than: Time,
+          ?recipient_ids: ::Array[String],
+          ?tenants: ::Array[String],
+          ?trigger_data: String,
+          ?workflows: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::BulkOperation
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/channels.rbs

@@ -0,0 +1,9 @@
+module Knockapi
+  module Resources
+    class Channels
+      attr_reader bulk: Knockapi::Resources::Channels::Bulk
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/integrations/census.rbs

@@ -0,0 +1,17 @@
+module Knockapi
+  module Resources
+    class Integrations
+      class Census
+        def custom_destination: (
+          id: String,
+          jsonrpc: String,
+          method_: String,
+          ?params: ::Hash[Symbol, top],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Integrations::CensusCustomDestinationResponse
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/integrations/hightouch.rbs

@@ -0,0 +1,17 @@
+module Knockapi
+  module Resources
+    class Integrations
+      class Hightouch
+        def embedded_destination: (
+          id: String,
+          jsonrpc: String,
+          method_: String,
+          ?params: ::Hash[Symbol, top],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Integrations::HightouchEmbeddedDestinationResponse
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/integrations.rbs

@@ -0,0 +1,11 @@
+module Knockapi
+  module Resources
+    class Integrations
+      attr_reader census: Knockapi::Resources::Integrations::Census
+
+      attr_reader hightouch: Knockapi::Resources::Integrations::Hightouch
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/messages/activities.rbs

@@ -0,0 +1,18 @@
+module Knockapi
+  module Resources
+    class Messages
+      class Activities
+        def list: (
+          String message_id,
+          ?after: String,
+          ?before: String,
+          ?page_size: Integer,
+          ?trigger_data: String,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Internal::ItemsCursor[Knockapi::Models::Activity]
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/messages/batch.rbs

@@ -0,0 +1,50 @@
+module Knockapi
+  module Resources
+    class Messages
+      class Batch
+        def archive: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_archive_response
+
+        def get_content: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_get_content_response
+
+        def mark_as_interacted: (
+          message_ids: ::Array[String],
+          ?metadata: ::Hash[Symbol, top]?,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_interacted_response
+
+        def mark_as_read: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_read_response
+
+        def mark_as_seen: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_seen_response
+
+        def mark_as_unread: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_unread_response
+
+        def mark_as_unseen: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_unseen_response
+
+        def unarchive: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_unarchive_response
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/messages.rbs

@@ -0,0 +1,100 @@
+module Knockapi
+  module Resources
+    class Messages
+      attr_reader batch: Knockapi::Resources::Messages::Batch
+
+      attr_reader activities: Knockapi::Resources::Messages::Activities
+
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?channel_id: String,
+        ?engagement_status: ::Array[Knockapi::Models::MessageListParams::engagement_status],
+        ?inserted_at: Knockapi::Models::MessageListParams::InsertedAt,
+        ?message_ids: ::Array[String],
+        ?page_size: Integer,
+        ?source: String,
+        ?status: ::Array[Knockapi::Models::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
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Models::Message]
+
+      def archive: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::Message
+
+      def get: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::Message
+
+      def get_content: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::MessageGetContentResponse
+
+      def list_activities: (
+        String message_id,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?trigger_data: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::ItemsCursor[Knockapi::Models::Activity]
+
+      def list_delivery_logs: (
+        String message_id,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Models::MessageDeliveryLog]
+
+      def list_events: (
+        String message_id,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Models::MessageEvent]
+
+      def mark_as_interacted: (
+        String message_id,
+        ?metadata: ::Hash[Symbol, top],
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::Message
+
+      def mark_as_read: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::Message
+
+      def mark_as_seen: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::Message
+
+      def mark_as_unread: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::Message
+
+      def mark_as_unseen: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::Message
+
+      def unarchive: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::Message
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/objects/bulk.rbs

@@ -0,0 +1,27 @@
+module Knockapi
+  module Resources
+    class Objects
+      class Bulk
+        def delete: (
+          String collection,
+          object_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::BulkOperation
+
+        def add_subscriptions: (
+          String collection,
+          subscriptions: ::Array[Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::BulkOperation
+
+        def set: (
+          String collection,
+          objects: ::Array[Knockapi::Models::InlineObjectRequest],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::BulkOperation
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end