trycourier 5.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e1448e2d9e9f4b3e873bd482815aa3b9fad29ecb111705b64771c6b2e7b431
-  data.tar.gz: af2e780f1a0a216e736c414e7e9753c69ad6625a45c80e2b84eae72bf611a8e3
+  metadata.gz: 62f640ccc5d992cd807b750192ee8ca02b3ffe5fa09537eeadf67ba086c518b3
+  data.tar.gz: bd638a13b9a78b54e849e76a30614bed55afbcb6e7fb7a1a2edf60a74cb1531b
 SHA512:
-  metadata.gz: 32f36d5e0b55ac49d6279347e6c762f350d814531833a5f57ff0517cbf363e2f07656154eb4bcbb3a73244045d27f5feebd98f2a8244fc1e7cc43249ca04ef76
-  data.tar.gz: 976626752ed191ad270a800c71e7123f5a6d3ca6337097713aca3b32d6ec413304c86a6ab2b251cd4a0fe2177e1c270d3067bab8637eaf1cf4bd117906c9eca8
+  metadata.gz: ed8c416e8431f1a50aa7fff01b939ba42b03acabe3a42a5a9f14da078f9dcf11bfd8cfe6cb88f642d48444aa0131c3eb9a9164fdbd6fec8a6d80d07c2f360403
+  data.tar.gz: 971c6a9a71bfdbc8faec0796d2b591d3635e55aece1ab1c208c6f68f3943a5fb39214c8a5944815b1f70f6e9912b8c77d8db2971d836116c543660a0951ef4a2

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [6.1.0](https://github.com/trycourier/courier-ruby/compare/v6.0.0...v6.1.0) (2026-08-19)
+
+
+### Features
+
+* **api:** add automation and journey run log endpoints ([#133](https://github.com/trycourier/courier-ruby/issues/133)) ([fe4a26c](https://github.com/trycourier/courier-ruby/commit/fe4a26c09d0e7f77e068f7767fe6bf3458827d85))
+* **api:** document section_id and section_name on a user's topic preference ([#132](https://github.com/trycourier/courier-ruby/issues/132)) ([86c3108](https://github.com/trycourier/courier-ruby/commit/86c31083552978e501795079b0c0a2a998403eed))
+
+
+### Chores
+
+* **api:** regenerate SDK ([#130](https://github.com/trycourier/courier-ruby/issues/130)) ([6743e28](https://github.com/trycourier/courier-ruby/commit/6743e288b0cbfb9e72635f411417d69593dc3311))
+
+## [6.0.0](https://github.com/trycourier/courier-ruby/compare/v5.0.0...v6.0.0) (2026-08-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* **api:** match the spec to the backend — apn/expo token types and the phantom notifications.duplicate ([#128](https://github.com/trycourier/courier-ruby/issues/128))
+
+### Features
+
+* **api:** match the spec to the backend — apn/expo token types and the phantom notifications.duplicate ([#128](https://github.com/trycourier/courier-ruby/issues/128)) ([5034ea3](https://github.com/trycourier/courier-ruby/commit/5034ea33f5242443ce08ef9005d3d02e9f471531))
+
 ## [5.0.0](https://github.com/trycourier/courier-ruby/compare/v4.26.2...v5.0.0) (2026-08-17)
 
 

data/README.md

@@ -9,7 +9,7 @@ Add the gem to your `Gemfile`:
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 5.0.0"
+gem "trycourier", "~> 6.1.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/courier/internal/type/union.rb

@@ -6,14 +6,14 @@ module Courier
       # @api private
       #
       # @example
-      #   # `discord` is a `Courier::Discord`
-      #   case discord
-      #   when Courier::SendToChannel
-      #     puts(discord.channel_id)
-      #   when Courier::SendDirectMessage
-      #     puts(discord.user_id)
+      #   # `apn` is a `Courier::Apn`
+      #   case apn
+      #   when Courier::Token
+      #     puts(apn.token)
+      #   when Courier::MultipleTokens
+      #     puts(apn.tokens)
       #   else
-      #     puts(discord)
+      #     puts(apn)
       #   end
       module Union
         include Courier::Internal::Type::Converter

data/lib/courier/models/apn.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # Apple Push Notification device tokens. Supply either a single `token` or a
+    # `tokens` value. A bare string is rejected by the provider — the token must be
+    # wrapped in this object.
+    module Apn
+      extend Courier::Internal::Type::Union
+
+      variant -> { Courier::Token }
+
+      variant -> { Courier::MultipleTokens }
+
+      # @!method self.variants
+      #   @return [Array(Courier::Models::Token, Courier::Models::MultipleTokens)]
+    end
+  end
+end

data/lib/courier/models/automation_run_list_item.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AutomationRunListItem < Courier::Internal::Type::BaseModel
+      # @!attribute run_id
+      #   A unique identifier representing the run.
+      #
+      #   @return [String]
+      required :run_id, String
+
+      # @!attribute source
+      #   Internal provenance strings describing what started the run, e.g.
+      #   `invoke/<template_id>` or `segment/page/Pricing Page`. Diagnostic only — the
+      #   format is unstable and should not be parsed.
+      #
+      #   @return [Array<String>]
+      required :source, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute created_at
+      #   When the run started, as an ISO 8601 timestamp.
+      #
+      #   @return [String, nil]
+      optional :created_at, String
+
+      # @!attribute status
+      #   The state of the run: `PROCESSING`, `PROCESSED`, `WAITING`, `CANCELED`, `ERROR`,
+      #   `THROTTLED`, or `NOT PROCESSED`. Not an enum — new values have been added
+      #   before.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute template_id
+      #   The id of the Automation Template this run belongs to.
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!method initialize(run_id:, source:, created_at: nil, status: nil, template_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::AutomationRunListItem} for more details.
+      #
+      #   An Automation run as it appears in a list response.
+      #
+      #   @param run_id [String] A unique identifier representing the run.
+      #
+      #   @param source [Array<String>] Internal provenance strings describing what started the run, e.g. `invoke/<templ
+      #
+      #   @param created_at [String] When the run started, as an ISO 8601 timestamp.
+      #
+      #   @param status [String] The state of the run: `PROCESSING`, `PROCESSED`, `WAITING`, `CANCELED`, `ERROR`,
+      #
+      #   @param template_id [String] The id of the Automation Template this run belongs to.
+    end
+  end
+end

data/lib/courier/models/automation_run_list_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AutomationRunListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute runs
+      #
+      #   @return [Array<Courier::Models::AutomationRunListItem>]
+      required :runs, -> { Courier::Internal::Type::ArrayOf[Courier::AutomationRunListItem] }
+
+      # @!attribute next_cursor
+      #   Pass back as `cursor` to fetch the next page. Absent on the last page.
+      #
+      #   @return [String, nil]
+      optional :next_cursor, String
+
+      # @!method initialize(runs:, next_cursor: nil)
+      #   A page of Automation runs.
+      #
+      #   @param runs [Array<Courier::Models::AutomationRunListItem>]
+      #
+      #   @param next_cursor [String] Pass back as `cursor` to fetch the next page. Absent on the last page.
+    end
+  end
+end

data/lib/courier/models/automation_run_step.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AutomationRunStep < Courier::Internal::Type::BaseModel
+      # @!attribute action
+      #   The kind of step that ran, e.g. `send`, `delay`, or `update-profile`.
+      #
+      #   @return [String]
+      required :action, String
+
+      # @!attribute status
+      #   The state of the step: the seven run statuses, plus `SKIPPED` and `COMPUTING`.
+      #   Not an enum — new values have been added before.
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute created_at
+      #   When the step started, as an ISO 8601 timestamp.
+      #
+      #   @return [String, nil]
+      optional :created_at, String
+
+      # @!attribute message_id
+      #   The message this step produced, present on send steps. Pass it to
+      #   `GET /messages/{message_id}` for delivery status. A send to a List or an
+      #   Audience yields one id for the request, not one per recipient.
+      #
+      #   @return [String, nil]
+      optional :message_id, String
+
+      # @!attribute step_id
+      #   A unique identifier representing the step.
+      #
+      #   @return [String, nil]
+      optional :step_id, String
+
+      # @!attribute updated_at
+      #   When the step last changed state, as an ISO 8601 timestamp.
+      #
+      #   @return [String, nil]
+      optional :updated_at, String
+
+      # @!method initialize(action:, status:, created_at: nil, message_id: nil, step_id: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::AutomationRunStep} for more details.
+      #
+      #   One executed step of an Automation run.
+      #
+      #   @param action [String] The kind of step that ran, e.g. `send`, `delay`, or `update-profile`.
+      #
+      #   @param status [String] The state of the step: the seven run statuses, plus `SKIPPED` and `COMPUTING`. N
+      #
+      #   @param created_at [String] When the step started, as an ISO 8601 timestamp.
+      #
+      #   @param message_id [String] The message this step produced, present on send steps. Pass it to `GET /messages
+      #
+      #   @param step_id [String] A unique identifier representing the step.
+      #
+      #   @param updated_at [String] When the step last changed state, as an ISO 8601 timestamp.
+    end
+  end
+end

data/lib/courier/models/automation_run_steps_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AutomationRunStepsResponse < Courier::Internal::Type::BaseModel
+      # @!attribute steps
+      #
+      #   @return [Array<Courier::Models::AutomationRunStep>]
+      required :steps, -> { Courier::Internal::Type::ArrayOf[Courier::AutomationRunStep] }
+
+      # @!method initialize(steps:)
+      #   Every step of an Automation run. Not paginated.
+      #
+      #   @param steps [Array<Courier::Models::AutomationRunStep>]
+    end
+  end
+end

data/lib/courier/models/automations/run_list_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Automations
+      # @see Courier::Resources::Automations::Runs#list
+      class RunListParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute cursor
+        #   A cursor token for pagination. Use the `next_cursor` from the previous response
+        #   to fetch the next page of results. Treat it as opaque.
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute end_date
+        #   An inclusive upper bound on `created_at`, in the same format as `start_date`.
+        #
+        #   @return [String, nil]
+        optional :end_date, String
+
+        # @!attribute limit
+        #   The number of runs to return per page, between `1` and `50`. Defaults to `20`.
+        #   Values outside the range are clamped, and a non-numeric value falls back to
+        #   `20`.
+        #
+        #   @return [String, nil]
+        optional :limit, String
+
+        # @!attribute start_date
+        #   An inclusive lower bound on `created_at`, as an ISO 8601 date or timestamp (e.g.
+        #   `2026-08-18` or `2026-08-18T20:06:36.259Z`). Any other format returns `400`.
+        #
+        #   @return [String, nil]
+        optional :start_date, String
+
+        # @!attribute status
+        #   A comma-separated list of run statuses to filter on, e.g. `PROCESSED,ERROR`.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute template_id
+        #   A comma-separated list of Automation Template ids to filter on.
+        #
+        #   @return [String, nil]
+        optional :template_id, String
+
+        # @!method initialize(cursor: nil, end_date: nil, limit: nil, start_date: nil, status: nil, template_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::Automations::RunListParams} for more details.
+        #
+        #   @param cursor [String] A cursor token for pagination. Use the `next_cursor` from the previous response
+        #
+        #   @param end_date [String] An inclusive upper bound on `created_at`, in the same format as `start_date`.
+        #
+        #   @param limit [String] The number of runs to return per page, between `1` and `50`. Defaults to `20`. V
+        #
+        #   @param start_date [String] An inclusive lower bound on `created_at`, as an ISO 8601 date or timestamp (e.g.
+        #
+        #   @param status [String] A comma-separated list of run statuses to filter on, e.g. `PROCESSED,ERROR`.
+        #
+        #   @param template_id [String] A comma-separated list of Automation Template ids to filter on.
+        #
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/automations/run_list_steps_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Automations
+      # @see Courier::Resources::Automations::Runs#list_steps
+      class RunListStepsParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!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
+  end
+end

data/lib/courier/models/create_journey_request.rb

@@ -10,7 +10,7 @@ module Courier
 
       # @!attribute nodes
       #
-      #   @return [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      #   @return [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneyAudienceTriggerNode, Courier::Models::JourneyWebhookTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       required :nodes, -> { Courier::Internal::Type::ArrayOf[union: Courier::JourneyNode] }
 
       # @!attribute enabled
@@ -29,7 +29,7 @@ module Courier
       #
       #   @param name [String]
       #
-      #   @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      #   @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneyAudienceTriggerNode, Courier::Models::JourneyWebhookTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
       #   @param enabled [Boolean]
       #

data/lib/courier/models/expo.rb

@@ -2,6 +2,7 @@
 
 module Courier
   module Models
+    # Expo push tokens. Supply either a single `token` or a `tokens` value.
     module Expo
       extend Courier::Internal::Type::Union
 

data/lib/courier/models/journey_audience_trigger_node.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyAudienceTriggerNode < Courier::Internal::Type::BaseModel
+      # @!attribute audience_id
+      #   The Audience to watch. Must name a single Audience; wildcards are not supported.
+      #
+      #   @return [String]
+      required :audience_id, String
+
+      # @!attribute trigger_type
+      #
+      #   @return [Symbol, Courier::Models::JourneyAudienceTriggerNode::TriggerType]
+      required :trigger_type, enum: -> { Courier::JourneyAudienceTriggerNode::TriggerType }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyAudienceTriggerNode::Type]
+      required :type, enum: -> { Courier::JourneyAudienceTriggerNode::Type }
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute conditions
+      #   Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+      #   group, or an AND/OR nested group. Omit the `conditions` property entirely to
+      #   express "no conditions".
+      #
+      #   @return [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup, nil]
+      optional :conditions, union: -> { Courier::JourneyConditionsField }
+
+      # @!method initialize(audience_id:, trigger_type:, type:, id: nil, conditions: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyAudienceTriggerNode} for more details.
+      #
+      #   Trigger fired when a user newly matches an Audience. Leaving and re-joining the
+      #   Audience re-enters the Journey. Membership is new-members-only: users already in
+      #   the Audience when the Journey is published do not enter. Unlike the v2
+      #   Automations audience trigger, there is no member scope, event type, or frequency
+      #   mode to configure, and `audience_id` must name one Audience — wildcards are not
+      #   supported.
+      #
+      #   @param audience_id [String] The Audience to watch. Must name a single Audience; wildcards are not supported.
+      #
+      #   @param trigger_type [Symbol, Courier::Models::JourneyAudienceTriggerNode::TriggerType]
+      #
+      #   @param type [Symbol, Courier::Models::JourneyAudienceTriggerNode::Type]
+      #
+      #   @param id [String]
+      #
+      #   @param conditions [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup] Condition spec for a journey node. Accepts a single condition atom, an AND/OR gr
+
+      # @see Courier::Models::JourneyAudienceTriggerNode#trigger_type
+      module TriggerType
+        extend Courier::Internal::Type::Enum
+
+        AUDIENCE = :audience
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyAudienceTriggerNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TRIGGER = :trigger
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_node.rb

@@ -11,9 +11,15 @@ module Courier
       # Trigger fired when the journey is invoked via the API. The optional `schema` field is a JSON Schema that validates the invocation payload.
       variant -> { Courier::JourneyAPIInvokeTriggerNode }
 
-      # Trigger fired by a segment event (`identify`, `group`, or `track`).
+      # Trigger fired by a segment event (`identify`, `group`, `track`, or `page`). A trigger with no `event_id` fires on any event of its type — the only shape `identify` and `group` can take, and the one that catches a stock `analytics.page()` call.
       variant -> { Courier::JourneySegmentTriggerNode }
 
+      # Trigger fired when a user newly matches an Audience. Leaving and re-joining the Audience re-enters the Journey. Membership is new-members-only: users already in the Audience when the Journey is published do not enter. Unlike the v2 Automations audience trigger, there is no member scope, event type, or frequency mode to configure, and `audience_id` must name one Audience — wildcards are not supported.
+      variant -> { Courier::JourneyAudienceTriggerNode }
+
+      # Trigger fired when an external system POSTs to the webhook URL minted for `event_source`. Narrow it to one event with `event_id`, or omit `event_id` to accept every event delivered to the URL.
+      variant -> { Courier::JourneyWebhookTriggerNode }
+
       # Send to the recipient. A send node sources its content from EXACTLY ONE of `message.template` (a single notification template) or `experiment` (an A/B split across weighted template variants) — supplying both, or neither, is rejected. Optionally override the recipient address, send as a tenant, delay the send, or attach `data`.
       variant -> { Courier::JourneySendNode }
 
@@ -344,7 +350,7 @@ module Courier
       end
 
       # @!method self.variants
-      #   @return [Array(Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode)]
+      #   @return [Array(Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneyAudienceTriggerNode, Courier::Models::JourneyWebhookTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode)]
     end
   end
 end

data/lib/courier/models/journey_response.rb

@@ -31,7 +31,7 @@ module Courier
 
       # @!attribute nodes
       #
-      #   @return [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      #   @return [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneyAudienceTriggerNode, Courier::Models::JourneyWebhookTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       required :nodes, -> { Courier::Internal::Type::ArrayOf[union: Courier::JourneyNode] }
 
       # @!attribute published
@@ -68,7 +68,7 @@ module Courier
       #
       #   @param name [String]
       #
-      #   @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      #   @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneyAudienceTriggerNode, Courier::Models::JourneyWebhookTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
       #   @param published [Integer, nil]
       #

data/lib/courier/models/journey_run.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyRun < Courier::Internal::Type::BaseModel
+      # @!attribute run_id
+      #   A unique identifier representing the run.
+      #
+      #   @return [String]
+      required :run_id, String
+
+      # @!attribute source
+      #   Internal provenance strings describing what started the run, e.g.
+      #   `invoke/<journey_id>` or `segment/page/Pricing Page`. Diagnostic only — the
+      #   format is unstable and should not be parsed.
+      #
+      #   @return [Array<String>]
+      required :source, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute created_at
+      #   When the run started, as an ISO 8601 timestamp.
+      #
+      #   @return [String, nil]
+      optional :created_at, String
+
+      # @!attribute status
+      #   The state of the run: `PROCESSING`, `PROCESSED`, `WAITING`, `CANCELED`, `ERROR`,
+      #   `THROTTLED`, or `NOT PROCESSED`. Not an enum — new values have been added
+      #   before.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute template_id
+      #   The id of the Journey this run belongs to.
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!attribute updated_at
+      #   When the run last changed state, as an ISO 8601 timestamp.
+      #
+      #   @return [String, nil]
+      optional :updated_at, String
+
+      # @!method initialize(run_id:, source:, created_at: nil, status: nil, template_id: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyRun} for more details.
+      #
+      #   One run of a Journey. `status` and `created_at` are absent on a small number of
+      #   legacy runs stored without them.
+      #
+      #   @param run_id [String] A unique identifier representing the run.
+      #
+      #   @param source [Array<String>] Internal provenance strings describing what started the run, e.g. `invoke/<journ
+      #
+      #   @param created_at [String] When the run started, as an ISO 8601 timestamp.
+      #
+      #   @param status [String] The state of the run: `PROCESSING`, `PROCESSED`, `WAITING`, `CANCELED`, `ERROR`,
+      #
+      #   @param template_id [String] The id of the Journey this run belongs to.
+      #
+      #   @param updated_at [String] When the run last changed state, as an ISO 8601 timestamp.
+    end
+  end
+end

data/lib/courier/models/journey_run_list_item.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyRunListItem < Courier::Internal::Type::BaseModel
+      # @!attribute run_id
+      #   A unique identifier representing the run.
+      #
+      #   @return [String]
+      required :run_id, String
+
+      # @!attribute source
+      #   Internal provenance strings describing what started the run. Diagnostic only.
+      #
+      #   @return [Array<String>]
+      required :source, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute created_at
+      #   When the run started, as an ISO 8601 timestamp.
+      #
+      #   @return [String, nil]
+      optional :created_at, String
+
+      # @!attribute status
+      #   The state of the run. See `JourneyRun.status` for the values it takes.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute template_id
+      #   The id of the Journey this run belongs to.
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!method initialize(run_id:, source:, created_at: nil, status: nil, template_id: nil)
+      #   A Journey run as it appears in a list response, without `updated_at`.
+      #
+      #   @param run_id [String] A unique identifier representing the run.
+      #
+      #   @param source [Array<String>] Internal provenance strings describing what started the run. Diagnostic only.
+      #
+      #   @param created_at [String] When the run started, as an ISO 8601 timestamp.
+      #
+      #   @param status [String] The state of the run. See `JourneyRun.status` for the values it takes.
+      #
+      #   @param template_id [String] The id of the Journey this run belongs to.
+    end
+  end
+end