FRE-709: Document duplicate recovery wake - FRE-635 already recovered via FRE-708
This commit is contained in:
71
node_modules/svix/src/api/backgroundTask.ts
generated
vendored
Normal file
71
node_modules/svix/src/api/backgroundTask.ts
generated
vendored
Normal file
@@ -0,0 +1,71 @@
|
||||
// this file is @generated
|
||||
|
||||
import {
|
||||
type BackgroundTaskOut,
|
||||
BackgroundTaskOutSerializer,
|
||||
} from "../models/backgroundTaskOut";
|
||||
import type { BackgroundTaskStatus } from "../models/backgroundTaskStatus";
|
||||
import type { BackgroundTaskType } from "../models/backgroundTaskType";
|
||||
import {
|
||||
type ListResponseBackgroundTaskOut,
|
||||
ListResponseBackgroundTaskOutSerializer,
|
||||
} from "../models/listResponseBackgroundTaskOut";
|
||||
import type { Ordering } from "../models/ordering";
|
||||
import { HttpMethod, SvixRequest, type SvixRequestContext } from "../request";
|
||||
|
||||
export interface BackgroundTaskListOptions {
|
||||
/** Filter the response based on the status. */
|
||||
status?: BackgroundTaskStatus;
|
||||
/** Filter the response based on the type. */
|
||||
task?: BackgroundTaskType;
|
||||
/** Limit the number of returned items */
|
||||
limit?: number;
|
||||
/** The iterator returned from a prior invocation */
|
||||
iterator?: string | null;
|
||||
/** The sorting order of the returned items */
|
||||
order?: Ordering;
|
||||
}
|
||||
|
||||
export class BackgroundTask {
|
||||
public constructor(private readonly requestCtx: SvixRequestContext) {}
|
||||
|
||||
/** List background tasks executed in the past 90 days. */
|
||||
public list(
|
||||
options?: BackgroundTaskListOptions
|
||||
): Promise<ListResponseBackgroundTaskOut> {
|
||||
const request = new SvixRequest(HttpMethod.GET, "/api/v1/background-task");
|
||||
|
||||
request.setQueryParams({
|
||||
status: options?.status,
|
||||
task: options?.task,
|
||||
limit: options?.limit,
|
||||
iterator: options?.iterator,
|
||||
order: options?.order,
|
||||
});
|
||||
|
||||
return request.send(
|
||||
this.requestCtx,
|
||||
ListResponseBackgroundTaskOutSerializer._fromJsonObject
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* List background tasks executed in the past 90 days.
|
||||
*
|
||||
* @deprecated Use list instead.
|
||||
* */
|
||||
public listByEndpoint(
|
||||
options?: BackgroundTaskListOptions
|
||||
): Promise<ListResponseBackgroundTaskOut> {
|
||||
return this.list(options);
|
||||
}
|
||||
|
||||
/** Get a background task by ID. */
|
||||
public get(taskId: string): Promise<BackgroundTaskOut> {
|
||||
const request = new SvixRequest(HttpMethod.GET, "/api/v1/background-task/{task_id}");
|
||||
|
||||
request.setPathParam("task_id", taskId);
|
||||
|
||||
return request.send(this.requestCtx, BackgroundTaskOutSerializer._fromJsonObject);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user