Class: Ledger::Sdk::Models::Import::Instance

Inherits:

Base::Instance

Object
Base::Instance
Ledger::Sdk::Models::Import::Instance

show all

Defined in:: lib/ledger/sdk/models/import.rb

Overview

Represents an individual import instance.

Instance Method Summary collapse

#lines(id) ⇒ ImportLine::Instance
Returns one of this import's lines.
#retry ⇒ Hash
Replays the whole import.

Methods inherited from Base::Instance

association, #data, #initialize

Constructor Details

This class inherits a constructor from Ledger::Sdk::Models::Base::Instance

Instance Method Details

#lines(id) ⇒ `ImportLine::Instance`

Returns one of this import's lines.

The id is required: Ledger exposes no index for import lines — they come embedded in the import's own payload — so there is no line collection to return.

Parameters:

id (String, Integer) —
the import line identifier

Returns:

(ImportLine::Instance) —
the line, scoped to this import

#retry ⇒ `Hash`

Replays the whole import.

Only an import that has finished processing is retryable; Ledger answers a 422 import_not_retryable otherwise.