knockapi 0.6.1 → 1.1.0

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

@@ -0,0 +1,389 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSetChannelTypes < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::PreferenceSetChannelTypes,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # Whether the channel type is enabled for the preference set.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            )
+          )
+        end
+        attr_reader :chat
+
+        sig do
+          params(
+            chat:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              )
+          ).void
+        end
+        attr_writer :chat
+
+        # Whether the channel type is enabled for the preference set.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            )
+          )
+        end
+        attr_reader :email
+
+        sig do
+          params(
+            email:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              )
+          ).void
+        end
+        attr_writer :email
+
+        # Whether the channel type is enabled for the preference set.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            )
+          )
+        end
+        attr_reader :http
+
+        sig do
+          params(
+            http:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              )
+          ).void
+        end
+        attr_writer :http
+
+        # Whether the channel type is enabled for the preference set.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            )
+          )
+        end
+        attr_reader :in_app_feed
+
+        sig do
+          params(
+            in_app_feed:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              )
+          ).void
+        end
+        attr_writer :in_app_feed
+
+        # Whether the channel type is enabled for the preference set.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            )
+          )
+        end
+        attr_reader :push
+
+        sig do
+          params(
+            push:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              )
+          ).void
+        end
+        attr_writer :push
+
+        # Whether the channel type is enabled for the preference set.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            )
+          )
+        end
+        attr_reader :sms
+
+        sig do
+          params(
+            sms:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              )
+          ).void
+        end
+        attr_writer :sms
+
+        # Channel type preferences.
+        sig do
+          params(
+            chat:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              ),
+            email:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              ),
+            http:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              ),
+            in_app_feed:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              ),
+            push:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              ),
+            sms:
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting::OrHash
+              )
+          ).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::Recipients::PreferenceSetChannelTypeSetting
+                ),
+              email:
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetChannelTypeSetting
+                ),
+              http:
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetChannelTypeSetting
+                ),
+              in_app_feed:
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetChannelTypeSetting
+                ),
+              push:
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetChannelTypeSetting
+                ),
+              sms:
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetChannelTypeSetting
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module Chat
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetChannelTypes::Chat::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module Email
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetChannelTypes::Email::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module HTTP
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetChannelTypes::HTTP::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module InAppFeed
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetChannelTypes::InAppFeed::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module Push
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetChannelTypes::Push::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # Whether the channel type is enabled for the preference set.
+        module SMS
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetChannelTypeSetting
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetChannelTypes::SMS::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipients/preference_set_request.rbi

@@ -0,0 +1,309 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSetRequest < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::PreferenceSetRequest,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # 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::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+                )
+              ]
+            )
+          )
+        end
+        attr_accessor :categories
+
+        # Channel type preferences.
+        sig do
+          returns(T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes))
+        end
+        attr_reader :channel_types
+
+        sig do
+          params(
+            channel_types:
+              T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes::OrHash)
+          ).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::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+                )
+              ]
+            )
+          )
+        end
+        attr_accessor :workflows
+
+        # A request to set a preference set for a recipient.
+        sig do
+          params(
+            categories:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::OrHash
+                  )
+                ]
+              ),
+            channel_types:
+              T.nilable(
+                Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+              ),
+            workflows:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::OrHash
+                  )
+                ]
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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(
+            {
+              categories:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+                    )
+                  ]
+                ),
+              channel_types:
+                T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes),
+              workflows:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+                    )
+                  ]
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Workflow or category preferences within a preference set
+        module Category
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+              )
+            end
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
+            # Channel type preferences.
+            sig do
+              returns(
+                T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes)
+              )
+            end
+            attr_reader :channel_types
+
+            sig do
+              params(
+                channel_types:
+                  T.nilable(
+                    Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                  )
+              ).void
+            end
+            attr_writer :channel_types
+
+            # A list of conditions to apply to a channel type.
+            sig { returns(T.nilable(T::Array[Knockapi::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(
+                    Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                  ),
+                conditions: T.nilable(T::Array[Knockapi::Condition::OrHash])
+              ).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::Recipients::PreferenceSetChannelTypes),
+                  conditions: T.nilable(T::Array[Knockapi::Condition])
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetRequest::Category::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # Workflow or category preferences within a preference set
+        module Workflow
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+              )
+            end
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
+            # Channel type preferences.
+            sig do
+              returns(
+                T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes)
+              )
+            end
+            attr_reader :channel_types
+
+            sig do
+              params(
+                channel_types:
+                  T.nilable(
+                    Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                  )
+              ).void
+            end
+            attr_writer :channel_types
+
+            # A list of conditions to apply to a channel type.
+            sig { returns(T.nilable(T::Array[Knockapi::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(
+                    Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                  ),
+                conditions: T.nilable(T::Array[Knockapi::Condition::OrHash])
+              ).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::Recipients::PreferenceSetChannelTypes),
+                  conditions: T.nilable(T::Array[Knockapi::Condition])
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetRequest::Workflow::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end