trycourier 4.7.0 → 4.8.0

data/lib/courier/models/elemental_content.rb

@@ -14,17 +14,10 @@ module Courier
       #   @return [String]
       required :version, String
 
-      # @!attribute brand
-      #
-      #   @return [String, nil]
-      optional :brand, String, nil?: true
-
-      # @!method initialize(elements:, version:, brand: nil)
+      # @!method initialize(elements:, version:)
       #   @param elements [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType>]
       #
       #   @param version [String] For example, "2022-01-01"
-      #
-      #   @param brand [String, nil]
     end
   end
 end

data/lib/courier/models/journey.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class Journey < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier of the journey.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute name
+      #   The name of the journey.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute version
+      #   The version of the journey (published or draft).
+      #
+      #   @return [Symbol, Courier::Models::Journey::Version]
+      required :version, enum: -> { Courier::Journey::Version }
+
+      # @!attribute created_at
+      #   ISO 8601 timestamp when the journey was created.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute updated_at
+      #   ISO 8601 timestamp when the journey was last updated.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!method initialize(id:, name:, version:, created_at: nil, updated_at: nil)
+      #   A journey template representing an automation workflow.
+      #
+      #   @param id [String] The unique identifier of the journey.
+      #
+      #   @param name [String] The name of the journey.
+      #
+      #   @param version [Symbol, Courier::Models::Journey::Version] The version of the journey (published or draft).
+      #
+      #   @param created_at [Time] ISO 8601 timestamp when the journey was created.
+      #
+      #   @param updated_at [Time] ISO 8601 timestamp when the journey was last updated.
+
+      # The version of the journey (published or draft).
+      #
+      # @see Courier::Models::Journey#version
+      module Version
+        extend Courier::Internal::Type::Enum
+
+        PUBLISHED = :published
+        DRAFT = :draft
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_invoke_params.rb

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

data/lib/courier/models/journey_list_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#list
+    class JourneyListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   A cursor token for pagination. Use the cursor from the previous response to
+      #   fetch the next page of results.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute version
+      #   The version of journeys to retrieve. Accepted values are published (for
+      #   published journeys) or draft (for draft journeys). Defaults to published.
+      #
+      #   @return [Symbol, Courier::Models::JourneyListParams::Version, nil]
+      optional :version, enum: -> { Courier::JourneyListParams::Version }
+
+      # @!method initialize(cursor: nil, version: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyListParams} for more details.
+      #
+      #   @param cursor [String] A cursor token for pagination. Use the cursor from the previous response to fetc
+      #
+      #   @param version [Symbol, Courier::Models::JourneyListParams::Version] The version of journeys to retrieve. Accepted values are published (for publishe
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+
+      # 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
+
+        PUBLISHED = :published
+        DRAFT = :draft
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys_invoke_request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneysInvokeRequest < Courier::Internal::Type::BaseModel
+      # @!attribute data
+      #   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.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute profile
+      #   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.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute user_id
+      #   A unique identifier for the user. If not provided, the system will attempt to
+      #   resolve the user identifier from profile or data objects.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(data: nil, profile: nil, user_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneysInvokeRequest} for more details.
+      #
+      #   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).
+      #
+      #   @param data [Hash{Symbol=>Object}] Data payload passed to the journey. The expected shape can be predefined using t
+      #
+      #   @param profile [Hash{Symbol=>Object}] Profile data for the user. Can contain contact information (email, phone_number)
+      #
+      #   @param user_id [String] A unique identifier for the user. If not provided, the system will attempt to re
+    end
+  end
+end

data/lib/courier/models/journeys_invoke_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#invoke
+    class JourneysInvokeResponse < Courier::Internal::Type::BaseModel
+      # @!attribute run_id
+      #   A unique identifier for the journey run that was created.
+      #
+      #   @return [String]
+      required :run_id, String, api_name: :runId
+
+      # @!method initialize(run_id:)
+      #   @param run_id [String] A unique identifier for the journey run that was created.
+    end
+  end
+end

data/lib/courier/models/journeys_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#list
+    class JourneysListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute cursor
+      #   A cursor token for pagination. Present when there are more results available.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute templates
+      #
+      #   @return [Array<Courier::Models::Journey>, nil]
+      optional :templates, -> { Courier::Internal::Type::ArrayOf[Courier::Journey] }
+
+      # @!method initialize(cursor: nil, templates: nil)
+      #   @param cursor [String] A cursor token for pagination. Present when there are more results available.
+      #
+      #   @param templates [Array<Courier::Models::Journey>]
+    end
+  end
+end

