trycourier 4.17.0 → 4.18.0

data/lib/courier/resources/{preference_sections.rb → workspace_preferences.rb}

@@ -2,89 +2,89 @@
 
 module Courier
   module Resources
-    class PreferenceSections
-      # @return [Courier::Resources::PreferenceSections::Topics]
+    class WorkspacePreferences
+      # @return [Courier::Resources::WorkspacePreferences::Topics]
       attr_reader :topics
 
-      # Create a preference section in your workspace. The section id is generated and
-      # returned. Topics are created inside a section via POST
+      # Create a workspace preference. The workspace preference id is generated and
+      # returned. Topics are created inside a workspace preference via POST
       # /preferences/sections/{section_id}/topics.
       #
       # @overload create(name:, has_custom_routing: nil, routing_options: nil, request_options: {})
       #
-      # @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.
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::PreferenceSectionGetResponse]
+      # @return [Courier::Models::WorkspacePreferenceGetResponse]
       #
-      # @see Courier::Models::PreferenceSectionCreateParams
+      # @see Courier::Models::WorkspacePreferenceCreateParams
       def create(params)
-        parsed, options = Courier::PreferenceSectionCreateParams.dump_request(params)
+        parsed, options = Courier::WorkspacePreferenceCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "preferences/sections",
           body: parsed,
-          model: Courier::PreferenceSectionGetResponse,
+          model: Courier::WorkspacePreferenceGetResponse,
           options: options
         )
       end
 
-      # Retrieve a preference section by id, including its topics.
+      # Retrieve a workspace preference by id, including its topics.
       #
       # @overload retrieve(section_id, request_options: {})
       #
-      # @param section_id [String] Id of the preference section.
+      # @param section_id [String] Id of the workspace preference.
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::PreferenceSectionGetResponse]
+      # @return [Courier::Models::WorkspacePreferenceGetResponse]
       #
-      # @see Courier::Models::PreferenceSectionRetrieveParams
+      # @see Courier::Models::WorkspacePreferenceRetrieveParams
       def retrieve(section_id, params = {})
         @client.request(
           method: :get,
           path: ["preferences/sections/%1$s", section_id],
-          model: Courier::PreferenceSectionGetResponse,
+          model: Courier::WorkspacePreferenceGetResponse,
           options: params[:request_options]
         )
       end
 
-      # List the workspace's preference sections. Each section embeds its topics. Scoped
-      # to the workspace of the API key.
+      # List the workspace's preferences. Each workspace preference embeds its topics.
+      # Scoped to the workspace of the API key.
       #
       # @overload list(request_options: {})
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::PreferenceSectionListResponse]
+      # @return [Courier::Models::WorkspacePreferenceListResponse]
       #
-      # @see Courier::Models::PreferenceSectionListParams
+      # @see Courier::Models::WorkspacePreferenceListParams
       def list(params = {})
         @client.request(
           method: :get,
           path: "preferences/sections",
-          model: Courier::PreferenceSectionListResponse,
+          model: Courier::WorkspacePreferenceListResponse,
           options: params[:request_options]
         )
       end
 
-      # Archive a preference section. The section must be empty: delete its topics
-      # first, otherwise the request fails with 409.
+      # Archive a workspace preference. The workspace preference must be empty: delete
+      # its topics first, otherwise the request fails with 409.
       #
       # @overload archive(section_id, request_options: {})
       #
-      # @param section_id [String] Id of the preference section.
+      # @param section_id [String] Id of the workspace preference.
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
-      # @see Courier::Models::PreferenceSectionArchiveParams
+      # @see Courier::Models::WorkspacePreferenceArchiveParams
       def archive(section_id, params = {})
         @client.request(
           method: :delete,
@@ -94,9 +94,9 @@ module Courier
         )
       end
 
-      # Publish the workspace's preferences page. Takes a snapshot of every section with
-      # its topics under a new published version, making the current state visible on
-      # the hosted preferences page (non-draft).
+      # Publish the workspace's preferences page. Takes a snapshot of every workspace
+      # preference with its topics under a new published version, making the current
+      # state visible on the hosted preferences page (non-draft).
       #
       # @overload publish(request_options: {})
       #
@@ -104,7 +104,7 @@ module Courier
       #
       # @return [Courier::Models::PublishPreferencesResponse]
       #
-      # @see Courier::Models::PreferenceSectionPublishParams
+      # @see Courier::Models::WorkspacePreferencePublishParams
       def publish(params = {})
         @client.request(
           method: :post,
@@ -114,31 +114,31 @@ module Courier
         )
       end
 
-      # Replace a preference section. Full document replacement; missing optional fields
-      # are cleared. Topics attached to the section are unaffected.
+      # Replace a workspace preference. Full document replacement; missing optional
+      # fields are cleared. Topics attached to the workspace preference are unaffected.
       #
       # @overload replace(section_id, name:, has_custom_routing: nil, routing_options: nil, request_options: {})
       #
-      # @param section_id [String] Id of the preference section.
+      # @param section_id [String] Id of the 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. Omit to clear.
+      # @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the workspace preference. Omit to clear.
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::PreferenceSectionGetResponse]
+      # @return [Courier::Models::WorkspacePreferenceGetResponse]
       #
-      # @see Courier::Models::PreferenceSectionReplaceParams
+      # @see Courier::Models::WorkspacePreferenceReplaceParams
       def replace(section_id, params)
-        parsed, options = Courier::PreferenceSectionReplaceParams.dump_request(params)
+        parsed, options = Courier::WorkspacePreferenceReplaceParams.dump_request(params)
         @client.request(
           method: :put,
           path: ["preferences/sections/%1$s", section_id],
           body: parsed,
-          model: Courier::PreferenceSectionGetResponse,
+          model: Courier::WorkspacePreferenceGetResponse,
           options: options
         )
       end
@@ -148,7 +148,7 @@ module Courier
       # @param client [Courier::Client]
       def initialize(client:)
         @client = client
-        @topics = Courier::Resources::PreferenceSections::Topics.new(client: client)
+        @topics = Courier::Resources::WorkspacePreferences::Topics.new(client: client)
       end
     end
   end

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "4.17.0"
+  VERSION = "4.18.0"
 end

data/lib/courier.rb

@@ -58,6 +58,7 @@ require_relative "courier/models/inbound_bulk_message_user"
 require_relative "courier/models/base_check"
 require_relative "courier/models/subscription_topic_new"
 require_relative "courier/models/elemental_channel_node"
+require_relative "courier/models/cancel_journey_request"
 require_relative "courier/models/create_journey_request"
 require_relative "courier/models/journeys_invoke_request"
 require_relative "courier/models/journey_publish_request"
@@ -72,16 +73,16 @@ require_relative "courier/models/notification_template_publish_request"
 require_relative "courier/models/notification_element_put_request"
 require_relative "courier/models/notification_template_update_request"
 require_relative "courier/models/notification_template_payload"
-require_relative "courier/models/preference_section_create_request"
-require_relative "courier/models/preference_section_replace_request"
-require_relative "courier/models/preference_topic_create_request"
-require_relative "courier/models/preference_topic_replace_request"
 require_relative "courier/models/routing_strategy_create_request"
 require_relative "courier/models/routing_strategy_replace_request"
 require_relative "courier/models/base_template_tenant_association"
 require_relative "courier/models/post_tenant_template_publish_request"
 require_relative "courier/models/put_tenant_template_request"
 require_relative "courier/models/users/user_token"
+require_relative "courier/models/workspace_preference_create_request"
+require_relative "courier/models/workspace_preference_replace_request"
+require_relative "courier/models/workspace_preference_topic_create_request"
+require_relative "courier/models/workspace_preference_topic_replace_request"
 require_relative "courier/models/airship_profile"
 require_relative "courier/models/airship_profile_audience"
 require_relative "courier/models/alignment"
@@ -131,6 +132,7 @@ require_relative "courier/models/bulk_list_users_response"
 require_relative "courier/models/bulk_retrieve_job_params"
 require_relative "courier/models/bulk_retrieve_job_response"
 require_relative "courier/models/bulk_run_job_params"
+require_relative "courier/models/cancel_journey_response"
 require_relative "courier/models/channel"
 require_relative "courier/models/channel_classification"
 require_relative "courier/models/channel_metadata"
@@ -171,6 +173,7 @@ require_relative "courier/models/journey"
 require_relative "courier/models/journey_ai_node"
 require_relative "courier/models/journey_api_invoke_trigger_node"
 require_relative "courier/models/journey_archive_params"
