trycourier 6.9.0 → 6.11.0

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # @see Courier::Resources::Notifications::Previews::Runs#list
+        class RunListParams < Courier::Internal::Type::BaseModel
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute cursor
+          #   Opaque pagination cursor from a previous response. Omit for the first page.
+          #
+          #   @return [String, nil]
+          optional :cursor, String, nil?: true
+
+          # @!attribute limit
+          #   Maximum number of results per page.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!method initialize(id:, cursor: nil, limit: nil, request_options: {})
+          #   @param id [String]
+          #
+          #   @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+          #
+          #   @param limit [Integer] Maximum number of results per page.
+          #
+          #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      module Previews
+        # @see Courier::Resources::Notifications::Previews::Runs#retrieve
+        class RunRetrieveParams < Courier::Internal::Type::BaseModel
+          extend Courier::Internal::Type::RequestParameters::Converter
+          include Courier::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute preview_run_id
+          #
+          #   @return [String]
+          required :preview_run_id, String
+
+          # @!method initialize(id:, preview_run_id:, request_options: {})
+          #   @param id [String]
+          #   @param preview_run_id [String]
+          #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/preference_change_log_entry.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreferenceChangeLogEntry < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for this change.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute custom_routing
+      #   The channels chosen for this topic, present only when has_custom_routing is
+      #   true. Empty otherwise.
+      #
+      #   @return [Array<Symbol, Courier::Models::ChannelClassification>]
+      required :custom_routing, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
+
+      # @!attribute has_custom_routing
+      #   Whether specific delivery channels were chosen for this topic rather than the
+      #   topic's default routing.
+      #
+      #   @return [Boolean]
+      required :has_custom_routing, Courier::Internal::Type::Boolean
+
+      # @!attribute status
+      #   The subscription status the change set.
+      #
+      #   @return [Symbol, Courier::Models::PreferenceStatus]
+      required :status, enum: -> { Courier::PreferenceStatus }
+
+      # @!attribute timestamp
+      #   When the change was made, as an ISO-8601 date-time in UTC.
+      #
+      #   @return [String]
+      required :timestamp, String
+
+      # @!attribute topic_id
+      #   The subscription topic the change applies to.
+      #
+      #   @return [String]
+      required :topic_id, String
+
+      # @!attribute topic_name
+      #   The display name of that topic when the change was made.
+      #
+      #   @return [String]
+      required :topic_name, String
+
+      # @!attribute user_id
+      #   The user whose preference changed.
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute previous
+      #   The value before this change, where it was recorded.
+      #
+      #   @return [Courier::Models::PreferenceChangeLogValue, nil]
+      optional :previous, -> { Courier::PreferenceChangeLogValue }
+
+      # @!attribute tenant_id
+      #   The tenant context the change was made in. Absent when the user set the
+      #   preference outside any tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant_id, String
+
+      # @!method initialize(id:, custom_routing:, has_custom_routing:, status:, timestamp:, topic_id:, topic_name:, user_id:, previous: nil, tenant_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::PreferenceChangeLogEntry} for more details.
+      #
+      #   @param id [String] Unique identifier for this change.
+      #
+      #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>] The channels chosen for this topic, present only when has_custom_routing is true
+      #
+      #   @param has_custom_routing [Boolean] Whether specific delivery channels were chosen for this topic rather than the to
+      #
+      #   @param status [Symbol, Courier::Models::PreferenceStatus] The subscription status the change set.
+      #
+      #   @param timestamp [String] When the change was made, as an ISO-8601 date-time in UTC.
+      #
+      #   @param topic_id [String] The subscription topic the change applies to.
+      #
+      #   @param topic_name [String] The display name of that topic when the change was made.
+      #
+      #   @param user_id [String] The user whose preference changed.
+      #
+      #   @param previous [Courier::Models::PreferenceChangeLogValue] The value before this change, where it was recorded.
+      #
+      #   @param tenant_id [String] The tenant context the change was made in. Absent when the user set the preferen
+    end
+  end
+end

data/lib/courier/models/preference_change_log_value.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreferenceChangeLogValue < Courier::Internal::Type::BaseModel
+      # @!attribute custom_routing
+      #   The channels chosen before the change.
+      #
+      #   @return [Array<Symbol, Courier::Models::ChannelClassification>]
+      required :custom_routing, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
+
+      # @!attribute has_custom_routing
+      #   Whether custom routing was in effect before the change.
+      #
+      #   @return [Boolean]
+      required :has_custom_routing, Courier::Internal::Type::Boolean
+
+      # @!attribute status
+      #   The subscription status before the change.
+      #
+      #   @return [Symbol, Courier::Models::PreferenceStatus]
+      required :status, enum: -> { Courier::PreferenceStatus }
+
+      # @!method initialize(custom_routing:, has_custom_routing:, status:)
+      #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>] The channels chosen before the change.
+      #
+      #   @param has_custom_routing [Boolean] Whether custom routing was in effect before the change.
+      #
+      #   @param status [Symbol, Courier::Models::PreferenceStatus] The subscription status before the change.
+    end
+  end
+end

data/lib/courier/models/preference_logs_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::WorkspacePreferences#list_logs
+    class PreferenceLogsListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute items
+      #   One entry per preference change, newest first.
+      #
+      #   @return [Array<Courier::Models::PreferenceChangeLogEntry>]
+      required :items, -> { Courier::Internal::Type::ArrayOf[Courier::PreferenceChangeLogEntry] }
+
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!method initialize(items:, paging:)
+      #   @param items [Array<Courier::Models::PreferenceChangeLogEntry>] One entry per preference change, newest first.
+      #
+      #   @param paging [Courier::Models::Paging]
+    end
+  end
+end

data/lib/courier/models/preview_archive_device_set_params.rb

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

data/lib/courier/models/preview_create_device_set_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Previews#create_device_set
+    class PreviewCreateDeviceSetParams < Courier::Models::CreateDeviceSetRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preview_device.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreviewDevice < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The device's identifier, used in `device_ids` when creating a device set or a
+      #   run.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute app
+      #   The mail app. For webmail it is the service (`outlook_com`, `gmail_com`); for
+      #   mobile the app (`apple_mail`, `gmail`); for desktop the app together with the
+      #   version it is sold under (`outlook_2019`, `outlook_microsoft_365`,
+      #   `apple_mail_16`), because that version is what separates one desktop Outlook
+      #   from another.
+      #
+      #   @return [String]
+      required :app, String
+
+      # @!attribute category
+      #   Where the app runs.
+      #
+      #   @return [Symbol, Courier::Models::PreviewDevice::Category]
+      required :category, enum: -> { Courier::PreviewDevice::Category }
+
+      # @!attribute name
+      #   Display name. Render it as-is rather than parsing it. It is also what separates
+      #   the two 120-dpi Outlook renders from their 100% siblings, which are otherwise
+      #   identical field for field.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute os
+      #   The operating system.
+      #
+      #   @return [String]
+      required :os, String
+
+      # @!attribute os_version
+      #   The operating system's version. Always set.
+      #
+      #   @return [String]
+      required :os_version, String
+
+      # @!attribute platform
+      #   What the app runs on — the browser for webmail (`chrome`, `edge`, `firefox`),
+      #   the phone for mobile (`iphone`, `pixel`). Null for desktop, where the app runs
+      #   on nothing but the OS.
+      #
+      #   @return [String, nil]
+      required :platform, String, nil?: true
+
+      # @!attribute platform_version
+      #   Which one of the platform — the phone model for mobile (`15_pro_max`, `10`).
+      #   Null for webmail, which always renders in the current browser, and for desktop.
+      #
+      #   @return [String, nil]
+      required :platform_version, String, nil?: true
+
+      # @!attribute theme
+      #   Whether the email is rendered in light or dark mode.
+      #
+      #   @return [Symbol, Courier::Models::PreviewDevice::Theme]
+      required :theme, enum: -> { Courier::PreviewDevice::Theme }
+
+      # @!method initialize(id:, app:, category:, name:, os:, os_version:, platform:, platform_version:, theme:)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::PreviewDevice} for more details.
+      #
+      #   One mail app on one platform, operating system and theme that a preview can be
+      #   rendered on. Reference data, identical for every workspace. Every field is
+      #   always present; `platform` and `platform_version` are null where they do not
+      #   apply.
+      #
+      #   @param id [String] The device's identifier, used in `device_ids` when creating a device set or a ru
+      #
+      #   @param app [String] The mail app. For webmail it is the service (`outlook_com`, `gmail_com`); for mo
+      #
+      #   @param category [Symbol, Courier::Models::PreviewDevice::Category] Where the app runs.
+      #
+      #   @param name [String] Display name. Render it as-is rather than parsing it. It is also what separates
+      #
+      #   @param os [String] The operating system.
+      #
+      #   @param os_version [String] The operating system's version. Always set.
+      #
+      #   @param platform [String, nil] What the app runs on — the browser for webmail (`chrome`, `edge`, `firefox`), th
+      #
+      #   @param platform_version [String, nil] Which one of the platform — the phone model for mobile (`15_pro_max`, `10`). Nul
+      #
+      #   @param theme [Symbol, Courier::Models::PreviewDevice::Theme] Whether the email is rendered in light or dark mode.
+
+      # Where the app runs.
+      #
+      # @see Courier::Models::PreviewDevice#category
+      module Category
+        extend Courier::Internal::Type::Enum
+
+        WEBMAIL = :webmail
+        MOBILE = :mobile
+        DESKTOP = :desktop
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Whether the email is rendered in light or dark mode.
+      #
+      # @see Courier::Models::PreviewDevice#theme
+      module Theme
+        extend Courier::Internal::Type::Enum
+
+        LIGHT = :light
+        DARK = :dark
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/preview_device_list_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Previews#list_devices
+    class PreviewDeviceListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::PreviewDevice>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::PreviewDevice] }
+
+      # @!method initialize(results:)
+      #   The full catalog of renderable devices. Not paginated.
+      #
+      #   @param results [Array<Courier::Models::PreviewDevice>]
+    end
+  end
+end

