knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models/recipients/discord_channel_data.rbi

@@ -4,13 +4,21 @@ module Knockapi
   module Models
     module Recipients
       class DiscordChannelData < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::DiscordChannelData,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # List of Discord channel connections.
         sig do
           returns(
             T::Array[
               T.any(
-                Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
-                Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
+                Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
+                Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
               )
             ]
           )
@@ -20,41 +28,59 @@ module Knockapi
         # Discord channel data.
         sig do
           params(
-            connections: T::Array[
-              T.any(
-                Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
-                Knockapi::Internal::AnyHash,
-                Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
-              )
-            ]
-          )
-            .returns(T.attached_class)
+            connections:
+              T::Array[
+                T.any(
+                  Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection::OrHash,
+                  Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::OrHash
+                )
+              ]
+          ).returns(T.attached_class)
         end
         def self.new(
           # List of Discord channel connections.
           connections:
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                connections: T::Array[
+          override.returns(
+            {
+              connections:
+                T::Array[
                   T.any(
-                    Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
-                    Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
+                    Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
+                    Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
                   )
                 ]
-              }
-            )
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         # Discord channel connection, either a channel connection or an incoming webhook
         # connection.
         module Connection
           extend Knockapi::Internal::Type::Union
 
+          Variants =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
+                Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
+              )
+            end
+
           class DiscordChannelConnection < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
             # Discord channel ID.
             sig { returns(String) }
             attr_accessor :channel_id
@@ -64,56 +90,72 @@ module Knockapi
             def self.new(
               # Discord channel ID.
               channel_id:
-            ); end
-            sig { override.returns({channel_id: String}) }
-            def to_hash; end
+            )
+            end
+
+            sig { override.returns({ channel_id: String }) }
+            def to_hash
+            end
           end
 
           class DiscordIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
             # Discord incoming webhook object.
             sig do
               returns(
-                Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
+                Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
               )
             end
             attr_reader :incoming_webhook
 
             sig do
               params(
-                incoming_webhook: T.any(
-                  Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook,
-                  Knockapi::Internal::AnyHash
-                )
-              )
-                .void
+                incoming_webhook:
+                  Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook::OrHash
+              ).void
             end
             attr_writer :incoming_webhook
 
             # Discord incoming webhook connection.
             sig do
               params(
-                incoming_webhook: T.any(
-                  Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook,
-                  Knockapi::Internal::AnyHash
-                )
-              )
-                .returns(T.attached_class)
+                incoming_webhook:
+                  Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook::OrHash
+              ).returns(T.attached_class)
             end
             def self.new(
               # Discord incoming webhook object.
               incoming_webhook:
-            ); end
+            )
+            end
+
             sig do
-              override
-                .returns(
-                  {
-                    incoming_webhook: Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
-                  }
-                )
+              override.returns(
+                {
+                  incoming_webhook:
+                    Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
 
             class IncomingWebhook < Knockapi::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook,
+                    Knockapi::Internal::AnyHash
+                  )
+                end
+
               # Incoming webhook URL.
               sig { returns(String) }
               attr_accessor :url
@@ -123,19 +165,24 @@ module Knockapi
               def self.new(
                 # Incoming webhook URL.
                 url:
-              ); end
-              sig { override.returns({url: String}) }
-              def to_hash; end
+              )
+              end
+
+              sig { override.returns({ url: String }) }
+              def to_hash
+              end
             end
           end
 
           sig do
-            override
-              .returns(
-                [Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection]
-              )
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::DiscordChannelData::Connection::Variants
+              ]
+            )
+          end
+          def self.variants
           end
-          def self.variants; end
         end
       end
     end

data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi

@@ -3,9 +3,37 @@
 module Knockapi
   module Models
     module Recipients
+      # Channel data for a given channel type.
+      module InlineChannelDataRequestItem
+        extend Knockapi::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::PushChannelData,
+              Knockapi::Recipients::OneSignalChannelData,
+              Knockapi::Recipients::SlackChannelData,
+              Knockapi::Recipients::MsTeamsChannelData,
+              Knockapi::Recipients::DiscordChannelData
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[
+              Knockapi::Recipients::InlineChannelDataRequestItem::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
+
       InlineChannelDataRequest =
         T.let(
-          Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::ChannelDataRequest],
+          Knockapi::Internal::Type::HashOf[
+            union: Knockapi::Recipients::InlineChannelDataRequestItem
+          ],
           Knockapi::Internal::Type::Converter
         )
     end

data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi

@@ -5,7 +5,9 @@ module Knockapi
     module Recipients
       InlinePreferenceSetRequest =
         T.let(
-          Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::PreferenceSetRequest],
+          Knockapi::Internal::Type::HashOf[
+            Knockapi::Recipients::PreferenceSetRequest
+          ],
           Knockapi::Internal::Type::Converter
         )
     end

data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi

@@ -4,13 +4,21 @@ module Knockapi
   module Models
     module Recipients
       class MsTeamsChannelData < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::MsTeamsChannelData,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # List of Microsoft Teams connections.
         sig do
           returns(
             T::Array[
               T.any(
-                Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
-                Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
+                Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
+                Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
               )
             ]
           )
