@apideck/unify 0.38.0 → 0.38.2

package/src/funcs/proxyPatch.ts

@@ -0,0 +1,259 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ApideckCore } 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 { ApideckError } from "../models/errors/apideckerror.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 * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export enum PatchAcceptEnum {
+  applicationJson = "application/json",
+  textCsv = "text/csv",
+  textPlain = "text/plain",
+  applicationOctetStream = "application/octet-stream",
+  applicationPdf = "application/pdf",
+  applicationXml = "application/xml",
+  textHtml = "text/html",
+}
+
+/**
+ * PATCH
+ *
+ * @remarks
+ * Proxies a downstream PATCH request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional security layer and logging without needing to rely on Unify for normalization.
+ * **Note**: Vault will proxy all data to the downstream URL and method/verb in the headers.
+ */
+export function proxyPatch(
+  client: ApideckCore,
+  request: operations.ProxyPatchProxyRequest,
+  options?: RequestOptions & { acceptHeaderOverride?: PatchAcceptEnum },
+): APIPromise<
+  Result<
+    operations.ProxyPatchProxyResponse,
+    | errors.Unauthorized
+    | ApideckError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ApideckCore,
+  request: operations.ProxyPatchProxyRequest,
+  options?: RequestOptions & { acceptHeaderOverride?: PatchAcceptEnum },
+): Promise<
+  [
+    Result<
+      operations.ProxyPatchProxyResponse,
+      | errors.Unauthorized
+      | ApideckError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ProxyPatchProxyRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = payload.RequestBody;
+
+  const path = pathToFunc("/proxy")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": body instanceof Blob && body.type ? body.type : undefined,
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, text/csv;q=0.9, text/plain;q=0.7, application/octet-stream;q=0.6, application/pdf;q=0.4, application/xml;q=0.3, text/html;q=0",
+    "x-apideck-app-id": encodeSimple(
+      "x-apideck-app-id",
+      payload.appId ?? client._options.appId,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-consumer-id": encodeSimple(
+      "x-apideck-consumer-id",
+      payload.consumerId ?? client._options.consumerId,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-downstream-authorization": encodeSimple(
+      "x-apideck-downstream-authorization",
+      payload.downstreamAuthorization,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-downstream-url": encodeSimple(
+      "x-apideck-downstream-url",
+      payload.downstreamUrl,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-service-id": encodeSimple(
+      "x-apideck-service-id",
+      payload.serviceId,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-unified-api": encodeSimple(
+      "x-apideck-unified-api",
+      payload.unifiedApi,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  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: "proxy.patchProxy",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 900000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PATCH",
+    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", "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<
+    operations.ProxyPatchProxyResponse,
+    | errors.Unauthorized
+    | ApideckError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ProxyPatchProxyResponse$inboundSchema, {
+      key: "responseJson",
+    }),
+    M.stream(200, operations.ProxyPatchProxyResponse$inboundSchema, {
+      key: "responseBinary",
+    }),
+    M.stream(200, operations.ProxyPatchProxyResponse$inboundSchema, {
+      ctype: "application/pdf",
+      key: "responsePdf",
+    }),
+    M.text(200, operations.ProxyPatchProxyResponse$inboundSchema, {
+      ctype: "application/xml",
+      key: "responseXml",
+    }),
+    M.text(200, operations.ProxyPatchProxyResponse$inboundSchema, {
+      ctype: "text/csv",
+      key: "responseCsv",
+    }),
+    M.text(200, operations.ProxyPatchProxyResponse$inboundSchema, {
+      key: "responseText",
+    }),
+    M.jsonErr(401, errors.Unauthorized$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+    M.json("default", operations.ProxyPatchProxyResponse$inboundSchema, {
+      hdrs: true,
+      key: "errorJson",
+    }),
+    M.text("default", operations.ProxyPatchProxyResponse$inboundSchema, {
+      ctype: "application/xml",
+      hdrs: true,
+      key: "errorXml",
+    }),
+    M.text("default", operations.ProxyPatchProxyResponse$inboundSchema, {
+      ctype: "text/html",
+      hdrs: true,
+      key: "errorHtml",
+    }),
+    M.text("default", operations.ProxyPatchProxyResponse$inboundSchema, {
+      hdrs: true,
+      key: "errorText",
+    }),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/proxyPost.ts

@@ -0,0 +1,259 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ApideckCore } 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 { ApideckError } from "../models/errors/apideckerror.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 * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export enum PostAcceptEnum {
+  applicationJson = "application/json",
+  textCsv = "text/csv",
+  textPlain = "text/plain",
+  applicationOctetStream = "application/octet-stream",
+  applicationPdf = "application/pdf",
+  applicationXml = "application/xml",
+  textHtml = "text/html",
+}
+
+/**
+ * POST
+ *
+ * @remarks
+ * Proxies a downstream POST request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional security layer and logging without needing to rely on Unify for normalization.
+ * **Note**: Vault will proxy all data to the downstream URL and method/verb in the headers.
+ */
+export function proxyPost(
+  client: ApideckCore,
+  request: operations.ProxyPostProxyRequest,
+  options?: RequestOptions & { acceptHeaderOverride?: PostAcceptEnum },
+): APIPromise<
+  Result<
+    operations.ProxyPostProxyResponse,
+    | errors.Unauthorized
+    | ApideckError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ApideckCore,
+  request: operations.ProxyPostProxyRequest,
+  options?: RequestOptions & { acceptHeaderOverride?: PostAcceptEnum },
+): Promise<
+  [
+    Result<
+      operations.ProxyPostProxyResponse,
+      | errors.Unauthorized
+      | ApideckError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ProxyPostProxyRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = payload.RequestBody;
+
+  const path = pathToFunc("/proxy")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": body instanceof Blob && body.type ? body.type : undefined,
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, text/csv;q=0.9, text/plain;q=0.7, application/octet-stream;q=0.6, application/pdf;q=0.4, application/xml;q=0.3, text/html;q=0",
+    "x-apideck-app-id": encodeSimple(
+      "x-apideck-app-id",
+      payload.appId ?? client._options.appId,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-consumer-id": encodeSimple(
+      "x-apideck-consumer-id",
+      payload.consumerId ?? client._options.consumerId,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-downstream-authorization": encodeSimple(
+      "x-apideck-downstream-authorization",
+      payload.downstreamAuthorization,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-downstream-url": encodeSimple(
+      "x-apideck-downstream-url",
+      payload.downstreamUrl,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-service-id": encodeSimple(
+      "x-apideck-service-id",
+      payload.serviceId,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-unified-api": encodeSimple(
+      "x-apideck-unified-api",
+      payload.unifiedApi,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  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: "proxy.postProxy",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 900000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    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", "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<
+    operations.ProxyPostProxyResponse,
+    | errors.Unauthorized
+    | ApideckError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ProxyPostProxyResponse$inboundSchema, {
+      key: "responseJson",
+    }),
+    M.stream(200, operations.ProxyPostProxyResponse$inboundSchema, {
+      key: "responseBinary",
+    }),
+    M.stream(200, operations.ProxyPostProxyResponse$inboundSchema, {
+      ctype: "application/pdf",
+      key: "responsePdf",
+    }),
+    M.text(200, operations.ProxyPostProxyResponse$inboundSchema, {
+      ctype: "application/xml",
+      key: "responseXml",
+    }),
+    M.text(200, operations.ProxyPostProxyResponse$inboundSchema, {
+      ctype: "text/csv",
+      key: "responseCsv",
+    }),
+    M.text(200, operations.ProxyPostProxyResponse$inboundSchema, {
+      key: "responseText",
+    }),
+    M.jsonErr(401, errors.Unauthorized$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+    M.json("default", operations.ProxyPostProxyResponse$inboundSchema, {
+      hdrs: true,
+      key: "errorJson",
+    }),
+    M.text("default", operations.ProxyPostProxyResponse$inboundSchema, {
+      ctype: "application/xml",
+      hdrs: true,
+      key: "errorXml",
+    }),
+    M.text("default", operations.ProxyPostProxyResponse$inboundSchema, {
+      ctype: "text/html",
+      hdrs: true,
+      key: "errorHtml",
+    }),
+    M.text("default", operations.ProxyPostProxyResponse$inboundSchema, {
+      hdrs: true,
+      key: "errorText",
+    }),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}