release: 1.9.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.8.1"
+  ".": "1.9.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 89
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-c15e6924891ae19a301d5e878d353bda7cf6aa486c13be9525fe9d4d06eb140f.yml
-openapi_spec_hash: 397a88d71e81d4339d41c151a61e12b9
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-fa68e7353b6d2eb51af35279f2f591a7d6168c5ade69c3cf40b5aae119ebcce1.yml
+openapi_spec_hash: f9315c4f1d89624aa2447499dbfe734c
 config_hash: b4c547c1d4c8cd0834bc793ddf5388ee

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.9.0 (2025-06-27)
+
+Full Changelog: [v1.8.1...v1.9.0](https://github.com/knocklabs/knock-ruby/compare/v1.8.1...v1.9.0)
+
+### Features
+
+* **api:** api update ([fc8b2d2](https://github.com/knocklabs/knock-ruby/commit/fc8b2d240d0ae0185fea80a1be818505f94f1d16))
+* **api:** api update ([f4f2f96](https://github.com/knocklabs/knock-ruby/commit/f4f2f96ded6152ac1d38ddbded881e306cd682ec))
+
+
+### Bug Fixes
+
+* **ci:** release-doctor — report correct token name ([dd5f4e2](https://github.com/knocklabs/knock-ruby/commit/dd5f4e20bca8d0881af1593f0a164963e31a1bb9))
+
 ## 1.8.1 (2025-06-18)
 
 Full Changelog: [v1.8.0...v1.8.1](https://github.com/knocklabs/knock-ruby/compare/v1.8.0...v1.8.1)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    knockapi (1.8.1)
+    knockapi (1.9.0)
       connection_pool
 
 GEM

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

bin/check-release-environment

@@ -3,7 +3,7 @@
 errors=()
 
 if [ -z "${GEM_HOST_API_KEY}" ]; then
-  errors+=("The KNOCK_GEM_HOST_API_KEY secret has not been set. Please set it in either this repository's secrets or your organization secrets")
+  errors+=("The GEM_HOST_API_KEY secret has not been set. Please set it in either this repository's secrets or your organization secrets")
 fi
 
 lenErrors=${#errors[@]}

lib/knockapi/models/audience_add_members_params.rb

@@ -41,15 +41,15 @@ class Member < Knockapi::Internal::Type::BaseModel
         # @see Knockapi::Models::AudienceAddMembersParams::Member#user
         class User < Knockapi::Internal::Type::BaseModel
           # @!attribute id
-          #   The ID for the user that you set when identifying them in Knock.
+          #   The unique identifier of the user.
           #
           #   @return [String, nil]
           optional :id, String
 
           # @!method initialize(id: nil)
           #   An object containing the user's ID.
           #
-          #   @param id [String] The ID for the user that you set when identifying them in Knock.
+          #   @param id [String] The unique identifier of the user.
         end
       end
     end

lib/knockapi/models/audience_member.rb

@@ -24,7 +24,7 @@ class AudienceMember < Knockapi::Internal::Type::BaseModel
       required :user, -> { Knockapi::User }
 
       # @!attribute user_id
-      #   The ID for the user that you set when identifying them in Knock.
+      #   The unique identifier of the user.
       #
       #   @return [String]
       required :user_id, String
@@ -47,7 +47,7 @@ class AudienceMember < Knockapi::Internal::Type::BaseModel
       #
       #   @param user [Knockapi::Models::User] A [User](/concepts/users) represents an individual in your system who can receiv
       #
-      #   @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      #   @param user_id [String] The unique identifier of the user.
       #
       #   @param tenant [String, nil] The unique identifier for the tenant.
     end

lib/knockapi/models/audience_remove_members_params.rb

@@ -44,15 +44,15 @@ class Member < Knockapi::Internal::Type::BaseModel
         # @see Knockapi::Models::AudienceRemoveMembersParams::Member#user
         class User < Knockapi::Internal::Type::BaseModel
           # @!attribute id
-          #   The ID for the user that you set when identifying them in Knock.
+          #   The unique identifier of the user.
           #
           #   @return [String, nil]
           optional :id, String
 
           # @!method initialize(id: nil)
           #   An object containing the user's ID.
           #
-          #   @param id [String] The ID for the user that you set when identifying them in Knock.
+          #   @param id [String] The unique identifier of the user.
         end
       end
     end

lib/knockapi/models/identify_user_request.rb

@@ -4,7 +4,7 @@ module Knockapi
   module Models
     class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel
       # @!attribute avatar
-      #   URL to the user's avatar image.
+      #   A URL for the avatar of the user.
       #
       #   @return [String, nil]
       optional :avatar, String, nil?: true
@@ -77,7 +77,7 @@ class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel
       #   that's specified elsewhere in the request. You can supply any additional
       #   properties you'd like to upsert for the user.
       #
-      #   @param avatar [String, nil] URL to the user's avatar image.
+      #   @param avatar [String, nil] A URL for the avatar of the user.
       #
       #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
       #

lib/knockapi/models/inline_identify_user_request.rb

@@ -4,13 +4,13 @@ module Knockapi
   module Models
     class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel
       # @!attribute id
-      #   The ID for the user that you set when identifying them in Knock.
+      #   The unique identifier of the user.
       #
       #   @return [String]
       required :id, String
 
       # @!attribute avatar
-      #   URL to the user's avatar image.
+      #   A URL for the avatar of the user.
       #
       #   @return [String, nil]
       optional :avatar, String, nil?: true
@@ -84,9 +84,9 @@ class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel
       #   It will perform an upsert for the user you're supplying, replacing any
       #   properties specified.
       #
-      #   @param id [String] The ID for the user that you set when identifying them in Knock.
+      #   @param id [String] The unique identifier of the user.
       #
-      #   @param avatar [String, nil] URL to the user's avatar image.
+      #   @param avatar [String, nil] A URL for the avatar of the user.
       #
       #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
       #

lib/knockapi/models/message.rb

@@ -230,7 +230,13 @@ class Source < Knockapi::Internal::Type::BaseModel
         #   @return [String]
         required :version_id, String
 
-        # @!method initialize(_typename:, categories:, key:, version_id:)
+        # @!attribute step_ref
+        #   The step reference for the step in the workflow that generated the message
+        #
+        #   @return [String, nil]
+        optional :step_ref, String, nil?: true
+
+        # @!method initialize(_typename:, categories:, key:, version_id:, step_ref: nil)
         #   The workflow that triggered the message.
         #
         #   @param _typename [String]
@@ -240,6 +246,8 @@ class Source < Knockapi::Internal::Type::BaseModel
         #   @param key [String] The key of the workflow that triggered the message.
         #
         #   @param version_id [String] The ID of the version of the workflow that triggered the message.
+        #
+        #   @param step_ref [String, nil] The step reference for the step in the workflow that generated the message
       end
 
       # The message delivery status.

lib/knockapi/models/message_get_content_response.rb

@@ -51,7 +51,7 @@ module Data
         # The content of an SMS message.
         variant -> { Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent }
 
-        # The content of a push notification.
+        # Push channel data.
         variant -> { Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent }
 
         # The content of a chat message.
@@ -198,7 +198,7 @@ class MessagePushContent < Knockapi::Internal::Type::BaseModel
           optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
 
           # @!method initialize(token:, _typename:, body:, title:, data: nil)
-          #   The content of a push notification.
+          #   Push channel data.
           #
           #   @param token [String] The device token to send the push notification to.
           #

lib/knockapi/models/message_list_activities_params.rb

@@ -20,7 +20,7 @@ class MessageListActivitiesParams < Knockapi::Internal::Type::BaseModel
       optional :before, String
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -36,7 +36,7 @@ class MessageListActivitiesParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param before [String] The cursor to fetch entries before.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param trigger_data [String] The trigger data to filter activities by.
       #

lib/knockapi/models/message_list_delivery_logs_params.rb

@@ -20,7 +20,7 @@ class MessageListDeliveryLogsParams < Knockapi::Internal::Type::BaseModel
       optional :before, String
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -30,7 +30,7 @@ class MessageListDeliveryLogsParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param before [String] The cursor to fetch entries before.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end

lib/knockapi/models/message_list_events_params.rb

@@ -20,7 +20,7 @@ class MessageListEventsParams < Knockapi::Internal::Type::BaseModel
       optional :before, String
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -30,7 +30,7 @@ class MessageListEventsParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param before [String] The cursor to fetch entries before.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end

lib/knockapi/models/message_list_params.rb

@@ -45,7 +45,7 @@ class MessageListParams < Knockapi::Internal::Type::BaseModel
       optional :message_ids, Knockapi::Internal::Type::ArrayOf[String]
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -111,7 +111,7 @@ class MessageListParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param source [String] Limits the results to messages triggered by the given workflow key.
       #

lib/knockapi/models/messages/batch_get_content_response.rb

@@ -51,7 +51,7 @@ module Data
           # The content of an SMS message.
           variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent }
 
-          # The content of a push notification.
+          # Push channel data.
           variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent }
 
           # The content of a chat message.
@@ -198,7 +198,7 @@ class MessagePushContent < Knockapi::Internal::Type::BaseModel
             optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
 
             # @!method initialize(token:, _typename:, body:, title:, data: nil)
-            #   The content of a push notification.
+            #   Push channel data.
             #
             #   @param token [String] The device token to send the push notification to.
             #

lib/knockapi/models/object_list_messages_params.rb

@@ -47,7 +47,7 @@ class ObjectListMessagesParams < Knockapi::Internal::Type::BaseModel
       optional :message_ids, Knockapi::Internal::Type::ArrayOf[String]
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -114,7 +114,7 @@ class ObjectListMessagesParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param source [String] Limits the results to messages triggered by the given workflow key.
       #

lib/knockapi/models/object_list_params.rb

@@ -26,7 +26,7 @@ class ObjectListParams < Knockapi::Internal::Type::BaseModel
       optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListParams::Include] }
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -38,7 +38,7 @@ class ObjectListParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param include [Array<Symbol, Knockapi::Models::ObjectListParams::Include>] Includes preferences of the objects in the response.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
 

lib/knockapi/models/object_list_schedules_params.rb

@@ -20,7 +20,7 @@ class ObjectListSchedulesParams < Knockapi::Internal::Type::BaseModel
       optional :before, String
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -42,7 +42,7 @@ class ObjectListSchedulesParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param before [String] The cursor to fetch entries before.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param tenant [String] Filter schedules by tenant id.
       #

lib/knockapi/models/object_list_subscriptions_params.rb

@@ -44,7 +44,7 @@ class ObjectListSubscriptionsParams < Knockapi::Internal::Type::BaseModel
                -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ObjectListSubscriptionsParams::Object] }
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -69,7 +69,7 @@ class ObjectListSubscriptionsParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param objects [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
       #

lib/knockapi/models/page_info.rb

@@ -10,7 +10,7 @@ class PageInfo < Knockapi::Internal::Type::BaseModel
       required :_typename, String, api_name: :__typename
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer]
       required :page_size, Integer
@@ -32,7 +32,7 @@ class PageInfo < Knockapi::Internal::Type::BaseModel
       #
       #   @param _typename [String] The typename of the schema.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param after [String, nil] The cursor to fetch entries after.
       #

lib/knockapi/models/recipients/channel_data.rb

@@ -45,13 +45,13 @@ class RecipientsChannelData < Knockapi::Internal::Type::BaseModel
         module Data
           extend Knockapi::Internal::Type::Union
 
-          # The content of a push notification.
+          # Push channel data.
           variant -> { Knockapi::Recipients::PushChannelData }
 
-          # Slack channel data
+          # Slack channel data.
           variant -> { Knockapi::Recipients::SlackChannelData }
 
-          # Microsoft Teams channel connection.
+          # Microsoft Teams channel data.
           variant -> { Knockapi::Recipients::MsTeamsChannelData }
 
           # Discord channel data.