knockapi 1.0.0 → 1.2.0

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

@@ -7,6 +7,14 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::GuideMarkMessageAsArchivedParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The unique identifier for the channel.
         sig { returns(String) }
         attr_accessor :channel_id
@@ -66,9 +74,8 @@ module Knockapi
             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)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the channel.
@@ -90,25 +97,27 @@ module Knockapi
           # The tenant ID of the guide.
           tenant: nil,
           request_options: {}
-        ); end
+        )
+        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
-              }
-            )
+          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
-        def to_hash; end
       end
     end
   end

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

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Users
       class GuideMarkMessageAsArchivedResponse < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The status of a guide's action.
         sig { returns(String) }
         attr_accessor :status
@@ -13,9 +21,12 @@ module Knockapi
         def self.new(
           # The status of a guide's action.
           status:
-        ); end
-        sig { override.returns({status: String}) }
-        def to_hash; end
+        )
+        end
+
+        sig { override.returns({ status: String }) }
+        def to_hash
+        end
       end
     end
   end

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

@@ -7,6 +7,14 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::GuideMarkMessageAsInteractedParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The unique identifier for the channel.
         sig { returns(String) }
         attr_accessor :channel_id
@@ -66,9 +74,8 @@ module Knockapi
             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)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the channel.
@@ -90,25 +97,27 @@ module Knockapi
           # The tenant ID of the guide.
           tenant: nil,
           request_options: {}
-        ); end
+        )
+        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
-              }
-            )
+          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
-        def to_hash; end
       end
     end
   end

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

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Users
       class GuideMarkMessageAsInteractedResponse < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The status of a guide's action.
         sig { returns(String) }
         attr_accessor :status
@@ -13,9 +21,12 @@ module Knockapi
         def self.new(
           # The status of a guide's action.
           status:
-        ); end
-        sig { override.returns({status: String}) }
-        def to_hash; end
+        )
+        end
+
+        sig { override.returns({ status: String }) }
+        def to_hash
+        end
       end
     end
   end

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

@@ -7,6 +7,14 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::GuideMarkMessageAsSeenParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The unique identifier for the channel.
         sig { returns(String) }
         attr_accessor :channel_id
@@ -66,9 +74,8 @@ module Knockapi
             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)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the channel.
@@ -90,25 +97,27 @@ module Knockapi
           # The tenant ID of the guide.
           tenant: nil,
           request_options: {}
-        ); end
+        )
+        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
-              }
-            )
+          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
-        def to_hash; end
       end
     end
   end

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

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Users
       class GuideMarkMessageAsSeenResponse < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Models::Users::GuideMarkMessageAsSeenResponse,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The status of a guide's action.
         sig { returns(String) }
         attr_accessor :status
@@ -13,9 +21,12 @@ module Knockapi
         def self.new(
           # The status of a guide's action.
           status:
-        ); end
-        sig { override.returns({status: String}) }
-        def to_hash; end
+        )
+        end
+
+        sig { override.returns({ status: String }) }
+        def to_hash
+        end
       end
     end
   end

data/rbi/knockapi/models/workflow_cancel_params.rbi

@@ -6,6 +6,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::WorkflowCancelParams, Knockapi::Internal::AnyHash)
+        end
+
       # 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
@@ -16,18 +21,31 @@ module Knockapi
 
       # 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)])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(String, Knockapi::RecipientReference::ObjectReference)
+            ]
+          )
+        )
+      end
       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)
+          recipients:
+            T.nilable(
+              T::Array[
+                T.any(
+                  String,
+                  Knockapi::RecipientReference::ObjectReference::OrHash
+                )
+              ]
+            ),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # An optional key that is used to reference a specific workflow trigger request
@@ -40,18 +58,25 @@ module Knockapi
         # recipients associated with the cancellation key.
         recipients: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              cancellation_key: String,
-              recipients: T.nilable(T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)]),
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            cancellation_key: String,
+            recipients:
+              T.nilable(
+                T::Array[
+                  T.any(String, Knockapi::RecipientReference::ObjectReference)
+                ]
+              ),
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/workflow_cancel_response.rbi

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

data/rbi/knockapi/models/workflow_trigger_params.rbi

@@ -6,11 +6,22 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::WorkflowTriggerParams, Knockapi::Internal::AnyHash)
+        end
+
       # 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)]
+          T::Array[
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
+          ]
         )
       end
       attr_accessor :recipients
@@ -21,7 +32,11 @@ module Knockapi
       sig do
         returns(
           T.nilable(
-            T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
           )
         )
       end
@@ -40,33 +55,32 @@ module Knockapi
       attr_accessor :data
 
       # An request to set a tenant inline.
-      sig { returns(T.nilable(T.any(String, Knockapi::Models::TenantRequest))) }
+      sig { returns(T.nilable(T.any(String, Knockapi::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
-            )
-          ),
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ],
+          actor:
+            T.nilable(
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ),
           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)
+          tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # The recipients to trigger the workflow for. Can inline identify users, objects,
@@ -87,23 +101,37 @@ module Knockapi
         # An request to set a tenant inline.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      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)
+        override.returns(
+          {
+            recipients:
+              T::Array[
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::InlineObjectRequest
+                )
+              ],
+            actor:
+              T.nilable(
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::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
-            }
-          )
+            cancellation_key: T.nilable(String),
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            tenant: T.nilable(T.any(String, Knockapi::TenantRequest)),
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/workflow_trigger_response.rbi

@@ -3,6 +3,14 @@
 module Knockapi
   module Models
     class WorkflowTriggerResponse < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::Models::WorkflowTriggerResponse,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       # This value allows you to track individual messages associated with this trigger
       # request.
       sig { returns(String) }
@@ -14,9 +22,12 @@ module Knockapi
         # 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
+
+      sig { override.returns({ workflow_run_id: String }) }
+      def to_hash
+      end
     end
   end
 end