Class: Increase::Models::DocumentListParams::Category

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/document_list_params.rb

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

Some parameter documentations has been truncated, see Increase::Models::DocumentListParams for more details.

Parameters:

  • category (Increase::Models::DocumentListParams::Category) (defaults to: nil)
  • created_at (Increase::Models::DocumentListParams::CreatedAt) (defaults to: nil)
  • cursor (String) (defaults to: nil) —

    Return the page of entries after this one.

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

    Filter Documents to ones belonging to the specified Entity.

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

    Filter records to the one with the specified ‘idempotency_key` you chose for tha

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

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

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/increase/models/document_list_params.rb', line 66

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

  # @!method initialize(in_: nil)
  #   Some parameter documentations has been truncated, see
  #   {Increase::Models::DocumentListParams::Category} for more details.
  #
  #   @param in_ [Array<Symbol, Increase::Models::DocumentListParams::Category::In>] Filter Documents for those with the specified category or categories. For GET re

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

    # Internal Revenue Service Form 1099-INT.
    FORM_1099_INT = :form_1099_int

    # Internal Revenue Service Form 1099-MISC.
    FORM_1099_MISC = :form_1099_misc

    # A document submitted in response to a proof of authorization request for an ACH transfer.
    PROOF_OF_AUTHORIZATION = :proof_of_authorization

    # Company information, such a policies or procedures, typically submitted during our due diligence process.
    COMPANY_INFORMATION = :company_information

    # An account verification letter.
     = :account_verification_letter

    # Funding instructions.
    FUNDING_INSTRUCTIONS = :funding_instructions

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

Instance Attribute Details

#in_ ⇒ Array<Symbol, Increase::Models::DocumentListParams::Category::In>?

Filter Documents for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ‘?in=one,two,three`.

Returns:



73
74
75
 
# File 'lib/increase/models/document_list_params.rb', line 73

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