knockapi 1.1.0 → 1.2.0

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

@@ -79,15 +79,6 @@ module Knockapi
 
           # @!method self.variants
           #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
-
-          define_sorbet_constant!(:Variants) do
-            T.type_alias do
-              T.any(
-                T::Boolean,
-                Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
-              )
-            end
-          end
         end
 
         # Workflow or category preferences within a preference set
@@ -125,15 +116,6 @@ module Knockapi
 
           # @!method self.variants
           #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)]
-
-          define_sorbet_constant!(:Variants) do
-            T.type_alias do
-              T.any(
-                T::Boolean,
-                Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
-              )
-            end
-          end
         end
       end
     end

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

@@ -80,15 +80,6 @@ module Knockapi
 
           # @!method self.variants
           #   @return [Array(Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection)]
-
-          define_sorbet_constant!(:Variants) do
-            T.type_alias do
-              T.any(
-                Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
-                Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
-              )
-            end
-          end
         end
 
         # @see Knockapi::Recipients::SlackChannelData#token

data/lib/knockapi/models/user_list_messages_params.rb

@@ -138,10 +138,13 @@ module Knockapi
         extend Knockapi::Internal::Type::Enum
 
         SEEN = :seen
+        UNSEEN = :unseen
         READ = :read
-        INTERACTED = :interacted
-        LINK_CLICKED = :link_clicked
+        UNREAD = :unread
         ARCHIVED = :archived
+        UNARCHIVED = :unarchived
+        LINK_CLICKED = :link_clicked
+        INTERACTED = :interacted
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/knockapi/models/users/feed_list_items_response.rb

@@ -288,15 +288,6 @@ module Knockapi
 
           # @!method self.variants
           #   @return [Array(Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock)]
-
-          define_sorbet_constant!(:Variants) do
-            T.type_alias do
-              T.any(
-                Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock,
-                Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock
-              )
-            end
-          end
         end
 
         # @see Knockapi::Models::Users::FeedListItemsResponse#source

data/lib/knockapi/models.rb

@@ -5,29 +5,40 @@ module Knockapi
     cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Knockapi::Internal::AnyHash) } }
   end
 
-  [
-    *Knockapi::Internal::Type::Enum.included_modules,
-    *Knockapi::Internal::Type::Union.included_modules
-  ].each do |cls|
-    cls.constants.each do |name|
-      case cls.const_get(name)
-      in true | false
-        cls.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, cls) } }
-        cls.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
-      in Integer
-        cls.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, cls) } }
-        cls.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
-      in Float
-        cls.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, cls) } }
-        cls.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
-      in Symbol
-        cls.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, cls) } }
-        cls.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
-      else
+  Knockapi::Internal::Util.walk_namespaces(Knockapi::Models).each do |mod|
+    case mod
+    in Knockapi::Internal::Type::Enum | Knockapi::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
       end
+    else
     end
   end
 
+  Knockapi::Internal::Util.walk_namespaces(Knockapi::Models)
+                          .lazy
+                          .grep(Knockapi::Internal::Type::Union)
+                          .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
   Activity = Knockapi::Models::Activity
 
   AudienceAddMembersParams = Knockapi::Models::AudienceAddMembersParams

data/lib/knockapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/rbi/knockapi/internal/type/array_of.rbi

@@ -8,6 +8,7 @@ module Knockapi
       # Array of items of a given type.
       class ArrayOf
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -63,6 +64,11 @@ module Knockapi
         def dump(value, state:)
         end
 
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
         # @api private
         sig { returns(Elem) }
         protected def item_type

data/rbi/knockapi/internal/type/base_model.rbi

@@ -197,6 +197,11 @@ module Knockapi
           end
           def dump(value, state:)
           end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
 
         class << self

data/rbi/knockapi/internal/type/boolean.rbi

@@ -8,6 +8,7 @@ module Knockapi
       # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -43,6 +44,11 @@ module Knockapi
           end
           def dump(value, state:)
           end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
       end
     end

