knockapi 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4edf766ef7fea30511bafeaf37ca5ec9a230e92f40e9b47f020d735c397ae2d
-  data.tar.gz: 49f17bf1e3915debccfba88de22152aa00f53d14ff3189d549104343173c8d40
+  metadata.gz: ac0712fabab74c852c94a2b9965183efac90dfa032a82fe7cde8278646d2b618
+  data.tar.gz: 9d76422f9303bae5aee52d8b258637ea69c32dcb982a666d1a6c5379db2721fe
 SHA512:
-  metadata.gz: 503af7c4bee2cab95fb77aef066afd8c6703bb3f9db4b8a05483709b6eb6fa4822d301a60f755d61fe2ffdb2b8b9e072f148fd95f0f2e6c92ed217f15d06cc33
-  data.tar.gz: c074a2d2dce553547360e3b7a9a34a6fec7965a9eaa2fa7fc3ab6065d1e3d2bf138f1a219a5a9e7df22ee3e5a16d08da00500ad57fcae5a9753e73aacff5e89e
+  metadata.gz: 190a4ac895ece179f333b0db6e7aecdb754682a3707150932882f8e89eb239a5dd22dff185d348ac016cdc36dd26f86079224ba9511b355f201d477c6cdb2f14
+  data.tar.gz: 41e71629aa63e8d7c06ac71f4809235cc61988d01392ef44815e70c6721a753df11d9d47c6cae340e13ed5003638e6a5a70b4837209a10bcdd0c7831a59396e9

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 1.19.0 (2025-11-07)
+
+Full Changelog: [v1.18.0...v1.19.0](https://github.com/knocklabs/knock-ruby/compare/v1.18.0...v1.19.0)
+
+### Features
+
+* **api:** api update ([49dfcac](https://github.com/knocklabs/knock-ruby/commit/49dfcacc09c8dfe929b609b27160fbc378953e67))
+* **api:** api update ([21f8ae5](https://github.com/knocklabs/knock-ruby/commit/21f8ae5d08e7a977043af146d5eca6ed2204153d))
+* **api:** api update ([6cf1256](https://github.com/knocklabs/knock-ruby/commit/6cf125684bca003fcde03286c25e12275702eb46))
+* **api:** support specifying a branch ([ebb9daa](https://github.com/knocklabs/knock-ruby/commit/ebb9daa2a60ff30730a5e5566ef4495d038b8ff0))
+* correct channel data schemas ([10baf42](https://github.com/knocklabs/knock-ruby/commit/10baf42ada5f4249951177b98f338e103fe648ae))
+
+
+### Bug Fixes
+
+* better thread safety via early initializing SSL store during HTTP client creation ([513da8d](https://github.com/knocklabs/knock-ruby/commit/513da8d87063a34c430572553cc987996cebf1aa))
+
+
+### Chores
+
+* bump dependency version and update sorbet types ([373db9a](https://github.com/knocklabs/knock-ruby/commit/373db9a9ef43934c3783a5fda89c443062bf6780))
+* **client:** send user-agent header ([5946677](https://github.com/knocklabs/knock-ruby/commit/59466777a63ea93441435ac1cd468a1d7ca76cd6))
+
 ## 1.18.0 (2025-10-28)
 
 Full Changelog: [v1.17.0...v1.18.0](https://github.com/knocklabs/knock-ruby/compare/v1.17.0...v1.18.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "knockapi", "~> 1.18.0"
+gem "knockapi", "~> 1.19.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/client.rb

@@ -18,6 +18,10 @@ module Knockapi
     # @return [String]
     attr_reader :api_key
 
+    # The slug of an existing branch
+    # @return [String, nil]
+    attr_reader :branch
+
     # @return [Knockapi::Resources::Recipients]
     attr_reader :recipients
 
@@ -67,6 +71,8 @@ module Knockapi
     #
     # @param api_key [String, nil] Defaults to `ENV["KNOCK_API_KEY"]`
     #
+    # @param branch [String, nil] The slug of an existing branch Defaults to `ENV["KNOCK_BRANCH"]`
+    #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["KNOCK_BASE_URL"]`
     #
@@ -81,6 +87,7 @@ module Knockapi
     # @param idempotency_header [String]
     def initialize(
       api_key: ENV["KNOCK_API_KEY"],
+      branch: ENV["KNOCK_BRANCH"],
       base_url: ENV["KNOCK_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -94,6 +101,10 @@ module Knockapi
         raise ArgumentError.new("api_key is required, and can be set via environ: \"KNOCK_API_KEY\"")
       end
 
+      headers = {
+        "x-knock-branch" => (@branch = branch&.to_s)
+      }
+
       @api_key = api_key.to_s
 
       super(
@@ -102,6 +113,7 @@ module Knockapi
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
         max_retry_delay: max_retry_delay,
+        headers: headers,
         idempotency_header: idempotency_header
       )
 

data/lib/knockapi/internal/transport/base_client.rb

@@ -201,7 +201,8 @@ module Knockapi
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module Knockapi
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{Knockapi::VERSION}"
+
         # @api private
         #
         # @return [String]

data/lib/knockapi/internal/transport/pooled_net_requester.rb

@@ -16,10 +16,11 @@ module Knockapi
         class << self
           # @api private
           #
+          # @param cert_store [OpenSSL::X509::Store]
           # @param url [URI::Generic]
           #
           # @return [Net::HTTP]
-          def connect(url)
+          def connect(cert_store:, url:)
             port =
               case [url.port, url.scheme]
               in [Integer, _]
@@ -33,6 +34,8 @@ module Knockapi
             Net::HTTP.new(url.host, port).tap do
               _1.use_ssl = %w[https wss].include?(url.scheme)
               _1.max_retries = 0
+
+              (_1.cert_store = cert_store) if _1.use_ssl?
             end
           end
 
@@ -102,7 +105,7 @@ module Knockapi
           pool =
             @mutex.synchronize do
               @pools[origin] ||= ConnectionPool.new(size: @size) do
-                self.class.connect(url)
+                self.class.connect(cert_store: @cert_store, url: url)
               end
             end
 
@@ -192,6 +195,7 @@ module Knockapi
         def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
+          @cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths)
           @pools = {}
         end
 

data/lib/knockapi/models/identify_user_request.rb

@@ -12,7 +12,7 @@ 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]
@@ -79,7 +79,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.
       #

data/lib/knockapi/models/inline_identify_user_request.rb

@@ -18,7 +18,7 @@ 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]
@@ -88,7 +88,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.
       #

data/lib/knockapi/models/inline_object_request.rb

@@ -18,7 +18,7 @@ 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]
@@ -31,6 +31,12 @@ module Knockapi
       #   @return [Time, nil]
       optional :created_at, Time, nil?: true
 
+      # @!attribute name
+      #   An optional name for the object.
+      #
+      #   @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
@@ -41,7 +47,7 @@ module Knockapi
                -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
                nil?: true
 
-      # @!method initialize(id:, collection:, channel_data: nil, created_at: nil, preferences: nil)
+      # @!method initialize(id:, collection:, channel_data: nil, created_at: nil, name: nil, preferences: nil)
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::InlineObjectRequest} for more details.
       #
@@ -51,10 +57,12 @@ module Knockapi
       #
       #   @param collection [String] The collection this object belongs to.
       #
-      #   @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] Timestamp when the resource was created.
       #
+      #   @param name [String, nil] An optional name for the object.
+      #
       #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
     end
   end

data/lib/knockapi/models/object_set_params.rb

@@ -10,7 +10,7 @@ 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] }
 
@@ -21,6 +21,12 @@ module Knockapi
       #   @return [String, nil]
       optional :locale, String, nil?: true
 
+      # @!attribute name
+      #   An optional name for the object.
+      #
+      #   @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
@@ -38,14 +44,16 @@ module Knockapi
       #   @return [String, nil]
       optional :timezone, String, nil?: true
 
-      # @!method initialize(channel_data: nil, locale: nil, preferences: nil, timezone: nil, request_options: {})
+      # @!method initialize(channel_data: nil, locale: nil, name: nil, preferences: nil, timezone: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::ObjectSetParams} for more details.
       #
-      #   @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

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

@@ -29,7 +29,7 @@ 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]
@@ -42,6 +42,12 @@ module Knockapi
           #   @return [Time, nil]
           optional :created_at, Time, nil?: true
 
+          # @!attribute name
+          #   An optional name for the object.
+          #
+          #   @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
@@ -52,7 +58,7 @@ module Knockapi
                    -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
                    nil?: true
 
-          # @!method initialize(id:, channel_data: nil, created_at: nil, preferences: nil)
+          # @!method initialize(id:, channel_data: nil, created_at: nil, name: nil, preferences: nil)
           #   Some parameter documentations has been truncated, see
           #   {Knockapi::Models::Objects::BulkSetParams::Object} for more details.
           #
@@ -60,10 +66,12 @@ module Knockapi
           #
           #   @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}, 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] Timestamp when the resource was created.
           #
+          #   @param name [String, nil] An optional name for the object.
+          #
           #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
         end
       end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class AwsSnsPushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
+        # @!attribute devices
+        #   A list of devices. Each device contains a target_arn, and optionally a locale
+        #   and timezone.
+        #
+        #   @return [Array<Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly::Device>]
+        required :devices,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly::Device] }
+
+        # @!method initialize(devices:)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly} for more
+        #   details.
+        #
+        #   AWS SNS push channel data.
+        #
+        #   @param devices [Array<Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly::Device>] A list of devices. Each device contains a target_arn, and optionally a locale an
+
+        class Device < Knockapi::Internal::Type::BaseModel
+          # @!attribute target_arn
+          #   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).
+          #
+          #   @return [String]
+          required :target_arn, 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(target_arn:, locale: nil, timezone: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly::Device} for
+          #   more details.
+          #
+          #   @param target_arn [String] The ARN of a platform endpoint associated with a platform application and a devi
+          #
+          #   @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/aws_sns_push_channel_data_target_arns_only.rb

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

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

@@ -19,7 +19,7 @@ module Knockapi
         # @!attribute data
         #   Channel data for a given channel type.
         #
-        #   @return [Knockapi::Models::Recipients::RecipientsChannelData::Data::PushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::Data::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData]
+        #   @return [Knockapi::Models::Recipients::RecipientsChannelData::Data::PushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData]
         required :data, union: -> { Knockapi::Recipients::RecipientsChannelData::Data }
 
         # @!attribute provider
@@ -35,7 +35,7 @@ module Knockapi
         #
         #   @param channel_id [String] The unique identifier for the channel.
         #
-        #   @param data [Knockapi::Models::Recipients::RecipientsChannelData::Data::PushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::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::RecipientsChannelData::Data::PushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
         #
         #   @param provider [Symbol, Knockapi::Models::Recipients::RecipientsChannelData::Provider] The type of provider.
 
@@ -52,7 +52,7 @@ module Knockapi
           variant -> { Knockapi::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull }
 
           # OneSignal channel data.
-          variant -> { Knockapi::Recipients::RecipientsChannelData::Data::OneSignalChannelDataPlayerIDsOnly }
+          variant -> { Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly }
 
           # Slack channel data.
           variant -> { Knockapi::Recipients::SlackChannelData }
@@ -190,21 +190,8 @@ module Knockapi
             end
           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::RecipientsChannelData::Data::PushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::Data::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
+          #   @return [Array(Knockapi::Models::Recipients::RecipientsChannelData::Data::PushChannelDataFull, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
         end
 
         # The type of provider.