knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/recipients/channel_data.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class RecipientsChannelData < Knockapi::Internal::Type::BaseModel
+        # The typename of the schema.
+        sig { returns(String) }
+        attr_accessor :_typename
+
+        # The unique identifier for the channel.
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # Channel data for a given channel type.
+        sig do
+          returns(
+            T.any(
+              Knockapi::Models::Recipients::PushChannelData,
+              Knockapi::Models::Recipients::SlackChannelData,
+              Knockapi::Models::Recipients::MsTeamsChannelData,
+              Knockapi::Models::Recipients::DiscordChannelData,
+              Knockapi::Models::Recipients::OneSignalChannelData
+            )
+          )
+        end
+        attr_accessor :data
+
+        # The type of provider.
+        sig { returns(T.nilable(Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)) }
+        attr_reader :provider
+
+        sig { params(provider: Knockapi::Models::Recipients::RecipientsChannelData::Provider::OrSymbol).void }
+        attr_writer :provider
+
+        # Channel data for a given channel type.
+        sig do
+          params(
+            _typename: String,
+            channel_id: String,
+            data: T.any(
+              Knockapi::Models::Recipients::PushChannelData,
+              Knockapi::Internal::AnyHash,
+              Knockapi::Models::Recipients::SlackChannelData,
+              Knockapi::Models::Recipients::MsTeamsChannelData,
+              Knockapi::Models::Recipients::DiscordChannelData,
+              Knockapi::Models::Recipients::OneSignalChannelData
+            ),
+            provider: Knockapi::Models::Recipients::RecipientsChannelData::Provider::OrSymbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The typename of the schema.
+          _typename:,
+          # The unique identifier for the channel.
+          channel_id:,
+          # Channel data for a given channel type.
+          data:,
+          # The type of provider.
+          provider: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                _typename: String,
+                channel_id: String,
+                data: T.any(
+                  Knockapi::Models::Recipients::PushChannelData,
+                  Knockapi::Models::Recipients::SlackChannelData,
+                  Knockapi::Models::Recipients::MsTeamsChannelData,
+                  Knockapi::Models::Recipients::DiscordChannelData,
+                  Knockapi::Models::Recipients::OneSignalChannelData
+                ),
+                provider: Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol
+              }
+            )
+        end
+        def to_hash; end
+
+        # Channel data for a given channel type.
+        module Data
+          extend Knockapi::Internal::Type::Union
+
+          sig do
+            override
+              .returns(
+                [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData]
+              )
+          end
+          def self.variants; end
+        end
+
+        # The type of provider.
+        module Provider
+          extend Knockapi::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Knockapi::Models::Recipients::RecipientsChannelData::Provider) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PUSH_FCM = T.let(:push_fcm, Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)
+          PUSH_APNS =
+            T.let(:push_apns, Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)
+          PUSH_EXPO =
+            T.let(:push_expo, Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)
+          PUSH_ONE_SIGNAL =
+            T.let(:push_one_signal, Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)
+          CHAT_SLACK =
+            T.let(:chat_slack, Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)
+          CHAT_MS_TEAMS =
+            T.let(:chat_ms_teams, Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)
+          CHAT_DISCORD =
+            T.let(:chat_discord, Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)
+          HTTP_KNOCK_WEBHOOK =
+            T.let(:http_knock_webhook, Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol)
+
+          sig { override.returns(T::Array[Knockapi::Models::Recipients::RecipientsChannelData::Provider::TaggedSymbol]) }
+          def self.values; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipients/channel_data_request.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class ChannelDataRequest < Knockapi::Internal::Type::BaseModel
+        # Channel data for a given channel type.
+        sig do
+          returns(
+            T.any(
+              Knockapi::Models::Recipients::PushChannelData,
+              Knockapi::Models::Recipients::OneSignalChannelData,
+              Knockapi::Models::Recipients::SlackChannelData,
+              Knockapi::Models::Recipients::MsTeamsChannelData,
+              Knockapi::Models::Recipients::DiscordChannelData
+            )
+          )
+        end
+        attr_accessor :data
+
+        # A request to set channel data for a type of channel.
+        sig do
+          params(
+            data: T.any(
+              Knockapi::Models::Recipients::PushChannelData,
+              Knockapi::Internal::AnyHash,
+              Knockapi::Models::Recipients::OneSignalChannelData,
+              Knockapi::Models::Recipients::SlackChannelData,
+              Knockapi::Models::Recipients::MsTeamsChannelData,
+              Knockapi::Models::Recipients::DiscordChannelData
+            )
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # Channel data for a given channel type.
+          data:
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                data: T.any(
+                  Knockapi::Models::Recipients::PushChannelData,
+                  Knockapi::Models::Recipients::OneSignalChannelData,
+                  Knockapi::Models::Recipients::SlackChannelData,
+                  Knockapi::Models::Recipients::MsTeamsChannelData,
+                  Knockapi::Models::Recipients::DiscordChannelData
+                )
+              }
+            )
+        end
+        def to_hash; end
+
+        # Channel data for a given channel type.
+        module Data
+          extend Knockapi::Internal::Type::Union
+
+          sig do
+            override
+              .returns(
+                [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData]
+              )
+          end
+          def self.variants; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class DiscordChannelData < Knockapi::Internal::Type::BaseModel
+        # List of Discord channel connections.
+        sig do
+          returns(
+            T::Array[
+              T.any(
+                Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
+                Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
+              )
+            ]
+          )
+        end
+        attr_accessor :connections
+
+        # 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)
+        end
+        def self.new(
+          # List of Discord channel connections.
+          connections:
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                connections: T::Array[
+                  T.any(
+                    Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
+                    Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
+                  )
+                ]
+              }
+            )
+        end
+        def to_hash; end
+
+        # Discord channel connection, either a channel connection or an incoming webhook
+        # connection.
+        module Connection
+          extend Knockapi::Internal::Type::Union
+
+          class DiscordChannelConnection < Knockapi::Internal::Type::BaseModel
+            # Discord channel ID.
+            sig { returns(String) }
+            attr_accessor :channel_id
+
+            # Discord channel connection.
+            sig { params(channel_id: String).returns(T.attached_class) }
+            def self.new(
+              # Discord channel ID.
+              channel_id:
+            ); end
+            sig { override.returns({channel_id: String}) }
+            def to_hash; end
+          end
+
+          class DiscordIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            # Discord incoming webhook object.
+            sig do
+              returns(
+                Knockapi::Models::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
+            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)
+            end
+            def self.new(
+              # Discord incoming webhook object.
+              incoming_webhook:
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    incoming_webhook: Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
+                  }
+                )
+            end
+            def to_hash; end
+
+            class IncomingWebhook < Knockapi::Internal::Type::BaseModel
+              # Incoming webhook URL.
+              sig { returns(String) }
+              attr_accessor :url
+
+              # Discord incoming webhook object.
+              sig { params(url: String).returns(T.attached_class) }
+              def self.new(
+                # Incoming webhook URL.
+                url:
+              ); 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]
+              )
+          end
+          def self.variants; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      InlineChannelDataRequest =
+        T.let(
+          Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::ChannelDataRequest],
+          Knockapi::Internal::Type::Converter
+        )
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      InlinePreferenceSetRequest =
+        T.let(
+          Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::PreferenceSetRequest],
+          Knockapi::Internal::Type::Converter
+        )
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class MsTeamsChannelData < Knockapi::Internal::Type::BaseModel
+        # List of Microsoft Teams connections.
+        sig do
+          returns(
+            T::Array[
+              T.any(
+                Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
+                Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
+              )
+            ]
+          )
+        end
+        attr_accessor :connections
+
+        # Microsoft Teams tenant ID.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :ms_teams_tenant_id
+
+        # 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
+              )
+            ],
+            ms_teams_tenant_id: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # List of Microsoft Teams connections.
+          connections:,
+          # Microsoft Teams tenant ID.
+          ms_teams_tenant_id: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                connections: T::Array[
+                  T.any(
+                    Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
+                    Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
+                  )
+                ],
+                ms_teams_tenant_id: T.nilable(String)
+              }
+            )
+        end
+        def to_hash; end
+
+        # Microsoft Teams token connection.
+        module Connection
+          extend Knockapi::Internal::Type::Union
+
+          class MsTeamsTokenConnection < Knockapi::Internal::Type::BaseModel
+            # Microsoft Teams channel ID.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :ms_teams_channel_id
+
+            # Microsoft Teams team ID.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :ms_teams_team_id
+
+            # Microsoft Teams tenant ID.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :ms_teams_tenant_id
+
+            # Microsoft Teams user ID.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :ms_teams_user_id
+
+            # Microsoft Teams token connection.
+            sig do
+              params(
+                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)
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              # Microsoft Teams channel ID.
+              ms_teams_channel_id: nil,
+              # Microsoft Teams team ID.
+              ms_teams_team_id: nil,
+              # Microsoft Teams tenant ID.
+              ms_teams_tenant_id: nil,
+              # Microsoft Teams user ID.
+              ms_teams_user_id: nil
+            ); 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)
+                  }
+                )
+            end
+            def to_hash; end
+          end
+
+          class MsTeamsIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            # Microsoft Teams incoming webhook.
+            sig do
+              returns(
+                Knockapi::Models::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
+            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)
+            end
+            def self.new(
+              # Microsoft Teams incoming webhook.
+              incoming_webhook:
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    incoming_webhook: Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook
+                  }
+                )
+            end
+            def to_hash; end
+
+            class IncomingWebhook < Knockapi::Internal::Type::BaseModel
+              # Microsoft Teams incoming webhook URL.
+              sig { returns(String) }
+              attr_accessor :url
+
+              # Microsoft Teams incoming webhook.
+              sig { params(url: String).returns(T.attached_class) }
+              def self.new(
+                # Microsoft Teams incoming webhook URL.
+                url:
+              ); 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]
+              )
+          end
+          def self.variants; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class OneSignalChannelData < Knockapi::Internal::Type::BaseModel
+        # A list of OneSignal player IDs.
+        sig { returns(T::Array[String]) }
+        attr_accessor :player_ids
+
+        # OneSignal channel data.
+        sig { params(player_ids: T::Array[String]).returns(T.attached_class) }
+        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
+    end
+  end
+end