Class: Increase::Models::ExportListParams::Category

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/export_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, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:



65
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
108
109
110
111
112
 
# File 'lib/increase/models/export_list_params.rb', line 65

class Category < Increase::Internal::Type::BaseModel
  # @!attribute in_
  #   Filter Exports 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::ExportListParams::Category::In>, nil]
  optional :in_,
           -> { Increase::Internal::Type::ArrayOf[enum: Increase::ExportListParams::Category::In] },
           api_name: :in

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

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

    # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
    ACCOUNT_STATEMENT_OFX = :account_statement_ofx

    # Export a BAI2 file of transactions and balances for a given date and optional Account.
    ACCOUNT_STATEMENT_BAI2 = :account_statement_bai2

    # Export a CSV of all transactions for a given time range.
    TRANSACTION_CSV = :transaction_csv

    # Export a CSV of account balances for the dates in a given range.
    BALANCE_CSV = :balance_csv

    # Export a CSV of bookkeeping account balances for the dates in a given range.
    BOOKKEEPING_ACCOUNT_BALANCE_CSV = :bookkeeping_account_balance_csv

    # Export a CSV of entities with a given status.
    ENTITY_CSV = :entity_csv

    # Export a CSV of vendors added to the third-party risk management dashboard.
    VENDOR_CSV = :vendor_csv

    # Certain dashboard tables are available as CSV exports. This export cannot be created via the API.
    DASHBOARD_TABLE_CSV = :dashboard_table_csv

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

Instance Attribute Details

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

Filter Exports 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:



72
73
74
 
# File 'lib/increase/models/export_list_params.rb', line 72

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