data/lib/courier/models/list_delete_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute list_id
+      #
+      #   @return [String]
+      required :list_id, String
+
+      # @!method initialize(list_id:, request_options: {})
+      #   @param list_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/list_restore_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute list_id
+      #
+      #   @return [String]
+      required :list_id, String
+
+      # @!method initialize(list_id:, request_options: {})
+      #   @param list_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/list_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute list_id
+      #
+      #   @return [String]
+      required :list_id, String
+
+      # @!method initialize(list_id:, request_options: {})
+      #   @param list_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/list_update_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute list_id
+      #
+      #   @return [String]
+      required :list_id, String
+
       # @!attribute name
       #
       #   @return [String]
@@ -17,7 +22,8 @@ module Courier
       #   @return [Courier::Models::RecipientPreferences, nil]
       optional :preferences, -> { Courier::RecipientPreferences }, nil?: true
 
-      # @!method initialize(name:, preferences: nil, request_options: {})
+      # @!method initialize(list_id:, name:, preferences: nil, request_options: {})
+      #   @param list_id [String]
       #   @param name [String]
       #   @param preferences [Courier::Models::RecipientPreferences, nil]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/lists/subscription_add_params.rb

@@ -8,12 +8,18 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute list_id
+        #
+        #   @return [String]
+        required :list_id, String
+
         # @!attribute recipients
         #
         #   @return [Array<Courier::Models::PutSubscriptionsRecipient>]
         required :recipients, -> { Courier::Internal::Type::ArrayOf[Courier::PutSubscriptionsRecipient] }
 
-        # @!method initialize(recipients:, request_options: {})
+        # @!method initialize(list_id:, recipients:, request_options: {})
+        #   @param list_id [String]
         #   @param recipients [Array<Courier::Models::PutSubscriptionsRecipient>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/lists/subscription_list_params.rb

@@ -8,13 +8,20 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute list_id
+        #
+        #   @return [String]
+        required :list_id, String
+
         # @!attribute cursor
         #   A unique identifier that allows for fetching the next set of list subscriptions
         #
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!method initialize(cursor: nil, request_options: {})
+        # @!method initialize(list_id:, cursor: nil, request_options: {})
+        #   @param list_id [String]
+        #
         #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of list subscriptions
         #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/lists/subscription_subscribe_params.rb

@@ -8,12 +8,18 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute list_id
+        #
+        #   @return [String]
+        required :list_id, String
+
         # @!attribute recipients
         #
         #   @return [Array<Courier::Models::PutSubscriptionsRecipient>]
         required :recipients, -> { Courier::Internal::Type::ArrayOf[Courier::PutSubscriptionsRecipient] }
 
-        # @!method initialize(recipients:, request_options: {})
+        # @!method initialize(list_id:, recipients:, request_options: {})
+        #   @param list_id [String]
         #   @param recipients [Array<Courier::Models::PutSubscriptionsRecipient>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/lists/subscription_subscribe_user_params.rb

@@ -13,13 +13,19 @@ module Courier
         #   @return [String]
         required :list_id, String
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute preferences
         #
         #   @return [Courier::Models::RecipientPreferences, nil]
         optional :preferences, -> { Courier::RecipientPreferences }, nil?: true
 
-        # @!method initialize(list_id:, preferences: nil, request_options: {})
+        # @!method initialize(list_id:, user_id:, preferences: nil, request_options: {})
         #   @param list_id [String]
+        #   @param user_id [String]
         #   @param preferences [Courier::Models::RecipientPreferences, nil]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/lists/subscription_unsubscribe_user_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :list_id, String
 
-        # @!method initialize(list_id:, request_options: {})
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(list_id:, user_id:, request_options: {})
         #   @param list_id [String]
+        #   @param user_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/message_cancel_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/message_content_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/message_details.rb

@@ -11,20 +11,6 @@ module Courier
       #   @return [String]
       required :id, String
 
-      # @!attribute clicked
-      #   A UTC timestamp at which the recipient clicked on a tracked link for the first
-      #   time. Stored as a millisecond representation of the Unix epoch.
-      #
-      #   @return [Integer]
-      required :clicked, Integer
-
-      # @!attribute delivered
-      #   A UTC timestamp at which the Integration provider delivered the message. Stored
-      #   as a millisecond representation of the Unix epoch.
-      #
-      #   @return [Integer]
-      required :delivered, Integer
-
       # @!attribute enqueued
       #   A UTC timestamp at which Courier received the message request. Stored as a
       #   millisecond representation of the Unix epoch.
@@ -44,71 +30,85 @@ module Courier
       #   @return [String]
       required :notification, String
 
-      # @!attribute opened
-      #   A UTC timestamp at which the recipient opened a message for the first time.
-      #   Stored as a millisecond representation of the Unix epoch.
-      #
-      #   @return [Integer]
-      required :opened, Integer
-
       # @!attribute recipient
       #   A unique identifier associated with the recipient of the delivered message.
       #
       #   @return [String]
       required :recipient, String
 
