Module: Courier::Models::CancelJourneyRequest

Extended by:

Internal::Type::Union

Defined in:

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

Overview

Request body for POST /journeys/cancel. Provide EXACTLY ONE of cancelation_token (cancels every run associated with the token) or run_id (cancels a single tenant-scoped run).

Defined Under Namespace

Classes: ByCancelationToken, ByRunID

Class Method Summary

• .variants ⇒ Array(Courier::Models::CancelJourneyRequest::ByCancelationToken, Courier::Models::CancelJourneyRequest::ByRunID)

Instance Method Summary

• #initialize(cancelation_token:) ⇒ Object
• #self?.variants ⇒ ::Array[Courier::Models::cancel_journey_request]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Class Method Details

.variants ⇒ Array(Courier::Models::CancelJourneyRequest::ByCancelationToken, Courier::Models::CancelJourneyRequest::ByRunID)

Returns:

• (Array(Courier::Models::CancelJourneyRequest::ByCancelationToken, Courier::Models::CancelJourneyRequest::ByRunID))

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

Instance Method Details

#initialize(cancelation_token:) ⇒ Object

Parameters:

• cancelation_token (String)

# File 'lib/courier/models/cancel_journey_request.rb', line 21

#self?.variants ⇒ ::Array[Courier::Models::cancel_journey_request]

Returns:

• (::Array[Courier::Models::cancel_journey_request])

# File 'sig/courier/models/cancel_journey_request.rbs', line 30

def self?.variants: -> ::Array[Courier::Models::cancel_journey_request]