knockapi 1.32.1 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5615477f5b1c715843b8dc300846dc6fe864b8085b2efdebfa170022b9c902bc
-  data.tar.gz: 2d600578fb21c61196086dd0072875631c00421ac7b178f2eef69f4eb5bfb496
+  metadata.gz: fb5f76000d121d8c600814efe156b7cf2f4b4462a226fecbb21b4748a9b65e18
+  data.tar.gz: cae6459c8ef79cce6dea2a81cd25493a526511316d89fdb0a92e85f10759cf3e
 SHA512:
-  metadata.gz: d4d96ca430662841cd9e6f21e72ec0d2d65ff8006c401b1fba649263fd650fe5846b677ab3feb796a8c37f914a016ceeb54824730350f664ac45d3dfa5862231
-  data.tar.gz: cc0f14aba26ed50e4a97bafaf51a6e6bf56bc278c535fe681a8b0266ccd79e4a0d0e023232a4a2abdee49079531b5af60504afe4f04d8462d0151f3a1a7e95ee
+  metadata.gz: 9469436d0f22fdcac4390c410b9d3611c498d5406657fa0b4c0c117d05c11dfcc3f9c17bfabcf1187a03041d370f09e6b468f81ee67f0dd7b57cffb9f4c98411
+  data.tar.gz: 431e2d390a4bfbdbc12f5a6efa1e0e6446ef51a64628da70e8a852399e9477b1179ed1545498b307ebf4a60413d34fbc6f2e3ae17dafc5e0a5c61184c8b0402d

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## 1.34.0 (2026-03-16)
+
+Full Changelog: [v1.33.0...v1.34.0](https://github.com/knocklabs/knock-ruby/compare/v1.33.0...v1.34.0)
+
+### Features
+
+* **api:** api update ([8f572c6](https://github.com/knocklabs/knock-ruby/commit/8f572c6bb0d7deb1d20a1abe3924f1e95f21ca2d))
+* **api:** api update ([5232e1e](https://github.com/knocklabs/knock-ruby/commit/5232e1edcd1da902db9b04aff3fbb0cfae0bed90))
+* **api:** api update ([765390c](https://github.com/knocklabs/knock-ruby/commit/765390cceb4a9137a3faaa4604c9f8ab5ce78a20))
+* **api:** api update ([e83aaa6](https://github.com/knocklabs/knock-ruby/commit/e83aaa66f6fdee79b306af01052869185625d468))
+* **api:** api update ([8cfb413](https://github.com/knocklabs/knock-ruby/commit/8cfb4139f35be6b9c98e9544deda42736253c40f))
+
+
+### Bug Fixes
+
+* **client:** add types for path params, and update structure of unions nested in params ([dafc84b](https://github.com/knocklabs/knock-ruby/commit/dafc84b3aa4176307137891ac55f41d025e32ffc))
+
+
+### Chores
+
+* **ci:** skip uploading artifacts on stainless-internal branches ([62439f6](https://github.com/knocklabs/knock-ruby/commit/62439f62236289d132c653ee23fc832a1a78b13b))
+* **internal:** tweak CI branches ([319abd4](https://github.com/knocklabs/knock-ruby/commit/319abd497feab9f1a4a12be7ef58e6f9ea513b8c))
+* **test:** do not count install time for mock server timeout ([f6dd487](https://github.com/knocklabs/knock-ruby/commit/f6dd487a2952bf560de7373eed043173debc2529))
+
+## 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.34.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/models/audience_add_members_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute key
+      #
+      #   @return [String]
+      required :key, String
+
       # @!attribute members
       #   A list of audience members to add. You can add up to 1,000 members per request.
       #
@@ -19,7 +24,9 @@ module Knockapi
       #   @return [Boolean, nil]
       optional :create_audience, Knockapi::Internal::Type::Boolean
 
-      # @!method initialize(members:, create_audience: nil, request_options: {})
+      # @!method initialize(key:, members:, create_audience: nil, request_options: {})
+      #   @param key [String]
+      #
       #   @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add. You can add up to 1,000 members per request.
       #
       #   @param create_audience [Boolean] Create the audience if it does not exist.

data/lib/knockapi/models/audience_list_members_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute key
+      #
+      #   @return [String]
+      required :key, String
+
+      # @!method initialize(key:, request_options: {})
+      #   @param key [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/audience_remove_members_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute key
+      #
+      #   @return [String]
+      required :key, String
+
       # @!attribute members
       #   A list of audience members to remove. You can remove up to 1,000 members per
       #   request.
@@ -14,10 +19,12 @@ module Knockapi
       #   @return [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>]
       required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceRemoveMembersParams::Member] }
 
-      # @!method initialize(members:, request_options: {})
+      # @!method initialize(key:, members:, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::AudienceRemoveMembersParams} for more details.
       #
+      #   @param key [String]
+      #
       #   @param members [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>] A list of audience members to remove. You can remove up to 1,000 members per req
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]

data/lib/knockapi/models/bulk_operation_get_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/channels/bulk_update_message_status_params.rb

@@ -8,6 +8,16 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        # @!attribute channel_id
+        #
+        #   @return [String]
+        required :channel_id, String
+
+        # @!attribute action
+        #
+        #   @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action]
+        required :action, enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::Action }
+
         # @!attribute archived
         #   Limits the results to messages with the given archived status.
         #
@@ -71,10 +81,14 @@ module Knockapi
         #   @return [Array<String>, nil]
         optional :workflows, Knockapi::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {})
+        # @!method initialize(channel_id:, action:, archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
         #
+        #   @param channel_id [String]
+        #
+        #   @param action [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action]
+        #
         #   @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
         #
         #   @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.

data/lib/knockapi/models/condition.rb

@@ -56,6 +56,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/lib/knockapi/models/message_archive_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/message_get_content_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/message_get_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/message_list_activities_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
       # @!attribute after
       #   The cursor to fetch entries after.
       #
@@ -31,7 +36,9 @@ module Knockapi
       #   @return [String, nil]
       optional :trigger_data, String
 
-      # @!method initialize(after: nil, before: nil, page_size: nil, trigger_data: nil, request_options: {})
+      # @!method initialize(message_id:, after: nil, before: nil, page_size: nil, trigger_data: nil, request_options: {})
+      #   @param message_id [String]
+      #
       #   @param after [String] The cursor to fetch entries after.
       #
       #   @param before [String] The cursor to fetch entries before.

data/lib/knockapi/models/message_list_delivery_logs_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
       # @!attribute after
       #   The cursor to fetch entries after.
       #
@@ -25,7 +30,9 @@ module Knockapi
       #   @return [Integer, nil]
       optional :page_size, Integer
 
-      # @!method initialize(after: nil, before: nil, page_size: nil, request_options: {})
+      # @!method initialize(message_id:, after: nil, before: nil, page_size: nil, request_options: {})
+      #   @param message_id [String]
+      #
       #   @param after [String] The cursor to fetch entries after.
       #
       #   @param before [String] The cursor to fetch entries before.

data/lib/knockapi/models/message_list_events_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
       # @!attribute after
       #   The cursor to fetch entries after.
       #
@@ -25,7 +30,9 @@ module Knockapi
       #   @return [Integer, nil]
       optional :page_size, Integer
 
-      # @!method initialize(after: nil, before: nil, page_size: nil, request_options: {})
+      # @!method initialize(message_id:, after: nil, before: nil, page_size: nil, request_options: {})
+      #   @param message_id [String]
+      #
       #   @param after [String] The cursor to fetch entries after.
       #
       #   @param before [String] The cursor to fetch entries before.

data/lib/knockapi/models/message_mark_as_interacted_params.rb

@@ -7,13 +7,20 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
       # @!attribute metadata
       #   Metadata about the interaction.
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
 
-      # @!method initialize(metadata: nil, request_options: {})
+      # @!method initialize(message_id:, metadata: nil, request_options: {})
+      #   @param message_id [String]
+      #
       #   @param metadata [Hash{Symbol=>Object}] Metadata about the interaction.
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]

data/lib/knockapi/models/message_mark_as_read_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/message_mark_as_seen_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/message_mark_as_unread_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/message_mark_as_unseen_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/message_unarchive_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/object_add_subscriptions_params.rb

@@ -7,6 +7,16 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute collection
+      #
+      #   @return [String]
+      required :collection, String
+
+      # @!attribute object_id_
+      #
+      #   @return [String]
+      required :object_id_, String
+
       # @!attribute recipients
       #   The recipients of the subscription. You can subscribe up to 100 recipients to an
       #   object at a time.
@@ -20,10 +30,14 @@ module Knockapi
       #   @return [Hash{Symbol=>Object}, nil]
       optional :properties, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
 
-      # @!method initialize(recipients:, properties: nil, request_options: {})
+      # @!method initialize(collection:, object_id_:, recipients:, properties: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::ObjectAddSubscriptionsParams} for more details.
       #
+      #   @param collection [String]
+      #
+      #   @param object_id_ [String]
+      #
       #   @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
       #
       #   @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.

data/lib/knockapi/models/object_delete_params.rb

@@ -7,7 +7,19 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute collection
+      #
+      #   @return [String]
+      required :collection, String
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(collection:, id:, request_options: {})
+      #   @param collection [String]
+      #   @param id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/object_delete_subscriptions_params.rb

@@ -7,6 +7,16 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute collection
+      #
+      #   @return [String]
+      required :collection, String
+
+      # @!attribute object_id_
+      #
+      #   @return [String]
+      required :object_id_, String
+
       # @!attribute recipients
       #   The recipients of the subscription. You can subscribe up to 100 recipients to an
       #   object at a time.
@@ -14,10 +24,14 @@ module Knockapi
       #   @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>]
       required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
 
-      # @!method initialize(recipients:, request_options: {})
+      # @!method initialize(collection:, object_id_:, recipients:, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::ObjectDeleteSubscriptionsParams} for more details.
       #
+      #   @param collection [String]
+      #
+      #   @param object_id_ [String]
+      #
       #   @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]

data/lib/knockapi/models/object_get_channel_data_params.rb

@@ -7,7 +7,25 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute collection
+      #
+      #   @return [String]
+      required :collection, String
+
+      # @!attribute object_id_
+      #
+      #   @return [String]
+      required :object_id_, String
+
+      # @!attribute channel_id
+      #
+      #   @return [String]
+      required :channel_id, String
+
+      # @!method initialize(collection:, object_id_:, channel_id:, request_options: {})
+      #   @param collection [String]
+      #   @param object_id_ [String]
+      #   @param channel_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/object_get_params.rb

@@ -7,7 +7,19 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute collection
+      #
+      #   @return [String]
+      required :collection, String
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(collection:, id:, request_options: {})
+      #   @param collection [String]
+      #   @param id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end