@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
59 lines • 2.56 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 ResponseMetadata = {
/**
* 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 ResponseMetadata$inboundSchema: z.ZodType<ResponseMetadata, z.ZodTypeDef, unknown>;
/** @internal */
export type ResponseMetadata$Outbound = {
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 ResponseMetadata$outboundSchema: z.ZodType<ResponseMetadata$Outbound, z.ZodTypeDef, ResponseMetadata>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace ResponseMetadata$ {
/** @deprecated use `ResponseMetadata$inboundSchema` instead. */
const inboundSchema: z.ZodType<ResponseMetadata, z.ZodTypeDef, unknown>;
/** @deprecated use `ResponseMetadata$outboundSchema` instead. */
const outboundSchema: z.ZodType<ResponseMetadata$Outbound, z.ZodTypeDef, ResponseMetadata>;
/** @deprecated use `ResponseMetadata$Outbound` instead. */
type Outbound = ResponseMetadata$Outbound;
}
export declare function responseMetadataToJSON(responseMetadata: ResponseMetadata): string;
export declare function responseMetadataFromJSON(jsonString: string): SafeParseResult<ResponseMetadata, SDKValidationError>;
//# sourceMappingURL=responsemetadata.d.ts.map