knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi

@@ -7,6 +7,14 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Integrations::HightouchEmbeddedDestinationParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The unique identifier for the RPC request.
         sig { returns(String) }
         attr_accessor :id
@@ -32,9 +40,8 @@ module Knockapi
             jsonrpc: String,
             method_: String,
             params: T::Hash[Symbol, T.anything],
-            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the RPC request.
@@ -46,20 +53,22 @@ module Knockapi
           # The parameters for the method.
           params: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                id: String,
-                jsonrpc: String,
-                method_: String,
-                params: T::Hash[Symbol, T.anything],
-                request_options: Knockapi::RequestOptions
-              }
-            )
+          override.returns(
+            {
+              id: String,
+              jsonrpc: String,
+              method_: String,
+              params: T::Hash[Symbol, T.anything],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
     end
   end

data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Integrations
       class HightouchEmbeddedDestinationResponse < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Models::Integrations::HightouchEmbeddedDestinationResponse,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The request ID.
         sig { returns(T.nilable(String)) }
         attr_reader :id
@@ -18,15 +26,24 @@ module Knockapi
         sig { params(result: T::Hash[Symbol, T.anything]).void }
         attr_writer :result
 
-        sig { params(id: String, result: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
+        sig do
+          params(id: String, result: T::Hash[Symbol, T.anything]).returns(
+            T.attached_class
+          )
+        end
         def self.new(
           # The request ID.
           id: nil,
           # The result of the RPC call.
           result: nil
-        ); end
-        sig { override.returns({id: String, result: T::Hash[Symbol, T.anything]}) }
-        def to_hash; end
+        )
+        end
+
+        sig do
+          override.returns({ id: String, result: T::Hash[Symbol, T.anything] })
+        end
+        def to_hash
+        end
       end
     end
   end

data/rbi/knockapi/models/message.rbi

@@ -3,6 +3,9 @@
 module Knockapi
   module Models
     class Message < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::Message, Knockapi::Internal::AnyHash) }
+
       # The unique identifier for the message.
       sig { returns(T.nilable(String)) }
       attr_reader :id
@@ -20,14 +23,21 @@ module Knockapi
       # One or more actors that are associated with this message. Note: this is a list
       # that can contain up to 10 actors if the message is produced from a
       # [batch](/designing-workflows/batch-function).
-      sig { returns(T.nilable(T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)])) }
+      sig do
+        returns(T.nilable(T::Array[Knockapi::RecipientReference::Variants]))
+      end
       attr_reader :actors
 
       sig do
         params(
-          actors: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)]
-        )
-          .void
+          actors:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ]
+        ).void
       end
       attr_writer :actors
 
@@ -55,10 +65,19 @@ module Knockapi
       attr_accessor :data
 
       # A list of engagement statuses.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::Message::EngagementStatus::TaggedSymbol])) }
+      sig do
+        returns(
+          T.nilable(T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol])
+        )
+      end
       attr_reader :engagement_statuses
 
-      sig { params(engagement_statuses: T::Array[Knockapi::Models::Message::EngagementStatus::OrSymbol]).void }
+      sig do
+        params(
+          engagement_statuses:
+            T::Array[Knockapi::Message::EngagementStatus::OrSymbol]
+        ).void
+      end
       attr_writer :engagement_statuses
 
       # Timestamp when the resource was created.
@@ -86,14 +105,14 @@ module Knockapi
 
       # A reference to a recipient, either a user identifier (string) or an object
       # reference (ID, collection).
-      sig { returns(T.nilable(T.any(String, Knockapi::Models::RecipientReference::ObjectReference))) }
+      sig { returns(T.nilable(Knockapi::RecipientReference::Variants)) }
       attr_reader :recipient
 
       sig do
         params(
-          recipient: T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)
-        )
-          .void
+          recipient:
+            T.any(String, Knockapi::RecipientReference::ObjectReference::OrHash)
+        ).void
       end
       attr_writer :recipient
 
@@ -106,17 +125,17 @@ module Knockapi
       attr_accessor :seen_at
 
       # The workflow that triggered the message.
