knockapi 1.18.0 → 1.20.0

data/lib/knockapi/models/recipients/preference_set_request.rb

@@ -33,7 +33,7 @@ module Knockapi
         # @!attribute channels
         #   Channel preferences.
         #
-        #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting}, nil]
+        #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
         optional :channels,
                  -> {
                    Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Channel]
@@ -70,7 +70,7 @@ module Knockapi
         #
         #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
         #
-        #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting}, nil] Channel preferences.
+        #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil] Channel preferences.
         #
         #   @param commercial_subscribed [Boolean, nil] Whether the recipient is subscribed to commercial communications. When false, th
         #
@@ -109,7 +109,7 @@ module Knockapi
             # @!attribute channels
             #   Channel preferences.
             #
-            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil]
+            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
             optional :channels,
                      -> do
                        Knockapi::Internal::Type::HashOf[
@@ -130,7 +130,7 @@ module Knockapi
             #
             #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
             #
-            #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil] Channel preferences.
+            #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil] Channel preferences.
             #
             #   @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
 
@@ -142,24 +142,10 @@ module Knockapi
               variant Knockapi::Internal::Type::Boolean
 
               # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
-              variant -> { Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting }
-
-              class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
-                # @!attribute conditions
-                #   A list of conditions to apply to a specific channel.
-                #
-                #   @return [Array<Knockapi::Models::Condition>]
-                required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
-
-                # @!method initialize(conditions:)
-                #   A set of settings for a specific channel. Currently, this can only be a list of
-                #   conditions to apply.
-                #
-                #   @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a specific channel.
-              end
+              variant -> { Knockapi::Recipients::PreferenceSetChannelSetting }
 
               # @!method self.variants
-              #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting)]
+              #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
             end
           end
 
@@ -175,24 +161,10 @@ module Knockapi
           variant Knockapi::Internal::Type::Boolean
 
           # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
-          variant -> { Knockapi::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting }
-
-          class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
-            # @!attribute conditions
-            #   A list of conditions to apply to a specific channel.
-            #
-            #   @return [Array<Knockapi::Models::Condition>]
-            required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
-
-            # @!method initialize(conditions:)
-            #   A set of settings for a specific channel. Currently, this can only be a list of
-            #   conditions to apply.
-            #
-            #   @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a specific channel.
-          end
+          variant -> { Knockapi::Recipients::PreferenceSetChannelSetting }
 
           # @!method self.variants
-          #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting)]
+          #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
         end
 
         # Workflow or category preferences within a preference set
@@ -214,7 +186,7 @@ module Knockapi
             # @!attribute channels
             #   Channel preferences.
             #
-            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil]
+            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
             optional :channels,
                      -> do
                        Knockapi::Internal::Type::HashOf[
@@ -235,7 +207,7 @@ module Knockapi
             #
             #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
             #
-            #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil] Channel preferences.
+            #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil] Channel preferences.
             #
             #   @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
 
@@ -247,24 +219,10 @@ module Knockapi
               variant Knockapi::Internal::Type::Boolean
 
               # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
-              variant -> { Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting }
-
-              class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
-                # @!attribute conditions
-                #   A list of conditions to apply to a specific channel.
-                #
-                #   @return [Array<Knockapi::Models::Condition>]
-                required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
-
-                # @!method initialize(conditions:)
-                #   A set of settings for a specific channel. Currently, this can only be a list of
-                #   conditions to apply.
-                #
-                #   @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a specific channel.
-              end
+              variant -> { Knockapi::Recipients::PreferenceSetChannelSetting }
 
               # @!method self.variants
-              #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting)]
+              #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
             end
           end
 

data/lib/knockapi/models/recipients/push_channel_data_devices_only.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class PushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
+        # @!attribute devices
+        #   A list of devices. Each device contains a token, and optionally a locale and
+        #   timezone.
+        #
+        #   @return [Array<Knockapi::Models::Recipients::PushChannelDataDevicesOnly::Device>]
+        required :devices,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::PushChannelDataDevicesOnly::Device] }
+
+        # @!method initialize(devices:)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::Recipients::PushChannelDataDevicesOnly} for more details.
+        #
+        #   Push channel data.
+        #
+        #   @param devices [Array<Knockapi::Models::Recipients::PushChannelDataDevicesOnly::Device>] A list of devices. Each device contains a token, and optionally a locale and tim
+
+        class Device < Knockapi::Internal::Type::BaseModel
+          # @!attribute token
+          #   The device token to send the push notification to.
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute locale
+          #   The locale of the object. Used for
+          #   [message localization](/concepts/translations).
+          #
+          #   @return [String, nil]
+          optional :locale, String, nil?: true
+
+          # @!attribute timezone
+          #   The timezone of the object. Must be a
+          #   valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+          #   Used
+          #   for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+          #
+          #   @return [String, nil]
+          optional :timezone, String, nil?: true
+
+          # @!method initialize(token:, locale: nil, timezone: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Recipients::PushChannelDataDevicesOnly::Device} for more
+          #   details.
+          #
+          #   @param token [String] The device token to send the push notification to.
+          #
+          #   @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
+          #
+          #   @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/recipients/push_channel_data_tokens_only.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class PushChannelDataTokensOnly < Knockapi::Internal::Type::BaseModel
+        # @!attribute tokens
+        #   A list of push channel tokens.
+        #
+        #   @return [Array<String>]
+        required :tokens, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(tokens:)
+        #   Push channel data.
+        #
+        #   @param tokens [Array<String>] A list of push channel tokens.
+      end
+    end
+  end
+end

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_request.rb

@@ -12,13 +12,19 @@ module Knockapi
       # @!attribute channel_data
       #   A request to set channel data for a type of channel inline.
       #
-      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
+      #   @return [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]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
                },
                nil?: true
 
+      # @!attribute name
+      #   An optional name for the tenant.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
       #   Preferences that are set inline will be merged into any existing preferences
@@ -35,7 +41,7 @@ module Knockapi
       #   @return [Knockapi::Models::TenantRequest::Settings, nil]
       optional :settings, -> { Knockapi::TenantRequest::Settings }
 
-      # @!method initialize(id:, channel_data: nil, preferences: nil, settings: nil)
+      # @!method initialize(id:, channel_data: nil, name: nil, preferences: nil, settings: nil)
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::TenantRequest} for more details.
       #
@@ -44,7 +50,9 @@ module Knockapi
       #
       #   @param id [String] The unique identifier for the tenant.
       #
-      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::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] A request to set channel data for a type of channel inline.
+      #
+      #   @param name [String, nil] An optional name for the tenant.
       #
       #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
       #

data/lib/knockapi/models/tenant_set_params.rb

@@ -7,24 +7,45 @@ 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.
       #
-      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
+      #   @return [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]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
                },
                nil?: true
 
+      # @!attribute name
+      #   An optional name for the tenant.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
       # @!attribute settings
       #   The settings for the tenant. Includes branding and preference set.
       #
       #   @return [Knockapi::Models::TenantSetParams::Settings, nil]
       optional :settings, -> { Knockapi::TenantSetParams::Settings }
 
-      # @!method initialize(channel_data: nil, settings: nil, request_options: {})
-      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::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.
+      # @!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.
       #
       #   @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
       #

data/lib/knockapi/models/users/feed_list_items_params.rb

@@ -32,6 +32,15 @@ module Knockapi
         #   @return [Boolean, nil]
         optional :has_tenant, Knockapi::Internal::Type::Boolean
 
+        # @!attribute locale
+        #   The locale to render the feed items in. Must be in the IETF 5646 format (e.g.
+        #   `en-US`). When not provided, will default to the locale that the feed items were
+        #   rendered in. Only available for enterprise plan customers using custom
+        #   translations.
+        #
+        #   @return [String, nil]
+        optional :locale, String
+
         # @!attribute page_size
         #   The number of items per page (defaults to 50).
         #
@@ -68,7 +77,10 @@ module Knockapi
         #   @return [Array<String>, nil]
         optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(after: nil, archived: nil, before: nil, has_tenant: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
+        # @!method initialize(after: nil, archived: nil, before: nil, has_tenant: nil, locale: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::Users::FeedListItemsParams} for more details.
+        #
         #   @param after [String] The cursor to fetch entries after.
         #
         #   @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.
@@ -77,6 +89,8 @@ module Knockapi
         #
         #   @param has_tenant [Boolean] Whether the feed items have a tenant.
         #
+        #   @param locale [String] The locale to render the feed items in. Must be in the IETF 5646 format (e.g. `e
+        #
         #   @param page_size [Integer] The number of items per page (defaults to 50).
         #
         #   @param source [String] The workflow key associated with the message in the feed.

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/objects.rb

@@ -362,16 +362,18 @@ module Knockapi
       # This operation is used to identify objects with their properties, as well as
       # optional preferences and channel data.
       #
-      # @overload set(collection, id, channel_data: nil, locale: nil, preferences: nil, timezone: nil, request_options: {})
+      # @overload set(collection, id, channel_data: nil, locale: nil, name: nil, preferences: nil, timezone: nil, request_options: {})
       #
       # @param collection [String] The collection this object belongs to.
       #
       # @param id [String] Unique identifier for the object.
       #
-      # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] 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}] A request to set channel data for a type of channel inline.
       #
       # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
       #
+      # @param name [String, nil] An optional name for the object.
+      #
       # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
       #
       # @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
@@ -404,7 +406,7 @@ module Knockapi
       #
       # @param channel_id [String] The unique identifier for the channel.
       #
-      # @param data [Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
+      # @param data [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] Channel data for a given channel type.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -448,7 +450,7 @@ module Knockapi
       #
       # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
       #
-      # @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting}, nil] Channel preferences.
+      # @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil] Channel preferences.
       #
       # @param commercial_subscribed [Boolean, nil] Whether the recipient is subscribed to commercial communications. When false, th
       #

data/lib/knockapi/resources/tenants.rb

@@ -57,36 +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, 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] Body param: A request to set channel data for a type of channel inline.
       #
-      # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::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] 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]
       #
@@ -95,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/resources/users/feeds.rb

@@ -26,6 +26,9 @@ module Knockapi
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Knockapi::Models::Users::FeedListItemsParams} for more details.
+        #
         # Returns a paginated list of feed items for a user in reverse chronological
         # order, including metadata about the feed. If the user has not yet been
         # identified within Knock, an empty feed will be returned.
@@ -41,7 +44,7 @@ module Knockapi
         # - This endpoint’s rate limit is always scoped per-user and per-environment. This
         #   is true even for requests made without a signed user token.
         #
-        # @overload list_items(user_id, id, after: nil, archived: nil, before: nil, has_tenant: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
+        # @overload list_items(user_id, id, after: nil, archived: nil, before: nil, has_tenant: nil, locale: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
         #
         # @param user_id [String] The unique identifier of the user.
         #
@@ -55,6 +58,8 @@ module Knockapi
         #
         # @param has_tenant [Boolean] Whether the feed items have a tenant.
         #
+        # @param locale [String] The locale to render the feed items in. Must be in the IETF 5646 format (e.g. `e
+        #
         # @param page_size [Integer] The number of items per page (defaults to 50).
         #
         # @param source [String] The workflow key associated with the message in the feed.

data/lib/knockapi/resources/users.rb

@@ -25,7 +25,7 @@ module Knockapi
       #
       # @param avatar [String, nil] A URL for the avatar of the user.
       #
-      # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::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] A request to set channel data for a type of channel inline.
       #
       # @param created_at [Time, nil] The creation date of the user from your system.
       #
@@ -354,7 +354,7 @@ module Knockapi
       #
       # @param channel_id [String] The unique identifier for the channel.
       #
-      # @param data [Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
+      # @param data [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] Channel data for a given channel type.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -392,7 +392,7 @@ module Knockapi
       #
       # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
       #
-      # @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting}, nil] Channel preferences.
+      # @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil] Channel preferences.
       #
       # @param commercial_subscribed [Boolean, nil] Whether the recipient is subscribed to commercial communications. When false, th
       #

data/lib/knockapi/version.rb

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

data/lib/knockapi.rb

@@ -9,6 +9,7 @@ require "erb"
 require "etc"
 require "json"
 require "net/http"
+require "openssl"
 require "pathname"
 require "rbconfig"
 require "securerandom"
@@ -147,13 +148,19 @@ require_relative "knockapi/models/providers/slack_revoke_access_response"
 require_relative "knockapi/models/recipient"
 require_relative "knockapi/models/recipient_reference"
 require_relative "knockapi/models/recipient_request"
+require_relative "knockapi/models/recipients/aws_sns_push_channel_data_devices_only"
+require_relative "knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only"
 require_relative "knockapi/models/recipients/discord_channel_data"
 require_relative "knockapi/models/recipients/inline_channel_data_request"
 require_relative "knockapi/models/recipients/inline_preference_set_request"
 require_relative "knockapi/models/recipients/ms_teams_channel_data"
+require_relative "knockapi/models/recipients/one_signal_channel_data_player_ids_only"
 require_relative "knockapi/models/recipients/preference_set"
+require_relative "knockapi/models/recipients/preference_set_channel_setting"
 require_relative "knockapi/models/recipients/preference_set_channel_types"
 require_relative "knockapi/models/recipients/preference_set_channel_type_setting"
+require_relative "knockapi/models/recipients/push_channel_data_devices_only"
+require_relative "knockapi/models/recipients/push_channel_data_tokens_only"
 require_relative "knockapi/models/recipients/channel_data"
 require_relative "knockapi/models/recipients/slack_channel_data"
 require_relative "knockapi/models/recipients/subscription"

data/manifest.yaml

@@ -6,6 +6,7 @@ dependencies:
   - etc
   - json
   - net/http
+  - openssl
   - pathname
   - rbconfig
   - securerandom

data/rbi/knockapi/client.rbi

@@ -13,6 +13,10 @@ module Knockapi
     sig { returns(String) }
     attr_reader :api_key
 
+    # The slug of an existing branch
+    sig { returns(T.nilable(String)) }
+    attr_reader :branch
+
     sig { returns(Knockapi::Resources::Recipients) }
     attr_reader :recipients
 
@@ -58,6 +62,7 @@ module Knockapi
     sig do
       params(
         api_key: T.nilable(String),
+        branch: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -69,6 +74,8 @@ module Knockapi
     def self.new(
       # Defaults to `ENV["KNOCK_API_KEY"]`
       api_key: ENV["KNOCK_API_KEY"],
+      # The slug of an existing branch Defaults to `ENV["KNOCK_BRANCH"]`
+      branch: ENV["KNOCK_BRANCH"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["KNOCK_BASE_URL"]`
       base_url: ENV["KNOCK_BASE_URL"],

data/rbi/knockapi/internal/transport/base_client.rbi

@@ -176,6 +176,11 @@ module Knockapi
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key