knockapi 1.4.0 → 1.6.0

data/rbi/knockapi/models/schedule_create_params.rbi

@@ -25,14 +25,26 @@ module Knockapi
       end
       attr_accessor :recipients
 
-      # The repeat rule for the schedule.
-      sig { returns(T::Array[Knockapi::ScheduleRepeatRule]) }
-      attr_accessor :repeats
-
       # The key of the workflow.
       sig { returns(String) }
       attr_accessor :workflow
 
+      # Specifies a recipient in a request. This can either be a user identifier
+      # (string), an inline user request (object), or an inline object request, which is
+      # determined by the presence of a `collection` property.
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
+          )
+        )
+      end
+      attr_accessor :actor
+
       # An optional map of data to pass into the workflow execution. There is a 1024
       # byte limit on the size of any single string value (with the exception of
       # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
@@ -44,6 +56,15 @@ module Knockapi
       sig { returns(T.nilable(Time)) }
       attr_accessor :ending_at
 
+      # The repeat rule for the schedule.
+      sig { returns(T.nilable(T::Array[Knockapi::ScheduleRepeatRule])) }
+      attr_reader :repeats
+
+      sig do
+        params(repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash]).void
+      end
+      attr_writer :repeats
+
       # The starting date and time for the schedule.
       sig { returns(T.nilable(Time)) }
       attr_accessor :scheduled_at
@@ -62,10 +83,18 @@ module Knockapi
                 Knockapi::InlineObjectRequest::OrHash
               )
             ],
-          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           workflow: String,
+          actor:
+            T.nilable(
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ),
           data: T.nilable(T::Hash[Symbol, T.anything]),
           ending_at: T.nilable(Time),
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           scheduled_at: T.nilable(Time),
           tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
           request_options: Knockapi::RequestOptions::OrHash
@@ -74,10 +103,12 @@ module Knockapi
       def self.new(
         # The recipients to set the schedule for. Limited to 100 recipients per request.
         recipients:,
-        # The repeat rule for the schedule.
-        repeats:,
         # The key of the workflow.
         workflow:,
+        # Specifies a recipient in a request. This can either be a user identifier
+        # (string), an inline user request (object), or an inline object request, which is
+        # determined by the presence of a `collection` property.
+        actor: nil,
         # An optional map of data to pass into the workflow execution. There is a 1024
         # byte limit on the size of any single string value (with the exception of
         # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
@@ -85,6 +116,8 @@ module Knockapi
         data: nil,
         # The ending date and time for the schedule.
         ending_at: nil,
+        # The repeat rule for the schedule.
+        repeats: nil,
         # The starting date and time for the schedule.
         scheduled_at: nil,
         # An request to set a tenant inline.
@@ -104,10 +137,18 @@ module Knockapi
                   Knockapi::InlineObjectRequest
                 )
               ],
-            repeats: T::Array[Knockapi::ScheduleRepeatRule],
             workflow: String,
+            actor:
+              T.nilable(
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::InlineObjectRequest
+                )
+              ),
             data: T.nilable(T::Hash[Symbol, T.anything]),
             ending_at: T.nilable(Time),
+            repeats: T::Array[Knockapi::ScheduleRepeatRule],
             scheduled_at: T.nilable(Time),
             tenant: T.nilable(T.any(String, Knockapi::TenantRequest)),
             request_options: Knockapi::RequestOptions

data/rbi/knockapi/models/schedule_list_params.rbi

@@ -36,11 +36,29 @@ module Knockapi
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
-      # Filter by recipient IDs.
-      sig { returns(T.nilable(T::Array[String])) }
+      # Filter by recipient references.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(String, Knockapi::RecipientReference::ObjectReference)
+            ]
+          )
+        )
+      end
       attr_reader :recipients
 
-      sig { params(recipients: T::Array[String]).void }
+      sig do
+        params(
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ]
+        ).void
+      end
       attr_writer :recipients
 
       # Filter by tenant ID.
