trycourier 6.9.0 → 6.11.0

data/rbi/courier/models/notifications/previews/preview_run_list_response.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Notifications
+      PreviewRunListResponse = Previews::PreviewRunListResponse
+
+      module Previews
+        class PreviewRunListResponse < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::Notifications::Previews::PreviewRunListResponse,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Courier::Paging) }
+          attr_reader :paging
+
+          sig { params(paging: Courier::Paging::OrHash).void }
+          attr_writer :paging
+
+          sig do
+            returns(T::Array[Courier::Notifications::Previews::PreviewRun])
+          end
+          attr_accessor :results
+
+          # Paginated list of preview runs, newest first.
+          sig do
+            params(
+              paging: Courier::Paging::OrHash,
+              results:
+                T::Array[Courier::Notifications::Previews::PreviewRun::OrHash]
+            ).returns(T.attached_class)
+          end
+          def self.new(paging:, results:)
+          end
+
+          sig do
+            override.returns(
+              {
+                paging: Courier::Paging,
+                results: T::Array[Courier::Notifications::Previews::PreviewRun]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notifications/previews/preview_run_status.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Notifications
+      PreviewRunStatus = Previews::PreviewRunStatus
+
+      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
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Courier::Notifications::Previews::PreviewRunStatus)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :PENDING,
+              Courier::Notifications::Previews::PreviewRunStatus::TaggedSymbol
+            )
+          RENDERED =
+            T.let(
+              :RENDERED,
+              Courier::Notifications::Previews::PreviewRunStatus::TaggedSymbol
+            )
+          SUBMITTED =
+            T.let(
+              :SUBMITTED,
+              Courier::Notifications::Previews::PreviewRunStatus::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :COMPLETED,
+              Courier::Notifications::Previews::PreviewRunStatus::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :FAILED,
+              Courier::Notifications::Previews::PreviewRunStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::Notifications::Previews::PreviewRunStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notifications/previews/run_create_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        class RunCreateParams < Courier::Models::Notifications::Previews::CreatePreviewRunRequest
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::Notifications::Previews::RunCreateParams,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :idempotency_key
+
+          sig { params(idempotency_key: String).void }
+          attr_writer :idempotency_key
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :x_idempotency_expiration
+
+          sig { params(x_idempotency_expiration: String).void }
+          attr_writer :x_idempotency_expiration
+
+          sig do
+            params(
+              id: String,
+              idempotency_key: String,
+              x_idempotency_expiration: String,
+              request_options: Courier::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            idempotency_key: nil,
+            x_idempotency_expiration: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                idempotency_key: String,
+                x_idempotency_expiration: String,
+                request_options: Courier::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notifications/previews/run_list_params.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        class RunListParams < Courier::Internal::Type::BaseModel
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::Notifications::Previews::RunListParams,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Opaque pagination cursor from a previous response. Omit for the first page.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :cursor
+
+          # Maximum number of results per page.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :limit
+
+          sig { params(limit: Integer).void }
+          attr_writer :limit
+
+          sig do
+            params(
+              id: String,
+              cursor: T.nilable(String),
+              limit: Integer,
+              request_options: Courier::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            # Opaque pagination cursor from a previous response. Omit for the first page.
+            cursor: nil,
+            # Maximum number of results per page.
+            limit: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                cursor: T.nilable(String),
+                limit: Integer,
+                request_options: Courier::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notifications/previews/run_retrieve_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        class RunRetrieveParams < Courier::Internal::Type::BaseModel
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::Notifications::Previews::RunRetrieveParams,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :preview_run_id
+
+          sig do
+            params(
+              id: String,
+              preview_run_id: String,
+              request_options: Courier::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(id:, preview_run_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                preview_run_id: String,
+                request_options: Courier::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_change_log_entry.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceChangeLogEntry < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::PreferenceChangeLogEntry, Courier::Internal::AnyHash)
+        end
+
+      # Unique identifier for this change.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The channels chosen for this topic, present only when has_custom_routing is
+      # true. Empty otherwise.
+      sig { returns(T::Array[Courier::ChannelClassification::TaggedSymbol]) }
+      attr_accessor :custom_routing
+
+      # Whether specific delivery channels were chosen for this topic rather than the
+      # topic's default routing.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_custom_routing
+
+      # The subscription status the change set.
+      sig { returns(Courier::PreferenceStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # When the change was made, as an ISO-8601 date-time in UTC.
+      sig { returns(String) }
+      attr_accessor :timestamp
+
+      # The subscription topic the change applies to.
+      sig { returns(String) }
+      attr_accessor :topic_id
+
+      # The display name of that topic when the change was made.
+      sig { returns(String) }
+      attr_accessor :topic_name
+
+      # The user whose preference changed.
+      sig { returns(String) }
+      attr_accessor :user_id
+
+      # The value before this change, where it was recorded.
+      sig { returns(T.nilable(Courier::PreferenceChangeLogValue)) }
+      attr_reader :previous
+
+      sig { params(previous: Courier::PreferenceChangeLogValue::OrHash).void }
+      attr_writer :previous
+
+      # The tenant context the change was made in. Absent when the user set the
+      # preference outside any tenant.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
+
+      sig do
+        params(
+          id: String,
+          custom_routing: T::Array[Courier::ChannelClassification::OrSymbol],
+          has_custom_routing: T::Boolean,
+          status: Courier::PreferenceStatus::OrSymbol,
+          timestamp: String,
+          topic_id: String,
+          topic_name: String,
+          user_id: String,
+          previous: Courier::PreferenceChangeLogValue::OrHash,
+          tenant_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for this change.
+        id:,
+        # The channels chosen for this topic, present only when has_custom_routing is
+        # true. Empty otherwise.
+        custom_routing:,
+        # Whether specific delivery channels were chosen for this topic rather than the
+        # topic's default routing.
+        has_custom_routing:,
+        # The subscription status the change set.
+        status:,
+        # When the change was made, as an ISO-8601 date-time in UTC.
+        timestamp:,
+        # The subscription topic the change applies to.
+        topic_id:,
+        # The display name of that topic when the change was made.
+        topic_name:,
+        # The user whose preference changed.
+        user_id:,
+        # The value before this change, where it was recorded.
+        previous: nil,
+        # The tenant context the change was made in. Absent when the user set the
+        # preference outside any tenant.
+        tenant_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            custom_routing:
+              T::Array[Courier::ChannelClassification::TaggedSymbol],
+            has_custom_routing: T::Boolean,
+            status: Courier::PreferenceStatus::TaggedSymbol,
+            timestamp: String,
+            topic_id: String,
+            topic_name: String,
+            user_id: String,
+            previous: Courier::PreferenceChangeLogValue,
+            tenant_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_change_log_value.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceChangeLogValue < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::PreferenceChangeLogValue, Courier::Internal::AnyHash)
+        end
+
+      # The channels chosen before the change.
+      sig { returns(T::Array[Courier::ChannelClassification::TaggedSymbol]) }
+      attr_accessor :custom_routing
+
+      # Whether custom routing was in effect before the change.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_custom_routing
+
+      # The subscription status before the change.
+      sig { returns(Courier::PreferenceStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      sig do
+        params(
+          custom_routing: T::Array[Courier::ChannelClassification::OrSymbol],
+          has_custom_routing: T::Boolean,
+          status: Courier::PreferenceStatus::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The channels chosen before the change.
+        custom_routing:,
+        # Whether custom routing was in effect before the change.
+        has_custom_routing:,
+        # The subscription status before the change.
+        status:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            custom_routing:
+              T::Array[Courier::ChannelClassification::TaggedSymbol],
+            has_custom_routing: T::Boolean,
+            status: Courier::PreferenceStatus::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_logs_list_response.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceLogsListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::PreferenceLogsListResponse, Courier::Internal::AnyHash)
+        end
+
+      # One entry per preference change, newest first.
+      sig { returns(T::Array[Courier::PreferenceChangeLogEntry]) }
+      attr_accessor :items
+
+      sig { returns(Courier::Paging) }
+      attr_reader :paging
+
+      sig { params(paging: Courier::Paging::OrHash).void }
+      attr_writer :paging
+
+      sig do
+        params(
+          items: T::Array[Courier::PreferenceChangeLogEntry::OrHash],
+          paging: Courier::Paging::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # One entry per preference change, newest first.
+        items:,
+        paging:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            items: T::Array[Courier::PreferenceChangeLogEntry],
+            paging: Courier::Paging
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preview_archive_device_set_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreviewArchiveDeviceSetParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreviewArchiveDeviceSetParams,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :device_set_id
+
+      sig do
+        params(
+          device_set_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(device_set_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { device_set_id: String, request_options: Courier::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preview_create_device_set_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreviewCreateDeviceSetParams < Courier::Models::CreateDeviceSetRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreviewCreateDeviceSetParams,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Courier::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end