knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models/audience_add_members_params.rbi

@@ -6,40 +6,56 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::AudienceAddMembersParams, Knockapi::Internal::AnyHash)
+        end
+
       # A list of audience members to add.
-      sig { returns(T::Array[Knockapi::Models::AudienceAddMembersParams::Member]) }
+      sig { returns(T::Array[Knockapi::AudienceAddMembersParams::Member]) }
       attr_accessor :members
 
       sig do
         params(
-          members: T::Array[T.any(Knockapi::Models::AudienceAddMembersParams::Member, Knockapi::Internal::AnyHash)],
-          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          members: T::Array[Knockapi::AudienceAddMembersParams::Member::OrHash],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # A list of audience members to add.
         members:,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              members: T::Array[Knockapi::Models::AudienceAddMembersParams::Member],
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            members: T::Array[Knockapi::AudienceAddMembersParams::Member],
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       class Member < Knockapi::Internal::Type::BaseModel
-        sig { returns(Knockapi::Models::AudienceAddMembersParams::Member::User) }
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::AudienceAddMembersParams::Member,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # An object containing the user's ID.
+        sig { returns(Knockapi::AudienceAddMembersParams::Member::User) }
         attr_reader :user
 
         sig do
-          params(user: T.any(Knockapi::Models::AudienceAddMembersParams::Member::User, Knockapi::Internal::AnyHash))
-            .void
+          params(
+            user: Knockapi::AudienceAddMembersParams::Member::User::OrHash
+          ).void
         end
         attr_writer :user
 
@@ -50,23 +66,38 @@ module Knockapi
         # An audience member.
         sig do
           params(
-            user: T.any(Knockapi::Models::AudienceAddMembersParams::Member::User, Knockapi::Internal::AnyHash),
+            user: Knockapi::AudienceAddMembersParams::Member::User::OrHash,
             tenant: T.nilable(String)
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
+          # An object containing the user's ID.
           user:,
           # The unique identifier for the tenant.
           tenant: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns({user: Knockapi::Models::AudienceAddMembersParams::Member::User, tenant: T.nilable(String)})
+          override.returns(
+            {
+              user: Knockapi::AudienceAddMembersParams::Member::User,
+              tenant: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class User < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::AudienceAddMembersParams::Member::User,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
           # The ID for the user that you set when identifying them in Knock.
           sig { returns(T.nilable(String)) }
           attr_reader :id
@@ -74,13 +105,17 @@ module Knockapi
           sig { params(id: String).void }
           attr_writer :id
 
+          # An object containing the user's ID.
           sig { params(id: String).returns(T.attached_class) }
           def self.new(
             # The ID for the user that you set when identifying them in Knock.
             id: nil
-          ); end
-          sig { override.returns({id: String}) }
-          def to_hash; end
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
         end
       end
     end

data/rbi/knockapi/models/audience_add_members_response.rbi

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

data/rbi/knockapi/models/audience_list_members_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::AudienceListMembersParams,
+            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/audience_list_members_response.rbi

@@ -3,36 +3,50 @@
 module Knockapi
   module Models
     class AudienceListMembersResponse < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::Models::AudienceListMembersResponse,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       # A list of audience members.
-      sig { returns(T::Array[Knockapi::Models::AudienceMember]) }
+      sig { returns(T::Array[Knockapi::AudienceMember]) }
       attr_accessor :entries
 
       # Pagination information for a list of resources.
-      sig { returns(Knockapi::Models::PageInfo) }
+      sig { returns(Knockapi::PageInfo) }
       attr_reader :page_info
 
-      sig { params(page_info: T.any(Knockapi::Models::PageInfo, Knockapi::Internal::AnyHash)).void }
+      sig { params(page_info: Knockapi::PageInfo::OrHash).void }
       attr_writer :page_info
 
       # A paginated list of audience members.
       sig do
         params(
-          entries: T::Array[T.any(Knockapi::Models::AudienceMember, Knockapi::Internal::AnyHash)],
-          page_info: T.any(Knockapi::Models::PageInfo, Knockapi::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          entries: T::Array[Knockapi::AudienceMember::OrHash],
+          page_info: Knockapi::PageInfo::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # A list of audience members.
         entries:,
         # Pagination information for a list of resources.
         page_info:
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns({entries: T::Array[Knockapi::Models::AudienceMember], page_info: Knockapi::Models::PageInfo})
+        override.returns(
+          {
+            entries: T::Array[Knockapi::AudienceMember],
+            page_info: Knockapi::PageInfo
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/audience_member.rbi

@@ -3,6 +3,11 @@
 module Knockapi
   module Models
     class AudienceMember < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::AudienceMember, Knockapi::Internal::AnyHash)
+        end
+
       # The typename of the schema.
       sig { returns(String) }
       attr_accessor :_typename
@@ -14,10 +19,10 @@ module Knockapi
       # A [User](/concepts/users) represents an individual in your system who can
       # receive notifications through Knock. Users are the most common recipients of
       # notifications and are always referenced by your internal identifier.
-      sig { returns(Knockapi::Models::User) }
+      sig { returns(Knockapi::User) }
       attr_reader :user
 
-      sig { params(user: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash)).void }
+      sig { params(user: Knockapi::User::OrHash).void }
       attr_writer :user
 
       # The ID for the user that you set when identifying them in Knock.
@@ -33,11 +38,10 @@ module Knockapi
         params(
           _typename: String,
           added_at: Time,
-          user: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash),
+          user: Knockapi::User::OrHash,
           user_id: String,
           tenant: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # The typename of the schema.
@@ -52,14 +56,22 @@ module Knockapi
         user_id:,
         # The unique identifier for the tenant.
         tenant: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {_typename: String, added_at: Time, user: Knockapi::Models::User, user_id: String, tenant: T.nilable(String)}
-          )
+        override.returns(
+          {
+            _typename: String,
+            added_at: Time,
+            user: Knockapi::User,
+            user_id: String,
+            tenant: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/audience_remove_members_params.rbi

@@ -6,42 +6,60 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::AudienceRemoveMembersParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       # A list of audience members to remove.
-      sig { returns(T::Array[Knockapi::Models::AudienceRemoveMembersParams::Member]) }
+      sig { returns(T::Array[Knockapi::AudienceRemoveMembersParams::Member]) }
       attr_accessor :members
 
       sig do
         params(
-          members: T::Array[T.any(Knockapi::Models::AudienceRemoveMembersParams::Member, Knockapi::Internal::AnyHash)],
-          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          members:
+            T::Array[Knockapi::AudienceRemoveMembersParams::Member::OrHash],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # A list of audience members to remove.
         members:,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              members: T::Array[Knockapi::Models::AudienceRemoveMembersParams::Member],
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            members: T::Array[Knockapi::AudienceRemoveMembersParams::Member],
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       class Member < Knockapi::Internal::Type::BaseModel
-        sig { returns(Knockapi::Models::AudienceRemoveMembersParams::Member::User) }
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::AudienceRemoveMembersParams::Member,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # An object containing the user's ID.
+        sig { returns(Knockapi::AudienceRemoveMembersParams::Member::User) }
         attr_reader :user
 
         sig do
           params(
-            user: T.any(Knockapi::Models::AudienceRemoveMembersParams::Member::User, Knockapi::Internal::AnyHash)
-          )
-            .void
+            user: Knockapi::AudienceRemoveMembersParams::Member::User::OrHash
+          ).void
         end
         attr_writer :user
 
@@ -52,23 +70,38 @@ module Knockapi
         # An audience member.
         sig do
           params(
-            user: T.any(Knockapi::Models::AudienceRemoveMembersParams::Member::User, Knockapi::Internal::AnyHash),
+            user: Knockapi::AudienceRemoveMembersParams::Member::User::OrHash,
             tenant: T.nilable(String)
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
+          # An object containing the user's ID.
           user:,
           # The unique identifier for the tenant.
           tenant: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns({user: Knockapi::Models::AudienceRemoveMembersParams::Member::User, tenant: T.nilable(String)})
+          override.returns(
+            {
+              user: Knockapi::AudienceRemoveMembersParams::Member::User,
+              tenant: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class User < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::AudienceRemoveMembersParams::Member::User,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
           # The ID for the user that you set when identifying them in Knock.
           sig { returns(T.nilable(String)) }
           attr_reader :id
@@ -76,13 +109,17 @@ module Knockapi
           sig { params(id: String).void }
           attr_writer :id
 
+          # An object containing the user's ID.
           sig { params(id: String).returns(T.attached_class) }
           def self.new(
             # The ID for the user that you set when identifying them in Knock.
             id: nil
-          ); end
-          sig { override.returns({id: String}) }
-          def to_hash; end
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
         end
       end
     end

data/rbi/knockapi/models/audience_remove_members_response.rbi

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

data/rbi/knockapi/models/bulk_operation.rbi

@@ -3,6 +3,11 @@
 module Knockapi
   module Models
     class BulkOperation < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::BulkOperation, Knockapi::Internal::AnyHash)
+        end
+
       # Unique identifier for the bulk operation.
       sig { returns(String) }
       attr_accessor :id
@@ -28,7 +33,7 @@ module Knockapi
       attr_accessor :processed_rows
 
       # The status of the bulk operation.
-      sig { returns(Knockapi::Models::BulkOperation::Status::TaggedSymbol) }
+      sig { returns(Knockapi::BulkOperation::Status::TaggedSymbol) }
       attr_accessor :status
 
       # The number of successful operations.
@@ -51,14 +56,13 @@ module Knockapi
       attr_writer :error_count
 
       # A list of items that failed to be processed.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::BulkOperation::ErrorItem])) }
+      sig { returns(T.nilable(T::Array[Knockapi::BulkOperation::ErrorItem])) }
       attr_reader :error_items
 
       sig do
         params(
-          error_items: T::Array[T.any(Knockapi::Models::BulkOperation::ErrorItem, Knockapi::Internal::AnyHash)]
-        )
-          .void
+          error_items: T::Array[Knockapi::BulkOperation::ErrorItem::OrHash]
+        ).void
       end
       attr_writer :error_items
 
@@ -86,17 +90,16 @@ module Knockapi
           inserted_at: Time,
           name: String,
           processed_rows: Integer,
-          status: Knockapi::Models::BulkOperation::Status::OrSymbol,
+          status: Knockapi::BulkOperation::Status::OrSymbol,
           success_count: Integer,
           updated_at: Time,
           completed_at: T.nilable(Time),
           error_count: Integer,
-          error_items: T::Array[T.any(Knockapi::Models::BulkOperation::ErrorItem, Knockapi::Internal::AnyHash)],
+          error_items: T::Array[Knockapi::BulkOperation::ErrorItem::OrHash],
           failed_at: T.nilable(Time),
           progress_path: String,
           started_at: T.nilable(Time)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # Unique identifier for the bulk operation.
@@ -129,48 +132,66 @@ module Knockapi
         progress_path: nil,
         # Timestamp when the bulk operation was started.
         started_at: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              _typename: String,
-              estimated_total_rows: Integer,
-              inserted_at: Time,
-              name: String,
-              processed_rows: Integer,
-              status: Knockapi::Models::BulkOperation::Status::TaggedSymbol,
-              success_count: Integer,
-              updated_at: Time,
-              completed_at: T.nilable(Time),
-              error_count: Integer,
-              error_items: T::Array[Knockapi::Models::BulkOperation::ErrorItem],
-              failed_at: T.nilable(Time),
-              progress_path: String,
-              started_at: T.nilable(Time)
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            _typename: String,
+            estimated_total_rows: Integer,
+            inserted_at: Time,
+            name: String,
+            processed_rows: Integer,
+            status: Knockapi::BulkOperation::Status::TaggedSymbol,
+            success_count: Integer,
+            updated_at: Time,
+            completed_at: T.nilable(Time),
+            error_count: Integer,
+            error_items: T::Array[Knockapi::BulkOperation::ErrorItem],
+            failed_at: T.nilable(Time),
+            progress_path: String,
+            started_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       # The status of the bulk operation.
       module Status
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::BulkOperation::Status) }
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Knockapi::BulkOperation::Status) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        QUEUED = T.let(:queued, Knockapi::Models::BulkOperation::Status::TaggedSymbol)
-        PROCESSING = T.let(:processing, Knockapi::Models::BulkOperation::Status::TaggedSymbol)
-        COMPLETED = T.let(:completed, Knockapi::Models::BulkOperation::Status::TaggedSymbol)
-        FAILED = T.let(:failed, Knockapi::Models::BulkOperation::Status::TaggedSymbol)
+        QUEUED = T.let(:queued, Knockapi::BulkOperation::Status::TaggedSymbol)
+        PROCESSING =
+          T.let(:processing, Knockapi::BulkOperation::Status::TaggedSymbol)
+        COMPLETED =
+          T.let(:completed, Knockapi::BulkOperation::Status::TaggedSymbol)
+        FAILED = T.let(:failed, Knockapi::BulkOperation::Status::TaggedSymbol)
 
-        sig { override.returns(T::Array[Knockapi::Models::BulkOperation::Status::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[Knockapi::BulkOperation::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
 
       class ErrorItem < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::BulkOperation::ErrorItem,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # Unique identifier for the object.
         sig { returns(String) }
         attr_accessor :id
@@ -179,15 +200,22 @@ module Knockapi
         sig { returns(T.nilable(String)) }
         attr_accessor :collection
 
-        sig { params(id: String, collection: T.nilable(String)).returns(T.attached_class) }
+        sig do
+          params(id: String, collection: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
         def self.new(
           # Unique identifier for the object.
           id:,
           # The collection this object belongs to.
           collection: nil
-        ); end
-        sig { override.returns({id: String, collection: T.nilable(String)}) }
-        def to_hash; end
+        )
+        end
+
+        sig { override.returns({ id: String, collection: T.nilable(String) }) }
+        def to_hash
+        end
       end
     end
   end

data/rbi/knockapi/models/bulk_operation_get_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::BulkOperationGetParams, 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