knockapi 1.16.0 → 1.17.0

data/rbi/knockapi/resources/messages/batch.rbi

@@ -10,7 +10,7 @@ module Knockapi
           params(
             message_ids: T::Array[String],
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T::Array[Knockapi::Models::Message])
+          ).returns(T::Array[Knockapi::Message])
         end
         def archive(
           # The message IDs to update the status of.
@@ -45,7 +45,7 @@ module Knockapi
             message_ids: T::Array[String],
             metadata: T.nilable(T::Hash[Symbol, T.anything]),
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T::Array[Knockapi::Models::Message])
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_interacted(
           # The message IDs to batch mark as interacted with.
@@ -62,7 +62,7 @@ module Knockapi
           params(
             message_ids: T::Array[String],
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T::Array[Knockapi::Models::Message])
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_read(
           # The message IDs to update the status of.
@@ -78,7 +78,7 @@ module Knockapi
           params(
             message_ids: T::Array[String],
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T::Array[Knockapi::Models::Message])
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_seen(
           # The message IDs to update the status of.
@@ -94,7 +94,7 @@ module Knockapi
           params(
             message_ids: T::Array[String],
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T::Array[Knockapi::Models::Message])
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_unread(
           # The message IDs to update the status of.
@@ -110,7 +110,7 @@ module Knockapi
           params(
             message_ids: T::Array[String],
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T::Array[Knockapi::Models::Message])
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_unseen(
           # The message IDs to update the status of.
@@ -126,7 +126,7 @@ module Knockapi
           params(
             message_ids: T::Array[String],
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T::Array[Knockapi::Models::Message])
+          ).returns(T::Array[Knockapi::Message])
         end
         def unarchive(
           # The message IDs to update the status of.

data/rbi/knockapi/resources/objects.rbi

@@ -353,9 +353,9 @@ module Knockapi
             T::Hash[
               Symbol,
               T.any(
-                Knockapi::Recipients::PushChannelData::OrHash,
-                Knockapi::Recipients::OneSignalChannelData::OrHash,
-                Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
+                Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly::OrHash,
+                Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly::OrHash,
+                Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly::OrHash,
                 Knockapi::Recipients::SlackChannelData::OrHash,
                 Knockapi::Recipients::MsTeamsChannelData::OrHash,
                 Knockapi::Recipients::DiscordChannelData::OrHash
@@ -401,9 +401,9 @@ module Knockapi
           channel_id: String,
           data:
             T.any(
-              Knockapi::Recipients::PushChannelData::OrHash,
-              Knockapi::Recipients::OneSignalChannelData::OrHash,
-              Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash,
+              Knockapi::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly::OrHash,
+              Knockapi::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly::OrHash,
+              Knockapi::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly::OrHash,
               Knockapi::Recipients::SlackChannelData::OrHash,
               Knockapi::Recipients::MsTeamsChannelData::OrHash,
               Knockapi::Recipients::DiscordChannelData::OrHash
@@ -451,6 +451,17 @@ module Knockapi
             ),
           channel_types:
             T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes::OrHash),
+          channels:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting::OrHash
+                )
+              ]
+            ),
+          commercial_subscribed: T.nilable(T::Boolean),
           workflows:
             T.nilable(
               T::Hash[
@@ -479,6 +490,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,

data/rbi/knockapi/resources/tenants.rbi

@@ -70,9 +70,9 @@ module Knockapi
               T::Hash[
                 Symbol,
                 T.any(
-                  Knockapi::Recipients::PushChannelData::OrHash,
-                  Knockapi::Recipients::OneSignalChannelData::OrHash,
-                  Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly::OrHash,
                   Knockapi::Recipients::SlackChannelData::OrHash,
                   Knockapi::Recipients::MsTeamsChannelData::OrHash,
                   Knockapi::Recipients::DiscordChannelData::OrHash

data/rbi/knockapi/resources/users.rbi

@@ -24,9 +24,9 @@ module Knockapi
               T::Hash[
                 Symbol,
                 T.any(
-                  Knockapi::Recipients::PushChannelData::OrHash,
-                  Knockapi::Recipients::OneSignalChannelData::OrHash,
-                  Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly::OrHash,
                   Knockapi::Recipients::SlackChannelData::OrHash,
                   Knockapi::Recipients::MsTeamsChannelData::OrHash,
                   Knockapi::Recipients::DiscordChannelData::OrHash
@@ -343,9 +343,9 @@ module Knockapi
           channel_id: String,
           data:
             T.any(
-              Knockapi::Recipients::PushChannelData::OrHash,
-              Knockapi::Recipients::OneSignalChannelData::OrHash,
-              Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash,
+              Knockapi::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly::OrHash,
+              Knockapi::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly::OrHash,
+              Knockapi::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly::OrHash,
               Knockapi::Recipients::SlackChannelData::OrHash,
               Knockapi::Recipients::MsTeamsChannelData::OrHash,
               Knockapi::Recipients::DiscordChannelData::OrHash
@@ -386,6 +386,17 @@ module Knockapi
             ),
           channel_types:
             T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes::OrHash),
+          channels:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting::OrHash
+                )
+              ]
+            ),
+          commercial_subscribed: T.nilable(T::Boolean),
           workflows:
             T.nilable(
               T::Hash[
@@ -412,6 +423,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,

data/sig/knockapi/models/message.rbs

@@ -13,6 +13,7 @@ module Knockapi
         updated_at: Time,
         actors: ::Array[Knockapi::Models::recipient_reference],
         archived_at: Time?,
+        channel: Knockapi::Message::Channel,
         clicked_at: Time?,
         data: ::Hash[Symbol, top]?,
         interacted_at: Time?,
@@ -52,6 +53,10 @@ module Knockapi
 
       attr_accessor archived_at: Time?
 
+      attr_reader channel: Knockapi::Message::Channel?
+
+      def channel=: (Knockapi::Message::Channel) -> Knockapi::Message::Channel
+
       attr_accessor clicked_at: Time?
 
       attr_accessor data: ::Hash[Symbol, top]?
@@ -84,6 +89,7 @@ module Knockapi
         updated_at: Time,
         ?actors: ::Array[Knockapi::Models::recipient_reference],
         ?archived_at: Time?,
+        ?channel: Knockapi::Message::Channel,
         ?clicked_at: Time?,
         ?data: ::Hash[Symbol, top]?,
         ?interacted_at: Time?,
@@ -108,6 +114,7 @@ module Knockapi
         updated_at: Time,
         actors: ::Array[Knockapi::Models::recipient_reference],
         archived_at: Time?,
+        channel: Knockapi::Message::Channel,
         clicked_at: Time?,
         data: ::Hash[Symbol, top]?,
         interacted_at: Time?,
@@ -215,6 +222,78 @@ module Knockapi
 
         def self?.values: -> ::Array[Knockapi::Models::Message::status]
       end
+
+      type channel =
+        {
+          id: String,
+          created_at: Time,
+          provider: String,
+          type: Knockapi::Models::Message::Channel::type_,
+          updated_at: Time,
+          key: String?,
+          name: String?
+        }
+
+      class Channel < Knockapi::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor provider: String
+
+        attr_accessor type: Knockapi::Models::Message::Channel::type_
+
+        attr_accessor updated_at: Time
+
+        attr_accessor key: String?
+
+        attr_accessor name: String?
+
+        def initialize: (
+          id: String,
+          created_at: Time,
+          provider: String,
+          type: Knockapi::Models::Message::Channel::type_,
+          updated_at: Time,
+          ?key: String?,
+          ?name: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Time,
+          provider: String,
+          type: Knockapi::Models::Message::Channel::type_,
+          updated_at: Time,
+          key: String?,
+          name: String?
+        }
+
+        type type_ =
+          :email
+          | :in_app
+          | :in_app_feed
+          | :in_app_guide
+          | :sms
+          | :push
+          | :chat
+          | :http
+
+        module Type
+          extend Knockapi::Internal::Type::Enum
+
+          EMAIL: :email
+          IN_APP: :in_app
+          IN_APP_FEED: :in_app_feed
+          IN_APP_GUIDE: :in_app_guide
+          SMS: :sms
+          PUSH: :push
+          CHAT: :chat
+          HTTP: :http
+
+          def self?.values: -> ::Array[Knockapi::Models::Message::Channel::type_]
+        end
+      end
     end
   end
 end

data/sig/knockapi/models/messages/batch_archive_response.rbs

@@ -1,7 +1,7 @@
 module Knockapi
   module Models
     module Messages
-      type batch_archive_response = ::Array[Knockapi::Models::Message]
+      type batch_archive_response = ::Array[Knockapi::Message]
 
       BatchArchiveResponse: Knockapi::Internal::Type::Converter
     end

data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs

@@ -1,8 +1,7 @@
 module Knockapi
   module Models
     module Messages
-      type batch_mark_as_interacted_response =
-        ::Array[Knockapi::Models::Message]
+      type batch_mark_as_interacted_response = ::Array[Knockapi::Message]
 
       BatchMarkAsInteractedResponse: Knockapi::Internal::Type::Converter
     end

data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs

@@ -1,7 +1,7 @@
 module Knockapi
   module Models
     module Messages
-      type batch_mark_as_read_response = ::Array[Knockapi::Models::Message]
+      type batch_mark_as_read_response = ::Array[Knockapi::Message]
 
       BatchMarkAsReadResponse: Knockapi::Internal::Type::Converter
     end

data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs

@@ -1,7 +1,7 @@
 module Knockapi
   module Models
     module Messages
-      type batch_mark_as_seen_response = ::Array[Knockapi::Models::Message]
+      type batch_mark_as_seen_response = ::Array[Knockapi::Message]
 
       BatchMarkAsSeenResponse: Knockapi::Internal::Type::Converter
     end

data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs

@@ -1,7 +1,7 @@
 module Knockapi
   module Models
     module Messages
-      type batch_mark_as_unread_response = ::Array[Knockapi::Models::Message]
+      type batch_mark_as_unread_response = ::Array[Knockapi::Message]
 
       BatchMarkAsUnreadResponse: Knockapi::Internal::Type::Converter
     end

data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs

@@ -1,7 +1,7 @@
 module Knockapi
   module Models
     module Messages
-      type batch_mark_as_unseen_response = ::Array[Knockapi::Models::Message]
+      type batch_mark_as_unseen_response = ::Array[Knockapi::Message]
 
       BatchMarkAsUnseenResponse: Knockapi::Internal::Type::Converter
     end

data/sig/knockapi/models/messages/batch_unarchive_response.rbs

@@ -1,7 +1,7 @@
 module Knockapi
   module Models
     module Messages
-      type batch_unarchive_response = ::Array[Knockapi::Models::Message]
+      type batch_unarchive_response = ::Array[Knockapi::Message]
 
       BatchUnarchiveResponse: Knockapi::Internal::Type::Converter
     end

data/sig/knockapi/models/recipients/channel_data.rbs

@@ -37,24 +37,114 @@ module Knockapi
         }
 
         type data =
-          Knockapi::Recipients::PushChannelData
+          Knockapi::Recipients::RecipientsChannelData::Data::PushChannelDataFull
+          | Knockapi::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull
+          | Knockapi::Recipients::RecipientsChannelData::Data::OneSignalChannelDataPlayerIDsOnly
           | Knockapi::Recipients::SlackChannelData
           | Knockapi::Recipients::MsTeamsChannelData
           | Knockapi::Recipients::DiscordChannelData
-          | Knockapi::Recipients::OneSignalChannelData
-          | Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData
 
         module Data
           extend Knockapi::Internal::Type::Union
 
-          type aws_sns_push_channel_data = { target_arns: ::Array[String] }
+          type push_channel_data_full =
+            {
+              devices: ::Array[Knockapi::Recipients::RecipientsChannelData::Data::PushChannelDataFull::Device],
+              tokens: ::Array[String]
+            }
+
+          class PushChannelDataFull < Knockapi::Internal::Type::BaseModel
+            attr_accessor devices: ::Array[Knockapi::Recipients::RecipientsChannelData::Data::PushChannelDataFull::Device]
+
+            attr_accessor tokens: ::Array[String]
+
+            def initialize: (
+              devices: ::Array[Knockapi::Recipients::RecipientsChannelData::Data::PushChannelDataFull::Device],
+              tokens: ::Array[String]
+            ) -> void
+
+            def to_hash: -> {
+              devices: ::Array[Knockapi::Recipients::RecipientsChannelData::Data::PushChannelDataFull::Device],
+              tokens: ::Array[String]
+            }
+
+            type device = { token: String, locale: String?, timezone: String? }
+
+            class Device < Knockapi::Internal::Type::BaseModel
+              attr_accessor token: String
+
+              attr_accessor locale: String?
+
+              attr_accessor timezone: String?
+
+              def initialize: (
+                token: String,
+                ?locale: String?,
+                ?timezone: String?
+              ) -> void
+
+              def to_hash: -> {
+                token: String,
+                locale: String?,
+                timezone: String?
+              }
+            end
+          end
+
+          type awssns_push_channel_data_full =
+            {
+              devices: ::Array[Knockapi::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull::Device],
+              target_arns: ::Array[String]
+            }
+
+          class AwssnsPushChannelDataFull < Knockapi::Internal::Type::BaseModel
+            attr_accessor devices: ::Array[Knockapi::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull::Device]
 
-          class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
             attr_accessor target_arns: ::Array[String]
 
-            def initialize: (target_arns: ::Array[String]) -> void
+            def initialize: (
+              devices: ::Array[Knockapi::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull::Device],
+              target_arns: ::Array[String]
+            ) -> void
+
+            def to_hash: -> {
+              devices: ::Array[Knockapi::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull::Device],
+              target_arns: ::Array[String]
+            }
+
+            type device =
+              { target_arn: String, locale: String?, timezone: String? }
+
+            class Device < Knockapi::Internal::Type::BaseModel
+              attr_accessor target_arn: String
+
+              attr_accessor locale: String?
+
+              attr_accessor timezone: String?
+
+              def initialize: (
+                target_arn: String,
+                ?locale: String?,
+                ?timezone: String?
+              ) -> void
+
+              def to_hash: -> {
+                target_arn: String,
+                locale: String?,
+                timezone: String?
+              }
+            end
+          end
+
+          type one_signal_channel_data_player_ids_only =
+            { player_ids: ::Array[String] }
+
+          class OneSignalChannelDataPlayerIDsOnly < Knockapi::Internal::Type::BaseModel
+            attr_accessor player_ids: ::Array[String]
+
+            def initialize: (player_ids: ::Array[String]) -> void
 
-            def to_hash: -> { target_arns: ::Array[String] }
+            def to_hash: -> { player_ids: ::Array[String] }
           end
 
           def self?.variants: -> ::Array[Knockapi::Models::Recipients::RecipientsChannelData::data]

data/sig/knockapi/models/recipients/channel_data_request.rbs

@@ -16,9 +16,9 @@ module Knockapi
         }
 
         type data =
-          Knockapi::Recipients::PushChannelData
-          | Knockapi::Recipients::OneSignalChannelData
-          | Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData
+          Knockapi::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly
+          | Knockapi::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly
+          | Knockapi::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly
           | Knockapi::Recipients::SlackChannelData
           | Knockapi::Recipients::MsTeamsChannelData
           | Knockapi::Recipients::DiscordChannelData
@@ -26,9 +26,20 @@ module Knockapi
         module Data
           extend Knockapi::Internal::Type::Union
 
-          type aws_sns_push_channel_data = { target_arns: ::Array[String] }
+          type push_channel_data_tokens_only = { tokens: ::Array[String] }
 
-          class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
+          class PushChannelDataTokensOnly < Knockapi::Internal::Type::BaseModel
+            attr_accessor tokens: ::Array[String]
+
+            def initialize: (tokens: ::Array[String]) -> void
+
+            def to_hash: -> { tokens: ::Array[String] }
+          end
+
+          type awssns_push_channel_data_target_ar_ns_only =
+            { target_arns: ::Array[String] }
+
+          class AwssnsPushChannelDataTargetArNsOnly < Knockapi::Internal::Type::BaseModel
             attr_accessor target_arns: ::Array[String]
 
             def initialize: (target_arns: ::Array[String]) -> void
@@ -36,6 +47,17 @@ module Knockapi
             def to_hash: -> { target_arns: ::Array[String] }
           end
 
+          type one_signal_channel_data_player_ids_only =
+            { player_ids: ::Array[String] }
+
+          class OneSignalChannelDataPlayerIDsOnly < Knockapi::Internal::Type::BaseModel
+            attr_accessor player_ids: ::Array[String]
+
+            def initialize: (player_ids: ::Array[String]) -> void
+
+            def to_hash: -> { player_ids: ::Array[String] }
+          end
+
           def self?.variants: -> ::Array[Knockapi::Models::Recipients::ChannelDataRequest::data]
         end
       end

data/sig/knockapi/models/recipients/inline_channel_data_request.rbs

@@ -2,9 +2,9 @@ module Knockapi
   module Models
     module Recipients
       type inline_channel_data_request_item =
-        Knockapi::Recipients::PushChannelData
-        | Knockapi::Recipients::OneSignalChannelData
-        | Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData
+        Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly
+        | Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly
+        | Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly
         | Knockapi::Recipients::SlackChannelData
         | Knockapi::Recipients::MsTeamsChannelData
         | Knockapi::Recipients::DiscordChannelData
@@ -12,9 +12,20 @@ module Knockapi
       module InlineChannelDataRequestItem
         extend Knockapi::Internal::Type::Union
 
-        type aws_sns_push_channel_data = { target_arns: ::Array[String] }
+        type push_channel_data_tokens_only = { tokens: ::Array[String] }
 
-        class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
+        class PushChannelDataTokensOnly < Knockapi::Internal::Type::BaseModel
+          attr_accessor tokens: ::Array[String]
+
+          def initialize: (tokens: ::Array[String]) -> void
+
+          def to_hash: -> { tokens: ::Array[String] }
+        end
+
+        type awssns_push_channel_data_target_ar_ns_only =
+          { target_arns: ::Array[String] }
+
+        class AwssnsPushChannelDataTargetArNsOnly < Knockapi::Internal::Type::BaseModel
           attr_accessor target_arns: ::Array[String]
 
           def initialize: (target_arns: ::Array[String]) -> void
@@ -22,6 +33,17 @@ module Knockapi
           def to_hash: -> { target_arns: ::Array[String] }
         end
 
+        type one_signal_channel_data_player_ids_only =
+          { player_ids: ::Array[String] }
+
+        class OneSignalChannelDataPlayerIDsOnly < Knockapi::Internal::Type::BaseModel
+          attr_accessor player_ids: ::Array[String]
+
+          def initialize: (player_ids: ::Array[String]) -> void
+
+          def to_hash: -> { player_ids: ::Array[String] }
+        end
+
         def self?.variants: -> ::Array[Knockapi::Models::Recipients::inline_channel_data_request_item]
       end