featureFlagsGet.ts•6.89 kB
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import { LaunchDarklyCore } from "../core.js";
import { encodeFormQuery, 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 * as components from "../models/components/index.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";
/**
* Get feature flag
*
* @remarks
* Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment.
*
* > #### Recommended use
* >
* > This endpoint can return a large amount of information. Specifying one or multiple environments with the `env` parameter can decrease response time and overall payload size. We recommend using this parameter to return only the environments relevant to your query.
*
* ### Expanding response
*
* LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields:
*
* - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days
* - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`.
*
* For example, `expand=evaluation` includes the `evaluation` field in the response.
*/
export function featureFlagsGet(
client: LaunchDarklyCore,
request: operations.GetFeatureFlagRequest,
options?: RequestOptions,
): APIPromise<
Result<
components.FeatureFlag,
| errors.UnauthorizedErrorRep
| errors.ForbiddenErrorRep
| errors.NotFoundErrorRep
| errors.RateLimitedErrorRep
| LaunchDarklyError
| ResponseValidationError
| ConnectionError
| RequestAbortedError
| RequestTimeoutError
| InvalidRequestError
| UnexpectedClientError
| SDKValidationError
>
> {
return new APIPromise($do(
client,
request,
options,
));
}
async function $do(
client: LaunchDarklyCore,
request: operations.GetFeatureFlagRequest,
options?: RequestOptions,
): Promise<
[
Result<
components.FeatureFlag,
| errors.UnauthorizedErrorRep
| errors.ForbiddenErrorRep
| errors.NotFoundErrorRep
| errors.RateLimitedErrorRep
| LaunchDarklyError
| ResponseValidationError
| ConnectionError
| RequestAbortedError
| RequestTimeoutError
| InvalidRequestError
| UnexpectedClientError
| SDKValidationError
>,
APICall,
]
> {
const parsed = safeParse(
request,
(value) => operations.GetFeatureFlagRequest$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 query = encodeFormQuery({
"env": payload.env,
"expand": payload.expand,
});
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: "getFeatureFlag",
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: "GET",
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,
errorCodes: ["401", "403", "404", "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<
components.FeatureFlag,
| errors.UnauthorizedErrorRep
| errors.ForbiddenErrorRep
| errors.NotFoundErrorRep
| errors.RateLimitedErrorRep
| LaunchDarklyError
| ResponseValidationError
| ConnectionError
| RequestAbortedError
| RequestTimeoutError
| InvalidRequestError
| UnexpectedClientError
| SDKValidationError
>(
M.json(200, components.FeatureFlag$inboundSchema),
M.jsonErr(401, errors.UnauthorizedErrorRep$inboundSchema),
M.jsonErr(403, errors.ForbiddenErrorRep$inboundSchema),
M.jsonErr(404, errors.NotFoundErrorRep$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 }];
}