knockapi 1.32.1 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5615477f5b1c715843b8dc300846dc6fe864b8085b2efdebfa170022b9c902bc
-  data.tar.gz: 2d600578fb21c61196086dd0072875631c00421ac7b178f2eef69f4eb5bfb496
+  metadata.gz: fdf258bbe7e17f9d95456fd503712fa051dcd85fa28d8dd9e308cc3e33b5ffa3
+  data.tar.gz: 435914a90c65531ac4dcafdb5af0ea1ef4ba6febfa948865bb60458c99ae3c9e
 SHA512:
-  metadata.gz: d4d96ca430662841cd9e6f21e72ec0d2d65ff8006c401b1fba649263fd650fe5846b677ab3feb796a8c37f914a016ceeb54824730350f664ac45d3dfa5862231
-  data.tar.gz: cc0f14aba26ed50e4a97bafaf51a6e6bf56bc278c535fe681a8b0266ccd79e4a0d0e023232a4a2abdee49079531b5af60504afe4f04d8462d0151f3a1a7e95ee
+  metadata.gz: 39584fbdff4b91e0630c6c7d8e05b7ac73c57de5e442945aa31bb3883fa3cfc3b9a705f074ac9cc4cc0e0f464ee6e19b431d6cb81b8e63e0ef332bad4bd808e3
+  data.tar.gz: 47c33e8c167fb90c047a78fb3831266fa720f5d96b89763411dd2c75ffd5cfdbe956b6fd10c58af6bee121be65b919ef51c51ab9f55bef584c5927aac854a2bb

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.33.0 (2026-03-03)
+
+Full Changelog: [v1.32.1...v1.33.0](https://github.com/knocklabs/knock-ruby/compare/v1.32.1...v1.33.0)
+
+### Features
+
+* **api:** api update ([7ba6675](https://github.com/knocklabs/knock-ruby/commit/7ba667550ffe7a071924b835e6f7bbb735dc93ad))
+* **api:** api update ([9a5227f](https://github.com/knocklabs/knock-ruby/commit/9a5227feaac4df242717be5e3704e4e327783250))
+
+
+### Bug Fixes
+
+* **client:** serialize query parameters properly ([0a76966](https://github.com/knocklabs/knock-ruby/commit/0a7696661973ba7e4f461be1bda646a3654a955a))
+
+
+### Chores
+
+* **ci:** add build step ([979140d](https://github.com/knocklabs/knock-ruby/commit/979140db56dabc14ead8dd64cee25c12c38f8c40))
+* **docs:** add missing descriptions ([d1d2610](https://github.com/knocklabs/knock-ruby/commit/d1d26104b361735f37a9739d676e350d088f27b8))
+
 ## 1.32.1 (2026-02-26)
 
 Full Changelog: [v1.32.0...v1.32.1](https://github.com/knocklabs/knock-ruby/compare/v1.32.0...v1.32.1)

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.32.1"
+gem "knockapi", "~> 1.33.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/client.rb

@@ -25,18 +25,26 @@ module Knockapi
     # @return [Knockapi::Resources::Recipients]
     attr_reader :recipients
 
+    # A user is an individual from your system, represented in Knock. They are most
+    # commonly a recipient of a notification.
     # @return [Knockapi::Resources::Users]
     attr_reader :users
 
+    # An object represents a resource in your system that you want to map into Knock.
     # @return [Knockapi::Resources::Objects]
     attr_reader :objects
 
+    # A tenant represents a top-level entity from your system, like a company,
+    # organization, account, or workspace.
     # @return [Knockapi::Resources::Tenants]
     attr_reader :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.
     # @return [Knockapi::Resources::BulkOperations]
     attr_reader :bulk_operations
 
+    # A message sent to a single recipient on a channel.
     # @return [Knockapi::Resources::Messages]
     attr_reader :messages
 
@@ -46,15 +54,20 @@ module Knockapi
     # @return [Knockapi::Resources::Integrations]
     attr_reader :integrations
 
+    # A workflow is a structured set of steps that is triggered to produce
+    # notifications sent over channels.
     # @return [Knockapi::Resources::Workflows]
     attr_reader :workflows
 
+    # A schedule is a per-recipient, timezone-aware configuration for when to invoke a
+    # workflow.
     # @return [Knockapi::Resources::Schedules]
     attr_reader :schedules
 
     # @return [Knockapi::Resources::Channels]
     attr_reader :channels
 
+    # An Audience is a segment of users.
     # @return [Knockapi::Resources::Audiences]
     attr_reader :audiences
 

data/lib/knockapi/internal/util.rb

@@ -490,6 +490,37 @@ module Knockapi
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection["#{key}[]"] = element.map(&:to_s)
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]

data/lib/knockapi/resources/audiences.rb

@@ -2,6 +2,7 @@
 
 module Knockapi
   module Resources
+    # An Audience is a segment of users.
     class Audiences
       # Some parameter documentations has been truncated, see
       # {Knockapi::Models::AudienceAddMembersParams} for more details.
@@ -22,12 +23,13 @@ module Knockapi
       #
       # @see Knockapi::Models::AudienceAddMembersParams
       def add_members(key, params)
-        parsed, options = Knockapi::AudienceAddMembersParams.dump_request(params)
         query_params = [:create_audience]
+        parsed, options = Knockapi::AudienceAddMembersParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :post,
           path: ["v1/audiences/%1$s/members", key],
-          query: parsed.slice(*query_params),
+          query: query,
           body: parsed.except(*query_params),
           model: NilClass,
           options: options

data/lib/knockapi/resources/bulk_operations.rb

@@ -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.
       #

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

@@ -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
         # Some parameter documentations has been truncated, see
         # {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.

data/lib/knockapi/resources/channels.rb

@@ -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.
       # @return [Knockapi::Resources::Channels::Bulk]
       attr_reader :bulk
 

data/lib/knockapi/resources/messages/batch.rb

@@ -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.
@@ -40,10 +41,11 @@ module Knockapi
         # @see Knockapi::Models::Messages::BatchGetContentParams
         def get_content(params)
           parsed, options = Knockapi::Messages::BatchGetContentParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: "v1/messages/batch/content",
-            query: parsed,
+            query: query,
             model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Messages::BatchGetContentResponseItem],
             options: options
           )

data/lib/knockapi/resources/messages.rb

@@ -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.
       # @return [Knockapi::Resources::Messages::Batch]
       attr_reader :batch
 
@@ -48,10 +50,11 @@ module Knockapi
       # @see Knockapi::Models::MessageListParams
       def list(params = {})
         parsed, options = Knockapi::MessageListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "v1/messages",
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::Message,
           options: options
@@ -141,10 +144,11 @@ module Knockapi
       # @see Knockapi::Models::MessageListActivitiesParams
       def list_activities(message_id, params = {})
         parsed, options = Knockapi::MessageListActivitiesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/messages/%1$s/activities", message_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::Activity,
           options: options
@@ -170,10 +174,11 @@ module Knockapi
       # @see Knockapi::Models::MessageListDeliveryLogsParams
       def list_delivery_logs(message_id, params = {})
         parsed, options = Knockapi::MessageListDeliveryLogsParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/messages/%1$s/delivery_logs", message_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::MessageDeliveryLog,
           options: options
@@ -199,10 +204,11 @@ module Knockapi
       # @see Knockapi::Models::MessageListEventsParams
       def list_events(message_id, params = {})
         parsed, options = Knockapi::MessageListEventsParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/messages/%1$s/events", message_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::MessageEvent,
           options: options

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

@@ -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.
         #

data/lib/knockapi/resources/objects.rb

@@ -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.
       # @return [Knockapi::Resources::Objects::Bulk]
       attr_reader :bulk
 
@@ -28,10 +31,11 @@ module Knockapi
       # @see Knockapi::Models::ObjectListParams
       def list(collection, params = {})
         parsed, options = Knockapi::ObjectListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/objects/%1$s", collection],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Object,
           options: options
@@ -244,10 +248,11 @@ module Knockapi
       # @see Knockapi::Models::ObjectListMessagesParams
       def list_messages(collection, id, params = {})
         parsed, options = Knockapi::ObjectListMessagesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/objects/%1$s/%2$s/messages", collection, id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::Message,
           options: options
@@ -301,10 +306,11 @@ module Knockapi
       # @see Knockapi::Models::ObjectListSchedulesParams
       def list_schedules(collection, id, params = {})
         parsed, options = Knockapi::ObjectListSchedulesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/objects/%1$s/%2$s/schedules", collection, id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Schedule,
           options: options
@@ -345,10 +351,11 @@ module Knockapi
       # @see Knockapi::Models::ObjectListSubscriptionsParams
       def list_subscriptions(collection, object_id_, params = {})
         parsed, options = Knockapi::ObjectListSubscriptionsParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/objects/%1$s/%2$s/subscriptions", collection, object_id_],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Recipients::Subscription,
           options: options

data/lib/knockapi/resources/providers/ms_teams.rb

@@ -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.
@@ -20,10 +22,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::MsTeamCheckAuthParams
         def check_auth(channel_id, params)
           parsed, options = Knockapi::Providers::MsTeamCheckAuthParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/ms-teams/%1$s/auth_check", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::MsTeamCheckAuthResponse,
             options: options
           )
@@ -49,10 +52,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::MsTeamListChannelsParams
         def list_channels(channel_id, params)
           parsed, options = Knockapi::Providers::MsTeamListChannelsParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/ms-teams/%1$s/channels", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::MsTeamListChannelsResponse,
             options: options
           )
@@ -76,10 +80,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::MsTeamListTeamsParams
         def list_teams(channel_id, params)
           parsed, options = Knockapi::Providers::MsTeamListTeamsParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/ms-teams/%1$s/teams", channel_id],
-            query: parsed,
+            query: query,
             page: Knockapi::Internal::MsTeamsPagination,
             model: Knockapi::Models::Providers::MsTeamListTeamsResponse,
             options: options
@@ -101,10 +106,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::MsTeamRevokeAccessParams
         def revoke_access(channel_id, params)
           parsed, options = Knockapi::Providers::MsTeamRevokeAccessParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :put,
             path: ["v1/providers/ms-teams/%1$s/revoke_access", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::MsTeamRevokeAccessResponse,
             options: options
           )

data/lib/knockapi/resources/providers/slack.rb

@@ -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.
         #
@@ -19,10 +21,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::SlackCheckAuthParams
         def check_auth(channel_id, params)
           parsed, options = Knockapi::Providers::SlackCheckAuthParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/slack/%1$s/auth_check", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::SlackCheckAuthResponse,
             options: options
           )
@@ -45,10 +48,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::SlackListChannelsParams
         def list_channels(channel_id, params)
           parsed, options = Knockapi::Providers::SlackListChannelsParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/slack/%1$s/channels", channel_id],
-            query: parsed,
+            query: query,
             page: Knockapi::Internal::SlackChannelsCursor,
             model: Knockapi::Models::Providers::SlackListChannelsResponse,
             options: options
@@ -70,10 +74,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::SlackRevokeAccessParams
         def revoke_access(channel_id, params)
           parsed, options = Knockapi::Providers::SlackRevokeAccessParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :put,
             path: ["v1/providers/slack/%1$s/revoke_access", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::SlackRevokeAccessResponse,
             options: options
           )

data/lib/knockapi/resources/providers.rb

@@ -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.
       # @return [Knockapi::Resources::Providers::Slack]
       attr_reader :slack
 
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       # @return [Knockapi::Resources::Providers::MsTeams]
       attr_reader :ms_teams
 

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

@@ -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/lib/knockapi/resources/schedules.rb

@@ -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.
       # @return [Knockapi::Resources::Schedules::Bulk]
       attr_reader :bulk
 
@@ -114,10 +118,11 @@ module Knockapi
       # @see Knockapi::Models::ScheduleListParams
       def list(params)
         parsed, options = Knockapi::ScheduleListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "v1/schedules",
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Schedule,
           options: options

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

@@ -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.
@@ -18,10 +20,11 @@ module Knockapi
         # @see Knockapi::Models::Tenants::BulkDeleteParams
         def delete(params)
           parsed, options = Knockapi::Tenants::BulkDeleteParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :post,
             path: "v1/tenants/bulk/delete",
-            query: parsed,
+            query: query,
             model: Knockapi::BulkOperation,
             options: options
           )

data/lib/knockapi/resources/tenants.rb

@@ -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.
       # @return [Knockapi::Resources::Tenants::Bulk]
       attr_reader :bulk
 
@@ -27,10 +31,11 @@ module Knockapi
       # @see Knockapi::Models::TenantListParams
       def list(params = {})
         parsed, options = Knockapi::TenantListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "v1/tenants",
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Tenant,
           options: options
@@ -75,10 +80,11 @@ module Knockapi
       # @see Knockapi::Models::TenantGetParams
       def get(id, params = {})
         parsed, options = Knockapi::TenantGetParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/tenants/%1$s", id],
-          query: parsed,
+          query: query,
           model: Knockapi::Tenant,
           options: options
         )
@@ -108,12 +114,13 @@ module Knockapi
       #
       # @see Knockapi::Models::TenantSetParams
       def set(id, params = {})
-        parsed, options = Knockapi::TenantSetParams.dump_request(params)
         query_params = [:resolve_full_preference_settings]
+        parsed, options = Knockapi::TenantSetParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :put,
           path: ["v1/tenants/%1$s", id],
-          query: parsed.slice(*query_params),
+          query: query,
           body: parsed.except(*query_params),
           model: Knockapi::Tenant,
           options: options

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

@@ -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.
         #

data/lib/knockapi/resources/users/feeds.rb

@@ -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.
         #
@@ -88,10 +90,11 @@ module Knockapi
         # @see Knockapi::Models::Users::FeedListItemsParams
         def list_items(user_id, id, params = {})
           parsed, options = Knockapi::Users::FeedListItemsParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/users/%1$s/feeds/%2$s", user_id, id],
-            query: parsed,
+            query: query,
             page: Knockapi::Internal::EntriesCursor,
             model: Knockapi::Models::Users::FeedListItemsResponse,
             options: options

data/lib/knockapi/resources/users/guides.rb

@@ -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.
         #
@@ -25,10 +27,11 @@ module Knockapi
         # @see Knockapi::Models::Users::GuideGetChannelParams
         def get_channel(user_id, channel_id, params = {})
           parsed, options = Knockapi::Users::GuideGetChannelParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/users/%1$s/guides/%2$s", user_id, channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Users::GuideGetChannelResponse,
             options: options
           )

data/lib/knockapi/resources/users.rb

@@ -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.
       # @return [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.
       # @return [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.
       # @return [Knockapi::Resources::Users::Bulk]
       attr_reader :bulk
 
@@ -77,10 +85,11 @@ module Knockapi
       # @see Knockapi::Models::UserListParams
       def list(params = {})
         parsed, options = Knockapi::UserListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "v1/users",
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::User,
           options: options
@@ -167,10 +176,11 @@ module Knockapi
       # @see Knockapi::Models::UserGetPreferencesParams
       def get_preferences(user_id, id, params = {})
         parsed, options = Knockapi::UserGetPreferencesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/users/%1$s/preferences/%2$s", user_id, id],
-          query: parsed,
+          query: query,
           model: Knockapi::Recipients::PreferenceSet,
           options: options
         )
@@ -222,10 +232,11 @@ module Knockapi
       # @see Knockapi::Models::UserListMessagesParams
       def list_messages(user_id, params = {})
         parsed, options = Knockapi::UserListMessagesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/users/%1$s/messages", user_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::Message,
           options: options
@@ -275,10 +286,11 @@ module Knockapi
       # @see Knockapi::Models::UserListSchedulesParams
       def list_schedules(user_id, params = {})
         parsed, options = Knockapi::UserListSchedulesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/users/%1$s/schedules", user_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Schedule,
           options: options
@@ -309,10 +321,11 @@ module Knockapi
       # @see Knockapi::Models::UserListSubscriptionsParams
       def list_subscriptions(user_id, params = {})
         parsed, options = Knockapi::UserListSubscriptionsParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/users/%1$s/subscriptions", user_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Recipients::Subscription,
           options: options

data/lib/knockapi/resources/workflows.rb

@@ -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
       # Some parameter documentations has been truncated, see
       # {Knockapi::Models::WorkflowCancelParams} for more details.

data/lib/knockapi/version.rb

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

data/rbi/knockapi/client.rbi

@@ -20,18 +20,26 @@ module Knockapi
     sig { returns(Knockapi::Resources::Recipients) }
     attr_reader :recipients
 
+    # 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) }
     attr_reader :users
 
+    # An object represents a resource in your system that you want to map into Knock.
     sig { returns(Knockapi::Resources::Objects) }
     attr_reader :objects
 
+    # A tenant represents a top-level entity from your system, like a company,
+    # organization, account, or workspace.
     sig { returns(Knockapi::Resources::Tenants) }
     attr_reader :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::BulkOperations) }
     attr_reader :bulk_operations
 
+    # A message sent to a single recipient on a channel.
     sig { returns(Knockapi::Resources::Messages) }
     attr_reader :messages
 
@@ -41,15 +49,20 @@ module Knockapi
     sig { returns(Knockapi::Resources::Integrations) }
     attr_reader :integrations
 
+    # A workflow is a structured set of steps that is triggered to produce
+    # notifications sent over channels.
     sig { returns(Knockapi::Resources::Workflows) }
     attr_reader :workflows
 
+    # A schedule is a per-recipient, timezone-aware configuration for when to invoke a
+    # workflow.
     sig { returns(Knockapi::Resources::Schedules) }
     attr_reader :schedules
 
     sig { returns(Knockapi::Resources::Channels) }
     attr_reader :channels
 
+    # An Audience is a segment of users.
     sig { returns(Knockapi::Resources::Audiences) }
     attr_reader :audiences
 

data/rbi/knockapi/internal/util.rbi

@@ -301,6 +301,26 @@ module Knockapi
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Knockapi::Internal::AnyHash).returns(
+            Knockapi::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Knockapi::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

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,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.32.1
+  version: 1.33.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-26 00:00:00.000000000 Z
+date: 2026-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi