knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models/tenants/bulk_set_params.rbi

@@ -7,29 +7,38 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(Knockapi::Tenants::BulkSetParams, Knockapi::Internal::AnyHash)
+          end
+
         # The tenants to be upserted.
-        sig { returns(T::Array[T.any(String, Knockapi::Models::TenantRequest)]) }
+        sig { returns(T::Array[T.any(String, Knockapi::TenantRequest)]) }
         attr_accessor :tenants
 
         sig do
           params(
-            tenants: T::Array[T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)],
-            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            tenants: T::Array[T.any(String, Knockapi::TenantRequest::OrHash)],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # The tenants to be upserted.
           tenants:,
           request_options: {}
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {tenants: T::Array[T.any(String, Knockapi::Models::TenantRequest)], request_options: Knockapi::RequestOptions}
-            )
+          override.returns(
+            {
+              tenants: T::Array[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/user.rbi

@@ -3,6 +3,9 @@
 module Knockapi
   module Models
     class User < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::User, Knockapi::Internal::AnyHash) }
+
       # The ID for the user that you set when identifying them in Knock.
       sig { returns(String) }
       attr_accessor :id
@@ -31,15 +34,15 @@ module Knockapi
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
-      # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
       # user (required for SMS channels).
       sig { returns(T.nilable(String)) }
       attr_accessor :phone_number
 
-      # The timezone of the user. Must be a valid
-      # [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
-      # Used for
-      # [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+      # The timezone of the user. Must be a
+      # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+      # Used
+      # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
       sig { returns(T.nilable(String)) }
       attr_accessor :timezone
 
@@ -57,8 +60,7 @@ module Knockapi
           name: T.nilable(String),
           phone_number: T.nilable(String),
           timezone: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # The ID for the user that you set when identifying them in Knock.
@@ -75,32 +77,34 @@ module Knockapi
         email: nil,
         # Display name of the user.
         name: nil,
-        # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+        # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
         # user (required for SMS channels).
         phone_number: nil,
-        # The timezone of the user. Must be a valid
-        # [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
-        # Used for
-        # [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+        # The timezone of the user. Must be a
+        # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+        # Used
+        # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
         timezone: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              _typename: String,
-              updated_at: Time,
-              avatar: T.nilable(String),
-              created_at: T.nilable(Time),
-              email: T.nilable(String),
-              name: T.nilable(String),
-              phone_number: T.nilable(String),
-              timezone: T.nilable(String)
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            _typename: String,
+            updated_at: Time,
+            avatar: T.nilable(String),
+            created_at: T.nilable(Time),
+            email: T.nilable(String),
+            name: T.nilable(String),
+            phone_number: T.nilable(String),
+            timezone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/user_delete_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::UserDeleteParams, 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_delete_response.rbi

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

data/rbi/knockapi/models/user_get_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::UserGetChannelDataParams, 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_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::UserGetParams, 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_get_preferences_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::UserGetPreferencesParams, Knockapi::Internal::AnyHash)
+        end
+
       # The unique identifier for the tenant.
       sig { returns(T.nilable(String)) }
       attr_reader :tenant
@@ -14,16 +19,25 @@ module Knockapi
       attr_writer :tenant
 
       sig do
-        params(tenant: String, request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(
+          tenant: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # The unique identifier for the tenant.
         tenant: nil,
         request_options: {}
-      ); end
-      sig { override.returns({tenant: String, request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      )
+      end
+
+      sig do
+        override.returns(
+          { tenant: String, request_options: Knockapi::RequestOptions }
+        )
+      end
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/user_list_messages_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::UserListMessagesParams, Knockapi::Internal::AnyHash)
+        end
+
       # The cursor to fetch entries after.
       sig { returns(T.nilable(String)) }
       attr_reader :after
@@ -28,23 +33,34 @@ module Knockapi
       attr_writer :channel_id
 
       # Limits the results to messages with the given engagement status.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::UserListMessagesParams::EngagementStatus::OrSymbol])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              Knockapi::UserListMessagesParams::EngagementStatus::OrSymbol
+            ]
+          )
+        )
+      end
       attr_reader :engagement_status
 
       sig do
-        params(engagement_status: T::Array[Knockapi::Models::UserListMessagesParams::EngagementStatus::OrSymbol])
-          .void
+        params(
+          engagement_status:
+            T::Array[
+              Knockapi::UserListMessagesParams::EngagementStatus::OrSymbol
+            ]
+        ).void
       end
       attr_writer :engagement_status
 
-      sig { returns(T.nilable(Knockapi::Models::UserListMessagesParams::InsertedAt)) }
+      sig { returns(T.nilable(Knockapi::UserListMessagesParams::InsertedAt)) }
       attr_reader :inserted_at
 
       sig do
         params(
-          inserted_at: T.any(Knockapi::Models::UserListMessagesParams::InsertedAt, Knockapi::Internal::AnyHash)
-        )
-          .void
+          inserted_at: Knockapi::UserListMessagesParams::InsertedAt::OrHash
+        ).void
       end
       attr_writer :inserted_at
 
@@ -71,10 +87,20 @@ module Knockapi
       attr_writer :source
 
       # Limits the results to messages with the given delivery status.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::UserListMessagesParams::Status::OrSymbol])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Knockapi::UserListMessagesParams::Status::OrSymbol]
+          )
+        )
+      end
       attr_reader :status
 
-      sig { params(status: T::Array[Knockapi::Models::UserListMessagesParams::Status::OrSymbol]).void }
+      sig do
+        params(
+          status: T::Array[Knockapi::UserListMessagesParams::Status::OrSymbol]
+        ).void
+      end
       attr_writer :status
 
       # Limits the results to items with the corresponding tenant.
@@ -120,20 +146,22 @@ module Knockapi
           after: String,
           before: String,
           channel_id: String,
-          engagement_status: T::Array[Knockapi::Models::UserListMessagesParams::EngagementStatus::OrSymbol],
-          inserted_at: T.any(Knockapi::Models::UserListMessagesParams::InsertedAt, Knockapi::Internal::AnyHash),
+          engagement_status:
+            T::Array[
+              Knockapi::UserListMessagesParams::EngagementStatus::OrSymbol
+            ],
+          inserted_at: Knockapi::UserListMessagesParams::InsertedAt::OrHash,
           message_ids: T::Array[String],
           page_size: Integer,
           source: String,
-          status: T::Array[Knockapi::Models::UserListMessagesParams::Status::OrSymbol],
+          status: T::Array[Knockapi::UserListMessagesParams::Status::OrSymbol],
           tenant: String,
           trigger_data: String,
           workflow_categories: T::Array[String],
           workflow_recipient_run_id: String,
           workflow_run_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 cursor to fetch entries after.
@@ -168,49 +196,107 @@ module Knockapi
         # returned by the workflow trigger request.
         workflow_run_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              after: String,
-              before: String,
-              channel_id: String,
-              engagement_status: T::Array[Knockapi::Models::UserListMessagesParams::EngagementStatus::OrSymbol],
-              inserted_at: Knockapi::Models::UserListMessagesParams::InsertedAt,
-              message_ids: T::Array[String],
-              page_size: Integer,
-              source: String,
-              status: T::Array[Knockapi::Models::UserListMessagesParams::Status::OrSymbol],
-              tenant: String,
-              trigger_data: String,
-              workflow_categories: T::Array[String],
-              workflow_recipient_run_id: String,
-              workflow_run_id: String,
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            after: String,
+            before: String,
+            channel_id: String,
+            engagement_status:
+              T::Array[
+                Knockapi::UserListMessagesParams::EngagementStatus::OrSymbol
+              ],
+            inserted_at: Knockapi::UserListMessagesParams::InsertedAt,
+            message_ids: T::Array[String],
+            page_size: Integer,
+            source: String,
+            status:
+              T::Array[Knockapi::UserListMessagesParams::Status::OrSymbol],
+            tenant: String,
+            trigger_data: String,
+            workflow_categories: T::Array[String],
+            workflow_recipient_run_id: String,
+            workflow_run_id: String,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       module EngagementStatus
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Knockapi::UserListMessagesParams::EngagementStatus)
+          end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        SEEN = T.let(:seen, Knockapi::Models::UserListMessagesParams::EngagementStatus::TaggedSymbol)
-        READ = T.let(:read, Knockapi::Models::UserListMessagesParams::EngagementStatus::TaggedSymbol)
-        INTERACTED = T.let(:interacted, Knockapi::Models::UserListMessagesParams::EngagementStatus::TaggedSymbol)
+        SEEN =
+          T.let(
+            :seen,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        UNSEEN =
+          T.let(
+            :unseen,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        READ =
+          T.let(
+            :read,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        UNREAD =
+          T.let(
+            :unread,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        ARCHIVED =
+          T.let(
+            :archived,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        UNARCHIVED =
+          T.let(
+            :unarchived,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
         LINK_CLICKED =
-          T.let(:link_clicked, Knockapi::Models::UserListMessagesParams::EngagementStatus::TaggedSymbol)
-        ARCHIVED = T.let(:archived, Knockapi::Models::UserListMessagesParams::EngagementStatus::TaggedSymbol)
+          T.let(
+            :link_clicked,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        INTERACTED =
+          T.let(
+            :interacted,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
 
-        sig { override.returns(T::Array[Knockapi::Models::UserListMessagesParams::EngagementStatus::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[
+              Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
       end
 
       class InsertedAt < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::UserListMessagesParams::InsertedAt,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # Limits the results to messages inserted after the given date.
         sig { returns(T.nilable(String)) }
         attr_reader :gt
@@ -239,7 +325,11 @@ module Knockapi
         sig { params(lte: String).void }
         attr_writer :lte
 
-        sig { params(gt: String, gte: String, lt: String, lte: String).returns(T.attached_class) }
+        sig do
+          params(gt: String, gte: String, lt: String, lte: String).returns(
+            T.attached_class
+          )
+        end
         def self.new(
           # Limits the results to messages inserted after the given date.
           gt: nil,
@@ -249,28 +339,62 @@ module Knockapi
           lt: nil,
           # Limits the results to messages inserted before or on the given date.
           lte: nil
-        ); end
-        sig { override.returns({gt: String, gte: String, lt: String, lte: String}) }
-        def to_hash; end
+        )
+        end
+
+        sig do
+          override.returns({ gt: String, gte: String, lt: String, lte: String })
+        end
+        def to_hash
+        end
       end
 
       module Status
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::UserListMessagesParams::Status) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Knockapi::UserListMessagesParams::Status)
+          end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        QUEUED = T.let(:queued, Knockapi::Models::UserListMessagesParams::Status::TaggedSymbol)
-        SENT = T.let(:sent, Knockapi::Models::UserListMessagesParams::Status::TaggedSymbol)
-        DELIVERED = T.let(:delivered, Knockapi::Models::UserListMessagesParams::Status::TaggedSymbol)
+        QUEUED =
+          T.let(:queued, Knockapi::UserListMessagesParams::Status::TaggedSymbol)
+        SENT =
+          T.let(:sent, Knockapi::UserListMessagesParams::Status::TaggedSymbol)
+        DELIVERED =
+          T.let(
+            :delivered,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
         DELIVERY_ATTEMPTED =
-          T.let(:delivery_attempted, Knockapi::Models::UserListMessagesParams::Status::TaggedSymbol)
-        UNDELIVERED = T.let(:undelivered, Knockapi::Models::UserListMessagesParams::Status::TaggedSymbol)
-        NOT_SENT = T.let(:not_sent, Knockapi::Models::UserListMessagesParams::Status::TaggedSymbol)
-        BOUNCED = T.let(:bounced, Knockapi::Models::UserListMessagesParams::Status::TaggedSymbol)
+          T.let(
+            :delivery_attempted,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
+        UNDELIVERED =
+          T.let(
+            :undelivered,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
+        NOT_SENT =
+          T.let(
+            :not_sent,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
+        BOUNCED =
+          T.let(
+            :bounced,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
 
-        sig { override.returns(T::Array[Knockapi::Models::UserListMessagesParams::Status::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[Knockapi::UserListMessagesParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
     end
   end