trycourier 4.17.0 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ebaf44c61a0ef71f4361dcc7d1c86fd966ef63dad937597e9aa3305eac0eb0c
-  data.tar.gz: 77043c6e894d91ae5bfcab16c10deebe37297817112069e094a88f0927452aa8
+  metadata.gz: f8dd821714bcedfb9a48185d8a9c04f669568f2fdd560bcbd58a7c21acf43be3
+  data.tar.gz: c8730971ee6d6fbb0e38a4f3a6a213c0a9fed7aca628d5ebc3e490c8c585d362
 SHA512:
-  metadata.gz: eada95e02ef63ffe5351c64ccbafa522e8a36d02b0ad84c15a250c493684b9676538c2c72d72ee6c613096bfb2de1e40b00cef51134af44de63229937ad22036
-  data.tar.gz: 1579153d043a077c6d4561276bfbbabbd986ddb115bea3552b5301717bb9e5c80855176573fc50789dc9293fd20970db74f5d003f1e3fe7e890128d236b4b65c
+  metadata.gz: 1c3bdee713e6ac20200c2c35ac993a34a07b52b3e4c1bc9422e0074aeffe344b39962d7703463de38d80f00ba1ecc56e5ea839654ac0a45c6c51400fc996849b
+  data.tar.gz: 07535c3b636a1462811bd7f00685dbc3738c3ce589cc0f963baf898a2895f543c48a8e12e39135c6bebccdbabc3fb85388dea03af2aff3d0bcf6758c4ef2309e

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 4.18.0 (2026-07-06)
+
+Full Changelog: [v4.17.1...v4.18.0](https://github.com/trycourier/courier-ruby/compare/v4.17.1...v4.18.0)
+
+### Features
+
+* **openapi:** Journeys cancel-by-token endpoint + send-node experiments (C-18986) ([12613c6](https://github.com/trycourier/courier-ruby/commit/12613c65e9b4facc19f7fa23cc92fac0b2ea8684))
+
+
+### Chores
+
+* **internal:** bound formatter parallelism to CPU count ([192d613](https://github.com/trycourier/courier-ruby/commit/192d6133c29e2ae7bfcd7c54bd1c244894f01b94))
+
+
+### Documentation
+
+* **openapi:** reword Cancel journey runs 400 description (re-trigger deploy) ([89ceaab](https://github.com/trycourier/courier-ruby/commit/89ceaab2e20d45c3dd807427f5e4d248ba94cc8a))
+* **openapi:** reword Cancel journey runs description (re-trigger deploy) ([ccce802](https://github.com/trycourier/courier-ruby/commit/ccce8027d4279de031ff2f7e95a250e512dbfbed))
+* **openapi:** tighten Journeys cancel/experiment copy (C-19177) ([10c4f1d](https://github.com/trycourier/courier-ruby/commit/10c4f1d3ca27c525ec5d75d49f4bb30cc0d6180d))
+
+## 4.17.1 (2026-06-25)
+
+Full Changelog: [v4.17.0...v4.17.1](https://github.com/trycourier/courier-ruby/compare/v4.17.0...v4.17.1)
+
+### Documentation
+
+* **openapi:** add full response examples to every endpoint ([be9724a](https://github.com/trycourier/courier-ruby/commit/be9724a3a5d7317bd31d99160414959b58d1e5bb))
+* **openapi:** reword Cancel Submission description ([68565aa](https://github.com/trycourier/courier-ruby/commit/68565aa1f8de141d9780a390da4b48aeb178624e))
+* **openapi:** reword Get Submission Checks description ([94541e4](https://github.com/trycourier/courier-ruby/commit/94541e4aaebbf1ac567e1047d2ce84e5ad97741b))
+* **openapi:** reword Replace Submission Checks description ([7aa63c1](https://github.com/trycourier/courier-ruby/commit/7aa63c14c83b9585ec963d426f47b2720b5b04cc))
+
 ## 4.17.0 (2026-06-24)
 
 Full Changelog: [v4.16.0...v4.17.0](https://github.com/trycourier/courier-ruby/compare/v4.16.0...v4.17.0)

data/lib/courier/client.rb

@@ -66,8 +66,8 @@ module Courier
     # @return [Courier::Resources::RoutingStrategies]
     attr_reader :routing_strategies
 
-    # @return [Courier::Resources::PreferenceSections]
-    attr_reader :preference_sections
+    # @return [Courier::Resources::WorkspacePreferences]
+    attr_reader :workspace_preferences
 
     # @return [Courier::Resources::Profiles]
     attr_reader :profiles
@@ -158,7 +158,7 @@ module Courier
       @requests = Courier::Resources::Requests.new(client: self)
       @notifications = Courier::Resources::Notifications.new(client: self)
       @routing_strategies = Courier::Resources::RoutingStrategies.new(client: self)
-      @preference_sections = Courier::Resources::PreferenceSections.new(client: self)
+      @workspace_preferences = Courier::Resources::WorkspacePreferences.new(client: self)
       @profiles = Courier::Resources::Profiles.new(client: self)
       @tenants = Courier::Resources::Tenants.new(client: self)
       @translations = Courier::Resources::Translations.new(client: self)

data/lib/courier/models/cancel_journey_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # Request body for `POST /journeys/cancel`. Provide EXACTLY ONE of
+    # `cancelation_token` (cancels every run associated with the token) or `run_id`
+    # (cancels a single tenant-scoped run).
+    module CancelJourneyRequest
+      extend Courier::Internal::Type::Union
+
+      variant -> { Courier::CancelJourneyRequest::ByCancelationToken }
+
+      variant -> { Courier::CancelJourneyRequest::ByRunID }
+
+      class ByCancelationToken < Courier::Internal::Type::BaseModel
+        # @!attribute cancelation_token
+        #
+        #   @return [String]
+        required :cancelation_token, String
+
+        # @!method initialize(cancelation_token:)
+        #   @param cancelation_token [String]
+      end
+
+      class ByRunID < Courier::Internal::Type::BaseModel
+        # @!attribute run_id
+        #
+        #   @return [String]
+        required :run_id, String
+
+        # @!method initialize(run_id:)
+        #   @param run_id [String]
+      end
+
+      # @!method self.variants
+      #   @return [Array(Courier::Models::CancelJourneyRequest::ByCancelationToken, Courier::Models::CancelJourneyRequest::ByRunID)]
+    end
+  end
+end

data/lib/courier/models/cancel_journey_response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # `202 Accepted` body for `POST /journeys/cancel`, returning the submitted
+    # identifier. When called with `cancelation_token`, returns
+    # `{ cancelation_token }`; when called with `run_id`, returns
+    # `{ run_id, status }`.
+    #
+    # @see Courier::Resources::Journeys#cancel
+    module CancelJourneyResponse
+      extend Courier::Internal::Type::Union
+
+      variant -> { Courier::CancelJourneyResponse::TokenBranch }
+
+      variant -> { Courier::CancelJourneyResponse::RunIDBranch }
+
+      class TokenBranch < Courier::Internal::Type::BaseModel
+        # @!attribute cancelation_token
+        #
+        #   @return [String]
+        required :cancelation_token, String
+
+        # @!method initialize(cancelation_token:)
+        #   @param cancelation_token [String]
+      end
+
+      class RunIDBranch < Courier::Internal::Type::BaseModel
+        # @!attribute run_id
+        #
+        #   @return [String]
+        required :run_id, String
+
+        # @!attribute status
+        #   The run's resulting status. `CANCELED` when the run was active and has been
+        #   canceled; `PROCESSED` or `ERROR` when the run had already finished and was left
+        #   unchanged; `CANCELED` for an already-canceled run.
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!method initialize(run_id:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::CancelJourneyResponse::RunIDBranch} for more details.
+        #
+        #   @param run_id [String]
+        #
+        #   @param status [String] The run's resulting status. `CANCELED` when the run was active and has been canc
+      end
+
+      # @!method self.variants
+      #   @return [Array(Courier::Models::CancelJourneyResponse::TokenBranch, Courier::Models::CancelJourneyResponse::RunIDBranch)]
+    end
+  end
+end

data/lib/courier/models/{preference_section_list_params.rb → journey_cancel_params.rb}

@@ -2,8 +2,8 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::PreferenceSections#list
-    class PreferenceSectionListParams < Courier::Internal::Type::BaseModel
+    # @see Courier::Resources::Journeys#cancel
+    class JourneyCancelParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/lib/courier/models/journey_experiment.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyExperiment < Courier::Internal::Type::BaseModel
+      # @!attribute bucketing_key
+      #   The value used to deterministically assign a recipient to a variant. Must be
+      #   non-empty with no leading or trailing whitespace.
+      #
+      #   @return [String]
+      required :bucketing_key, String, api_name: :bucketingKey
+
+      # @!attribute variants
+      #   Between 2 and 10 weighted template variants.
+      #
+      #   @return [Array<Courier::Models::JourneyExperimentVariant>]
+      required :variants, -> { Courier::Internal::Type::ArrayOf[Courier::JourneyExperimentVariant] }
+
+      # @!attribute id
+      #   Unique experiment id (prefixed `exp_`). Omit to have one generated
+      #   automatically; when supplied it must be a valid `exp_` id.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute name
+      #   Optional display name for the experiment.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(bucketing_key:, variants:, id: nil, name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyExperiment} for more details.
+      #
+      #   A/B experiment config for a send node. The recipient is deterministically
+      #   bucketed by `bucketingKey` and routed to one of the `variants` in proportion to
+      #   its `weight`. Present on a send node INSTEAD OF `message.template`.
+      #
+      #   @param bucketing_key [String] The value used to deterministically assign a recipient to a variant. Must be non
+      #
+      #   @param variants [Array<Courier::Models::JourneyExperimentVariant>] Between 2 and 10 weighted template variants.
+      #
+      #   @param id [String] Unique experiment id (prefixed `exp_`). Omit to have one generated automatically
+      #
+      #   @param name [String] Optional display name for the experiment.
+    end
+  end
+end

data/lib/courier/models/journey_experiment_variant.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyExperimentVariant < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute template_id
+      #   The notification template sent for this variant.
+      #
+      #   @return [String]
+      required :template_id, String, api_name: :templateId
+
+      # @!attribute weight
+      #   Relative routing weight. Must be non-negative.
+      #
+      #   @return [Float]
+      required :weight, Float
+
+      # @!attribute name
+      #   Optional display name for the variant.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(id:, template_id:, weight:, name: nil)
+      #   A single weighted variant of an experiment. Variant ids must be unique within
+      #   the experiment and the sum of all variant weights must be greater than 0.
+      #   Weights are relative (no sum-to-100 requirement) — routing normalizes them
+      #   proportionally.
+      #
+      #   @param id [String]
+      #
+      #   @param template_id [String] The notification template sent for this variant.
+      #
+      #   @param weight [Float] Relative routing weight. Must be non-negative.
+      #
+      #   @param name [String] Optional display name for the variant.
+    end
+  end
+end

data/lib/courier/models/journey_node.rb

@@ -14,7 +14,7 @@ module Courier
       # Trigger fired by a segment event (`identify`, `group`, or `track`).
       variant -> { Courier::JourneySegmentTriggerNode }
 
-      # Send a notification template to the recipient. Optionally override the recipient address, delay the send, or attach `data`.
+      # Send to the recipient. A send node sources its content from EXACTLY ONE of `message.template` (a single notification template) or `experiment` (an A/B split across weighted template variants) — supplying both, or neither, is rejected. Optionally override the recipient address, delay the send, or attach `data`.
       variant -> { Courier::JourneySendNode }
 
       # Pause the journey run for a fixed `duration`.

data/lib/courier/models/journey_send_node.rb

@@ -26,12 +26,23 @@ module Courier
       #   @return [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup, nil]
       optional :conditions, union: -> { Courier::JourneyConditionsField }
 
-      # @!method initialize(message:, type:, id: nil, conditions: nil)
+      # @!attribute experiment
+      #   A/B experiment config for a send node. The recipient is deterministically
+      #   bucketed by `bucketingKey` and routed to one of the `variants` in proportion to
+      #   its `weight`. Present on a send node INSTEAD OF `message.template`.
+      #
+      #   @return [Courier::Models::JourneyExperiment, nil]
+      optional :experiment, -> { Courier::JourneyExperiment }
+
+      # @!method initialize(message:, type:, id: nil, conditions: nil, experiment: nil)
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::JourneySendNode} for more details.
       #
-      #   Send a notification template to the recipient. Optionally override the recipient
-      #   address, delay the send, or attach `data`.
+      #   Send to the recipient. A send node sources its content from EXACTLY ONE of
+      #   `message.template` (a single notification template) or `experiment` (an A/B
+      #   split across weighted template variants) — supplying both, or neither, is
+      #   rejected. Optionally override the recipient address, delay the send, or attach
+      #   `data`.
       #
       #   @param message [Courier::Models::JourneySendNode::Message]
       #
@@ -40,14 +51,11 @@ module Courier
       #   @param id [String]
       #
       #   @param conditions [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup] Condition spec for a journey node. Accepts a single condition atom, an AND/OR gr
+      #
+      #   @param experiment [Courier::Models::JourneyExperiment] A/B experiment config for a send node. The recipient is deterministically bucket
 
       # @see Courier::Models::JourneySendNode#message
       class Message < Courier::Internal::Type::BaseModel
-        # @!attribute template
-        #
-        #   @return [String]
-        required :template, String
-
         # @!attribute data
         #
         #   @return [Hash{Symbol=>Object}, nil]
@@ -58,15 +66,20 @@ module Courier
         #   @return [Courier::Models::JourneySendNode::Message::Delay, nil]
         optional :delay, -> { Courier::JourneySendNode::Message::Delay }
 
+        # @!attribute template
+        #
+        #   @return [String, nil]
+        optional :template, String
+
         # @!attribute to
         #
         #   @return [Courier::Models::JourneySendNode::Message::To, nil]
         optional :to, -> { Courier::JourneySendNode::Message::To }
 
-        # @!method initialize(template:, data: nil, delay: nil, to: nil)
-        #   @param template [String]
+        # @!method initialize(data: nil, delay: nil, template: nil, to: nil)
         #   @param data [Hash{Symbol=>Object}]
         #   @param delay [Courier::Models::JourneySendNode::Message::Delay]
+        #   @param template [String]
         #   @param to [Courier::Models::JourneySendNode::Message::To]
 
         # @see Courier::Models::JourneySendNode::Message#delay

data/lib/courier/models/publish_preferences_response.rb

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::PreferenceSections#publish
+    # @see Courier::Resources::WorkspacePreferences#publish
     class PublishPreferencesResponse < Courier::Internal::Type::BaseModel
       # @!attribute page_id
       #   Id of the published page snapshot.

data/lib/courier/models/{preference_section_archive_params.rb → workspace_preference_archive_params.rb}

@@ -2,8 +2,8 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::PreferenceSections#archive
-    class PreferenceSectionArchiveParams < Courier::Internal::Type::BaseModel
+    # @see Courier::Resources::WorkspacePreferences#archive
+    class WorkspacePreferenceArchiveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/lib/courier/models/workspace_preference_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::WorkspacePreferences#create
+    class WorkspacePreferenceCreateParams < Courier::Models::WorkspacePreferenceCreateRequest
+      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/{preference_section_create_request.rb → workspace_preference_create_request.rb}

@@ -2,21 +2,21 @@
 
 module Courier
   module Models
-    class PreferenceSectionCreateRequest < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceCreateRequest < Courier::Internal::Type::BaseModel
       # @!attribute name
-      #   Human-readable name for the section.
+      #   Human-readable name for the workspace preference.
       #
       #   @return [String]
       required :name, String
 
       # @!attribute has_custom_routing
-      #   Whether the section defines custom routing for its topics.
+      #   Whether the workspace preference defines custom routing for its topics.
       #
       #   @return [Boolean, nil]
       optional :has_custom_routing, Courier::Internal::Type::Boolean, nil?: true
 
       # @!attribute routing_options
-      #   Default channels for the section. Defaults to empty if omitted.
+      #   Default channels for the workspace preference. Defaults to empty if omitted.
       #
       #   @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
       optional :routing_options,
@@ -24,13 +24,13 @@ module Courier
                nil?: true
 
       # @!method initialize(name:, has_custom_routing: nil, routing_options: nil)
-      #   Request body for creating a preference section.
+      #   Request body for creating a workspace preference.
       #
-      #   @param name [String] Human-readable name for the section.
+      #   @param name [String] Human-readable name for the workspace preference.
       #
-      #   @param has_custom_routing [Boolean, nil] Whether the section defines custom routing for its topics.
+      #   @param has_custom_routing [Boolean, nil] Whether the workspace preference defines custom routing for its topics.
       #
-      #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the section. Defaults to empty if omitted.
+      #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the workspace preference. Defaults to empty if omitted.
     end
   end
 end

data/lib/courier/models/{preference_section_get_response.rb → workspace_preference_get_response.rb}

@@ -2,22 +2,22 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::PreferenceSections#create
-    class PreferenceSectionGetResponse < Courier::Internal::Type::BaseModel
+    # @see Courier::Resources::WorkspacePreferences#create
+    class WorkspacePreferenceGetResponse < Courier::Internal::Type::BaseModel
       # @!attribute id
-      #   The preference section id.
+      #   The workspace preference id.
       #
       #   @return [String]
       required :id, String
 
       # @!attribute created
-      #   ISO-8601 timestamp of when the section was created.
+      #   ISO-8601 timestamp of when the workspace preference was created.
       #
       #   @return [String]
       required :created, String
 
       # @!attribute has_custom_routing
-      #   Whether the section defines custom routing for its topics.
+      #   Whether the workspace preference defines custom routing for its topics.
       #
       #   @return [Boolean]
       required :has_custom_routing, Courier::Internal::Type::Boolean
@@ -29,16 +29,16 @@ module Courier
       required :name, String
 
       # @!attribute routing_options
-      #   Default channels for the section. May be empty.
+      #   Default channels for the workspace preference. May be empty.
       #
       #   @return [Array<Symbol, Courier::Models::ChannelClassification>]
       required :routing_options, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
 
       # @!attribute topics
-      #   The topics contained in this section.
+      #   The topics contained in this workspace preference.
       #
-      #   @return [Array<Courier::Models::PreferenceTopicGetResponse>]
-      required :topics, -> { Courier::Internal::Type::ArrayOf[Courier::PreferenceTopicGetResponse] }
+      #   @return [Array<Courier::Models::WorkspacePreferenceTopicGetResponse>]
+      required :topics, -> { Courier::Internal::Type::ArrayOf[Courier::WorkspacePreferenceTopicGetResponse] }
 
       # @!attribute creator
       #   Id of the creator.
@@ -59,19 +59,19 @@ module Courier
       optional :updater, String, nil?: true
 
       # @!method initialize(id:, created:, has_custom_routing:, name:, routing_options:, topics:, creator: nil, updated: nil, updater: nil)
-      #   A preference section in your workspace, including its topics.
+      #   A workspace preference in your workspace, including its topics.
       #
-      #   @param id [String] The preference section id.
+      #   @param id [String] The workspace preference id.
       #
-      #   @param created [String] ISO-8601 timestamp of when the section was created.
+      #   @param created [String] ISO-8601 timestamp of when the workspace preference was created.
       #
-      #   @param has_custom_routing [Boolean] Whether the section defines custom routing for its topics.
+      #   @param has_custom_routing [Boolean] Whether the workspace preference defines custom routing for its topics.
       #
       #   @param name [String] Human-readable name.
       #
-      #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>] Default channels for the section. May be empty.
+      #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>] Default channels for the workspace preference. May be empty.
       #
-      #   @param topics [Array<Courier::Models::PreferenceTopicGetResponse>] The topics contained in this section.
+      #   @param topics [Array<Courier::Models::WorkspacePreferenceTopicGetResponse>] The topics contained in this workspace preference.
       #
       #   @param creator [String, nil] Id of the creator.
       #

data/lib/courier/models/{preference_section_publish_params.rb → workspace_preference_list_params.rb}

@@ -2,8 +2,8 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::PreferenceSections#publish
-    class PreferenceSectionPublishParams < Courier::Internal::Type::BaseModel
+    # @see Courier::Resources::WorkspacePreferences#list
+    class WorkspacePreferenceListParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/lib/courier/models/workspace_preference_list_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::WorkspacePreferences#list
+    class WorkspacePreferenceListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::WorkspacePreferenceGetResponse>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::WorkspacePreferenceGetResponse] }
+
+      # @!method initialize(results:)
+      #   The workspace's preferences, each with its topics.
+      #
+      #   @param results [Array<Courier::Models::WorkspacePreferenceGetResponse>]
+    end
+  end
+end

data/lib/courier/models/{preference_section_create_params.rb → workspace_preference_publish_params.rb}

@@ -2,8 +2,8 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::PreferenceSections#create
-    class PreferenceSectionCreateParams < Courier::Models::PreferenceSectionCreateRequest
+    # @see Courier::Resources::WorkspacePreferences#publish
+    class WorkspacePreferencePublishParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/lib/courier/models/{preference_section_replace_params.rb → workspace_preference_replace_params.rb}

@@ -2,8 +2,8 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::PreferenceSections#replace
-    class PreferenceSectionReplaceParams < Courier::Models::PreferenceSectionReplaceRequest
+    # @see Courier::Resources::WorkspacePreferences#replace
+    class WorkspacePreferenceReplaceParams < Courier::Models::WorkspacePreferenceReplaceRequest
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/lib/courier/models/{preference_section_replace_request.rb → workspace_preference_replace_request.rb}

@@ -2,21 +2,21 @@
 
 module Courier
   module Models
-    class PreferenceSectionReplaceRequest < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceReplaceRequest < Courier::Internal::Type::BaseModel
       # @!attribute name
-      #   Human-readable name for the section.
+      #   Human-readable name for the workspace preference.
       #
       #   @return [String]
       required :name, String
 
       # @!attribute has_custom_routing
-      #   Whether the section defines custom routing for its topics.
+      #   Whether the workspace preference defines custom routing for its topics.
       #
       #   @return [Boolean, nil]
       optional :has_custom_routing, Courier::Internal::Type::Boolean, nil?: true
 
       # @!attribute routing_options
-      #   Default channels for the section. Omit to clear.
+      #   Default channels for the workspace preference. Omit to clear.
       #
       #   @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
       optional :routing_options,
@@ -24,14 +24,14 @@ module Courier
                nil?: true
 
       # @!method initialize(name:, has_custom_routing: nil, routing_options: nil)
-      #   Request body for replacing a preference section. Full document replacement;
+      #   Request body for replacing a workspace preference. Full document replacement;
       #   missing optional fields are cleared.
       #
-      #   @param name [String] Human-readable name for the section.
+      #   @param name [String] Human-readable name for the workspace preference.
       #
-      #   @param has_custom_routing [Boolean, nil] Whether the section defines custom routing for its topics.
+      #   @param has_custom_routing [Boolean, nil] Whether the workspace preference defines custom routing for its topics.
       #
-      #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the section. Omit to clear.
+      #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the workspace preference. Omit to clear.
     end
   end
 end

data/lib/courier/models/{preference_section_retrieve_params.rb → workspace_preference_retrieve_params.rb}

@@ -2,8 +2,8 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::PreferenceSections#retrieve
-    class PreferenceSectionRetrieveParams < Courier::Internal::Type::BaseModel
+    # @see Courier::Resources::WorkspacePreferences#retrieve
+    class WorkspacePreferenceRetrieveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters