Module: MetronomeSDK::Models::V1::PlanListCustomersParams::Status

Extended by:

Internal::Type::Enum

Defined in:

lib/metronome_sdk/models/v1/plan_list_customers_params.rb,
sig/metronome_sdk/models/v1/plan_list_customers_params.rbs

Overview

Status of customers on a given plan. Defaults to active.

• all - Return current, past, and upcoming customers of the plan.
• active - Return current customers of the plan.
• ended - Return past customers of the plan.
• upcoming - Return upcoming customers of the plan.

Multiple statuses can be OR'd together using commas, e.g. active,ended. Note: ended,upcoming combination is not yet supported.

Constant Summary

ALL =

Returns:

• (:all)

:all

ACTIVE =

Returns:

• (:active)

:active

ENDED =

Returns:

• (:ended)

:ended

UPCOMING =

Returns:

• (:upcoming)

:upcoming

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #self?.values ⇒ ::Array[MetronomeSDK::Models::V1::PlanListCustomersParams::status]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

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

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/plan_list_customers_params.rb', line 73

Instance Method Details

#self?.values ⇒ ::Array[MetronomeSDK::Models::V1::PlanListCustomersParams::status]

Returns:

• (::Array[MetronomeSDK::Models::V1::PlanListCustomersParams::status])

# File 'sig/metronome_sdk/models/v1/plan_list_customers_params.rbs', line 59

def self?.values: -> ::Array[MetronomeSDK::Models::V1::PlanListCustomersParams::status]