@documenso/sdk-typescript 0.3.0 → 0.4.0

package/src/models/operations/recipientupdatetemplaterecipients.ts

@@ -24,6 +24,7 @@ export type RecipientUpdateTemplateRecipientsRoleRequest = ClosedEnum<
  */
 export const RecipientUpdateTemplateRecipientsAccessAuthRequest = {
   Account: "ACCOUNT",
+  TwoFactorAuth: "TWO_FACTOR_AUTH",
 } as const;
 /**
  * The type of authentication required for the recipient to access the document.
@@ -112,6 +113,7 @@ export type RecipientUpdateTemplateRecipientsSendStatus = ClosedEnum<
  */
 export const RecipientUpdateTemplateRecipientsAccessAuthResponse = {
   Account: "ACCOUNT",
+  TwoFactorAuth: "TWO_FACTOR_AUTH",
 } as const;
 /**
  * The type of authentication required for the recipient to access the document.
@@ -193,6 +195,14 @@ export type RecipientUpdateTemplateRecipientsValue2 = {
   value: string;
 };
 
+export const RecipientUpdateTemplateRecipientsDirection = {
+  Vertical: "vertical",
+  Horizontal: "horizontal",
+} as const;
+export type RecipientUpdateTemplateRecipientsDirection = ClosedEnum<
+  typeof RecipientUpdateTemplateRecipientsDirection
+>;
+
 export type RecipientUpdateTemplateRecipientsFieldMetaCheckbox = {
   label?: string | undefined;
   placeholder?: string | undefined;
@@ -202,6 +212,7 @@ export type RecipientUpdateTemplateRecipientsFieldMetaCheckbox = {
   values?: Array<RecipientUpdateTemplateRecipientsValue2> | undefined;
   validationRule?: string | undefined;
   validationLength?: number | undefined;
+  direction?: RecipientUpdateTemplateRecipientsDirection | undefined;
 };
 
 export const RecipientUpdateTemplateRecipientsTypeRadio = {
@@ -248,10 +259,10 @@ export type RecipientUpdateTemplateRecipientsFieldMetaNumber = {
   required?: boolean | undefined;
   readOnly?: boolean | undefined;
   type: RecipientUpdateTemplateRecipientsTypeNumber;
-  numberFormat?: string | undefined;
+  numberFormat?: string | null | undefined;
   value?: string | undefined;
-  minValue?: number | undefined;
-  maxValue?: number | undefined;
+  minValue?: number | null | undefined;
+  maxValue?: number | null | undefined;
   fontSize?: number | undefined;
   textAlign?: RecipientUpdateTemplateRecipientsTextAlign6 | undefined;
 };
@@ -389,22 +400,22 @@ export type RecipientUpdateTemplateRecipientsFieldMetaInitials = {
 };
 
 export type RecipientUpdateTemplateRecipientsFieldMetaUnion =
-  | RecipientUpdateTemplateRecipientsFieldMetaRadio
   | RecipientUpdateTemplateRecipientsFieldMetaInitials
   | RecipientUpdateTemplateRecipientsFieldMetaName
   | RecipientUpdateTemplateRecipientsFieldMetaEmail
   | RecipientUpdateTemplateRecipientsFieldMetaDate
-  | RecipientUpdateTemplateRecipientsFieldMetaDropdown
-  | RecipientUpdateTemplateRecipientsFieldMetaCheckbox
   | RecipientUpdateTemplateRecipientsFieldMetaText
-  | RecipientUpdateTemplateRecipientsFieldMetaNumber;
+  | RecipientUpdateTemplateRecipientsFieldMetaNumber
+  | RecipientUpdateTemplateRecipientsFieldMetaRadio
+  | RecipientUpdateTemplateRecipientsFieldMetaCheckbox
+  | RecipientUpdateTemplateRecipientsFieldMetaDropdown;
 
 export type RecipientUpdateTemplateRecipientsField = {
+  envelopeId: string;
+  envelopeItemId: string;
   type: RecipientUpdateTemplateRecipientsType;
   id: number;
   secondaryId: string;
-  documentId: number | null;
-  templateId: number | null;
   recipientId: number;
   /**
    * The page number of the field on the document. Starts from 1.
@@ -417,26 +428,27 @@ export type RecipientUpdateTemplateRecipientsField = {
   customText: string;
   inserted: boolean;
   fieldMeta:
-    | RecipientUpdateTemplateRecipientsFieldMetaRadio
     | RecipientUpdateTemplateRecipientsFieldMetaInitials
     | RecipientUpdateTemplateRecipientsFieldMetaName
     | RecipientUpdateTemplateRecipientsFieldMetaEmail
     | RecipientUpdateTemplateRecipientsFieldMetaDate
-    | RecipientUpdateTemplateRecipientsFieldMetaDropdown
-    | RecipientUpdateTemplateRecipientsFieldMetaCheckbox
     | RecipientUpdateTemplateRecipientsFieldMetaText
     | RecipientUpdateTemplateRecipientsFieldMetaNumber
+    | RecipientUpdateTemplateRecipientsFieldMetaRadio
+    | RecipientUpdateTemplateRecipientsFieldMetaCheckbox
+    | RecipientUpdateTemplateRecipientsFieldMetaDropdown
     | null;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 export type RecipientUpdateTemplateRecipientsRecipientResponse = {
+  envelopeId: string;
   role: RecipientUpdateTemplateRecipientsRoleResponse;
   readStatus: RecipientUpdateTemplateRecipientsReadStatus;
   signingStatus: RecipientUpdateTemplateRecipientsSigningStatus;
   sendStatus: RecipientUpdateTemplateRecipientsSendStatus;
   id: number;
-  documentId: number | null;
-  templateId: number | null;
   email: string;
   name: string;
   token: string;
@@ -450,6 +462,8 @@ export type RecipientUpdateTemplateRecipientsRecipientResponse = {
   signingOrder: number | null;
   rejectionReason: string | null;
   fields: Array<RecipientUpdateTemplateRecipientsField>;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /**
@@ -1211,6 +1225,29 @@ export function recipientUpdateTemplateRecipientsValue2FromJSON(
   );
 }
 
+/** @internal */
+export const RecipientUpdateTemplateRecipientsDirection$inboundSchema:
+  z.ZodNativeEnum<typeof RecipientUpdateTemplateRecipientsDirection> = z
+    .nativeEnum(RecipientUpdateTemplateRecipientsDirection);
+
+/** @internal */
+export const RecipientUpdateTemplateRecipientsDirection$outboundSchema:
+  z.ZodNativeEnum<typeof RecipientUpdateTemplateRecipientsDirection> =
+    RecipientUpdateTemplateRecipientsDirection$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RecipientUpdateTemplateRecipientsDirection$ {
+  /** @deprecated use `RecipientUpdateTemplateRecipientsDirection$inboundSchema` instead. */
+  export const inboundSchema =
+    RecipientUpdateTemplateRecipientsDirection$inboundSchema;
+  /** @deprecated use `RecipientUpdateTemplateRecipientsDirection$outboundSchema` instead. */
+  export const outboundSchema =
+    RecipientUpdateTemplateRecipientsDirection$outboundSchema;
+}
+
 /** @internal */
 export const RecipientUpdateTemplateRecipientsFieldMetaCheckbox$inboundSchema:
   z.ZodType<