@@ -56,7 +74,13 @@ module Knockapi
           after: String,
           before: String,
           page_size: Integer,
-          recipients: T::Array[String],
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           tenant: String,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -70,7 +94,7 @@ module Knockapi
         before: nil,
         # The number of items per page.
         page_size: nil,
-        # Filter by recipient IDs.
+        # Filter by recipient references.
         recipients: nil,
         # Filter by tenant ID.
         tenant: nil,
@@ -85,7 +109,10 @@ module Knockapi
             after: String,
             before: String,
             page_size: Integer,
-            recipients: T::Array[String],
+            recipients:
+              T::Array[
+                T.any(String, Knockapi::RecipientReference::ObjectReference)
+              ],
             tenant: String,
             request_options: Knockapi::RequestOptions
           }

data/rbi/knockapi/models/schedule_repeat_rule.rbi

@@ -8,14 +8,17 @@ module Knockapi
           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::ScheduleRepeatRule::Frequency::OrSymbol) }
       attr_accessor :frequency
 
+      # The typename of the schema.
+      sig { returns(T.nilable(String)) }
+      attr_reader :_typename
+
+      sig { params(_typename: String).void }
+      attr_writer :_typename
+
       # The day of the month to repeat the schedule.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :day_of_month
@@ -46,8 +49,8 @@ module Knockapi
       # The repeat rule for the schedule.
       sig do
         params(
-          _typename: String,
           frequency: Knockapi::ScheduleRepeatRule::Frequency::OrSymbol,
+          _typename: String,
           day_of_month: T.nilable(Integer),
           days:
             T.nilable(T::Array[Knockapi::ScheduleRepeatRule::Day::OrSymbol]),
@@ -57,10 +60,10 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
-        # The typename of the schema.
-        _typename:,
         # The frequency of the schedule.
         frequency:,
+        # The typename of the schema.
+        _typename: nil,
         # The day of the month to repeat the schedule.
         day_of_month: nil,
         # The days of the week to repeat the schedule.
@@ -77,8 +80,8 @@ module Knockapi
       sig do
         override.returns(
           {
-            _typename: String,
             frequency: Knockapi::ScheduleRepeatRule::Frequency::OrSymbol,
+            _typename: String,
             day_of_month: T.nilable(Integer),
             days:
               T.nilable(T::Array[Knockapi::ScheduleRepeatRule::Day::OrSymbol]),

data/rbi/knockapi/models/tenant_set_params.rbi

@@ -30,14 +30,6 @@ module Knockapi
       end
       attr_accessor :channel_data
 
-      # Inline set preferences for a recipient, where the key is the preference set id.
-      sig do
-        returns(
-          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
-        )
-      end
-      attr_accessor :preferences
-
       # The settings for the tenant. Includes branding and preference set.
       sig { returns(T.nilable(Knockapi::TenantSetParams::Settings)) }
       attr_reader :settings
@@ -60,13 +52,6 @@ module Knockapi
                 )
               ]
             ),
-          preferences:
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Knockapi::Recipients::PreferenceSetRequest::OrHash
-              ]
-            ),
           settings: Knockapi::TenantSetParams::Settings::OrHash,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -74,8 +59,6 @@ module Knockapi
       def self.new(
         # A request to set channel data for a type of channel inline.
         channel_data: nil,
-        # Inline set preferences for a recipient, where the key is the preference set id.
-        preferences: nil,
         # The settings for the tenant. Includes branding and preference set.
         settings: nil,
         request_options: {}
@@ -98,10 +81,6 @@ module Knockapi
                   )
                 ]
               ),
-            preferences:
-              T.nilable(
-                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
-              ),
             settings: Knockapi::TenantSetParams::Settings,
             request_options: Knockapi::RequestOptions
           }

data/rbi/knockapi/models/user_list_subscriptions_params.rbi

