Module: Orb::Models::SubscriptionListParams::Status

Extended by:
Internal::Type::Enum
Defined in:
lib/orb/models/subscription_list_params.rb,
sig/orb/models/subscription_list_params.rbs

Constant Summary collapse

ACTIVE =

Returns:

  • (:active) 
:active
ENDED =

Returns:

  • (:ended) 
:ended
UPCOMING =

Returns:

  • (:upcoming) 
:upcoming

Class Method Summary collapse

Instance Method Summary collapse

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/orb/models/subscription_list_params.rb', line 103

Instance Method Details

#initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, external_plan_id: nil, limit: nil, plan_id: nil, status: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::SubscriptionListParams for more details.

Parameters:

  • created_at_gt (Time, nil) (defaults to: nil)
  • created_at_gte (Time, nil) (defaults to: nil)
  • created_at_lt (Time, nil) (defaults to: nil)
  • created_at_lte (Time, nil) (defaults to: nil)
  • cursor (String, nil) (defaults to: nil) —

    Cursor for pagination. This can be populated by the next_cursor value returned

  • customer_id (Array<String>, nil) (defaults to: nil)
  • external_customer_id (Array<String>, nil) (defaults to: nil)
  • external_plan_id (String, nil) (defaults to: nil)
  • limit (Integer) (defaults to: nil) —

    The number of items to fetch. Defaults to 20.

  • plan_id (String, nil) (defaults to: nil)
  • status (Symbol, Orb::Models::SubscriptionListParams::Status, nil) (defaults to: nil)
  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


96
97
98
99
100
101
102
103
104
105
 
# File 'lib/orb/models/subscription_list_params.rb', line 96

module Status
  extend Orb::Internal::Type::Enum

  ACTIVE = :active
  ENDED = :ended
  UPCOMING = :upcoming

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Orb::Models::SubscriptionListParams::status]

Returns:

  • (::Array[Orb::Models::SubscriptionListParams::status]) 


86
 
# File 'sig/orb/models/subscription_list_params.rbs', line 86

def self?.values: -> ::Array[Orb::Models::SubscriptionListParams::status]