knockapi 1.0.0 → 1.2.0

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

@@ -4,6 +4,14 @@ 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
@@ -13,7 +21,7 @@ module Knockapi
                 Symbol,
                 T.any(
                   T::Boolean,
-                  Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+                  Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
                 )
               ]
             )
@@ -22,14 +30,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
 
@@ -42,7 +52,7 @@ module Knockapi
                 Symbol,
                 T.any(
                   T::Boolean,
-                  Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+                  Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
                 )
               ]
             )
@@ -53,29 +63,31 @@ module Knockapi
         # A request to set a preference set for a recipient.
         sig do
           params(
-            categories: T.nilable(
-              T::Hash[
-                Symbol,
-                T.any(
-                  T::Boolean,
-                  Knockapi::Models::Recipients::PreferenceSetRequest::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::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject,
-                  Knockapi::Internal::AnyHash
-                )
-              ]
-            )
-          )
-            .returns(T.attached_class)
+            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
@@ -86,147 +98,210 @@ 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(
-              {
-                categories: T.nilable(
+          override.returns(
+            {
+              categories:
+                T.nilable(
                   T::Hash[
                     Symbol,
                     T.any(
                       T::Boolean,
-                      Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+                      Knockapi::Recipients::PreferenceSetRequest::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::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+                      Knockapi::Recipients::PreferenceSetRequest::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::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 { 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::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject]
-              )
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetRequest::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::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 { 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::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject]
-              )
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetRequest::Workflow::Variants
+              ]
+            )
+          end
+          def self.variants
           end
-          def self.variants; end
         end
       end
     end

data/rbi/knockapi/models/recipients/push_channel_data.rbi

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Recipients
       class PushChannelData < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::PushChannelData,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # A list of push channel tokens.
         sig { returns(T::Array[String]) }
         attr_accessor :tokens
@@ -13,9 +21,12 @@ module Knockapi
         def self.new(
           # A list of push channel tokens.
           tokens:
-        ); end
-        sig { override.returns({tokens: T::Array[String]}) }
-        def to_hash; end
+        )
+        end
+
+        sig { override.returns({ tokens: T::Array[String] }) }
+        def to_hash
+        end
       end
     end
   end

data/rbi/knockapi/models/recipients/slack_channel_data.rbi

@@ -4,13 +4,21 @@ module Knockapi
   module Models
     module Recipients
       class SlackChannelData < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::SlackChannelData,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # List of Slack channel connections.
         sig do
           returns(
             T::Array[
               T.any(
-                Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection,
-                Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+                Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
               )
             ]
           )
@@ -18,58 +26,79 @@ module Knockapi
         attr_accessor :connections
 
         # A Slack connection token.
-        sig { returns(T.nilable(Knockapi::Models::Recipients::SlackChannelData::Token)) }
+        sig do
+          returns(T.nilable(Knockapi::Recipients::SlackChannelData::Token))
+        end
         attr_reader :token
 
         sig do
           params(
-            token: T.nilable(T.any(Knockapi::Models::Recipients::SlackChannelData::Token, Knockapi::Internal::AnyHash))
-          )
-            .void
+            token:
+              T.nilable(Knockapi::Recipients::SlackChannelData::Token::OrHash)
+          ).void
         end
         attr_writer :token
 
         # Slack channel data
         sig do
           params(
-            connections: T::Array[
-              T.any(
-                Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection,
-                Knockapi::Internal::AnyHash,
-                Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
-              )
-            ],
-            token: T.nilable(T.any(Knockapi::Models::Recipients::SlackChannelData::Token, Knockapi::Internal::AnyHash))
-          )
-            .returns(T.attached_class)
+            connections:
+              T::Array[
+                T.any(
+                  Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection::OrHash,
+                  Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection::OrHash
+                )
+              ],
+            token:
+              T.nilable(Knockapi::Recipients::SlackChannelData::Token::OrHash)
+          ).returns(T.attached_class)
         end
         def self.new(
           # List of Slack channel connections.
           connections:,
           # A Slack connection token.
           token: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                connections: T::Array[
+          override.returns(
+            {
+              connections:
+                T::Array[
                   T.any(
-                    Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection,
-                    Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+                    Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                    Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
                   )
                 ],
-                token: T.nilable(Knockapi::Models::Recipients::SlackChannelData::Token)
-              }
-            )
+              token: T.nilable(Knockapi::Recipients::SlackChannelData::Token)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         # A Slack connection, either an access token or an incoming webhook
         module Connection
           extend Knockapi::Internal::Type::Union
 
+          Variants =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+              )
+            end
+
           class SlackTokenConnection < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
             # A Slack access token.
             sig { returns(T.nilable(String)) }
             attr_accessor :access_token
@@ -88,8 +117,7 @@ module Knockapi
                 access_token: T.nilable(String),
                 channel_id: T.nilable(String),
                 user_id: T.nilable(String)
-              )
-                .returns(T.attached_class)
+              ).returns(T.attached_class)
             end
             def self.new(
               # A Slack access token.
@@ -98,19 +126,31 @@ module Knockapi
               channel_id: nil,
               # A Slack user ID from the Slack provider.
               user_id: nil
-            ); end
+            )
+            end
+
             sig do
-              override
-                .returns({
-                           access_token: T.nilable(String),
-                           channel_id: T.nilable(String),
-                           user_id: T.nilable(String)
-                         })
+              override.returns(
+                {
+                  access_token: T.nilable(String),
+                  channel_id: T.nilable(String),
+                  user_id: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
           end
 
           class SlackIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
             # The URL of the incoming webhook for a Slack connection.
             sig { returns(String) }
             attr_accessor :url
@@ -120,33 +160,51 @@ module Knockapi
             def self.new(
               # The URL of the incoming webhook for a Slack connection.
               url:
-            ); end
-            sig { override.returns({url: String}) }
-            def to_hash; end
+            )
+            end
+
+            sig { override.returns({ url: String }) }
+            def to_hash
+            end
           end
 
           sig do
-            override
-              .returns(
-                [Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection]
-              )
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::SlackChannelData::Connection::Variants
+              ]
+            )
+          end
+          def self.variants
           end
-          def self.variants; end
         end
 
         class Token < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::SlackChannelData::Token,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
           # A Slack access token.
           sig { returns(T.nilable(String)) }
           attr_accessor :access_token
 
           # A Slack connection token.
-          sig { params(access_token: T.nilable(String)).returns(T.attached_class) }
+          sig do
+            params(access_token: T.nilable(String)).returns(T.attached_class)
+          end
           def self.new(
             # A Slack access token.
             access_token:
-          ); end
-          sig { override.returns({access_token: T.nilable(String)}) }
-          def to_hash; end
+          )
+          end
+
+          sig { override.returns({ access_token: T.nilable(String) }) }
+          def to_hash
+          end
         end
       end
     end