The open-source agent harness - the runtime layer that turns an LLM into a working agent.
// This file was auto-generated by Fern from our API Definition.
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
import { mergeHeaders } from "../../../../core/headers.js";
import * as core from "../../../../core/index.js";
import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.js";
import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
import * as errors from "../../../../errors/index.js";
import * as serializers from "../../../../serialization/index.js";
import * as TrueForge from "../../../index.js";
export declare namespace SchedulesClient {
export type Options = BaseClientOptions;
export interface RequestOptions extends BaseRequestOptions {}
}
export class SchedulesClient {
protected readonly _options: NormalizedClientOptionsWithAuth<SchedulesClient.Options>;
constructor(options: SchedulesClient.Options) {
this._options = normalizeClientOptionsWithAuth(options);
}
/**
* List schedules for the tenant, newest first.
*
* @param {TrueForge.ListSchedulesRequest} request
* @param {SchedulesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.BadRequestError}
* @throws {@link TrueForge.UnauthorizedError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
* await client.schedules.list()
*/
public async list(
request: TrueForge.ListSchedulesRequest = {},
requestOptions?: SchedulesClient.RequestOptions,
): Promise<core.Page<TrueForge.Schedule, TrueForge.ListSchedulesResponse>> {
const list = core.HttpResponsePromise.interceptFunction(
async (
request: TrueForge.ListSchedulesRequest,
): Promise<core.WithRawResponse<TrueForge.ListSchedulesResponse>> => {
const { limit = 25, pageToken, agentNames, createdByMe } = request;
const _queryParams: Record<string, unknown> = {
limit,
page_token: pageToken,
agent_names: agentNames,
created_by_me: createdByMe,
};
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)),
"api/v1/schedules",
),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions?.queryParams)
.build(),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
fetchFn: this._options?.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.ListSchedulesResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrueForge.BadRequestError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 401:
throw new TrueForge.UnauthorizedError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
default:
throw new errors.TrueForgeError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/api/v1/schedules");
},
);
const dataWithRawResponse = await list(request).withRawResponse();
return new core.Page<TrueForge.Schedule, TrueForge.ListSchedulesResponse>({
response: dataWithRawResponse.data,
rawResponse: dataWithRawResponse.rawResponse,
hasNextPage: (response) =>
response?.pagination.nextPageToken != null &&
!(typeof response?.pagination.nextPageToken === "string" && response?.pagination.nextPageToken === ""),
getItems: (response) => response?.data ?? [],
loadPage: (response) => {
return list(core.setObjectProperty(request, "pageToken", response?.pagination.nextPageToken));
},
});
}
/**
* Create a schedule for an existing agent (by name) and add its first pending run when active.
*
* @param {TrueForge.CreateScheduleRequest} request
* @param {SchedulesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.BadRequestError}
* @throws {@link TrueForge.NotFoundError}
* @throws {@link TrueForge.ConflictError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
* await client.schedules.create({
* agentName: "agent_name",
* manifest: {
* cron: "cron",
* task: "task"
* },
* name: "name"
* })
*/
public create(
request: TrueForge.CreateScheduleRequest,
requestOptions?: SchedulesClient.RequestOptions,
): core.HttpResponsePromise<TrueForge.GetScheduleResponse> {
return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
}
private async __create(
request: TrueForge.CreateScheduleRequest,
requestOptions?: SchedulesClient.RequestOptions,
): Promise<core.WithRawResponse<TrueForge.GetScheduleResponse>> {
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)),
"api/v1/schedules",
),
method: "POST",
headers: _headers,
contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
requestType: "json",
body: mergeAdditionalBodyParameters(
serializers.CreateScheduleRequest.jsonOrThrow(request, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
omitUndefined: true,
}),
requestOptions?.additionalBodyParameters,
),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
fetchFn: this._options?.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.GetScheduleResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrueForge.BadRequestError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 404:
throw new TrueForge.NotFoundError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 409:
throw new TrueForge.ConflictError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
default:
throw new errors.TrueForgeError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/api/v1/schedules");
}
/**
* Start a schedule run immediately using the schedule task. Does not replace or advance the cron pending run.
*
* @param {TrueForge.CreateScheduleRunRequest} request
* @param {SchedulesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.BadRequestError}
* @throws {@link TrueForge.ForbiddenError}
* @throws {@link TrueForge.NotFoundError}
* @throws {@link TrueForge.ConflictError}
* @throws {@link TrueForge.UnprocessableEntityError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
* await client.schedules.createRun({
* scheduleId: "schedule_id"
* })
*/
public createRun(
request: TrueForge.CreateScheduleRunRequest,
requestOptions?: SchedulesClient.RequestOptions,
): core.HttpResponsePromise<TrueForge.CreateScheduleRunResponse> {
return core.HttpResponsePromise.fromPromise(this.__createRun(request, requestOptions));
}
private async __createRun(
request: TrueForge.CreateScheduleRunRequest,
requestOptions?: SchedulesClient.RequestOptions,
): Promise<core.WithRawResponse<TrueForge.CreateScheduleRunResponse>> {
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)),
"api/v1/schedules/runs",
),
method: "POST",
headers: _headers,
contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
requestType: "json",
body: mergeAdditionalBodyParameters(
serializers.CreateScheduleRunRequest.jsonOrThrow(request, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
omitUndefined: true,
}),
requestOptions?.additionalBodyParameters,
),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
fetchFn: this._options?.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.CreateScheduleRunResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrueForge.BadRequestError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 403:
throw new TrueForge.ForbiddenError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 404:
throw new TrueForge.NotFoundError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 409:
throw new TrueForge.ConflictError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 422:
throw new TrueForge.UnprocessableEntityError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
default:
throw new errors.TrueForgeError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/api/v1/schedules/runs");
}
/**
* Get a schedule by id.
*
* @param {string} schedule_id - Immutable schedule identifier.
* @param {SchedulesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.ForbiddenError}
* @throws {@link TrueForge.NotFoundError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
* await client.schedules.get("schedule_id")
*/
public get(
schedule_id: string,
requestOptions?: SchedulesClient.RequestOptions,
): core.HttpResponsePromise<TrueForge.GetScheduleResponse> {
return core.HttpResponsePromise.fromPromise(this.__get(schedule_id, requestOptions));
}
private async __get(
schedule_id: string,
requestOptions?: SchedulesClient.RequestOptions,
): Promise<core.WithRawResponse<TrueForge.GetScheduleResponse>> {
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)),
`api/v1/schedules/${core.url.encodePathParam(schedule_id, errors.TrueForgeError)}`,
),
method: "GET",
headers: _headers,
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
fetchFn: this._options?.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.GetScheduleResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 403:
throw new TrueForge.ForbiddenError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 404:
throw new TrueForge.NotFoundError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
default:
throw new errors.TrueForgeError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return handleNonStatusCodeError(
_response.error,
_response.rawResponse,
"GET",
"/api/v1/schedules/{schedule_id}",
);
}
/**
* Replace name and manifest; replaces or drops the pending run when status/cron/timezone change.
*
* @param {string} schedule_id - Immutable schedule identifier.
* @param {TrueForge.UpdateScheduleRequest} request
* @param {SchedulesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.BadRequestError}
* @throws {@link TrueForge.ForbiddenError}
* @throws {@link TrueForge.NotFoundError}
* @throws {@link TrueForge.ConflictError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
* await client.schedules.update("schedule_id", {
* manifest: {
* cron: "cron",
* task: "task"
* },
* name: "name"
* })
*/
public update(
schedule_id: string,
request: TrueForge.UpdateScheduleRequest,
requestOptions?: SchedulesClient.RequestOptions,
): core.HttpResponsePromise<TrueForge.GetScheduleResponse> {
return core.HttpResponsePromise.fromPromise(this.__update(schedule_id, request, requestOptions));
}
private async __update(
schedule_id: string,
request: TrueForge.UpdateScheduleRequest,
requestOptions?: SchedulesClient.RequestOptions,
): Promise<core.WithRawResponse<TrueForge.GetScheduleResponse>> {
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)),
`api/v1/schedules/${core.url.encodePathParam(schedule_id, errors.TrueForgeError)}`,
),
method: "PUT",
headers: _headers,
contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
requestType: "json",
body: mergeAdditionalBodyParameters(
serializers.UpdateScheduleRequest.jsonOrThrow(request, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
omitUndefined: true,
}),
requestOptions?.additionalBodyParameters,
),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
fetchFn: this._options?.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.GetScheduleResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrueForge.BadRequestError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 403:
throw new TrueForge.ForbiddenError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 404:
throw new TrueForge.NotFoundError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 409:
throw new TrueForge.ConflictError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
default:
throw new errors.TrueForgeError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return handleNonStatusCodeError(
_response.error,
_response.rawResponse,
"PUT",
"/api/v1/schedules/{schedule_id}",
);
}
/**
* Delete a schedule and its runs. Idempotent.
*
* @param {string} schedule_id - Immutable schedule identifier.
* @param {SchedulesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.UnauthorizedError}
* @throws {@link TrueForge.ForbiddenError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
* await client.schedules.delete("schedule_id")
*/
public delete(
schedule_id: string,
requestOptions?: SchedulesClient.RequestOptions,
): core.HttpResponsePromise<TrueForge.DeleteScheduleResponse> {
return core.HttpResponsePromise.fromPromise(this.__delete(schedule_id, requestOptions));
}
private async __delete(
schedule_id: string,
requestOptions?: SchedulesClient.RequestOptions,
): Promise<core.WithRawResponse<TrueForge.DeleteScheduleResponse>> {
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)),
`api/v1/schedules/${core.url.encodePathParam(schedule_id, errors.TrueForgeError)}`,
),
method: "DELETE",
headers: _headers,
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
fetchFn: this._options?.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.DeleteScheduleResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrueForge.UnauthorizedError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 403:
throw new TrueForge.ForbiddenError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
default:
throw new errors.TrueForgeError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return handleNonStatusCodeError(
_response.error,
_response.rawResponse,
"DELETE",
"/api/v1/schedules/{schedule_id}",
);
}
/**
* List runs of a schedule, newest `scheduled_for` first. Available to its creator or a manager of its agent.
*
* @param {string} schedule_id - Immutable schedule identifier.
* @param {TrueForge.ListRunsSchedulesRequest} request
* @param {SchedulesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.BadRequestError}
* @throws {@link TrueForge.ForbiddenError}
* @throws {@link TrueForge.NotFoundError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
* await client.schedules.listRuns("schedule_id")
*/
public async listRuns(
schedule_id: string,
request: TrueForge.ListRunsSchedulesRequest = {},
requestOptions?: SchedulesClient.RequestOptions,
): Promise<core.Page<TrueForge.ScheduleRun, TrueForge.ListScheduleRunsResponse>> {
const list = core.HttpResponsePromise.interceptFunction(
async (
request: TrueForge.ListRunsSchedulesRequest,
): Promise<core.WithRawResponse<TrueForge.ListScheduleRunsResponse>> => {
const { limit = 25, pageToken } = request;
const _queryParams: Record<string, unknown> = {
limit,
page_token: pageToken,
};
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)),
`api/v1/schedules/${core.url.encodePathParam(schedule_id, errors.TrueForgeError)}/runs`,
),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions?.queryParams)
.build(),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
fetchFn: this._options?.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.ListScheduleRunsResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrueForge.BadRequestError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 403:
throw new TrueForge.ForbiddenError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
case 404:
throw new TrueForge.NotFoundError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
}),
_response.rawResponse,
);
default:
throw new errors.TrueForgeError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return handleNonStatusCodeError(
_response.error,
_response.rawResponse,
"GET",
"/api/v1/schedules/{schedule_id}/runs",
);
},
);
const dataWithRawResponse = await list(request).withRawResponse();
return new core.Page<TrueForge.ScheduleRun, TrueForge.ListScheduleRunsResponse>({
response: dataWithRawResponse.data,
rawResponse: dataWithRawResponse.rawResponse,
hasNextPage: (response) =>
response?.pagination.nextPageToken != null &&
!(typeof response?.pagination.nextPageToken === "string" && response?.pagination.nextPageToken === ""),
getItems: (response) => response?.data ?? [],
loadPage: (response) => {
return list(core.setObjectProperty(request, "pageToken", response?.pagination.nextPageToken));
},
});
}
}