knockapi 1.0.0 → 1.1.0

data/rbi/knockapi/models/user_list_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::UserListParams, Knockapi::Internal::AnyHash)
+        end
+
       # The cursor to fetch entries after.
       sig { returns(T.nilable(String)) }
       attr_reader :after
@@ -21,10 +26,18 @@ module Knockapi
       attr_writer :before
 
       # Associated resources to include in the response.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::UserListParams::Include::OrSymbol])) }
+      sig do
+        returns(
+          T.nilable(T::Array[Knockapi::UserListParams::Include::OrSymbol])
+        )
+      end
       attr_reader :include
 
-      sig { params(include: T::Array[Knockapi::Models::UserListParams::Include::OrSymbol]).void }
+      sig do
+        params(
+          include: T::Array[Knockapi::UserListParams::Include::OrSymbol]
+        ).void
+      end
       attr_writer :include
 
       # The number of items per page.
@@ -38,11 +51,10 @@ module Knockapi
         params(
           after: String,
           before: String,
-          include: T::Array[Knockapi::Models::UserListParams::Include::OrSymbol],
+          include: T::Array[Knockapi::UserListParams::Include::OrSymbol],
           page_size: Integer,
-          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 cursor to fetch entries after.
@@ -54,31 +66,40 @@ module Knockapi
         # The number of items per page.
         page_size: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              after: String,
-              before: String,
-              include: T::Array[Knockapi::Models::UserListParams::Include::OrSymbol],
-              page_size: Integer,
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            after: String,
+            before: String,
+            include: T::Array[Knockapi::UserListParams::Include::OrSymbol],
+            page_size: Integer,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       module Include
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::UserListParams::Include) }
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Knockapi::UserListParams::Include) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PREFERENCES = T.let(:preferences, Knockapi::Models::UserListParams::Include::TaggedSymbol)
+        PREFERENCES =
+          T.let(:preferences, Knockapi::UserListParams::Include::TaggedSymbol)
 
-        sig { override.returns(T::Array[Knockapi::Models::UserListParams::Include::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[Knockapi::UserListParams::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
     end
   end

data/rbi/knockapi/models/user_list_preferences_params.rbi

@@ -6,14 +6,25 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::UserListPreferencesParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/user_list_preferences_response.rbi

@@ -4,7 +4,7 @@ module Knockapi
   module Models
     UserListPreferencesResponse =
       T.let(
-        Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Recipients::PreferenceSet],
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::PreferenceSet],
         Knockapi::Internal::Type::Converter
       )
   end

data/rbi/knockapi/models/user_list_schedules_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::UserListSchedulesParams, Knockapi::Internal::AnyHash)
+        end
+
       # The cursor to fetch entries after.
       sig { returns(T.nilable(String)) }
       attr_reader :after
@@ -48,9 +53,8 @@ module Knockapi
           page_size: Integer,
           tenant: String,
           workflow: 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 cursor to fetch entries after.
@@ -64,21 +68,23 @@ module Knockapi
         # The workflow key to filter schedules for.
         workflow: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              after: String,
-              before: String,
-              page_size: Integer,
-              tenant: String,
-              workflow: String,
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            after: String,
+            before: String,
+            page_size: Integer,
+            tenant: String,
+            workflow: String,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/user_list_subscriptions_params.rbi

@@ -6,6 +6,14 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::UserListSubscriptionsParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       # The cursor to fetch entries after.
       sig { returns(T.nilable(String)) }
       attr_reader :after
@@ -21,10 +29,21 @@ module Knockapi
       attr_writer :before
 
       # Associated resources to include in the response.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::UserListSubscriptionsParams::Include::OrSymbol])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Knockapi::UserListSubscriptionsParams::Include::OrSymbol]
+          )
+        )
+      end
       attr_reader :include
 
-      sig { params(include: T::Array[Knockapi::Models::UserListSubscriptionsParams::Include::OrSymbol]).void }
+      sig do
+        params(
+          include:
+            T::Array[Knockapi::UserListSubscriptionsParams::Include::OrSymbol]
+        ).void
+      end
       attr_writer :include
 
       # Only returns subscriptions for the specified object GIDs.
@@ -45,12 +64,12 @@ module Knockapi
         params(
           after: String,
           before: String,
-          include: T::Array[Knockapi::Models::UserListSubscriptionsParams::Include::OrSymbol],
+          include:
+            T::Array[Knockapi::UserListSubscriptionsParams::Include::OrSymbol],
           objects: T::Array[String],
           page_size: Integer,
-          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 cursor to fetch entries after.
@@ -64,32 +83,51 @@ module Knockapi
         # The number of items per page.
         page_size: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              after: String,
-              before: String,
-              include: T::Array[Knockapi::Models::UserListSubscriptionsParams::Include::OrSymbol],
-              objects: T::Array[String],
-              page_size: Integer,
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            after: String,
+            before: String,
+            include:
+              T::Array[
+                Knockapi::UserListSubscriptionsParams::Include::OrSymbol
+              ],
+            objects: T::Array[String],
+            page_size: Integer,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       module Include
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::UserListSubscriptionsParams::Include) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Knockapi::UserListSubscriptionsParams::Include)
+          end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PREFERENCES = T.let(:preferences, Knockapi::Models::UserListSubscriptionsParams::Include::TaggedSymbol)
+        PREFERENCES =
+          T.let(
+            :preferences,
+            Knockapi::UserListSubscriptionsParams::Include::TaggedSymbol
+          )
 
-        sig { override.returns(T::Array[Knockapi::Models::UserListSubscriptionsParams::Include::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[
+              Knockapi::UserListSubscriptionsParams::Include::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
       end
     end
   end

data/rbi/knockapi/models/user_merge_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::UserMergeParams, Knockapi::Internal::AnyHash)
+        end
+
       # The user ID to merge from.
       sig { returns(String) }
       attr_accessor :from_user_id
@@ -13,17 +18,23 @@ module Knockapi
       sig do
         params(
           from_user_id: 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 user ID to merge from.
         from_user_id:,
         request_options: {}
-      ); end
-      sig { override.returns({from_user_id: String, request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      )
+      end
+
+      sig do
+        override.returns(
+          { from_user_id: String, request_options: Knockapi::RequestOptions }
+        )
+      end
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/user_set_channel_data_params.rbi

@@ -6,14 +6,22 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserSetChannelDataParams, Knockapi::Internal::AnyHash)
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/user_set_preferences_params.rbi

@@ -6,14 +6,22 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserSetPreferencesParams, Knockapi::Internal::AnyHash)
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/user_unset_channel_data_params.rbi

@@ -6,14 +6,25 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::UserUnsetChannelDataParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/user_unset_channel_data_response.rbi

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

data/rbi/knockapi/models/user_update_params.rbi

@@ -6,14 +6,22 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserUpdateParams, Knockapi::Internal::AnyHash)
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/users/bulk_delete_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::BulkDeleteParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # A list of user IDs.
         sig { returns(T::Array[String]) }
         attr_accessor :user_ids
@@ -14,17 +22,26 @@ module Knockapi
         sig do
           params(
             user_ids: T::Array[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(
           # A list of user IDs.
           user_ids:,
           request_options: {}
-        ); end
-        sig { override.returns({user_ids: T::Array[String], request_options: Knockapi::RequestOptions}) }
-        def to_hash; end
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              user_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
       end
     end
   end

data/rbi/knockapi/models/users/bulk_identify_params.rbi

@@ -7,29 +7,41 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::BulkIdentifyParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # A list of users.
-        sig { returns(T::Array[Knockapi::Models::InlineIdentifyUserRequest]) }
+        sig { returns(T::Array[Knockapi::InlineIdentifyUserRequest]) }
         attr_accessor :users
 
         sig do
           params(
-            users: T::Array[T.any(Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Internal::AnyHash)],
-            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            users: T::Array[Knockapi::InlineIdentifyUserRequest::OrHash],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # A list of users.
           users:,
           request_options: {}
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {users: T::Array[Knockapi::Models::InlineIdentifyUserRequest], request_options: Knockapi::RequestOptions}
-            )
+          override.returns(
+            {
+              users: T::Array[Knockapi::InlineIdentifyUserRequest],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
     end
   end

data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi

@@ -7,15 +7,22 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::BulkSetPreferencesParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # A request to set a preference set for a recipient.
-        sig { returns(Knockapi::Models::Recipients::PreferenceSetRequest) }
+        sig { returns(Knockapi::Recipients::PreferenceSetRequest) }
         attr_reader :preferences
 
         sig do
           params(
-            preferences: T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)
-          )
-            .void
+            preferences: Knockapi::Recipients::PreferenceSetRequest::OrHash
+          ).void
         end
         attr_writer :preferences
 
@@ -25,11 +32,10 @@ module Knockapi
 
         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: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # A request to set a preference set for a recipient.
@@ -37,18 +43,20 @@ module Knockapi
           # A list of user IDs.
           user_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                preferences: Knockapi::Models::Recipients::PreferenceSetRequest,
-                user_ids: T::Array[String],
-                request_options: Knockapi::RequestOptions
-              }
-            )
+          override.returns(
+            {
+              preferences: Knockapi::Recipients::PreferenceSetRequest,
+              user_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
     end
   end