@docusign/iam-sdk/src/funcs/workspacesWorkspaceUploadRequestAddWorkspaceUploadRequestDocument.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.

/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import { IamClientCore } from "../core.js";
import { appendForm, encodeSimple, normalizeBlob } from "../lib/encodings.js";
import {
  bytesToBlob,
  getContentTypeFromFileName,
  readableStreamToArrayBuffer,
} from "../lib/files.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 * as components from "../models/components/index.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import { IamClientError } from "../models/errors/iamclienterror.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 { isBlobLike } from "../types/blobs.js";
import { Result } from "../types/fp.js";
import { isReadableStream } from "../types/streams.js";

/**
 * Add a document to an upload request via file upload
 *
 * @remarks
 * This operation adds a document to a specific upload request within a workspace via file upload. The file is passed in the request body as multipart/form-data. The file name is used as the document name.
 *
 * If set, this operation will use {@link Security.accessToken} from the global security.
 */
export function workspacesWorkspaceUploadRequestAddWorkspaceUploadRequestDocument(
  client: IamClientCore,
  request: operations.AddWorkspaceUploadRequestDocumentRequest,
  options?: RequestOptions,
): APIPromise<
  Result<
    components.AddWorkspaceUploadRequestDocumentResponse,
    | errors.ErrorDetails
    | IamClientError
    | ResponseValidationError
    | ConnectionError
    | RequestAbortedError
    | RequestTimeoutError
    | InvalidRequestError
    | UnexpectedClientError
    | SDKValidationError
  >
> {
  return new APIPromise($do(
    client,
    request,
    options,
  ));
}

async function $do(
  client: IamClientCore,
  request: operations.AddWorkspaceUploadRequestDocumentRequest,
  options?: RequestOptions,
): Promise<
  [
    Result<
      components.AddWorkspaceUploadRequestDocumentResponse,
      | errors.ErrorDetails
      | IamClientError
      | ResponseValidationError
      | ConnectionError
      | RequestAbortedError
      | RequestTimeoutError
      | InvalidRequestError
      | UnexpectedClientError
      | SDKValidationError
    >,
    APICall,
  ]
> {
  const parsed = safeParse(
    request,
    (value) =>
      operations.AddWorkspaceUploadRequestDocumentRequest$outboundSchema.parse(
        value,
      ),
    "Input validation failed",
  );
  if (!parsed.ok) {
    return [parsed, { status: "invalid" }];
  }
  const payload = parsed.value;
  const body = new FormData();
  if (payload.AddWorkspaceUploadRequestDocumentRequest != null) {
    if (payload.AddWorkspaceUploadRequestDocumentRequest.file !== undefined) {
      if (isBlobLike(payload.AddWorkspaceUploadRequestDocumentRequest.file)) {
        const file = payload.AddWorkspaceUploadRequestDocumentRequest.file;
        const blob = await normalizeBlob(file);
        const name = "name" in file ? (file.name as string) : undefined;
        appendForm(body, "file", blob, name);
      } else if (
        isReadableStream(
          payload.AddWorkspaceUploadRequestDocumentRequest.file.content,
        )
      ) {
        const buffer = await readableStreamToArrayBuffer(
          payload.AddWorkspaceUploadRequestDocumentRequest.file.content,
        );
        const contentType =
          getContentTypeFromFileName(
            payload.AddWorkspaceUploadRequestDocumentRequest.file.fileName,
          ) || "application/octet-stream";
        appendForm(
          body,
          "file",
          bytesToBlob(buffer, contentType),
          payload.AddWorkspaceUploadRequestDocumentRequest.file.fileName,
        );
      } else {
        const contentType =
          getContentTypeFromFileName(
            payload.AddWorkspaceUploadRequestDocumentRequest.file.fileName,
          ) || "application/octet-stream";
        appendForm(
          body,
          "file",
          bytesToBlob(
            payload.AddWorkspaceUploadRequestDocumentRequest.file.content,
            contentType,
          ),
          payload.AddWorkspaceUploadRequestDocumentRequest.file.fileName,
        );
      }
    }
  }

  const pathParams = {
    accountId: encodeSimple("accountId", payload.accountId, {
      explode: false,
      charEncoding: "percent",
    }),
    uploadRequestId: encodeSimple("uploadRequestId", payload.uploadRequestId, {
      explode: false,
      charEncoding: "percent",
    }),
    workspaceId: encodeSimple("workspaceId", payload.workspaceId, {
      explode: false,
      charEncoding: "percent",
    }),
  };
  const path = pathToFunc(
    "/v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests/{uploadRequestId}/documents",
  )(pathParams);

  const headers = new Headers(compactMap({
    Accept: "application/json",
  }));

  const secConfig = await extractSecurity(client._options.accessToken);
  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
  const requestSecurity = resolveGlobalSecurity(securityInput, [0]);

  const context = {
    options: client._options,
    baseURL: options?.serverURL ?? client._baseURL ?? "",
    operationID: "addWorkspaceUploadRequestDocument",
    oAuth2Scopes: null,

    resolvedSecurity: requestSecurity,

    securitySource: client._options.accessToken,
    retryConfig: options?.retries
      || client._options.retryConfig
      || {
        strategy: "backoff",
        backoff: {
          initialInterval: 500,
          maxInterval: 5000,
          exponent: 1.5,
          maxElapsedTime: 30000,
        },
        retryConnectionErrors: true,
      }
      || { strategy: "none" },
    retryCodes: options?.retryCodes || ["5XX", "429"],
  };

  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,
    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<
    components.AddWorkspaceUploadRequestDocumentResponse,
    | errors.ErrorDetails
    | IamClientError
    | ResponseValidationError
    | ConnectionError
    | RequestAbortedError
    | RequestTimeoutError
    | InvalidRequestError
    | UnexpectedClientError
    | SDKValidationError
  >(
    M.json(
      201,
      components.AddWorkspaceUploadRequestDocumentResponse$inboundSchema,
    ),
    M.jsonErr([400, 401], errors.ErrorDetails$inboundSchema),
    M.jsonErr(500, errors.ErrorDetails$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 }];
}