data/lib/courier/models/preview_list_device_sets_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Previews#list_device_sets
+    class PreviewListDeviceSetsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preview_list_devices_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Previews#list_devices
+    class PreviewListDevicesParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preview_retrieve_device_set_params.rb

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

data/lib/courier/models/preview_update_device_set_params.rb

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

data/lib/courier/models/workspace_preference_list_logs_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::WorkspacePreferences#list_logs
+    class WorkspacePreferenceListLogsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   A cursor from a previous response's paging.cursor. Continue only while
+      #   paging.more is true; the cursor is omitted on the last page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   How many entries to return. Defaults to 25.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute since
+      #   Return only changes at or after this time, as an ISO-8601 date or date-time. A
+      #   date alone is read as the start of that day in UTC.
+      #
+      #   @return [String, nil]
+      optional :since, String
+
+      # @!attribute tenant_id
+      #   Narrow to the changes this user made in one tenant context. Only valid together
+      #   with user_id.
+      #
+      #   @return [String, nil]
+      optional :tenant_id, String
+
+      # @!attribute user_id
+      #   Return only this user's changes. Omit it to read every change in the
+      #   environment.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(cursor: nil, limit: nil, since: nil, tenant_id: nil, user_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::WorkspacePreferenceListLogsParams} for more details.
+      #
+      #   @param cursor [String] A cursor from a previous response's paging.cursor. Continue only while paging.mo
+      #
+      #   @param limit [Integer] How many entries to return. Defaults to 25.
+      #
+      #   @param since [String] Return only changes at or after this time, as an ISO-8601 date or date-time. A d
+      #
+      #   @param tenant_id [String] Narrow to the changes this user made in one tenant context. Only valid together
+      #
+      #   @param user_id [String] Return only this user's changes. Omit it to read every change in the environment
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models.rb

@@ -179,10 +179,16 @@ module Courier
 
   CreateBroadcastRequest = Courier::Models::CreateBroadcastRequest
 
+  CreateDeviceSetRequest = Courier::Models::CreateDeviceSetRequest
+
   CreateJourneyRequest = Courier::Models::CreateJourneyRequest
 
   DefaultPreferences = Courier::Models::DefaultPreferences
 
+  DeviceSet = Courier::Models::DeviceSet
+
+  DeviceSetListResponse = Courier::Models::DeviceSetListResponse
+
   DeviceType = Courier::Models::DeviceType
 
   DigestCategory = Courier::Models::DigestCategory
@@ -517,8 +523,30 @@ module Courier
 
   Preference = Courier::Models::Preference
 
+  PreferenceChangeLogEntry = Courier::Models::PreferenceChangeLogEntry
+
+  PreferenceChangeLogValue = Courier::Models::PreferenceChangeLogValue
+
+  PreferenceLogsListResponse = Courier::Models::PreferenceLogsListResponse
+
   PreferenceStatus = Courier::Models::PreferenceStatus
 
+  PreviewArchiveDeviceSetParams = Courier::Models::PreviewArchiveDeviceSetParams
+
+  PreviewCreateDeviceSetParams = Courier::Models::PreviewCreateDeviceSetParams
+
+  PreviewDevice = Courier::Models::PreviewDevice
+
+  PreviewDeviceListResponse = Courier::Models::PreviewDeviceListResponse
+
+  PreviewListDeviceSetsParams = Courier::Models::PreviewListDeviceSetsParams
+
+  PreviewListDevicesParams = Courier::Models::PreviewListDevicesParams
+
+  PreviewRetrieveDeviceSetParams = Courier::Models::PreviewRetrieveDeviceSetParams
+
+  PreviewUpdateDeviceSetParams = Courier::Models::PreviewUpdateDeviceSetParams
+
   ProfileCreateParams = Courier::Models::ProfileCreateParams
 
   ProfileDeleteParams = Courier::Models::ProfileDeleteParams
@@ -699,6 +727,8 @@ module Courier
 
   WorkspacePreferenceGetResponse = Courier::Models::WorkspacePreferenceGetResponse
 
+  WorkspacePreferenceListLogsParams = Courier::Models::WorkspacePreferenceListLogsParams
+
   WorkspacePreferenceListParams = Courier::Models::WorkspacePreferenceListParams
 
   WorkspacePreferenceListResponse = Courier::Models::WorkspacePreferenceListResponse