trycourier 4.17.0 → 4.18.0

data/rbi/courier/resources/{preference_sections → workspace_preferences}/topics.rbi

@@ -2,20 +2,21 @@
 
 module Courier
   module Resources
-    class PreferenceSections
+    class WorkspacePreferences
       class Topics
-        # Create a subscription preference topic inside a section. Fails with 404 if the
-        # section does not exist. The topic id is generated and returned.
+        # Create a subscription preference topic inside a workspace preference. Fails with
+        # 404 if the workspace preference does not exist. The topic id is generated and
+        # returned.
         sig do
           params(
             section_id: String,
             default_status:
-              Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
+              Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
             name: String,
             allowed_preferences:
               T.nilable(
                 T::Array[
-                  Courier::PreferenceTopicCreateRequest::AllowedPreference::OrSymbol
+                  Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::OrSymbol
                 ]
               ),
             include_unsubscribe_header: T.nilable(T::Boolean),
@@ -23,10 +24,10 @@ module Courier
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
             topic_data: T.nilable(T::Hash[Symbol, T.anything]),
             request_options: Courier::RequestOptions::OrHash
-          ).returns(Courier::PreferenceTopicGetResponse)
+          ).returns(Courier::WorkspacePreferenceTopicGetResponse)
         end
         def create(
-          # Id of the preference section to create the topic in.
+          # Id of the workspace preference to create the topic in.
           section_id,
           # The default subscription status applied when a recipient has not set their own.
           default_status:,
@@ -45,39 +46,41 @@ module Courier
         )
         end
 
-        # Retrieve a topic within a section. Returns 404 if the section does not exist,
-        # the topic does not exist, or the topic belongs to a different section.
+        # Retrieve a topic within a workspace preference. Returns 404 if the workspace
+        # preference does not exist, the topic does not exist, or the topic belongs to a
+        # different workspace preference.
         sig do
           params(
             topic_id: String,
             section_id: String,
             request_options: Courier::RequestOptions::OrHash
-          ).returns(Courier::PreferenceTopicGetResponse)
+          ).returns(Courier::WorkspacePreferenceTopicGetResponse)
         end
         def retrieve(
           # Id of the subscription preference topic.
           topic_id,
-          # Id of the preference section.
+          # Id of the workspace preference.
           section_id:,
           request_options: {}
         )
         end
 
-        # List the topics in a preference section.
+        # List the topics in a workspace preference.
         sig do
           params(
             section_id: String,
             request_options: Courier::RequestOptions::OrHash
-          ).returns(Courier::PreferenceTopicListResponse)
+          ).returns(Courier::WorkspacePreferenceTopicListResponse)
         end
         def list(
-          # Id of the preference section.
+          # Id of the workspace preference.
           section_id,
           request_options: {}
         )
         end
 
