knockapi 1.32.1 → 1.34.0

data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi

@@ -15,6 +15,12 @@ module Knockapi
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
+        sig { returns(String) }
+        attr_accessor :message_id
+
         # The unique identifier for the channel.
         sig { returns(String) }
         attr_accessor :channel_id
@@ -65,6 +71,8 @@ module Knockapi
 
         sig do
           params(
+            user_id: String,
+            message_id: String,
             channel_id: String,
             guide_id: String,
             guide_key: String,
@@ -78,6 +86,8 @@ module Knockapi
           ).returns(T.attached_class)
         end
         def self.new(
+          user_id:,
+          message_id:,
           # The unique identifier for the channel.
           channel_id:,
           # The unique identifier for the guide.
@@ -103,6 +113,8 @@ module Knockapi
         sig do
           override.returns(
             {
+              user_id: String,
+              message_id: String,
               channel_id: String,
               guide_id: String,
               guide_key: String,

data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi

@@ -15,6 +15,12 @@ module Knockapi
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
+        sig { returns(String) }
+        attr_accessor :message_id
+
         # The unique identifier for the channel.
         sig { returns(String) }
         attr_accessor :channel_id
@@ -65,6 +71,8 @@ module Knockapi
 
         sig do
           params(
+            user_id: String,
+            message_id: String,
             channel_id: String,
             guide_id: String,
             guide_key: String,
@@ -78,6 +86,8 @@ module Knockapi
           ).returns(T.attached_class)
         end
         def self.new(
+          user_id:,
+          message_id:,
           # The unique identifier for the channel.
           channel_id:,
           # The unique identifier for the guide.
@@ -103,6 +113,8 @@ module Knockapi
         sig do
           override.returns(
             {
+              user_id: String,
+              message_id: String,
               channel_id: String,
               guide_id: String,
               guide_key: String,

data/rbi/knockapi/models/workflow_cancel_params.rbi

@@ -11,6 +11,9 @@ module Knockapi
           T.any(Knockapi::WorkflowCancelParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       # An optional key that is used to reference a specific workflow trigger request
       # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
       # request. Must be provided while triggering a workflow in order to enable
@@ -34,6 +37,7 @@ module Knockapi
 
       sig do
         params(
+          key: String,
           cancellation_key: String,
           recipients:
             T.nilable(
@@ -48,6 +52,7 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
+        key:,
         # An optional key that is used to reference a specific workflow trigger request
         # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
         # request. Must be provided while triggering a workflow in order to enable
@@ -64,6 +69,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            key: String,
             cancellation_key: String,
             recipients:
               T.nilable(

data/rbi/knockapi/models/workflow_trigger_params.rbi

@@ -11,6 +11,9 @@ module Knockapi
           T.any(Knockapi::WorkflowTriggerParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       # The recipients to trigger the workflow for. Can inline identify users, objects,
       # or use a list of user IDs. Limited to 1,000 recipients.
       sig do
@@ -63,6 +66,7 @@ module Knockapi
 
       sig do
         params(
+          key: String,
           recipients:
             T::Array[
               T.any(
@@ -86,6 +90,7 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
+        key:,
         # The recipients to trigger the workflow for. Can inline identify users, objects,
         # or use a list of user IDs. Limited to 1,000 recipients.
         recipients:,
@@ -113,6 +118,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            key: String,
             recipients:
               T::Array[
                 T.any(

data/rbi/knockapi/resources/audiences.rbi

@@ -2,6 +2,7 @@
 
 module Knockapi
   module Resources
+    # An Audience is a segment of users.
     class Audiences
       # Adds one or more members to the specified audience.
       sig do

data/rbi/knockapi/resources/bulk_operations.rbi

@@ -2,6 +2,8 @@
 
 module Knockapi
   module Resources
+    # A bulk operation is a set of changes applied across zero or more records
+    # triggered via a call to the Knock API and performed asynchronously.
     class BulkOperations
       # Retrieves a bulk operation (if it exists) and displays the current state of it.
       sig do

data/rbi/knockapi/resources/channels/bulk.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Channels
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       class Bulk
         # Bulk update the status of messages for a specific channel. The channel is
         # specified by the `channel_id` parameter. The action to perform is specified by

data/rbi/knockapi/resources/channels.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Channels
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       sig { returns(Knockapi::Resources::Channels::Bulk) }
       attr_reader :bulk
 

data/rbi/knockapi/resources/messages/batch.rbi

@@ -3,6 +3,7 @@
 module Knockapi
   module Resources
     class Messages
+      # A message sent to a single recipient on a channel.
       class Batch
         # Marks the given messages as archived. Archived messages are hidden from the
         # default message list in the feed but can still be accessed and unarchived later.

data/rbi/knockapi/resources/messages.rbi

@@ -2,7 +2,9 @@
 
 module Knockapi
   module Resources
+    # A message sent to a single recipient on a channel.
     class Messages
+      # A message sent to a single recipient on a channel.
       sig { returns(Knockapi::Resources::Messages::Batch) }
       attr_reader :batch
 

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

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Objects
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       class Bulk
         # Bulk deletes objects from the specified collection.
         sig do

data/rbi/knockapi/resources/objects.rbi

@@ -2,7 +2,10 @@
 
 module Knockapi
   module Resources
+    # An object represents a resource in your system that you want to map into Knock.
     class Objects
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       sig { returns(Knockapi::Resources::Objects::Bulk) }
       attr_reader :bulk
 

data/rbi/knockapi/resources/providers/ms_teams.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Providers
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       class MsTeams
         # Check if a connection to Microsoft Teams has been authorized for a given
         # Microsoft Teams tenant object.

data/rbi/knockapi/resources/providers/slack.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Providers
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       class Slack
         # Check if a Slack channel is authenticated.
         sig do

data/rbi/knockapi/resources/providers.rbi

@@ -3,9 +3,13 @@
 module Knockapi
   module Resources
     class Providers
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       sig { returns(Knockapi::Resources::Providers::Slack) }
       attr_reader :slack
 
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       sig { returns(Knockapi::Resources::Providers::MsTeams) }
       attr_reader :ms_teams
 

data/rbi/knockapi/resources/schedules/bulk.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Schedules
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       class Bulk
         # Bulk creates up to 1,000 schedules at a time. This endpoint also handles
         # [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)

data/rbi/knockapi/resources/schedules.rbi

@@ -2,7 +2,11 @@
 
 module Knockapi
   module Resources
+    # A schedule is a per-recipient, timezone-aware configuration for when to invoke a
+    # workflow.
     class Schedules
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       sig { returns(Knockapi::Resources::Schedules::Bulk) }
       attr_reader :bulk
 

data/rbi/knockapi/resources/tenants/bulk.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Tenants
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       class Bulk
         # Delete up to 1,000 tenants at a time in a single operation. This operation
         # cannot be undone.

data/rbi/knockapi/resources/tenants.rbi

@@ -2,7 +2,11 @@
 
 module Knockapi
   module Resources
+    # A tenant represents a top-level entity from your system, like a company,
+    # organization, account, or workspace.
     class Tenants
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       sig { returns(Knockapi::Resources::Tenants::Bulk) }
       attr_reader :bulk
 

data/rbi/knockapi/resources/users/bulk.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Users
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       class Bulk
         # Permanently deletes up to 1,000 users at a time.
         sig do

data/rbi/knockapi/resources/users/feeds.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Users
+      # A user is an individual from your system, represented in Knock. They are most
+      # commonly a recipient of a notification.
       class Feeds
         # Returns the feed settings for a user.
         sig do

data/rbi/knockapi/resources/users/guides.rbi

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Users
+      # A user is an individual from your system, represented in Knock. They are most
+      # commonly a recipient of a notification.
       class Guides
         # Returns a list of eligible in-app guides for a specific user and channel.
         sig do

data/rbi/knockapi/resources/users.rbi

@@ -2,13 +2,21 @@
 
 module Knockapi
   module Resources
+    # A user is an individual from your system, represented in Knock. They are most
+    # commonly a recipient of a notification.
     class Users
+      # A user is an individual from your system, represented in Knock. They are most
+      # commonly a recipient of a notification.
       sig { returns(Knockapi::Resources::Users::Feeds) }
       attr_reader :feeds
 
+      # A user is an individual from your system, represented in Knock. They are most
+      # commonly a recipient of a notification.
       sig { returns(Knockapi::Resources::Users::Guides) }
       attr_reader :guides
 
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       sig { returns(Knockapi::Resources::Users::Bulk) }
       attr_reader :bulk
 

data/rbi/knockapi/resources/workflows.rbi

@@ -2,6 +2,8 @@
 
 module Knockapi
   module Resources
+    # A workflow is a structured set of steps that is triggered to produce
+    # notifications sent over channels.
     class Workflows
       # When invoked for a workflow using a specific workflow key and cancellation key,
       # will cancel any queued workflow runs associated with that key/cancellation key

data/sig/knockapi/internal/util.rbs

@@ -106,6 +106,16 @@ module Knockapi
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/knockapi/models/audience_add_members_params.rbs

@@ -2,6 +2,7 @@ module Knockapi
   module Models
     type audience_add_members_params =
       {
+        key: String,
         members: ::Array[Knockapi::AudienceAddMembersParams::Member],
         create_audience: bool
       }
@@ -11,6 +12,8 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor key: String
+
       attr_accessor members: ::Array[Knockapi::AudienceAddMembersParams::Member]
 
       attr_reader create_audience: bool?
@@ -18,12 +21,14 @@ module Knockapi
       def create_audience=: (bool) -> bool
 
       def initialize: (
+        key: String,
         members: ::Array[Knockapi::AudienceAddMembersParams::Member],
         ?create_audience: bool,
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
+        key: String,
         members: ::Array[Knockapi::AudienceAddMembersParams::Member],
         create_audience: bool,
         request_options: Knockapi::RequestOptions

data/sig/knockapi/models/audience_list_members_params.rbs

@@ -1,15 +1,20 @@
 module Knockapi
   module Models
     type audience_list_members_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { key: String } & Knockapi::Internal::Type::request_parameters
 
     class AudienceListMembersParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor key: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        key: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> { key: String, request_options: Knockapi::RequestOptions }
     end
   end
 end

data/sig/knockapi/models/audience_remove_members_params.rbs

@@ -1,21 +1,28 @@
 module Knockapi
   module Models
     type audience_remove_members_params =
-      { members: ::Array[Knockapi::AudienceRemoveMembersParams::Member] }
+      {
+        key: String,
+        members: ::Array[Knockapi::AudienceRemoveMembersParams::Member]
+      }
       & Knockapi::Internal::Type::request_parameters
 
     class AudienceRemoveMembersParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor key: String
+
       attr_accessor members: ::Array[Knockapi::AudienceRemoveMembersParams::Member]
 
       def initialize: (
+        key: String,
         members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
+        key: String,
         members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
         request_options: Knockapi::RequestOptions
       }

data/sig/knockapi/models/bulk_operation_get_params.rbs

@@ -1,15 +1,20 @@
 module Knockapi
   module Models
     type bulk_operation_get_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { id: String } & Knockapi::Internal::Type::request_parameters
 
     class BulkOperationGetParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Knockapi::RequestOptions }
     end
   end
 end

data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs

@@ -3,6 +3,8 @@ module Knockapi
     module Channels
       type bulk_update_message_status_params =
         {
+          channel_id: String,
+          action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action,
           archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
           delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
           engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,
@@ -20,6 +22,10 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        attr_accessor channel_id: String
+
+        attr_accessor action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action
+
         attr_reader archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived?
 
         def archived=: (
@@ -67,6 +73,8 @@ module Knockapi
         def workflows=: (::Array[String]) -> ::Array[String]
 
         def initialize: (
+          channel_id: String,
+          action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action,
           ?archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
           ?delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
           ?engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,
@@ -81,6 +89,8 @@ module Knockapi
         ) -> void
 
         def to_hash: -> {
+          channel_id: String,
+          action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action,
           archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
           delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
           engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,

data/sig/knockapi/models/condition.rbs

@@ -47,6 +47,7 @@ module Knockapi
         | :is_timestamp_on_or_after_date
         | :is_timestamp_before_date
         | :is_timestamp_between
+        | :is_between
         | :is_audience_member
         | :is_not_audience_member
 
@@ -73,6 +74,7 @@ module Knockapi
         IS_TIMESTAMP_ON_OR_AFTER_DATE: :is_timestamp_on_or_after_date
         IS_TIMESTAMP_BEFORE_DATE: :is_timestamp_before_date
         IS_TIMESTAMP_BETWEEN: :is_timestamp_between
+        IS_BETWEEN: :is_between
         IS_AUDIENCE_MEMBER: :is_audience_member
         IS_NOT_AUDIENCE_MEMBER: :is_not_audience_member
 

data/sig/knockapi/models/message_archive_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_archive_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageArchiveParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_get_content_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_get_content_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageGetContentParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_get_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_get_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageGetParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end