trycourier 4.26.1 → 4.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dae9e29710e0f5f51b49e7f54a4dea8ca81242d1e60b5c22c1e6fbebb40f7764
-  data.tar.gz: 6495ca2eb5e082913bb43f3f6d1e1b933f5b4be59de9b3d33f9c3b276027948a
+  metadata.gz: 9f62c9ba0ccf68a6be91bb13460ab3d7ed38815cd7d2827eba3f0b6c5460598b
+  data.tar.gz: 7d3026d94cc1db562eb020e2e145eacbb67bd5adeada9e29010e60143bdba7ce
 SHA512:
-  metadata.gz: 6f700ac897dd06c5fea58697d83f3380a2b9da7228e5da085433df3eaa3e26434c6f634e2392d67e8582aa74854a6f9c1b3a6800095f3656e259bf8738bef21c
-  data.tar.gz: 8a2cac3bce7dc295374474a83aaf488496e8f347b4d4f0c72a9f524e4746dfa84c6c2ab6f053fbf4efac5733625d789eebe6493e7517d5ae7121d5ebe4dda8ab
+  metadata.gz: aed6dce51f5f53597c0b64f394f29cec87c693790996d74d7fc6aaac652a724fe31dda9c3068e0c355888349cf0cb2249db1f8c70126c6f4eea85af0c75c70e6
+  data.tar.gz: b2b494e23b204e033f15d79fe44aa38b601443a515915955c678770878268e68700793bd1542036c405a7e8b0cef24db72d4d33576dd73bdd94d295bc51fe148

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [4.26.2](https://github.com/trycourier/courier-ruby/compare/v4.26.1...v4.26.2) (2026-08-13)
+
+
+### Documentation
+
+* **api:** describe every broadcast id path parameter ([#120](https://github.com/trycourier/courier-ruby/issues/120)) ([2f4031e](https://github.com/trycourier/courier-ruby/commit/2f4031e65786588609fcf21e8cc7b42b3813eed7))
+* **api:** say what the bulk job endpoints return ([#122](https://github.com/trycourier/courier-ruby/issues/122)) ([e5f3d75](https://github.com/trycourier/courier-ruby/commit/e5f3d7576f1b682fa395d3d7ef05c7dfb69ea922))
+
 ## [4.26.1](https://github.com/trycourier/courier-ruby/compare/v4.26.0...v4.26.1) (2026-08-13)
 
 

data/README.md

@@ -9,7 +9,7 @@ Add the gem to your `Gemfile`:
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 4.26.1"
+gem "trycourier", "~> 4.26.2"
 ```
 
 <!-- x-release-please-end -->

data/lib/courier/resources/broadcasts.rb

@@ -35,7 +35,8 @@ module Courier
       #
       # @overload retrieve(broadcast_id, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast to retrieve, identified by the `id` returned when it was created.
+      #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Courier::Models::Broadcast]
@@ -55,7 +56,7 @@ module Courier
       #
       # @overload update(broadcast_id, name:, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast to rename.
       #
       # @param name [String] New human-readable name.
       #
@@ -106,7 +107,8 @@ module Courier
       #
       # @overload archive(broadcast_id, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast to archive.
+      #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Courier::Models::Broadcast]
@@ -126,7 +128,8 @@ module Courier
       #
       # @overload cancel(broadcast_id, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast to cancel.
+      #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Courier::Models::Broadcast]
@@ -141,12 +144,16 @@ module Courier
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::BroadcastDuplicateParams} for more details.
+      #
       # Duplicate a broadcast (and its template) into a new draft named "{source name}
       # (copy)".
       #
       # @overload duplicate(broadcast_id, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast to copy. The duplicate is created as a new draft and this broadcas
+      #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Courier::Models::Broadcast]
@@ -167,7 +174,7 @@ module Courier
       #
       # @overload put_content(broadcast_id, content:, state: nil, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast whose content you want to replace.
       #
       # @param content [Courier::Models::NotificationContentPutRequest::Content] Elemental content payload. The server defaults `version` when omitted.
       #
@@ -198,7 +205,7 @@ module Courier
       #
       # @overload retrieve_content(broadcast_id, version: nil, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast whose content you want to read.
       #
       # @param version [String] Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to `dr
       #
@@ -228,7 +235,7 @@ module Courier
       #
       # @overload schedule(broadcast_id, recipient_id:, recipient_type:, scheduled_to:, timezone: nil, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast to schedule.
       #
       # @param recipient_id [String] ID of the target list or audience.
       #
@@ -259,7 +266,7 @@ module Courier
       #
       # @overload send_(broadcast_id, recipient_id:, recipient_type:, request_options: {})
       #
-      # @param broadcast_id [String]
+      # @param broadcast_id [String] The broadcast to send.
       #
       # @param recipient_id [String] ID of the target list or audience.
       #

data/lib/courier/resources/bulk.rb

@@ -65,7 +65,8 @@ module Courier
       # Some parameter documentations has been truncated, see
       # {Courier::Models::BulkListUsersParams} for more details.
       #
-      # Get Bulk Job Users
+      # Returns the users ingested into a bulk job with paging, each carrying the status
+      # Courier recorded for it and the id of the message it produced.
       #
       # @overload list_users(job_id, cursor: nil, request_options: {})
       #
@@ -90,7 +91,9 @@ module Courier
         )
       end
 
-      # Get a bulk job
+      # Returns a bulk job's message definition, its status — CREATED, PROCESSING,
+      # COMPLETED, or ERROR — and running counts of users received, messages enqueued,
+      # and failures. Poll it to follow a job through to completion.
       #
       # @overload retrieve_job(job_id, request_options: {})
       #
@@ -110,7 +113,9 @@ module Courier
         )
       end
 
-      # Run a bulk job
+      # Starts processing a bulk job, sending to every user ingested into it. Returns
+      # 204 immediately; the job runs asynchronously, so poll the job to watch its
+      # status and counts.
       #
       # @overload run_job(job_id, request_options: {})
       #

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "4.26.1"
+  VERSION = "4.26.2"
 end

data/rbi/courier/resources/broadcasts.rbi

@@ -31,7 +31,11 @@ module Courier
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::Broadcast)
       end
-      def retrieve(broadcast_id, request_options: {})
+      def retrieve(
+        # The broadcast to retrieve, identified by the `id` returned when it was created.
+        broadcast_id,
+        request_options: {}
+      )
       end
 
       # Update a broadcast's name. Content is edited via the broadcast's notification
@@ -44,6 +48,7 @@ module Courier
         ).returns(Courier::Broadcast)
       end
       def update(
+        # The broadcast to rename.
         broadcast_id,
         # New human-readable name.
         name:,
@@ -77,7 +82,11 @@ module Courier
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::Broadcast)
       end
-      def archive(broadcast_id, request_options: {})
+      def archive(
+        # The broadcast to archive.
+        broadcast_id,
+        request_options: {}
+      )
       end
 
       # Cancel a broadcast's pending schedule, returning it to the draft state. Only
@@ -88,7 +97,11 @@ module Courier
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::Broadcast)
       end
-      def cancel(broadcast_id, request_options: {})
+      def cancel(
+        # The broadcast to cancel.
+        broadcast_id,
+        request_options: {}
+      )
       end
 
       # Duplicate a broadcast (and its template) into a new draft named "{source name}
@@ -99,7 +112,12 @@ module Courier
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::Broadcast)
       end
-      def duplicate(broadcast_id, request_options: {})
+      def duplicate(
+        # The broadcast to copy. The duplicate is created as a new draft and this
+        # broadcast is left unchanged.
+        broadcast_id,
+        request_options: {}
+      )
       end
 
       # Author the broadcast's content by replacing the draft elemental content of its
@@ -114,6 +132,7 @@ module Courier
         ).returns(Courier::NotificationContentMutationResponse)
       end
       def put_content(
+        # The broadcast whose content you want to replace.
         broadcast_id,
         # Elemental content payload. The server defaults `version` when omitted.
         content:,
@@ -134,6 +153,7 @@ module Courier
         ).returns(Courier::NotificationContentGetResponse)
       end
       def retrieve_content(
+        # The broadcast whose content you want to read.
         broadcast_id,
         # Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to
         # `draft`.
@@ -157,6 +177,7 @@ module Courier
         ).returns(Courier::Broadcast)
       end
       def schedule(
+        # The broadcast to schedule.
         broadcast_id,
         # ID of the target list or audience.
         recipient_id:,
@@ -183,6 +204,7 @@ module Courier
         ).returns(Courier::Broadcast)
       end
       def send_(
+        # The broadcast to send.
         broadcast_id,
         # ID of the target list or audience.
         recipient_id:,

data/rbi/courier/resources/bulk.rbi

@@ -47,7 +47,8 @@ module Courier
       )
       end
 
-      # Get Bulk Job Users
+      # Returns the users ingested into a bulk job with paging, each carrying the status
+      # Courier recorded for it and the id of the message it produced.
       sig do
         params(
           job_id: String,
@@ -65,7 +66,9 @@ module Courier
       )
       end
 
-      # Get a bulk job
+      # Returns a bulk job's message definition, its status — CREATED, PROCESSING,
+      # COMPLETED, or ERROR — and running counts of users received, messages enqueued,
+      # and failures. Poll it to follow a job through to completion.
       sig do
         params(
           job_id: String,
@@ -79,7 +82,9 @@ module Courier
       )
       end
 
-      # Run a bulk job
+      # Starts processing a bulk job, sending to every user ingested into it. Returns
+      # 204 immediately; the job runs asynchronously, so poll the job to watch its
+      # status and counts.
       sig do
         params(
           job_id: String,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 4.26.1
+  version: 4.26.2
 platform: ruby
 authors:
 - Courier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-13 00:00:00.000000000 Z
+date: 2026-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi