Class: Courier::Models::JourneyFetchPostPutNode

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Courier::Models::JourneyFetchPostPutNode

Defined in:

lib/courier/models/journey_fetch_post_put_node.rb,
sig/courier/models/journey_fetch_post_put_node.rbs

Defined Under Namespace

Modules: Method, Type

Instance Attribute Summary

• #body ⇒ String^?
• #conditions ⇒ Array<String>, ...

  Condition spec for a journey node.

• #headers ⇒ Hash{Symbol=>String}^?
• #id ⇒ String^?
• #merge_strategy ⇒ Symbol, Courier::Models::JourneyMergeStrategy

  Strategy for merging a fetch response into the journey run state.

• #method_ ⇒ Symbol, Courier::Models::JourneyFetchPostPutNode::Method
• #query_params ⇒ Hash{Symbol=>String}^?
• #response_schema ⇒ Hash{Symbol=>Object}^?

  A JSONSchema object (Draft-07-compatible).

• #type ⇒ Symbol, Courier::Models::JourneyFetchPostPutNode::Type
• #url ⇒ String

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(merge_strategy:, method_:, type:, url:, id: nil, body: nil, conditions: nil, headers: nil, query_params: nil, response_schema: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see JourneyFetchPostPutNode for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(merge_strategy:, method_:, type:, url:, id: nil, body: nil, conditions: nil, headers: nil, query_params: nil, response_schema: nil) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::JourneyFetchPostPutNode for more details.

Issue an HTTP POST or PUT request with a body and merge the response into the journey state per merge_strategy.

Parameters:

• merge_strategy (Symbol, Courier::Models::JourneyMergeStrategy) —

  Strategy for merging a fetch response into the journey run state.

• method_ (Symbol, Courier::Models::JourneyFetchPostPutNode::Method)
• type (Symbol, Courier::Models::JourneyFetchPostPutNode::Type)
• url (String)
• id (String) (defaults to: nil)
• body (String) (defaults to: nil)
• conditions (Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup) (defaults to: nil) —

  Condition spec for a journey node. Accepts a single condition atom, an AND/OR gr

• headers (Hash{Symbol=>String}) (defaults to: nil)
• query_params (Hash{Symbol=>String}) (defaults to: nil)
• response_schema (Hash{Symbol=>Object}) (defaults to: nil) —

  A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 61

Instance Attribute Details

#body ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 35

optional :body, String

#conditions ⇒ Array<String>, ...

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".

Returns:

• (Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup, nil)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 43

optional :conditions, union: -> { Courier::JourneyConditionsField }

#headers ⇒ Hash{Symbol=>String}^?

Parameters:

• (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 48

optional :headers, Courier::Internal::Type::HashOf[String]

#id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 30

optional :id, String

#merge_strategy ⇒ Symbol, Courier::Models::JourneyMergeStrategy

Strategy for merging a fetch response into the journey run state.

Parameters:

• value (Courier::Models::journey_merge_strategy)

Returns:

• (Symbol, Courier::Models::JourneyMergeStrategy)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 10

required :merge_strategy, enum: -> { Courier::JourneyMergeStrategy }

#method_ ⇒ Symbol, Courier::Models::JourneyFetchPostPutNode::Method

Parameters:

• value (Courier::Models::JourneyFetchPostPutNode::method_)

Returns:

• (Symbol, Courier::Models::JourneyFetchPostPutNode::Method)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 15

required :method_, enum: -> { Courier::JourneyFetchPostPutNode::Method }, api_name: :method

#query_params ⇒ Hash{Symbol=>String}^?

Parameters:

• (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 53

optional :query_params, Courier::Internal::Type::HashOf[String]

#response_schema ⇒ Hash{Symbol=>Object}^?

A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 59

optional :response_schema, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]

#type ⇒ Symbol, Courier::Models::JourneyFetchPostPutNode::Type

Parameters:

• value (Courier::Models::JourneyFetchPostPutNode::type_)

Returns:

• (Symbol, Courier::Models::JourneyFetchPostPutNode::Type)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 20

required :type, enum: -> { Courier::JourneyFetchPostPutNode::Type }

#url ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 25

required :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/courier/models/journey_fetch_post_put_node.rb', line 95

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/courier/models/journey_fetch_post_put_node.rbs', line 65

def to_hash: -> {