@@ -1228,6 +1265,9 @@ export const RecipientUpdateTemplateRecipientsFieldMetaCheckbox$inboundSchema:
     ).optional(),
     validationRule: z.string().optional(),
     validationLength: z.number().optional(),
+    direction: RecipientUpdateTemplateRecipientsDirection$inboundSchema.default(
+      "vertical",
+    ),
   });
 
 /** @internal */
@@ -1240,6 +1280,7 @@ export type RecipientUpdateTemplateRecipientsFieldMetaCheckbox$Outbound = {
   values?: Array<RecipientUpdateTemplateRecipientsValue2$Outbound> | undefined;
   validationRule?: string | undefined;
   validationLength?: number | undefined;
+  direction: string;
 };
 
 /** @internal */
@@ -1259,6 +1300,8 @@ export const RecipientUpdateTemplateRecipientsFieldMetaCheckbox$outboundSchema:
     ).optional(),
     validationRule: z.string().optional(),
     validationLength: z.number().optional(),
+    direction: RecipientUpdateTemplateRecipientsDirection$outboundSchema
+      .default("vertical"),
   });
 
 /**
@@ -1543,10 +1586,10 @@ export const RecipientUpdateTemplateRecipientsFieldMetaNumber$inboundSchema:
     required: z.boolean().optional(),
     readOnly: z.boolean().optional(),
     type: RecipientUpdateTemplateRecipientsTypeNumber$inboundSchema,
-    numberFormat: z.string().optional(),
+    numberFormat: z.nullable(z.string()).optional(),
     value: z.string().optional(),
-    minValue: z.number().optional(),
-    maxValue: z.number().optional(),
+    minValue: z.nullable(z.number()).optional(),
+    maxValue: z.nullable(z.number()).optional(),
     fontSize: z.number().optional(),
     textAlign: RecipientUpdateTemplateRecipientsTextAlign6$inboundSchema
       .optional(),
@@ -1559,10 +1602,10 @@ export type RecipientUpdateTemplateRecipientsFieldMetaNumber$Outbound = {
   required?: boolean | undefined;
   readOnly?: boolean | undefined;
   type: string;
-  numberFormat?: string | undefined;
+  numberFormat?: string | null | undefined;
   value?: string | undefined;
-  minValue?: number | undefined;
-  maxValue?: number | undefined;
+  minValue?: number | null | undefined;
+  maxValue?: number | null | undefined;
   fontSize?: number | undefined;
   textAlign?: string | undefined;
 };
@@ -1579,10 +1622,10 @@ export const RecipientUpdateTemplateRecipientsFieldMetaNumber$outboundSchema:
     required: z.boolean().optional(),
     readOnly: z.boolean().optional(),
     type: RecipientUpdateTemplateRecipientsTypeNumber$outboundSchema,
-    numberFormat: z.string().optional(),
+    numberFormat: z.nullable(z.string()).optional(),
     value: z.string().optional(),
-    minValue: z.number().optional(),
-    maxValue: z.number().optional(),
+    minValue: z.nullable(z.number()).optional(),
+    maxValue: z.nullable(z.number()).optional(),
     fontSize: z.number().optional(),
     textAlign: RecipientUpdateTemplateRecipientsTextAlign6$outboundSchema
       .optional(),
@@ -2314,36 +2357,36 @@ export const RecipientUpdateTemplateRecipientsFieldMetaUnion$inboundSchema:
     z.ZodTypeDef,
     unknown
   > = z.union([
-    z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaRadio$inboundSchema),
     z.lazy(() =>
       RecipientUpdateTemplateRecipientsFieldMetaInitials$inboundSchema
     ),
     z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaName$inboundSchema),
     z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaEmail$inboundSchema),
     z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaDate$inboundSchema),
+    z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaText$inboundSchema),
     z.lazy(() =>
-      RecipientUpdateTemplateRecipientsFieldMetaDropdown$inboundSchema
+      RecipientUpdateTemplateRecipientsFieldMetaNumber$inboundSchema
     ),
+    z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaRadio$inboundSchema),
     z.lazy(() =>
       RecipientUpdateTemplateRecipientsFieldMetaCheckbox$inboundSchema
     ),
-    z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaText$inboundSchema),
     z.lazy(() =>
-      RecipientUpdateTemplateRecipientsFieldMetaNumber$inboundSchema
+      RecipientUpdateTemplateRecipientsFieldMetaDropdown$inboundSchema
     ),
   ]);
 
 /** @internal */
 export type RecipientUpdateTemplateRecipientsFieldMetaUnion$Outbound =
-  | RecipientUpdateTemplateRecipientsFieldMetaRadio$Outbound
   | RecipientUpdateTemplateRecipientsFieldMetaInitials$Outbound
   | RecipientUpdateTemplateRecipientsFieldMetaName$Outbound
   | RecipientUpdateTemplateRecipientsFieldMetaEmail$Outbound
   | RecipientUpdateTemplateRecipientsFieldMetaDate$Outbound
-  | RecipientUpdateTemplateRecipientsFieldMetaDropdown$Outbound
-  | RecipientUpdateTemplateRecipientsFieldMetaCheckbox$Outbound
   | RecipientUpdateTemplateRecipientsFieldMetaText$Outbound
-  | RecipientUpdateTemplateRecipientsFieldMetaNumber$Outbound;
+  | RecipientUpdateTemplateRecipientsFieldMetaNumber$Outbound
+  | RecipientUpdateTemplateRecipientsFieldMetaRadio$Outbound
+  | RecipientUpdateTemplateRecipientsFieldMetaCheckbox$Outbound
+  | RecipientUpdateTemplateRecipientsFieldMetaDropdown$Outbound;
 
 /** @internal */
 export const RecipientUpdateTemplateRecipientsFieldMetaUnion$outboundSchema:
@@ -2352,9 +2395,6 @@ export const RecipientUpdateTemplateRecipientsFieldMetaUnion$outboundSchema:
     z.ZodTypeDef,
     RecipientUpdateTemplateRecipientsFieldMetaUnion
   > = z.union([
-    z.lazy(() =>
-      RecipientUpdateTemplateRecipientsFieldMetaRadio$outboundSchema
-    ),
     z.lazy(() =>
       RecipientUpdateTemplateRecipientsFieldMetaInitials$outboundSchema
     ),
@@ -2363,15 +2403,18 @@ export const RecipientUpdateTemplateRecipientsFieldMetaUnion$outboundSchema:
       RecipientUpdateTemplateRecipientsFieldMetaEmail$outboundSchema
     ),
     z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaDate$outboundSchema),
