release: 1.34.0

.github/workflows/ci.yml

@@ -1,12 +1,14 @@
 name: CI
 on:
   push:
-    branches-ignore:
-      - 'generated'
-      - 'codegen/**'
-      - 'integrated/**'
-      - 'stl-preview-head/**'
-      - 'stl-preview-base/**'
+    branches:
+      - '**'
+      - '!integrated/**'
+      - '!stl-preview-head/**'
+      - '!stl-preview-base/**'
+      - '!generated'
+      - '!codegen/**'
+      - 'codegen/stl/**'
   pull_request:
     branches-ignore:
       - 'stl-preview-head/**'
@@ -33,14 +35,18 @@ jobs:
           bundle install
 
       - name: Get GitHub OIDC Token
-        if: github.repository == 'stainless-sdks/knock-ruby'
+        if: |-
+          github.repository == 'stainless-sdks/knock-ruby' &&
+          !startsWith(github.ref, 'refs/heads/stl/')
         id: github-oidc
         uses: actions/github-script@v8
         with:
           script: core.setOutput('github_token', await core.getIDToken());
 
       - name: Build and upload gem artifacts
-        if: github.repository == 'stainless-sdks/knock-ruby'
+        if: |-
+          github.repository == 'stainless-sdks/knock-ruby' &&
+          !startsWith(github.ref, 'refs/heads/stl/')
         env:
           URL: https://pkg.stainless.com/s
           AUTH: ${{ steps.github-oidc.outputs.github_token }}

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.33.0"
+  ".": "1.34.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 90
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-eaaacf2abf99e5ee2fd681d70e02e9d0bbc7a0216d25cf4f10bae75c5fb59df5.yml
-openapi_spec_hash: 51a8f39a76a1bcd85d29a0949d6c353a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-8453f7087b0207e02d485220151fc4eb2348689b4c281de0184cdc80f9a15c01.yml
+openapi_spec_hash: deda6ffd2fc6c4d79a556cb216811cc8
 config_hash: 32503026a45db991d0d102f25af40a77

CHANGELOG.md

@@ -1,5 +1,29 @@
 # 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)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    knockapi (1.33.0)
+    knockapi (1.34.0)
       cgi
       connection_pool
 

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

lib/knockapi/models/audience_add_members_params.rb

@@ -7,6 +7,11 @@ class AudienceAddMembersParams < Knockapi::Internal::Type::BaseModel
       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 @@ class AudienceAddMembersParams < Knockapi::Internal::Type::BaseModel
       #   @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.

lib/knockapi/models/audience_list_members_params.rb

@@ -7,7 +7,13 @@ class AudienceListMembersParams < Knockapi::Internal::Type::BaseModel
       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

lib/knockapi/models/audience_remove_members_params.rb

@@ -7,17 +7,24 @@ class AudienceRemoveMembersParams < Knockapi::Internal::Type::BaseModel
       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.
       #
       #   @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}]

lib/knockapi/models/bulk_operation_get_params.rb

@@ -7,7 +7,13 @@ class BulkOperationGetParams < Knockapi::Internal::Type::BaseModel
       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

lib/knockapi/models/channels/bulk_update_message_status_params.rb

@@ -8,6 +8,16 @@ class BulkUpdateMessageStatusParams < Knockapi::Internal::Type::BaseModel
         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 @@ class BulkUpdateMessageStatusParams < Knockapi::Internal::Type::BaseModel
         #   @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.

lib/knockapi/models/condition.rb

@@ -56,6 +56,7 @@ module Operator
         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
 

lib/knockapi/models/message_archive_params.rb

@@ -7,7 +7,13 @@ class MessageArchiveParams < Knockapi::Internal::Type::BaseModel
       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

lib/knockapi/models/message_get_content_params.rb

@@ -7,7 +7,13 @@ class MessageGetContentParams < Knockapi::Internal::Type::BaseModel
       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

lib/knockapi/models/message_get_params.rb

@@ -7,7 +7,13 @@ class MessageGetParams < Knockapi::Internal::Type::BaseModel
       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

lib/knockapi/models/message_list_activities_params.rb

@@ -7,6 +7,11 @@ class MessageListActivitiesParams < Knockapi::Internal::Type::BaseModel
       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 @@ class MessageListActivitiesParams < Knockapi::Internal::Type::BaseModel
       #   @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.

lib/knockapi/models/message_list_delivery_logs_params.rb

@@ -7,6 +7,11 @@ class MessageListDeliveryLogsParams < Knockapi::Internal::Type::BaseModel
       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 @@ class MessageListDeliveryLogsParams < Knockapi::Internal::Type::BaseModel
       #   @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.

lib/knockapi/models/message_list_events_params.rb

@@ -7,6 +7,11 @@ class MessageListEventsParams < Knockapi::Internal::Type::BaseModel
       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 @@ class MessageListEventsParams < Knockapi::Internal::Type::BaseModel
       #   @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.

lib/knockapi/models/message_mark_as_interacted_params.rb

@@ -7,13 +7,20 @@ class MessageMarkAsInteractedParams < Knockapi::Internal::Type::BaseModel
       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}]

lib/knockapi/models/message_mark_as_read_params.rb

@@ -7,7 +7,13 @@ class MessageMarkAsReadParams < Knockapi::Internal::Type::BaseModel
       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

lib/knockapi/models/message_mark_as_seen_params.rb

@@ -7,7 +7,13 @@ class MessageMarkAsSeenParams < Knockapi::Internal::Type::BaseModel
       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