knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models/tenant_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::TenantListParams, Knockapi::Internal::AnyHash)
+        end
+
       # The cursor to fetch entries after.
       sig { returns(T.nilable(String)) }
       attr_reader :after
@@ -48,9 +53,8 @@ module Knockapi
           name: String,
           page_size: Integer,
           tenant_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.
@@ -64,21 +68,23 @@ module Knockapi
         # Filter tenants by ID.
         tenant_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              after: String,
-              before: String,
-              name: String,
-              page_size: Integer,
-              tenant_id: String,
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            after: String,
+            before: String,
+            name: String,
+            page_size: Integer,
+            tenant_id: String,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/tenant_request.rbi

@@ -3,23 +3,47 @@
 module Knockapi
   module Models
     class TenantRequest < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::TenantRequest, Knockapi::Internal::AnyHash)
+        end
+
       # The unique identifier for the tenant.
       sig { returns(String) }
       attr_accessor :id
 
       # A request to set channel data for a type of channel inline.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
       attr_accessor :channel_data
 
       # Inline set preferences for a recipient, where the key is the preference set id.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
       attr_accessor :preferences
 
       # The settings for the tenant. Includes branding and preference set.
-      sig { returns(T.nilable(Knockapi::Models::TenantRequest::Settings)) }
+      sig { returns(T.nilable(Knockapi::TenantRequest::Settings)) }
       attr_reader :settings
 
-      sig { params(settings: T.any(Knockapi::Models::TenantRequest::Settings, Knockapi::Internal::AnyHash)).void }
+      sig { params(settings: Knockapi::TenantRequest::Settings::OrHash).void }
       attr_writer :settings
 
       # A tenant to be set in the system. You can supply any additional properties on
@@ -27,15 +51,28 @@ module Knockapi
       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::TenantRequest::Settings, Knockapi::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          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::TenantRequest::Settings::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # The unique identifier for the tenant.
@@ -46,69 +83,106 @@ module Knockapi
         preferences: nil,
         # The settings for the tenant. Includes branding and preference set.
         settings: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              channel_data: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest]),
-              preferences: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest]),
-              settings: Knockapi::Models::TenantRequest::Settings
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            channel_data:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            preferences:
+              T.nilable(
+                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+              ),
+            settings: Knockapi::TenantRequest::Settings
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       class Settings < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::TenantRequest::Settings,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The branding for the tenant.
-        sig { returns(T.nilable(Knockapi::Models::TenantRequest::Settings::Branding)) }
+        sig { returns(T.nilable(Knockapi::TenantRequest::Settings::Branding)) }
         attr_reader :branding
 
         sig do
-          params(branding: T.any(Knockapi::Models::TenantRequest::Settings::Branding, Knockapi::Internal::AnyHash))
-            .void
+          params(
+            branding: Knockapi::TenantRequest::Settings::Branding::OrHash
+          ).void
         end
         attr_writer :branding
 
         # A request to set a preference set for a recipient.
-        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetRequest)) }
+        sig { returns(T.nilable(Knockapi::Recipients::PreferenceSetRequest)) }
         attr_reader :preference_set
 
         sig do
           params(
-            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash))
-          )
-            .void
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSetRequest::OrHash)
+          ).void
         end
         attr_writer :preference_set
 
         # The settings for the tenant. Includes branding and preference set.
         sig do
           params(
-            branding: T.any(Knockapi::Models::TenantRequest::Settings::Branding, Knockapi::Internal::AnyHash),
-            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash))
-          )
-            .returns(T.attached_class)
+            branding: Knockapi::TenantRequest::Settings::Branding::OrHash,
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSetRequest::OrHash)
+          ).returns(T.attached_class)
         end
         def self.new(
           # The branding for the tenant.
           branding: nil,
           # A request to set a preference set for a recipient.
           preference_set: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                branding: Knockapi::Models::TenantRequest::Settings::Branding,
-                preference_set: T.nilable(Knockapi::Models::Recipients::PreferenceSetRequest)
-              }
-            )
+          override.returns(
+            {
+              branding: Knockapi::TenantRequest::Settings::Branding,
+              preference_set:
+                T.nilable(Knockapi::Recipients::PreferenceSetRequest)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class Branding < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::TenantRequest::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)) }
@@ -134,8 +208,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
@@ -148,19 +221,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_set_params.rbi

