Class: Increase::Models::EntityOnboardingSessionListParams::Status

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity_onboarding_session_list_params.rb,
sig/increase/models/entity_onboarding_session_list_params.rbs

Defined Under Namespace

Modules: In

Instance Attribute Summary collapse

Instance Method Summary collapse

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(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

  • cursor (String) (defaults to: nil) —

    Return the page of entries after this one.

  • idempotency_key (String) (defaults to: nil) —

    Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

  • limit (Integer) (defaults to: nil) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

  • status (Increase::Models::EntityOnboardingSessionListParams::Status) (defaults to: nil)
  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/increase/models/entity_onboarding_session_list_params.rb', line 54

class Status < Increase::Internal::Type::BaseModel
  # @!attribute in_
  #   Filter Entity Onboarding Session for those with the specified status or
  #   statuses. For GET requests, this should be encoded as a comma-delimited string,
  #   such as `?in=one,two,three`.
  #
  #   @return [Array<Symbol, Increase::Models::EntityOnboardingSessionListParams::Status::In>, nil]
  optional :in_,
           -> {
             Increase::Internal::Type::ArrayOf[enum: Increase::EntityOnboardingSessionListParams::Status::In]
           },
           api_name: :in

  # @!method initialize(in_: nil)
  #   @param in_ [Array<Symbol, Increase::Models::EntityOnboardingSessionListParams::Status::In>]
  #     Filter Entity Onboarding Session for those with the specified status or
  #     statuses. For GET requests, this should be encoded as a comma-delimited string,
  #     such as `?in=one,two,three`.

  module In
    extend Increase::Internal::Type::Enum

    # The Entity Onboarding Session is active.
    ACTIVE = :active

    # The Entity Onboarding Session has expired.
    EXPIRED = :expired

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

Instance Attribute Details

#in_ ⇒ Array<Symbol, Increase::Models::EntityOnboardingSessionListParams::Status::In>?

Filter Entity Onboarding Session for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

Returns:



61
62
63
64
65
 
# File 'lib/increase/models/entity_onboarding_session_list_params.rb', line 61

optional :in_,
-> {
  Increase::Internal::Type::ArrayOf[enum: Increase::EntityOnboardingSessionListParams::Status::In]
},
api_name: :in

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


66
 
# File 'sig/increase/models/entity_onboarding_session_list_params.rbs', line 66

def to_hash: -> {