trycourier 4.26.0 → 4.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c82d3665f14afda7c4e656a802da5d7e949a73570d969e0ba4963ebca052cafb
-  data.tar.gz: 4e20b157ddb87e3f8bb4699f4010dac082c231550fcd546ecea09c514aae6baf
+  metadata.gz: dae9e29710e0f5f51b49e7f54a4dea8ca81242d1e60b5c22c1e6fbebb40f7764
+  data.tar.gz: 6495ca2eb5e082913bb43f3f6d1e1b933f5b4be59de9b3d33f9c3b276027948a
 SHA512:
-  metadata.gz: 41b277139739fa601401ff3b160af7f1d501782edc24c1efb0029d8042ec3fdab8580237b1ebae867322fd78f61977787248aab8c112c14341055f1576d6ed94
-  data.tar.gz: 32c6c9dcabd41b05a7773e30c869a16013a695503a76ba75b921447c2ba166c560f806c20842de315b6c188febf6b9a716ffc7a8dd60e857b9a65b471877976c
+  metadata.gz: 6f700ac897dd06c5fea58697d83f3380a2b9da7228e5da085433df3eaa3e26434c6f634e2392d67e8582aa74854a6f9c1b3a6800095f3656e259bf8738bef21c
+  data.tar.gz: 8a2cac3bce7dc295374474a83aaf488496e8f347b4d4f0c72a9f524e4746dfa84c6c2ab6f053fbf4efac5733625d789eebe6493e7517d5ae7121d5ebe4dda8ab

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [4.26.1](https://github.com/trycourier/courier-ruby/compare/v4.26.0...v4.26.1) (2026-08-13)
+
+
+### Chores
+
+* **api:** regenerate SDK ([#115](https://github.com/trycourier/courier-ruby/issues/115)) ([27dadbf](https://github.com/trycourier/courier-ruby/commit/27dadbfd9a49b7f2fe7970d8a63f956f76d484e6))
+
+
+### Documentation
+
+* **api:** give every request body an example, and correct the archive status code ([#119](https://github.com/trycourier/courier-ruby/issues/119)) ([b4ad8e9](https://github.com/trycourier/courier-ruby/commit/b4ad8e90341bc2a7a0a34c04aeddcb60a91124e7))
+* sync README from api-spec ([#113](https://github.com/trycourier/courier-ruby/issues/113)) ([8d479fe](https://github.com/trycourier/courier-ruby/commit/8d479fe04eea80c8f307e054e78098fe7cde253e))
+
 ## 4.26.0 (2026-08-10)
 
 Full Changelog: [v4.25.0...v4.26.0](https://github.com/trycourier/courier-ruby/compare/v4.25.0...v4.26.0)

data/README.md

@@ -1,17 +1,20 @@
-<!-- AUTO-GENERATED-OVERVIEW:START — Do not edit this section. It is synced from mintlify-docs. -->
 # Courier Ruby SDK
 
-The Courier Ruby SDK provides typed access to the Courier REST API from any Ruby 3.2+ application. It ships with Yard docstrings, RBS and RBI type definitions for Sorbet, and uses `net/http` with connection pooling.
+The Courier Ruby SDK provides typed access to the Courier REST API from Ruby applications. Use it to send notifications, manage user profiles, check message status, issue JWT tokens for client-side SDKs, and more.
 
 ## Installation
 
-Add to your `Gemfile`:
+Add the gem to your `Gemfile`:
+
+<!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier"
+gem "trycourier", "~> 4.26.1"
 ```
 
-Then run `bundle install`.
+<!-- x-release-please-end -->
+
+Then run `bundle install`. Requires Ruby 3.2+.
 
 ## Quick Start
 
@@ -19,24 +22,20 @@ Then run `bundle install`.
 require "bundler/setup"
 require "courier"
 
-client = Courier::Client.new
+courier = Courier::Client.new(
+  api_key: ENV["COURIER_API_KEY"] # the default, can be omitted
+)
 
-response = client.send_.message(
-  message: {
-    to: { email: "you@example.com" },
-    content: {
-      title: "Hello from Courier!",
-      body: "Your first notification, sent with the Ruby SDK."
-    }
-  }
+response = courier.send_.message(
+  message: {to: {user_id: "your_user_id"}, template: "your_template_id", data: {foo: "bar"}}
 )
 
-puts response.request_id
+puts(response.requestId)
 ```
 
-The client reads `COURIER_API_KEY` from your environment automatically. You can also pass it explicitly: `Courier::Client.new(api_key: "your-key")`.
+The client reads `COURIER_API_KEY` from your environment automatically.
 
-> **Note**: The method is `send_` (with trailing underscore) because `send` is a reserved method in Ruby.
+Note the trailing underscore on `send_` — `send` is reserved in Ruby.
 
 ## Documentation
 
@@ -45,5 +44,3 @@ Full documentation: **[courier.com/docs/sdk-libraries/ruby](https://www.courier.
 - [Quickstart](https://www.courier.com/docs/getting-started/quickstart/)
 - [Send API](https://www.courier.com/docs/platform/sending/send-message/)
 - [API Reference](https://www.courier.com/docs/reference/get-started/)
-- [RubyDoc](https://gemdocs.org/gems/trycourier)
-<!-- AUTO-GENERATED-OVERVIEW:END -->

data/lib/courier/client.rb

@@ -58,6 +58,9 @@ module Courier
     # @return [Courier::Resources::Broadcasts]
     attr_reader :broadcasts
 
+    # @return [Courier::Resources::Bulk]
+    attr_reader :bulk
+
     # Manage the logos, colors, and layout that give the templates you send a
     # consistent look.
     # @return [Courier::Resources::Brands]
@@ -187,6 +190,7 @@ module Courier
       @automations = Courier::Resources::Automations.new(client: self)
       @journeys = Courier::Resources::Journeys.new(client: self)
       @broadcasts = Courier::Resources::Broadcasts.new(client: self)
+      @bulk = Courier::Resources::Bulk.new(client: self)
       @brands = Courier::Resources::Brands.new(client: self)
       @digests = Courier::Resources::Digests.new(client: self)
       @inbound = Courier::Resources::Inbound.new(client: self)

data/lib/courier/models/bulk_add_users_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Bulk#add_users
+    class BulkAddUsersParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String
+
+      # @!attribute users
+      #
+      #   @return [Array<Courier::Models::InboundBulkMessageUser>]
+      required :users, -> { Courier::Internal::Type::ArrayOf[Courier::InboundBulkMessageUser] }
+
+      # @!method initialize(job_id:, users:, request_options: {})
+      #   @param job_id [String]
+      #   @param users [Array<Courier::Models::InboundBulkMessageUser>]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/bulk_create_job_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Bulk#create_job
+    class BulkCreateJobParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute message
+      #   Bulk message definition. Supports two formats:
+      #
+      #   - V1 format: Requires `event` field (event ID or notification ID)
+      #   - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+      #     content) in addition to `event`
+      #
+      #   @return [Courier::Models::InboundBulkMessage]
+      required :message, -> { Courier::InboundBulkMessage }
+
+      # @!method initialize(message:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::BulkCreateJobParams} for more details.
+      #
+      #   @param message [Courier::Models::InboundBulkMessage] Bulk message definition. Supports two formats:
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/bulk_create_job_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Bulk#create_job
+    class BulkCreateJobResponse < Courier::Internal::Type::BaseModel
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String, api_name: :jobId
+
+      # @!method initialize(job_id:)
+      #   @param job_id [String]
+    end
+  end
+end

data/lib/courier/models/bulk_list_users_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Bulk#list_users
+    class BulkListUsersParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String
+
+      # @!attribute cursor
+      #   A unique identifier that allows for fetching the next set of users added to the
+      #   bulk job
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!method initialize(job_id:, cursor: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::BulkListUsersParams} for more details.
+      #
+      #   @param job_id [String]
+      #
+      #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of users added to the
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/bulk_list_users_response.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Bulk#list_users
+    class BulkListUsersResponse < Courier::Internal::Type::BaseModel
+      # @!attribute items
+      #
+      #   @return [Array<Courier::Models::BulkListUsersResponse::Item>]
+      required :items, -> { Courier::Internal::Type::ArrayOf[Courier::Models::BulkListUsersResponse::Item] }
+
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!method initialize(items:, paging:)
+      #   @param items [Array<Courier::Models::BulkListUsersResponse::Item>]
+      #   @param paging [Courier::Models::Paging]
+
+      class Item < Courier::Models::InboundBulkMessageUser
+        # @!attribute status
+        #
+        #   @return [Symbol, Courier::Models::BulkListUsersResponse::Item::Status]
+        required :status, enum: -> { Courier::Models::BulkListUsersResponse::Item::Status }
+
+        # @!attribute message_id
+        #
+        #   @return [String, nil]
+        optional :message_id, String, api_name: :messageId, nil?: true
+
+        # @!method initialize(status:, message_id: nil)
+        #   @param status [Symbol, Courier::Models::BulkListUsersResponse::Item::Status]
+        #   @param message_id [String, nil]
+
+        module Status
+          extend Courier::Internal::Type::Enum
+
+          PENDING = :PENDING
+          ENQUEUED = :ENQUEUED
+          ERROR = :ERROR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/bulk_retrieve_job_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Bulk#retrieve_job
+    class BulkRetrieveJobParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String
+
+      # @!method initialize(job_id:, request_options: {})
+      #   @param job_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/bulk_retrieve_job_response.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Bulk#retrieve_job
+    class BulkRetrieveJobResponse < Courier::Internal::Type::BaseModel
+      # @!attribute job
+      #
+      #   @return [Courier::Models::BulkRetrieveJobResponse::Job]
+      required :job, -> { Courier::Models::BulkRetrieveJobResponse::Job }
+
+      # @!method initialize(job:)
+      #   @param job [Courier::Models::BulkRetrieveJobResponse::Job]
+
+      # @see Courier::Models::BulkRetrieveJobResponse#job
+      class Job < Courier::Internal::Type::BaseModel
+        # @!attribute definition
+        #   Bulk message definition. Supports two formats:
+        #
+        #   - V1 format: Requires `event` field (event ID or notification ID)
+        #   - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+        #     content) in addition to `event`
+        #
+        #   @return [Courier::Models::InboundBulkMessage]
+        required :definition, -> { Courier::InboundBulkMessage }
+
+        # @!attribute enqueued
+        #
+        #   @return [Integer]
+        required :enqueued, Integer
+
+        # @!attribute failures
+        #
+        #   @return [Integer]
+        required :failures, Integer
+
+        # @!attribute received
+        #
+        #   @return [Integer]
+        required :received, Integer
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Courier::Models::BulkRetrieveJobResponse::Job::Status]
+        required :status, enum: -> { Courier::Models::BulkRetrieveJobResponse::Job::Status }
+
+        # @!method initialize(definition:, enqueued:, failures:, received:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::BulkRetrieveJobResponse::Job} for more details.
+        #
+        #   @param definition [Courier::Models::InboundBulkMessage] Bulk message definition. Supports two formats:
+        #
+        #   @param enqueued [Integer]
+        #
+        #   @param failures [Integer]
+        #
+        #   @param received [Integer]
+        #
+        #   @param status [Symbol, Courier::Models::BulkRetrieveJobResponse::Job::Status]
+
+        # @see Courier::Models::BulkRetrieveJobResponse::Job#status
+        module Status
+          extend Courier::Internal::Type::Enum
+
+          CREATED = :CREATED
+          PROCESSING = :PROCESSING
+          COMPLETED = :COMPLETED
+          ERROR = :ERROR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/bulk_run_job_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Bulk#run_job
+    class BulkRunJobParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String
+
+      # @!method initialize(job_id:, request_options: {})
+      #   @param job_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/inbound_bulk_message.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class InboundBulkMessage < Courier::Internal::Type::BaseModel
+      # @!attribute event
+      #   Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
+      #   "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
+      #   mapped to a notification.
+      #
+      #   @return [String]
+      required :event, String
+
+      # @!attribute brand
+      #
+      #   @return [String, nil]
+      optional :brand, String, nil?: true
+
+      # @!attribute content
+      #   Elemental content (optional, for V2 format). When provided, this will be used
+      #   instead of the notification associated with the `event` field.
+      #
+      #   @return [Courier::Models::ElementalContentSugar, Courier::Models::ElementalContent, nil]
+      optional :content, union: -> { Courier::InboundBulkMessage::Content }, nil?: true
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute locale
+      #
+      #   @return [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
+      optional :locale,
+               Courier::Internal::Type::HashOf[Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]],
+               nil?: true
+
+      # @!attribute override
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute template
+      #   Notification ID or template ID (optional, for V2 format). When provided, this
+      #   will be used instead of the notification associated with the `event` field.
+      #
+      #   @return [String, nil]
+      optional :template, String, nil?: true
+
+      # @!method initialize(event:, brand: nil, content: nil, data: nil, locale: nil, override: nil, template: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::InboundBulkMessage} for more details.
+      #
+      #   Bulk message definition. Supports two formats:
+      #
+      #   - V1 format: Requires `event` field (event ID or notification ID)
+      #   - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+      #     content) in addition to `event`
+      #
+      #   @param event [String] Event ID or Notification ID (required). Can be either a
+      #
+      #   @param brand [String, nil]
+      #
+      #   @param content [Courier::Models::ElementalContentSugar, Courier::Models::ElementalContent, nil] Elemental content (optional, for V2 format). When provided, this will be used
+      #
+      #   @param data [Hash{Symbol=>Object}, nil]
+      #
+      #   @param locale [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
+      #
+      #   @param override [Hash{Symbol=>Object}, nil]
+      #
+      #   @param template [String, nil] Notification ID or template ID (optional, for V2 format). When provided,
+
+      # Elemental content (optional, for V2 format). When provided, this will be used
+      # instead of the notification associated with the `event` field.
+      #
+      # @see Courier::Models::InboundBulkMessage#content
+      module Content
+        extend Courier::Internal::Type::Union
+
+        # Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
+        variant -> { Courier::ElementalContentSugar }
+
+        variant -> { Courier::ElementalContent }
+
+        # @!method self.variants
+        #   @return [Array(Courier::Models::ElementalContentSugar, Courier::Models::ElementalContent)]
+      end
+    end
+  end
+end

data/lib/courier/models/inbound_bulk_message_user.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class InboundBulkMessageUser < Courier::Internal::Type::BaseModel
+      # @!attribute data
+      #   User-specific data that will be merged with message.data
+      #
+      #   @return [Object, nil]
+      optional :data, Courier::Internal::Type::Unknown
+
+      # @!attribute preferences
+      #
+      #   @return [Courier::Models::RecipientPreferences, nil]
+      optional :preferences, -> { Courier::RecipientPreferences }, nil?: true
+
+      # @!attribute profile
+      #   User profile information. For email-based bulk jobs, `profile.email` is required
+      #   for provider routing to determine if the message can be delivered. The email
+      #   address should be provided here rather than in `to.email`.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute recipient
+      #   User ID (legacy field, use profile or to.user_id instead)
+      #
+      #   @return [String, nil]
+      optional :recipient, String, nil?: true
+
+      # @!attribute to
+      #   Optional recipient information. Note: For email provider routing, use
+      #   `profile.email` instead of `to.email`. The `to` field is primarily used for
+      #   recipient identification and data merging.
+      #
+      #   @return [Courier::Models::UserRecipient, nil]
+      optional :to, -> { Courier::UserRecipient }, nil?: true
+
+      # @!method initialize(data: nil, preferences: nil, profile: nil, recipient: nil, to: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::InboundBulkMessageUser} for more details.
+      #
+      #   @param data [Object] User-specific data that will be merged with message.data
+      #
+      #   @param preferences [Courier::Models::RecipientPreferences, nil]
+      #
+      #   @param profile [Hash{Symbol=>Object}, nil] User profile information. For email-based bulk jobs, `profile.email` is required
+      #
+      #   @param recipient [String, nil] User ID (legacy field, use profile or to.user_id instead)
+      #
+      #   @param to [Courier::Models::UserRecipient, nil] Optional recipient information. Note: For email provider routing, use
+    end
+  end
+end

data/lib/courier/models.rb

@@ -141,6 +141,16 @@ module Courier
 
   BroadcastUpdateParams = Courier::Models::BroadcastUpdateParams
 
+  BulkAddUsersParams = Courier::Models::BulkAddUsersParams
+
+  BulkCreateJobParams = Courier::Models::BulkCreateJobParams
+
+  BulkListUsersParams = Courier::Models::BulkListUsersParams
+
+  BulkRetrieveJobParams = Courier::Models::BulkRetrieveJobParams
+
+  BulkRunJobParams = Courier::Models::BulkRunJobParams
+
   CancelJourneyRequest = Courier::Models::CancelJourneyRequest
 
   CancelJourneyResponse = Courier::Models::CancelJourneyResponse
@@ -213,6 +223,10 @@ module Courier
 
   Icons = Courier::Models::Icons
 
+  InboundBulkMessage = Courier::Models::InboundBulkMessage
+
+  InboundBulkMessageUser = Courier::Models::InboundBulkMessageUser
+
   InboundTrackEventParams = Courier::Models::InboundTrackEventParams
 
   Intercom = Courier::Models::Intercom