knockapi 1.0.0 → 1.1.0

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

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Recipients
       class PreferenceSet < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::PreferenceSet,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # Unique identifier for the preference set.
         sig { returns(String) }
         attr_accessor :id
@@ -17,7 +25,7 @@ module Knockapi
                 Symbol,
                 T.any(
                   T::Boolean,
-                  Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
+                  Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
                 )
               ]
             )
@@ -26,14 +34,16 @@ module Knockapi
         attr_accessor :categories
 
         # Channel type preferences.
-        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+        sig do
+          returns(T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes))
+        end
         attr_reader :channel_types
 
         sig do
           params(
-            channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
-          )
-            .void
+            channel_types:
+              T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes::OrHash)
+          ).void
         end
         attr_writer :channel_types
 
@@ -46,7 +56,7 @@ module Knockapi
                 Symbol,
                 T.any(
                   T::Boolean,
-                  Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
+                  Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
                 )
               ]
             )
@@ -59,29 +69,31 @@ module Knockapi
         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)
+            categories:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::OrHash
+                  )
+                ]
+              ),
+            channel_types:
+              T.nilable(
+                Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+              ),
+            workflows:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::OrHash
+                  )
+                ]
+              )
+          ).returns(T.attached_class)
         end
         def self.new(
           # Unique identifier for the preference set.
@@ -94,148 +106,207 @@ module Knockapi
           # An object where the key is the workflow key and the values are the preference
           # settings for that workflow.
           workflows: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                id: String,
-                categories: T.nilable(
+          override.returns(
+            {
+              id: String,
+              categories:
+                T.nilable(
                   T::Hash[
                     Symbol,
                     T.any(
                       T::Boolean,
-                      Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
+                      Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
                     )
                   ]
                 ),
-                channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
-                workflows: T.nilable(
+              channel_types:
+                T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes),
+              workflows:
+                T.nilable(
                   T::Hash[
                     Symbol,
                     T.any(
                       T::Boolean,
-                      Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
+                      Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
                     )
                   ]
                 )
-              }
-            )
+            }
+          )
+        end
+        def to_hash
         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::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
+              )
+            end
+
           class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
             # Channel type preferences.
-            sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+            sig do
+              returns(
+                T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes)
+              )
+            end
             attr_reader :channel_types
 
             sig do
               params(
-                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
-              )
-                .void
+                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::Models::Condition])) }
+            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(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)
+                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
+            )
+            end
+
             sig do
-              override
-                .returns(
-                  {
-                    channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
-                    conditions: T.nilable(T::Array[Knockapi::Models::Condition])
-                  }
-                )
+              override.returns(
+                {
+                  channel_types:
+                    T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes),
+                  conditions: T.nilable(T::Array[Knockapi::Condition])
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
           end
 
           sig do
-            override
-              .returns(
-                [T::Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject]
-              )
+            override.returns(
+              T::Array[Knockapi::Recipients::PreferenceSet::Category::Variants]
+            )
+          end
+          def self.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::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
+              )
+            end
+
           class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
             # Channel type preferences.
-            sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+            sig do
+              returns(
+                T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes)
+              )
+            end
             attr_reader :channel_types
 
             sig do
               params(
-                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
-              )
-                .void
+                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::Models::Condition])) }
+            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(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)
+                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
+            )
+            end
+
             sig do
-              override
-                .returns(
-                  {
-                    channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
-                    conditions: T.nilable(T::Array[Knockapi::Models::Condition])
-                  }
-                )
+              override.returns(
+                {
+                  channel_types:
+                    T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes),
+                  conditions: T.nilable(T::Array[Knockapi::Condition])
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
           end
 
           sig do
-            override
-              .returns(
-                [T::Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject]
-              )
+            override.returns(
+              T::Array[Knockapi::Recipients::PreferenceSet::Workflow::Variants]
+            )
+          end
+          def self.variants
           end
-          def self.variants; end
         end
       end
     end

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

@@ -4,22 +4,34 @@ module Knockapi
   module Models
     module Recipients
       class PreferenceSetChannelTypeSetting < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::PreferenceSetChannelTypeSetting,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # A list of conditions to apply to a channel type.
-        sig { returns(T::Array[Knockapi::Models::Condition]) }
+        sig { returns(T::Array[Knockapi::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)
+          params(conditions: T::Array[Knockapi::Condition::OrHash]).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
+
+        sig { override.returns({ conditions: T::Array[Knockapi::Condition] }) }
+        def to_hash
+        end
       end
     end
   end