knockapi 1.17.0 → 1.19.0

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

@@ -8,13 +8,19 @@ module Knockapi
         extend Knockapi::Internal::Type::Union
 
         # Push channel data.
-        variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly }
+        variant -> { Knockapi::Recipients::PushChannelDataTokensOnly }
+
+        # Push channel data.
+        variant -> { Knockapi::Recipients::PushChannelDataDevicesOnly }
 
         # AWS SNS push channel data.
-        variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly }
+        variant -> { Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly }
+
+        # AWS SNS push channel data.
+        variant -> { Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly }
 
         # OneSignal channel data.
-        variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly }
+        variant -> { Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly }
 
         # Slack channel data.
         variant -> { Knockapi::Recipients::SlackChannelData }
@@ -25,52 +31,8 @@ module Knockapi
         # Discord channel data.
         variant -> { Knockapi::Recipients::DiscordChannelData }
 
-        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
-
-        class AwssnsPushChannelDataTargetArNsOnly < Knockapi::Internal::Type::BaseModel
-          # @!attribute target_arns
-          #   A list of platform endpoint ARNs. See
-          #   [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
-          #
-          #   @return [Array<String>]
-          required :target_arns, Knockapi::Internal::Type::ArrayOf[String]
-
-          # @!method initialize(target_arns:)
-          #   Some parameter documentations has been truncated, see
-          #   {Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly}
-          #   for more details.
-          #
-          #   AWS SNS push channel data.
-          #
-          #   @param target_arns [Array<String>] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin
-        end
-
-        class OneSignalChannelDataPlayerIDsOnly < Knockapi::Internal::Type::BaseModel
-          # @!attribute player_ids
-          #   A list of OneSignal player IDs.
-          #
-          #   @return [Array<String>]
-          required :player_ids, Knockapi::Internal::Type::ArrayOf[String]
-
-          # @!method initialize(player_ids:)
-          #   OneSignal channel data.
-          #
-          #   @param player_ids [Array<String>] A list of OneSignal player IDs.
-        end
-
         # @!method self.variants
-        #   @return [Array(Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
+        #   @return [Array(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)]
       end
 
       # @type [Knockapi::Internal::Type::Converter]

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

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

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

@@ -30,7 +30,7 @@ module Knockapi
         # @!attribute channels
         #   Channel preferences.
         #
-        #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Channel::PreferenceSetChannelSetting}, nil]
+        #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
         optional :channels,
                  -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Channel] },
                  nil?: true
@@ -66,7 +66,7 @@ module Knockapi
         #
         #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
         #
-        #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::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
         #
@@ -91,7 +91,7 @@ module Knockapi
             # @!attribute channels
             #   Channel preferences.
             #
-            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil]
+            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
             optional :channels,
                      -> {
                        Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel]
@@ -110,7 +110,7 @@ module Knockapi
             #
             #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
             #
-            #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::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.
 
@@ -122,24 +122,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::PreferenceSet::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::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting)]
+              #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
             end
           end
 
@@ -155,24 +141,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::PreferenceSet::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::PreferenceSet::Channel::PreferenceSetChannelSetting)]
+          #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
         end
 
         # Workflow or category preferences within a preference set
@@ -194,7 +166,7 @@ module Knockapi
             # @!attribute channels
             #   Channel preferences.
             #
-            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil]
+            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
             optional :channels,
                      -> {
                        Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel]
@@ -213,7 +185,7 @@ module Knockapi
             #
             #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
             #
-            #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::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.
 
@@ -225,24 +197,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::PreferenceSet::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::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting)]
+              #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
             end
           end
 

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      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
+    end
+  end
+end

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_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::AwssnsPushChannelDataTargetArNsOnly, 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::AwssnsPushChannelDataTargetArNsOnly, 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

@@ -10,21 +10,29 @@ 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::AwssnsPushChannelDataTargetArNsOnly, 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::AwssnsPushChannelDataTargetArNsOnly, 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(channel_data: nil, name: nil, settings: nil, request_options: {})
+      #   @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.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::AwssnsPushChannelDataTargetArNsOnly, 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::AwssnsPushChannelDataTargetArNsOnly, 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

@@ -80,11 +80,13 @@ module Knockapi
       # 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, channel_data: nil, name: nil, settings: nil, request_options: {})
       #
       # @param id [String] The unique identifier for the tenant.
       #
-      # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, 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 settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
       #