knockapi 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de4f4337ddae3ff013f23c8ab79b48785b5bbf34ed79d31dad83b5111a98330f
-  data.tar.gz: ea934f1d6c8128e2bdcb55d14e7904f8da88cfe73e7e0791dc293e5428f997f0
+  metadata.gz: 8d72e806e4aa7f07a86c10e93b8e6060c1da2860ab3d8af247e6c20e83bedacf
+  data.tar.gz: 49d2bd4bfe5cc74233d8549938819497bf410f7b2d5686cb8c2096c6f86d40db
 SHA512:
-  metadata.gz: 4599b2cbbdbdaeda625d4a5b383d19a28fec88c9fe6d33a279967c1f11fa8f96af8c6c20ee1c94c0041137a5c0916fc96ad5903e9ae7e636dd9f1435356d83a3
-  data.tar.gz: 290da7f20e22193ea4b6f0488c9c23cf05f017dada61b9742993b75472944e32d4ffc7cf9e4129299da40a6eef1a4aa3c35bd9c01529c9e81593519270c605e2
+  metadata.gz: 18b9a4fcab27e4ed869e66b8f189f3ddd780dbe6636eba4a29b143d1cc5362a4069812f55a65041b92b5a1820fe8be29b0b08dd16bfb791504b9e1b163d9cb00
+  data.tar.gz: 2c8f5226db4d52750c0905dfc38de19ba144cc771e4b4d9316972f7395641f22a09eebae4e0f63315d4d1450172d490502eed29a13e4959888a932529bfefa35

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 1.15.0 (2025-09-23)
+
+Full Changelog: [v1.14.0...v1.15.0](https://github.com/knocklabs/knock-ruby/compare/v1.14.0...v1.15.0)
+
+### Features
+
+* **api:** api update ([9e20ef7](https://github.com/knocklabs/knock-ruby/commit/9e20ef78f55bd98a4a44ad32a85c63d5b0f7da97))
+* **api:** api update ([f6a598f](https://github.com/knocklabs/knock-ruby/commit/f6a598f8caab8d8fadc652efa12ebbbc62a5d3dc))
+* **api:** set idempotency key header by default ([14e4fac](https://github.com/knocklabs/knock-ruby/commit/14e4face034def9abbb45120d5c1af1cb415b689))
+
+
+### Chores
+
+* improve example values ([3745058](https://github.com/knocklabs/knock-ruby/commit/37450588f7a937fec2ab49ab04c7142493c7d646))
+
+## 1.14.0 (2025-09-19)
+
+Full Changelog: [v1.13.0...v1.14.0](https://github.com/knocklabs/knock-ruby/compare/v1.13.0...v1.14.0)
+
+### Features
+
+* expose response headers for both streams and errors ([5cbf48f](https://github.com/knocklabs/knock-ruby/commit/5cbf48f94eecc974a2e3d9a200a04bbfc9d08db4))
+
+
+### Chores
+
+* do not install brew dependencies in ./scripts/bootstrap by default ([daac840](https://github.com/knocklabs/knock-ruby/commit/daac84029a5ba728f68163b9cccb77dacf56a6b1))
+
 ## 1.13.0 (2025-09-10)
 
 Full Changelog: [v1.12.0...v1.13.0](https://github.com/knocklabs/knock-ruby/compare/v1.12.0...v1.13.0)

data/README.md

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

data/lib/knockapi/client.rb

@@ -80,13 +80,16 @@ module Knockapi
     # @param initial_retry_delay [Float]
     #
     # @param max_retry_delay [Float]
+    #
+    # @param idempotency_header [String]
     def initialize(
       api_key: ENV["KNOCK_API_KEY"],
       base_url: ENV["KNOCK_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY,
+      idempotency_header: "Idempotency-Key"
     )
       base_url ||= "https://api.knock.app"
 
@@ -101,7 +104,8 @@ module Knockapi
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        idempotency_header: idempotency_header
       )
 
       @shared = Knockapi::Resources::Shared.new(client: self)

data/lib/knockapi/errors.rb

@@ -40,6 +40,9 @@ module Knockapi
       # @return [Integer, nil]
       attr_accessor :status
 
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
       # @return [Object, nil]
       attr_accessor :body
 
@@ -47,13 +50,15 @@ module Knockapi
       #
       # @param url [URI::Generic]
       # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
         @url = url
         @status = status
+        @headers = headers
         @body = body
         @request = request
         @response = response
@@ -74,6 +79,7 @@ module Knockapi
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -81,6 +87,7 @@ module Knockapi
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -95,6 +102,7 @@ module Knockapi
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -102,6 +110,7 @@ module Knockapi
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,21 +125,24 @@ module Knockapi
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
       #
       # @return [self]
-      def self.for(url:, status:, body:, request:, response:, message: nil)
-        kwargs = {
-          url: url,
-          status: status,
-          body: body,
-          request: request,
-          response: response,
-          message: message
-        }
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
 
         case status
         in 400
@@ -162,15 +174,17 @@ module Knockapi
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status:, body:, request:, response:, message: nil)
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
         message ||= {url: url.to_s, status: status, body: body}
         super(
           url: url,
           status: status,
+          headers: headers,
           body: body,
           request: request,
           response: response,

data/lib/knockapi/internal/entries_cursor.rb

@@ -60,7 +60,7 @@ module Knockapi
       #
       # @param client [Knockapi::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/knockapi/internal/items_cursor.rb

@@ -60,7 +60,7 @@ module Knockapi
       #
       # @param client [Knockapi::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/knockapi/internal/ms_teams_pagination.rb

@@ -60,7 +60,7 @@ module Knockapi
       #
       # @param client [Knockapi::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/knockapi/internal/slack_channels_cursor.rb

@@ -60,7 +60,7 @@ module Knockapi
       #
       # @param client [Knockapi::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/knockapi/internal/transport/base_client.rb

@@ -47,7 +47,7 @@ module Knockapi
           # @api private
           #
           # @param status [Integer]
-          # @param headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param headers [Hash{String=>String}]
           #
           # @return [Boolean]
           def should_retry?(status, headers:)
@@ -85,7 +85,7 @@ module Knockapi
           #
           # @param status [Integer]
           #
-          # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param response_headers [Hash{String=>String}]
           #
           # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
@@ -378,6 +378,7 @@ module Knockapi
           rescue Knockapi::Errors::APIConnectionError => e
             status = e
           end
+          headers = Knockapi::Internal::Util.normalized_headers(response&.each_header&.to_h)
 
           case status
           in ..299
@@ -390,7 +391,7 @@ module Knockapi
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
-            request = self.class.follow_redirect(request, status: status, response_headers: response)
+            request = self.class.follow_redirect(request, status: status, response_headers: headers)
             send_request(
               request,
               redirect_count: redirect_count + 1,
@@ -399,9 +400,9 @@ module Knockapi
             )
           in Knockapi::Errors::APIConnectionError if retry_count >= max_retries
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
-              Knockapi::Internal::Util.decode_content(response, stream: stream, suppress_error: true)
+              Knockapi::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure
               self.class.reap_connection!(status, stream: stream)
             end
@@ -409,6 +410,7 @@ module Knockapi
             raise Knockapi::Errors::APIStatusError.for(
               url: url,
               status: status,
+              headers: headers,
               body: decoded,
               request: nil,
               response: response
@@ -485,19 +487,21 @@ module Knockapi
             send_retry_header: send_retry_header
           )
 
-          decoded = Knockapi::Internal::Util.decode_content(response, stream: stream)
+          headers = Knockapi::Internal::Util.normalized_headers(response.each_header.to_h)
+          decoded = Knockapi::Internal::Util.decode_content(headers, stream: stream)
           case req
           in {stream: Class => st}
             st.new(
               model: model,
               url: url,
               status: status,
+              headers: headers,
               response: response,
               unwrap: unwrap,
               stream: decoded
             )
           in {page: Class => page}
-            page.new(client: self, req: req, headers: response, page_data: decoded)
+            page.new(client: self, req: req, headers: headers, page_data: decoded)
           else
             unwrapped = Knockapi::Internal::Util.dig(decoded, unwrap)
             Knockapi::Internal::Type::Converter.coerce(model, unwrapped)

data/lib/knockapi/internal/type/base_page.rb

@@ -39,7 +39,7 @@ module Knockapi
         #
         # @param client [Knockapi::Internal::Transport::BaseClient]
         # @param req [Hash{Symbol=>Object}]
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param page_data [Object]
         def initialize(client:, req:, headers:, page_data:)
           @client = client

data/lib/knockapi/internal/util.rb

@@ -647,7 +647,7 @@ module Knockapi
         #
         # Assumes each chunk in stream has `Encoding::BINARY`.
         #
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #

data/lib/knockapi/resources/audiences.rb

@@ -13,7 +13,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [String]
+      # @return [nil]
       #
       # @see Knockapi::Models::AudienceAddMembersParams
       def add_members(key, params)
@@ -22,7 +22,7 @@ module Knockapi
           method: :post,
           path: ["v1/audiences/%1$s/members", key],
           body: parsed,
-          model: String,
+          model: NilClass,
           options: options
         )
       end
@@ -57,7 +57,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [String]
+      # @return [nil]
       #
       # @see Knockapi::Models::AudienceRemoveMembersParams
       def remove_members(key, params)
@@ -66,7 +66,7 @@ module Knockapi
           method: :delete,
           path: ["v1/audiences/%1$s/members", key],
           body: parsed,
-          model: String,
+          model: NilClass,
           options: options
         )
       end

data/lib/knockapi/resources/objects.rb

@@ -49,14 +49,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [String]
+      # @return [nil]
       #
       # @see Knockapi::Models::ObjectDeleteParams
       def delete(collection, id, params = {})
         @client.request(
           method: :delete,
           path: ["v1/objects/%1$s/%2$s", collection, id],
-          model: String,
+          model: NilClass,
           options: params[:request_options]
         )
       end
@@ -478,14 +478,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [String]
+      # @return [nil]
       #
       # @see Knockapi::Models::ObjectUnsetChannelDataParams
       def unset_channel_data(collection, object_id_, channel_id, params = {})
         @client.request(
           method: :delete,
           path: ["v1/objects/%1$s/%2$s/channel_data/%3$s", collection, object_id_, channel_id],
-          model: String,
+          model: NilClass,
           options: params[:request_options]
         )
       end

data/lib/knockapi/resources/tenants.rb

@@ -45,14 +45,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [String]
+      # @return [nil]
       #
       # @see Knockapi::Models::TenantDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
           path: ["v1/tenants/%1$s", id],
-          model: String,
+          model: NilClass,
           options: params[:request_options]
         )
       end

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

@@ -41,7 +41,7 @@ module Knockapi
         #
         # @param user_id [String] The unique identifier of the user.
         #
-        # @param message_id [String] The unique identifier for the message.
+        # @param message_id [String]
         #
         # @param channel_id [String] The unique identifier for the channel.
         #
@@ -84,7 +84,7 @@ module Knockapi
         #
         # @param user_id [String] The unique identifier of the user.
         #
-        # @param message_id [String] The unique identifier for the message.
+        # @param message_id [String]
         #
         # @param channel_id [String] The unique identifier for the channel.
         #
@@ -127,7 +127,7 @@ module Knockapi
         #
         # @param user_id [String] The unique identifier of the user.
         #
-        # @param message_id [String] The unique identifier for the message.
+        # @param message_id [String]
         #
         # @param channel_id [String] The unique identifier for the channel.
         #

data/lib/knockapi/resources/users.rb

@@ -95,14 +95,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [String]
+      # @return [nil]
       #
       # @see Knockapi::Models::UserDeleteParams
       def delete(user_id, params = {})
         @client.request(
           method: :delete,
           path: ["v1/users/%1$s", user_id],
-          model: String,
+          model: NilClass,
           options: params[:request_options]
         )
       end
@@ -420,14 +420,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [String]
+      # @return [nil]
       #
       # @see Knockapi::Models::UserUnsetChannelDataParams
       def unset_channel_data(user_id, channel_id, params = {})
         @client.request(
           method: :delete,
           path: ["v1/users/%1$s/channel_data/%2$s", user_id, channel_id],
-          model: String,
+          model: NilClass,
           options: params[:request_options]
         )
       end

data/lib/knockapi/resources/workflows.rb

@@ -20,7 +20,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [String]
+      # @return [nil]
       #
       # @see Knockapi::Models::WorkflowCancelParams
       def cancel(key, params)
@@ -29,7 +29,7 @@ module Knockapi
           method: :post,
           path: ["v1/workflows/%1$s/cancel", key],
           body: parsed,
-          model: String,
+          model: NilClass,
           options: options
         )
       end

data/lib/knockapi/version.rb

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

data/lib/knockapi.rb

@@ -59,12 +59,10 @@ require_relative "knockapi/models/recipients/preference_set_request"
 require_relative "knockapi/models/identify_user_request"
 require_relative "knockapi/models/activity"
 require_relative "knockapi/models/audience_add_members_params"
-require_relative "knockapi/models/audience_add_members_response"
 require_relative "knockapi/models/audience_list_members_params"
 require_relative "knockapi/models/audience_list_members_response"
 require_relative "knockapi/models/audience_member"
 require_relative "knockapi/models/audience_remove_members_params"
-require_relative "knockapi/models/audience_remove_members_response"
 require_relative "knockapi/models/bulk_operation"
 require_relative "knockapi/models/bulk_operation_get_params"
 require_relative "knockapi/models/channels/bulk_update_message_status_params"
@@ -113,7 +111,6 @@ require_relative "knockapi/models/object"
 require_relative "knockapi/models/object_add_subscriptions_params"
 require_relative "knockapi/models/object_add_subscriptions_response"
 require_relative "knockapi/models/object_delete_params"
-require_relative "knockapi/models/object_delete_response"
 require_relative "knockapi/models/object_delete_subscriptions_params"
 require_relative "knockapi/models/object_delete_subscriptions_response"
 require_relative "knockapi/models/object_get_channel_data_params"
@@ -132,7 +129,6 @@ require_relative "knockapi/models/object_set_channel_data_params"
 require_relative "knockapi/models/object_set_params"
 require_relative "knockapi/models/object_set_preferences_params"
 require_relative "knockapi/models/object_unset_channel_data_params"
-require_relative "knockapi/models/object_unset_channel_data_response"
 require_relative "knockapi/models/page_info"
 require_relative "knockapi/models/providers/ms_team_check_auth_params"
 require_relative "knockapi/models/providers/ms_team_check_auth_response"
@@ -175,7 +171,6 @@ require_relative "knockapi/models/schedule_update_params"
 require_relative "knockapi/models/schedule_update_response"
 require_relative "knockapi/models/tenant"
 require_relative "knockapi/models/tenant_delete_params"
-require_relative "knockapi/models/tenant_delete_response"
 require_relative "knockapi/models/tenant_get_params"
 require_relative "knockapi/models/tenant_list_params"
 require_relative "knockapi/models/tenant_request"
@@ -184,7 +179,6 @@ require_relative "knockapi/models/tenants/bulk_set_params"
 require_relative "knockapi/models/tenant_set_params"
 require_relative "knockapi/models/user"
 require_relative "knockapi/models/user_delete_params"
-require_relative "knockapi/models/user_delete_response"
 require_relative "knockapi/models/user_get_channel_data_params"
 require_relative "knockapi/models/user_get_params"
 require_relative "knockapi/models/user_get_preferences_params"
@@ -213,10 +207,8 @@ require_relative "knockapi/models/users/guide_mark_message_as_seen_response"
 require_relative "knockapi/models/user_set_channel_data_params"
 require_relative "knockapi/models/user_set_preferences_params"
 require_relative "knockapi/models/user_unset_channel_data_params"
-require_relative "knockapi/models/user_unset_channel_data_response"
 require_relative "knockapi/models/user_update_params"
 require_relative "knockapi/models/workflow_cancel_params"
-require_relative "knockapi/models/workflow_cancel_response"
 require_relative "knockapi/models/workflow_trigger_params"
 require_relative "knockapi/models/workflow_trigger_response"
 require_relative "knockapi/models"

data/rbi/knockapi/client.rbi

@@ -65,7 +65,8 @@ module Knockapi
         max_retries: Integer,
         timeout: Float,
         initial_retry_delay: Float,
-        max_retry_delay: Float
+        max_retry_delay: Float,
+        idempotency_header: String
       ).returns(T.attached_class)
     end
     def self.new(
@@ -78,7 +79,8 @@ module Knockapi
       max_retries: Knockapi::Client::DEFAULT_MAX_RETRIES,
       timeout: Knockapi::Client::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: Knockapi::Client::DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: Knockapi::Client::DEFAULT_MAX_RETRY_DELAY
+      max_retry_delay: Knockapi::Client::DEFAULT_MAX_RETRY_DELAY,
+      idempotency_header: "Idempotency-Key"
     )
     end
   end