knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/resources/recipients/preferences.rbi

@@ -6,7 +6,8 @@ module Knockapi
       class Preferences
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/recipients/subscriptions.rbi

@@ -6,7 +6,8 @@ module Knockapi
       class Subscriptions
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/recipients.rbi

@@ -14,7 +14,8 @@ module Knockapi
 
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/schedules/bulk.rbi

@@ -9,19 +9,22 @@ module Knockapi
         # for the `actor`, `recipient`, and `tenant` fields.
         sig do
           params(
-            schedules: T::Array[T.any(Knockapi::Models::Schedules::BulkCreateParams::Schedule, Knockapi::Internal::AnyHash)],
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(Knockapi::Models::BulkOperation)
+            schedules:
+              T::Array[Knockapi::Schedules::BulkCreateParams::Schedule::OrHash],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
         end
         def create(
           # A list of schedules.
           schedules:,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/schedules.rbi

@@ -13,27 +13,25 @@ module Knockapi
       # for the `actor`, `recipient`, and `tenant` fields.
       sig do
         params(
-          recipients: T::Array[
-            T.any(
-              String,
-              Knockapi::Models::InlineIdentifyUserRequest,
-              Knockapi::Internal::AnyHash,
-              Knockapi::Models::InlineObjectRequest
-            )
-          ],
-          repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)],
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ],
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           workflow: String,
           data: T.nilable(T::Hash[Symbol, T.anything]),
           ending_at: T.nilable(Time),
           scheduled_at: T.nilable(Time),
-          tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)),
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(T::Array[Knockapi::Models::Schedule])
+          tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T::Array[Knockapi::Schedule])
       end
       def create(
-        # The recipients to trigger the workflow for. Can inline identify users, objects,
-        # or use a list of user IDs. Limited to 1,000 recipients.
+        # The recipients to set the schedule for. Limited to 100 recipients per request.
         recipients:,
         # The repeat rule for the schedule.
         repeats:,
@@ -48,7 +46,9 @@ module Knockapi
         # An request to set a tenant inline.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Updates one or more existing schedules with new timing, data, or other
       # properties. All specified schedule IDs will be updated with the same values.
       # This endpoint also handles
@@ -57,17 +57,20 @@ module Knockapi
       sig do
         params(
           schedule_ids: T::Array[String],
-          actor: T.nilable(
-            T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)
-          ),
+          actor:
+            T.nilable(
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ),
           data: T.nilable(T::Hash[Symbol, T.anything]),
           ending_at: T.nilable(Time),
-          repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)],
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           scheduled_at: T.nilable(Time),
-          tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)),
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(T::Array[Knockapi::Models::Schedule])
+          tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T::Array[Knockapi::Schedule])
       end
       def update(
         # A list of schedule IDs.
@@ -86,7 +89,9 @@ module Knockapi
         # An request to set a tenant inline.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Returns a paginated list of schedules for the current environment, filtered by
       # workflow and optionally by recipients and tenant.
       sig do
@@ -97,9 +102,8 @@ module Knockapi
           page_size: Integer,
           recipients: T::Array[String],
           tenant: String,
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Schedule])
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Internal::EntriesCursor[Knockapi::Schedule])
       end
       def list(
         # Filter by workflow key.
@@ -115,21 +119,28 @@ module Knockapi
         # Filter by tenant ID.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Permanently deletes one or more schedules identified by the provided schedule
       # IDs. This operation cannot be undone.
       sig do
-        params(schedule_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-          .returns(T::Array[Knockapi::Models::Schedule])
+        params(
+          schedule_ids: T::Array[String],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T::Array[Knockapi::Schedule])
       end
       def delete(
         # A list of schedule IDs.
         schedule_ids:,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/shared.rbi

@@ -5,7 +5,8 @@ module Knockapi
     class Shared
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/tenants/bulk.rbi

@@ -6,30 +6,36 @@ module Knockapi
       class Bulk
         # Delete multiple tenants in a single operation. This operation cannot be undone.
         sig do
-          params(tenant_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(Knockapi::Models::BulkOperation)
+          params(
+            tenant_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
         end
         def delete(
           # The IDs of the tenants to delete.
           tenant_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Set or update up to 1,000 tenants in a single operation.
         sig do
           params(
-            tenants: T::Array[T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)],
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(Knockapi::Models::BulkOperation)
+            tenants: T::Array[T.any(String, Knockapi::TenantRequest::OrHash)],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
         end
         def set(
           # The tenants to be upserted.
           tenants:,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/tenants.rbi

@@ -14,9 +14,8 @@ module Knockapi
           name: String,
           page_size: Integer,
           tenant_id: String,
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Tenant])
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Internal::EntriesCursor[Knockapi::Tenant])
       end
       def list(
         # The cursor to fetch entries after.
@@ -30,36 +29,65 @@ module Knockapi
         # Filter tenants by ID.
         tenant_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Delete a tenant and all associated data. This operation cannot be undone.
-      sig { params(id: String, request_options: Knockapi::RequestOpts).returns(String) }
+      sig do
+        params(
+          id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(String)
+      end
       def delete(
         # The unique identifier for the tenant.
         id,
         request_options: {}
-      ); end
+      )
+      end
+
       # Get a tenant by ID.
-      sig { params(id: String, request_options: Knockapi::RequestOpts).returns(Knockapi::Models::Tenant) }
+      sig do
+        params(
+          id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Tenant)
+      end
       def get(
         # The unique identifier for the tenant.
         id,
         request_options: {}
-      ); end
+      )
+      end
+
       # Sets a tenant within an environment, performing an upsert operation. Any
       # existing properties will be merged with the incoming properties.
       sig do
         params(
           id: String,
-          channel_data: T.nilable(
-            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)]
-          ),
-          preferences: T.nilable(
-            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
-          ),
-          settings: T.any(Knockapi::Models::TenantSetParams::Settings, Knockapi::Internal::AnyHash),
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Models::Tenant)
+          channel_data:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  Knockapi::Recipients::PushChannelData::OrHash,
+                  Knockapi::Recipients::OneSignalChannelData::OrHash,
+                  Knockapi::Recipients::SlackChannelData::OrHash,
+                  Knockapi::Recipients::MsTeamsChannelData::OrHash,
+                  Knockapi::Recipients::DiscordChannelData::OrHash
+                )
+              ]
+            ),
+          preferences:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::OrHash
+              ]
+            ),
+          settings: Knockapi::TenantSetParams::Settings::OrHash,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Tenant)
       end
       def set(
         # The unique identifier for the tenant.
@@ -71,10 +99,13 @@ module Knockapi
         # The settings for the tenant. Includes branding and preference set.
         settings: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/users/bulk.rbi

@@ -7,39 +7,43 @@ module Knockapi
         # Deletes multiple users in a single operation. Accepts up to 100 user IDs to
         # delete and returns a bulk operation that can be queried for progress.
         sig do
-          params(user_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(Knockapi::Models::BulkOperation)
+          params(
+            user_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
         end
         def delete(
           # A list of user IDs.
           user_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Identifies multiple users in a single operation. Allows creating or updating up
         # to 100 users in a single batch with various properties, preferences, and channel
         # data.
         sig do
           params(
-            users: T::Array[T.any(Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Internal::AnyHash)],
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(Knockapi::Models::BulkOperation)
+            users: T::Array[Knockapi::InlineIdentifyUserRequest::OrHash],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
         end
         def identify(
           # A list of users.
           users:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Sets preferences for multiple users in a single operation. Supports either
         # setting the same preferences for multiple users or specific preferences for each
         # user.
         sig do
           params(
-            preferences: T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash),
+            preferences: Knockapi::Recipients::PreferenceSetRequest::OrHash,
             user_ids: T::Array[String],
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(Knockapi::Models::BulkOperation)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
         end
         def set_preferences(
           # A request to set a preference set for a recipient.
@@ -47,10 +51,13 @@ module Knockapi
           # A list of user IDs.
           user_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/users/feeds.rbi

@@ -6,8 +6,11 @@ module Knockapi
       class Feeds
         # Returns the feed settings for a user.
         sig do
-          params(user_id: String, id: String, request_options: Knockapi::RequestOpts)
-            .returns(Knockapi::Models::Users::FeedGetSettingsResponse)
+          params(
+            user_id: String,
+            id: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::Models::Users::FeedGetSettingsResponse)
         end
         def get_settings(
           # The ID for the user that you set when identifying them in Knock.
@@ -15,7 +18,9 @@ module Knockapi
           # The unique identifier for the channel.
           id,
           request_options: {}
-        ); end
+        )
+        end
+
         # Returns a paginated list of feed items for a user, including metadata about the
         # feed.
         sig do
@@ -23,18 +28,21 @@ module Knockapi
             user_id: String,
             id: String,
             after: String,
-            archived: Knockapi::Models::Users::FeedListItemsParams::Archived::OrSymbol,
+            archived: Knockapi::Users::FeedListItemsParams::Archived::OrSymbol,
             before: String,
             has_tenant: T::Boolean,
             page_size: Integer,
             source: String,
-            status: Knockapi::Models::Users::FeedListItemsParams::Status::OrSymbol,
+            status: Knockapi::Users::FeedListItemsParams::Status::OrSymbol,
             tenant: String,
             trigger_data: String,
             workflow_categories: T::Array[String],
-            request_options: Knockapi::RequestOpts
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(
+            Knockapi::Internal::EntriesCursor[
+              Knockapi::Models::Users::FeedListItemsResponse
+            ]
           )
-            .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Users::FeedListItemsResponse])
         end
         def list_items(
           # The ID for the user that you set when identifying them in Knock.
@@ -62,10 +70,13 @@ module Knockapi
           # The workflow categories of the feed items.
           workflow_categories: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/users/guides.rbi

@@ -12,9 +12,8 @@ module Knockapi
             data: String,
             tenant: String,
             type: String,
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(Knockapi::Models::Users::GuideGetChannelResponse)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::Models::Users::GuideGetChannelResponse)
         end
         def get_channel(
           # The ID for the user that you set when identifying them in Knock.
@@ -28,7 +27,9 @@ module Knockapi
           # The type of guides to filter by.
           type: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Records that a guide has been archived by a user, triggering any associated
         # archived events.
         sig do
@@ -44,9 +45,8 @@ module Knockapi
             is_final: T::Boolean,
             metadata: T::Hash[Symbol, T.anything],
             tenant: T.nilable(String),
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse)
         end
         def mark_message_as_archived(
           # The ID for the user that you set when identifying them in Knock.
@@ -72,7 +72,9 @@ module Knockapi
           # The tenant ID of the guide.
           tenant: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Records that a user has interacted with a guide, triggering any associated
         # interacted events.
         sig do
@@ -88,9 +90,10 @@ module Knockapi
             is_final: T::Boolean,
             metadata: T::Hash[Symbol, T.anything],
             tenant: T.nilable(String),
-            request_options: Knockapi::RequestOpts
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(
+            Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse
           )
-            .returns(Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse)
         end
         def mark_message_as_interacted(
           # The ID for the user that you set when identifying them in Knock.
@@ -116,7 +119,9 @@ module Knockapi
           # The tenant ID of the guide.
           tenant: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Records that a guide has been seen by a user, triggering any associated seen
         # events.
         sig do
@@ -132,9 +137,8 @@ module Knockapi
             is_final: T::Boolean,
             metadata: T::Hash[Symbol, T.anything],
             tenant: T.nilable(String),
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(Knockapi::Models::Users::GuideMarkMessageAsSeenResponse)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::Models::Users::GuideMarkMessageAsSeenResponse)
         end
         def mark_message_as_seen(
           # The ID for the user that you set when identifying them in Knock.
@@ -160,10 +164,13 @@ module Knockapi
           # The tenant ID of the guide.
           tenant: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end