@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface StreamAccountChangesOptions

    interface StreamAccountChangesOptions {
        account: { account_id: string };
        cursor?: DurableAccountChangeCursor;
        resourceTypes?: readonly string[];
        maxResults?: number;
        taskOptions?: TaskOptions;
        bootstrap?: (context: AccountChangeBootstrapContext) => Promise<void>;
    }
    Index
    account cursor? resourceTypes? maxResults? taskOptions? bootstrap?
    account: { account_id: string }

    Type Declaration

    • account_id: string

      Seller-assigned account identifier. For upstream-managed account namespaces, this value comes from list_accounts; for seller-defined namespaces without a list_accounts surface, it is supplied out-of-band. Buyer-declared account sellers MAY echo account_id from sync_accounts as an internal handle, but they MUST continue accepting the account's current natural-key AccountRef on subsequent calls. A former key tombstoned by identity reconciliation returns ACCOUNT_MOVED to authorized callers.

    cursor?: DurableAccountChangeCursor

    Restored from the same seller/principal/account/filter partition.

    resourceTypes?: readonly string[]
    maxResults?: number
    taskOptions?: TaskOptions
    bootstrap?: (context: AccountChangeBootstrapContext) => Promise<void>

    Rebuild every authoritative snapshot in scope, including all statuses and pages. A fresh latest cursor is acquired BEFORE this hook. No checkpoint is offered until it succeeds and the subsequent feed page is processed. Without this hook, first use drains earliest; expiry throws a typed error.

    Settings
    Member Visibility

    On This Page
    Properties