+    z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaText$outboundSchema),
     z.lazy(() =>
-      RecipientUpdateTemplateRecipientsFieldMetaDropdown$outboundSchema
+      RecipientUpdateTemplateRecipientsFieldMetaNumber$outboundSchema
+    ),
+    z.lazy(() =>
+      RecipientUpdateTemplateRecipientsFieldMetaRadio$outboundSchema
     ),
     z.lazy(() =>
       RecipientUpdateTemplateRecipientsFieldMetaCheckbox$outboundSchema
     ),
-    z.lazy(() => RecipientUpdateTemplateRecipientsFieldMetaText$outboundSchema),
     z.lazy(() =>
-      RecipientUpdateTemplateRecipientsFieldMetaNumber$outboundSchema
+      RecipientUpdateTemplateRecipientsFieldMetaDropdown$outboundSchema
     ),
   ]);
 
@@ -2424,11 +2467,11 @@ export const RecipientUpdateTemplateRecipientsField$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  envelopeId: z.string(),
+  envelopeItemId: z.string(),
   type: RecipientUpdateTemplateRecipientsType$inboundSchema,
   id: z.number(),
   secondaryId: z.string(),
-  documentId: z.nullable(z.number()),
-  templateId: z.nullable(z.number()),
   recipientId: z.number(),
   page: z.number(),
   positionX: z.any().optional(),
