knockapi 0.6.1 → 1.1.0

data/lib/knockapi/models/recipients/inline_channel_data_request.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      # Channel data for a given channel type.
+      module InlineChannelDataRequestItem
+        extend Knockapi::Internal::Type::Union
+
+        # The content of a push notification.
+        variant -> { Knockapi::Recipients::PushChannelData }
+
+        # OneSignal channel data.
+        variant -> { Knockapi::Recipients::OneSignalChannelData }
+
+        # Slack channel data
+        variant -> { Knockapi::Recipients::SlackChannelData }
+
+        # Microsoft Teams channel connection.
+        variant -> { Knockapi::Recipients::MsTeamsChannelData }
+
+        # Discord channel data.
+        variant -> { Knockapi::Recipients::DiscordChannelData }
+
+        # @!method self.variants
+        #   @return [Array(Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::PushChannelData,
+              Knockapi::Recipients::OneSignalChannelData,
+              Knockapi::Recipients::SlackChannelData,
+              Knockapi::Recipients::MsTeamsChannelData,
+              Knockapi::Recipients::DiscordChannelData
+            )
+          end
+        end
+      end
+
+      # @type [Knockapi::Internal::Type::Converter]
+      InlineChannelDataRequest =
+        Knockapi::Internal::Type::HashOf[union: -> { Knockapi::Recipients::InlineChannelDataRequestItem }]
+    end
+  end
+end

data/lib/knockapi/models/recipients/inline_preference_set_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      # @type [Knockapi::Internal::Type::Converter]
+      InlinePreferenceSetRequest =
+        Knockapi::Internal::Type::HashOf[-> { Knockapi::Recipients::PreferenceSetRequest }]
+    end
+  end
+end

data/lib/knockapi/models/recipients/ms_teams_channel_data.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class MsTeamsChannelData < Knockapi::Internal::Type::BaseModel
+        # @!attribute connections
+        #   List of Microsoft Teams connections.
+        #
+        #   @return [Array<Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>]
+        required :connections,
+                 -> {
+                   Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::MsTeamsChannelData::Connection]
+                 }
+
+        # @!attribute ms_teams_tenant_id
+        #   Microsoft Teams tenant ID.
+        #
+        #   @return [String, nil]
+        optional :ms_teams_tenant_id, String, nil?: true
+
+        # @!method initialize(connections:, ms_teams_tenant_id: nil)
+        #   Microsoft Teams channel connection.
+        #
+        #   @param connections [Array<Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>] List of Microsoft Teams connections.
+        #
+        #   @param ms_teams_tenant_id [String, nil] Microsoft Teams tenant ID.
+
+        # Microsoft Teams token connection.
+        module Connection
+          extend Knockapi::Internal::Type::Union
+
+          # Microsoft Teams token connection.
+          variant -> { Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection }
+
+          # Microsoft Teams incoming webhook connection.
+          variant -> {
+            Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
+          }
+
+          class MsTeamsTokenConnection < Knockapi::Internal::Type::BaseModel
+            # @!attribute ms_teams_channel_id
+            #   Microsoft Teams channel ID.
+            #
+            #   @return [String, nil]
+            optional :ms_teams_channel_id, String, nil?: true
+
+            # @!attribute ms_teams_team_id
+            #   Microsoft Teams team ID.
+            #
+            #   @return [String, nil]
+            optional :ms_teams_team_id, String, nil?: true
+
+            # @!attribute ms_teams_tenant_id
+            #   Microsoft Teams tenant ID.
+            #
+            #   @return [String, nil]
+            optional :ms_teams_tenant_id, String, nil?: true
+
+            # @!attribute ms_teams_user_id
+            #   Microsoft Teams user ID.
+            #
+            #   @return [String, nil]
+            optional :ms_teams_user_id, String, nil?: true
+
+            # @!method initialize(ms_teams_channel_id: nil, ms_teams_team_id: nil, ms_teams_tenant_id: nil, ms_teams_user_id: nil)
+            #   Microsoft Teams token connection.
+            #
+            #   @param ms_teams_channel_id [String, nil] Microsoft Teams channel ID.
+            #
+            #   @param ms_teams_team_id [String, nil] Microsoft Teams team ID.
+            #
+            #   @param ms_teams_tenant_id [String, nil] Microsoft Teams tenant ID.
+            #
+            #   @param ms_teams_user_id [String, nil] Microsoft Teams user ID.
+          end
+
+          class MsTeamsIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            # @!attribute incoming_webhook
+            #   Microsoft Teams incoming webhook.
+            #
+            #   @return [Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook]
+            required :incoming_webhook,
+                     -> {
+                       Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook
+                     }
+
+            # @!method initialize(incoming_webhook:)
+            #   Microsoft Teams incoming webhook connection.
+            #
+            #   @param incoming_webhook [Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook] Microsoft Teams incoming webhook.
+
+            # @see Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection#incoming_webhook
+            class IncomingWebhook < Knockapi::Internal::Type::BaseModel
+              # @!attribute url
+              #   Microsoft Teams incoming webhook URL.
+              #
+              #   @return [String]
+              required :url, String
+
+              # @!method initialize(url:)
+              #   Microsoft Teams incoming webhook.
+              #
+              #   @param url [String] Microsoft Teams incoming webhook URL.
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
+                Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/recipients/one_signal_channel_data.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class OneSignalChannelData < Knockapi::Internal::Type::BaseModel
+        # @!attribute player_ids
+        #   A list of OneSignal player IDs.
+        #
+        #   @return [Array<String>]
+        required :player_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(player_ids:)
+        #   OneSignal channel data.
+        #
+        #   @param player_ids [Array<String>] A list of OneSignal player IDs.
+      end
+    end
+  end
+end

data/lib/knockapi/models/recipients/preference_set.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSet < Knockapi::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the preference set.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute categories
+        #   An object where the key is the category and the values are the preference
+        #   settings for that category.
+        #
+        #   @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
+        optional :categories,
+                 -> {
+                   Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Category]
+                 },
+                 nil?: true
+
+        # @!attribute channel_types
+        #   Channel type preferences.
+        #
+        #   @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
+        optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+        # @!attribute workflows
+        #   An object where the key is the workflow key and the values are the preference
+        #   settings for that workflow.
+        #
+        #   @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
+        optional :workflows,
+                 -> {
+                   Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Workflow]
+                 },
+                 nil?: true
+
+        # @!method initialize(id:, categories: nil, channel_types: nil, workflows: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Recipients::PreferenceSet} for more details.
+        #
+        #   A preference set represents a specific set of notification preferences for a
+        #   recipient. A recipient can have multiple preference sets.
+        #
+        #   @param id [String] Unique identifier for the preference set.
+        #
+        #   @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
+        #
+        #   @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+        #
+        #   @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
+
+        # Workflow or category preferences within a preference set
+        module Category
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # The settings object for a workflow or category, where you can specify channel types or conditions.
+          variant -> {
+            Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
+          }
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            # @!attribute channel_types
+            #   Channel type preferences.
+            #
+            #   @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
+            optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+            # @!attribute conditions
+            #   A list of conditions to apply to a channel type.
+            #
+            #   @return [Array<Knockapi::Condition>, nil]
+            optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
+
+            # @!method initialize(channel_types: nil, conditions: nil)
+            #   The settings object for a workflow or category, where you can specify channel
+            #   types or conditions.
+            #
+            #   @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+            #
+            #   @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
+          end
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
+              )
+            end
+          end
+        end
+
+        # Workflow or category preferences within a preference set
+        module Workflow
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # The settings object for a workflow or category, where you can specify channel types or conditions.
+          variant -> {
+            Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
+          }
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            # @!attribute channel_types
+            #   Channel type preferences.
+            #
+            #   @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
+            optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+            # @!attribute conditions
+            #   A list of conditions to apply to a channel type.
+            #
+            #   @return [Array<Knockapi::Condition>, nil]
+            optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
+
+            # @!method initialize(channel_types: nil, conditions: nil)
+            #   The settings object for a workflow or category, where you can specify channel
+            #   types or conditions.
+            #
+            #   @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+            #
+            #   @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
+          end
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSetChannelTypeSetting < Knockapi::Internal::Type::BaseModel
+        # @!attribute conditions
+        #   A list of conditions to apply to a channel type.
+        #
+        #   @return [Array<Knockapi::Condition>]
+        required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
+
+        # @!method initialize(conditions:)
+        #   A set of settings for a channel type. Currently, this can only be a list of
+        #   conditions to apply.
+        #
+        #   @param conditions [Array<Knockapi::Condition>] A list of conditions to apply to a channel type.
+      end
+    end
+  end
+end

data/lib/knockapi/models/recipients/preference_set_channel_types.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSetChannelTypes < Knockapi::Internal::Type::BaseModel
+        # @!attribute chat
+        #   Whether the channel type is enabled for the preference set.
+        #
+        #   @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
+        optional :chat, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Chat }
+
+        # @!attribute email
+        #   Whether the channel type is enabled for the preference set.
+        #
+        #   @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
+        optional :email, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Email }
+
+        # @!attribute http
+        #   Whether the channel type is enabled for the preference set.
+        #
+        #   @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
+        optional :http, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::HTTP }
+
+        # @!attribute in_app_feed
+        #   Whether the channel type is enabled for the preference set.
+        #
+        #   @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
+        optional :in_app_feed, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::InAppFeed }
+
+        # @!attribute push
+        #   Whether the channel type is enabled for the preference set.
+        #
+        #   @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
+        optional :push, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Push }
+
+        # @!attribute sms
+        #   Whether the channel type is enabled for the preference set.
+        #
+        #   @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
+        optional :sms, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::SMS }
+
+        # @!method initialize(chat: nil, email: nil, http: nil, in_app_feed: nil, push: nil, sms: nil)
+        #   Channel type preferences.
+        #
+        #   @param chat [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
+        #
+        #   @param email [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
+        #
+        #   @param http [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
+        #
+        #   @param in_app_feed [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
+        #
+        #   @param push [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
+        #
+        #   @param sms [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
+
+        # Whether the channel type is enabled for the preference set.
+        #
+        # @see Knockapi::Recipients::PreferenceSetChannelTypes#chat
+        module Chat
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
+          variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        #
+        # @see Knockapi::Recipients::PreferenceSetChannelTypes#email
+        module Email
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
+          variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        #
+        # @see Knockapi::Recipients::PreferenceSetChannelTypes#http
+        module HTTP
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
+          variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        #
+        # @see Knockapi::Recipients::PreferenceSetChannelTypes#in_app_feed
+        module InAppFeed
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
+          variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        #
+        # @see Knockapi::Recipients::PreferenceSetChannelTypes#push
+        module Push
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
+          variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        #
+        # @see Knockapi::Recipients::PreferenceSetChannelTypes#sms
+        module SMS
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
+          variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
+          end
+        end
+      end
+    end
+  end
+end