@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
28 lines • 1.51 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { Affordance } from "./affordance.js";
/**
* Available actions for this document. Actions vary based on document state - upload actions during initial upload, remediation actions after processing.
*/
export type BulkJobItemActions = {
/**
* Azure Blob Store presigned URL to upload the document file (valid for ~8 hours)
*/
uploadDocument?: string | undefined;
/**
* Affordances (aka 'actions') describe the available operations on a resource, including CRUD and RPC-like operations. It details the
*
* @remarks
* expected input payload, http method, query parameters, and the resulting output.
*
* Affordances enable clients to dynamically adapt to the API's current state and available actions. Instead of
* hardcoding all possible endpoints and their associated logic, a client can inspect the affordances within a
* resource's representation to discover what actions are possible and how to perform them.
*/
updateMetadata?: Affordance | null | undefined;
};
/** @internal */
export declare const BulkJobItemActions$inboundSchema: z.ZodType<BulkJobItemActions, z.ZodTypeDef, unknown>;
export declare function bulkJobItemActionsFromJSON(jsonString: string): SafeParseResult<BulkJobItemActions, SDKValidationError>;
//# sourceMappingURL=bulkjobitemactions.d.ts.map