@vercel/sdk
Version:
<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>
91 lines • 3.74 kB
JavaScript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
import { matchStatusCode } from "../lib/http.js";
import * as M from "../lib/matchers.js";
import { compactMap } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
import { pathToFunc } from "../lib/url.js";
import { CancelDeploymentRequest$outboundSchema, CancelDeploymentResponseBody$inboundSchema, } from "../models/canceldeploymentop.js";
import { APIPromise } from "../types/async.js";
/**
* Cancel a deployment
*
* @remarks
* This endpoint allows you to cancel a deployment which is currently building, by supplying its `id` in the URL.
*
* If set, this operation will use {@link Security.bearerToken} from the global security.
*/
export function deploymentsCancelDeployment(client, request, options) {
return new APIPromise($do(client, request, options));
}
async function $do(client, request, options) {
const parsed = safeParse(request, (value) => CancelDeploymentRequest$outboundSchema.parse(value), "Input validation failed");
if (!parsed.ok) {
return [parsed, { status: "invalid" }];
}
const payload = parsed.value;
const body = null;
const pathParams = {
id: encodeSimple("id", payload.id, {
explode: false,
charEncoding: "percent",
}),
};
const path = pathToFunc("/v12/deployments/{id}/cancel")(pathParams);
const query = encodeFormQuery({
"slug": payload.slug,
"teamId": payload.teamId,
});
const headers = new Headers(compactMap({
Accept: "application/json",
}));
const secConfig = await extractSecurity(client._options.bearerToken);
const securityInput = secConfig == null ? {} : { bearerToken: secConfig };
const requestSecurity = resolveGlobalSecurity(securityInput, [0]);
const context = {
options: client._options,
baseURL: options?.serverURL ?? client._baseURL ?? "",
operationID: "cancelDeployment",
oAuth2Scopes: null,
resolvedSecurity: requestSecurity,
securitySource: client._options.bearerToken,
retryConfig: options?.retries
|| client._options.retryConfig
|| { strategy: "none" },
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
};
const requestRes = client._createRequest(context, {
security: requestSecurity,
method: "PATCH",
baseURL: options?.serverURL,
path: path,
headers: headers,
query: query,
body: body,
userAgent: client._options.userAgent,
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
}, options);
if (!requestRes.ok) {
return [requestRes, { status: "invalid" }];
}
const req = requestRes.value;
const doResult = await client._do(req, {
context,
isErrorStatusCode: (statusCode) => matchStatusCode({ status: statusCode }, ["4XX", "5XX"]),
retryConfig: context.retryConfig,
retryCodes: context.retryCodes,
});
if (!doResult.ok) {
return [doResult, { status: "request-error", request: req }];
}
const response = doResult.value;
const [result] = await M.match(M.json(200, CancelDeploymentResponseBody$inboundSchema), M.fail([400, 401, 403, 404, "4XX"]), M.fail("5XX"))(response, req);
if (!result.ok) {
return [result, { status: "complete", request: req, response }];
}
return [result, { status: "complete", request: req, response }];
}
//# sourceMappingURL=deploymentsCancelDeployment.js.map