@@ -2439,9 +2482,6 @@ export const RecipientUpdateTemplateRecipientsField$inboundSchema: z.ZodType<
   inserted: z.boolean(),
   fieldMeta: z.nullable(
     z.union([
-      z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaRadio$inboundSchema
-      ),
       z.lazy(() =>
         RecipientUpdateTemplateRecipientsFieldMetaInitials$inboundSchema
       ),
@@ -2455,28 +2495,33 @@ export const RecipientUpdateTemplateRecipientsField$inboundSchema: z.ZodType<
         RecipientUpdateTemplateRecipientsFieldMetaDate$inboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaDropdown$inboundSchema
+        RecipientUpdateTemplateRecipientsFieldMetaText$inboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaCheckbox$inboundSchema
+        RecipientUpdateTemplateRecipientsFieldMetaNumber$inboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaText$inboundSchema
+        RecipientUpdateTemplateRecipientsFieldMetaRadio$inboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaNumber$inboundSchema
+        RecipientUpdateTemplateRecipientsFieldMetaCheckbox$inboundSchema
+      ),
+      z.lazy(() =>
+        RecipientUpdateTemplateRecipientsFieldMetaDropdown$inboundSchema
       ),
     ]),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RecipientUpdateTemplateRecipientsField$Outbound = {
+  envelopeId: string;
+  envelopeItemId: string;
   type: string;
   id: number;
   secondaryId: string;
-  documentId: number | null;
-  templateId: number | null;
   recipientId: number;
   page: number;
   positionX?: any | undefined;
@@ -2486,16 +2531,18 @@ export type RecipientUpdateTemplateRecipientsField$Outbound = {
   customText: string;
   inserted: boolean;
   fieldMeta:
-    | RecipientUpdateTemplateRecipientsFieldMetaRadio$Outbound
     | RecipientUpdateTemplateRecipientsFieldMetaInitials$Outbound
     | RecipientUpdateTemplateRecipientsFieldMetaName$Outbound
     | RecipientUpdateTemplateRecipientsFieldMetaEmail$Outbound
     | RecipientUpdateTemplateRecipientsFieldMetaDate$Outbound
-    | RecipientUpdateTemplateRecipientsFieldMetaDropdown$Outbound
-    | RecipientUpdateTemplateRecipientsFieldMetaCheckbox$Outbound
     | RecipientUpdateTemplateRecipientsFieldMetaText$Outbound
     | RecipientUpdateTemplateRecipientsFieldMetaNumber$Outbound
+    | RecipientUpdateTemplateRecipientsFieldMetaRadio$Outbound
+    | RecipientUpdateTemplateRecipientsFieldMetaCheckbox$Outbound
+    | RecipientUpdateTemplateRecipientsFieldMetaDropdown$Outbound
     | null;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -2504,11 +2551,11 @@ export const RecipientUpdateTemplateRecipientsField$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RecipientUpdateTemplateRecipientsField
 > = z.object({
+  envelopeId: z.string(),
+  envelopeItemId: z.string(),
   type: RecipientUpdateTemplateRecipientsType$outboundSchema,
   id: z.number(),
   secondaryId: z.string(),
-  documentId: z.nullable(z.number()),
-  templateId: z.nullable(z.number()),
   recipientId: z.number(),
   page: z.number(),
   positionX: z.any().optional(),
@@ -2519,9 +2566,6 @@ export const RecipientUpdateTemplateRecipientsField$outboundSchema: z.ZodType<
   inserted: z.boolean(),
   fieldMeta: z.nullable(
     z.union([
-      z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaRadio$outboundSchema
-      ),
       z.lazy(() =>
         RecipientUpdateTemplateRecipientsFieldMetaInitials$outboundSchema
       ),
@@ -2535,19 +2579,24 @@ export const RecipientUpdateTemplateRecipientsField$outboundSchema: z.ZodType<
         RecipientUpdateTemplateRecipientsFieldMetaDate$outboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaDropdown$outboundSchema
+        RecipientUpdateTemplateRecipientsFieldMetaText$outboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaCheckbox$outboundSchema
+        RecipientUpdateTemplateRecipientsFieldMetaNumber$outboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaText$outboundSchema
+        RecipientUpdateTemplateRecipientsFieldMetaRadio$outboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateTemplateRecipientsFieldMetaNumber$outboundSchema
+        RecipientUpdateTemplateRecipientsFieldMetaCheckbox$outboundSchema
+      ),
+      z.lazy(() =>
+        RecipientUpdateTemplateRecipientsFieldMetaDropdown$outboundSchema
       ),
     ]),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /**
@@ -2594,13 +2643,12 @@ export const RecipientUpdateTemplateRecipientsRecipientResponse$inboundSchema:
     z.ZodTypeDef,
     unknown
   > = z.object({
+    envelopeId: z.string(),
     role: RecipientUpdateTemplateRecipientsRoleResponse$inboundSchema,
     readStatus: RecipientUpdateTemplateRecipientsReadStatus$inboundSchema,
     signingStatus: RecipientUpdateTemplateRecipientsSigningStatus$inboundSchema,
     sendStatus: RecipientUpdateTemplateRecipientsSendStatus$inboundSchema,
     id: z.number(),
-    documentId: z.nullable(z.number()),
-    templateId: z.nullable(z.number()),
     email: z.string(),
     name: z.string(),
     token: z.string(),
@@ -2615,17 +2663,18 @@ export const RecipientUpdateTemplateRecipientsRecipientResponse$inboundSchema:
     fields: z.array(
       z.lazy(() => RecipientUpdateTemplateRecipientsField$inboundSchema),
     ),
+    documentId: z.nullable(z.number()).optional(),
+    templateId: z.nullable(z.number()).optional(),
   });
 
 /** @internal */
 export type RecipientUpdateTemplateRecipientsRecipientResponse$Outbound = {
+  envelopeId: string;
   role: string;
   readStatus: string;
   signingStatus: string;
   sendStatus: string;
   id: number;
-  documentId: number | null;
-  templateId: number | null;
   email: string;
   name: string;
   token: string;
@@ -2636,6 +2685,8 @@ export type RecipientUpdateTemplateRecipientsRecipientResponse$Outbound = {
   signingOrder: number | null;
   rejectionReason: string | null;
   fields: Array<RecipientUpdateTemplateRecipientsField$Outbound>;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -2645,14 +2696,13 @@ export const RecipientUpdateTemplateRecipientsRecipientResponse$outboundSchema:
     z.ZodTypeDef,
     RecipientUpdateTemplateRecipientsRecipientResponse
   > = z.object({
+    envelopeId: z.string(),
     role: RecipientUpdateTemplateRecipientsRoleResponse$outboundSchema,
     readStatus: RecipientUpdateTemplateRecipientsReadStatus$outboundSchema,
     signingStatus:
       RecipientUpdateTemplateRecipientsSigningStatus$outboundSchema,
     sendStatus: RecipientUpdateTemplateRecipientsSendStatus$outboundSchema,
     id: z.number(),
-    documentId: z.nullable(z.number()),
-    templateId: z.nullable(z.number()),
     email: z.string(),
     name: z.string(),
     token: z.string(),
@@ -2667,6 +2717,8 @@ export const RecipientUpdateTemplateRecipientsRecipientResponse$outboundSchema:
     fields: z.array(
       z.lazy(() => RecipientUpdateTemplateRecipientsField$outboundSchema),
     ),
+    documentId: z.nullable(z.number()).optional(),
+    templateId: z.nullable(z.number()).optional(),
   });
 
 /**