knockapi 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac0712fabab74c852c94a2b9965183efac90dfa032a82fe7cde8278646d2b618
-  data.tar.gz: 9d76422f9303bae5aee52d8b258637ea69c32dcb982a666d1a6c5379db2721fe
+  metadata.gz: 59aa0cd10e59e4f0f18ddbefd0da6e0482a90c1243539d52389c1074e1a9e14c
+  data.tar.gz: 9a797662afb59af4d0964d0025957607feb398ea4f8a728e359a174886222d31
 SHA512:
-  metadata.gz: 190a4ac895ece179f333b0db6e7aecdb754682a3707150932882f8e89eb239a5dd22dff185d348ac016cdc36dd26f86079224ba9511b355f201d477c6cdb2f14
-  data.tar.gz: 41e71629aa63e8d7c06ac71f4809235cc61988d01392ef44815e70c6721a753df11d9d47c6cae340e13ed5003638e6a5a70b4837209a10bcdd0c7831a59396e9
+  metadata.gz: 6d1da55316e1915100adc1748a00de8aee8b46c8b7a710948a34190faa8f6a03cbe33f0856817c9437b82eb09aeb6fc7ea18f04b87498234dd7ddb623f4b5734
+  data.tar.gz: a4268192cef85172e23bdaf4287e7a0d6f9257bb199ea56b17800974aa16e8424fcdff12ee87eddd7e205801e40605ab6a00d5c7cbed8977a7057bb5227054d9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.20.0 (2025-11-19)
+
+Full Changelog: [v1.19.0...v1.20.0](https://github.com/knocklabs/knock-ruby/compare/v1.19.0...v1.20.0)
+
+### Features
+
+* **api:** api update ([fb4c210](https://github.com/knocklabs/knock-ruby/commit/fb4c2104b4be76381a3fd224879c356f66882a1c))
+* **api:** api update ([d0a06cf](https://github.com/knocklabs/knock-ruby/commit/d0a06cf1572a04f6dae4551c18471f4ef808e2c2))
+
 ## 1.19.0 (2025-11-07)
 
 Full Changelog: [v1.18.0...v1.19.0](https://github.com/knocklabs/knock-ruby/compare/v1.18.0...v1.19.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.19.0"
+gem "knockapi", "~> 1.20.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb

@@ -9,18 +9,24 @@ module Knockapi
         include Knockapi::Internal::Type::RequestParameters
 
         # @!attribute subscriptions
-        #   A list of subscriptions.
+        #   A nested list of subscriptions.
         #
         #   @return [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>]
         required :subscriptions,
                  -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkAddSubscriptionsParams::Subscription] }
 
         # @!method initialize(subscriptions:, request_options: {})
-        #   @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
+        #   @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A nested list of subscriptions.
         #
         #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
 
         class Subscription < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the object.
+          #
+          #   @return [String]
+          required :id, String
+
           # @!attribute recipients
           #   The recipients of the subscription. You can subscribe up to 100 recipients to an
           #   object at a time.
@@ -36,11 +42,15 @@ module Knockapi
                    Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown],
                    nil?: true
 
-          # @!method initialize(recipients:, properties: nil)
+          # @!method initialize(id:, recipients:, properties: nil)
           #   Some parameter documentations has been truncated, see
           #   {Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription} for more
           #   details.
           #
+          #   A list of subscriptions. 1 subscribed-to id, and N subscriber recipients.
+          #
+          #   @param id [String] Unique identifier for the object.
+          #
           #   @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/tenant_get_params.rb

@@ -7,7 +7,20 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute resolve_full_preference_settings
+      #   When true, merges environment-level default preferences into the tenant's
+      #   `settings.preference_set` field before returning the response. Defaults to
+      #   false.
+      #
+      #   @return [Boolean, nil]
+      optional :resolve_full_preference_settings, Knockapi::Internal::Type::Boolean
+
+      # @!method initialize(resolve_full_preference_settings: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::TenantGetParams} for more details.
+      #
+      #   @param resolve_full_preference_settings [Boolean] When true, merges environment-level default preferences into the tenant's `setti
+      #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/tenant_set_params.rb

@@ -7,6 +7,14 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute resolve_full_preference_settings
+      #   When true, merges environment-level default preferences into the tenant's
+      #   `settings.preference_set` field before returning the response. Defaults to
+      #   false.
+      #
+      #   @return [Boolean, nil]
+      optional :resolve_full_preference_settings, Knockapi::Internal::Type::Boolean
+
       # @!attribute channel_data
       #   A request to set channel data for a type of channel inline.
       #
@@ -29,7 +37,12 @@ module Knockapi
       #   @return [Knockapi::Models::TenantSetParams::Settings, nil]
       optional :settings, -> { Knockapi::TenantSetParams::Settings }
 
-      # @!method initialize(channel_data: nil, name: nil, settings: nil, request_options: {})
+      # @!method initialize(resolve_full_preference_settings: nil, channel_data: nil, name: nil, settings: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::TenantSetParams} for more details.
+      #
+      #   @param resolve_full_preference_settings [Boolean] When true, merges environment-level default preferences into the tenant's `setti
+      #
       #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelDataTokensOnly, Knockapi::Models::Recipients::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataTargetArnsOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, 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.
       #
       #   @param name [String, nil] An optional name for the tenant.

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

@@ -38,7 +38,7 @@ module Knockapi
         #
         # @param collection [String] The collection this object belongs to.
         #
-        # @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
+        # @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A nested list of subscriptions.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/knockapi/resources/tenants.rb

@@ -57,38 +57,50 @@ module Knockapi
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Knockapi::Models::TenantGetParams} for more details.
+      #
       # Get a tenant by ID.
       #
-      # @overload get(id, request_options: {})
+      # @overload get(id, resolve_full_preference_settings: nil, request_options: {})
       #
       # @param id [String] The unique identifier for the tenant.
       #
+      # @param resolve_full_preference_settings [Boolean] When true, merges environment-level default preferences into the tenant's `setti
+      #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Knockapi::Models::Tenant]
       #
       # @see Knockapi::Models::TenantGetParams
       def get(id, params = {})
+        parsed, options = Knockapi::TenantGetParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v1/tenants/%1$s", id],
+          query: parsed,
           model: Knockapi::Tenant,
-          options: params[:request_options]
+          options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Knockapi::Models::TenantSetParams} for more details.
+      #
       # Sets a tenant within an environment, performing an upsert operation. Any
       # existing properties will be merged with the incoming properties.
       #
-      # @overload set(id, channel_data: nil, name: nil, settings: nil, request_options: {})
+      # @overload set(id, resolve_full_preference_settings: nil, channel_data: nil, name: nil, settings: nil, request_options: {})
       #
-      # @param id [String] The unique identifier for the tenant.
+      # @param id [String] Path param: The unique identifier for the tenant.
+      #
+      # @param resolve_full_preference_settings [Boolean] Query param: When true, merges environment-level default preferences into the te
       #
-      # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelDataTokensOnly, Knockapi::Models::Recipients::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataTargetArnsOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, 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.
+      # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelDataTokensOnly, Knockapi::Models::Recipients::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataTargetArnsOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] Body param: A request to set channel data for a type of channel inline.
       #
-      # @param name [String, nil] An optional name for the tenant.
+      # @param name [String, nil] Body param: An optional name for the tenant.
       #
-      # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
+      # @param settings [Knockapi::Models::TenantSetParams::Settings] Body param: The settings for the tenant. Includes branding and preference set.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -97,10 +109,12 @@ module Knockapi
       # @see Knockapi::Models::TenantSetParams
       def set(id, params = {})
         parsed, options = Knockapi::TenantSetParams.dump_request(params)
+        query_params = [:resolve_full_preference_settings]
         @client.request(
           method: :put,
           path: ["v1/tenants/%1$s", id],
-          body: parsed,
+          query: parsed.slice(*query_params),
+          body: parsed.except(*query_params),
           model: Knockapi::Tenant,
           options: options
         )

data/lib/knockapi/version.rb

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

data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi

@@ -15,7 +15,7 @@ module Knockapi
             )
           end
 
