trycourier 4.7.0 → 4.8.0

data/rbi/courier/models/journey_list_params.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyListParams, Courier::Internal::AnyHash)
+        end
+
+      # A cursor token for pagination. Use the cursor from the previous response to
+      # fetch the next page of results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # The version of journeys to retrieve. Accepted values are published (for
+      # published journeys) or draft (for draft journeys). Defaults to published.
+      sig { returns(T.nilable(Courier::JourneyListParams::Version::OrSymbol)) }
+      attr_reader :version
+
+      sig do
+        params(version: Courier::JourneyListParams::Version::OrSymbol).void
+      end
+      attr_writer :version
+
+      sig do
+        params(
+          cursor: String,
+          version: Courier::JourneyListParams::Version::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A cursor token for pagination. Use the cursor from the previous response to
+        # fetch the next page of results.
+        cursor: nil,
+        # The version of journeys to retrieve. Accepted values are published (for
+        # published journeys) or draft (for draft journeys). Defaults to published.
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            version: Courier::JourneyListParams::Version::OrSymbol,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The version of journeys to retrieve. Accepted values are published (for
+      # published journeys) or draft (for draft journeys). Defaults to published.
+      module Version
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::JourneyListParams::Version) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PUBLISHED =
+          T.let(:published, Courier::JourneyListParams::Version::TaggedSymbol)
+        DRAFT = T.let(:draft, Courier::JourneyListParams::Version::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneyListParams::Version::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys_invoke_request.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneysInvokeRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneysInvokeRequest, Courier::Internal::AnyHash)
+        end
+
+      # Data payload passed to the journey. The expected shape can be predefined using
+      # the schema builder in the journey editor. This data is available in journey
+      # steps for condition evaluation and template variable interpolation. Can also
+      # contain user identifiers (user_id, userId, anonymousId) if not provided
+      # elsewhere.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :data
+
+      sig { params(data: T::Hash[Symbol, T.anything]).void }
+      attr_writer :data
+
+      # Profile data for the user. Can contain contact information (email,
+      # phone_number), user identifiers (user_id, userId, anonymousId), or any custom
+      # profile fields. Profile fields are merged with any existing stored profile for
+      # the user. Include context.tenant_id to load a tenant-scoped profile for
+      # multi-tenant scenarios.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :profile
+
+      sig { params(profile: T::Hash[Symbol, T.anything]).void }
+      attr_writer :profile
+
+      # A unique identifier for the user. If not provided, the system will attempt to
+      # resolve the user identifier from profile or data objects.
+      sig { returns(T.nilable(String)) }
+      attr_reader :user_id
+
+      sig { params(user_id: String).void }
+      attr_writer :user_id
+
+      # Request body for invoking a journey. Requires either a user identifier or a
+      # profile with contact information. User identifiers can be provided via user_id
+      # field, or resolved from profile/data objects (user_id, userId, or anonymousId
+      # fields).
+      sig do
+        params(
+          data: T::Hash[Symbol, T.anything],
+          profile: T::Hash[Symbol, T.anything],
+          user_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Data payload passed to the journey. The expected shape can be predefined using
+        # the schema builder in the journey editor. This data is available in journey
+        # steps for condition evaluation and template variable interpolation. Can also
+        # contain user identifiers (user_id, userId, anonymousId) if not provided
+        # elsewhere.
+        data: nil,
+        # Profile data for the user. Can contain contact information (email,
+        # phone_number), user identifiers (user_id, userId, anonymousId), or any custom
+        # profile fields. Profile fields are merged with any existing stored profile for
+        # the user. Include context.tenant_id to load a tenant-scoped profile for
+        # multi-tenant scenarios.
+        profile: nil,
+        # A unique identifier for the user. If not provided, the system will attempt to
+        # resolve the user identifier from profile or data objects.
+        user_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Hash[Symbol, T.anything],
+            profile: T::Hash[Symbol, T.anything],
+            user_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys_invoke_response.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneysInvokeResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneysInvokeResponse, Courier::Internal::AnyHash)
+        end
+
+      # A unique identifier for the journey run that was created.
+      sig { returns(String) }
+      attr_accessor :run_id
+
+      sig { params(run_id: String).returns(T.attached_class) }
+      def self.new(
+        # A unique identifier for the journey run that was created.
+        run_id:
+      )
+      end
+
+      sig { override.returns({ run_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys_list_response.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneysListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneysListResponse, Courier::Internal::AnyHash)
+        end
+
+      # A cursor token for pagination. Present when there are more results available.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      sig { returns(T.nilable(T::Array[Courier::Journey])) }
+      attr_reader :templates
+
+      sig { params(templates: T::Array[Courier::Journey::OrHash]).void }
+      attr_writer :templates
+
+      sig do
+        params(
+          cursor: String,
+          templates: T::Array[Courier::Journey::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A cursor token for pagination. Present when there are more results available.
+        cursor: nil,
+        templates: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { cursor: String, templates: T::Array[Courier::Journey] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/list_delete_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::ListDeleteParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :list_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          list_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(list_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { list_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/list_restore_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::ListRestoreParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :list_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          list_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(list_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { list_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/list_retrieve_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::ListRetrieveParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :list_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          list_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(list_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { list_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/list_update_params.rbi

@@ -11,6 +11,9 @@ module Courier
           T.any(Courier::ListUpdateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :list_id
+
       sig { returns(String) }
       attr_accessor :name
 
@@ -26,17 +29,19 @@ module Courier
 
       sig do
         params(
+          list_id: String,
           name: String,
           preferences: T.nilable(Courier::RecipientPreferences::OrHash),
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(name:, preferences: nil, request_options: {})
+      def self.new(list_id:, name:, preferences: nil, request_options: {})
       end
 
       sig do
         override.returns(
           {
+            list_id: String,
             name: String,
             preferences: T.nilable(Courier::RecipientPreferences),
             request_options: Courier::RequestOptions

data/rbi/courier/models/lists/subscription_add_params.rbi

@@ -15,21 +15,26 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :list_id
+
         sig { returns(T::Array[Courier::PutSubscriptionsRecipient]) }
         attr_accessor :recipients
 
         sig do
           params(
+            list_id: String,
             recipients: T::Array[Courier::PutSubscriptionsRecipient::OrHash],
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(recipients:, request_options: {})
+        def self.new(list_id:, recipients:, request_options: {})
         end
 
         sig do
           override.returns(
             {
+              list_id: String,
               recipients: T::Array[Courier::PutSubscriptionsRecipient],
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/lists/subscription_list_params.rbi

@@ -15,17 +15,22 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :list_id
+
         # A unique identifier that allows for fetching the next set of list subscriptions
         sig { returns(T.nilable(String)) }
         attr_accessor :cursor
 
         sig do
           params(
+            list_id: String,
             cursor: T.nilable(String),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          list_id:,
           # A unique identifier that allows for fetching the next set of list subscriptions
           cursor: nil,
           request_options: {}
@@ -35,6 +40,7 @@ module Courier
         sig do
           override.returns(
             {
+              list_id: String,
               cursor: T.nilable(String),
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/lists/subscription_subscribe_params.rbi

@@ -15,21 +15,26 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :list_id
+
         sig { returns(T::Array[Courier::PutSubscriptionsRecipient]) }
         attr_accessor :recipients
 
         sig do
           params(
+            list_id: String,
             recipients: T::Array[Courier::PutSubscriptionsRecipient::OrHash],
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(recipients:, request_options: {})
+        def self.new(list_id:, recipients:, request_options: {})
         end
 
         sig do
           override.returns(
             {
+              list_id: String,
               recipients: T::Array[Courier::PutSubscriptionsRecipient],
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/lists/subscription_subscribe_user_params.rbi

@@ -18,6 +18,9 @@ module Courier
         sig { returns(String) }
         attr_accessor :list_id
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         sig { returns(T.nilable(Courier::RecipientPreferences)) }
         attr_reader :preferences
 
@@ -31,17 +34,19 @@ module Courier
         sig do
           params(
             list_id: String,
+            user_id: String,
             preferences: T.nilable(Courier::RecipientPreferences::OrHash),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(list_id:, preferences: nil, request_options: {})
+        def self.new(list_id:, user_id:, preferences: nil, request_options: {})
         end
 
         sig do
           override.returns(
             {
               list_id: String,
+              user_id: String,
               preferences: T.nilable(Courier::RecipientPreferences),
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/lists/subscription_unsubscribe_user_params.rbi

@@ -18,18 +18,26 @@ module Courier
         sig { returns(String) }
         attr_accessor :list_id
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         sig do
           params(
             list_id: String,
+            user_id: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(list_id:, request_options: {})
+        def self.new(list_id:, user_id:, request_options: {})
         end
 
         sig do
           override.returns(
-            { list_id: String, request_options: Courier::RequestOptions }
+            {
+              list_id: String,
+              user_id: String,
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/courier/models/message_cancel_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::MessageCancelParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :message_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          message_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(message_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { message_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/message_content_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::MessageContentParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :message_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          message_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(message_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { message_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end