-      sig { returns(T.nilable(Knockapi::Models::Message::Source)) }
+      sig { returns(T.nilable(Knockapi::Message::Source)) }
       attr_reader :source
 
-      sig { params(source: T.any(Knockapi::Models::Message::Source, Knockapi::Internal::AnyHash)).void }
+      sig { params(source: Knockapi::Message::Source::OrHash).void }
       attr_writer :source
 
       # The message delivery status.
-      sig { returns(T.nilable(Knockapi::Models::Message::Status::TaggedSymbol)) }
+      sig { returns(T.nilable(Knockapi::Message::Status::TaggedSymbol)) }
       attr_reader :status
 
-      sig { params(status: Knockapi::Models::Message::Status::OrSymbol).void }
+      sig { params(status: Knockapi::Message::Status::OrSymbol).void }
       attr_writer :status
 
       # The ID of the `tenant` associated with the message. Only present when a `tenant`
@@ -141,27 +160,37 @@ module Knockapi
         params(
           id: String,
           _typename: String,
-          actors: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)],
+          actors:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           archived_at: T.nilable(Time),
           channel_id: String,
           clicked_at: T.nilable(Time),
           data: T.nilable(T::Hash[Symbol, T.anything]),
-          engagement_statuses: T::Array[Knockapi::Models::Message::EngagementStatus::OrSymbol],
+          engagement_statuses:
+            T::Array[Knockapi::Message::EngagementStatus::OrSymbol],
           inserted_at: Time,
           interacted_at: T.nilable(Time),
           link_clicked_at: T.nilable(Time),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           read_at: T.nilable(Time),
-          recipient: T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash),
+          recipient:
+            T.any(
+              String,
+              Knockapi::RecipientReference::ObjectReference::OrHash
+            ),
           scheduled_at: T.nilable(Time),
           seen_at: T.nilable(Time),
-          source: T.any(Knockapi::Models::Message::Source, Knockapi::Internal::AnyHash),
-          status: Knockapi::Models::Message::Status::OrSymbol,
+          source: Knockapi::Message::Source::OrHash,
+          status: Knockapi::Message::Status::OrSymbol,
           tenant: T.nilable(String),
           updated_at: Time,
           workflow: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # The unique identifier for the message.
@@ -214,56 +243,76 @@ module Knockapi
         updated_at: nil,
         # The key of the workflow that generated the message.
         workflow: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              _typename: String,
-              actors: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)],
-              archived_at: T.nilable(Time),
-              channel_id: String,
-              clicked_at: T.nilable(Time),
-              data: T.nilable(T::Hash[Symbol, T.anything]),
-              engagement_statuses: T::Array[Knockapi::Models::Message::EngagementStatus::TaggedSymbol],
-              inserted_at: Time,
-              interacted_at: T.nilable(Time),
-              link_clicked_at: T.nilable(Time),
-              metadata: T.nilable(T::Hash[Symbol, T.anything]),
-              read_at: T.nilable(Time),
-              recipient: T.any(String, Knockapi::Models::RecipientReference::ObjectReference),
-              scheduled_at: T.nilable(Time),
-              seen_at: T.nilable(Time),
-              source: Knockapi::Models::Message::Source,
-              status: Knockapi::Models::Message::Status::TaggedSymbol,
-              tenant: T.nilable(String),
-              updated_at: Time,
-              workflow: T.nilable(String)
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            _typename: String,
+            actors: T::Array[Knockapi::RecipientReference::Variants],
+            archived_at: T.nilable(Time),
+            channel_id: String,
+            clicked_at: T.nilable(Time),
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            engagement_statuses:
+              T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol],
+            inserted_at: Time,
+            interacted_at: T.nilable(Time),
+            link_clicked_at: T.nilable(Time),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            read_at: T.nilable(Time),
+            recipient: Knockapi::RecipientReference::Variants,
+            scheduled_at: T.nilable(Time),
+            seen_at: T.nilable(Time),
+            source: Knockapi::Message::Source,
+            status: Knockapi::Message::Status::TaggedSymbol,
+            tenant: T.nilable(String),
+            updated_at: Time,
+            workflow: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       # An engagement status for a message. Can be one of: read, seen, interacted,
       # link_clicked, archived.
       module EngagementStatus
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::Message::EngagementStatus) }
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Knockapi::Message::EngagementStatus) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        SEEN = T.let(:seen, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
-        READ = T.let(:read, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
-        INTERACTED = T.let(:interacted, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
-        LINK_CLICKED = T.let(:link_clicked, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
-        ARCHIVED = T.let(:archived, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
+        SEEN = T.let(:seen, Knockapi::Message::EngagementStatus::TaggedSymbol)
+        READ = T.let(:read, Knockapi::Message::EngagementStatus::TaggedSymbol)
+        INTERACTED =
+          T.let(:interacted, Knockapi::Message::EngagementStatus::TaggedSymbol)
+        LINK_CLICKED =
+          T.let(
+            :link_clicked,
+            Knockapi::Message::EngagementStatus::TaggedSymbol
+          )
+        ARCHIVED =
+          T.let(:archived, Knockapi::Message::EngagementStatus::TaggedSymbol)
 
-        sig { override.returns(T::Array[Knockapi::Models::Message::EngagementStatus::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
 
       class Source < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Knockapi::Message::Source, Knockapi::Internal::AnyHash)
+          end
+
         sig { returns(String) }
         attr_accessor :_typename
 
@@ -281,8 +330,12 @@ module Knockapi
 
         # The workflow that triggered the message.
         sig do
-          params(_typename: String, categories: T::Array[String], key: String, version_id: String)
-            .returns(T.attached_class)
+          params(
+            _typename: String,
+            categories: T::Array[String],
+            key: String,
+            version_id: String
+          ).returns(T.attached_class)
         end
         def self.new(
           _typename:,
@@ -292,30 +345,45 @@ module Knockapi
           key:,
           # The ID of the version of the workflow that triggered the message.
           version_id:
-        ); end
+        )
+        end
+
         sig do
-          override.returns({_typename: String, categories: T::Array[String], key: String, version_id: String})
+          override.returns(
+            {
+              _typename: String,
+              categories: T::Array[String],
+              key: String,
+              version_id: String
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
 
       # The message delivery status.
       module Status
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::Message::Status) }
+        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Message::Status) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        QUEUED = T.let(:queued, Knockapi::Models::Message::Status::TaggedSymbol)
-        SENT = T.let(:sent, Knockapi::Models::Message::Status::TaggedSymbol)
-        DELIVERED = T.let(:delivered, Knockapi::Models::Message::Status::TaggedSymbol)
-        DELIVERY_ATTEMPTED = T.let(:delivery_attempted, Knockapi::Models::Message::Status::TaggedSymbol)
-        UNDELIVERED = T.let(:undelivered, Knockapi::Models::Message::Status::TaggedSymbol)
-        NOT_SENT = T.let(:not_sent, Knockapi::Models::Message::Status::TaggedSymbol)
-        BOUNCED = T.let(:bounced, Knockapi::Models::Message::Status::TaggedSymbol)
+        QUEUED = T.let(:queued, Knockapi::Message::Status::TaggedSymbol)
+        SENT = T.let(:sent, Knockapi::Message::Status::TaggedSymbol)
+        DELIVERED = T.let(:delivered, Knockapi::Message::Status::TaggedSymbol)
+        DELIVERY_ATTEMPTED =
+          T.let(:delivery_attempted, Knockapi::Message::Status::TaggedSymbol)
+        UNDELIVERED =
+          T.let(:undelivered, Knockapi::Message::Status::TaggedSymbol)
+        NOT_SENT = T.let(:not_sent, Knockapi::Message::Status::TaggedSymbol)
+        BOUNCED = T.let(:bounced, Knockapi::Message::Status::TaggedSymbol)
 
-        sig { override.returns(T::Array[Knockapi::Models::Message::Status::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(T::Array[Knockapi::Message::Status::TaggedSymbol])
+        end
+        def self.values
+        end
       end
     end
   end

data/rbi/knockapi/models/message_archive_params.rbi

@@ -6,14 +6,22 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::MessageArchiveParams, Knockapi::Internal::AnyHash)
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end