Interface ReliableReportingConsumerV1<TCredential>

interface ReliableReportingConsumerV1<TCredential = unknown> {
    start(): void;
    stop(): Promise<void>;
    replaceAccounts(
        accounts: readonly ReliableReportingConsumerAccountV1<TCredential>[],
    ): void;
    runAccount(
        accountId: string,
        reason?: ReliableReportingConsumerRunReasonV1,
        consumerScope?: string,
    ): Promise<ReliableReportingConsumerRunResultV1>;
    handleAuthenticatedNotification(
        payload: unknown,
        authentication: { consumerScope: string },
    ): Promise<ReliableReportingConsumerRunResultV1 | null>;
}

Type Parameters

TCredential = unknown

Index

Methods

start stop replaceAccounts runAccount handleAuthenticatedNotification

Methods

start

start(): void
Returns void
- Defined in src/lib/reporting/consumer-runtime.ts:106

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in src/lib/reporting/consumer-runtime.ts:107

replaceAccounts

replaceAccounts(
accounts: readonly ReliableReportingConsumerAccountV1<TCredential>[],
): void
Atomically replace the configured account roster without restarting the worker.
Parameters
- accounts: readonly ReliableReportingConsumerAccountV1<TCredential>[]
Returns void
- Defined in src/lib/reporting/consumer-runtime.ts:109

runAccount

runAccount(
    accountId: string,
    reason?: ReliableReportingConsumerRunReasonV1,
    consumerScope?: string,
): Promise<ReliableReportingConsumerRunResultV1>
Parameters
- accountId: string
- Optionalreason: ReliableReportingConsumerRunReasonV1
- OptionalconsumerScope: string
  Required when the same account ID is configured under multiple authenticated sellers/principals.
Returns Promise<ReliableReportingConsumerRunResultV1>
- Defined in src/lib/reporting/consumer-runtime.ts:110

handleAuthenticatedNotification

handleAuthenticatedNotification(
payload: unknown,
authentication: { consumerScope: string },
): Promise<ReliableReportingConsumerRunResultV1 | null>
Call only after authenticating and verifying the webhook signature.
Parameters
- payload: unknown
- authentication: { consumerScope: string }
Returns Promise<ReliableReportingConsumerRunResultV1 | null>
- Defined in src/lib/reporting/consumer-runtime.ts:117