trycourier 6.10.0 → 6.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bab9f203d342c48548c1f0e174e23733585494b0b3b8369d2ccedab9fbbaf34
-  data.tar.gz: 86a57ea48f82c3e4f7da5536bd4c2a3b80c07dfb9178ccdc8d36da6ef74c74ad
+  metadata.gz: 8355e7fd1f1c9e1ed9f2aafab8f6dbce8c8081f7e9b62ff4f43f7a218d8eb9d5
+  data.tar.gz: d678747f0d3d4b4107f5be81fb7dc138f7711a88eed4f37591b8e938743cf2a4
 SHA512:
-  metadata.gz: 94fb163ff7c2e6cd81eb20e028fbbf5a0cedc2f3eb299864a3c7f19c6c2d838f329dcf329b02438318bc1ab20cba5d56604377f2e359d54d298c620ac0384340
-  data.tar.gz: e7f0b03ecf872ddf5bc0b38a28fbd0c1bd169241e31c9729c623f1b1e7f42b58155d1ec30e3ddf60ae93aa9fb9a40337403b7f7bc581f0852a3f11cd844b5d54
+  metadata.gz: c190958991c41ffe7905492408eac10b80f5e237eec79efa599489176942a068be1b4de41d28ab04cdd32637d4fc5513a3bd1c9f86f1f7118295706b93c1fd89
+  data.tar.gz: 3f561d73086f92e6452f3d8eb632aa60f2c1158952e2aab5008440864c5cf7f82a2f188fa4218c9ae4bc071aa6663b732e42fc90d5e549b6b27944b076237a93

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [6.11.1](https://github.com/trycourier/courier-ruby/compare/v6.11.0...v6.11.1) (2026-09-24)
+
+
+### Documentation
+
+* **api:** use OpenAPI 3.0 example on the preview schemas ([#167](https://github.com/trycourier/courier-ruby/issues/167)) ([1dc8ecf](https://github.com/trycourier/courier-ruby/commit/1dc8ecf475c40ea3147b52e79204b516795a092d))
+
+## [6.11.0](https://github.com/trycourier/courier-ruby/compare/v6.10.0...v6.11.0) (2026-09-24)
+
+
+### Features
+
+* **api:** cross-client previews endpoints ([#165](https://github.com/trycourier/courier-ruby/issues/165)) ([0701a83](https://github.com/trycourier/courier-ruby/commit/0701a833e9b5d80ea39c8f701ae2d66b8453c165))
+
 ## [6.10.0](https://github.com/trycourier/courier-ruby/compare/v6.9.0...v6.10.0) (2026-09-24)
 
 

data/README.md

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

data/lib/courier/client.rb

@@ -58,6 +58,11 @@ module Courier
     # @return [Courier::Resources::Broadcasts]
     attr_reader :broadcasts
 
+    # Render a template's email content on real email clients and read back the
+    # screenshots, so you can check how it looks before you send it.
+    # @return [Courier::Resources::Previews]
+    attr_reader :previews
+
     # @return [Courier::Resources::Bulk]
     attr_reader :bulk
 
@@ -190,6 +195,7 @@ module Courier
       @automations = Courier::Resources::Automations.new(client: self)
       @journeys = Courier::Resources::Journeys.new(client: self)
       @broadcasts = Courier::Resources::Broadcasts.new(client: self)
+      @previews = Courier::Resources::Previews.new(client: self)
       @bulk = Courier::Resources::Bulk.new(client: self)
       @brands = Courier::Resources::Brands.new(client: self)
       @digests = Courier::Resources::Digests.new(client: self)

data/lib/courier/models/create_device_set_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class CreateDeviceSetRequest < Courier::Internal::Type::BaseModel
+      # @!attribute device_ids
+      #   The devices the set contains, by `PreviewDevice.id`. At least one is required.
+      #
+      #   @return [Array<String>]
+      required :device_ids, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(device_ids:, name:)
+      #   Request body for creating or replacing a device set. A full replace, not a patch
+      #   — both fields are always written.
+      #
+      #   @param device_ids [Array<String>] The devices the set contains, by `PreviewDevice.id`. At least one is required.
+      #
+      #   @param name [String] Human-readable name.
+    end
+  end
+end

data/lib/courier/models/device_set.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Previews#archive_device_set
+    class DeviceSet < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the device set.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   ISO-8601 timestamp of when the set was created.
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute device_ids
+      #   The devices in this set, by `PreviewDevice.id`.
+      #
+      #   @return [Array<String>]
+      required :device_ids, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute updated_at
+      #   ISO-8601 timestamp of when the set was last written.
+      #
+      #   @return [String]
+      required :updated_at, String
+
+      # @!attribute archived_at
+      #   ISO-8601 timestamp of when the set was archived. Present only on the archive
+      #   response, which is the one place the state is observable.
+      #
+      #   @return [String, nil]
+      optional :archived_at, String
+
+      # @!method initialize(id:, created_at:, device_ids:, name:, updated_at:, archived_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::DeviceSet} for more details.
+      #
+      #   A named, reusable list of preview devices.
+      #
+      #   @param id [String] Unique identifier for the device set.
+      #
+      #   @param created_at [String] ISO-8601 timestamp of when the set was created.
+      #
+      #   @param device_ids [Array<String>] The devices in this set, by `PreviewDevice.id`.
+      #
+      #   @param name [String] Human-readable name.
+      #
+      #   @param updated_at [String] ISO-8601 timestamp of when the set was last written.
+      #
+      #   @param archived_at [String] ISO-8601 timestamp of when the set was archived. Present only on the archive res
+    end
+  end
+end

data/lib/courier/models/device_set_list_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Previews#list_device_sets
+    class DeviceSetListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::DeviceSet>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::DeviceSet] }
+
+      # @!method initialize(results:)
+      #   The workspace's active device sets. Not paginated.
+      #
+      #   @param results [Array<Courier::Models::DeviceSet>]
+    end
+  end
+end

data/lib/courier/models/notifications/previews/create_preview_run_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        class CreatePreviewRunRequest < Courier::Internal::Type::BaseModel
+          # @!attribute data
+          #   Template variables to render with, the same shape as the `data` object on a
+          #   send.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+          # @!attribute device_ids
+          #   The devices to render on, by `PreviewDevice.id`, for a one-off run. Mutually
+          #   exclusive with `device_set_id`.
+          #
+          #   @return [Array<String>, nil]
+          optional :device_ids, Courier::Internal::Type::ArrayOf[String]
+
+          # @!attribute device_set_id
+          #   A saved device set naming the devices to render on. Mutually exclusive with
+          #   `device_ids`.
+          #
+          #   @return [String, nil]
+          optional :device_set_id, String
+
+          # @!attribute locale
+          #   Render the template's content for this locale, e.g. "fr-FR".
+          #
+          #   @return [String, nil]
+          optional :locale, String
+
+          # @!attribute template_version
+          #   Which version of the template to render. Omit for the latest saved draft, which
+          #   always exists and is what the editor shows. `published` renders the live
+          #   version; a zero-padded `v002` renders that specific publish. Versions are
+          #   1-based, so `v000` is not a version, and the unpadded `v2` is rejected — that
+          #   spelling belongs to journeys' AutomationVersionId, a different scheme in which
+          #   `v0` means published.
+          #
+          #   @return [String, nil]
+          optional :template_version, String
+
+          # @!method initialize(data: nil, device_ids: nil, device_set_id: nil, locale: nil, template_version: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Courier::Models::Notifications::Previews::CreatePreviewRunRequest} for more
+          #   details.
+          #
+          #   Request body for creating a preview run of the template in the path. Provide
+          #   exactly one of `device_set_id` or `device_ids`. The template is the path's
+          #   `{id}`; a `template_id` here is an unknown key and a 400.
+          #
+          #   @param data [Hash{Symbol=>Object}] Template variables to render with, the same shape as the `data` object on a send
+          #
+          #   @param device_ids [Array<String>] The devices to render on, by `PreviewDevice.id`, for a one-off run. Mutually exc
+          #
+          #   @param device_set_id [String] A saved device set naming the devices to render on. Mutually exclusive with `dev
+          #
+          #   @param locale [String] Render the template's content for this locale, e.g. "fr-FR".
+          #
+          #   @param template_version [String] Which version of the template to render. Omit for the latest saved draft, which
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/notifications/previews/preview_result.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        class PreviewResult < Courier::Internal::Type::BaseModel
+          # @!attribute device_id
+          #   The device this result is for, by `PreviewDevice.id`.
+          #
+          #   @return [String]
+          required :device_id, String
+
+          # @!attribute screenshot_url
+          #   Short-lived signed URL for the full-sized image. Null until the screenshot
+          #   exists. Re-signed on every read, so fetch it rather than storing it.
+          #
+          #   @return [String, nil]
+          required :screenshot_url, String, nil?: true
+
+          # @!attribute status
+          #   One device's outcome. `COMPLETED` means the screenshot exists and its URLs are
+          #   populated. `UNSUPPORTED`, `TIMED_OUT` and `FAILED` are all terminal, and none
+          #   stands in for another — `UNSUPPORTED` means the device was retired at the
+          #   vendor, `TIMED_OUT` means it did not report in time.
+          #
+          #   @return [Symbol, Courier::Models::Notifications::Previews::PreviewResultStatus]
+          required :status, enum: -> { Courier::Notifications::Previews::PreviewResultStatus }
+
+          # @!attribute thumbnail_url
+          #   Short-lived signed URL for the grid-sized image. Null until the screenshot
+          #   exists. Re-signed on every read, so fetch it rather than storing it.
+          #
+          #   @return [String, nil]
+          required :thumbnail_url, String, nil?: true
+
+          # @!attribute failure_reason
+          #   Why one device's render failed, when its `status` is `FAILED` and the cause has
+          #   a public name. `DELIVERY_FAILED` means the rendering service could not deliver
+          #   the message to its own capture mailbox — infrastructure, not anything wrong with
+          #   the template.
+          #
+          #   @return [Symbol, Courier::Models::Notifications::Previews::PreviewResultFailureReason, nil]
+          optional :failure_reason, enum: -> { Courier::Notifications::Previews::PreviewResultFailureReason }
+
+          # @!method initialize(device_id:, screenshot_url:, status:, thumbnail_url:, failure_reason: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Courier::Models::Notifications::Previews::PreviewResult} for more details.
+          #
+          #   One device's result within a preview run.
+          #
+          #   @param device_id [String] The device this result is for, by `PreviewDevice.id`.
+          #
+          #   @param screenshot_url [String, nil] Short-lived signed URL for the full-sized image. Null until the screenshot exist
+          #
+          #   @param status [Symbol, Courier::Models::Notifications::Previews::PreviewResultStatus] One device's outcome. `COMPLETED` means the screenshot exists and its URLs are p
+          #
+          #   @param thumbnail_url [String, nil] Short-lived signed URL for the grid-sized image. Null until the screenshot exist
+          #
+          #   @param failure_reason [Symbol, Courier::Models::Notifications::Previews::PreviewResultFailureReason] Why one device's render failed, when its `status` is `FAILED` and the cause has
+        end
+      end
+
+      PreviewResult = Previews::PreviewResult
+    end
+  end
+end

data/lib/courier/models/notifications/previews/preview_result_failure_reason.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # Why one device's render failed, when its `status` is `FAILED` and the cause has
+        # a public name. `DELIVERY_FAILED` means the rendering service could not deliver
+        # the message to its own capture mailbox — infrastructure, not anything wrong with
+        # the template.
+        module PreviewResultFailureReason
+          extend Courier::Internal::Type::Enum
+
+          DELIVERY_FAILED = :DELIVERY_FAILED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      PreviewResultFailureReason = Previews::PreviewResultFailureReason
+    end
+  end
+end

data/lib/courier/models/notifications/previews/preview_result_status.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # One device's outcome. `COMPLETED` means the screenshot exists and its URLs are
+        # populated. `UNSUPPORTED`, `TIMED_OUT` and `FAILED` are all terminal, and none
+        # stands in for another — `UNSUPPORTED` means the device was retired at the
+        # vendor, `TIMED_OUT` means it did not report in time.
+        module PreviewResultStatus
+          extend Courier::Internal::Type::Enum
+
+          PENDING = :PENDING
+          PROCESSING = :PROCESSING
+          COMPLETED = :COMPLETED
+          UNSUPPORTED = :UNSUPPORTED
+          TIMED_OUT = :TIMED_OUT
+          FAILED = :FAILED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      PreviewResultStatus = Previews::PreviewResultStatus
+    end
+  end
+end

data/lib/courier/models/notifications/previews/preview_run.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # @see Courier::Resources::Notifications::Previews::Runs#create
+        class PreviewRun < Courier::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the preview run.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   ISO-8601 timestamp of when the run was created.
+          #
+          #   @return [String]
+          required :created_at, String
+
+          # @!attribute device_ids
+          #   The devices this run was submitted for, snapshotted when the run was created.
+          #
+          #   @return [Array<String>]
+          required :device_ids, Courier::Internal::Type::ArrayOf[String]
+
+          # @!attribute status
+          #   Where the run itself has got to. `PENDING` and `RENDERED` mean Courier is still
+          #   preparing the email, `SUBMITTED` means it is with the rendering service, and
+          #   `COMPLETED` means every device has reported. `FAILED` is the run as a whole
+          #   failing — an individual device failing never fails the run.
+          #
+          #   @return [Symbol, Courier::Models::Notifications::Previews::PreviewRunStatus]
+          required :status, enum: -> { Courier::Notifications::Previews::PreviewRunStatus }
+
+          # @!attribute template_id
+          #   The template that was rendered.
+          #
+          #   @return [String]
+          required :template_id, String
+
+          # @!attribute failure_reason
+          #   Why the run failed, when `status` is `FAILED`. `NO_EMAIL_CHANNEL` and
+          #   `TEMPLATE_NOT_SUPPORTED` mean there was nothing to render;
+          #   `ALL_DEVICES_UNSUPPORTED` means every requested device has been retired and the
+          #   request can be fixed by choosing others.
+          #
+          #   @return [Symbol, Courier::Models::Notifications::Previews::PreviewRunFailureReason, nil]
+          optional :failure_reason, enum: -> { Courier::Notifications::Previews::PreviewRunFailureReason }
+
+          # @!attribute template_version
+          #   The version of the template that was rendered — `draft`, or a zero-padded
+          #   published version such as `v002`. Absent until the render settles.
+          #
+          #   @return [String, nil]
+          optional :template_version, String
+
+          # @!method initialize(id:, created_at:, device_ids:, status:, template_id:, failure_reason: nil, template_version: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Courier::Models::Notifications::Previews::PreviewRun} for more details.
+          #
+          #   One render of a template across a set of devices. Billable.
+          #
+          #   @param id [String] Unique identifier for the preview run.
+          #
+          #   @param created_at [String] ISO-8601 timestamp of when the run was created.
+          #
+          #   @param device_ids [Array<String>] The devices this run was submitted for, snapshotted when the run was created.
+          #
+          #   @param status [Symbol, Courier::Models::Notifications::Previews::PreviewRunStatus] Where the run itself has got to. `PENDING` and `RENDERED` mean Courier is still
+          #
+          #   @param template_id [String] The template that was rendered.
+          #
+          #   @param failure_reason [Symbol, Courier::Models::Notifications::Previews::PreviewRunFailureReason] Why the run failed, when `status` is `FAILED`. `NO_EMAIL_CHANNEL` and
+          #   `TEMPLATE\_
+          #
+          #   @param template_version [String] The version of the template that was rendered — `draft`, or a zero-padded publis
+        end
+      end
+
+      PreviewRun = Previews::PreviewRun
+    end
+  end
+end

data/lib/courier/models/notifications/previews/preview_run_detail.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # @see Courier::Resources::Notifications::Previews::Runs#retrieve
+        class PreviewRunDetail < Courier::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the preview run.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   ISO-8601 timestamp of when the run was created.
+          #
+          #   @return [String]
+          required :created_at, String
+
+          # @!attribute device_ids
+          #   The devices this run was submitted for, snapshotted when the run was created.
+          #
+          #   @return [Array<String>]
+          required :device_ids, Courier::Internal::Type::ArrayOf[String]
+
+          # @!attribute results
+          #   One entry per device in `device_ids`.
+          #
+          #   @return [Array<Courier::Models::Notifications::Previews::PreviewResult>]
+          required :results,
+                   -> { Courier::Internal::Type::ArrayOf[Courier::Notifications::Previews::PreviewResult] }
+
+          # @!attribute status
+          #   Where the run itself has got to. `PENDING` and `RENDERED` mean Courier is still
+          #   preparing the email, `SUBMITTED` means it is with the rendering service, and
+          #   `COMPLETED` means every device has reported. `FAILED` is the run as a whole
+          #   failing — an individual device failing never fails the run.
+          #
+          #   @return [Symbol, Courier::Models::Notifications::Previews::PreviewRunStatus]
+          required :status, enum: -> { Courier::Notifications::Previews::PreviewRunStatus }
+
+          # @!attribute template_id
+          #   The template that was rendered.
+          #
+          #   @return [String]
+          required :template_id, String
+
+          # @!attribute failure_reason
+          #   Why the run failed, when `status` is `FAILED`. `NO_EMAIL_CHANNEL` and
+          #   `TEMPLATE_NOT_SUPPORTED` mean there was nothing to render;
+          #   `ALL_DEVICES_UNSUPPORTED` means every requested device has been retired and the
+          #   request can be fixed by choosing others.
+          #
+          #   @return [Symbol, Courier::Models::Notifications::Previews::PreviewRunFailureReason, nil]
+          optional :failure_reason, enum: -> { Courier::Notifications::Previews::PreviewRunFailureReason }
+
+          # @!attribute template_version
+          #   The version of the template that was rendered — `draft`, or a zero-padded
+          #   published version such as `v002`. Absent until the render settles.
+          #
+          #   @return [String, nil]
+          optional :template_version, String
+
+          # @!method initialize(id:, created_at:, device_ids:, results:, status:, template_id:, failure_reason: nil, template_version: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Courier::Models::Notifications::Previews::PreviewRunDetail} for more details.
+          #
+          #   A preview run together with its per-device results.
+          #
+          #   @param id [String] Unique identifier for the preview run.
+          #
+          #   @param created_at [String] ISO-8601 timestamp of when the run was created.
+          #
+          #   @param device_ids [Array<String>] The devices this run was submitted for, snapshotted when the run was created.
+          #
+          #   @param results [Array<Courier::Models::Notifications::Previews::PreviewResult>] One entry per device in `device_ids`.
+          #
+          #   @param status [Symbol, Courier::Models::Notifications::Previews::PreviewRunStatus] Where the run itself has got to. `PENDING` and `RENDERED` mean Courier is still
+          #
+          #   @param template_id [String] The template that was rendered.
+          #
+          #   @param failure_reason [Symbol, Courier::Models::Notifications::Previews::PreviewRunFailureReason] Why the run failed, when `status` is `FAILED`. `NO_EMAIL_CHANNEL` and
+          #   `TEMPLATE\_
+          #
+          #   @param template_version [String] The version of the template that was rendered — `draft`, or a zero-padded publis
+        end
+      end
+
+      PreviewRunDetail = Previews::PreviewRunDetail
+    end
+  end
+end

data/lib/courier/models/notifications/previews/preview_run_failure_reason.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # Why the run failed, when `status` is `FAILED`. `NO_EMAIL_CHANNEL` and
+        # `TEMPLATE_NOT_SUPPORTED` mean there was nothing to render;
+        # `ALL_DEVICES_UNSUPPORTED` means every requested device has been retired and the
+        # request can be fixed by choosing others.
+        module PreviewRunFailureReason
+          extend Courier::Internal::Type::Enum
+
+          TEMPLATE_NOT_SUPPORTED = :TEMPLATE_NOT_SUPPORTED
+          NO_EMAIL_CHANNEL = :NO_EMAIL_CHANNEL
+          RENDER_FAILED = :RENDER_FAILED
+          ALL_DEVICES_UNSUPPORTED = :ALL_DEVICES_UNSUPPORTED
+          VENDOR_ERROR = :VENDOR_ERROR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      PreviewRunFailureReason = Previews::PreviewRunFailureReason
+    end
+  end
+end

data/lib/courier/models/notifications/previews/preview_run_list_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # @see Courier::Resources::Notifications::Previews::Runs#list
+        class PreviewRunListResponse < Courier::Internal::Type::BaseModel
+          # @!attribute paging
+          #
+          #   @return [Courier::Models::Paging]
+          required :paging, -> { Courier::Paging }
+
+          # @!attribute results
+          #
+          #   @return [Array<Courier::Models::Notifications::Previews::PreviewRun>]
+          required :results, -> { Courier::Internal::Type::ArrayOf[Courier::Notifications::Previews::PreviewRun] }
+
+          # @!method initialize(paging:, results:)
+          #   Paginated list of preview runs, newest first.
+          #
+          #   @param paging [Courier::Models::Paging]
+          #   @param results [Array<Courier::Models::Notifications::Previews::PreviewRun>]
+        end
+      end
+
+      PreviewRunListResponse = Previews::PreviewRunListResponse
+    end
+  end
+end

data/lib/courier/models/notifications/previews/preview_run_status.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # Where the run itself has got to. `PENDING` and `RENDERED` mean Courier is still
+        # preparing the email, `SUBMITTED` means it is with the rendering service, and
+        # `COMPLETED` means every device has reported. `FAILED` is the run as a whole
+        # failing — an individual device failing never fails the run.
+        module PreviewRunStatus
+          extend Courier::Internal::Type::Enum
+
+          PENDING = :PENDING
+          RENDERED = :RENDERED
+          SUBMITTED = :SUBMITTED
+          COMPLETED = :COMPLETED
+          FAILED = :FAILED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      PreviewRunStatus = Previews::PreviewRunStatus
+    end
+  end
+end

data/lib/courier/models/notifications/previews/run_create_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # @see Courier::Resources::Notifications::Previews::Runs#create
+        class RunCreateParams < Courier::Models::Notifications::Previews::CreatePreviewRunRequest
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!attribute x_idempotency_expiration
+          #
+          #   @return [String, nil]
+          optional :x_idempotency_expiration, String
+
+          # @!method initialize(id:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
+          #   @param id [String]
+          #   @param idempotency_key [String]
+          #   @param x_idempotency_expiration [String]
+          #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end