-        # Archive a topic and remove it from its section. Same 404 rules as GET.
+        # Archive a topic and remove it from its workspace preference. Same 404 rules as
+        # GET.
         sig do
           params(
             topic_id: String,
@@ -88,25 +91,25 @@ module Courier
         def archive(
           # Id of the subscription preference topic.
           topic_id,
-          # Id of the preference section.
+          # Id of the workspace preference.
           section_id:,
           request_options: {}
         )
         end
 
-        # Replace a topic within a section. Full document replacement; missing optional
-        # fields are cleared. Same 404 rules as GET.
+        # Replace a topic within a workspace preference. Full document replacement;
+        # missing optional fields are cleared. Same 404 rules as GET.
         sig do
           params(
             topic_id: String,
             section_id: String,
             default_status:
-              Courier::PreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
+              Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
             name: String,
             allowed_preferences:
               T.nilable(
                 T::Array[
-                  Courier::PreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
+                  Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
                 ]
               ),
             include_unsubscribe_header: T.nilable(T::Boolean),
@@ -114,12 +117,12 @@ module Courier
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
             topic_data: T.nilable(T::Hash[Symbol, T.anything]),
             request_options: Courier::RequestOptions::OrHash
-          ).returns(Courier::PreferenceTopicGetResponse)
+          ).returns(Courier::WorkspacePreferenceTopicGetResponse)
         end
         def replace(
           # Path param: Id of the subscription preference topic.
           topic_id,
-          # Path param: Id of the preference section.
+          # Path param: Id of the workspace preference.
           section_id:,
           # Body param: The default subscription status applied when a recipient has not set
           # their own.

data/rbi/courier/resources/{preference_sections.rbi → workspace_preferences.rbi}

@@ -2,12 +2,12 @@
 
 module Courier
   module Resources
-    class PreferenceSections
-      sig { returns(Courier::Resources::PreferenceSections::Topics) }
+    class WorkspacePreferences
+      sig { returns(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.
       sig do
         params(
@@ -16,45 +16,45 @@ module Courier
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::PreferenceSectionGetResponse)
+        ).returns(Courier::WorkspacePreferenceGetResponse)
       end
       def create(
-        # Human-readable name for the section.
+        # Human-readable name for the workspace preference.
         name:,
-        # Whether the section defines custom routing for its topics.
+        # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
-        # Default channels for the section. Defaults to empty if omitted.
+        # Default channels for the workspace preference. Defaults to empty if omitted.
         routing_options: nil,
         request_options: {}
       )
       end
 
-      # Retrieve a preference section by id, including its topics.
+      # Retrieve a workspace preference by id, including its topics.
       sig do
         params(
           section_id: String,
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::PreferenceSectionGetResponse)
+        ).returns(Courier::WorkspacePreferenceGetResponse)
       end
       def retrieve(
-        # Id of the preference section.
+        # Id of the workspace preference.
         section_id,
         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.
       sig do
         params(request_options: Courier::RequestOptions::OrHash).returns(
-          Courier::PreferenceSectionListResponse
+          Courier::WorkspacePreferenceListResponse
         )
       end
       def list(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.
       sig do
         params(
           section_id: String,
@@ -62,15 +62,15 @@ module Courier
         ).void
       end
       def archive(
-        # Id of the preference section.
+        # Id of the workspace preference.
         section_id,
         request_options: {}
       )
       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).
       sig do
         params(request_options: Courier::RequestOptions::OrHash).returns(
           Courier::PublishPreferencesResponse
@@ -79,8 +79,8 @@ module Courier
       def publish(request_options: {})
       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.
       sig do
         params(
           section_id: String,
@@ -89,16 +89,16 @@ module Courier
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::PreferenceSectionGetResponse)
+        ).returns(Courier::WorkspacePreferenceGetResponse)
       end
       def replace(
-        # Id of the preference section.
+        # Id of the workspace preference.
         section_id,
-        # Human-readable name for the section.
+        # Human-readable name for the workspace preference.
         name:,
-        # Whether the section defines custom routing for its topics.
+        # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
-        # Default channels for the section. Omit to clear.
+        # Default channels for the workspace preference. Omit to clear.
         routing_options: nil,
         request_options: {}
       )

data/sig/courier/client.rbs

@@ -42,7 +42,7 @@ module Courier
 
     attr_reader routing_strategies: Courier::Resources::RoutingStrategies
 
-    attr_reader preference_sections: Courier::Resources::PreferenceSections
+    attr_reader workspace_preferences: Courier::Resources::WorkspacePreferences
 
     attr_reader profiles: Courier::Resources::Profiles
 

data/sig/courier/models/cancel_journey_request.rbs

@@ -0,0 +1,33 @@
+module Courier
+  module Models
+    type cancel_journey_request =
+      Courier::CancelJourneyRequest::ByCancelationToken
+      | Courier::CancelJourneyRequest::ByRunID
+
+    module CancelJourneyRequest
+      extend Courier::Internal::Type::Union
+
+      type by_cancelation_token = { cancelation_token: String }
+
+      class ByCancelationToken < Courier::Internal::Type::BaseModel
+        attr_accessor cancelation_token: String
+
+        def initialize: (cancelation_token: String) -> void
+
+        def to_hash: -> { cancelation_token: String }
+      end
+
+      type by_run_id = { run_id: String }
+
+      class ByRunID < Courier::Internal::Type::BaseModel
+        attr_accessor run_id: String
+
+        def initialize: (run_id: String) -> void
+
+        def to_hash: -> { run_id: String }
+      end
+
+      def self?.variants: -> ::Array[Courier::Models::cancel_journey_request]
+    end
+  end
+end

data/sig/courier/models/cancel_journey_response.rbs

@@ -0,0 +1,35 @@
+module Courier
+  module Models
+    type cancel_journey_response =
+      Courier::CancelJourneyResponse::TokenBranch
+      | Courier::CancelJourneyResponse::RunIDBranch
+
+    module CancelJourneyResponse
+      extend Courier::Internal::Type::Union
+
+      type token_branch = { cancelation_token: String }
+
+      class TokenBranch < Courier::Internal::Type::BaseModel
+        attr_accessor cancelation_token: String
+
+        def initialize: (cancelation_token: String) -> void
+
+        def to_hash: -> { cancelation_token: String }
+      end
+
+      type run_id_branch = { run_id: String, status: String }
+
+      class RunIDBranch < Courier::Internal::Type::BaseModel
+        attr_accessor run_id: String
+
+        attr_accessor status: String
+
+        def initialize: (run_id: String, status: String) -> void
+
+        def to_hash: -> { run_id: String, status: String }
+      end
+
+      def self?.variants: -> ::Array[Courier::Models::cancel_journey_response]
+    end
+  end
+end

data/sig/courier/models/{preference_section_list_params.rbs → journey_cancel_params.rbs}

@@ -1,9 +1,9 @@
 module Courier
   module Models
-    type preference_section_list_params =
+    type journey_cancel_params =
       {  } & Courier::Internal::Type::request_parameters
 
-    class PreferenceSectionListParams < Courier::Internal::Type::BaseModel
+    class JourneyCancelParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/sig/courier/models/journey_experiment.rbs

@@ -0,0 +1,39 @@
+module Courier
+  module Models
+    type journey_experiment =
+      {
+        bucketing_key: String,
+        variants: ::Array[Courier::JourneyExperimentVariant],
+        id: String,
+        name: String
+      }
+
+    class JourneyExperiment < Courier::Internal::Type::BaseModel
+      attr_accessor bucketing_key: String
+
+      attr_accessor variants: ::Array[Courier::JourneyExperimentVariant]
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      def initialize: (
+        bucketing_key: String,
+        variants: ::Array[Courier::JourneyExperimentVariant],
+        ?id: String,
+        ?name: String
+      ) -> void
+
+      def to_hash: -> {
+        bucketing_key: String,
+        variants: ::Array[Courier::JourneyExperimentVariant],
+        id: String,
+        name: String
+      }
+    end
+  end
+end

data/sig/courier/models/journey_experiment_variant.rbs

@@ -0,0 +1,32 @@
+module Courier
+  module Models
+    type journey_experiment_variant =
+      { id: String, template_id: String, weight: Float, name: String }
+
+    class JourneyExperimentVariant < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor template_id: String
+
+      attr_accessor weight: Float
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      def initialize: (
+        id: String,
+        template_id: String,
+        weight: Float,
+        ?name: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        template_id: String,
+        weight: Float,
+        name: String
+      }
+    end
+  end
+end

data/sig/courier/models/journey_send_node.rbs

@@ -5,7 +5,8 @@ module Courier
         message: Courier::JourneySendNode::Message,
         type: Courier::Models::JourneySendNode::type_,
         id: String,
-        conditions: Courier::Models::journey_conditions_field
+        conditions: Courier::Models::journey_conditions_field,
+        experiment: Courier::JourneyExperiment
       }
 
     class JourneySendNode < Courier::Internal::Type::BaseModel
@@ -23,31 +24,37 @@ module Courier
         Courier::Models::journey_conditions_field
       ) -> Courier::Models::journey_conditions_field
 
+      attr_reader experiment: Courier::JourneyExperiment?
+
+      def experiment=: (
+        Courier::JourneyExperiment
+      ) -> Courier::JourneyExperiment
+
       def initialize: (
         message: Courier::JourneySendNode::Message,
         type: Courier::Models::JourneySendNode::type_,
         ?id: String,
-        ?conditions: Courier::Models::journey_conditions_field
+        ?conditions: Courier::Models::journey_conditions_field,
+        ?experiment: Courier::JourneyExperiment
       ) -> void
 
       def to_hash: -> {
         message: Courier::JourneySendNode::Message,
         type: Courier::Models::JourneySendNode::type_,
         id: String,
-        conditions: Courier::Models::journey_conditions_field
+        conditions: Courier::Models::journey_conditions_field,
+        experiment: Courier::JourneyExperiment
       }
 
       type message =
         {
-          template: String,
           data: ::Hash[Symbol, top],
           delay: Courier::JourneySendNode::Message::Delay,
+          template: String,
           to: Courier::JourneySendNode::Message::To
         }
 
       class Message < Courier::Internal::Type::BaseModel
-        attr_accessor template: String
-
         attr_reader data: ::Hash[Symbol, top]?
 
         def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
@@ -58,6 +65,10 @@ module Courier
           Courier::JourneySendNode::Message::Delay
         ) -> Courier::JourneySendNode::Message::Delay
 
