@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
70 lines • 3.12 kB
TypeScript
import * as z from "zod";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
/**
* Control information and metadata for the response.
*/
export type TriggerWorkflowSuccess = {
instanceId?: string | undefined;
/**
* A fully-qualified URL that can be used to access or interact with this
*
* @remarks
* workflow instance while it is running. This URL may provide access to
* additional details, actions, or logs related to the workflow execution.
*/
instanceUrl?: string | undefined;
/**
* The maximum number of items that can be returned in a single page.
*/
pageLimit?: number | null | undefined;
/**
* The continuation token used to retrieve a page in a paginated response.
*/
pageTokenNext?: string | null | undefined;
/**
* Unique identifier for the request, useful for tracking and debugging.
*/
requestId?: string | null | undefined;
/**
* The timestamp indicating when the response was generated.
*/
responseTimestamp?: Date | null | undefined;
/**
* The duration of time, in milliseconds, that the server took to process and respond
*
* @remarks
* to the request. This is measured from the time the server received the request
* until the time the response was sent.
*/
responseDurationMs?: number | null | undefined;
};
/** @internal */
export declare const TriggerWorkflowSuccess$inboundSchema: z.ZodType<TriggerWorkflowSuccess, z.ZodTypeDef, unknown>;
/** @internal */
export type TriggerWorkflowSuccess$Outbound = {
instance_id?: string | undefined;
instance_url?: string | undefined;
page_limit?: number | null | undefined;
page_token_next?: string | null | undefined;
request_id?: string | null | undefined;
response_timestamp?: string | null | undefined;
response_duration_ms?: number | null | undefined;
};
/** @internal */
export declare const TriggerWorkflowSuccess$outboundSchema: z.ZodType<TriggerWorkflowSuccess$Outbound, z.ZodTypeDef, TriggerWorkflowSuccess>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace TriggerWorkflowSuccess$ {
/** @deprecated use `TriggerWorkflowSuccess$inboundSchema` instead. */
const inboundSchema: z.ZodType<TriggerWorkflowSuccess, z.ZodTypeDef, unknown>;
/** @deprecated use `TriggerWorkflowSuccess$outboundSchema` instead. */
const outboundSchema: z.ZodType<TriggerWorkflowSuccess$Outbound, z.ZodTypeDef, TriggerWorkflowSuccess>;
/** @deprecated use `TriggerWorkflowSuccess$Outbound` instead. */
type Outbound = TriggerWorkflowSuccess$Outbound;
}
export declare function triggerWorkflowSuccessToJSON(triggerWorkflowSuccess: TriggerWorkflowSuccess): string;
export declare function triggerWorkflowSuccessFromJSON(jsonString: string): SafeParseResult<TriggerWorkflowSuccess, SDKValidationError>;
//# sourceMappingURL=triggerworkflowsuccess.d.ts.map