trycourier 6.9.0 → 6.11.0

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

data/sig/courier/models/preference_change_log_entry.rbs

@@ -0,0 +1,71 @@
+module Courier
+  module Models
+    type preference_change_log_entry =
+      {
+        id: String,
+        custom_routing: ::Array[Courier::Models::channel_classification],
+        has_custom_routing: bool,
+        status: Courier::Models::preference_status,
+        timestamp: String,
+        topic_id: String,
+        topic_name: String,
+        user_id: String,
+        previous: Courier::PreferenceChangeLogValue,
+        tenant_id: String
+      }
+
+    class PreferenceChangeLogEntry < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor custom_routing: ::Array[Courier::Models::channel_classification]
+
+      attr_accessor has_custom_routing: bool
+
+      attr_accessor status: Courier::Models::preference_status
+
+      attr_accessor timestamp: String
+
+      attr_accessor topic_id: String
+
+      attr_accessor topic_name: String
+
+      attr_accessor user_id: String
+
+      attr_reader previous: Courier::PreferenceChangeLogValue?
+
+      def previous=: (
+        Courier::PreferenceChangeLogValue
+      ) -> Courier::PreferenceChangeLogValue
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
+
+      def initialize: (
+        id: String,
+        custom_routing: ::Array[Courier::Models::channel_classification],
+        has_custom_routing: bool,
+        status: Courier::Models::preference_status,
+        timestamp: String,
+        topic_id: String,
+        topic_name: String,
+        user_id: String,
+        ?previous: Courier::PreferenceChangeLogValue,
+        ?tenant_id: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        custom_routing: ::Array[Courier::Models::channel_classification],
+        has_custom_routing: bool,
+        status: Courier::Models::preference_status,
+        timestamp: String,
+        topic_id: String,
+        topic_name: String,
+        user_id: String,
+        previous: Courier::PreferenceChangeLogValue,
+        tenant_id: String
+      }
+    end
+  end
+end

data/sig/courier/models/preference_change_log_value.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Models
+    type preference_change_log_value =
+      {
+        custom_routing: ::Array[Courier::Models::channel_classification],
+        has_custom_routing: bool,
+        status: Courier::Models::preference_status
+      }
+
+    class PreferenceChangeLogValue < Courier::Internal::Type::BaseModel
+      attr_accessor custom_routing: ::Array[Courier::Models::channel_classification]
+
+      attr_accessor has_custom_routing: bool
+
+      attr_accessor status: Courier::Models::preference_status
+
+      def initialize: (
+        custom_routing: ::Array[Courier::Models::channel_classification],
+        has_custom_routing: bool,
+        status: Courier::Models::preference_status
+      ) -> void
+
+      def to_hash: -> {
+        custom_routing: ::Array[Courier::Models::channel_classification],
+        has_custom_routing: bool,
+        status: Courier::Models::preference_status
+      }
+    end
+  end
+end

data/sig/courier/models/preference_logs_list_response.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type preference_logs_list_response =
+      {
+        items: ::Array[Courier::PreferenceChangeLogEntry],
+        paging: Courier::Paging
+      }
+
+    class PreferenceLogsListResponse < Courier::Internal::Type::BaseModel
+      attr_accessor items: ::Array[Courier::PreferenceChangeLogEntry]
+
+      attr_accessor paging: Courier::Paging
+
+      def initialize: (
+        items: ::Array[Courier::PreferenceChangeLogEntry],
+        paging: Courier::Paging
+      ) -> void
+
+      def to_hash: -> {
+        items: ::Array[Courier::PreferenceChangeLogEntry],
+        paging: Courier::Paging
+      }
+    end
+  end
+end

data/sig/courier/models/preview_archive_device_set_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type preview_archive_device_set_params =
+      { device_set_id: String } & Courier::Internal::Type::request_parameters
+
+    class PreviewArchiveDeviceSetParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor device_set_id: String
+
+      def initialize: (
+        device_set_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        device_set_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/preview_create_device_set_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type preview_create_device_set_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class PreviewCreateDeviceSetParams < Courier::Models::CreateDeviceSetRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end

data/sig/courier/models/preview_device.rbs

@@ -0,0 +1,83 @@
+module Courier
+  module Models
+    type preview_device =
+      {
+        id: String,
+        app: String,
+        category: Courier::Models::PreviewDevice::category,
+        name: String,
+        os: String,
+        os_version: String,
+        platform: String?,
+        platform_version: String?,
+        theme: Courier::Models::PreviewDevice::theme
+      }
+
+    class PreviewDevice < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor app: String
+
+      attr_accessor category: Courier::Models::PreviewDevice::category
+
+      attr_accessor name: String
+
+      attr_accessor os: String
+
+      attr_accessor os_version: String
+
+      attr_accessor platform: String?
+
+      attr_accessor platform_version: String?
+
+      attr_accessor theme: Courier::Models::PreviewDevice::theme
+
+      def initialize: (
+        id: String,
+        app: String,
+        category: Courier::Models::PreviewDevice::category,
+        name: String,
+        os: String,
+        os_version: String,
+        platform: String?,
+        platform_version: String?,
+        theme: Courier::Models::PreviewDevice::theme
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        app: String,
+        category: Courier::Models::PreviewDevice::category,
+        name: String,
+        os: String,
+        os_version: String,
+        platform: String?,
+        platform_version: String?,
+        theme: Courier::Models::PreviewDevice::theme
+      }
+
+      type category = :webmail | :mobile | :desktop
+
+      module Category
+        extend Courier::Internal::Type::Enum
+
+        WEBMAIL: :webmail
+        MOBILE: :mobile
+        DESKTOP: :desktop
+
+        def self?.values: -> ::Array[Courier::Models::PreviewDevice::category]
+      end
+
+      type theme = :light | :dark
+
+      module Theme
+        extend Courier::Internal::Type::Enum
+
+        LIGHT: :light
+        DARK: :dark
+
+        def self?.values: -> ::Array[Courier::Models::PreviewDevice::theme]
+      end
+    end
+  end
+end

data/sig/courier/models/preview_device_list_response.rbs

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

data/sig/courier/models/preview_list_device_sets_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type preview_list_device_sets_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class PreviewListDeviceSetsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end

data/sig/courier/models/preview_list_devices_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type preview_list_devices_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class PreviewListDevicesParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end

data/sig/courier/models/preview_retrieve_device_set_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type preview_retrieve_device_set_params =
+      { device_set_id: String } & Courier::Internal::Type::request_parameters
+
+    class PreviewRetrieveDeviceSetParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor device_set_id: String
+
+      def initialize: (
+        device_set_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        device_set_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/preview_update_device_set_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type preview_update_device_set_params =
+      { device_set_id: String } & Courier::Internal::Type::request_parameters
+
+    class PreviewUpdateDeviceSetParams < Courier::Models::CreateDeviceSetRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def device_set_id: -> String
+
+      def device_set_id=: (String _) -> String
+
+      def initialize: (
+        device_set_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        device_set_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/workspace_preference_list_logs_params.rbs

@@ -0,0 +1,56 @@
+module Courier
+  module Models
+    type workspace_preference_list_logs_params =
+      {
+        cursor: String,
+        limit: Integer,
+        since: String,
+        tenant_id: String,
+        user_id: String
+      }
+      & Courier::Internal::Type::request_parameters
+
+    class WorkspacePreferenceListLogsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_reader since: String?
+
+      def since=: (String) -> String
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
+
+      attr_reader user_id: String?
+
+      def user_id=: (String) -> String
+
+      def initialize: (
+        ?cursor: String,
+        ?limit: Integer,
+        ?since: String,
+        ?tenant_id: String,
+        ?user_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        cursor: String,
+        limit: Integer,
+        since: String,
+        tenant_id: String,
+        user_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models.rbs

@@ -139,10 +139,16 @@ module Courier
 
   class CreateBroadcastRequest = Courier::Models::CreateBroadcastRequest
 
+  class CreateDeviceSetRequest = Courier::Models::CreateDeviceSetRequest
+
   class CreateJourneyRequest = Courier::Models::CreateJourneyRequest
 
   class DefaultPreferences = Courier::Models::DefaultPreferences
 
+  class DeviceSet = Courier::Models::DeviceSet
+
+  class DeviceSetListResponse = Courier::Models::DeviceSetListResponse
+
   class DeviceType = Courier::Models::DeviceType
 
   class DigestCategory = Courier::Models::DigestCategory
@@ -473,8 +479,30 @@ module Courier
 
   class Preference = Courier::Models::Preference
 
+  class PreferenceChangeLogEntry = Courier::Models::PreferenceChangeLogEntry
+
+  class PreferenceChangeLogValue = Courier::Models::PreferenceChangeLogValue
+
+  class PreferenceLogsListResponse = Courier::Models::PreferenceLogsListResponse
+
   module PreferenceStatus = Courier::Models::PreferenceStatus
 
+  class PreviewArchiveDeviceSetParams = Courier::Models::PreviewArchiveDeviceSetParams
+
+  class PreviewCreateDeviceSetParams = Courier::Models::PreviewCreateDeviceSetParams
+
+  class PreviewDevice = Courier::Models::PreviewDevice
+
+  class PreviewDeviceListResponse = Courier::Models::PreviewDeviceListResponse
+
+  class PreviewListDeviceSetsParams = Courier::Models::PreviewListDeviceSetsParams
+
+  class PreviewListDevicesParams = Courier::Models::PreviewListDevicesParams
+
+  class PreviewRetrieveDeviceSetParams = Courier::Models::PreviewRetrieveDeviceSetParams
+
+  class PreviewUpdateDeviceSetParams = Courier::Models::PreviewUpdateDeviceSetParams
+
   class ProfileCreateParams = Courier::Models::ProfileCreateParams
 
   class ProfileDeleteParams = Courier::Models::ProfileDeleteParams
@@ -655,6 +683,8 @@ module Courier
 
   class WorkspacePreferenceGetResponse = Courier::Models::WorkspacePreferenceGetResponse
 
+  class WorkspacePreferenceListLogsParams = Courier::Models::WorkspacePreferenceListLogsParams
+
   class WorkspacePreferenceListParams = Courier::Models::WorkspacePreferenceListParams
 
   class WorkspacePreferenceListResponse = Courier::Models::WorkspacePreferenceListResponse

data/sig/courier/resources/notifications/previews/runs.rbs

@@ -0,0 +1,36 @@
+module Courier
+  module Resources
+    class Notifications
+      class Previews
+        class Runs
+          def create: (
+            String id,
+            ?data: ::Hash[Symbol, top],
+            ?device_ids: ::Array[String],
+            ?device_set_id: String,
+            ?locale: String,
+            ?template_version: String,
+            ?idempotency_key: String,
+            ?x_idempotency_expiration: String,
+            ?request_options: Courier::request_opts
+          ) -> Courier::Notifications::Previews::PreviewRun
+
+          def retrieve: (
+            String preview_run_id,
+            id: String,
+            ?request_options: Courier::request_opts
+          ) -> Courier::Notifications::Previews::PreviewRunDetail
+
+          def list: (
+            String id,
+            ?cursor: String?,
+            ?limit: Integer,
+            ?request_options: Courier::request_opts
+          ) -> Courier::Notifications::Previews::PreviewRunListResponse
+
+          def initialize: (client: Courier::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/courier/resources/notifications/previews.rbs

@@ -0,0 +1,11 @@
+module Courier
+  module Resources
+    class Notifications
+      class Previews
+        attr_reader runs: Courier::Resources::Notifications::Previews::Runs
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end

data/sig/courier/resources/notifications.rbs

@@ -3,6 +3,8 @@ module Courier
     class Notifications
       attr_reader checks: Courier::Resources::Notifications::Checks
 
+      attr_reader previews: Courier::Resources::Notifications::Previews
+
       def create: (
         notification: Courier::NotificationTemplateWritePayload,
         ?state: Courier::Models::NotificationTemplateCreateRequest::state,

data/sig/courier/resources/previews.rbs

@@ -0,0 +1,38 @@
+module Courier
+  module Resources
+    class Previews
+      def archive_device_set: (
+        String device_set_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::DeviceSet
+
+      def create_device_set: (
+        device_ids: ::Array[String],
+        name: String,
+        ?request_options: Courier::request_opts
+      ) -> Courier::DeviceSet
+
+      def list_device_sets: (
+        ?request_options: Courier::request_opts
+      ) -> Courier::DeviceSetListResponse
+
+      def list_devices: (
+        ?request_options: Courier::request_opts
+      ) -> Courier::PreviewDeviceListResponse
+
+      def retrieve_device_set: (
+        String device_set_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::DeviceSet
+
+      def update_device_set: (
+        String device_set_id,
+        device_ids: ::Array[String],
+        name: String,
+        ?request_options: Courier::request_opts
+      ) -> Courier::DeviceSet
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/workspace_preferences.rbs

@@ -27,6 +27,15 @@ module Courier
         ?request_options: Courier::request_opts
       ) -> nil
 
+      def list_logs: (
+        ?cursor: String,
+        ?limit: Integer,
+        ?since: String,
+        ?tenant_id: String,
+        ?user_id: String,
+        ?request_options: Courier::request_opts
+      ) -> Courier::PreferenceLogsListResponse
+
       def publish: (
         ?brand_id: String?,
         ?description: String?,