@@ -6,33 +6,70 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::TenantSetParams, Knockapi::Internal::AnyHash)
+        end
+
       # A request to set channel data for a type of channel inline.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
       attr_accessor :channel_data
 
       # Inline set preferences for a recipient, where the key is the preference set id.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
       attr_accessor :preferences
 
       # The settings for the tenant. Includes branding and preference set.
-      sig { returns(T.nilable(Knockapi::Models::TenantSetParams::Settings)) }
+      sig { returns(T.nilable(Knockapi::TenantSetParams::Settings)) }
       attr_reader :settings
 
-      sig { params(settings: T.any(Knockapi::Models::TenantSetParams::Settings, Knockapi::Internal::AnyHash)).void }
+      sig { params(settings: Knockapi::TenantSetParams::Settings::OrHash).void }
       attr_writer :settings
 
       sig do
         params(
-          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: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          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(T.attached_class)
       end
       def self.new(
         # A request to set channel data for a type of channel inline.
@@ -42,71 +79,108 @@ module Knockapi
         # The settings for the tenant. Includes branding and preference set.
         settings: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              channel_data: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest]),
-              preferences: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest]),
-              settings: Knockapi::Models::TenantSetParams::Settings,
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            channel_data:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            preferences:
+              T.nilable(
+                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+              ),
+            settings: Knockapi::TenantSetParams::Settings,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       class Settings < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::TenantSetParams::Settings,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The branding for the tenant.
-        sig { returns(T.nilable(Knockapi::Models::TenantSetParams::Settings::Branding)) }
+        sig do
+          returns(T.nilable(Knockapi::TenantSetParams::Settings::Branding))
+        end
         attr_reader :branding
 
         sig do
           params(
-            branding: T.any(Knockapi::Models::TenantSetParams::Settings::Branding, Knockapi::Internal::AnyHash)
-          )
-            .void
+            branding: Knockapi::TenantSetParams::Settings::Branding::OrHash
+          ).void
         end
         attr_writer :branding
 
         # A request to set a preference set for a recipient.
-        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetRequest)) }
+        sig { returns(T.nilable(Knockapi::Recipients::PreferenceSetRequest)) }
         attr_reader :preference_set
 
         sig do
           params(
-            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash))
-          )
-            .void
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSetRequest::OrHash)
+          ).void
         end
         attr_writer :preference_set
 
         # The settings for the tenant. Includes branding and preference set.
         sig do
           params(
-            branding: T.any(Knockapi::Models::TenantSetParams::Settings::Branding, Knockapi::Internal::AnyHash),
-            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash))
-          )
-            .returns(T.attached_class)
+            branding: Knockapi::TenantSetParams::Settings::Branding::OrHash,
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSetRequest::OrHash)
+          ).returns(T.attached_class)
         end
         def self.new(
           # The branding for the tenant.
           branding: nil,
           # A request to set a preference set for a recipient.
           preference_set: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                branding: Knockapi::Models::TenantSetParams::Settings::Branding,
-                preference_set: T.nilable(Knockapi::Models::Recipients::PreferenceSetRequest)
-              }
-            )
+          override.returns(
+            {
+              branding: Knockapi::TenantSetParams::Settings::Branding,
+              preference_set:
+                T.nilable(Knockapi::Recipients::PreferenceSetRequest)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class Branding < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::TenantSetParams::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)) }
@@ -132,8 +206,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
@@ -146,19 +219,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/tenants/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::Tenants::BulkDeleteParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The IDs of the tenants to delete.
         sig { returns(T::Array[String]) }
         attr_accessor :tenant_ids
@@ -14,17 +22,26 @@ module Knockapi
         sig do
           params(
             tenant_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(
           # The IDs of the tenants to delete.
           tenant_ids:,
           request_options: {}
-        ); end
-        sig { override.returns({tenant_ids: T::Array[String], request_options: Knockapi::RequestOptions}) }
-        def to_hash; end
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              tenant_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
       end
     end
   end