knockapi 1.20.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59aa0cd10e59e4f0f18ddbefd0da6e0482a90c1243539d52389c1074e1a9e14c
-  data.tar.gz: 9a797662afb59af4d0964d0025957607feb398ea4f8a728e359a174886222d31
+  metadata.gz: '0874267848eeb99b21173d6b7115415dd08b573b1939f271f2b0e672e8c93394'
+  data.tar.gz: 5f112a3e47ef2b1b237f3359a61bd9e7e6caa6e079f37531d08c87df26979a01
 SHA512:
-  metadata.gz: 6d1da55316e1915100adc1748a00de8aee8b46c8b7a710948a34190faa8f6a03cbe33f0856817c9437b82eb09aeb6fc7ea18f04b87498234dd7ddb623f4b5734
-  data.tar.gz: a4268192cef85172e23bdaf4287e7a0d6f9257bb199ea56b17800974aa16e8424fcdff12ee87eddd7e205801e40605ab6a00d5c7cbed8977a7057bb5227054d9
+  metadata.gz: aa578c36d4937f35de975638eac48ab6d0d96c25d019cb152115dcb62f32b0ecf08d90d5a57082a83f9930a7a6291754caa0ad57c9b3554001e1415b1efb0cbb
+  data.tar.gz: 130e34f48bb8264cfdd25b05473ff4b4cef74a02dc4f7a52f75994128aac908a747f74c162bd6109c39e41d7f3c002723886993439d4dfe639a2669503b60ce9

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 1.22.0 (2025-12-04)
+
+Full Changelog: [v1.21.0...v1.22.0](https://github.com/knocklabs/knock-ruby/compare/v1.21.0...v1.22.0)
+
+### Features
+
+* **api:** api update ([28047a5](https://github.com/knocklabs/knock-ruby/commit/28047a59ac407ca2ecff51cfa13fc4a5c1d27019))
+
+## 1.21.0 (2025-11-20)
+
+Full Changelog: [v1.20.0...v1.21.0](https://github.com/knocklabs/knock-ruby/compare/v1.20.0...v1.21.0)
+
+### Features
+
+* **api:** Add bulk delete subscriptions ([2fed837](https://github.com/knocklabs/knock-ruby/commit/2fed8371bbd0a682d8a5c3fd030024847c69180b))
+
+
+### Chores
+
+* explicitly require "base64" gem ([cde84e5](https://github.com/knocklabs/knock-ruby/commit/cde84e5db590434da5db78b9138915f3072ec82d))
+
 ## 1.20.0 (2025-11-19)
 
 Full Changelog: [v1.19.0...v1.20.0](https://github.com/knocklabs/knock-ruby/compare/v1.19.0...v1.20.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "knockapi", "~> 1.20.0"
+gem "knockapi", "~> 1.22.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/models/message.rb

@@ -252,7 +252,24 @@ module Knockapi
         #   @return [Symbol, Knockapi::Models::Message::Source::Type, nil]
         optional :type, enum: -> { Knockapi::Message::Source::Type }
 
-        # @!method initialize(_typename:, categories:, key:, version_id:, step_ref: nil, type: nil)
+        # @!attribute workflow_recipient_run_id
+        #   The unique identifier for the workflow recipient run that generated this
+        #   message. Only present for workflow/broadcast messages.
+        #
+        #   @return [String, nil]
+        optional :workflow_recipient_run_id, String, nil?: true
+
+        # @!attribute workflow_run_id
+        #   The unique identifier for the workflow run that generated this message. Only
+        #   present for workflow/broadcast messages.
+        #
+        #   @return [String, nil]
+        optional :workflow_run_id, String, nil?: true
+
+        # @!method initialize(_typename:, categories:, key:, version_id:, step_ref: nil, type: nil, workflow_recipient_run_id: nil, workflow_run_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::Message::Source} for more details.
+        #
         #   The workflow or guide that triggered the message.
         #
         #   @param _typename [String]
@@ -266,6 +283,10 @@ module Knockapi
         #   @param step_ref [String, nil] The step reference for the step in the workflow that generated the message.
         #
         #   @param type [Symbol, Knockapi::Models::Message::Source::Type] Whether this message was generated from a workflow, broadcast, or guide.
+        #
+        #   @param workflow_recipient_run_id [String, nil] The unique identifier for the workflow recipient run that generated this message
+        #
+        #   @param workflow_run_id [String, nil] The unique identifier for the workflow run that generated this message. Only pre
 
         # Whether this message was generated from a workflow, broadcast, or guide.
         #

data/lib/knockapi/models/objects/bulk_delete_subscriptions_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Objects
+      # @see Knockapi::Resources::Objects::Bulk#delete_subscriptions
+      class BulkDeleteSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute subscriptions
+        #   A nested list of subscriptions.
+        #
+        #   @return [Array<Knockapi::Models::Objects::BulkDeleteSubscriptionsParams::Subscription>]
+        required :subscriptions,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription] }
+
+        # @!method initialize(subscriptions:, request_options: {})
+        #   @param subscriptions [Array<Knockapi::Models::Objects::BulkDeleteSubscriptionsParams::Subscription>] A nested list of subscriptions.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        class Subscription < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the object.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute recipients
+          #   The recipients of the subscription. You can subscribe up to 100 recipients to an
+          #   object at a time.
+          #
+          #   @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>]
+          required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
+
+          # @!method initialize(id:, recipients:)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Objects::BulkDeleteSubscriptionsParams::Subscription} for
+          #   more details.
+          #
+          #   A list of subscriptions. 1 subscribed-to id, and N subscriber recipients.
+          #
+          #   @param id [String] Unique identifier for the object.
+          #
+          #   @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/objects/bulk.rb

@@ -56,6 +56,31 @@ module Knockapi
           )
         end
 
+        # Delete subscriptions for many objects in a single collection type. If a
+        # subscription for an object in the collection doesn't exist, it will be skipped.
+        #
+        # @overload delete_subscriptions(collection, subscriptions:, request_options: {})
+        #
+        # @param collection [String] The collection this object belongs to.
+        #
+        # @param subscriptions [Array<Knockapi::Models::Objects::BulkDeleteSubscriptionsParams::Subscription>] A nested list of subscriptions.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::BulkOperation]
+        #
+        # @see Knockapi::Models::Objects::BulkDeleteSubscriptionsParams
+        def delete_subscriptions(collection, params)
+          parsed, options = Knockapi::Objects::BulkDeleteSubscriptionsParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/objects/%1$s/bulk/subscriptions/delete", collection],
+            body: parsed,
+            model: Knockapi::BulkOperation,
+            options: options
+          )
+        end
+
         # Bulk sets up to 1,000 objects at a time in the specified collection.
         #
         # @overload set(collection, objects:, request_options: {})

data/lib/knockapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.20.0"
+  VERSION = "1.22.0"
 end

data/lib/knockapi.rb

@@ -3,6 +3,7 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"
@@ -125,6 +126,7 @@ require_relative "knockapi/models/object_list_schedules_params"
 require_relative "knockapi/models/object_list_subscriptions_params"
 require_relative "knockapi/models/objects/bulk_add_subscriptions_params"
 require_relative "knockapi/models/objects/bulk_delete_params"
+require_relative "knockapi/models/objects/bulk_delete_subscriptions_params"
 require_relative "knockapi/models/objects/bulk_set_params"
 require_relative "knockapi/models/object_set_channel_data_params"
 require_relative "knockapi/models/object_set_params"

data/manifest.yaml

@@ -1,5 +1,6 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb

data/rbi/knockapi/models/message.rbi

@@ -316,6 +316,16 @@ module Knockapi
         sig { params(type: Knockapi::Message::Source::Type::OrSymbol).void }
         attr_writer :type
 
+        # The unique identifier for the workflow recipient run that generated this
+        # message. Only present for workflow/broadcast messages.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :workflow_recipient_run_id
+
+        # The unique identifier for the workflow run that generated this message. Only
+        # present for workflow/broadcast messages.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :workflow_run_id
+
         # The workflow or guide that triggered the message.
         sig do
           params(
@@ -324,7 +334,9 @@ module Knockapi
             key: String,
             version_id: String,
             step_ref: T.nilable(String),
-            type: Knockapi::Message::Source::Type::OrSymbol
+            type: Knockapi::Message::Source::Type::OrSymbol,
+            workflow_recipient_run_id: T.nilable(String),
+            workflow_run_id: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -338,7 +350,13 @@ module Knockapi
           # The step reference for the step in the workflow that generated the message.
           step_ref: nil,
           # Whether this message was generated from a workflow, broadcast, or guide.
-          type: nil
+          type: nil,
+          # The unique identifier for the workflow recipient run that generated this
+          # message. Only present for workflow/broadcast messages.
+          workflow_recipient_run_id: nil,
+          # The unique identifier for the workflow run that generated this message. Only
+          # present for workflow/broadcast messages.
+          workflow_run_id: nil
         )
         end
 
@@ -350,7 +368,9 @@ module Knockapi
               key: String,
               version_id: String,
               step_ref: T.nilable(String),
-              type: Knockapi::Message::Source::Type::TaggedSymbol
+              type: Knockapi::Message::Source::Type::TaggedSymbol,
+              workflow_recipient_run_id: T.nilable(String),
+              workflow_run_id: T.nilable(String)
             }
           )
         end

data/rbi/knockapi/models/objects/bulk_delete_subscriptions_params.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Objects
+      class BulkDeleteSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Objects::BulkDeleteSubscriptionsParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # A nested list of subscriptions.
+        sig do
+          returns(
+            T::Array[
+              Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription
+            ]
+          )
+        end
+        attr_accessor :subscriptions
+
+        sig do
+          params(
+            subscriptions:
+              T::Array[
+                Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription::OrHash
+              ],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A nested list of subscriptions.
+          subscriptions:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              subscriptions:
+                T::Array[
+                  Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription
+                ],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Subscription < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # Unique identifier for the object.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The recipients of the subscription. You can subscribe up to 100 recipients to an
+          # object at a time.
+          sig do
+            returns(
+              T::Array[
+                T.any(String, Knockapi::RecipientReference::ObjectReference)
+              ]
+            )
+          end
+          attr_accessor :recipients
+
+          # A list of subscriptions. 1 subscribed-to id, and N subscriber recipients.
+          sig do
+            params(
+              id: String,
+              recipients:
+                T::Array[
+                  T.any(
+                    String,
+                    Knockapi::RecipientReference::ObjectReference::OrHash
+                  )
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique identifier for the object.
+            id:,
+            # The recipients of the subscription. You can subscribe up to 100 recipients to an
+            # object at a time.
+            recipients:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                recipients:
+                  T::Array[
+                    T.any(String, Knockapi::RecipientReference::ObjectReference)
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -45,6 +45,27 @@ module Knockapi
         )
         end
 
+        # Delete subscriptions for many objects in a single collection type. If a
+        # subscription for an object in the collection doesn't exist, it will be skipped.
+        sig do
+          params(
+            collection: String,
+            subscriptions:
+              T::Array[
+                Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription::OrHash
+              ],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
+        end
+        def delete_subscriptions(
+          # The collection this object belongs to.
+          collection,
+          # A nested list of subscriptions.
+          subscriptions:,
+          request_options: {}
+        )
+        end
+
         # Bulk sets up to 1,000 objects at a time in the specified collection.
         sig do
           params(

data/sig/knockapi/models/message.rbs

@@ -149,7 +149,9 @@ module Knockapi
           key: String,
           version_id: String,
           step_ref: String?,
-          type: Knockapi::Models::Message::Source::type_
+          type: Knockapi::Models::Message::Source::type_,
+          workflow_recipient_run_id: String?,
+          workflow_run_id: String?
         }
 
       class Source < Knockapi::Internal::Type::BaseModel
@@ -169,13 +171,19 @@ module Knockapi
           Knockapi::Models::Message::Source::type_
         ) -> Knockapi::Models::Message::Source::type_
 
+        attr_accessor workflow_recipient_run_id: String?
+
+        attr_accessor workflow_run_id: String?
+
         def initialize: (
           _typename: String,
           categories: ::Array[String],
           key: String,
           version_id: String,
           ?step_ref: String?,
-          ?type: Knockapi::Models::Message::Source::type_
+          ?type: Knockapi::Models::Message::Source::type_,
+          ?workflow_recipient_run_id: String?,
+          ?workflow_run_id: String?
         ) -> void
 
         def to_hash: -> {
@@ -184,7 +192,9 @@ module Knockapi
           key: String,
           version_id: String,
           step_ref: String?,
-          type: Knockapi::Models::Message::Source::type_
+          type: Knockapi::Models::Message::Source::type_,
+          workflow_recipient_run_id: String?,
+          workflow_run_id: String?
         }
 
         type type_ = :broadcast | :workflow | :guide

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

@@ -0,0 +1,50 @@
+module Knockapi
+  module Models
+    module Objects
+      type bulk_delete_subscriptions_params =
+        {
+          subscriptions: ::Array[Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkDeleteSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor subscriptions: ::Array[Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription]
+
+        def initialize: (
+          subscriptions: ::Array[Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          subscriptions: ::Array[Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription],
+          request_options: Knockapi::RequestOptions
+        }
+
+        type subscription =
+          {
+            id: String,
+            recipients: ::Array[Knockapi::Models::recipient_reference]
+          }
+
+        class Subscription < Knockapi::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor recipients: ::Array[Knockapi::Models::recipient_reference]
+
+          def initialize: (
+            id: String,
+            recipients: ::Array[Knockapi::Models::recipient_reference]
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            recipients: ::Array[Knockapi::Models::recipient_reference]
+          }
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/resources/objects/bulk.rbs

@@ -14,6 +14,12 @@ module Knockapi
           ?request_options: Knockapi::request_opts
         ) -> Knockapi::BulkOperation
 
+        def delete_subscriptions: (
+          String collection,
+          subscriptions: ::Array[Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
         def set: (
           String collection,
           objects: ::Array[Knockapi::Objects::BulkSetParams::Object],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-20 00:00:00.000000000 Z
+date: 2025-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -131,6 +131,7 @@ files:
 - lib/knockapi/models/object_unset_channel_data_params.rb
 - lib/knockapi/models/objects/bulk_add_subscriptions_params.rb
 - lib/knockapi/models/objects/bulk_delete_params.rb
+- lib/knockapi/models/objects/bulk_delete_subscriptions_params.rb
 - lib/knockapi/models/objects/bulk_set_params.rb
 - lib/knockapi/models/page_info.rb
 - lib/knockapi/models/providers/ms_team_check_auth_params.rb
@@ -345,6 +346,7 @@ files:
 - rbi/knockapi/models/object_unset_channel_data_params.rbi
 - rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi
 - rbi/knockapi/models/objects/bulk_delete_params.rbi
+- rbi/knockapi/models/objects/bulk_delete_subscriptions_params.rbi
 - rbi/knockapi/models/objects/bulk_set_params.rbi
 - rbi/knockapi/models/page_info.rbi
 - rbi/knockapi/models/providers/ms_team_check_auth_params.rbi
@@ -558,6 +560,7 @@ files:
 - sig/knockapi/models/object_unset_channel_data_params.rbs
 - sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs
 - sig/knockapi/models/objects/bulk_delete_params.rbs
+- sig/knockapi/models/objects/bulk_delete_subscriptions_params.rbs
 - sig/knockapi/models/objects/bulk_set_params.rbs
 - sig/knockapi/models/page_info.rbs
 - sig/knockapi/models/providers/ms_team_check_auth_params.rbs