Module: Courier::Models::CancelJourneyResponse

Extended by:

Internal::Type::Union

Defined in:

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

Overview

202 Accepted body for POST /journeys/cancel, returning the submitted identifier. When called with cancelation_token, returns { cancelation_token }; when called with run_id, returns { run_id, status }.

See Also:

• Courier::Resources::Journeys#cancel

Defined Under Namespace

Classes: RunIDBranch, TokenBranch

Class Method Summary

• .variants ⇒ Array(Courier::Models::CancelJourneyResponse::TokenBranch, Courier::Models::CancelJourneyResponse::RunIDBranch)

Instance Method Summary

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

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::CancelJourneyResponse::TokenBranch, Courier::Models::CancelJourneyResponse::RunIDBranch)

Returns:

• (Array(Courier::Models::CancelJourneyResponse::TokenBranch, Courier::Models::CancelJourneyResponse::RunIDBranch))

# File 'lib/courier/models/cancel_journey_response.rb', line 51

Instance Method Details

#initialize(cancelation_token:) ⇒ Object

Parameters:

• cancelation_token (String)

# File 'lib/courier/models/cancel_journey_response.rb', line 24

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

Returns:

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

# File 'sig/courier/models/cancel_journey_response.rbs', line 32

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