+require_relative "courier/models/journey_cancel_params"
 require_relative "courier/models/journey_condition_atom"
 require_relative "courier/models/journey_condition_group"
 require_relative "courier/models/journey_condition_nested_group"
@@ -179,6 +182,8 @@ require_relative "courier/models/journey_create_params"
 require_relative "courier/models/journey_delay_duration_node"
 require_relative "courier/models/journey_delay_until_node"
 require_relative "courier/models/journey_exit_node"
+require_relative "courier/models/journey_experiment"
+require_relative "courier/models/journey_experiment_variant"
 require_relative "courier/models/journey_fetch_get_delete_node"
 require_relative "courier/models/journey_fetch_post_put_node"
 require_relative "courier/models/journey_invoke_params"
@@ -279,22 +284,7 @@ require_relative "courier/models/pagerduty_recipient"
 require_relative "courier/models/paging"
 require_relative "courier/models/post_tenant_template_publish_response"
 require_relative "courier/models/preference"
-require_relative "courier/models/preference_section_archive_params"
-require_relative "courier/models/preference_section_create_params"
-require_relative "courier/models/preference_section_get_response"
-require_relative "courier/models/preference_section_list_params"
-require_relative "courier/models/preference_section_list_response"
-require_relative "courier/models/preference_section_publish_params"
-require_relative "courier/models/preference_section_replace_params"
-require_relative "courier/models/preference_section_retrieve_params"
-require_relative "courier/models/preference_sections/topic_archive_params"
-require_relative "courier/models/preference_sections/topic_create_params"
-require_relative "courier/models/preference_sections/topic_list_params"
-require_relative "courier/models/preference_sections/topic_replace_params"
-require_relative "courier/models/preference_sections/topic_retrieve_params"
 require_relative "courier/models/preference_status"
-require_relative "courier/models/preference_topic_get_response"
-require_relative "courier/models/preference_topic_list_response"
 require_relative "courier/models/profile_create_params"
 require_relative "courier/models/profile_create_response"
 require_relative "courier/models/profile_delete_params"
@@ -410,6 +400,21 @@ require_relative "courier/models/webhook_profile"
 require_relative "courier/models/webhook_profile_type"
 require_relative "courier/models/webhook_recipient"
 require_relative "courier/models/widget_background"
+require_relative "courier/models/workspace_preference_archive_params"
+require_relative "courier/models/workspace_preference_create_params"
+require_relative "courier/models/workspace_preference_get_response"
+require_relative "courier/models/workspace_preference_list_params"
+require_relative "courier/models/workspace_preference_list_response"
+require_relative "courier/models/workspace_preference_publish_params"
+require_relative "courier/models/workspace_preference_replace_params"
+require_relative "courier/models/workspace_preference_retrieve_params"
+require_relative "courier/models/workspace_preferences/topic_archive_params"
+require_relative "courier/models/workspace_preferences/topic_create_params"
+require_relative "courier/models/workspace_preferences/topic_list_params"
+require_relative "courier/models/workspace_preferences/topic_replace_params"
+require_relative "courier/models/workspace_preferences/topic_retrieve_params"
+require_relative "courier/models/workspace_preference_topic_get_response"
+require_relative "courier/models/workspace_preference_topic_list_response"
 require_relative "courier/models"
 require_relative "courier/resources/audiences"
 require_relative "courier/resources/audit_events"
@@ -428,8 +433,6 @@ require_relative "courier/resources/lists/subscriptions"
 require_relative "courier/resources/messages"
 require_relative "courier/resources/notifications"
 require_relative "courier/resources/notifications/checks"
-require_relative "courier/resources/preference_sections"
-require_relative "courier/resources/preference_sections/topics"
 require_relative "courier/resources/profiles"
 require_relative "courier/resources/profiles/lists"
 require_relative "courier/resources/providers"
@@ -447,3 +450,5 @@ require_relative "courier/resources/users"
 require_relative "courier/resources/users/preferences"
 require_relative "courier/resources/users/tenants"
 require_relative "courier/resources/users/tokens"
+require_relative "courier/resources/workspace_preferences"
+require_relative "courier/resources/workspace_preferences/topics"

data/rbi/courier/client.rbi

@@ -61,8 +61,8 @@ module Courier
     sig { returns(Courier::Resources::RoutingStrategies) }
     attr_reader :routing_strategies
 
