knockapi 1.0.0 → 1.1.0

data/rbi/knockapi/models/schedule_update_params.rbi

@@ -6,13 +6,24 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ScheduleUpdateParams, Knockapi::Internal::AnyHash)
+        end
+
       # A list of schedule IDs.
       sig { returns(T::Array[String]) }
       attr_accessor :schedule_ids
 
       # A reference to a recipient, either a user identifier (string) or an object
       # reference (ID, collection).
-      sig { returns(T.nilable(T.any(String, Knockapi::Models::RecipientReference::ObjectReference))) }
+      sig do
+        returns(
+          T.nilable(
+            T.any(String, Knockapi::RecipientReference::ObjectReference)
+          )
+        )
+      end
       attr_accessor :actor
 
       # An optional map of data to pass into the workflow execution.
@@ -24,10 +35,12 @@ module Knockapi
       attr_accessor :ending_at
 
       # The repeat rule for the schedule.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::ScheduleRepeatRule])) }
+      sig { returns(T.nilable(T::Array[Knockapi::ScheduleRepeatRule])) }
       attr_reader :repeats
 
-      sig { params(repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)]).void }
+      sig do
+        params(repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash]).void
+      end
       attr_writer :repeats
 
       # The starting date and time for the schedule.
@@ -35,23 +48,26 @@ module Knockapi
       attr_accessor :scheduled_at
 
       # 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(
           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: 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(
         # A list of schedule IDs.
@@ -70,23 +86,28 @@ module Knockapi
         # An request to set a tenant inline.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              schedule_ids: T::Array[String],
-              actor: T.nilable(T.any(String, Knockapi::Models::RecipientReference::ObjectReference)),
-              data: T.nilable(T::Hash[Symbol, T.anything]),
-              ending_at: T.nilable(Time),
-              repeats: T::Array[Knockapi::Models::ScheduleRepeatRule],
-              scheduled_at: T.nilable(Time),
-              tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest)),
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            schedule_ids: T::Array[String],
+            actor:
+              T.nilable(
+                T.any(String, Knockapi::RecipientReference::ObjectReference)
+              ),
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            ending_at: T.nilable(Time),
+            repeats: T::Array[Knockapi::ScheduleRepeatRule],
+            scheduled_at: T.nilable(Time),
+            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/schedule_update_response.rbi

@@ -3,6 +3,9 @@
 module Knockapi
   module Models
     ScheduleUpdateResponse =
-      T.let(Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Schedule], Knockapi::Internal::Type::Converter)
+      T.let(
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
+        Knockapi::Internal::Type::Converter
+      )
   end
 end

data/rbi/knockapi/models/schedules/bulk_create_params.rbi

@@ -7,34 +7,55 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Schedules::BulkCreateParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # A list of schedules.
-        sig { returns(T::Array[Knockapi::Models::Schedules::BulkCreateParams::Schedule]) }
+        sig do
+          returns(T::Array[Knockapi::Schedules::BulkCreateParams::Schedule])
+        end
         attr_accessor :schedules
 
         sig do
           params(
-            schedules: T::Array[T.any(Knockapi::Models::Schedules::BulkCreateParams::Schedule, Knockapi::Internal::AnyHash)],
-            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            schedules:
+              T::Array[Knockapi::Schedules::BulkCreateParams::Schedule::OrHash],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # A list of schedules.
           schedules:,
           request_options: {}
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                schedules: T::Array[Knockapi::Models::Schedules::BulkCreateParams::Schedule],
-                request_options: Knockapi::RequestOptions
-              }
-            )
+          override.returns(
+            {
+              schedules:
+                T::Array[Knockapi::Schedules::BulkCreateParams::Schedule],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class Schedule < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Schedules::BulkCreateParams::Schedule,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
           # The key of the workflow.
           sig { returns(String) }
           attr_accessor :workflow
@@ -45,7 +66,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
@@ -65,7 +90,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
@@ -73,22 +102,23 @@ module Knockapi
 
           sig do
             params(
-              recipient: T.any(
-                String,
-                Knockapi::Models::InlineIdentifyUserRequest,
-                Knockapi::Internal::AnyHash,
-                Knockapi::Models::InlineObjectRequest
-              )
-            )
-              .void
+              recipient:
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest::OrHash,
+                  Knockapi::InlineObjectRequest::OrHash
+                )
+            ).void
           end
           attr_writer :recipient
 
           # The repeat rule for the schedule.
-          sig { returns(T.nilable(T::Array[Knockapi::Models::ScheduleRepeatRule])) }
+          sig { returns(T.nilable(T::Array[Knockapi::ScheduleRepeatRule])) }
           attr_reader :repeats
 
-          sig { params(repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)]).void }
+          sig do
+            params(repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash]).void
+          end
           attr_writer :repeats
 
           # The starting date and time for the schedule.
@@ -96,34 +126,33 @@ module Knockapi
           attr_accessor :scheduled_at
 
           # 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
 
           # A schedule represents a recurring workflow execution.
           sig do
             params(
               workflow: String,
-              actor: T.nilable(
-                T.any(
-                  String,
-                  Knockapi::Models::InlineIdentifyUserRequest,
-                  Knockapi::Internal::AnyHash,
-                  Knockapi::Models::InlineObjectRequest
-                )
-              ),
+              actor:
+                T.nilable(
+                  T.any(
+                    String,
+                    Knockapi::InlineIdentifyUserRequest::OrHash,
+                    Knockapi::InlineObjectRequest::OrHash
+                  )
+                ),
               data: T.nilable(T::Hash[Symbol, T.anything]),
               ending_at: T.nilable(Time),
-              recipient: T.any(
-                String,
-                Knockapi::Models::InlineIdentifyUserRequest,
-                Knockapi::Internal::AnyHash,
-                Knockapi::Models::InlineObjectRequest
-              ),
-              repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)],
+              recipient:
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest::OrHash,
+                  Knockapi::InlineObjectRequest::OrHash
+                ),
+              repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
               scheduled_at: T.nilable(Time),
-              tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash))
-            )
-              .returns(T.attached_class)
+              tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash))
+            ).returns(T.attached_class)
           end
           def self.new(
             # The key of the workflow.
@@ -146,25 +175,37 @@ module Knockapi
             scheduled_at: nil,
             # An request to set a tenant inline.
             tenant: nil
-          ); end
+          )
+          end
+
           sig do
-            override
-              .returns(
-                {
-                  workflow: String,
-                  actor: T.nilable(
-                    T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)
+            override.returns(
+              {
+                workflow: String,
+                actor:
+                  T.nilable(
+                    T.any(
+                      String,
+                      Knockapi::InlineIdentifyUserRequest,
+                      Knockapi::InlineObjectRequest
+                    )
                   ),
-                  data: T.nilable(T::Hash[Symbol, T.anything]),
-                  ending_at: T.nilable(Time),
-                  recipient: T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest),
-                  repeats: T::Array[Knockapi::Models::ScheduleRepeatRule],
-                  scheduled_at: T.nilable(Time),
-                  tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest))
-                }
-              )
+                data: T.nilable(T::Hash[Symbol, T.anything]),
+                ending_at: T.nilable(Time),
+                recipient:
+                  T.any(
+                    String,
+                    Knockapi::InlineIdentifyUserRequest,
+                    Knockapi::InlineObjectRequest
+                  ),
+                repeats: T::Array[Knockapi::ScheduleRepeatRule],
+                scheduled_at: T.nilable(Time),
+                tenant: T.nilable(T.any(String, Knockapi::TenantRequest))
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
         end
       end
     end

data/rbi/knockapi/models/tenant.rbi

@@ -3,6 +3,9 @@
 module Knockapi
   module Models
     class Tenant < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::Tenant, Knockapi::Internal::AnyHash) }
+
       # The unique identifier for the tenant.
       sig { returns(String) }
       attr_accessor :id
@@ -16,10 +19,12 @@ module Knockapi
       attr_accessor :name
 
       # The settings for the tenant. Includes branding and preference set.
-      sig { returns(T.nilable(Knockapi::Models::Tenant::Settings)) }
+      sig { returns(T.nilable(Knockapi::Tenant::Settings)) }
       attr_reader :settings
 
-      sig { params(settings: T.nilable(T.any(Knockapi::Models::Tenant::Settings, Knockapi::Internal::AnyHash))).void }
+      sig do
+        params(settings: T.nilable(Knockapi::Tenant::Settings::OrHash)).void
+      end
       attr_writer :settings
 
       # A tenant entity.
@@ -28,9 +33,8 @@ module Knockapi
           id: String,
           _typename: String,
           name: T.nilable(String),
-          settings: T.nilable(T.any(Knockapi::Models::Tenant::Settings, Knockapi::Internal::AnyHash))
-        )
-          .returns(T.attached_class)
+          settings: T.nilable(Knockapi::Tenant::Settings::OrHash)
+        ).returns(T.attached_class)
       end
       def self.new(
         # The unique identifier for the tenant.
@@ -41,48 +45,59 @@ module Knockapi
         name: nil,
         # The settings for the tenant. Includes branding and preference set.
         settings: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {id: String, _typename: String, name: T.nilable(String), settings: T.nilable(Knockapi::Models::Tenant::Settings)}
-          )
+        override.returns(
+          {
+            id: String,
+            _typename: String,
+            name: T.nilable(String),
+            settings: T.nilable(Knockapi::Tenant::Settings)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       class Settings < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Knockapi::Tenant::Settings, Knockapi::Internal::AnyHash)
+          end
+
         # The branding for the tenant.
-        sig { returns(T.nilable(Knockapi::Models::Tenant::Settings::Branding)) }
+        sig { returns(T.nilable(Knockapi::Tenant::Settings::Branding)) }
         attr_reader :branding
 
         sig do
           params(
-            branding: T.nilable(T.any(Knockapi::Models::Tenant::Settings::Branding, Knockapi::Internal::AnyHash))
-          )
-            .void
+            branding: T.nilable(Knockapi::Tenant::Settings::Branding::OrHash)
+          ).void
         end
         attr_writer :branding
 
         # A preference set represents a specific set of notification preferences for a
         # recipient. A recipient can have multiple preference sets.
-        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSet)) }
+        sig { returns(T.nilable(Knockapi::Recipients::PreferenceSet)) }
         attr_reader :preference_set
 
         sig do
           params(
-            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSet, Knockapi::Internal::AnyHash))
-          )
-            .void
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSet::OrHash)
+          ).void
         end
         attr_writer :preference_set
 
         # The settings for the tenant. Includes branding and preference set.
         sig do
           params(
-            branding: T.nilable(T.any(Knockapi::Models::Tenant::Settings::Branding, Knockapi::Internal::AnyHash)),
-            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSet, Knockapi::Internal::AnyHash))
-          )
-            .returns(T.attached_class)
+            branding: T.nilable(Knockapi::Tenant::Settings::Branding::OrHash),
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSet::OrHash)
+          ).returns(T.attached_class)
         end
         def self.new(
           # The branding for the tenant.
@@ -90,19 +105,29 @@ module Knockapi
           # A preference set represents a specific set of notification preferences for a
           # recipient. A recipient can have multiple preference sets.
           preference_set: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                branding: T.nilable(Knockapi::Models::Tenant::Settings::Branding),
-                preference_set: T.nilable(Knockapi::Models::Recipients::PreferenceSet)
-              }
-            )
+          override.returns(
+            {
+              branding: T.nilable(Knockapi::Tenant::Settings::Branding),
+              preference_set: T.nilable(Knockapi::Recipients::PreferenceSet)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class Branding < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Tenant::Settings::Branding,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
           # The icon URL for the tenant. Must point to a valid image with an image MIME
           # type.
           sig { returns(T.nilable(String)) }
@@ -128,8 +153,7 @@ module Knockapi
               logo_url: T.nilable(String),
               primary_color: T.nilable(String),
               primary_color_contrast: T.nilable(String)
-            )
-              .returns(T.attached_class)
+            ).returns(T.attached_class)
           end
           def self.new(
             # The icon URL for the tenant. Must point to a valid image with an image MIME
@@ -142,19 +166,21 @@ module Knockapi
             primary_color: nil,
             # The primary color contrast for the tenant, provided as a hex value.
             primary_color_contrast: nil
-          ); end
+          )
+          end
+
           sig do
-            override
-              .returns(
-                {
-                  icon_url: T.nilable(String),
-                  logo_url: T.nilable(String),
-                  primary_color: T.nilable(String),
-                  primary_color_contrast: T.nilable(String)
-                }
-              )
+            override.returns(
+              {
+                icon_url: T.nilable(String),
+                logo_url: T.nilable(String),
+                primary_color: T.nilable(String),
+                primary_color_contrast: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
         end
       end
     end

data/rbi/knockapi/models/tenant_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::TenantDeleteParams, 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/tenant_delete_response.rbi

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

data/rbi/knockapi/models/tenant_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::TenantGetParams, 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