@@ -46,11 +46,29 @@ module Knockapi
       end
       attr_writer :include
 
-      # Only returns subscriptions for the specified object GIDs.
-      sig { returns(T.nilable(T::Array[String])) }
+      # Only returns subscriptions for the specified object references.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(String, Knockapi::RecipientReference::ObjectReference)
+            ]
+          )
+        )
+      end
       attr_reader :objects
 
-      sig { params(objects: T::Array[String]).void }
+      sig do
+        params(
+          objects:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ]
+        ).void
+      end
       attr_writer :objects
 
       # The number of items per page.
@@ -66,7 +84,13 @@ module Knockapi
           before: String,
           include:
             T::Array[Knockapi::UserListSubscriptionsParams::Include::OrSymbol],
-          objects: T::Array[String],
+          objects:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           page_size: Integer,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -78,7 +102,7 @@ module Knockapi
         before: nil,
         # Associated resources to include in the response.
         include: nil,
-        # Only returns subscriptions for the specified object GIDs.
+        # Only returns subscriptions for the specified object references.
         objects: nil,
         # The number of items per page.
         page_size: nil,
@@ -95,7 +119,10 @@ module Knockapi
               T::Array[
                 Knockapi::UserListSubscriptionsParams::Include::OrSymbol
               ],
-            objects: T::Array[String],
+            objects:
+              T::Array[
+                T.any(String, Knockapi::RecipientReference::ObjectReference)
+              ],
             page_size: Integer,
             request_options: Knockapi::RequestOptions
           }

data/rbi/knockapi/resources/objects/bulk.rbi

@@ -49,7 +49,7 @@ module Knockapi
         sig do
           params(
             collection: String,
-            objects: T::Array[Knockapi::InlineObjectRequest::OrHash],
+            objects: T::Array[Knockapi::Objects::BulkSetParams::Object::OrHash],
             request_options: Knockapi::RequestOptions::OrHash
           ).returns(Knockapi::BulkOperation)
         end

data/rbi/knockapi/resources/schedules.rbi

@@ -21,10 +21,18 @@ module Knockapi
                 Knockapi::InlineObjectRequest::OrHash
               )
             ],
-          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           workflow: String,
+          actor:
+            T.nilable(
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ),
           data: T.nilable(T::Hash[Symbol, T.anything]),
           ending_at: T.nilable(Time),
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           scheduled_at: T.nilable(Time),
           tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
           request_options: Knockapi::RequestOptions::OrHash
@@ -33,10 +41,12 @@ module Knockapi
       def create(
         # The recipients to set the schedule for. Limited to 100 recipients per request.
         recipients:,
-        # The repeat rule for the schedule.
-        repeats:,
         # The key of the workflow.
         workflow:,
+        # Specifies a recipient in a request. This can either be a user identifier
+        # (string), an inline user request (object), or an inline object request, which is
+        # determined by the presence of a `collection` property.
+        actor: nil,
         # An optional map of data to pass into the workflow execution. There is a 1024
         # byte limit on the size of any single string value (with the exception of
         # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
@@ -44,6 +54,8 @@ module Knockapi
         data: nil,
         # The ending date and time for the schedule.
         ending_at: nil,
+        # The repeat rule for the schedule.
+        repeats: nil,
         # The starting date and time for the schedule.
         scheduled_at: nil,
         # An request to set a tenant inline.
@@ -106,7 +118,13 @@ module Knockapi
           after: String,
           before: String,
           page_size: Integer,
-          recipients: T::Array[String],
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           tenant: String,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(Knockapi::Internal::EntriesCursor[Knockapi::Schedule])
@@ -120,7 +138,7 @@ module Knockapi
         before: nil,
         # The number of items per page.
         page_size: nil,
-        # Filter by recipient IDs.
+        # Filter by recipient references.
         recipients: nil,
         # Filter by tenant ID.
         tenant: nil,

data/rbi/knockapi/resources/tenants.rbi

@@ -78,13 +78,6 @@ module Knockapi
                 )
               ]
             ),
-          preferences:
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Knockapi::Recipients::PreferenceSetRequest::OrHash
-              ]
-            ),
           settings: Knockapi::TenantSetParams::Settings::OrHash,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(Knockapi::Tenant)
@@ -94,8 +87,6 @@ module Knockapi
         id,
         # A request to set channel data for a type of channel inline.
         channel_data: nil,
-        # Inline set preferences for a recipient, where the key is the preference set id.
-        preferences: nil,
         # The settings for the tenant. Includes branding and preference set.
         settings: nil,
         request_options: {}

data/rbi/knockapi/resources/users.rbi

@@ -283,7 +283,13 @@ module Knockapi
           before: String,
           include:
             T::Array[Knockapi::UserListSubscriptionsParams::Include::OrSymbol],
-          objects: T::Array[String],
+          objects:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           page_size: Integer,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(
@@ -299,7 +305,7 @@ module Knockapi
         before: nil,
         # Associated resources to include in the response.
         include: nil,
-        # Only returns subscriptions for the specified object GIDs.
+        # Only returns subscriptions for the specified object references.
         objects: nil,
         # The number of items per page.
         page_size: nil,

data/sig/knockapi/models/objects/bulk_set_params.rbs

@@ -2,24 +2,56 @@ module Knockapi
   module Models
     module Objects
       type bulk_set_params =
-        { objects: ::Array[Knockapi::InlineObjectRequest] }
+        { objects: ::Array[Knockapi::Objects::BulkSetParams::Object] }
         & Knockapi::Internal::Type::request_parameters
 
       class BulkSetParams < Knockapi::Internal::Type::BaseModel
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
-        attr_accessor objects: ::Array[Knockapi::InlineObjectRequest]
+        attr_accessor objects: ::Array[Knockapi::Objects::BulkSetParams::Object]
 
         def initialize: (
-          objects: ::Array[Knockapi::InlineObjectRequest],
+          objects: ::Array[Knockapi::Objects::BulkSetParams::Object],
           ?request_options: Knockapi::request_opts
         ) -> void
 
         def to_hash: -> {
-          objects: ::Array[Knockapi::InlineObjectRequest],
+          objects: ::Array[Knockapi::Objects::BulkSetParams::Object],
           request_options: Knockapi::RequestOptions
         }
+
+        type object =
+          {
+            id: String,
+            channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+            created_at: Time?,
+            preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+          }
+
+        class Object < Knockapi::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
+
+          attr_accessor created_at: Time?
+
+          attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+
+          def initialize: (
+            id: String,
+            ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+            ?created_at: Time?,
+            ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+            created_at: Time?,
+            preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+          }
+        end
       end
     end
   end

data/sig/knockapi/models/schedule_create_params.rbs

@@ -3,10 +3,11 @@ module Knockapi
     type schedule_create_params =
       {
         recipients: ::Array[Knockapi::Models::recipient_request],
-        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         workflow: String,
+        actor: Knockapi::Models::recipient_request?,
         data: ::Hash[Symbol, top]?,
         ending_at: Time?,
+        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         scheduled_at: Time?,
         tenant: Knockapi::Models::inline_tenant_request?
       }
@@ -18,24 +19,31 @@ module Knockapi
 
       attr_accessor recipients: ::Array[Knockapi::Models::recipient_request]
 
-      attr_accessor repeats: ::Array[Knockapi::ScheduleRepeatRule]
-
       attr_accessor workflow: String
 
+      attr_accessor actor: Knockapi::Models::recipient_request?
+
       attr_accessor data: ::Hash[Symbol, top]?
 
       attr_accessor ending_at: Time?
 
+      attr_reader repeats: ::Array[Knockapi::ScheduleRepeatRule]?
+
+      def repeats=: (
+        ::Array[Knockapi::ScheduleRepeatRule]
+      ) -> ::Array[Knockapi::ScheduleRepeatRule]
+
       attr_accessor scheduled_at: Time?
 
       attr_accessor tenant: Knockapi::Models::inline_tenant_request?
 
       def initialize: (
         recipients: ::Array[Knockapi::Models::recipient_request],
-        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         workflow: String,
+        ?actor: Knockapi::Models::recipient_request?,
         ?data: ::Hash[Symbol, top]?,
         ?ending_at: Time?,
+        ?repeats: ::Array[Knockapi::ScheduleRepeatRule],
         ?scheduled_at: Time?,
         ?tenant: Knockapi::Models::inline_tenant_request?,
         ?request_options: Knockapi::request_opts
@@ -43,10 +51,11 @@ module Knockapi
 
       def to_hash: -> {
         recipients: ::Array[Knockapi::Models::recipient_request],
-        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         workflow: String,
+        actor: Knockapi::Models::recipient_request?,
         data: ::Hash[Symbol, top]?,
         ending_at: Time?,
+        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         scheduled_at: Time?,
         tenant: Knockapi::Models::inline_tenant_request?,
         request_options: Knockapi::RequestOptions

data/sig/knockapi/models/schedule_list_params.rbs

@@ -6,7 +6,7 @@ module Knockapi
         after: String,
         before: String,
         page_size: Integer,
-        recipients: ::Array[String],
+        recipients: ::Array[Knockapi::Models::recipient_reference],
         tenant: String
       }
       & Knockapi::Internal::Type::request_parameters
@@ -29,9 +29,11 @@ module Knockapi
 
       def page_size=: (Integer) -> Integer
 
-      attr_reader recipients: ::Array[String]?
+      attr_reader recipients: ::Array[Knockapi::Models::recipient_reference]?
 
-      def recipients=: (::Array[String]) -> ::Array[String]
+      def recipients=: (
+        ::Array[Knockapi::Models::recipient_reference]
+      ) -> ::Array[Knockapi::Models::recipient_reference]
 
       attr_reader tenant: String?
 
@@ -42,7 +44,7 @@ module Knockapi
         ?after: String,
         ?before: String,
         ?page_size: Integer,
-        ?recipients: ::Array[String],
+        ?recipients: ::Array[Knockapi::Models::recipient_reference],
         ?tenant: String,
         ?request_options: Knockapi::request_opts
       ) -> void
@@ -52,7 +54,7 @@ module Knockapi
         after: String,
         before: String,
         page_size: Integer,
-        recipients: ::Array[String],
+        recipients: ::Array[Knockapi::Models::recipient_reference],
         tenant: String,
         request_options: Knockapi::RequestOptions
       }

data/sig/knockapi/models/schedule_repeat_rule.rbs

@@ -2,8 +2,8 @@ module Knockapi
   module Models
     type schedule_repeat_rule =
       {
-        _typename: String,
         frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
+        _typename: String,
         day_of_month: Integer?,
         days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
         hours: Integer?,
@@ -12,10 +12,12 @@ module Knockapi
       }
 
     class ScheduleRepeatRule < Knockapi::Internal::Type::BaseModel
-      attr_accessor _typename: String
-
       attr_accessor frequency: Knockapi::Models::ScheduleRepeatRule::frequency
 
+      attr_reader _typename: String?
+
+      def _typename=: (String) -> String
+
       attr_accessor day_of_month: Integer?
 
       attr_accessor days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?
@@ -29,8 +31,8 @@ module Knockapi
       attr_accessor minutes: Integer?
 
       def initialize: (
-        _typename: String,
         frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
+        ?_typename: String,
         ?day_of_month: Integer?,
         ?days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
         ?hours: Integer?,
@@ -39,8 +41,8 @@ module Knockapi
       ) -> void
 
       def to_hash: -> {
-        _typename: String,
         frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
+        _typename: String,
         day_of_month: Integer?,
         days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
         hours: Integer?,