knockapi 1.16.0 → 1.18.0

data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi

@@ -10,20 +10,157 @@ module Knockapi
         Variants =
           T.type_alias do
             T.any(
-              Knockapi::Recipients::PushChannelData,
-              Knockapi::Recipients::OneSignalChannelData,
-              Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
+              Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
+              Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
+              Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
+              Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
+              Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
               Knockapi::Recipients::SlackChannelData,
               Knockapi::Recipients::MsTeamsChannelData,
               Knockapi::Recipients::DiscordChannelData
             )
           end
 
-        class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
+        class PushChannelDataTokensOnly < Knockapi::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
+                Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # A list of push channel tokens.
+          sig { returns(T::Array[String]) }
+          attr_accessor :tokens
+
+          # Push channel data.
+          sig { params(tokens: T::Array[String]).returns(T.attached_class) }
+          def self.new(
+            # A list of push channel tokens.
+            tokens:
+          )
+          end
+
+          sig { override.returns({ tokens: T::Array[String] }) }
+          def to_hash
+          end
+        end
+
+        class PushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # A list of devices. Each device contains a token, and optionally a locale and
+          # timezone.
+          sig do
+            returns(
+              T::Array[
+                Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::Device
+              ]
+            )
+          end
+          attr_accessor :devices
+
+          # Push channel data.
+          sig do
+            params(
+              devices:
+                T::Array[
+                  Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::Device::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A list of devices. Each device contains a token, and optionally a locale and
+            # timezone.
+            devices:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                devices:
+                  T::Array[
+                    Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::Device
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Device < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::Device,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
+            # The device token to send the push notification to.
+            sig { returns(String) }
+            attr_accessor :token
+
+            # The locale of the object. Used for
+            # [message localization](/concepts/translations).
+            sig { returns(T.nilable(String)) }
+            attr_accessor :locale
+
+            # 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).
+            sig { returns(T.nilable(String)) }
+            attr_accessor :timezone
+
+            sig do
+              params(
+                token: String,
+                locale: T.nilable(String),
+                timezone: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The device token to send the push notification to.
+              token:,
+              # The locale of the object. Used for
+              # [message localization](/concepts/translations).
+              locale: nil,
+              # 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).
+              timezone: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  token: String,
+                  locale: T.nilable(String),
+                  timezone: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
+        class AwssnsPushChannelDataTargetArNsOnly < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
                 Knockapi::Internal::AnyHash
               )
             end
@@ -49,6 +186,145 @@ module Knockapi
           end
         end
 
+        class AwssnsPushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # A list of devices. Each device contains a target_arn, and optionally a locale
+          # and timezone.
+          sig do
+            returns(
+              T::Array[
+                Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::Device
+              ]
+            )
+          end
+          attr_accessor :devices
+
+          # AWS SNS push channel data.
+          sig do
+            params(
+              devices:
+                T::Array[
+                  Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::Device::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A list of devices. Each device contains a target_arn, and optionally a locale
+            # and timezone.
+            devices:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                devices:
+                  T::Array[
+                    Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::Device
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Device < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::Device,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
+            # The ARN of a platform endpoint associated with a platform application and a
+            # device token. See
+            # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
+            sig { returns(String) }
+            attr_accessor :target_arn
+
+            # The locale of the object. Used for
+            # [message localization](/concepts/translations).
+            sig { returns(T.nilable(String)) }
+            attr_accessor :locale
+
+            # 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).
+            sig { returns(T.nilable(String)) }
+            attr_accessor :timezone
+
+            sig do
+              params(
+                target_arn: String,
+                locale: T.nilable(String),
+                timezone: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The ARN of a platform endpoint associated with a platform application and a
+              # device token. See
+              # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
+              target_arn:,
+              # The locale of the object. Used for
+              # [message localization](/concepts/translations).
+              locale: nil,
+              # 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).
+              timezone: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  target_arn: String,
+                  locale: T.nilable(String),
+                  timezone: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
+        class OneSignalChannelDataPlayerIDsOnly < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # A list of OneSignal player IDs.
+          sig { returns(T::Array[String]) }
+          attr_accessor :player_ids
+
+          # OneSignal channel data.
+          sig { params(player_ids: T::Array[String]).returns(T.attached_class) }
+          def self.new(
+            # A list of OneSignal player IDs.
+            player_ids:
+          )
+          end
+
+          sig { override.returns({ player_ids: T::Array[String] }) }
+          def to_hash
+          end
+        end
+
         sig do
           override.returns(
             T::Array[

data/rbi/knockapi/models/recipients/preference_set.rbi

@@ -44,6 +44,24 @@ module Knockapi
         end
         attr_writer :channel_types
 
+        # Channel preferences.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSet::Channel::Variants
+              ]
+            )
+          )
+        end
+        attr_accessor :channels
+
+        # Whether the recipient is subscribed to commercial communications. When false,
+        # the recipient will not receive commercial workflow notifications.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :commercial_subscribed
+
         # An object where the key is the workflow key and the values are the preference
         # settings for that workflow.
         sig do
@@ -77,6 +95,17 @@ module Knockapi
               T.nilable(
                 Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
               ),
+            channels:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Recipients::PreferenceSet::Channel::PreferenceSetChannelSetting::OrHash
+                  )
+                ]
+              ),
+            commercial_subscribed: T.nilable(T::Boolean),
             workflows:
               T.nilable(
                 T::Hash[
@@ -97,6 +126,11 @@ module Knockapi
           categories: nil,
           # Channel type preferences.
           channel_types: nil,
+          # Channel preferences.
+          channels: nil,
+          # Whether the recipient is subscribed to commercial communications. When false,
+          # the recipient will not receive commercial workflow notifications.
+          commercial_subscribed: nil,
           # An object where the key is the workflow key and the values are the preference
           # settings for that workflow.
           workflows: nil
@@ -116,6 +150,14 @@ module Knockapi
                 ),
               channel_types:
                 T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes),
+              channels:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Knockapi::Recipients::PreferenceSet::Channel::Variants
+                  ]
+                ),
+              commercial_subscribed: T.nilable(T::Boolean),
               workflows:
                 T.nilable(
                   T::Hash[
@@ -168,6 +210,19 @@ module Knockapi
             end
             attr_writer :channel_types
 
+            # Channel preferences.
+            sig do
+              returns(
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel::Variants
+                  ]
+                )
+              )
+            end
+            attr_accessor :channels
+
             # A list of conditions to apply to a channel type.
             sig { returns(T.nilable(T::Array[Knockapi::Condition])) }
             attr_accessor :conditions
@@ -180,12 +235,24 @@ module Knockapi
                   T.nilable(
                     Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
                   ),
+                channels:
+                  T.nilable(
+                    T::Hash[
+                      Symbol,
+                      T.any(
+                        T::Boolean,
+                        Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting::OrHash
+                      )
+                    ]
+                  ),
                 conditions: T.nilable(T::Array[Knockapi::Condition::OrHash])
               ).returns(T.attached_class)
             end
             def self.new(
               # Channel type preferences.
               channel_types: nil,
+              # Channel preferences.
+              channels: nil,
               # A list of conditions to apply to a channel type.
               conditions: nil
             )