-    sig { returns(Courier::Resources::PreferenceSections) }
-    attr_reader :preference_sections
+    sig { returns(Courier::Resources::WorkspacePreferences) }
+    attr_reader :workspace_preferences
 
     sig { returns(Courier::Resources::Profiles) }
     attr_reader :profiles

data/rbi/courier/models/cancel_journey_request.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+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
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::CancelJourneyRequest::ByCancelationToken,
+            Courier::CancelJourneyRequest::ByRunID
+          )
+        end
+
+      class ByCancelationToken < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::CancelJourneyRequest::ByCancelationToken,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :cancelation_token
+
+        sig { params(cancelation_token: String).returns(T.attached_class) }
+        def self.new(cancelation_token:)
+        end
+
+        sig { override.returns({ cancelation_token: String }) }
+        def to_hash
+        end
+      end
+
+      class ByRunID < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::CancelJourneyRequest::ByRunID,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :run_id
+
+        sig { params(run_id: String).returns(T.attached_class) }
+        def self.new(run_id:)
+        end
+
+        sig { override.returns({ run_id: String }) }
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(T::Array[Courier::CancelJourneyRequest::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/cancel_journey_response.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+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 }`.
+    module CancelJourneyResponse
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::CancelJourneyResponse::TokenBranch,
+            Courier::CancelJourneyResponse::RunIDBranch
+          )
+        end
+
+      class TokenBranch < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::CancelJourneyResponse::TokenBranch,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :cancelation_token
+
+        sig { params(cancelation_token: String).returns(T.attached_class) }
+        def self.new(cancelation_token:)
+        end
+
+        sig { override.returns({ cancelation_token: String }) }
+        def to_hash
+        end
+      end
+
+      class RunIDBranch < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::CancelJourneyResponse::RunIDBranch,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :run_id
+
+        # 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.
+        sig { returns(String) }
+        attr_accessor :status
+
+        sig { params(run_id: String, status: String).returns(T.attached_class) }
+        def self.new(
+          run_id:,
+          # 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.
+          status:
+        )
+        end
+
+        sig { override.returns({ run_id: String, status: String }) }
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(T::Array[Courier::CancelJourneyResponse::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_cancel_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyCancelParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyCancelParams, 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

data/rbi/courier/models/journey_experiment.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyExperiment < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyExperiment, Courier::Internal::AnyHash)
+        end
+
+      # The value used to deterministically assign a recipient to a variant. Must be
+      # non-empty with no leading or trailing whitespace.
+      sig { returns(String) }
+      attr_accessor :bucketing_key
+
+      # Between 2 and 10 weighted template variants.
+      sig { returns(T::Array[Courier::JourneyExperimentVariant]) }
+      attr_accessor :variants
+
+      # Unique experiment id (prefixed `exp_`). Omit to have one generated
+      # automatically; when supplied it must be a valid `exp_` id.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Optional display name for the experiment.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # 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`.
+      sig do
+        params(
+          bucketing_key: String,
+          variants: T::Array[Courier::JourneyExperimentVariant::OrHash],
+          id: String,
+          name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The value used to deterministically assign a recipient to a variant. Must be
+        # non-empty with no leading or trailing whitespace.
+        bucketing_key:,
+        # Between 2 and 10 weighted template variants.
+        variants:,
+        # Unique experiment id (prefixed `exp_`). Omit to have one generated
+        # automatically; when supplied it must be a valid `exp_` id.
+        id: nil,
+        # Optional display name for the experiment.
+        name: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            bucketing_key: String,
+            variants: T::Array[Courier::JourneyExperimentVariant],
+            id: String,
+            name: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_experiment_variant.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyExperimentVariant < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyExperimentVariant, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The notification template sent for this variant.
+      sig { returns(String) }
+      attr_accessor :template_id
+
+      # Relative routing weight. Must be non-negative.
+      sig { returns(Float) }
+      attr_accessor :weight
+
+      # Optional display name for the variant.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # 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.
+      sig do
+        params(
+          id: String,
+          template_id: String,
+          weight: Float,
+          name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # The notification template sent for this variant.
+        template_id:,
+        # Relative routing weight. Must be non-negative.
+        weight:,
+        # Optional display name for the variant.
+        name: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, template_id: String, weight: Float, name: String }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end