@docusign/iam-sdk/dist/commonjs/sdk/workspaceuploadrequest.d.ts

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

import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import * as operations from "../models/operations/index.js";
export declare class WorkspaceUploadRequest extends ClientSDK {
    /**
     * Creates a new upload request within a workspace
     *
     * @remarks
     * This operation creates a new upload request within a workspace. The upload request includes name, description, due date, and user assignments. Upload requests can be created as drafts or sent immediately based on the status field.
     */
    createWorkspaceUploadRequest(request: operations.CreateWorkspaceUploadRequestRequest, options?: RequestOptions): Promise<components.GetWorkspaceUploadRequestResponse>;
    /**
     * Gets upload requests within a workspace
     *
     * @remarks
     * This operation retrieves a list of upload requests within a workspace. Each upload request includes details such as ID, name, description, status, owner information, associated documents, assignments, and various dates.
     */
    getWorkspaceUploadRequests(request: operations.GetWorkspaceUploadRequestsRequest, options?: RequestOptions): Promise<components.GetWorkspaceUploadRequestsResponse>;
    /**
     * Gets details for a specific upload request
     *
     * @remarks
     * This operation retrieves details about a specific upload request within a workspace. The response includes comprehensive information about the upload request including status, assigned users, associated documents, owner details, and various dates.
     */
    getWorkspaceUploadRequest(request: operations.GetWorkspaceUploadRequestRequest, options?: RequestOptions): Promise<components.GetWorkspaceUploadRequestResponse>;
    /**
     * Updates a specific upload request
     *
     * @remarks
     * This operation updates a specific upload request within a workspace. Only draft upload requests can be edited. The editable fields are name, description, due date, and status. Status changes are restricted - only transitions from draft to in_progress are allowed. Attempting to update a non-draft upload request will result in an INVALID_STATUS error. Attempting an invalid status change will result in an INVALID_STATUS_CHANGE error.
     */
    updateWorkspaceUploadRequest(request: operations.UpdateWorkspaceUploadRequestRequest, options?: RequestOptions): Promise<components.GetWorkspaceUploadRequestResponse>;
    /**
     * Deletes a specific upload request
     *
     * @remarks
     * This operation deletes a specific upload request within a workspace. Upload requests cannot be deleted if they are complete or have associated documents.
     */
    deleteWorkspaceUploadRequest(request: operations.DeleteWorkspaceUploadRequestRequest, options?: RequestOptions): Promise<void>;
    /**
     * 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.
     */
    addWorkspaceUploadRequestDocument(request: operations.AddWorkspaceUploadRequestDocumentRequest, options?: RequestOptions): Promise<components.AddWorkspaceUploadRequestDocumentResponse>;
    /**
     * Complete an upload request
     *
     * @remarks
     * This operation completes a specific upload request within a workspace and is intended to be called by the user completing the upload request. Only upload requests that are in progress can be completed.
     */
    completeWorkspaceUploadRequest(request: operations.CompleteWorkspaceUploadRequestRequest, options?: RequestOptions): Promise<void>;
}
//# sourceMappingURL=workspaceuploadrequest.d.ts.map