Interface ReserveCompoundCreditInput

What reserveCompoundCredit reserves: a call's most, quoted inside the ledger from its rates and limits.

interface ReserveCompoundCreditInput {
    scopeId: string;
    operationId: string;
    kind: string;
    requestHash: string;
    rates: {
        primary: RateSnapshot;
        fallbacks?: readonly RateSnapshot[];
    };
    mediaComponent: string;
    durationSeconds: number;
    attempts: AttemptLimits;
    supplierDailyCapMicro: number;
    at: number;
    expiresAt: number;
    policy?: AllocationPolicy;
}

Properties

scopeId operationId kind requestHash rates mediaComponent durationSeconds attempts supplierDailyCapMicro at expiresAt policy?

Properties

scopeId

scopeId: string

operationId

operationId: string

The host's id for the call or run; a hold is made once for it.

kind

kind: string

What is held for, such as call or meeting_run.

requestHash

requestHash: string

A digest of the request the hold is for; the same operation with another digest is a conflict.

rates

rates: {
    primary: RateSnapshot;
    fallbacks?: readonly RateSnapshot[];
}

Type declaration

mediaComponent

mediaComponent: string

The component that prices connected time.

durationSeconds

durationSeconds: number

The call's full requested duration, whole seconds.

attempts

attempts: AttemptLimits

supplierDailyCapMicro

supplierDailyCapMicro: number

The platform's cap on supplier cost for the UTC day of at, across every scope.

at

at: number

expiresAt

expiresAt: number

When the hold's time is up and a reconcile asks about it.

Optional policy

policy?: AllocationPolicy

Settings

Member Visibility

Theme

On This Page

scopeIdoperationIdkindrequestHashratesmediaComponentdurationSecondsattemptssupplierDailyCapMicroatexpiresAtpolicy