-        # A list of subscriptions.
+        # A nested list of subscriptions.
         sig do
           returns(
             T::Array[
@@ -35,7 +35,7 @@ module Knockapi
           ).returns(T.attached_class)
         end
         def self.new(
-          # A list of subscriptions.
+          # A nested list of subscriptions.
           subscriptions:,
           request_options: {}
         )
@@ -64,6 +64,10 @@ module Knockapi
               )
             end
 
+          # Unique identifier for the object.
+          sig { returns(String) }
+          attr_accessor :id
+
           # The recipients of the subscription. You can subscribe up to 100 recipients to an
           # object at a time.
           sig do
@@ -83,8 +87,10 @@ module Knockapi
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_accessor :properties
 
+          # A list of subscriptions. 1 subscribed-to id, and N subscriber recipients.
           sig do
             params(
+              id: String,
               recipients:
                 T::Array[
                   T.any(
@@ -97,6 +103,8 @@ module Knockapi
             ).returns(T.attached_class)
           end
           def self.new(
+            # Unique identifier for the object.
+            id:,
             # The recipients of the subscription. You can subscribe up to 100 recipients to an
             # object at a time.
             recipients:,
@@ -108,6 +116,7 @@ module Knockapi
           sig do
             override.returns(
               {
+                id: String,
                 recipients:
                   T::Array[
                     T.any(

data/rbi/knockapi/models/tenant_get_params.rbi

@@ -11,15 +11,38 @@ module Knockapi
           T.any(Knockapi::TenantGetParams, Knockapi::Internal::AnyHash)
         end
 
+      # When true, merges environment-level default preferences into the tenant's
+      # `settings.preference_set` field before returning the response. Defaults to
+      # false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :resolve_full_preference_settings
+
+      sig { params(resolve_full_preference_settings: T::Boolean).void }
+      attr_writer :resolve_full_preference_settings
+
       sig do
-        params(request_options: Knockapi::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          resolve_full_preference_settings: T::Boolean,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # When true, merges environment-level default preferences into the tenant's
+        # `settings.preference_set` field before returning the response. Defaults to
+        # false.
+        resolve_full_preference_settings: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            resolve_full_preference_settings: T::Boolean,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/knockapi/models/tenant_set_params.rbi

@@ -11,6 +11,15 @@ module Knockapi
           T.any(Knockapi::TenantSetParams, Knockapi::Internal::AnyHash)
         end
 
+      # When true, merges environment-level default preferences into the tenant's
+      # `settings.preference_set` field before returning the response. Defaults to
+      # false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :resolve_full_preference_settings
+
+      sig { params(resolve_full_preference_settings: T::Boolean).void }
+      attr_writer :resolve_full_preference_settings
+
       # A request to set channel data for a type of channel inline.
       sig do
         returns(
@@ -46,6 +55,7 @@ module Knockapi
 
       sig do
         params(
+          resolve_full_preference_settings: T::Boolean,
           channel_data:
             T.nilable(
               T::Hash[
@@ -68,6 +78,10 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
+        # When true, merges environment-level default preferences into the tenant's
+        # `settings.preference_set` field before returning the response. Defaults to
+        # false.
+        resolve_full_preference_settings: nil,
         # A request to set channel data for a type of channel inline.
         channel_data: nil,
         # An optional name for the tenant.
@@ -81,6 +95,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            resolve_full_preference_settings: T::Boolean,
             channel_data:
               T.nilable(
                 T::Hash[

data/rbi/knockapi/resources/objects/bulk.rbi

@@ -39,7 +39,7 @@ module Knockapi
         def add_subscriptions(
           # The collection this object belongs to.
           collection,
-          # A list of subscriptions.
+          # A nested list of subscriptions.
           subscriptions:,
           request_options: {}
         )

data/rbi/knockapi/resources/tenants.rbi

@@ -50,12 +50,17 @@ module Knockapi
       sig do
         params(
           id: String,
+          resolve_full_preference_settings: T::Boolean,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(Knockapi::Tenant)
       end
       def get(
         # The unique identifier for the tenant.
         id,
+        # When true, merges environment-level default preferences into the tenant's
+        # `settings.preference_set` field before returning the response. Defaults to
+        # false.
+        resolve_full_preference_settings: nil,
         request_options: {}
       )
       end
@@ -65,6 +70,7 @@ module Knockapi
       sig do
         params(
           id: String,
+          resolve_full_preference_settings: T::Boolean,
           channel_data:
             T.nilable(
               T::Hash[
@@ -87,13 +93,17 @@ module Knockapi
         ).returns(Knockapi::Tenant)
       end
       def set(
-        # The unique identifier for the tenant.
+        # Path param: The unique identifier for the tenant.
         id,
-        # A request to set channel data for a type of channel inline.
+        # Query param: When true, merges environment-level default preferences into the
+        # tenant's `settings.preference_set` field before returning the response. Defaults
+        # to false.
+        resolve_full_preference_settings: nil,
+        # Body param: A request to set channel data for a type of channel inline.
         channel_data: nil,
-        # An optional name for the tenant.
+        # Body param: An optional name for the tenant.
         name: nil,
-        # The settings for the tenant. Includes branding and preference set.
+        # Body param: The settings for the tenant. Includes branding and preference set.
         settings: nil,
         request_options: {}
       )

data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs

@@ -25,21 +25,26 @@ module Knockapi
 
         type subscription =
           {
+            id: String,
             recipients: ::Array[Knockapi::Models::recipient_request],
             properties: ::Hash[Symbol, top]?
           }
 
         class Subscription < Knockapi::Internal::Type::BaseModel
+          attr_accessor id: String
+
           attr_accessor recipients: ::Array[Knockapi::Models::recipient_request]
 
           attr_accessor properties: ::Hash[Symbol, top]?
 
           def initialize: (
+            id: String,
             recipients: ::Array[Knockapi::Models::recipient_request],
             ?properties: ::Hash[Symbol, top]?
           ) -> void
 
           def to_hash: -> {
+            id: String,
             recipients: ::Array[Knockapi::Models::recipient_request],
             properties: ::Hash[Symbol, top]?
           }

data/sig/knockapi/models/tenant_get_params.rbs

@@ -1,14 +1,26 @@
 module Knockapi
   module Models
-    type tenant_get_params = {  } & Knockapi::Internal::Type::request_parameters
+    type tenant_get_params =
+      { resolve_full_preference_settings: bool }
+      & Knockapi::Internal::Type::request_parameters
 
     class TenantGetParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_reader resolve_full_preference_settings: bool?
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def resolve_full_preference_settings=: (bool) -> bool
+
+      def initialize: (
+        ?resolve_full_preference_settings: bool,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        resolve_full_preference_settings: bool,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/tenant_set_params.rbs

@@ -2,6 +2,7 @@ module Knockapi
   module Models
     type tenant_set_params =
       {
+        resolve_full_preference_settings: bool,
         channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
         name: String?,
         settings: Knockapi::TenantSetParams::Settings
@@ -12,6 +13,10 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_reader resolve_full_preference_settings: bool?
+
+      def resolve_full_preference_settings=: (bool) -> bool
+
       attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
 
       attr_accessor name: String?
@@ -23,6 +28,7 @@ module Knockapi
       ) -> Knockapi::TenantSetParams::Settings
 
       def initialize: (
+        ?resolve_full_preference_settings: bool,
         ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
         ?name: String?,
         ?settings: Knockapi::TenantSetParams::Settings,
@@ -30,6 +36,7 @@ module Knockapi
       ) -> void
 
       def to_hash: -> {
+        resolve_full_preference_settings: bool,
         channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
         name: String?,
         settings: Knockapi::TenantSetParams::Settings,

data/sig/knockapi/resources/tenants.rbs

@@ -16,11 +16,13 @@ module Knockapi
 
       def get: (
         String id,
+        ?resolve_full_preference_settings: bool,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Tenant
 
       def set: (
         String id,
+        ?resolve_full_preference_settings: bool,
         ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
         ?name: String?,
         ?settings: Knockapi::TenantSetParams::Settings,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-07 00:00:00.000000000 Z
+date: 2025-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool