@documenso/sdk-typescript 0.3.0 → 0.4.0

package/src/models/operations/recipientupdatedocumentrecipient.ts

@@ -24,6 +24,7 @@ export type RecipientUpdateDocumentRecipientRoleRequest = ClosedEnum<
  */
 export const RecipientUpdateDocumentRecipientAccessAuthRequest = {
   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 RecipientUpdateDocumentRecipientSendStatus = ClosedEnum<
  */
 export const RecipientUpdateDocumentRecipientAccessAuthResponse = {
   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 RecipientUpdateDocumentRecipientValue2 = {
   value: string;
 };
 
+export const RecipientUpdateDocumentRecipientDirection = {
+  Vertical: "vertical",
+  Horizontal: "horizontal",
+} as const;
+export type RecipientUpdateDocumentRecipientDirection = ClosedEnum<
+  typeof RecipientUpdateDocumentRecipientDirection
+>;
+
 export type RecipientUpdateDocumentRecipientFieldMetaCheckbox = {
   label?: string | undefined;
   placeholder?: string | undefined;
@@ -202,6 +212,7 @@ export type RecipientUpdateDocumentRecipientFieldMetaCheckbox = {
   values?: Array<RecipientUpdateDocumentRecipientValue2> | undefined;
   validationRule?: string | undefined;
   validationLength?: number | undefined;
+  direction?: RecipientUpdateDocumentRecipientDirection | undefined;
 };
 
 export const RecipientUpdateDocumentRecipientTypeRadio = {
@@ -248,10 +259,10 @@ export type RecipientUpdateDocumentRecipientFieldMetaNumber = {
   required?: boolean | undefined;
   readOnly?: boolean | undefined;
   type: RecipientUpdateDocumentRecipientTypeNumber;
-  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?: RecipientUpdateDocumentRecipientTextAlign6 | undefined;
 };
@@ -389,22 +400,22 @@ export type RecipientUpdateDocumentRecipientFieldMetaInitials = {
 };
 
 export type RecipientUpdateDocumentRecipientFieldMetaUnion =
-  | RecipientUpdateDocumentRecipientFieldMetaRadio
   | RecipientUpdateDocumentRecipientFieldMetaInitials
   | RecipientUpdateDocumentRecipientFieldMetaName
   | RecipientUpdateDocumentRecipientFieldMetaEmail
   | RecipientUpdateDocumentRecipientFieldMetaDate
-  | RecipientUpdateDocumentRecipientFieldMetaDropdown
-  | RecipientUpdateDocumentRecipientFieldMetaCheckbox
   | RecipientUpdateDocumentRecipientFieldMetaText
-  | RecipientUpdateDocumentRecipientFieldMetaNumber;
+  | RecipientUpdateDocumentRecipientFieldMetaNumber
+  | RecipientUpdateDocumentRecipientFieldMetaRadio
+  | RecipientUpdateDocumentRecipientFieldMetaCheckbox
+  | RecipientUpdateDocumentRecipientFieldMetaDropdown;
 
 export type RecipientUpdateDocumentRecipientField = {
+  envelopeId: string;
+  envelopeItemId: string;
   type: RecipientUpdateDocumentRecipientType;
   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,29 +428,30 @@ export type RecipientUpdateDocumentRecipientField = {
   customText: string;
   inserted: boolean;
   fieldMeta:
-    | RecipientUpdateDocumentRecipientFieldMetaRadio
     | RecipientUpdateDocumentRecipientFieldMetaInitials
     | RecipientUpdateDocumentRecipientFieldMetaName
     | RecipientUpdateDocumentRecipientFieldMetaEmail
     | RecipientUpdateDocumentRecipientFieldMetaDate
-    | RecipientUpdateDocumentRecipientFieldMetaDropdown
-    | RecipientUpdateDocumentRecipientFieldMetaCheckbox
     | RecipientUpdateDocumentRecipientFieldMetaText
     | RecipientUpdateDocumentRecipientFieldMetaNumber
+    | RecipientUpdateDocumentRecipientFieldMetaRadio
+    | RecipientUpdateDocumentRecipientFieldMetaCheckbox
+    | RecipientUpdateDocumentRecipientFieldMetaDropdown
     | null;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /**
  * Successful response
  */
 export type RecipientUpdateDocumentRecipientResponse = {
+  envelopeId: string;
   role: RecipientUpdateDocumentRecipientRoleResponse;
   readStatus: RecipientUpdateDocumentRecipientReadStatus;
   signingStatus: RecipientUpdateDocumentRecipientSigningStatus;
   sendStatus: RecipientUpdateDocumentRecipientSendStatus;
   id: number;
-  documentId: number | null;
-  templateId: number | null;
   email: string;
   name: string;
   token: string;
@@ -453,6 +465,8 @@ export type RecipientUpdateDocumentRecipientResponse = {
   signingOrder: number | null;
   rejectionReason: string | null;
   fields: Array<RecipientUpdateDocumentRecipientField>;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -1190,6 +1204,29 @@ export function recipientUpdateDocumentRecipientValue2FromJSON(
   );
 }
 
+/** @internal */
+export const RecipientUpdateDocumentRecipientDirection$inboundSchema:
+  z.ZodNativeEnum<typeof RecipientUpdateDocumentRecipientDirection> = z
+    .nativeEnum(RecipientUpdateDocumentRecipientDirection);
+
+/** @internal */
+export const RecipientUpdateDocumentRecipientDirection$outboundSchema:
+  z.ZodNativeEnum<typeof RecipientUpdateDocumentRecipientDirection> =
+    RecipientUpdateDocumentRecipientDirection$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RecipientUpdateDocumentRecipientDirection$ {
+  /** @deprecated use `RecipientUpdateDocumentRecipientDirection$inboundSchema` instead. */
+  export const inboundSchema =
+    RecipientUpdateDocumentRecipientDirection$inboundSchema;
+  /** @deprecated use `RecipientUpdateDocumentRecipientDirection$outboundSchema` instead. */
+  export const outboundSchema =
+    RecipientUpdateDocumentRecipientDirection$outboundSchema;
+}
+
 /** @internal */
 export const RecipientUpdateDocumentRecipientFieldMetaCheckbox$inboundSchema:
   z.ZodType<
@@ -1207,6 +1244,9 @@ export const RecipientUpdateDocumentRecipientFieldMetaCheckbox$inboundSchema:
     ).optional(),
     validationRule: z.string().optional(),
     validationLength: z.number().optional(),
+    direction: RecipientUpdateDocumentRecipientDirection$inboundSchema.default(
+      "vertical",
+    ),
   });
 
 /** @internal */
@@ -1219,6 +1259,7 @@ export type RecipientUpdateDocumentRecipientFieldMetaCheckbox$Outbound = {
   values?: Array<RecipientUpdateDocumentRecipientValue2$Outbound> | undefined;
   validationRule?: string | undefined;
   validationLength?: number | undefined;
+  direction: string;
 };
 
 /** @internal */
@@ -1238,6 +1279,9 @@ export const RecipientUpdateDocumentRecipientFieldMetaCheckbox$outboundSchema:
     ).optional(),
     validationRule: z.string().optional(),
     validationLength: z.number().optional(),
+    direction: RecipientUpdateDocumentRecipientDirection$outboundSchema.default(
+      "vertical",
+    ),
   });
 
 /**
@@ -1517,10 +1561,10 @@ export const RecipientUpdateDocumentRecipientFieldMetaNumber$inboundSchema:
     required: z.boolean().optional(),
     readOnly: z.boolean().optional(),
     type: RecipientUpdateDocumentRecipientTypeNumber$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: RecipientUpdateDocumentRecipientTextAlign6$inboundSchema
       .optional(),
@@ -1533,10 +1577,10 @@ export type RecipientUpdateDocumentRecipientFieldMetaNumber$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;
 };
@@ -1553,10 +1597,10 @@ export const RecipientUpdateDocumentRecipientFieldMetaNumber$outboundSchema:
     required: z.boolean().optional(),
     readOnly: z.boolean().optional(),
     type: RecipientUpdateDocumentRecipientTypeNumber$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: RecipientUpdateDocumentRecipientTextAlign6$outboundSchema
       .optional(),
@@ -2285,34 +2329,34 @@ export const RecipientUpdateDocumentRecipientFieldMetaUnion$inboundSchema:
     z.ZodTypeDef,
     unknown
   > = z.union([
-    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaRadio$inboundSchema),
     z.lazy(() =>
       RecipientUpdateDocumentRecipientFieldMetaInitials$inboundSchema
     ),
     z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaName$inboundSchema),
     z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaEmail$inboundSchema),
     z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaDate$inboundSchema),
+    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaText$inboundSchema),
+    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaNumber$inboundSchema),
+    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaRadio$inboundSchema),
     z.lazy(() =>
-      RecipientUpdateDocumentRecipientFieldMetaDropdown$inboundSchema
+      RecipientUpdateDocumentRecipientFieldMetaCheckbox$inboundSchema
     ),
     z.lazy(() =>
-      RecipientUpdateDocumentRecipientFieldMetaCheckbox$inboundSchema
+      RecipientUpdateDocumentRecipientFieldMetaDropdown$inboundSchema
     ),
-    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaText$inboundSchema),
-    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaNumber$inboundSchema),
   ]);
 
 /** @internal */
 export type RecipientUpdateDocumentRecipientFieldMetaUnion$Outbound =
-  | RecipientUpdateDocumentRecipientFieldMetaRadio$Outbound
   | RecipientUpdateDocumentRecipientFieldMetaInitials$Outbound
   | RecipientUpdateDocumentRecipientFieldMetaName$Outbound
   | RecipientUpdateDocumentRecipientFieldMetaEmail$Outbound
   | RecipientUpdateDocumentRecipientFieldMetaDate$Outbound
-  | RecipientUpdateDocumentRecipientFieldMetaDropdown$Outbound
-  | RecipientUpdateDocumentRecipientFieldMetaCheckbox$Outbound
   | RecipientUpdateDocumentRecipientFieldMetaText$Outbound
-  | RecipientUpdateDocumentRecipientFieldMetaNumber$Outbound;
+  | RecipientUpdateDocumentRecipientFieldMetaNumber$Outbound
+  | RecipientUpdateDocumentRecipientFieldMetaRadio$Outbound
+  | RecipientUpdateDocumentRecipientFieldMetaCheckbox$Outbound
+  | RecipientUpdateDocumentRecipientFieldMetaDropdown$Outbound;
 
 /** @internal */
 export const RecipientUpdateDocumentRecipientFieldMetaUnion$outboundSchema:
@@ -2321,22 +2365,22 @@ export const RecipientUpdateDocumentRecipientFieldMetaUnion$outboundSchema:
     z.ZodTypeDef,
     RecipientUpdateDocumentRecipientFieldMetaUnion
   > = z.union([
-    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaRadio$outboundSchema),
     z.lazy(() =>
       RecipientUpdateDocumentRecipientFieldMetaInitials$outboundSchema
     ),
     z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaName$outboundSchema),
     z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaEmail$outboundSchema),
     z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaDate$outboundSchema),
+    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaText$outboundSchema),
     z.lazy(() =>
-      RecipientUpdateDocumentRecipientFieldMetaDropdown$outboundSchema
+      RecipientUpdateDocumentRecipientFieldMetaNumber$outboundSchema
     ),
+    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaRadio$outboundSchema),
     z.lazy(() =>
       RecipientUpdateDocumentRecipientFieldMetaCheckbox$outboundSchema
     ),
-    z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaText$outboundSchema),
     z.lazy(() =>
-      RecipientUpdateDocumentRecipientFieldMetaNumber$outboundSchema
+      RecipientUpdateDocumentRecipientFieldMetaDropdown$outboundSchema
     ),
   ]);
 
@@ -2389,11 +2433,11 @@ export const RecipientUpdateDocumentRecipientField$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  envelopeId: z.string(),
+  envelopeItemId: z.string(),
   type: RecipientUpdateDocumentRecipientType$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(),
@@ -2404,9 +2448,6 @@ export const RecipientUpdateDocumentRecipientField$inboundSchema: z.ZodType<
   inserted: z.boolean(),
   fieldMeta: z.nullable(
     z.union([
-      z.lazy(() =>
-        RecipientUpdateDocumentRecipientFieldMetaRadio$inboundSchema
-      ),
       z.lazy(() =>
         RecipientUpdateDocumentRecipientFieldMetaInitials$inboundSchema
       ),
@@ -2415,27 +2456,32 @@ export const RecipientUpdateDocumentRecipientField$inboundSchema: z.ZodType<
         RecipientUpdateDocumentRecipientFieldMetaEmail$inboundSchema
       ),
       z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaDate$inboundSchema),
+      z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaText$inboundSchema),
       z.lazy(() =>
-        RecipientUpdateDocumentRecipientFieldMetaDropdown$inboundSchema
+        RecipientUpdateDocumentRecipientFieldMetaNumber$inboundSchema
+      ),
+      z.lazy(() =>
+        RecipientUpdateDocumentRecipientFieldMetaRadio$inboundSchema
       ),
       z.lazy(() =>
         RecipientUpdateDocumentRecipientFieldMetaCheckbox$inboundSchema
       ),
-      z.lazy(() => RecipientUpdateDocumentRecipientFieldMetaText$inboundSchema),
       z.lazy(() =>
-        RecipientUpdateDocumentRecipientFieldMetaNumber$inboundSchema
+        RecipientUpdateDocumentRecipientFieldMetaDropdown$inboundSchema
       ),
     ]),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RecipientUpdateDocumentRecipientField$Outbound = {
+  envelopeId: string;
+  envelopeItemId: string;
   type: string;
   id: number;
   secondaryId: string;
-  documentId: number | null;
-  templateId: number | null;
   recipientId: number;
   page: number;
   positionX?: any | undefined;
@@ -2445,16 +2491,18 @@ export type RecipientUpdateDocumentRecipientField$Outbound = {
   customText: string;
   inserted: boolean;
   fieldMeta:
-    | RecipientUpdateDocumentRecipientFieldMetaRadio$Outbound
     | RecipientUpdateDocumentRecipientFieldMetaInitials$Outbound
     | RecipientUpdateDocumentRecipientFieldMetaName$Outbound
     | RecipientUpdateDocumentRecipientFieldMetaEmail$Outbound
     | RecipientUpdateDocumentRecipientFieldMetaDate$Outbound
-    | RecipientUpdateDocumentRecipientFieldMetaDropdown$Outbound
-    | RecipientUpdateDocumentRecipientFieldMetaCheckbox$Outbound
     | RecipientUpdateDocumentRecipientFieldMetaText$Outbound
     | RecipientUpdateDocumentRecipientFieldMetaNumber$Outbound
+    | RecipientUpdateDocumentRecipientFieldMetaRadio$Outbound
+    | RecipientUpdateDocumentRecipientFieldMetaCheckbox$Outbound
+    | RecipientUpdateDocumentRecipientFieldMetaDropdown$Outbound
     | null;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -2463,11 +2511,11 @@ export const RecipientUpdateDocumentRecipientField$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RecipientUpdateDocumentRecipientField
 > = z.object({
+  envelopeId: z.string(),
+  envelopeItemId: z.string(),
   type: RecipientUpdateDocumentRecipientType$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(),
@@ -2478,9 +2526,6 @@ export const RecipientUpdateDocumentRecipientField$outboundSchema: z.ZodType<
   inserted: z.boolean(),
   fieldMeta: z.nullable(
     z.union([
-      z.lazy(() =>
-        RecipientUpdateDocumentRecipientFieldMetaRadio$outboundSchema
-      ),
       z.lazy(() =>
         RecipientUpdateDocumentRecipientFieldMetaInitials$outboundSchema
       ),
@@ -2494,19 +2539,24 @@ export const RecipientUpdateDocumentRecipientField$outboundSchema: z.ZodType<
         RecipientUpdateDocumentRecipientFieldMetaDate$outboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateDocumentRecipientFieldMetaDropdown$outboundSchema
+        RecipientUpdateDocumentRecipientFieldMetaText$outboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateDocumentRecipientFieldMetaCheckbox$outboundSchema
+        RecipientUpdateDocumentRecipientFieldMetaNumber$outboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateDocumentRecipientFieldMetaText$outboundSchema
+        RecipientUpdateDocumentRecipientFieldMetaRadio$outboundSchema
       ),
       z.lazy(() =>
-        RecipientUpdateDocumentRecipientFieldMetaNumber$outboundSchema
+        RecipientUpdateDocumentRecipientFieldMetaCheckbox$outboundSchema
+      ),
+      z.lazy(() =>
+        RecipientUpdateDocumentRecipientFieldMetaDropdown$outboundSchema
       ),
     ]),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /**
@@ -2551,13 +2601,12 @@ export const RecipientUpdateDocumentRecipientResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  envelopeId: z.string(),
   role: RecipientUpdateDocumentRecipientRoleResponse$inboundSchema,
   readStatus: RecipientUpdateDocumentRecipientReadStatus$inboundSchema,
   signingStatus: RecipientUpdateDocumentRecipientSigningStatus$inboundSchema,
   sendStatus: RecipientUpdateDocumentRecipientSendStatus$inboundSchema,
   id: z.number(),
-  documentId: z.nullable(z.number()),
-  templateId: z.nullable(z.number()),
   email: z.string(),
   name: z.string(),
   token: z.string(),
@@ -2572,17 +2621,18 @@ export const RecipientUpdateDocumentRecipientResponse$inboundSchema: z.ZodType<
   fields: z.array(
     z.lazy(() => RecipientUpdateDocumentRecipientField$inboundSchema),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RecipientUpdateDocumentRecipientResponse$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;
@@ -2593,6 +2643,8 @@ export type RecipientUpdateDocumentRecipientResponse$Outbound = {
   signingOrder: number | null;
   rejectionReason: string | null;
   fields: Array<RecipientUpdateDocumentRecipientField$Outbound>;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -2601,13 +2653,12 @@ export const RecipientUpdateDocumentRecipientResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RecipientUpdateDocumentRecipientResponse
 > = z.object({
+  envelopeId: z.string(),
   role: RecipientUpdateDocumentRecipientRoleResponse$outboundSchema,
   readStatus: RecipientUpdateDocumentRecipientReadStatus$outboundSchema,
   signingStatus: RecipientUpdateDocumentRecipientSigningStatus$outboundSchema,
   sendStatus: RecipientUpdateDocumentRecipientSendStatus$outboundSchema,
   id: z.number(),
-  documentId: z.nullable(z.number()),
-  templateId: z.nullable(z.number()),
   email: z.string(),
   name: z.string(),
   token: z.string(),
@@ -2622,6 +2673,8 @@ export const RecipientUpdateDocumentRecipientResponse$outboundSchema: z.ZodType<
   fields: z.array(
     z.lazy(() => RecipientUpdateDocumentRecipientField$outboundSchema),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /**