@docusign/iam-sdk/src/models/components/triggerworkflowsuccess.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 * as z from "zod/v3";
import { remap as remap$ } from "../../lib/primitives.js";
import { safeParse } from "../../lib/schemas.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import * as types from "../../types/primitives.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";

/**
 * Control information and metadata for the response.
 */
export type TriggerWorkflowSuccess = {
  /**
   * A unique identifier for this specific instance of the workflow. This UUID
   *
   * @remarks
   * is used to reference the running instance in other API calls (e.g., to
   * retrieve its status or terminate the instance).
   * Example: '1a46ccde-9db4-42d6-94fa-0ddd07a3d2ff'
   */
  instanceId: string;
  /**
   * 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;
  /**
   * Unique identifier for the request, useful for tracking and debugging.
   */
  requestId: string | null;
  /**
   * The timestamp indicating when the response was generated.
   */
  responseTimestamp: Date | null;
  /**
   * 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;
};

/** @internal */
export const TriggerWorkflowSuccess$inboundSchema: z.ZodType<
  TriggerWorkflowSuccess,
  z.ZodTypeDef,
  unknown
> = z.object({
  instance_id: types.string().default("00000000-0000-0000-0000-000000000000"),
  instance_url: types.optional(types.string()),
  page_limit: z.nullable(types.number().default(25)),
  request_id: types.nullable(types.string()),
  response_timestamp: types.nullable(types.date()),
  response_duration_ms: types.nullable(types.number()),
}).transform((v) => {
  return remap$(v, {
    "instance_id": "instanceId",
    "instance_url": "instanceUrl",
    "page_limit": "pageLimit",
    "request_id": "requestId",
    "response_timestamp": "responseTimestamp",
    "response_duration_ms": "responseDurationMs",
  });
});

export function triggerWorkflowSuccessFromJSON(
  jsonString: string,
): SafeParseResult<TriggerWorkflowSuccess, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => TriggerWorkflowSuccess$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'TriggerWorkflowSuccess' from JSON`,
  );
}