/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ import * as z from "zod/v3"; import { WistiaCore } from "../core.js"; 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 { 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 { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { WistiaError } from "../models/errors/wistiaerror.js"; import * as operations from "../models/operations/index.js"; import { APICall, APIPromise } from "../types/async.js"; import { Result } from "../types/fp.js"; /** * Show Media Embed Locations * * @remarks * Retrieve embed location analytics for a video. Returns a list of pages where the * video is embedded, ranked by the chosen metric. * * The date range between `start_date` and `end_date` must not exceed 2 years. * * * ## Requires api token with one of the following permissions * ``` * Read detailed stats * ``` * */ export function analyticsMediaGetAnalyticsMediasMediaIdEmbedLocations( client: WistiaCore, request: operations.GetAnalyticsMediasMediaIdEmbedLocationsRequest, options?: RequestOptions, ): APIPromise< Result< Array, | errors.GetAnalyticsMediasMediaIdEmbedLocationsBadRequestError | errors.GetAnalyticsMediasMediaIdEmbedLocationsUnauthorizedError | errors.GetAnalyticsMediasMediaIdEmbedLocationsForbiddenError | errors.GetAnalyticsMediasMediaIdEmbedLocationsInternalServerError | errors.GetAnalyticsMediasMediaIdEmbedLocationsServiceUnavailableError | WistiaError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError > > { return new APIPromise($do( client, request, options, )); } async function $do( client: WistiaCore, request: operations.GetAnalyticsMediasMediaIdEmbedLocationsRequest, options?: RequestOptions, ): Promise< [ Result< Array, | errors.GetAnalyticsMediasMediaIdEmbedLocationsBadRequestError | errors.GetAnalyticsMediasMediaIdEmbedLocationsUnauthorizedError | errors.GetAnalyticsMediasMediaIdEmbedLocationsForbiddenError | errors.GetAnalyticsMediasMediaIdEmbedLocationsInternalServerError | errors.GetAnalyticsMediasMediaIdEmbedLocationsServiceUnavailableError | WistiaError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >, APICall, ] > { const parsed = safeParse( request, (value) => operations.GetAnalyticsMediasMediaIdEmbedLocationsRequest$outboundSchema .parse(value), "Input validation failed", ); if (!parsed.ok) { return [parsed, { status: "invalid" }]; } const payload = parsed.value; const body = null; const pathParams = { mediaId: encodeSimple("mediaId", payload.mediaId, { explode: false, charEncoding: "percent", }), }; const path = pathToFunc("/analytics/medias/{mediaId}/embed_locations")( pathParams, ); const query = encodeFormQuery({ "embed_url": payload.embed_url, "end_date": payload.end_date, "per_page": payload.per_page, "sort_by": payload.sort_by, "sort_direction": payload.sort_direction, "start_date": payload.start_date, }); const headers = new Headers(compactMap({ Accept: "application/json", })); const secConfig = await extractSecurity(client._options.bearerAuth); const securityInput = secConfig == null ? {} : { bearerAuth: secConfig }; const requestSecurity = resolveGlobalSecurity(securityInput); const context = { options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "get_/analytics/medias/{mediaId}/embed_locations", oAuth2Scopes: null, resolvedSecurity: requestSecurity, securitySource: client._options.bearerAuth, 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, isErrorStatusCode: (statusCode: number) => matchStatusCode({ status: statusCode } as Response, ["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< Array, | errors.GetAnalyticsMediasMediaIdEmbedLocationsBadRequestError | errors.GetAnalyticsMediasMediaIdEmbedLocationsUnauthorizedError | errors.GetAnalyticsMediasMediaIdEmbedLocationsForbiddenError | errors.GetAnalyticsMediasMediaIdEmbedLocationsInternalServerError | errors.GetAnalyticsMediasMediaIdEmbedLocationsServiceUnavailableError | WistiaError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >( M.json( 200, z.array( operations .GetAnalyticsMediasMediaIdEmbedLocationsResponse$inboundSchema, ), ), M.jsonErr( 400, errors .GetAnalyticsMediasMediaIdEmbedLocationsBadRequestError$inboundSchema, ), M.jsonErr( 401, errors .GetAnalyticsMediasMediaIdEmbedLocationsUnauthorizedError$inboundSchema, ), M.jsonErr( 403, errors .GetAnalyticsMediasMediaIdEmbedLocationsForbiddenError$inboundSchema, ), M.jsonErr( 500, errors .GetAnalyticsMediasMediaIdEmbedLocationsInternalServerError$inboundSchema, ), M.jsonErr( 503, errors .GetAnalyticsMediasMediaIdEmbedLocationsServiceUnavailableError$inboundSchema, ), M.fail([404, "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 }]; }