data/rbi/knockapi/internal/type/enum.rbi

@@ -67,6 +67,11 @@ module Knockapi
         def dump(value, state:)
         end
 
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
         # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)

data/rbi/knockapi/internal/type/file_input.rbi

@@ -47,6 +47,11 @@ module Knockapi
           end
           def dump(value, state:)
           end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
       end
     end

data/rbi/knockapi/internal/type/hash_of.rbi

@@ -8,6 +8,7 @@ module Knockapi
       # Hash of items of a given type.
       class HashOf
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -63,6 +64,11 @@ module Knockapi
         def dump(value, state:)
         end
 
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
         # @api private
         sig { returns(Elem) }
         protected def item_type

data/rbi/knockapi/internal/type/union.rbi

@@ -101,6 +101,11 @@ module Knockapi
         def dump(value, state:)
         end
 
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
         # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)

data/rbi/knockapi/internal/type/unknown.rbi

@@ -8,6 +8,7 @@ module Knockapi
       # When we don't know what to expect for the value.
       class Unknown
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -43,6 +44,11 @@ module Knockapi
           end
           def dump(value, state:)
           end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
       end
     end

data/rbi/knockapi/internal/util.rbi

@@ -11,6 +11,15 @@ module Knockapi
       def self.monotonic_secs
       end
 
+      # @api private
+      sig do
+        params(ns: T.any(Module, T::Class[T.anything])).returns(
+          T::Enumerable[T.any(Module, T::Class[T.anything])]
+        )
+      end
+      def self.walk_namespaces(ns)
+      end
+
       class << self
         # @api private
         sig { returns(String) }
@@ -441,10 +450,35 @@ module Knockapi
         def const_missing(name)
         end
 
+        # @api private
+        sig { params(name: Symbol).returns(T::Boolean) }
+        def sorbet_constant_defined?(name)
+        end
+
         # @api private
         sig { params(name: Symbol, blk: T.proc.returns(T.anything)).void }
         def define_sorbet_constant!(name, &blk)
         end
+
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
+        class << self
+          # @api private
+          sig do
+            params(
+              type:
+                T.any(
+                  Knockapi::Internal::Util::SorbetRuntimeSupport,
+                  T.anything
+                )
+            ).returns(T.anything)
+          end
+          def to_sorbet_type(type)
+          end
+        end
       end
     end
   end

data/rbi/knockapi/internal.rbi

@@ -8,6 +8,9 @@ module Knockapi
     # this alias might be refined in the future.
     AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
 
+    FileInput =
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Knockapi::FilePart) }
+
     OMIT = T.let(Object.new.freeze, T.anything)
   end
 end

data/rbi/knockapi/models/activity.rbi

@@ -21,7 +21,7 @@ module Knockapi
       attr_writer :_typename
 
       # A recipient of a notification, which is either a user or an object.
-      sig { returns(T.nilable(T.any(Knockapi::User, Knockapi::Object))) }
+      sig { returns(T.nilable(Knockapi::Recipient::Variants)) }
       attr_accessor :actor
 
       # The workflow trigger `data` payload associated with the activity.
@@ -36,7 +36,7 @@ module Knockapi
       attr_writer :inserted_at
 
       # A recipient of a notification, which is either a user or an object.
-      sig { returns(T.nilable(T.any(Knockapi::User, Knockapi::Object))) }
+      sig { returns(T.nilable(Knockapi::Recipient::Variants)) }
       attr_reader :recipient
 
       sig do
@@ -92,10 +92,10 @@ module Knockapi
           {
             id: String,
             _typename: String,
-            actor: T.nilable(T.any(Knockapi::User, Knockapi::Object)),
+            actor: T.nilable(Knockapi::Recipient::Variants),
             data: T.nilable(T::Hash[Symbol, T.anything]),
             inserted_at: Time,
-            recipient: T.any(Knockapi::User, Knockapi::Object),
+            recipient: Knockapi::Recipient::Variants,
             updated_at: Time
           }
         )

data/rbi/knockapi/models/message.rbi

@@ -24,13 +24,7 @@ module Knockapi
       # that can contain up to 10 actors if the message is produced from a
       # [batch](/designing-workflows/batch-function).
       sig do
-        returns(
-          T.nilable(
-            T::Array[
-              T.any(String, Knockapi::RecipientReference::ObjectReference)
-            ]
-          )
-        )
+        returns(T.nilable(T::Array[Knockapi::RecipientReference::Variants]))
       end
       attr_reader :actors
 
@@ -111,13 +105,7 @@ module Knockapi
 
       # A reference to a recipient, either a user identifier (string) or an object
       # reference (ID, collection).
-      sig do
-        returns(
-          T.nilable(
-            T.any(String, Knockapi::RecipientReference::ObjectReference)
-          )
-        )
-      end
+      sig { returns(T.nilable(Knockapi::RecipientReference::Variants)) }
       attr_reader :recipient
 
       sig do
@@ -263,10 +251,7 @@ module Knockapi
           {
             id: String,
             _typename: String,
-            actors:
-              T::Array[
-                T.any(String, Knockapi::RecipientReference::ObjectReference)
-              ],
+            actors: T::Array[Knockapi::RecipientReference::Variants],
             archived_at: T.nilable(Time),
             channel_id: String,
             clicked_at: T.nilable(Time),
@@ -278,8 +263,7 @@ module Knockapi
             link_clicked_at: T.nilable(Time),
             metadata: T.nilable(T::Hash[Symbol, T.anything]),
             read_at: T.nilable(Time),
-            recipient:
-              T.any(String, Knockapi::RecipientReference::ObjectReference),
+            recipient: Knockapi::RecipientReference::Variants,
             scheduled_at: T.nilable(Time),
             seen_at: T.nilable(Time),
             source: Knockapi::Message::Source,

data/rbi/knockapi/models/message_delivery_log.rbi

@@ -103,10 +103,18 @@ module Knockapi
           end
 
         # The body content that was sent with the request.
-        sig { returns(T.nilable(T.any(String, T::Hash[Symbol, T.anything]))) }
+        sig do
+          returns(
+            T.nilable(Knockapi::MessageDeliveryLog::Request::Body::Variants)
+          )
+        end
         attr_reader :body
 
-        sig { params(body: T.any(String, T::Hash[Symbol, T.anything])).void }
+        sig do
+          params(
+            body: Knockapi::MessageDeliveryLog::Request::Body::Variants
+          ).void
+        end
         attr_writer :body
 
         # The headers that were sent with the request.
@@ -151,7 +159,7 @@ module Knockapi
         # A message delivery log request.
         sig do
           params(
-            body: T.any(String, T::Hash[Symbol, T.anything]),
+            body: Knockapi::MessageDeliveryLog::Request::Body::Variants,
             headers: T.nilable(T::Hash[Symbol, T.anything]),
             host: String,
             method_: Knockapi::MessageDeliveryLog::Request::Method::OrSymbol,
@@ -178,7 +186,7 @@ module Knockapi
         sig do
           override.returns(
             {
-              body: T.any(String, T::Hash[Symbol, T.anything]),
+              body: Knockapi::MessageDeliveryLog::Request::Body::Variants,
               headers: T.nilable(T::Hash[Symbol, T.anything]),
               host: String,
               method_:
@@ -272,10 +280,18 @@ module Knockapi
           end
 
         # The body content that was received with the response.
-        sig { returns(T.nilable(T.any(String, T::Hash[Symbol, T.anything]))) }
+        sig do
+          returns(
+            T.nilable(Knockapi::MessageDeliveryLog::Response::Body::Variants)
+          )
+        end
         attr_reader :body
 
-        sig { params(body: T.any(String, T::Hash[Symbol, T.anything])).void }
+        sig do
+          params(
+            body: Knockapi::MessageDeliveryLog::Response::Body::Variants
+          ).void
+        end
         attr_writer :body
 
         # The headers that were received with the response.
@@ -292,7 +308,7 @@ module Knockapi
         # A message delivery log response.
         sig do
           params(
-            body: T.any(String, T::Hash[Symbol, T.anything]),
+            body: Knockapi::MessageDeliveryLog::Response::Body::Variants,
             headers: T.nilable(T::Hash[Symbol, T.anything]),
             status: Integer
           ).returns(T.attached_class)
@@ -310,7 +326,7 @@ module Knockapi
         sig do
           override.returns(
             {
-              body: T.any(String, T::Hash[Symbol, T.anything]),
+              body: Knockapi::MessageDeliveryLog::Response::Body::Variants,
               headers: T.nilable(T::Hash[Symbol, T.anything]),
               status: Integer
             }

data/rbi/knockapi/models/message_event.rbi

@@ -22,9 +22,7 @@ module Knockapi
 
       # A reference to a recipient, either a user identifier (string) or an object
       # reference (ID, collection).
-      sig do
-        returns(T.any(String, Knockapi::RecipientReference::ObjectReference))
-      end
+      sig { returns(Knockapi::RecipientReference::Variants) }
       attr_accessor :recipient
 
       # The type of event that occurred.
@@ -74,8 +72,7 @@ module Knockapi
             id: String,
             _typename: String,
             inserted_at: Time,
-            recipient:
-              T.any(String, Knockapi::RecipientReference::ObjectReference),
+            recipient: Knockapi::RecipientReference::Variants,
             type: Knockapi::MessageEvent::Type::TaggedSymbol,
             data: T.nilable(T::Hash[Symbol, T.anything])
           }

data/rbi/knockapi/models/message_get_content_response.rbi

@@ -17,15 +17,7 @@ module Knockapi
 
       # Content data specific to the channel type.
       sig do
-        returns(
-          T.any(
-            Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent,
-            Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent,
-            Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent,
-            Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent,
-            Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent
-          )
-        )
+        returns(Knockapi::Models::MessageGetContentResponse::Data::Variants)
       end
       attr_accessor :data
 
@@ -69,14 +61,7 @@ module Knockapi
         override.returns(
           {
             _typename: String,
-            data:
-              T.any(
-                Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent,
-                Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent,
-                Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent,
-                Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent,
-                Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent
-              ),
+            data: Knockapi::Models::MessageGetContentResponse::Data::Variants,
             inserted_at: Time,
             message_id: String
           }
@@ -566,10 +551,7 @@ module Knockapi
           sig do
             returns(
               T::Array[
-                T.any(
-                  Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
-                  Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
-                )
+                Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::Variants
               ]
             )
           end
@@ -602,10 +584,7 @@ module Knockapi
                 _typename: String,
                 blocks:
                   T::Array[
-                    T.any(
-                      Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
-                      Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
-                    )
+                    Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::Variants
                   ]
               }
             )

data/rbi/knockapi/models/message_list_params.rbi

@@ -230,14 +230,29 @@ module Knockapi
             :seen,
             Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
           )
+        UNSEEN =
+          T.let(
+            :unseen,
+            Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
+          )
         READ =
           T.let(
             :read,
             Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
           )
-        INTERACTED =
+        UNREAD =
           T.let(
-            :interacted,
+            :unread,
+            Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
+          )
+        ARCHIVED =
+          T.let(
+            :archived,
+            Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
+          )
+        UNARCHIVED =
+          T.let(
+            :unarchived,
             Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
           )
         LINK_CLICKED =
@@ -245,9 +260,9 @@ module Knockapi
             :link_clicked,
             Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
           )
-        ARCHIVED =
+        INTERACTED =
           T.let(
-            :archived,
+            :interacted,
             Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
           )