+        attr_reader template: String?
+
+        def template=: (String) -> String
+
         attr_reader to: Courier::JourneySendNode::Message::To?
 
         def to=: (
@@ -65,16 +76,16 @@ module Courier
         ) -> Courier::JourneySendNode::Message::To
 
         def initialize: (
-          template: String,
           ?data: ::Hash[Symbol, top],
           ?delay: Courier::JourneySendNode::Message::Delay,
+          ?template: String,
           ?to: Courier::JourneySendNode::Message::To
         ) -> void
 
         def to_hash: -> {
-          template: String,
           data: ::Hash[Symbol, top],
           delay: Courier::JourneySendNode::Message::Delay,
+          template: String,
           to: Courier::JourneySendNode::Message::To
         }
 

data/sig/courier/models/{preference_section_retrieve_params.rbs → workspace_preference_archive_params.rbs}

@@ -1,9 +1,9 @@
 module Courier
   module Models
-    type preference_section_retrieve_params =
+    type workspace_preference_archive_params =
       { section_id: String } & Courier::Internal::Type::request_parameters
 
-    class PreferenceSectionRetrieveParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceArchiveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/sig/courier/models/workspace_preference_create_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type workspace_preference_create_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class WorkspacePreferenceCreateParams < Courier::Models::WorkspacePreferenceCreateRequest
+      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/{preference_section_replace_request.rbs → workspace_preference_create_request.rbs}

@@ -1,13 +1,13 @@
 module Courier
   module Models
-    type preference_section_replace_request =
+    type workspace_preference_create_request =
       {
         name: String,
         has_custom_routing: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?
       }
 
-    class PreferenceSectionReplaceRequest < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceCreateRequest < Courier::Internal::Type::BaseModel
       attr_accessor name: String
 
       attr_accessor has_custom_routing: bool?

data/sig/courier/models/{preference_section_get_response.rbs → workspace_preference_get_response.rbs}

@@ -1,19 +1,19 @@
 module Courier
   module Models
-    type preference_section_get_response =
+    type workspace_preference_get_response =
       {
         id: String,
         created: String,
         has_custom_routing: bool,
         name: String,
         routing_options: ::Array[Courier::Models::channel_classification],
-        topics: ::Array[Courier::PreferenceTopicGetResponse],
+        topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
         creator: String?,
         updated: String?,
         updater: String?
       }
 
-    class PreferenceSectionGetResponse < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceGetResponse < Courier::Internal::Type::BaseModel
       attr_accessor id: String
 
       attr_accessor created: String
@@ -24,7 +24,7 @@ module Courier
 
       attr_accessor routing_options: ::Array[Courier::Models::channel_classification]
 
-      attr_accessor topics: ::Array[Courier::PreferenceTopicGetResponse]
+      attr_accessor topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse]
 
       attr_accessor creator: String?
 
@@ -38,7 +38,7 @@ module Courier
         has_custom_routing: bool,
         name: String,
         routing_options: ::Array[Courier::Models::channel_classification],
-        topics: ::Array[Courier::PreferenceTopicGetResponse],
+        topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
         ?creator: String?,
         ?updated: String?,
         ?updater: String?
@@ -50,7 +50,7 @@ module Courier
         has_custom_routing: bool,
         name: String,
         routing_options: ::Array[Courier::Models::channel_classification],
-        topics: ::Array[Courier::PreferenceTopicGetResponse],
+        topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
         creator: String?,
         updated: String?,
         updater: String?

data/sig/courier/models/{preference_section_publish_params.rbs → workspace_preference_list_params.rbs}

@@ -1,9 +1,9 @@
 module Courier
   module Models
-    type preference_section_publish_params =
+    type workspace_preference_list_params =
       {  } & Courier::Internal::Type::request_parameters
 
-    class PreferenceSectionPublishParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceListParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/sig/courier/models/workspace_preference_list_response.rbs

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

data/sig/courier/models/{preference_section_create_params.rbs → workspace_preference_publish_params.rbs}

@@ -1,9 +1,9 @@
 module Courier
   module Models
-    type preference_section_create_params =
+    type workspace_preference_publish_params =
       {  } & Courier::Internal::Type::request_parameters
 
-    class PreferenceSectionCreateParams < Courier::Models::PreferenceSectionCreateRequest
+    class WorkspacePreferencePublishParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/sig/courier/models/{preference_section_replace_params.rbs → workspace_preference_replace_params.rbs}

@@ -1,9 +1,9 @@
 module Courier
   module Models
-    type preference_section_replace_params =
+    type workspace_preference_replace_params =
       { section_id: String } & Courier::Internal::Type::request_parameters
 
-    class PreferenceSectionReplaceParams < Courier::Models::PreferenceSectionReplaceRequest
+    class WorkspacePreferenceReplaceParams < Courier::Models::WorkspacePreferenceReplaceRequest
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters