featureFlagsDelete.ts•5.61 kB
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import * as z from "zod";
import { LaunchDarklyCore } from "../core.js";
import { encodeSimple } from "../lib/encodings.js";
import * as M from "../lib/matchers.js";
import { compactMap } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { RequestOptions } from "../lib/sdks.js";
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
import { pathToFunc } from "../lib/url.js";
import {
ConnectionError,
InvalidRequestError,
RequestAbortedError,
RequestTimeoutError,
UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { LaunchDarklyError } from "../models/errors/launchdarklyerror.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { APICall, APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
* Delete feature flag
*
* @remarks
* Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
*/
export function featureFlagsDelete(
client: LaunchDarklyCore,
request: operations.DeleteFeatureFlagRequest,
options?: RequestOptions,
): APIPromise<
Result<
void,
| errors.UnauthorizedErrorRep
| errors.NotFoundErrorRep
| errors.StatusConflictErrorRep
| errors.RateLimitedErrorRep
| LaunchDarklyError
| ResponseValidationError
| ConnectionError
| RequestAbortedError
| RequestTimeoutError
| InvalidRequestError
| UnexpectedClientError
| SDKValidationError
>
> {
return new APIPromise($do(
client,
request,
options,
));
}
async function $do(
client: LaunchDarklyCore,
request: operations.DeleteFeatureFlagRequest,
options?: RequestOptions,
): Promise<
[
Result<
void,
| errors.UnauthorizedErrorRep
| errors.NotFoundErrorRep
| errors.StatusConflictErrorRep
| errors.RateLimitedErrorRep
| LaunchDarklyError
| ResponseValidationError
| ConnectionError
| RequestAbortedError
| RequestTimeoutError
| InvalidRequestError
| UnexpectedClientError
| SDKValidationError
>,
APICall,
]
> {
const parsed = safeParse(
request,
(value) => operations.DeleteFeatureFlagRequest$outboundSchema.parse(value),
"Input validation failed",
);
if (!parsed.ok) {
return [parsed, { status: "invalid" }];
}
const payload = parsed.value;
const body = null;
const pathParams = {
featureFlagKey: encodeSimple("featureFlagKey", payload.featureFlagKey, {
explode: false,
charEncoding: "percent",
}),
projectKey: encodeSimple("projectKey", payload.projectKey, {
explode: false,
charEncoding: "percent",
}),
};
const path = pathToFunc("/api/v2/flags/{projectKey}/{featureFlagKey}")(
pathParams,
);
const headers = new Headers(compactMap({
Accept: "application/json",
}));
const secConfig = await extractSecurity(client._options.apiKey);
const securityInput = secConfig == null ? {} : { apiKey: secConfig };
const requestSecurity = resolveGlobalSecurity(securityInput);
const context = {
options: client._options,
baseURL: options?.serverURL ?? client._baseURL ?? "",
operationID: "deleteFeatureFlag",
oAuth2Scopes: [],
resolvedSecurity: requestSecurity,
securitySource: client._options.apiKey,
retryConfig: options?.retries
|| client._options.retryConfig
|| { strategy: "none" },
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
};
const requestRes = client._createRequest(context, {
security: requestSecurity,
method: "DELETE",
baseURL: options?.serverURL,
path: path,
headers: headers,
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,
errorCodes: ["401", "404", "409", "429", "4XX", "5XX"],
retryConfig: context.retryConfig,
retryCodes: context.retryCodes,
});
if (!doResult.ok) {
return [doResult, { status: "request-error", request: req }];
}
const response = doResult.value;
const responseFields = {
HttpMeta: { Response: response, Request: req },
};
const [result] = await M.match<
void,
| errors.UnauthorizedErrorRep
| errors.NotFoundErrorRep
| errors.StatusConflictErrorRep
| errors.RateLimitedErrorRep
| LaunchDarklyError
| ResponseValidationError
| ConnectionError
| RequestAbortedError
| RequestTimeoutError
| InvalidRequestError
| UnexpectedClientError
| SDKValidationError
>(
M.nil(204, z.void()),
M.jsonErr(401, errors.UnauthorizedErrorRep$inboundSchema),
M.jsonErr(404, errors.NotFoundErrorRep$inboundSchema),
M.jsonErr(409, errors.StatusConflictErrorRep$inboundSchema),
M.jsonErr(429, errors.RateLimitedErrorRep$inboundSchema),
M.fail("4XX"),
M.fail("5XX"),
)(response, req, { extraFields: responseFields });
if (!result.ok) {
return [result, { status: "complete", request: req, response }];
}
return [result, { status: "complete", request: req, response }];
}