-      # @!attribute sent
-      #   A UTC timestamp at which Courier passed the message to the Integration provider.
-      #   Stored as a millisecond representation of the Unix epoch.
-      #
-      #   @return [Integer]
-      required :sent, Integer
-
       # @!attribute status
       #   The current status of the message.
       #
       #   @return [Symbol, Courier::Models::MessageDetails::Status]
       required :status, enum: -> { Courier::MessageDetails::Status }
 
+      # @!attribute clicked
+      #   A UTC timestamp at which the recipient clicked on a tracked link for the first
+      #   time. Stored as a millisecond representation of the Unix epoch.
+      #
+      #   @return [Integer, nil]
+      optional :clicked, Integer
+
+      # @!attribute delivered
+      #   A UTC timestamp at which the Integration provider delivered the message. Stored
+      #   as a millisecond representation of the Unix epoch.
+      #
+      #   @return [Integer, nil]
+      optional :delivered, Integer
+
       # @!attribute error
       #   A message describing the error that occurred.
       #
       #   @return [String, nil]
       optional :error, String, nil?: true
 
+      # @!attribute opened
+      #   A UTC timestamp at which the recipient opened a message for the first time.
+      #   Stored as a millisecond representation of the Unix epoch.
+      #
+      #   @return [Integer, nil]
+      optional :opened, Integer
+
       # @!attribute reason
       #   The reason for the current status of the message.
       #
       #   @return [Symbol, Courier::Models::MessageDetails::Reason, nil]
       optional :reason, enum: -> { Courier::MessageDetails::Reason }, nil?: true
 
-      # @!method initialize(id:, clicked:, delivered:, enqueued:, event:, notification:, opened:, recipient:, sent:, status:, error: nil, reason: nil)
+      # @!attribute sent
+      #   A UTC timestamp at which Courier passed the message to the Integration provider.
+      #   Stored as a millisecond representation of the Unix epoch.
+      #
+      #   @return [Integer, nil]
+      optional :sent, Integer
+
+      # @!method initialize(id:, enqueued:, event:, notification:, recipient:, status:, clicked: nil, delivered: nil, error: nil, opened: nil, reason: nil, sent: nil)
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::MessageDetails} for more details.
       #
       #   @param id [String] A unique identifier associated with the message you wish to retrieve (results fr
       #
-      #   @param clicked [Integer] A UTC timestamp at which the recipient clicked on a tracked link for the first t
-      #
-      #   @param delivered [Integer] A UTC timestamp at which the Integration provider delivered the message. Stored
-      #
       #   @param enqueued [Integer] A UTC timestamp at which Courier received the message request. Stored as a milli
       #
       #   @param event [String] A unique identifier associated with the event of the delivered message.
       #
       #   @param notification [String] A unique identifier associated with the notification of the delivered message.
       #
-      #   @param opened [Integer] A UTC timestamp at which the recipient opened a message for the first time. Stor
-      #
       #   @param recipient [String] A unique identifier associated with the recipient of the delivered message.
       #
-      #   @param sent [Integer] A UTC timestamp at which Courier passed the message to the Integration provider.
-      #
       #   @param status [Symbol, Courier::Models::MessageDetails::Status] The current status of the message.
       #
+      #   @param clicked [Integer] A UTC timestamp at which the recipient clicked on a tracked link for the first t
+      #
+      #   @param delivered [Integer] A UTC timestamp at which the Integration provider delivered the message. Stored
+      #
       #   @param error [String, nil] A message describing the error that occurred.
       #
+      #   @param opened [Integer] A UTC timestamp at which the recipient opened a message for the first time. Stor
+      #
       #   @param reason [Symbol, Courier::Models::MessageDetails::Reason, nil] The reason for the current status of the message.
+      #
+      #   @param sent [Integer] A UTC timestamp at which Courier passed the message to the Integration provider.
 
       # The current status of the message.
       #

data/lib/courier/models/message_history_params.rb

@@ -7,13 +7,20 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
       # @!attribute type
       #   A supported Message History type that will filter the events returned.
       #
       #   @return [String, nil]
       optional :type, String, nil?: true
 
-      # @!method initialize(type: nil, request_options: {})
+      # @!method initialize(message_id:, type: nil, request_options: {})
+      #   @param message_id [String]
+      #
       #   @param type [String, nil] A supported Message History type that will filter the events returned.
       #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/message_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
+      # @!method initialize(message_id:, request_options: {})
+      #   @param message_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/notification_retrieve_content_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/notifications/check_delete_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :id, String
 
-        # @!method initialize(id:, request_options: {})
+        # @!attribute submission_id
+        #
+        #   @return [String]
+        required :submission_id, String
+
+        # @!method initialize(id:, submission_id:, request_options: {})
         #   @param id [String]
+        #   @param submission_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/notifications/check_list_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :id, String
 
-        # @!method initialize(id:, request_options: {})
+        # @!attribute submission_id
+        #
+        #   @return [String]
+        required :submission_id, String
+
+        # @!method initialize(id:, submission_id:, request_options: {})
         #   @param id [String]
+        #   @param submission_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end