knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models/recipients/subscription.rbi

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Recipients
       class Subscription < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::Subscription,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The typename of the schema.
         sig { returns(String) }
         attr_accessor :_typename
@@ -13,14 +21,14 @@ module Knockapi
         attr_accessor :inserted_at
 
         # A custom [Object](/concepts/objects) entity which belongs to a collection.
-        sig { returns(Knockapi::Models::Object) }
+        sig { returns(Knockapi::Object) }
         attr_reader :object
 
-        sig { params(object: T.any(Knockapi::Models::Object, Knockapi::Internal::AnyHash)).void }
+        sig { params(object: Knockapi::Object::OrHash).void }
         attr_writer :object
 
         # A recipient of a notification, which is either a user or an object.
-        sig { returns(T.any(Knockapi::Models::User, Knockapi::Models::Object)) }
+        sig { returns(Knockapi::Recipient::Variants) }
         attr_accessor :recipient
 
         # The timestamp when the resource was last updated.
@@ -36,12 +44,11 @@ module Knockapi
           params(
             _typename: String,
             inserted_at: Time,
-            object: T.any(Knockapi::Models::Object, Knockapi::Internal::AnyHash),
-            recipient: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object),
+            object: Knockapi::Object::OrHash,
+            recipient: T.any(Knockapi::User::OrHash, Knockapi::Object::OrHash),
             updated_at: Time,
             properties: T.nilable(T::Hash[Symbol, T.anything])
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
           # The typename of the schema.
@@ -56,21 +63,23 @@ module Knockapi
           updated_at:,
           # The custom properties associated with the subscription relationship.
           properties: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                _typename: String,
-                inserted_at: Time,
-                object: Knockapi::Models::Object,
-                recipient: T.any(Knockapi::Models::User, Knockapi::Models::Object),
-                updated_at: Time,
-                properties: T.nilable(T::Hash[Symbol, T.anything])
-              }
-            )
+          override.returns(
+            {
+              _typename: String,
+              inserted_at: Time,
+              object: Knockapi::Object,
+              recipient: Knockapi::Recipient::Variants,
+              updated_at: Time,
+              properties: T.nilable(T::Hash[Symbol, T.anything])
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
     end
   end

data/rbi/knockapi/models/schedule.rbi

@@ -3,6 +3,9 @@
 module Knockapi
   module Models
     class Schedule < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::Schedule, Knockapi::Internal::AnyHash) }
+
       # Unique identifier for the schedule.
       sig { returns(String) }
       attr_accessor :id
@@ -12,11 +15,11 @@ module Knockapi
       attr_accessor :inserted_at
 
       # A recipient of a notification, which is either a user or an object.
-      sig { returns(T.any(Knockapi::Models::User, Knockapi::Models::Object)) }
+      sig { returns(Knockapi::Recipient::Variants) }
       attr_accessor :recipient
 
       # The repeat rule for the schedule.
-      sig { returns(T::Array[Knockapi::Models::ScheduleRepeatRule]) }
+      sig { returns(T::Array[Knockapi::ScheduleRepeatRule]) }
       attr_accessor :repeats
 
       # The timestamp when the resource was last updated.
@@ -35,7 +38,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::Models::User, Knockapi::Models::Object))) }
+      sig { returns(T.nilable(Knockapi::Recipient::Variants)) }
       attr_accessor :actor
 
       # An optional map of data to pass into the workflow execution.
@@ -61,18 +64,18 @@ module Knockapi
         params(
           id: String,
           inserted_at: Time,
-          recipient: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object),
-          repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)],
+          recipient: T.any(Knockapi::User::OrHash, Knockapi::Object::OrHash),
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           updated_at: Time,
           workflow: String,
           _typename: String,
-          actor: T.nilable(T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object)),
+          actor:
+            T.nilable(T.any(Knockapi::User::OrHash, Knockapi::Object::OrHash)),
           data: T.nilable(T::Hash[Symbol, T.anything]),
           last_occurrence_at: T.nilable(Time),
           next_occurrence_at: T.nilable(Time),
           tenant: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # Unique identifier for the schedule.
@@ -101,27 +104,29 @@ module Knockapi
         # tenant-level overrides associated with the tenant object, and all messages
         # produced from workflow runs will be tagged with the tenant.
         tenant: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              inserted_at: Time,
-              recipient: T.any(Knockapi::Models::User, Knockapi::Models::Object),
-              repeats: T::Array[Knockapi::Models::ScheduleRepeatRule],
-              updated_at: Time,
-              workflow: String,
-              _typename: String,
-              actor: T.nilable(T.any(Knockapi::Models::User, Knockapi::Models::Object)),
-              data: T.nilable(T::Hash[Symbol, T.anything]),
-              last_occurrence_at: T.nilable(Time),
-              next_occurrence_at: T.nilable(Time),
-              tenant: T.nilable(String)
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            inserted_at: Time,
+            recipient: Knockapi::Recipient::Variants,
+            repeats: T::Array[Knockapi::ScheduleRepeatRule],
+            updated_at: Time,
+            workflow: String,
+            _typename: String,
+            actor: T.nilable(Knockapi::Recipient::Variants),
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            last_occurrence_at: T.nilable(Time),
+            next_occurrence_at: T.nilable(Time),
+            tenant: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/schedule_create_params.rbi

@@ -6,17 +6,27 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # The recipients to trigger the workflow for. Can inline identify users, objects,
-      # or use a list of user IDs. Limited to 1,000 recipients.
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ScheduleCreateParams, Knockapi::Internal::AnyHash)
+        end
+
+      # The recipients to set the schedule for. Limited to 100 recipients per request.
       sig do
         returns(
-          T::Array[T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)]
+          T::Array[
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
+          ]
         )
       end
       attr_accessor :recipients
 
       # The repeat rule for the schedule.
-      sig { returns(T::Array[Knockapi::Models::ScheduleRepeatRule]) }
+      sig { returns(T::Array[Knockapi::ScheduleRepeatRule]) }
       attr_accessor :repeats
 
       # The key of the workflow.
@@ -36,32 +46,30 @@ module Knockapi
       attr_accessor :scheduled_at
 
       # An request to set a tenant inline.
-      sig { returns(T.nilable(T.any(String, Knockapi::Models::TenantRequest))) }
+      sig { returns(T.nilable(T.any(String, Knockapi::TenantRequest))) }
       attr_accessor :tenant
 
       sig do
         params(
-          recipients: T::Array[
-            T.any(
-              String,
-              Knockapi::Models::InlineIdentifyUserRequest,
-              Knockapi::Internal::AnyHash,
-              Knockapi::Models::InlineObjectRequest
-            )
-          ],
-          repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)],
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ],
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           workflow: String,
           data: T.nilable(T::Hash[Symbol, T.anything]),
           ending_at: T.nilable(Time),
           scheduled_at: T.nilable(Time),
-          tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)),
-          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
-        # The recipients to trigger the workflow for. Can inline identify users, objects,
-        # or use a list of user IDs. Limited to 1,000 recipients.
+        # The recipients to set the schedule for. Limited to 100 recipients per request.
         recipients:,
         # The repeat rule for the schedule.
         repeats:,
@@ -76,23 +84,32 @@ module Knockapi
         # An request to set a tenant inline.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              recipients: T::Array[T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)],
-              repeats: T::Array[Knockapi::Models::ScheduleRepeatRule],
-              workflow: String,
-              data: T.nilable(T::Hash[Symbol, T.anything]),
-              ending_at: T.nilable(Time),
-              scheduled_at: T.nilable(Time),
-              tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest)),
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            recipients:
+              T::Array[
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::InlineObjectRequest
+                )
+              ],
+            repeats: T::Array[Knockapi::ScheduleRepeatRule],
+            workflow: String,
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            ending_at: T.nilable(Time),
+            scheduled_at: T.nilable(Time),
+            tenant: T.nilable(T.any(String, Knockapi::TenantRequest)),
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/schedule_create_response.rbi

@@ -3,6 +3,9 @@
 module Knockapi
   module Models
     ScheduleCreateResponse =
-      T.let(Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Schedule], Knockapi::Internal::Type::Converter)
+      T.let(
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
+        Knockapi::Internal::Type::Converter
+      )
   end
 end

data/rbi/knockapi/models/schedule_delete_params.rbi

@@ -6,6 +6,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ScheduleDeleteParams, Knockapi::Internal::AnyHash)
+        end
+
       # A list of schedule IDs.
       sig { returns(T::Array[String]) }
       attr_accessor :schedule_ids
@@ -13,17 +18,26 @@ module Knockapi
       sig do
         params(
           schedule_ids: T::Array[String],
-          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(
         # A list of schedule IDs.
         schedule_ids:,
         request_options: {}
-      ); end
-      sig { override.returns({schedule_ids: T::Array[String], request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            schedule_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/schedule_delete_response.rbi

@@ -3,6 +3,9 @@
 module Knockapi
   module Models
     ScheduleDeleteResponse =
-      T.let(Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Schedule], Knockapi::Internal::Type::Converter)
+      T.let(
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
+        Knockapi::Internal::Type::Converter
+      )
   end
 end

data/rbi/knockapi/models/schedule_list_params.rbi

@@ -6,6 +6,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ScheduleListParams, Knockapi::Internal::AnyHash)
+        end
+
       # Filter by workflow key.
       sig { returns(String) }
       attr_accessor :workflow
@@ -53,9 +58,8 @@ module Knockapi
           page_size: Integer,
           recipients: T::Array[String],
           tenant: String,
-          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(
         # Filter by workflow key.
@@ -71,22 +75,24 @@ module Knockapi
         # Filter by tenant ID.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              workflow: String,
-              after: String,
-              before: String,
-              page_size: Integer,
-              recipients: T::Array[String],
-              tenant: String,
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            workflow: String,
+            after: String,
+            before: String,
+            page_size: Integer,
+            recipients: T::Array[String],
+            tenant: String,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/schedule_repeat_rule.rbi

@@ -3,12 +3,17 @@
 module Knockapi
   module Models
     class ScheduleRepeatRule < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ScheduleRepeatRule, Knockapi::Internal::AnyHash)
+        end
+
       # The typename of the schema.
       sig { returns(String) }
       attr_accessor :_typename
 
       # The frequency of the schedule.
-      sig { returns(Knockapi::Models::ScheduleRepeatRule::Frequency::OrSymbol) }
+      sig { returns(Knockapi::ScheduleRepeatRule::Frequency::OrSymbol) }
       attr_accessor :frequency
 
       # The day of the month to repeat the schedule.
@@ -16,7 +21,11 @@ module Knockapi
       attr_accessor :day_of_month
 
       # The days of the week to repeat the schedule.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::ScheduleRepeatRule::Day::OrSymbol])) }
+      sig do
+        returns(
+          T.nilable(T::Array[Knockapi::ScheduleRepeatRule::Day::OrSymbol])
+        )
+      end
       attr_accessor :days
 
       # The hour of the day to repeat the schedule.
@@ -38,14 +47,14 @@ module Knockapi
       sig do
         params(
           _typename: String,
-          frequency: Knockapi::Models::ScheduleRepeatRule::Frequency::OrSymbol,
+          frequency: Knockapi::ScheduleRepeatRule::Frequency::OrSymbol,
           day_of_month: T.nilable(Integer),
-          days: T.nilable(T::Array[Knockapi::Models::ScheduleRepeatRule::Day::OrSymbol]),
+          days:
+            T.nilable(T::Array[Knockapi::ScheduleRepeatRule::Day::OrSymbol]),
           hours: T.nilable(Integer),
           interval: Integer,
           minutes: T.nilable(Integer)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # The typename of the schema.
@@ -62,56 +71,77 @@ module Knockapi
         interval: nil,
         # The minute of the hour to repeat the schedule.
         minutes: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              _typename: String,
-              frequency: Knockapi::Models::ScheduleRepeatRule::Frequency::OrSymbol,
-              day_of_month: T.nilable(Integer),
-              days: T.nilable(T::Array[Knockapi::Models::ScheduleRepeatRule::Day::OrSymbol]),
-              hours: T.nilable(Integer),
-              interval: Integer,
-              minutes: T.nilable(Integer)
-            }
-          )
+        override.returns(
+          {
+            _typename: String,
+            frequency: Knockapi::ScheduleRepeatRule::Frequency::OrSymbol,
+            day_of_month: T.nilable(Integer),
+            days:
+              T.nilable(T::Array[Knockapi::ScheduleRepeatRule::Day::OrSymbol]),
+            hours: T.nilable(Integer),
+            interval: Integer,
+            minutes: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       # The frequency of the schedule.
       module Frequency
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ScheduleRepeatRule::Frequency) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Knockapi::ScheduleRepeatRule::Frequency)
+          end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        DAILY = T.let(:daily, Knockapi::Models::ScheduleRepeatRule::Frequency::TaggedSymbol)
-        WEEKLY = T.let(:weekly, Knockapi::Models::ScheduleRepeatRule::Frequency::TaggedSymbol)
-        MONTHLY = T.let(:monthly, Knockapi::Models::ScheduleRepeatRule::Frequency::TaggedSymbol)
-        HOURLY = T.let(:hourly, Knockapi::Models::ScheduleRepeatRule::Frequency::TaggedSymbol)
-
-        sig { override.returns(T::Array[Knockapi::Models::ScheduleRepeatRule::Frequency::TaggedSymbol]) }
-        def self.values; end
+        DAILY =
+          T.let(:daily, Knockapi::ScheduleRepeatRule::Frequency::TaggedSymbol)
+        WEEKLY =
+          T.let(:weekly, Knockapi::ScheduleRepeatRule::Frequency::TaggedSymbol)
+        MONTHLY =
+          T.let(:monthly, Knockapi::ScheduleRepeatRule::Frequency::TaggedSymbol)
+        HOURLY =
+          T.let(:hourly, Knockapi::ScheduleRepeatRule::Frequency::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Knockapi::ScheduleRepeatRule::Frequency::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
 
       # An identifier for a day of the week.
       module Day
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ScheduleRepeatRule::Day) }
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Knockapi::ScheduleRepeatRule::Day) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        MON = T.let(:mon, Knockapi::Models::ScheduleRepeatRule::Day::TaggedSymbol)
-        TUE = T.let(:tue, Knockapi::Models::ScheduleRepeatRule::Day::TaggedSymbol)
-        WED = T.let(:wed, Knockapi::Models::ScheduleRepeatRule::Day::TaggedSymbol)
-        THU = T.let(:thu, Knockapi::Models::ScheduleRepeatRule::Day::TaggedSymbol)
-        FRI = T.let(:fri, Knockapi::Models::ScheduleRepeatRule::Day::TaggedSymbol)
-        SAT = T.let(:sat, Knockapi::Models::ScheduleRepeatRule::Day::TaggedSymbol)
-        SUN = T.let(:sun, Knockapi::Models::ScheduleRepeatRule::Day::TaggedSymbol)
-
-        sig { override.returns(T::Array[Knockapi::Models::ScheduleRepeatRule::Day::TaggedSymbol]) }
-        def self.values; end
+        MON = T.let(:mon, Knockapi::ScheduleRepeatRule::Day::TaggedSymbol)
+        TUE = T.let(:tue, Knockapi::ScheduleRepeatRule::Day::TaggedSymbol)
+        WED = T.let(:wed, Knockapi::ScheduleRepeatRule::Day::TaggedSymbol)
+        THU = T.let(:thu, Knockapi::ScheduleRepeatRule::Day::TaggedSymbol)
+        FRI = T.let(:fri, Knockapi::ScheduleRepeatRule::Day::TaggedSymbol)
+        SAT = T.let(:sat, Knockapi::ScheduleRepeatRule::Day::TaggedSymbol)
+        SUN = T.let(:sun, Knockapi::ScheduleRepeatRule::Day::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Knockapi::ScheduleRepeatRule::Day::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
     end
   end