Class: Ledger::Sdk::Models::Container::Instance

Inherits:
Base::Instance show all
Defined in:
lib/ledger/sdk/models/container.rb

Overview

Represents an individual container instance.

Has associations to Account, Position, Fee and FeeExclusion allowing navigation to the accounts, positions, fees and fee exclusions attached to this container.

Instance Method Summary collapse

Methods inherited from Base::Instance

association, #data, #initialize

Constructor Details

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

Instance Method Details

#accounts(associated_id = nil) ⇒ Account, Account::Instance

Access the accounts associated with this container.

Parameters:

  • associated_id (String, Integer, nil) (defaults to: nil) —

    ID of a specific account, or nil to get the collection

Returns:

#balances(name) ⇒ Balance

Access the balances of this container for a given balance name.

Parameters:

  • name (String) —

    the balance name. Known names: official, official_with_updated_price, transparent, transparent_with_updated_price. Not validated by the SDK.

Returns:

  • (Balance) —

    the balance collection scoped to this container

#fee_exclusions(associated_id = nil) ⇒ FeeExclusion, FeeExclusion::Instance

Access the fee-base exclusions attached to this container.

Parameters:

  • associated_id (String, Integer, nil) (defaults to: nil) —

    ID of a specific fee exclusion, or nil to get the collection

Returns:

#fees(associated_id = nil) ⇒ Fee, Fee::Instance

Access the fees attached to this container.

Parameters:

  • associated_id (String, Integer, nil) (defaults to: nil) —

    ID of a specific fee, or nil to get the collection

Returns:

  • (Fee) —

    the fee collection (if no ID)

  • (Fee::Instance) —

    a fee instance (if ID provided)

#positions ⇒ Position

Access every position of this container in one call (each account's displayable positions), via /containers/<id>/positions.

Returns:

  • (Position) —

    the container-wide position collection

#update(attributes) ⇒ Hash

Updates this container's attributes. Alongside fees and fee-exclusions management, this is one of the SDK's few write operations — most of the SDK remains read-only. Used by folio to persist the container's asset manager (+manager_id+, a mosaic bank id). Updates this container's attributes. This is the SDK's ONE write operation — everything else is read-only. Used by folio to persist the container's asset manager (+manager_id+, a mosaic bank id).

Parameters:

  • attributes (Hash) —

    attributes to update, e.g. { manager_id: 42 }

Returns:

  • (Hash) —

    the refreshed container data