@@ -196,12 +263,78 @@ module Knockapi
                 {
                   channel_types:
                     T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes),
+                  channels:
+                    T.nilable(
+                      T::Hash[
+                        Symbol,
+                        Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel::Variants
+                      ]
+                    ),
                   conditions: T.nilable(T::Array[Knockapi::Condition])
                 }
               )
             end
             def to_hash
             end
+
+            # Whether the specific channel (by channel_id) is enabled for the preference set,
+            # or a settings object with conditions.
+            module Channel
+              extend Knockapi::Internal::Type::Union
+
+              Variants =
+                T.type_alias do
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting
+                  )
+                end
+
+              class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting,
+                      Knockapi::Internal::AnyHash
+                    )
+                  end
+
+                # A list of conditions to apply to a specific channel.
+                sig { returns(T::Array[Knockapi::Condition]) }
+                attr_accessor :conditions
+
+                # A set of settings for a specific channel. Currently, this can only be a list of
+                # conditions to apply.
+                sig do
+                  params(
+                    conditions: T::Array[Knockapi::Condition::OrHash]
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # A list of conditions to apply to a specific channel.
+                  conditions:
+                )
+                end
+
+                sig do
+                  override.returns(
+                    { conditions: T::Array[Knockapi::Condition] }
+                  )
+                end
+                def to_hash
+                end
+              end
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject::Channel::Variants
+                  ]
+                )
+              end
+              def self.variants
+              end
+            end
           end
 
           sig do
@@ -213,6 +346,61 @@ module Knockapi
           end
         end
 
+        # Whether the specific channel (by channel_id) is enabled for the preference set,
+        # or a settings object with conditions.
+        module Channel
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSet::Channel::PreferenceSetChannelSetting
+              )
+            end
+
+          class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::PreferenceSet::Channel::PreferenceSetChannelSetting,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
+            # A list of conditions to apply to a specific channel.
+            sig { returns(T::Array[Knockapi::Condition]) }
+            attr_accessor :conditions
+
+            # A set of settings for a specific channel. Currently, this can only be a list of
+            # conditions to apply.
+            sig do
+              params(conditions: T::Array[Knockapi::Condition::OrHash]).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # A list of conditions to apply to a specific channel.
+              conditions:
+            )
+            end
+
+            sig do
+              override.returns({ conditions: T::Array[Knockapi::Condition] })
+            end
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[Knockapi::Recipients::PreferenceSet::Channel::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+
         # Workflow or category preferences within a preference set
         module Workflow
           extend Knockapi::Internal::Type::Union
@@ -252,6 +440,19 @@ module Knockapi
             end
             attr_writer :channel_types
 
+            # Channel preferences.
+            sig do
+              returns(
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::Variants
+                  ]
+                )
+              )
+            end
+            attr_accessor :channels
+
             # A list of conditions to apply to a channel type.
             sig { returns(T.nilable(T::Array[Knockapi::Condition])) }
             attr_accessor :conditions
@@ -264,12 +465,24 @@ module Knockapi
                   T.nilable(
                     Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
                   ),
+                channels:
+                  T.nilable(
+                    T::Hash[
+                      Symbol,
+                      T.any(
+                        T::Boolean,
+                        Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting::OrHash
+                      )
+                    ]
+                  ),
                 conditions: T.nilable(T::Array[Knockapi::Condition::OrHash])
               ).returns(T.attached_class)
             end
             def self.new(
               # Channel type preferences.
               channel_types: nil,
+              # Channel preferences.
+              channels: nil,
               # A list of conditions to apply to a channel type.
               conditions: nil
             )
@@ -280,12 +493,78 @@ module Knockapi
                 {
                   channel_types:
                     T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes),
+                  channels:
+                    T.nilable(
+                      T::Hash[
+                        Symbol,
+                        Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::Variants
+                      ]
+                    ),
                   conditions: T.nilable(T::Array[Knockapi::Condition])
                 }
               )
             end
             def to_hash
             end
+
+            # Whether the specific channel (by channel_id) is enabled for the preference set,
+            # or a settings object with conditions.
+            module Channel
+              extend Knockapi::Internal::Type::Union
+
+              Variants =
+                T.type_alias do
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting
+                  )
+                end
+
+              class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting,
+                      Knockapi::Internal::AnyHash
+                    )
+                  end
+
+                # A list of conditions to apply to a specific channel.
+                sig { returns(T::Array[Knockapi::Condition]) }
+                attr_accessor :conditions
+
+                # A set of settings for a specific channel. Currently, this can only be a list of
+                # conditions to apply.
+                sig do
+                  params(
+                    conditions: T::Array[Knockapi::Condition::OrHash]
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # A list of conditions to apply to a specific channel.
+                  conditions:
+                )
+                end
+
+                sig do
+                  override.returns(
+                    { conditions: T::Array[Knockapi::Condition] }
+                  )
+                end
+                def to_hash
+                end
+              end
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::Variants
+                  ]
+                )
+              end
+              def self.variants
+              end
+            end
           end
 
           sig do