knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideMarkMessageAsArchivedParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # The unique identifier for the channel.
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # The unique identifier for the guide.
+        sig { returns(String) }
+        attr_accessor :guide_id
+
+        # The key of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_key
+
+        # The step reference of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_step_ref
+
+        # The content of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :content
+
+        sig { params(content: T::Hash[Symbol, T.anything]).void }
+        attr_writer :content
+
+        # The data of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :data
+
+        sig { params(data: T::Hash[Symbol, T.anything]).void }
+        attr_writer :data
+
+        # Whether the guide is final.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_final
+
+        sig { params(is_final: T::Boolean).void }
+        attr_writer :is_final
+
+        # The metadata of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+        attr_writer :metadata
+
+        # The tenant ID of the guide.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tenant
+
+        sig do
+          params(
+            channel_id: String,
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            content: T::Hash[Symbol, T.anything],
+            data: T::Hash[Symbol, T.anything],
+            is_final: T::Boolean,
+            metadata: T::Hash[Symbol, T.anything],
+            tenant: T.nilable(String),
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the channel.
+          channel_id:,
+          # The unique identifier for the guide.
+          guide_id:,
+          # The key of the guide.
+          guide_key:,
+          # The step reference of the guide.
+          guide_step_ref:,
+          # The content of the guide.
+          content: nil,
+          # The data of the guide.
+          data: nil,
+          # Whether the guide is final.
+          is_final: nil,
+          # The metadata of the guide.
+          metadata: nil,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                channel_id: String,
+                guide_id: String,
+                guide_key: String,
+                guide_step_ref: String,
+                content: T::Hash[Symbol, T.anything],
+                data: T::Hash[Symbol, T.anything],
+                is_final: T::Boolean,
+                metadata: T::Hash[Symbol, T.anything],
+                tenant: T.nilable(String),
+                request_options: Knockapi::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideMarkMessageAsArchivedResponse < Knockapi::Internal::Type::BaseModel
+        # The status of a guide's action.
+        sig { returns(String) }
+        attr_accessor :status
+
+        # A response for a guide action.
+        sig { params(status: String).returns(T.attached_class) }
+        def self.new(
+          # The status of a guide's action.
+          status:
+        ); end
+        sig { override.returns({status: String}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideMarkMessageAsInteractedParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # The unique identifier for the channel.
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # The unique identifier for the guide.
+        sig { returns(String) }
+        attr_accessor :guide_id
+
+        # The key of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_key
+
+        # The step reference of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_step_ref
+
+        # The content of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :content
+
+        sig { params(content: T::Hash[Symbol, T.anything]).void }
+        attr_writer :content
+
+        # The data of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :data
+
+        sig { params(data: T::Hash[Symbol, T.anything]).void }
+        attr_writer :data
+
+        # Whether the guide is final.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_final
+
+        sig { params(is_final: T::Boolean).void }
+        attr_writer :is_final
+
+        # The metadata of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+        attr_writer :metadata
+
+        # The tenant ID of the guide.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tenant
+
+        sig do
+          params(
+            channel_id: String,
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            content: T::Hash[Symbol, T.anything],
+            data: T::Hash[Symbol, T.anything],
+            is_final: T::Boolean,
+            metadata: T::Hash[Symbol, T.anything],
+            tenant: T.nilable(String),
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the channel.
+          channel_id:,
+          # The unique identifier for the guide.
+          guide_id:,
+          # The key of the guide.
+          guide_key:,
+          # The step reference of the guide.
+          guide_step_ref:,
+          # The content of the guide.
+          content: nil,
+          # The data of the guide.
+          data: nil,
+          # Whether the guide is final.
+          is_final: nil,
+          # The metadata of the guide.
+          metadata: nil,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                channel_id: String,
+                guide_id: String,
+                guide_key: String,
+                guide_step_ref: String,
+                content: T::Hash[Symbol, T.anything],
+                data: T::Hash[Symbol, T.anything],
+                is_final: T::Boolean,
+                metadata: T::Hash[Symbol, T.anything],
+                tenant: T.nilable(String),
+                request_options: Knockapi::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideMarkMessageAsInteractedResponse < Knockapi::Internal::Type::BaseModel
+        # The status of a guide's action.
+        sig { returns(String) }
+        attr_accessor :status
+
+        # A response for a guide action.
+        sig { params(status: String).returns(T.attached_class) }
+        def self.new(
+          # The status of a guide's action.
+          status:
+        ); end
+        sig { override.returns({status: String}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideMarkMessageAsSeenParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # The unique identifier for the channel.
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # The unique identifier for the guide.
+        sig { returns(String) }
+        attr_accessor :guide_id
+
+        # The key of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_key
+
+        # The step reference of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_step_ref
+
+        # The content of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :content
+
+        sig { params(content: T::Hash[Symbol, T.anything]).void }
+        attr_writer :content
+
+        # The data of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :data
+
+        sig { params(data: T::Hash[Symbol, T.anything]).void }
+        attr_writer :data
+
+        # Whether the guide is final.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_final
+
+        sig { params(is_final: T::Boolean).void }
+        attr_writer :is_final
+
+        # The metadata of the guide.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+        attr_writer :metadata
+
+        # The tenant ID of the guide.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tenant
+
+        sig do
+          params(
+            channel_id: String,
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            content: T::Hash[Symbol, T.anything],
+            data: T::Hash[Symbol, T.anything],
+            is_final: T::Boolean,
+            metadata: T::Hash[Symbol, T.anything],
+            tenant: T.nilable(String),
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the channel.
+          channel_id:,
+          # The unique identifier for the guide.
+          guide_id:,
+          # The key of the guide.
+          guide_key:,
+          # The step reference of the guide.
+          guide_step_ref:,
+          # The content of the guide.
+          content: nil,
+          # The data of the guide.
+          data: nil,
+          # Whether the guide is final.
+          is_final: nil,
+          # The metadata of the guide.
+          metadata: nil,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                channel_id: String,
+                guide_id: String,
+                guide_key: String,
+                guide_step_ref: String,
+                content: T::Hash[Symbol, T.anything],
+                data: T::Hash[Symbol, T.anything],
+                is_final: T::Boolean,
+                metadata: T::Hash[Symbol, T.anything],
+                tenant: T.nilable(String),
+                request_options: Knockapi::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideMarkMessageAsSeenResponse < Knockapi::Internal::Type::BaseModel
+        # The status of a guide's action.
+        sig { returns(String) }
+        attr_accessor :status
+
+        # A response for a guide action.
+        sig { params(status: String).returns(T.attached_class) }
+        def self.new(
+          # The status of a guide's action.
+          status:
+        ); end
+        sig { override.returns({status: String}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/workflow_cancel_params.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class WorkflowCancelParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # An optional key that is used to reference a specific workflow trigger request
+      # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+      # request. Must be provided while triggering a workflow in order to enable
+      # subsequent cancellation. Should be unique across trigger requests to avoid
+      # unintentional cancellations.
+      sig { returns(String) }
+      attr_accessor :cancellation_key
+
+      # A list of recipients to cancel the notification for. If omitted, cancels for all
+      # recipients associated with the cancellation key.
+      sig { returns(T.nilable(T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)])) }
+      attr_accessor :recipients
+
+      sig do
+        params(
+          cancellation_key: String,
+          recipients: T.nilable(
+            T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)]
+          ),
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # An optional key that is used to reference a specific workflow trigger request
+        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+        # request. Must be provided while triggering a workflow in order to enable
+        # subsequent cancellation. Should be unique across trigger requests to avoid
+        # unintentional cancellations.
+        cancellation_key:,
+        # A list of recipients to cancel the notification for. If omitted, cancels for all
+        # recipients associated with the cancellation key.
+        recipients: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              cancellation_key: String,
+              recipients: T.nilable(T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)]),
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/workflow_trigger_params.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # The recipients to trigger the workflow for. Can inline identify users, objects,
+      # or use a list of user IDs. Limited to 1,000 recipients.
+      sig do
+        returns(
+          T::Array[T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)]
+        )
+      end
+      attr_accessor :recipients
+
+      # Specifies a recipient in a request. This can either be a user identifier
+      # (string), an inline user request (object), or an inline object request, which is
+      # determined by the presence of a `collection` property.
+      sig do
+        returns(
+          T.nilable(
+            T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)
+          )
+        )
+      end
+      attr_accessor :actor
+
+      # An optional key that is used to reference a specific workflow trigger request
+      # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+      # request. Must be provided while triggering a workflow in order to enable
+      # subsequent cancellation. Should be unique across trigger requests to avoid
+      # unintentional cancellations.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cancellation_key
+
+      # An optional map of data to pass into the workflow execution.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :data
+
+      # An request to set a tenant inline.
+      sig { returns(T.nilable(T.any(String, Knockapi::Models::TenantRequest))) }
+      attr_accessor :tenant
+
+      sig do
+        params(
+          recipients: T::Array[
+            T.any(
+              String,
+              Knockapi::Models::InlineIdentifyUserRequest,
+              Knockapi::Internal::AnyHash,
+              Knockapi::Models::InlineObjectRequest
+            )
+          ],
+          actor: T.nilable(
+            T.any(
+              String,
+              Knockapi::Models::InlineIdentifyUserRequest,
+              Knockapi::Internal::AnyHash,
+              Knockapi::Models::InlineObjectRequest
+            )
+          ),
+          cancellation_key: T.nilable(String),
+          data: T.nilable(T::Hash[Symbol, T.anything]),
+          tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)),
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The recipients to trigger the workflow for. Can inline identify users, objects,
+        # or use a list of user IDs. Limited to 1,000 recipients.
+        recipients:,
+        # Specifies a recipient in a request. This can either be a user identifier
+        # (string), an inline user request (object), or an inline object request, which is
+        # determined by the presence of a `collection` property.
+        actor: nil,
+        # An optional key that is used to reference a specific workflow trigger request
+        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+        # request. Must be provided while triggering a workflow in order to enable
+        # subsequent cancellation. Should be unique across trigger requests to avoid
+        # unintentional cancellations.
+        cancellation_key: nil,
+        # An optional map of data to pass into the workflow execution.
+        data: nil,
+        # An request to set a tenant inline.
+        tenant: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              recipients: T::Array[T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)],
+              actor: T.nilable(
+                T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)
+              ),
+              cancellation_key: T.nilable(String),
+              data: T.nilable(T::Hash[Symbol, T.anything]),
+              tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest)),
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/workflow_trigger_response.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class WorkflowTriggerResponse < Knockapi::Internal::Type::BaseModel
+      # This value allows you to track individual messages associated with this trigger
+      # request.
+      sig { returns(String) }
+      attr_accessor :workflow_run_id
+
+      # The response from triggering a workflow.
+      sig { params(workflow_run_id: String).returns(T.attached_class) }
+      def self.new(
+        # This value allows you to track individual messages associated with this trigger
+        # request.
+        workflow_run_id:
+      ); end
+      sig { override.returns({workflow_run_id: String}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/request_options.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Knockapi
+  RequestOpts = T.type_alias { T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash) }
+
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Knockapi::Internal::Type::BaseModel
+    # @api private
+    sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void }
+    def self.validate!(opts); end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) }
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig { params(values: Knockapi::Internal::AnyHash).returns(T.attached_class) }
+    def self.new(values = {}); end
+  end
+end