@@ -24,44 +32,62 @@ module Knockapi
         # Microsoft Teams channel connection.
         sig do
           params(
-            connections: T::Array[
-              T.any(
-                Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
-                Knockapi::Internal::AnyHash,
-                Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
-              )
-            ],
+            connections:
+              T::Array[
+                T.any(
+                  Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection::OrHash,
+                  Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::OrHash
+                )
+              ],
             ms_teams_tenant_id: T.nilable(String)
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
           # List of Microsoft Teams connections.
           connections:,
           # Microsoft Teams tenant ID.
           ms_teams_tenant_id: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                connections: T::Array[
+          override.returns(
+            {
+              connections:
+                T::Array[
                   T.any(
-                    Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
-                    Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
+                    Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
+                    Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
                   )
                 ],
-                ms_teams_tenant_id: T.nilable(String)
-              }
-            )
+              ms_teams_tenant_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         # Microsoft Teams token connection.
         module Connection
           extend Knockapi::Internal::Type::Union
 
+          Variants =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
+                Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
+              )
+            end
+
           class MsTeamsTokenConnection < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
             # Microsoft Teams channel ID.
             sig { returns(T.nilable(String)) }
             attr_accessor :ms_teams_channel_id
@@ -85,8 +111,7 @@ module Knockapi
                 ms_teams_team_id: T.nilable(String),
                 ms_teams_tenant_id: T.nilable(String),
                 ms_teams_user_id: T.nilable(String)
-              )
-                .returns(T.attached_class)
+              ).returns(T.attached_class)
             end
             def self.new(
               # Microsoft Teams channel ID.
@@ -97,66 +122,81 @@ module Knockapi
               ms_teams_tenant_id: nil,
               # Microsoft Teams user ID.
               ms_teams_user_id: nil
-            ); end
+            )
+            end
+
             sig do
-              override
-                .returns(
-                  {
-                    ms_teams_channel_id: T.nilable(String),
-                    ms_teams_team_id: T.nilable(String),
-                    ms_teams_tenant_id: T.nilable(String),
-                    ms_teams_user_id: T.nilable(String)
-                  }
-                )
+              override.returns(
+                {
+                  ms_teams_channel_id: T.nilable(String),
+                  ms_teams_team_id: T.nilable(String),
+                  ms_teams_tenant_id: T.nilable(String),
+                  ms_teams_user_id: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
           end
 
           class MsTeamsIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
             # Microsoft Teams incoming webhook.
             sig do
               returns(
-                Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook
+                Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook
               )
             end
             attr_reader :incoming_webhook
 
             sig do
               params(
-                incoming_webhook: T.any(
-                  Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook,
-                  Knockapi::Internal::AnyHash
-                )
-              )
-                .void
+                incoming_webhook:
+                  Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook::OrHash
+              ).void
             end
             attr_writer :incoming_webhook
 
             # Microsoft Teams incoming webhook connection.
             sig do
               params(
-                incoming_webhook: T.any(
-                  Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook,
-                  Knockapi::Internal::AnyHash
-                )
-              )
-                .returns(T.attached_class)
+                incoming_webhook:
+                  Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook::OrHash
+              ).returns(T.attached_class)
             end
             def self.new(
               # Microsoft Teams incoming webhook.
               incoming_webhook:
-            ); end
+            )
+            end
+
             sig do
-              override
-                .returns(
-                  {
-                    incoming_webhook: Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook
-                  }
-                )
+              override.returns(
+                {
+                  incoming_webhook:
+                    Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
 
             class IncomingWebhook < Knockapi::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook,
+                    Knockapi::Internal::AnyHash
+                  )
+                end
+
               # Microsoft Teams incoming webhook URL.
               sig { returns(String) }
               attr_accessor :url
@@ -166,19 +206,24 @@ module Knockapi
               def self.new(
                 # Microsoft Teams incoming webhook URL.
                 url:
-              ); end
-              sig { override.returns({url: String}) }
-              def to_hash; end
+              )
+              end
+
+              sig { override.returns({ url: String }) }
+              def to_hash
+              end
             end
           end
 
           sig do
-            override
-              .returns(
-                [Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection]
-              )
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::MsTeamsChannelData::Connection::Variants
+              ]
+            )
+          end
+          def self.variants
           end
-          def self.variants; end
         end
       end
     end

data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Recipients
       class OneSignalChannelData < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::OneSignalChannelData,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # A list of OneSignal player IDs.
         sig { returns(T::Array[String]) }
         attr_accessor :player_ids
@@ -13,9 +21,12 @@ module Knockapi
         def self.new(
           # A list of OneSignal player IDs.
           player_ids:
-        ); end
-        sig { override.returns({player_ids: T::Array[String]}) }
-        def to_hash; end
+        )
+        end
+
+        sig { override.returns({ player_ids: T::Array[String] }) }
+        def to_hash
+        end
       end
     end
   end