trycourier 4.10.2 → 4.11.0

data/lib/courier/models/journey_throttle_dynamic_node.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyThrottleDynamicNode < Courier::Internal::Type::BaseModel
+      # @!attribute max_allowed
+      #
+      #   @return [Integer]
+      required :max_allowed, Integer
+
+      # @!attribute period
+      #
+      #   @return [String]
+      required :period, String
+
+      # @!attribute scope
+      #
+      #   @return [Symbol, Courier::Models::JourneyThrottleDynamicNode::Scope]
+      required :scope, enum: -> { Courier::JourneyThrottleDynamicNode::Scope }
+
+      # @!attribute throttle_key
+      #
+      #   @return [String]
+      required :throttle_key, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyThrottleDynamicNode::Type]
+      required :type, enum: -> { Courier::JourneyThrottleDynamicNode::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(max_allowed:, period:, scope:, throttle_key:, type:, id: nil, conditions: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyThrottleDynamicNode} for more details.
+      #
+      #   Throttle the journey by a dynamic `throttle_key`, allowing at most `max_allowed`
+      #   invocations per `period`.
+      #
+      #   @param max_allowed [Integer]
+      #
+      #   @param period [String]
+      #
+      #   @param scope [Symbol, Courier::Models::JourneyThrottleDynamicNode::Scope]
+      #
+      #   @param throttle_key [String]
+      #
+      #   @param type [Symbol, Courier::Models::JourneyThrottleDynamicNode::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::JourneyThrottleDynamicNode#scope
+      module Scope
+        extend Courier::Internal::Type::Enum
+
+        DYNAMIC = :dynamic
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyThrottleDynamicNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        THROTTLE = :throttle
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_throttle_static_node.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyThrottleStaticNode < Courier::Internal::Type::BaseModel
+      # @!attribute max_allowed
+      #
+      #   @return [Integer]
+      required :max_allowed, Integer
+
+      # @!attribute period
+      #
+      #   @return [String]
+      required :period, String
+
+      # @!attribute scope
+      #
+      #   @return [Symbol, Courier::Models::JourneyThrottleStaticNode::Scope]
+      required :scope, enum: -> { Courier::JourneyThrottleStaticNode::Scope }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyThrottleStaticNode::Type]
+      required :type, enum: -> { Courier::JourneyThrottleStaticNode::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(max_allowed:, period:, scope:, type:, id: nil, conditions: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyThrottleStaticNode} for more details.
+      #
+      #   Throttle the journey by a static `scope` (`user` or `global`), allowing at most
+      #   `max_allowed` invocations per `period`.
+      #
+      #   @param max_allowed [Integer]
+      #
+      #   @param period [String]
+      #
+      #   @param scope [Symbol, Courier::Models::JourneyThrottleStaticNode::Scope]
+      #
+      #   @param type [Symbol, Courier::Models::JourneyThrottleStaticNode::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::JourneyThrottleStaticNode#scope
+      module Scope
+        extend Courier::Internal::Type::Enum
+
+        USER = :user
+        GLOBAL = :global
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyThrottleStaticNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        THROTTLE = :throttle
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_version_item.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyVersionItem < Courier::Internal::Type::BaseModel
+      # @!attribute created
+      #
+      #   @return [Integer, nil]
+      required :created, Integer, nil?: true
+
+      # @!attribute creator
+      #
+      #   @return [String, nil]
+      required :creator, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute published
+      #
+      #   @return [Integer, nil]
+      required :published, Integer, nil?: true
+
+      # @!attribute version
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!method initialize(created:, creator:, name:, published:, version:)
+      #   A published version of a journey.
+      #
+      #   @param created [Integer, nil]
+      #   @param creator [String, nil]
+      #   @param name [String]
+      #   @param published [Integer, nil]
+      #   @param version [String]
+    end
+  end
+end

data/lib/courier/models/journey_versions_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#list_versions
+    class JourneyVersionsListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::JourneyVersionItem>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::JourneyVersionItem] }
+
+      # @!method initialize(paging:, results:)
+      #   Paged list of published journey versions, most recent first.
+      #
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::JourneyVersionItem>]
+    end
+  end
+end

data/lib/courier/models/journeys/template_archive_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#archive
+      class TemplateArchiveParams < 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 notification_id
+        #
+        #   @return [String]
+        required :notification_id, String
+
+        # @!method initialize(template_id:, notification_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param notification_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#create
+      class TemplateCreateParams < Courier::Models::JourneyTemplateCreateRequest
+        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
+end

data/lib/courier/models/journeys/template_list_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#list
+      class TemplateListParams < 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 cursor
+        #   Pagination cursor from a prior response.
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute limit
+        #   Page size. Minimum 1, maximum 100.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(template_id:, cursor: nil, limit: nil, request_options: {})
+        #   @param template_id [String]
+        #
+        #   @param cursor [String] Pagination cursor from a prior response.
+        #
+        #   @param limit [Integer] Page size. Minimum 1, maximum 100.
+        #
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_list_versions_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#list_versions
+      class TemplateListVersionsParams < 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 notification_id
+        #
+        #   @return [String]
+        required :notification_id, String
+
+        # @!method initialize(template_id:, notification_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param notification_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_publish_params.rb

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

data/lib/courier/models/journeys/template_replace_params.rb

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

data/lib/courier/models/journeys/template_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#retrieve
+      class TemplateRetrieveParams < 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 notification_id
+        #
+        #   @return [String]
+        required :notification_id, String
+
+        # @!method initialize(template_id:, notification_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param notification_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/tenants/template_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Tenants
+      # @see Courier::Resources::Tenants::Templates#delete
+      class TemplateDeleteParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(tenant_id:, template_id:, request_options: {})
+        #   @param tenant_id [String]
+        #   @param template_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models.rb

@@ -133,6 +133,8 @@ module Courier
 
   Check = Courier::Models::Check
 
+  CreateJourneyRequest = Courier::Models::CreateJourneyRequest
+
   DefaultPreferences = Courier::Models::DefaultPreferences
 
   DeviceType = Courier::Models::DeviceType
@@ -191,16 +193,87 @@ module Courier
 
   Journey = Courier::Models::Journey
 
+  JourneyAINode = Courier::Models::JourneyAINode
+
+  JourneyAPIInvokeTriggerNode = Courier::Models::JourneyAPIInvokeTriggerNode
+
+  JourneyArchiveParams = Courier::Models::JourneyArchiveParams
+
+  # @type [Courier::Internal::Type::Converter]
+  JourneyConditionAtom = Courier::Models::JourneyConditionAtom
+
+  JourneyConditionGroup = Courier::Models::JourneyConditionGroup
+
+  JourneyConditionNestedGroup = Courier::Models::JourneyConditionNestedGroup
+
+  JourneyConditionsField = Courier::Models::JourneyConditionsField
+
+  JourneyCreateParams = Courier::Models::JourneyCreateParams
+
+  JourneyDelayDurationNode = Courier::Models::JourneyDelayDurationNode
+
+  JourneyDelayUntilNode = Courier::Models::JourneyDelayUntilNode
+
+  JourneyExitNode = Courier::Models::JourneyExitNode
+
+  JourneyFetchGetDeleteNode = Courier::Models::JourneyFetchGetDeleteNode
+
+  JourneyFetchPostPutNode = Courier::Models::JourneyFetchPostPutNode
+
   JourneyInvokeParams = Courier::Models::JourneyInvokeParams
 
   JourneyListParams = Courier::Models::JourneyListParams
 
+  JourneyListVersionsParams = Courier::Models::JourneyListVersionsParams
+
+  JourneyMergeStrategy = Courier::Models::JourneyMergeStrategy
+
+  JourneyNode = Courier::Models::JourneyNode
+
+  JourneyPublishParams = Courier::Models::JourneyPublishParams
+
+  JourneyPublishRequest = Courier::Models::JourneyPublishRequest
+
+  JourneyReplaceParams = Courier::Models::JourneyReplaceParams
+
+  JourneyResponse = Courier::Models::JourneyResponse
+
+  JourneyRetrieveParams = Courier::Models::JourneyRetrieveParams
+
+  Journeys = Courier::Models::Journeys
+
+  JourneySegmentTriggerNode = Courier::Models::JourneySegmentTriggerNode
+
+  JourneySendNode = Courier::Models::JourneySendNode
+
   JourneysInvokeRequest = Courier::Models::JourneysInvokeRequest
 
   JourneysInvokeResponse = Courier::Models::JourneysInvokeResponse
 
   JourneysListResponse = Courier::Models::JourneysListResponse
 
+  JourneyState = Courier::Models::JourneyState
+
+  JourneyTemplateCreateRequest = Courier::Models::JourneyTemplateCreateRequest
+
+  JourneyTemplateGetResponse = Courier::Models::JourneyTemplateGetResponse
+
+  JourneyTemplateListResponse = Courier::Models::JourneyTemplateListResponse
+
+  JourneyTemplatePublishRequest = Courier::Models::JourneyTemplatePublishRequest
+
+  JourneyTemplateReplaceRequest = Courier::Models::JourneyTemplateReplaceRequest
+
+  JourneyTemplateSummary = Courier::Models::JourneyTemplateSummary
+
+  JourneyThrottleDynamicNode = Courier::Models::JourneyThrottleDynamicNode
+
+  JourneyThrottleStaticNode = Courier::Models::JourneyThrottleStaticNode
+
+  JourneyVersionItem = Courier::Models::JourneyVersionItem
+
+  JourneyVersionsListResponse = Courier::Models::JourneyVersionsListResponse
+
   ListDeleteParams = Courier::Models::ListDeleteParams
 
   ListFilter = Courier::Models::ListFilter