trycourier 4.10.2 → 4.12.0

data/lib/courier/models/journey_retrieve_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#retrieve
+    class JourneyRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute template_id
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!attribute version
+      #   Version selector: `draft`, `published` (default), or `vN`.
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(template_id:, version: nil, request_options: {})
+      #   @param template_id [String]
+      #
+      #   @param version [String] Version selector: `draft`, `published` (default), or `vN`.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/journey_segment_trigger_node.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneySegmentTriggerNode < Courier::Internal::Type::BaseModel
+      # @!attribute request_type
+      #
+      #   @return [Symbol, Courier::Models::JourneySegmentTriggerNode::RequestType]
+      required :request_type, enum: -> { Courier::JourneySegmentTriggerNode::RequestType }
+
+      # @!attribute trigger_type
+      #
+      #   @return [Symbol, Courier::Models::JourneySegmentTriggerNode::TriggerType]
+      required :trigger_type, enum: -> { Courier::JourneySegmentTriggerNode::TriggerType }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneySegmentTriggerNode::Type]
+      required :type, enum: -> { Courier::JourneySegmentTriggerNode::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 }
+
+      # @!attribute event_id
+      #
+      #   @return [String, nil]
+      optional :event_id, String
+
+      # @!method initialize(request_type:, trigger_type:, type:, id: nil, conditions: nil, event_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneySegmentTriggerNode} for more details.
+      #
+      #   Trigger fired by a segment event (`identify`, `group`, or `track`).
+      #
+      #   @param request_type [Symbol, Courier::Models::JourneySegmentTriggerNode::RequestType]
+      #
+      #   @param trigger_type [Symbol, Courier::Models::JourneySegmentTriggerNode::TriggerType]
+      #
+      #   @param type [Symbol, Courier::Models::JourneySegmentTriggerNode::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
+      #
+      #   @param event_id [String]
+
+      # @see Courier::Models::JourneySegmentTriggerNode#request_type
+      module RequestType
+        extend Courier::Internal::Type::Enum
+
+        IDENTIFY = :identify
+        GROUP = :group
+        TRACK = :track
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneySegmentTriggerNode#trigger_type
+      module TriggerType
+        extend Courier::Internal::Type::Enum
+
+        SEGMENT = :segment
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneySegmentTriggerNode#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_send_node.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneySendNode < Courier::Internal::Type::BaseModel
+      # @!attribute message
+      #
+      #   @return [Courier::Models::JourneySendNode::Message]
+      required :message, -> { Courier::JourneySendNode::Message }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneySendNode::Type]
+      required :type, enum: -> { Courier::JourneySendNode::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(message:, type:, id: nil, conditions: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneySendNode} for more details.
+      #
+      #   Send a notification template to the recipient. Optionally override the recipient
+      #   address, delay the send, or attach `data`.
+      #
+      #   @param message [Courier::Models::JourneySendNode::Message]
+      #
+      #   @param type [Symbol, Courier::Models::JourneySendNode::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::JourneySendNode#message
+      class Message < Courier::Internal::Type::BaseModel
+        # @!attribute template
+        #
+        #   @return [String]
+        required :template, String
+
+        # @!attribute data
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+        # @!attribute delay
+        #
+        #   @return [Courier::Models::JourneySendNode::Message::Delay, nil]
+        optional :delay, -> { Courier::JourneySendNode::Message::Delay }
+
+        # @!attribute to
+        #
+        #   @return [Courier::Models::JourneySendNode::Message::To, nil]
+        optional :to, -> { Courier::JourneySendNode::Message::To }
+
+        # @!method initialize(template:, data: nil, delay: nil, to: nil)
+        #   @param template [String]
+        #   @param data [Hash{Symbol=>Object}]
+        #   @param delay [Courier::Models::JourneySendNode::Message::Delay]
+        #   @param to [Courier::Models::JourneySendNode::Message::To]
+
+        # @see Courier::Models::JourneySendNode::Message#delay
+        class Delay < Courier::Internal::Type::BaseModel
+          # @!attribute until_
+          #
+          #   @return [String]
+          required :until_, String, api_name: :until
+
+          # @!attribute timezone
+          #
+          #   @return [String, nil]
+          optional :timezone, String
+
+          # @!method initialize(until_:, timezone: nil)
+          #   @param until_ [String]
+          #   @param timezone [String]
+        end
+
+        # @see Courier::Models::JourneySendNode::Message#to
+        class To < Courier::Internal::Type::BaseModel
+          # @!attribute email_override
+          #
+          #   @return [String, nil]
+          optional :email_override, String
+
+          # @!attribute phone_number_override
+          #
+          #   @return [String, nil]
+          optional :phone_number_override, String
+
+          # @!attribute user_id_override
+          #
+          #   @return [String, nil]
+          optional :user_id_override, String
+
+          # @!method initialize(email_override: nil, phone_number_override: nil, user_id_override: nil)
+          #   @param email_override [String]
+          #   @param phone_number_override [String]
+          #   @param user_id_override [String]
+        end
+      end
+
+      # @see Courier::Models::JourneySendNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        SEND = :send
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_state.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # Lifecycle state of a journey.
+    module JourneyState
+      extend Courier::Internal::Type::Enum
+
+      DRAFT = :DRAFT
+      PUBLISHED = :PUBLISHED
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/courier/models/journey_template_create_request.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyTemplateCreateRequest < Courier::Internal::Type::BaseModel
+      # @!attribute channel
+      #
+      #   @return [String]
+      required :channel, String
+
+      # @!attribute notification
+      #
+      #   @return [Courier::Models::JourneyTemplateCreateRequest::Notification]
+      required :notification, -> { Courier::JourneyTemplateCreateRequest::Notification }
+
+      # @!attribute provider_key
+      #
+      #   @return [String, nil]
+      optional :provider_key, String, api_name: :providerKey
+
+      # @!attribute state
+      #
+      #   @return [String, nil]
+      optional :state, String
+
+      # @!method initialize(channel:, notification:, provider_key: nil, state: nil)
+      #   Request body for creating a notification template scoped to a journey.
+      #
+      #   @param channel [String]
+      #   @param notification [Courier::Models::JourneyTemplateCreateRequest::Notification]
+      #   @param provider_key [String]
+      #   @param state [String]
+
+      # @see Courier::Models::JourneyTemplateCreateRequest#notification
+      class Notification < Courier::Internal::Type::BaseModel
+        # @!attribute brand
+        #
+        #   @return [Courier::Models::JourneyTemplateCreateRequest::Notification::Brand, nil]
+        required :brand, -> { Courier::JourneyTemplateCreateRequest::Notification::Brand }, nil?: true
+
+        # @!attribute content
+        #
+        #   @return [Courier::Models::JourneyTemplateCreateRequest::Notification::Content]
+        required :content, -> { Courier::JourneyTemplateCreateRequest::Notification::Content }
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute subscription
+        #
+        #   @return [Courier::Models::JourneyTemplateCreateRequest::Notification::Subscription, nil]
+        required :subscription,
+                 -> { Courier::JourneyTemplateCreateRequest::Notification::Subscription },
+                 nil?: true
+
+        # @!attribute tags
+        #
+        #   @return [Array<String>]
+        required :tags, Courier::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(brand:, content:, name:, subscription:, tags:)
+        #   @param brand [Courier::Models::JourneyTemplateCreateRequest::Notification::Brand, nil]
+        #   @param content [Courier::Models::JourneyTemplateCreateRequest::Notification::Content]
+        #   @param name [String]
+        #   @param subscription [Courier::Models::JourneyTemplateCreateRequest::Notification::Subscription, nil]
+        #   @param tags [Array<String>]
+
+        # @see Courier::Models::JourneyTemplateCreateRequest::Notification#brand
+        class Brand < Courier::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   @param id [String]
+        end
+
+        # @see Courier::Models::JourneyTemplateCreateRequest::Notification#content
+        class Content < Courier::Internal::Type::BaseModel
+          # @!attribute elements
+          #
+          #   @return [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType>]
+          required :elements, -> { Courier::Internal::Type::ArrayOf[union: Courier::ElementalNode] }
+
+          # @!attribute version
+          #
+          #   @return [Symbol, Courier::Models::JourneyTemplateCreateRequest::Notification::Content::Version]
+          required :version, enum: -> { Courier::JourneyTemplateCreateRequest::Notification::Content::Version }
+
+          # @!attribute scope
+          #
+          #   @return [Symbol, Courier::Models::JourneyTemplateCreateRequest::Notification::Content::Scope, nil]
+          optional :scope, enum: -> { Courier::JourneyTemplateCreateRequest::Notification::Content::Scope }
+
+          # @!method initialize(elements:, version:, scope: nil)
+          #   @param elements [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType>]
+          #   @param version [Symbol, Courier::Models::JourneyTemplateCreateRequest::Notification::Content::Version]
+          #   @param scope [Symbol, Courier::Models::JourneyTemplateCreateRequest::Notification::Content::Scope]
+
+          # @see Courier::Models::JourneyTemplateCreateRequest::Notification::Content#version
+          module Version
+            extend Courier::Internal::Type::Enum
+
+            VERSION_2022_01_01 = :"2022-01-01"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Courier::Models::JourneyTemplateCreateRequest::Notification::Content#scope
+          module Scope
+            extend Courier::Internal::Type::Enum
+
+            DEFAULT = :default
+            STRICT = :strict
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Courier::Models::JourneyTemplateCreateRequest::Notification#subscription
+        class Subscription < Courier::Internal::Type::BaseModel
+          # @!attribute topic_id
+          #
+          #   @return [String]
+          required :topic_id, String
+
+          # @!method initialize(topic_id:)
+          #   @param topic_id [String]
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/journey_template_get_response.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyTemplateGetResponse < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute brand
+      #
+      #   @return [Courier::Models::JourneyTemplateGetResponse::Brand, nil]
+      required :brand, -> { Courier::JourneyTemplateGetResponse::Brand }, nil?: true
+
+      # @!attribute content
+      #
+      #   @return [Courier::Models::JourneyTemplateGetResponse::Content]
+      required :content, -> { Courier::JourneyTemplateGetResponse::Content }
+
+      # @!attribute created
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute state
+      #
+      #   @return [Symbol, Courier::Models::JourneyTemplateGetResponse::State]
+      required :state, enum: -> { Courier::JourneyTemplateGetResponse::State }
+
+      # @!attribute subscription
+      #
+      #   @return [Courier::Models::JourneyTemplateGetResponse::Subscription, nil]
+      required :subscription, -> { Courier::JourneyTemplateGetResponse::Subscription }, nil?: true
+
+      # @!attribute tags
+      #
+      #   @return [Array<String>]
+      required :tags, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute updated
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer
+
+      # @!attribute updater
+      #
+      #   @return [String, nil]
+      optional :updater, String
+
+      # @!method initialize(id:, brand:, content:, created:, creator:, name:, state:, subscription:, tags:, updated: nil, updater: nil)
+      #   A journey-scoped notification template.
+      #
+      #   @param id [String]
+      #   @param brand [Courier::Models::JourneyTemplateGetResponse::Brand, nil]
+      #   @param content [Courier::Models::JourneyTemplateGetResponse::Content]
+      #   @param created [Integer]
+      #   @param creator [String]
+      #   @param name [String]
+      #   @param state [Symbol, Courier::Models::JourneyTemplateGetResponse::State]
+      #   @param subscription [Courier::Models::JourneyTemplateGetResponse::Subscription, nil]
+      #   @param tags [Array<String>]
+      #   @param updated [Integer]
+      #   @param updater [String]
+
+      # @see Courier::Models::JourneyTemplateGetResponse#brand
+      class Brand < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   @param id [String]
+      end
+
+      # @see Courier::Models::JourneyTemplateGetResponse#content
+      class Content < Courier::Internal::Type::BaseModel
+        # @!attribute elements
+        #
+        #   @return [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType>]
+        required :elements, -> { Courier::Internal::Type::ArrayOf[union: Courier::ElementalNode] }
+
+        # @!attribute version
+        #
+        #   @return [Symbol, Courier::Models::JourneyTemplateGetResponse::Content::Version]
+        required :version, enum: -> { Courier::JourneyTemplateGetResponse::Content::Version }
+
+        # @!attribute scope
+        #
+        #   @return [Symbol, Courier::Models::JourneyTemplateGetResponse::Content::Scope, nil]
+        optional :scope, enum: -> { Courier::JourneyTemplateGetResponse::Content::Scope }
+
+        # @!method initialize(elements:, version:, scope: nil)
+        #   @param elements [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType>]
+        #   @param version [Symbol, Courier::Models::JourneyTemplateGetResponse::Content::Version]
+        #   @param scope [Symbol, Courier::Models::JourneyTemplateGetResponse::Content::Scope]
+
+        # @see Courier::Models::JourneyTemplateGetResponse::Content#version
+        module Version
+          extend Courier::Internal::Type::Enum
+
+          VERSION_2022_01_01 = :"2022-01-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Courier::Models::JourneyTemplateGetResponse::Content#scope
+        module Scope
+          extend Courier::Internal::Type::Enum
+
+          DEFAULT = :default
+          STRICT = :strict
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Courier::Models::JourneyTemplateGetResponse#state
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PUBLISHED = :PUBLISHED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyTemplateGetResponse#subscription
+      class Subscription < Courier::Internal::Type::BaseModel
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!method initialize(topic_id:)
+        #   @param topic_id [String]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_template_list_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyTemplateListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::JourneyTemplateSummary>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::JourneyTemplateSummary] }
+
+      # @!method initialize(paging:, results:)
+      #   Paged list of journey-scoped notification templates.
+      #
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::JourneyTemplateSummary>]
+    end
+  end
+end

data/lib/courier/models/journey_template_publish_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyTemplatePublishRequest < Courier::Internal::Type::BaseModel
+      # @!attribute version
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(version: nil)
+      #   Request body for publishing a journey-scoped notification template. Pass
+      #   `version` to roll back to a prior version; omit to publish the current draft.
+      #
+      #   @param version [String]
+    end
+  end
+end