trycourier 6.10.0 → 6.11.1

data/rbi/courier/resources/previews.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Courier
+  module Resources
+    # 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.
+    class Previews
+      # Archive a device set. This is a soft delete — the archived set is returned and
+      # no longer appears in list results. Runs already created against it keep their
+      # own copy of the device list and are unaffected. The Courier-provided default set
+      # cannot be archived and returns 409.
+      sig do
+        params(
+          device_set_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::DeviceSet)
+      end
+      def archive_device_set(
+        # The preview set to archive.
+        device_set_id,
+        request_options: {}
+      )
+      end
+
+      # Create a named, reusable set of preview devices. Every id must be one listed by
+      # `GET /previews/devices`; any other is a 422.
+      sig do
+        params(
+          device_ids: T::Array[String],
+          name: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::DeviceSet)
+      end
+      def create_device_set(
+        # The devices the set contains, by `PreviewDevice.id`. At least one is required.
+        device_ids:,
+        # Human-readable name.
+        name:,
+        request_options: {}
+      )
+      end
+
+      # List the workspace's preview sets. Archived sets are not returned.
+      sig do
+        params(request_options: Courier::RequestOptions::OrHash).returns(
+          Courier::DeviceSetListResponse
+        )
+      end
+      def list_device_sets(request_options: {})
+      end
+
+      # List the devices a preview can be rendered on. Reference data, identical for
+      # every workspace — these ids are what a device set is built from and what a run
+      # reports results for.
+      sig do
+        params(request_options: Courier::RequestOptions::OrHash).returns(
+          Courier::PreviewDeviceListResponse
+        )
+      end
+      def list_devices(request_options: {})
+      end
+
+      # Retrieve a preview set by ID. Archived sets return 404.
+      sig do
+        params(
+          device_set_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::DeviceSet)
+      end
+      def retrieve_device_set(
+        # The preview set to retrieve, identified by the `id` returned when it was
+        # created.
+        device_set_id,
+        request_options: {}
+      )
+      end
+
+      # Replace a device set. This is a full replace, not a patch — both the name and
+      # the device list are always written. The Courier-provided default set cannot be
+      # changed and returns 409.
+      sig do
+        params(
+          device_set_id: String,
+          device_ids: T::Array[String],
+          name: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::DeviceSet)
+      end
+      def update_device_set(
+        # The preview set to replace.
+        device_set_id,
+        # The devices the set contains, by `PreviewDevice.id`. At least one is required.
+        device_ids:,
+        # Human-readable name.
+        name:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/courier/client.rbs

@@ -26,6 +26,8 @@ module Courier
 
     attr_reader broadcasts: Courier::Resources::Broadcasts
 
+    attr_reader previews: Courier::Resources::Previews
+
     attr_reader bulk: Courier::Resources::Bulk
 
     attr_reader brands: Courier::Resources::Brands

data/sig/courier/models/create_device_set_request.rbs

@@ -0,0 +1,16 @@
+module Courier
+  module Models
+    type create_device_set_request =
+      { device_ids: ::Array[String], name: String }
+
+    class CreateDeviceSetRequest < Courier::Internal::Type::BaseModel
+      attr_accessor device_ids: ::Array[String]
+
+      attr_accessor name: String
+
+      def initialize: (device_ids: ::Array[String], name: String) -> void
+
+      def to_hash: -> { device_ids: ::Array[String], name: String }
+    end
+  end
+end

data/sig/courier/models/device_set.rbs

@@ -0,0 +1,47 @@
+module Courier
+  module Models
+    type device_set =
+      {
+        id: String,
+        created_at: String,
+        device_ids: ::Array[String],
+        name: String,
+        updated_at: String,
+        archived_at: String
+      }
+
+    class DeviceSet < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: String
+
+      attr_accessor device_ids: ::Array[String]
+
+      attr_accessor name: String
+
+      attr_accessor updated_at: String
+
+      attr_reader archived_at: String?
+
+      def archived_at=: (String) -> String
+
+      def initialize: (
+        id: String,
+        created_at: String,
+        device_ids: ::Array[String],
+        name: String,
+        updated_at: String,
+        ?archived_at: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: String,
+        device_ids: ::Array[String],
+        name: String,
+        updated_at: String,
+        archived_at: String
+      }
+    end
+  end
+end

data/sig/courier/models/device_set_list_response.rbs

@@ -0,0 +1,13 @@
+module Courier
+  module Models
+    type device_set_list_response = { results: ::Array[Courier::DeviceSet] }
+
+    class DeviceSetListResponse < Courier::Internal::Type::BaseModel
+      attr_accessor results: ::Array[Courier::DeviceSet]
+
+      def initialize: (results: ::Array[Courier::DeviceSet]) -> void
+
+      def to_hash: -> { results: ::Array[Courier::DeviceSet] }
+    end
+  end
+end

data/sig/courier/models/notifications/previews/create_preview_run_request.rbs

@@ -0,0 +1,54 @@
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        type create_preview_run_request =
+          {
+            data: ::Hash[Symbol, top],
+            device_ids: ::Array[String],
+            device_set_id: String,
+            locale: String,
+            template_version: String
+          }
+
+        class CreatePreviewRunRequest < Courier::Internal::Type::BaseModel
+          attr_reader data: ::Hash[Symbol, top]?
+
+          def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          attr_reader device_ids: ::Array[String]?
+
+          def device_ids=: (::Array[String]) -> ::Array[String]
+
+          attr_reader device_set_id: String?
+
+          def device_set_id=: (String) -> String
+
+          attr_reader locale: String?
+
+          def locale=: (String) -> String
+
+          attr_reader template_version: String?
+
+          def template_version=: (String) -> String
+
+          def initialize: (
+            ?data: ::Hash[Symbol, top],
+            ?device_ids: ::Array[String],
+            ?device_set_id: String,
+            ?locale: String,
+            ?template_version: String
+          ) -> void
+
+          def to_hash: -> {
+            data: ::Hash[Symbol, top],
+            device_ids: ::Array[String],
+            device_set_id: String,
+            locale: String,
+            template_version: String
+          }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/preview_result.rbs

@@ -0,0 +1,50 @@
+module Courier
+  module Models
+    module Notifications
+      class PreviewResult = Previews::PreviewResult
+
+      module Previews
+        type preview_result =
+          {
+            device_id: String,
+            screenshot_url: String?,
+            status: Courier::Models::Notifications::Previews::preview_result_status,
+            thumbnail_url: String?,
+            failure_reason: Courier::Models::Notifications::Previews::preview_result_failure_reason
+          }
+
+        class PreviewResult < Courier::Internal::Type::BaseModel
+          attr_accessor device_id: String
+
+          attr_accessor screenshot_url: String?
+
+          attr_accessor status: Courier::Models::Notifications::Previews::preview_result_status
+
+          attr_accessor thumbnail_url: String?
+
+          attr_reader failure_reason: Courier::Models::Notifications::Previews::preview_result_failure_reason?
+
+          def failure_reason=: (
+            Courier::Models::Notifications::Previews::preview_result_failure_reason
+          ) -> Courier::Models::Notifications::Previews::preview_result_failure_reason
+
+          def initialize: (
+            device_id: String,
+            screenshot_url: String?,
+            status: Courier::Models::Notifications::Previews::preview_result_status,
+            thumbnail_url: String?,
+            ?failure_reason: Courier::Models::Notifications::Previews::preview_result_failure_reason
+          ) -> void
+
+          def to_hash: -> {
+            device_id: String,
+            screenshot_url: String?,
+            status: Courier::Models::Notifications::Previews::preview_result_status,
+            thumbnail_url: String?,
+            failure_reason: Courier::Models::Notifications::Previews::preview_result_failure_reason
+          }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/preview_result_failure_reason.rbs

@@ -0,0 +1,19 @@
+module Courier
+  module Models
+    module Notifications
+      module PreviewResultFailureReason = Previews::PreviewResultFailureReason
+
+      module Previews
+        type preview_result_failure_reason = :DELIVERY_FAILED
+
+        module PreviewResultFailureReason
+          extend Courier::Internal::Type::Enum
+
+          DELIVERY_FAILED: :DELIVERY_FAILED
+
+          def self?.values: -> ::Array[Courier::Models::Notifications::Previews::preview_result_failure_reason]
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/preview_result_status.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Models
+    module Notifications
+      module PreviewResultStatus = Previews::PreviewResultStatus
+
+      module Previews
+        type preview_result_status =
+          :PENDING
+          | :PROCESSING
+          | :COMPLETED
+          | :UNSUPPORTED
+          | :TIMED_OUT
+          | :FAILED
+
+        module PreviewResultStatus
+          extend Courier::Internal::Type::Enum
+
+          PENDING: :PENDING
+          PROCESSING: :PROCESSING
+          COMPLETED: :COMPLETED
+          UNSUPPORTED: :UNSUPPORTED
+          TIMED_OUT: :TIMED_OUT
+          FAILED: :FAILED
+
+          def self?.values: -> ::Array[Courier::Models::Notifications::Previews::preview_result_status]
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/preview_run.rbs

@@ -0,0 +1,62 @@
+module Courier
+  module Models
+    module Notifications
+      class PreviewRun = Previews::PreviewRun
+
+      module Previews
+        type preview_run =
+          {
+            id: String,
+            created_at: String,
+            device_ids: ::Array[String],
+            status: Courier::Models::Notifications::Previews::preview_run_status,
+            template_id: String,
+            failure_reason: Courier::Models::Notifications::Previews::preview_run_failure_reason,
+            template_version: String
+          }
+
+        class PreviewRun < Courier::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor created_at: String
+
+          attr_accessor device_ids: ::Array[String]
+
+          attr_accessor status: Courier::Models::Notifications::Previews::preview_run_status
+
+          attr_accessor template_id: String
+
+          attr_reader failure_reason: Courier::Models::Notifications::Previews::preview_run_failure_reason?
+
+          def failure_reason=: (
+            Courier::Models::Notifications::Previews::preview_run_failure_reason
+          ) -> Courier::Models::Notifications::Previews::preview_run_failure_reason
+
+          attr_reader template_version: String?
+
+          def template_version=: (String) -> String
+
+          def initialize: (
+            id: String,
+            created_at: String,
+            device_ids: ::Array[String],
+            status: Courier::Models::Notifications::Previews::preview_run_status,
+            template_id: String,
+            ?failure_reason: Courier::Models::Notifications::Previews::preview_run_failure_reason,
+            ?template_version: String
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            created_at: String,
+            device_ids: ::Array[String],
+            status: Courier::Models::Notifications::Previews::preview_run_status,
+            template_id: String,
+            failure_reason: Courier::Models::Notifications::Previews::preview_run_failure_reason,
+            template_version: String
+          }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/preview_run_detail.rbs

@@ -0,0 +1,67 @@
+module Courier
+  module Models
+    module Notifications
+      class PreviewRunDetail = Previews::PreviewRunDetail
+
+      module Previews
+        type preview_run_detail =
+          {
+            id: String,
+            created_at: String,
+            device_ids: ::Array[String],
+            results: ::Array[Courier::Notifications::Previews::PreviewResult],
+            status: Courier::Models::Notifications::Previews::preview_run_status,
+            template_id: String,
+            failure_reason: Courier::Models::Notifications::Previews::preview_run_failure_reason,
+            template_version: String
+          }
+
+        class PreviewRunDetail < Courier::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor created_at: String
+
+          attr_accessor device_ids: ::Array[String]
+
+          attr_accessor results: ::Array[Courier::Notifications::Previews::PreviewResult]
+
+          attr_accessor status: Courier::Models::Notifications::Previews::preview_run_status
+
+          attr_accessor template_id: String
+
+          attr_reader failure_reason: Courier::Models::Notifications::Previews::preview_run_failure_reason?
+
+          def failure_reason=: (
+            Courier::Models::Notifications::Previews::preview_run_failure_reason
+          ) -> Courier::Models::Notifications::Previews::preview_run_failure_reason
+
+          attr_reader template_version: String?
+
+          def template_version=: (String) -> String
+
+          def initialize: (
+            id: String,
+            created_at: String,
+            device_ids: ::Array[String],
+            results: ::Array[Courier::Notifications::Previews::PreviewResult],
+            status: Courier::Models::Notifications::Previews::preview_run_status,
+            template_id: String,
+            ?failure_reason: Courier::Models::Notifications::Previews::preview_run_failure_reason,
+            ?template_version: String
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            created_at: String,
+            device_ids: ::Array[String],
+            results: ::Array[Courier::Notifications::Previews::PreviewResult],
+            status: Courier::Models::Notifications::Previews::preview_run_status,
+            template_id: String,
+            failure_reason: Courier::Models::Notifications::Previews::preview_run_failure_reason,
+            template_version: String
+          }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/preview_run_failure_reason.rbs

@@ -0,0 +1,28 @@
+module Courier
+  module Models
+    module Notifications
+      module PreviewRunFailureReason = Previews::PreviewRunFailureReason
+
+      module Previews
+        type preview_run_failure_reason =
+          :TEMPLATE_NOT_SUPPORTED
+          | :NO_EMAIL_CHANNEL
+          | :RENDER_FAILED
+          | :ALL_DEVICES_UNSUPPORTED
+          | :VENDOR_ERROR
+
+        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
+
+          def self?.values: -> ::Array[Courier::Models::Notifications::Previews::preview_run_failure_reason]
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/preview_run_list_response.rbs

@@ -0,0 +1,31 @@
+module Courier
+  module Models
+    module Notifications
+      class PreviewRunListResponse = Previews::PreviewRunListResponse
+
+      module Previews
+        type preview_run_list_response =
+          {
+            paging: Courier::Paging,
+            results: ::Array[Courier::Notifications::Previews::PreviewRun]
+          }
+
+        class PreviewRunListResponse < Courier::Internal::Type::BaseModel
+          attr_accessor paging: Courier::Paging
+
+          attr_accessor results: ::Array[Courier::Notifications::Previews::PreviewRun]
+
+          def initialize: (
+            paging: Courier::Paging,
+            results: ::Array[Courier::Notifications::Previews::PreviewRun]
+          ) -> void
+
+          def to_hash: -> {
+            paging: Courier::Paging,
+            results: ::Array[Courier::Notifications::Previews::PreviewRun]
+          }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/preview_run_status.rbs

@@ -0,0 +1,24 @@
+module Courier
+  module Models
+    module Notifications
+      module PreviewRunStatus = Previews::PreviewRunStatus
+
+      module Previews
+        type preview_run_status =
+          :PENDING | :RENDERED | :SUBMITTED | :COMPLETED | :FAILED
+
+        module PreviewRunStatus
+          extend Courier::Internal::Type::Enum
+
+          PENDING: :PENDING
+          RENDERED: :RENDERED
+          SUBMITTED: :SUBMITTED
+          COMPLETED: :COMPLETED
+          FAILED: :FAILED
+
+          def self?.values: -> ::Array[Courier::Models::Notifications::Previews::preview_run_status]
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/run_create_params.rbs

@@ -0,0 +1,46 @@
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        type run_create_params =
+          {
+            id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String
+          }
+          & Courier::Internal::Type::request_parameters
+
+        class RunCreateParams < Courier::Models::Notifications::Previews::CreatePreviewRunRequest
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          def id: -> String
+
+          def id=: (String _) -> String
+
+          def idempotency_key: -> String?
+
+          def idempotency_key=: (String _) -> String
+
+          def x_idempotency_expiration: -> String?
+
+          def x_idempotency_expiration=: (String _) -> String
+
+          def initialize: (
+            id: String,
+            ?idempotency_key: String,
+            ?x_idempotency_expiration: String,
+            ?request_options: Courier::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/run_list_params.rbs

@@ -0,0 +1,38 @@
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        type run_list_params =
+          { id: String, cursor: String?, limit: Integer }
+          & Courier::Internal::Type::request_parameters
+
+        class RunListParams < Courier::Internal::Type::BaseModel
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          attr_accessor id: String
+
+          attr_accessor cursor: String?
+
+          attr_reader limit: Integer?
+
+          def limit=: (Integer) -> Integer
+
+          def initialize: (
+            id: String,
+            ?cursor: String?,
+            ?limit: Integer,
+            ?request_options: Courier::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            cursor: String?,
+            limit: Integer,
+            request_options: Courier::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/notifications/previews/run_retrieve_params.rbs

@@ -0,0 +1,32 @@
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        type run_retrieve_params =
+          { id: String, preview_run_id: String }
+          & Courier::Internal::Type::request_parameters
+
+        class RunRetrieveParams < Courier::Internal::Type::BaseModel
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          attr_accessor id: String
+
+          attr_accessor preview_run_id: String
+
+          def initialize: (
+            id: String,
+            preview_run_id: String,
+            ?request_options: Courier::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            preview_run_id: String,
+            request_options: Courier::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end