knockapi 1.8.1 → 1.10.0

data/rbi/knockapi/models/message.rbi

@@ -328,13 +328,18 @@ module Knockapi
         sig { returns(String) }
         attr_accessor :version_id
 
+        # The step reference for the step in the workflow that generated the message
+        sig { returns(T.nilable(String)) }
+        attr_accessor :step_ref
+
         # The workflow that triggered the message.
         sig do
           params(
             _typename: String,
             categories: T::Array[String],
             key: String,
-            version_id: String
+            version_id: String,
+            step_ref: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -344,7 +349,9 @@ module Knockapi
           # The key of the workflow that triggered the message.
           key:,
           # The ID of the version of the workflow that triggered the message.
-          version_id:
+          version_id:,
+          # The step reference for the step in the workflow that generated the message
+          step_ref: nil
         )
         end
 
@@ -354,7 +361,8 @@ module Knockapi
               _typename: String,
               categories: T::Array[String],
               key: String,
-              version_id: String
+              version_id: String,
+              step_ref: T.nilable(String)
             }
           )
         end

data/rbi/knockapi/models/message_get_content_response.rbi

@@ -258,7 +258,7 @@ module Knockapi
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_accessor :data
 
-          # The content of a push notification.
+          # Push channel data.
           sig do
             params(
               token: String,

data/rbi/knockapi/models/message_list_activities_params.rbi

@@ -28,7 +28,7 @@ module Knockapi
       sig { params(before: String).void }
       attr_writer :before
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -56,7 +56,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # The trigger data to filter activities by.
         trigger_data: nil,

data/rbi/knockapi/models/message_list_delivery_logs_params.rbi

@@ -28,7 +28,7 @@ module Knockapi
       sig { params(before: String).void }
       attr_writer :before
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -48,7 +48,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )

data/rbi/knockapi/models/message_list_events_params.rbi

@@ -25,7 +25,7 @@ module Knockapi
       sig { params(before: String).void }
       attr_writer :before
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -45,7 +45,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )

data/rbi/knockapi/models/message_list_params.rbi

@@ -68,7 +68,7 @@ module Knockapi
       sig { params(message_ids: T::Array[String]).void }
       attr_writer :message_ids
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -168,7 +168,7 @@ module Knockapi
         # Limits the results to only the message IDs given (max 50). Note: when using this
         # option, the results will be subject to any other filters applied to the query.
         message_ids: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Limits the results to messages triggered by the given workflow key.
         source: nil,

data/rbi/knockapi/models/messages/batch_get_content_response.rbi

@@ -262,7 +262,7 @@ module Knockapi
             sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
             attr_accessor :data
 
-            # The content of a push notification.
+            # Push channel data.
             sig do
               params(
                 token: String,

data/rbi/knockapi/models/object_list_messages_params.rbi

@@ -72,7 +72,7 @@ module Knockapi
       sig { params(message_ids: T::Array[String]).void }
       attr_writer :message_ids
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -177,7 +177,7 @@ module Knockapi
         # Limits the results to only the message IDs given (max 50). Note: when using this
         # option, the results will be subject to any other filters applied to the query.
         message_ids: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Limits the results to messages triggered by the given workflow key.
         source: nil,

data/rbi/knockapi/models/object_list_params.rbi

@@ -40,7 +40,7 @@ module Knockapi
       end
       attr_writer :include
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -63,7 +63,7 @@ module Knockapi
         before: nil,
         # Includes preferences of the objects in the response.
         include: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )

data/rbi/knockapi/models/object_list_schedules_params.rbi

@@ -28,7 +28,7 @@ module Knockapi
       sig { params(before: String).void }
       attr_writer :before
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -64,7 +64,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Filter schedules by tenant id.
         tenant: nil,

data/rbi/knockapi/models/object_list_subscriptions_params.rbi

@@ -79,7 +79,7 @@ module Knockapi
       end
       attr_writer :objects
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -146,7 +146,7 @@ module Knockapi
         mode: nil,
         # Objects to filter by (only used if mode is `recipient`).
         objects: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Recipients to filter by (only used if mode is `object`).
         recipients: nil,

data/rbi/knockapi/models/page_info.rbi

@@ -10,7 +10,7 @@ module Knockapi
       sig { returns(String) }
       attr_accessor :_typename
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(Integer) }
       attr_accessor :page_size
 
@@ -34,7 +34,7 @@ module Knockapi
       def self.new(
         # The typename of the schema.
         _typename:,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size:,
         # The cursor to fetch entries after.
         after: nil,

data/rbi/knockapi/models/providers/slack_list_channels_params.rbi

@@ -107,7 +107,8 @@ module Knockapi
 
           # Mix and match channel types by providing a comma-separated list of any
           # combination of public_channel, private_channel, mpim, im. Defaults to
-          # `"public_channel,private_channel"`.
+          # `"public_channel,private_channel"`. If the user's Slack ID is unavailable, this
+          # option is ignored and only public channels are returned.
           sig { returns(T.nilable(String)) }
           attr_reader :types
 
@@ -137,7 +138,8 @@ module Knockapi
             team_id: nil,
             # Mix and match channel types by providing a comma-separated list of any
             # combination of public_channel, private_channel, mpim, im. Defaults to
-            # `"public_channel,private_channel"`.
+            # `"public_channel,private_channel"`. If the user's Slack ID is unavailable, this
+            # option is ignored and only public channels are returned.
             types: nil
           )
           end

data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi

@@ -29,7 +29,7 @@ module Knockapi
         sig { returns(T.nilable(String)) }
         attr_accessor :ms_teams_tenant_id
 
-        # Microsoft Teams channel connection.
+        # Microsoft Teams channel data.
         sig do
           params(
             connections:

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

@@ -16,7 +16,7 @@ module Knockapi
         sig { returns(T::Array[String]) }
         attr_accessor :tokens
 
-        # The content of a push notification.
+        # Push channel data.
         sig { params(tokens: T::Array[String]).returns(T.attached_class) }
         def self.new(
           # A list of push channel tokens.

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

@@ -39,7 +39,7 @@ module Knockapi
         end
         attr_writer :token
 
-        # Slack channel data
+        # Slack channel data.
         sig do
           params(
             connections:

data/rbi/knockapi/models/schedule.rbi

@@ -41,10 +41,10 @@ module Knockapi
       sig { returns(T.nilable(Knockapi::Recipient::Variants)) }
       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
-      # size of the full `data` payload.
+      # An optional map of data to pass into the workflow execution. There is a 10MB
+      # limit on the size of the full `data` payload. Any individual string value
+      # greater than 1024 bytes in length will be
+      # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :data
 
@@ -97,10 +97,10 @@ module Knockapi
         _typename: nil,
         # A recipient of a notification, which is either a user or an object.
         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
-        # size of the full `data` payload.
+        # An optional map of data to pass into the workflow execution. There is a 10MB
+        # limit on the size of the full `data` payload. Any individual string value
+        # greater than 1024 bytes in length will be
+        # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
         # The last occurrence of the schedule.
         last_occurrence_at: nil,

data/rbi/knockapi/models/schedule_create_params.rbi

@@ -45,10 +45,10 @@ module Knockapi
       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
-      # size of the full `data` payload.
+      # An optional map of data to pass into the workflow execution. There is a 10MB
+      # limit on the size of the full `data` payload. Any individual string value
+      # greater than 1024 bytes in length will be
+      # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :data
 
@@ -109,10 +109,10 @@ module Knockapi
         # (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
-        # size of the full `data` payload.
+        # An optional map of data to pass into the workflow execution. There is a 10MB
+        # limit on the size of the full `data` payload. Any individual string value
+        # greater than 1024 bytes in length will be
+        # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
         # The ending date and time for the schedule.
         ending_at: nil,

data/rbi/knockapi/models/schedule_list_params.rbi

@@ -29,7 +29,7 @@ module Knockapi
       sig { params(before: String).void }
       attr_writer :before
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -92,7 +92,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Filter by recipient references.
         recipients: nil,

data/rbi/knockapi/models/schedule_update_params.rbi

@@ -26,10 +26,10 @@ module Knockapi
       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
-      # size of the full `data` payload.
+      # An optional map of data to pass into the workflow execution. There is a 10MB
+      # limit on the size of the full `data` payload. Any individual string value
+      # greater than 1024 bytes in length will be
+      # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :data
 
@@ -78,10 +78,10 @@ module Knockapi
         # A reference to a recipient, either a user identifier (string) or an object
         # reference (ID, collection).
         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
-        # size of the full `data` payload.
+        # An optional map of data to pass into the workflow execution. There is a 10MB
+        # limit on the size of the full `data` payload. Any individual string value
+        # greater than 1024 bytes in length will be
+        # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
         # The ending date and time for the schedule.
         ending_at: nil,

data/rbi/knockapi/models/schedules/bulk_create_params.rbi

@@ -76,10 +76,10 @@ module Knockapi
           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
-          # size of the full `data` payload.
+          # An optional map of data to pass into the workflow execution. There is a 10MB
+          # limit on the size of the full `data` payload. Any individual string value
+          # greater than 1024 bytes in length will be
+          # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_accessor :data
 
@@ -164,10 +164,10 @@ module Knockapi
             # (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
-            # size of the full `data` payload.
+            # An optional map of data to pass into the workflow execution. There is a 10MB
+            # limit on the size of the full `data` payload. Any individual string value
+            # greater than 1024 bytes in length will be
+            # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
             data: nil,
             # The ending date and time for the schedule.
             ending_at: nil,

data/rbi/knockapi/models/tenant_list_params.rbi

@@ -32,7 +32,7 @@ module Knockapi
       sig { params(name: String).void }
       attr_writer :name
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -63,7 +63,7 @@ module Knockapi
         before: nil,
         # Filter tenants by name.
         name: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Filter tenants by ID.
         tenant_id: nil,

data/rbi/knockapi/models/user.rbi

@@ -6,7 +6,7 @@ module Knockapi
       OrHash =
         T.type_alias { T.any(Knockapi::User, Knockapi::Internal::AnyHash) }
 
-      # The ID for the user that you set when identifying them in Knock.
+      # The unique identifier of the user.
       sig { returns(String) }
       attr_accessor :id
 
@@ -18,7 +18,7 @@ module Knockapi
       sig { returns(Time) }
       attr_accessor :updated_at
 
-      # URL to the user's avatar image.
+      # A URL for the avatar of the user.
       sig { returns(T.nilable(String)) }
       attr_accessor :avatar
 
@@ -63,13 +63,13 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the user.
         id:,
         # The typename of the schema.
         _typename:,
         # The timestamp when the resource was last updated.
         updated_at:,
-        # URL to the user's avatar image.
+        # A URL for the avatar of the user.
         avatar: nil,
         # The creation date of the user from your system.
         created_at: nil,

data/rbi/knockapi/models/user_list_messages_params.rbi

@@ -72,7 +72,7 @@ module Knockapi
       sig { params(message_ids: T::Array[String]).void }
       attr_writer :message_ids
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -176,7 +176,7 @@ module Knockapi
         # Limits the results to only the message IDs given (max 50). Note: when using this
         # option, the results will be subject to any other filters applied to the query.
         message_ids: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Limits the results to messages triggered by the given workflow key.
         source: nil,

data/rbi/knockapi/models/user_list_params.rbi

@@ -40,7 +40,7 @@ module Knockapi
       end
       attr_writer :include
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -63,7 +63,7 @@ module Knockapi
         before: nil,
         # Associated resources to include in the response.
         include: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )

data/rbi/knockapi/models/user_list_schedules_params.rbi

@@ -25,7 +25,7 @@ module Knockapi
       sig { params(before: String).void }
       attr_writer :before
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -61,7 +61,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # The tenant ID to filter schedules for.
         tenant: nil,

data/rbi/knockapi/models/user_list_subscriptions_params.rbi

@@ -71,7 +71,7 @@ module Knockapi
       end
       attr_writer :objects
 
-      # The number of items per page.
+      # The number of items per page (defaults to 50).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -104,7 +104,7 @@ module Knockapi
         include: nil,
         # Only returns subscriptions for the specified object references.
         objects: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )

data/rbi/knockapi/models/users/feed_list_items_params.rbi

@@ -51,14 +51,14 @@ module Knockapi
         sig { params(has_tenant: T::Boolean).void }
         attr_writer :has_tenant
 
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_size
 
         sig { params(page_size: Integer).void }
         attr_writer :page_size
 
-        # The source of the feed items.
+        # The workflow key associated with the message in the feed.
         sig { returns(T.nilable(String)) }
         attr_reader :source
 
@@ -125,9 +125,9 @@ module Knockapi
           before: nil,
           # Whether the feed items have a tenant.
           has_tenant: nil,
-          # The number of items per page.
+          # The number of items per page (defaults to 50).
           page_size: nil,
-          # The source of the feed items.
+          # The workflow key associated with the message in the feed.
           source: nil,
           # The status of the feed items.
           status: nil,

data/rbi/knockapi/models/workflow_trigger_params.rbi

@@ -50,10 +50,10 @@ module Knockapi
       sig { returns(T.nilable(String)) }
       attr_accessor :cancellation_key
 
-      # 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
-      # size of the full `data` payload.
+      # An optional map of data to pass into the workflow execution. There is a 10MB
+      # limit on the size of the full `data` payload. Any individual string value
+      # greater than 1024 bytes in length will be
+      # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :data
 
@@ -99,10 +99,10 @@ module Knockapi
         # subsequent cancellation. Should be unique across trigger requests to avoid
         # unintentional cancellations.
         cancellation_key: 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
-        # size of the full `data` payload.
+        # An optional map of data to pass into the workflow execution. There is a 10MB
+        # limit on the size of the full `data` payload. Any individual string value
+        # greater than 1024 bytes in length will be
+        # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
         # An request to set a tenant inline.
         tenant: nil,

data/rbi/knockapi/resources/messages.rbi

@@ -40,7 +40,7 @@ module Knockapi
         # Limits the results to only the message IDs given (max 50). Note: when using this
         # option, the results will be subject to any other filters applied to the query.
         message_ids: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Limits the results to messages triggered by the given workflow key.
         source: nil,
@@ -125,7 +125,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # The trigger data to filter activities by.
         trigger_data: nil,
@@ -150,7 +150,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )
@@ -173,7 +173,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )