knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/recipients/preference_set.rbi

@@ -0,0 +1,243 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSet < Knockapi::Internal::Type::BaseModel
+        # Unique identifier for the preference set.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # An object where the key is the category and the values are the preference
+        # settings for that category.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
+                )
+              ]
+            )
+          )
+        end
+        attr_accessor :categories
+
+        # Channel type preferences.
+        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+        attr_reader :channel_types
+
+        sig do
+          params(
+            channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
+          )
+            .void
+        end
+        attr_writer :channel_types
+
+        # An object where the key is the workflow key and the values are the preference
+        # settings for that workflow.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
+                )
+              ]
+            )
+          )
+        end
+        attr_accessor :workflows
+
+        # A preference set represents a specific set of notification preferences for a
+        # recipient. A recipient can have multiple preference sets.
+        sig do
+          params(
+            id: String,
+            categories: T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject,
+                  Knockapi::Internal::AnyHash
+                )
+              ]
+            ),
+            channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash)),
+            workflows: T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject,
+                  Knockapi::Internal::AnyHash
+                )
+              ]
+            )
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the preference set.
+          id:,
+          # An object where the key is the category and the values are the preference
+          # settings for that category.
+          categories: nil,
+          # Channel type preferences.
+          channel_types: nil,
+          # An object where the key is the workflow key and the values are the preference
+          # settings for that workflow.
+          workflows: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                categories: T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
+                    )
+                  ]
+                ),
+                channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
+                workflows: T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
+                    )
+                  ]
+                )
+              }
+            )
+        end
+        def to_hash; end
+
+        # Workflow or category preferences within a preference set
+        module Category
+          extend Knockapi::Internal::Type::Union
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            # Channel type preferences.
+            sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+            attr_reader :channel_types
+
+            sig do
+              params(
+                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
+              )
+                .void
+            end
+            attr_writer :channel_types
+
+            # A list of conditions to apply to a channel type.
+            sig { returns(T.nilable(T::Array[Knockapi::Models::Condition])) }
+            attr_accessor :conditions
+
+            # The settings object for a workflow or category, where you can specify channel
+            # types or conditions.
+            sig do
+              params(
+                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash)),
+                conditions: T.nilable(T::Array[T.any(Knockapi::Models::Condition, Knockapi::Internal::AnyHash)])
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              # Channel type preferences.
+              channel_types: nil,
+              # A list of conditions to apply to a channel type.
+              conditions: nil
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
+                    conditions: T.nilable(T::Array[Knockapi::Models::Condition])
+                  }
+                )
+            end
+            def to_hash; end
+          end
+
+          sig do
+            override
+              .returns(
+                [T::Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject]
+              )
+          end
+          def self.variants; end
+        end
+
+        # Workflow or category preferences within a preference set
+        module Workflow
+          extend Knockapi::Internal::Type::Union
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            # Channel type preferences.
+            sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+            attr_reader :channel_types
+
+            sig do
+              params(
+                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
+              )
+                .void
+            end
+            attr_writer :channel_types
+
+            # A list of conditions to apply to a channel type.
+            sig { returns(T.nilable(T::Array[Knockapi::Models::Condition])) }
+            attr_accessor :conditions
+
+            # The settings object for a workflow or category, where you can specify channel
+            # types or conditions.
+            sig do
+              params(
+                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash)),
+                conditions: T.nilable(T::Array[T.any(Knockapi::Models::Condition, Knockapi::Internal::AnyHash)])
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              # Channel type preferences.
+              channel_types: nil,
+              # A list of conditions to apply to a channel type.
+              conditions: nil
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
+                    conditions: T.nilable(T::Array[Knockapi::Models::Condition])
+                  }
+                )
+            end
+            def to_hash; end
+          end
+
+          sig do
+            override
+              .returns(
+                [T::Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject]
+              )
+          end
+          def self.variants; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSetChannelTypeSetting < Knockapi::Internal::Type::BaseModel
+        # A list of conditions to apply to a channel type.
+        sig { returns(T::Array[Knockapi::Models::Condition]) }
+        attr_accessor :conditions
+
+        # A set of settings for a channel type. Currently, this can only be a list of
+        # conditions to apply.
+        sig do
+          params(conditions: T::Array[T.any(Knockapi::Models::Condition, Knockapi::Internal::AnyHash)])
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A list of conditions to apply to a channel type.
+          conditions:
+        ); end
+        sig { override.returns({conditions: T::Array[Knockapi::Models::Condition]}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi

@@ -0,0 +1,218 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSetChannelTypes < Knockapi::Internal::Type::BaseModel
+        # Whether the channel type is enabled for the preference set.
+        sig { returns(T.nilable(T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting))) }
+        attr_reader :chat
+
+        sig do
+          params(
+            chat: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            )
+          )
+            .void
+        end
+        attr_writer :chat
+
+        # Whether the channel type is enabled for the preference set.
+        sig { returns(T.nilable(T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting))) }
+        attr_reader :email
+
+        sig do
+          params(
+            email: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            )
+          )
+            .void
+        end
+        attr_writer :email
+
+        # Whether the channel type is enabled for the preference set.
+        sig { returns(T.nilable(T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting))) }
+        attr_reader :http
+
+        sig do
+          params(
+            http: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            )
+          )
+            .void
+        end
+        attr_writer :http
+
+        # Whether the channel type is enabled for the preference set.
+        sig { returns(T.nilable(T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting))) }
+        attr_reader :in_app_feed
+
+        sig do
+          params(
+            in_app_feed: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            )
+          )
+            .void
+        end
+        attr_writer :in_app_feed
+
+        # Whether the channel type is enabled for the preference set.
+        sig { returns(T.nilable(T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting))) }
+        attr_reader :push
+
+        sig do
+          params(
+            push: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            )
+          )
+            .void
+        end
+        attr_writer :push
+
+        # Whether the channel type is enabled for the preference set.
+        sig { returns(T.nilable(T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting))) }
+        attr_reader :sms
+
+        sig do
+          params(
+            sms: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            )
+          )
+            .void
+        end
+        attr_writer :sms
+
+        # Channel type preferences.
+        sig do
+          params(
+            chat: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            ),
+            email: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            ),
+            http: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            ),
+            in_app_feed: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            ),
+            push: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            ),
+            sms: T.any(
+              T::Boolean,
+              Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            )
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # Whether the channel type is enabled for the preference set.
+          chat: nil,
+          # Whether the channel type is enabled for the preference set.
+          email: nil,
+          # Whether the channel type is enabled for the preference set.
+          http: nil,
+          # Whether the channel type is enabled for the preference set.
+          in_app_feed: nil,
+          # Whether the channel type is enabled for the preference set.
+          push: nil,
+          # Whether the channel type is enabled for the preference set.
+          sms: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                chat: T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting),
+                email: T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting),
+                http: T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting),
+                in_app_feed: T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting),
+                push: T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting),
+                sms: T.any(T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)
+              }
+            )
+        end
+        def to_hash; end
+
+        # Whether the channel type is enabled for the preference set.
+        module Chat
+          extend Knockapi::Internal::Type::Union
+
+          sig { override.returns([T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting]) }
+          def self.variants; end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module Email
+          extend Knockapi::Internal::Type::Union
+
+          sig { override.returns([T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting]) }
+          def self.variants; end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module HTTP
+          extend Knockapi::Internal::Type::Union
+
+          sig { override.returns([T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting]) }
+          def self.variants; end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module InAppFeed
+          extend Knockapi::Internal::Type::Union
+
+          sig { override.returns([T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting]) }
+          def self.variants; end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module Push
+          extend Knockapi::Internal::Type::Union
+
+          sig { override.returns([T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting]) }
+          def self.variants; end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module SMS
+          extend Knockapi::Internal::Type::Union
+
+          sig { override.returns([T::Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting]) }
+          def self.variants; end
+        end
+      end
+    end
+  end
+end