Class: Increase::Resources::Exports

Inherits:

Object

• Object
• Increase::Resources::Exports

Defined in:

lib/increase/resources/exports.rb,
sig/increase/resources/exports.rbs

Instance Method Summary

• #create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, fee_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {}) ⇒ Increase::Models::Export

  Create an Export.

• #initialize(client:) ⇒ Exports constructor private

  A new instance of Exports.

• #list(category: nil, created_at: nil, cursor: nil, form_1099_int: nil, form_1099_misc: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Export>

  List Exports.

• #retrieve(export_id, request_options: {}) ⇒ Increase::Models::Export

  Retrieve an Export.

Constructor Details

#initialize(client:) ⇒ Exports

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Exports.

Parameters:

• client (Increase::Client)
• client: (Increase::Client)

# File 'lib/increase/resources/exports.rb', line 137

def initialize(client:)
  @client = client
end

Instance Method Details

#create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, fee_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {}) ⇒ Increase::Models::Export

Create an Export

Parameters:

• category (Symbol, Increase::Models::ExportCreateParams::Category) —

  The type of Export to create.

• account_statement_bai2 (Increase::Models::ExportCreateParams::AccountStatementBai2) —

  Options for the created export. Required if category is equal to account_statement_bai2.

• account_statement_ofx (Increase::Models::ExportCreateParams::AccountStatementOfx) —

  Options for the created export. Required if category is equal to account_statement_ofx.

• account_verification_letter (Increase::Models::ExportCreateParams::AccountVerificationLetter) —

  Options for the created export. Required if category is equal to account_verification_letter.

• bookkeeping_account_balance_csv (Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv) —

  Options for the created export. Required if category is equal to bookkeeping_account_balance_csv.

• daily_account_balance_csv (Increase::Models::ExportCreateParams::DailyAccountBalanceCsv) —

  Options for the created export. Required if category is equal to daily_account_balance_csv.

• entity_csv (Increase::Models::ExportCreateParams::EntityCsv) —

  Options for the created export. Required if category is equal to entity_csv.

• fee_csv (Increase::Models::ExportCreateParams::FeeCsv) —

  Options for the created export. Required if category is equal to fee_csv.

• funding_instructions (Increase::Models::ExportCreateParams::FundingInstructions) —

  Options for the created export. Required if category is equal to funding_instructions.

• transaction_csv (Increase::Models::ExportCreateParams::TransactionCsv) —

  Options for the created export. Required if category is equal to transaction_csv.

• vendor_csv (Increase::Models::ExportCreateParams::VendorCsv) —

  Options for the created export. Required if category is equal to vendor_csv.

• voided_check (Increase::Models::ExportCreateParams::VoidedCheck) —

  Options for the created export. Required if category is equal to voided_check.

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

Returns:

• (Increase::Models::Export)

See Also:

• Models::ExportCreateParams

# File 'lib/increase/resources/exports.rb', line 58

def create(params)
  parsed, options = Increase::ExportCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "exports",
    body: parsed,
    model: Increase::Export,
    options: options
  )
end

#list(category: nil, created_at: nil, cursor: nil, form_1099_int: nil, form_1099_misc: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Export>

List Exports

Parameters:

• category (Symbol, Increase::Models::ExportListParams::Category) —

  Filter Exports for those with the specified category.

• created_at (Increase::Models::ExportListParams::CreatedAt)
• cursor (String) —

  Return the page of entries after this one.

• form_1099_int (Increase::Models::ExportListParams::Form1099Int)
• form_1099_misc (Increase::Models::ExportListParams::Form1099Misc)
• idempotency_key (String) —

  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) —

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

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

Returns:

• (Increase::Internal::Page<Increase::Models::Export>)

See Also:

• Models::ExportListParams

# File 'lib/increase/resources/exports.rb', line 121

def list(params = {})
  parsed, options = Increase::ExportListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "exports",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::Export,
    options: options
  )
end

#retrieve(export_id, request_options: {}) ⇒ Increase::Models::Export

Retrieve an Export

Parameters:

• export_id (String) —

  The identifier of the Export to retrieve.

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

Returns:

• (Increase::Models::Export)

See Also:

• Models::ExportRetrieveParams

# File 'lib/increase/resources/exports.rb', line 80

def retrieve(export_id, params = {})
  @client.request(
    method: :get,
    path: ["exports/%1$s", export_id],
    model: Increase::Export,
    options: params[:request_options]
  )
end