knockapi 0.6.1 → 1.1.0

data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      class BatchMarkAsInteractedParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Messages::BatchMarkAsInteractedParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The message IDs to batch mark as interacted with.
+        sig { returns(T::Array[String]) }
+        attr_accessor :message_ids
+
+        # Metadata about the interaction.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metadata
+
+        sig do
+          params(
+            message_ids: T::Array[String],
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The message IDs to batch mark as interacted with.
+          message_ids:,
+          # Metadata about the interaction.
+          metadata: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              message_ids: T::Array[String],
+              metadata: T.nilable(T::Hash[Symbol, T.anything]),
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      BatchMarkAsInteractedResponse =
+        T.let(
+          Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+          Knockapi::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      class BatchMarkAsReadParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Messages::BatchMarkAsReadParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The message IDs to update the status of.
+        sig { returns(T::Array[String]) }
+        attr_accessor :message_ids
+
+        sig do
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The message IDs to update the status of.
+          message_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              message_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      BatchMarkAsReadResponse =
+        T.let(
+          Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+          Knockapi::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      class BatchMarkAsSeenParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Messages::BatchMarkAsSeenParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The message IDs to update the status of.
+        sig { returns(T::Array[String]) }
+        attr_accessor :message_ids
+
+        sig do
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The message IDs to update the status of.
+          message_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              message_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      BatchMarkAsSeenResponse =
+        T.let(
+          Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+          Knockapi::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      class BatchMarkAsUnreadParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Messages::BatchMarkAsUnreadParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The message IDs to update the status of.
+        sig { returns(T::Array[String]) }
+        attr_accessor :message_ids
+
+        sig do
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The message IDs to update the status of.
+          message_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              message_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      BatchMarkAsUnreadResponse =
+        T.let(
+          Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+          Knockapi::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      class BatchMarkAsUnseenParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Messages::BatchMarkAsUnseenParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The message IDs to update the status of.
+        sig { returns(T::Array[String]) }
+        attr_accessor :message_ids
+
+        sig do
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The message IDs to update the status of.
+          message_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              message_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      BatchMarkAsUnseenResponse =
+        T.let(
+          Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+          Knockapi::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_unarchive_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      class BatchUnarchiveParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Messages::BatchUnarchiveParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The message IDs to update the status of.
+        sig { returns(T::Array[String]) }
+        attr_accessor :message_ids
+
+        sig do
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The message IDs to update the status of.
+          message_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              message_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_unarchive_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      BatchUnarchiveResponse =
+        T.let(
+          Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+          Knockapi::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/knockapi/models/object.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class Object < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::Object, Knockapi::Internal::AnyHash) }
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The typename of the schema.
+      sig { returns(String) }
+      attr_accessor :_typename
+
+      # The collection this object belongs to.
+      sig { returns(String) }
+      attr_accessor :collection
+
+      # The timestamp when the resource was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Timestamp when the resource was created.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at
+
+      # The custom properties associated with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :properties
+
+      sig { params(properties: T::Hash[Symbol, T.anything]).void }
+      attr_writer :properties
+
+      # A custom [Object](/concepts/objects) entity which belongs to a collection.
+      sig do
+        params(
+          id: String,
+          _typename: String,
+          collection: String,
+          updated_at: Time,
+          created_at: T.nilable(Time),
+          properties: T::Hash[Symbol, T.anything]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        # The typename of the schema.
+        _typename:,
+        # The collection this object belongs to.
+        collection:,
+        # The timestamp when the resource was last updated.
+        updated_at:,
+        # Timestamp when the resource was created.
+        created_at: nil,
+        # The custom properties associated with the object.
+        properties: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            _typename: String,
+            collection: String,
+            updated_at: Time,
+            created_at: T.nilable(Time),
+            properties: T::Hash[Symbol, T.anything]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/object_add_subscriptions_params.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectAddSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::ObjectAddSubscriptionsParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
+      # The recipients of the subscription. You can subscribe up to 100 recipients to an
+      # object at a time.
+      sig do
+        returns(
+          T::Array[
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
+          ]
+        )
+      end
+      attr_accessor :recipients
+
+      # The custom properties associated with the subscription relationship.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :properties
+
+      sig do
+        params(
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ],
+          properties: T.nilable(T::Hash[Symbol, T.anything]),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The recipients of the subscription. You can subscribe up to 100 recipients to an
+        # object at a time.
+        recipients:,
+        # The custom properties associated with the subscription relationship.
+        properties: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipients:
+              T::Array[
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::InlineObjectRequest
+                )
+              ],
+            properties: T.nilable(T::Hash[Symbol, T.anything]),
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/object_add_subscriptions_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    ObjectAddSubscriptionsResponse =
+      T.let(
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::Subscription],
+        Knockapi::Internal::Type::Converter
+      )
+  end
+end

data/rbi/knockapi/models/object_delete_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectDeleteParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ObjectDeleteParams, Knockapi::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/object_delete_response.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    ObjectDeleteResponse = String
+  end
+end

data/rbi/knockapi/models/object_delete_subscriptions_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectDeleteSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::ObjectDeleteSubscriptionsParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
+      # The recipients of the subscription. You can subscribe up to 100 recipients to an
+      # object at a time.
+      sig do
+        returns(
+          T::Array[T.any(String, Knockapi::RecipientReference::ObjectReference)]
+        )
+      end
+      attr_accessor :recipients
+
+      sig do
+        params(
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The recipients of the subscription. You can subscribe up to 100 recipients to an
+        # object at a time.
+        recipients:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipients:
+              T::Array[
+                T.any(String, Knockapi::RecipientReference::ObjectReference)
+              ],
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/object_delete_subscriptions_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    ObjectDeleteSubscriptionsResponse =
+      T.let(
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::Subscription],
+        Knockapi::Internal::Type::Converter
+      )
+  end
+end