@documenso/sdk-typescript 0.3.0 → 0.4.0

package/src/models/operations/recipientgetdocumentrecipient.ts

@@ -53,6 +53,7 @@ export type RecipientGetDocumentRecipientSendStatus = ClosedEnum<
  */
 export const RecipientGetDocumentRecipientAccessAuth = {
   Account: "ACCOUNT",
+  TwoFactorAuth: "TWO_FACTOR_AUTH",
 } as const;
 /**
  * The type of authentication required for the recipient to access the document.
@@ -134,6 +135,14 @@ export type RecipientGetDocumentRecipientValue2 = {
   value: string;
 };
 
+export const RecipientGetDocumentRecipientDirection = {
+  Vertical: "vertical",
+  Horizontal: "horizontal",
+} as const;
+export type RecipientGetDocumentRecipientDirection = ClosedEnum<
+  typeof RecipientGetDocumentRecipientDirection
+>;
+
 export type RecipientGetDocumentRecipientFieldMetaCheckbox = {
   label?: string | undefined;
   placeholder?: string | undefined;
@@ -143,6 +152,7 @@ export type RecipientGetDocumentRecipientFieldMetaCheckbox = {
   values?: Array<RecipientGetDocumentRecipientValue2> | undefined;
   validationRule?: string | undefined;
   validationLength?: number | undefined;
+  direction?: RecipientGetDocumentRecipientDirection | undefined;
 };
 
 export const RecipientGetDocumentRecipientTypeRadio = {
@@ -189,10 +199,10 @@ export type RecipientGetDocumentRecipientFieldMetaNumber = {
   required?: boolean | undefined;
   readOnly?: boolean | undefined;
   type: RecipientGetDocumentRecipientTypeNumber;
-  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?: RecipientGetDocumentRecipientTextAlign6 | undefined;
 };
@@ -330,22 +340,22 @@ export type RecipientGetDocumentRecipientFieldMetaInitials = {
 };
 
 export type RecipientGetDocumentRecipientFieldMetaUnion =
-  | RecipientGetDocumentRecipientFieldMetaRadio
   | RecipientGetDocumentRecipientFieldMetaInitials
   | RecipientGetDocumentRecipientFieldMetaName
   | RecipientGetDocumentRecipientFieldMetaEmail
   | RecipientGetDocumentRecipientFieldMetaDate
-  | RecipientGetDocumentRecipientFieldMetaDropdown
-  | RecipientGetDocumentRecipientFieldMetaCheckbox
   | RecipientGetDocumentRecipientFieldMetaText
-  | RecipientGetDocumentRecipientFieldMetaNumber;
+  | RecipientGetDocumentRecipientFieldMetaNumber
+  | RecipientGetDocumentRecipientFieldMetaRadio
+  | RecipientGetDocumentRecipientFieldMetaCheckbox
+  | RecipientGetDocumentRecipientFieldMetaDropdown;
 
 export type RecipientGetDocumentRecipientField = {
+  envelopeId: string;
+  envelopeItemId: string;
   type: RecipientGetDocumentRecipientType;
   id: number;
   secondaryId: string;
-  documentId: number | null;
-  templateId: number | null;
   recipientId: number;
   /**
    * The page number of the field on the document. Starts from 1.
@@ -358,29 +368,30 @@ export type RecipientGetDocumentRecipientField = {
   customText: string;
   inserted: boolean;
   fieldMeta:
-    | RecipientGetDocumentRecipientFieldMetaRadio
     | RecipientGetDocumentRecipientFieldMetaInitials
     | RecipientGetDocumentRecipientFieldMetaName
     | RecipientGetDocumentRecipientFieldMetaEmail
     | RecipientGetDocumentRecipientFieldMetaDate
-    | RecipientGetDocumentRecipientFieldMetaDropdown
-    | RecipientGetDocumentRecipientFieldMetaCheckbox
     | RecipientGetDocumentRecipientFieldMetaText
     | RecipientGetDocumentRecipientFieldMetaNumber
+    | RecipientGetDocumentRecipientFieldMetaRadio
+    | RecipientGetDocumentRecipientFieldMetaCheckbox
+    | RecipientGetDocumentRecipientFieldMetaDropdown
     | null;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /**
  * Successful response
  */
 export type RecipientGetDocumentRecipientResponse = {
+  envelopeId: string;
   role: RecipientGetDocumentRecipientRole;
   readStatus: RecipientGetDocumentRecipientReadStatus;
   signingStatus: RecipientGetDocumentRecipientSigningStatus;
   sendStatus: RecipientGetDocumentRecipientSendStatus;
   id: number;
-  documentId: number | null;
-  templateId: number | null;
   email: string;
   name: string;
   token: string;
@@ -394,6 +405,8 @@ export type RecipientGetDocumentRecipientResponse = {
   signingOrder: number | null;
   rejectionReason: string | null;
   fields: Array<RecipientGetDocumentRecipientField>;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -942,6 +955,30 @@ export function recipientGetDocumentRecipientValue2FromJSON(
   );
 }
 
+/** @internal */
+export const RecipientGetDocumentRecipientDirection$inboundSchema:
+  z.ZodNativeEnum<typeof RecipientGetDocumentRecipientDirection> = z.nativeEnum(
+    RecipientGetDocumentRecipientDirection,
+  );
+
+/** @internal */
+export const RecipientGetDocumentRecipientDirection$outboundSchema:
+  z.ZodNativeEnum<typeof RecipientGetDocumentRecipientDirection> =
+    RecipientGetDocumentRecipientDirection$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RecipientGetDocumentRecipientDirection$ {
+  /** @deprecated use `RecipientGetDocumentRecipientDirection$inboundSchema` instead. */
+  export const inboundSchema =
+    RecipientGetDocumentRecipientDirection$inboundSchema;
+  /** @deprecated use `RecipientGetDocumentRecipientDirection$outboundSchema` instead. */
+  export const outboundSchema =
+    RecipientGetDocumentRecipientDirection$outboundSchema;
+}
+
 /** @internal */
 export const RecipientGetDocumentRecipientFieldMetaCheckbox$inboundSchema:
   z.ZodType<
@@ -959,6 +996,9 @@ export const RecipientGetDocumentRecipientFieldMetaCheckbox$inboundSchema:
     ).optional(),
     validationRule: z.string().optional(),
     validationLength: z.number().optional(),
+    direction: RecipientGetDocumentRecipientDirection$inboundSchema.default(
+      "vertical",
+    ),
   });
 
 /** @internal */
@@ -971,6 +1011,7 @@ export type RecipientGetDocumentRecipientFieldMetaCheckbox$Outbound = {
   values?: Array<RecipientGetDocumentRecipientValue2$Outbound> | undefined;
   validationRule?: string | undefined;
   validationLength?: number | undefined;
+  direction: string;
 };
 
 /** @internal */
@@ -990,6 +1031,9 @@ export const RecipientGetDocumentRecipientFieldMetaCheckbox$outboundSchema:
     ).optional(),
     validationRule: z.string().optional(),
     validationLength: z.number().optional(),
+    direction: RecipientGetDocumentRecipientDirection$outboundSchema.default(
+      "vertical",
+    ),
   });
 
 /**
@@ -1268,10 +1312,10 @@ export const RecipientGetDocumentRecipientFieldMetaNumber$inboundSchema:
     required: z.boolean().optional(),
     readOnly: z.boolean().optional(),
     type: RecipientGetDocumentRecipientTypeNumber$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: RecipientGetDocumentRecipientTextAlign6$inboundSchema.optional(),
   });
@@ -1283,10 +1327,10 @@ export type RecipientGetDocumentRecipientFieldMetaNumber$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;
 };
@@ -1303,10 +1347,10 @@ export const RecipientGetDocumentRecipientFieldMetaNumber$outboundSchema:
     required: z.boolean().optional(),
     readOnly: z.boolean().optional(),
     type: RecipientGetDocumentRecipientTypeNumber$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: RecipientGetDocumentRecipientTextAlign6$outboundSchema
       .optional(),
@@ -2026,28 +2070,28 @@ export const RecipientGetDocumentRecipientFieldMetaUnion$inboundSchema:
     z.ZodTypeDef,
     unknown
   > = z.union([
-    z.lazy(() => RecipientGetDocumentRecipientFieldMetaRadio$inboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaInitials$inboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaName$inboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaEmail$inboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaDate$inboundSchema),
-    z.lazy(() => RecipientGetDocumentRecipientFieldMetaDropdown$inboundSchema),
-    z.lazy(() => RecipientGetDocumentRecipientFieldMetaCheckbox$inboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaText$inboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaNumber$inboundSchema),
+    z.lazy(() => RecipientGetDocumentRecipientFieldMetaRadio$inboundSchema),
+    z.lazy(() => RecipientGetDocumentRecipientFieldMetaCheckbox$inboundSchema),
+    z.lazy(() => RecipientGetDocumentRecipientFieldMetaDropdown$inboundSchema),
   ]);
 
 /** @internal */
 export type RecipientGetDocumentRecipientFieldMetaUnion$Outbound =
-  | RecipientGetDocumentRecipientFieldMetaRadio$Outbound
   | RecipientGetDocumentRecipientFieldMetaInitials$Outbound
   | RecipientGetDocumentRecipientFieldMetaName$Outbound
   | RecipientGetDocumentRecipientFieldMetaEmail$Outbound
   | RecipientGetDocumentRecipientFieldMetaDate$Outbound
-  | RecipientGetDocumentRecipientFieldMetaDropdown$Outbound
-  | RecipientGetDocumentRecipientFieldMetaCheckbox$Outbound
   | RecipientGetDocumentRecipientFieldMetaText$Outbound
-  | RecipientGetDocumentRecipientFieldMetaNumber$Outbound;
+  | RecipientGetDocumentRecipientFieldMetaNumber$Outbound
+  | RecipientGetDocumentRecipientFieldMetaRadio$Outbound
+  | RecipientGetDocumentRecipientFieldMetaCheckbox$Outbound
+  | RecipientGetDocumentRecipientFieldMetaDropdown$Outbound;
 
 /** @internal */
 export const RecipientGetDocumentRecipientFieldMetaUnion$outboundSchema:
@@ -2056,15 +2100,15 @@ export const RecipientGetDocumentRecipientFieldMetaUnion$outboundSchema:
     z.ZodTypeDef,
     RecipientGetDocumentRecipientFieldMetaUnion
   > = z.union([
-    z.lazy(() => RecipientGetDocumentRecipientFieldMetaRadio$outboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaInitials$outboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaName$outboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaEmail$outboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaDate$outboundSchema),
-    z.lazy(() => RecipientGetDocumentRecipientFieldMetaDropdown$outboundSchema),
-    z.lazy(() => RecipientGetDocumentRecipientFieldMetaCheckbox$outboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaText$outboundSchema),
     z.lazy(() => RecipientGetDocumentRecipientFieldMetaNumber$outboundSchema),
+    z.lazy(() => RecipientGetDocumentRecipientFieldMetaRadio$outboundSchema),
+    z.lazy(() => RecipientGetDocumentRecipientFieldMetaCheckbox$outboundSchema),
+    z.lazy(() => RecipientGetDocumentRecipientFieldMetaDropdown$outboundSchema),
   ]);
 
 /**
@@ -2115,11 +2159,11 @@ export const RecipientGetDocumentRecipientField$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  envelopeId: z.string(),
+  envelopeItemId: z.string(),
   type: RecipientGetDocumentRecipientType$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(),
@@ -2130,32 +2174,34 @@ export const RecipientGetDocumentRecipientField$inboundSchema: z.ZodType<
   inserted: z.boolean(),
   fieldMeta: z.nullable(
     z.union([
-      z.lazy(() => RecipientGetDocumentRecipientFieldMetaRadio$inboundSchema),
       z.lazy(() =>
         RecipientGetDocumentRecipientFieldMetaInitials$inboundSchema
       ),
       z.lazy(() => RecipientGetDocumentRecipientFieldMetaName$inboundSchema),
       z.lazy(() => RecipientGetDocumentRecipientFieldMetaEmail$inboundSchema),
       z.lazy(() => RecipientGetDocumentRecipientFieldMetaDate$inboundSchema),
+      z.lazy(() => RecipientGetDocumentRecipientFieldMetaText$inboundSchema),
+      z.lazy(() => RecipientGetDocumentRecipientFieldMetaNumber$inboundSchema),
+      z.lazy(() => RecipientGetDocumentRecipientFieldMetaRadio$inboundSchema),
       z.lazy(() =>
-        RecipientGetDocumentRecipientFieldMetaDropdown$inboundSchema
+        RecipientGetDocumentRecipientFieldMetaCheckbox$inboundSchema
       ),
       z.lazy(() =>
-        RecipientGetDocumentRecipientFieldMetaCheckbox$inboundSchema
+        RecipientGetDocumentRecipientFieldMetaDropdown$inboundSchema
       ),
-      z.lazy(() => RecipientGetDocumentRecipientFieldMetaText$inboundSchema),
-      z.lazy(() => RecipientGetDocumentRecipientFieldMetaNumber$inboundSchema),
     ]),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RecipientGetDocumentRecipientField$Outbound = {
+  envelopeId: string;
+  envelopeItemId: string;
   type: string;
   id: number;
   secondaryId: string;
-  documentId: number | null;
-  templateId: number | null;
   recipientId: number;
   page: number;
   positionX?: any | undefined;
@@ -2165,16 +2211,18 @@ export type RecipientGetDocumentRecipientField$Outbound = {
   customText: string;
   inserted: boolean;
   fieldMeta:
-    | RecipientGetDocumentRecipientFieldMetaRadio$Outbound
     | RecipientGetDocumentRecipientFieldMetaInitials$Outbound
     | RecipientGetDocumentRecipientFieldMetaName$Outbound
     | RecipientGetDocumentRecipientFieldMetaEmail$Outbound
     | RecipientGetDocumentRecipientFieldMetaDate$Outbound
-    | RecipientGetDocumentRecipientFieldMetaDropdown$Outbound
-    | RecipientGetDocumentRecipientFieldMetaCheckbox$Outbound
     | RecipientGetDocumentRecipientFieldMetaText$Outbound
     | RecipientGetDocumentRecipientFieldMetaNumber$Outbound
+    | RecipientGetDocumentRecipientFieldMetaRadio$Outbound
+    | RecipientGetDocumentRecipientFieldMetaCheckbox$Outbound
+    | RecipientGetDocumentRecipientFieldMetaDropdown$Outbound
     | null;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -2183,11 +2231,11 @@ export const RecipientGetDocumentRecipientField$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RecipientGetDocumentRecipientField
 > = z.object({
+  envelopeId: z.string(),
+  envelopeItemId: z.string(),
   type: RecipientGetDocumentRecipientType$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(),
@@ -2198,25 +2246,25 @@ export const RecipientGetDocumentRecipientField$outboundSchema: z.ZodType<
   inserted: z.boolean(),
   fieldMeta: z.nullable(
     z.union([
-      z.lazy(() => RecipientGetDocumentRecipientFieldMetaRadio$outboundSchema),
       z.lazy(() =>
         RecipientGetDocumentRecipientFieldMetaInitials$outboundSchema
       ),
-      z.lazy(() =>
-        RecipientGetDocumentRecipientFieldMetaName$outboundSchema
-      ),
+      z.lazy(() => RecipientGetDocumentRecipientFieldMetaName$outboundSchema),
       z.lazy(() => RecipientGetDocumentRecipientFieldMetaEmail$outboundSchema),
       z.lazy(() => RecipientGetDocumentRecipientFieldMetaDate$outboundSchema),
+      z.lazy(() => RecipientGetDocumentRecipientFieldMetaText$outboundSchema),
+      z.lazy(() => RecipientGetDocumentRecipientFieldMetaNumber$outboundSchema),
+      z.lazy(() => RecipientGetDocumentRecipientFieldMetaRadio$outboundSchema),
       z.lazy(() =>
-        RecipientGetDocumentRecipientFieldMetaDropdown$outboundSchema
+        RecipientGetDocumentRecipientFieldMetaCheckbox$outboundSchema
       ),
       z.lazy(() =>
-        RecipientGetDocumentRecipientFieldMetaCheckbox$outboundSchema
+        RecipientGetDocumentRecipientFieldMetaDropdown$outboundSchema
       ),
-      z.lazy(() => RecipientGetDocumentRecipientFieldMetaText$outboundSchema),
-      z.lazy(() => RecipientGetDocumentRecipientFieldMetaNumber$outboundSchema),
     ]),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /**
@@ -2260,13 +2308,12 @@ export const RecipientGetDocumentRecipientResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  envelopeId: z.string(),
   role: RecipientGetDocumentRecipientRole$inboundSchema,
   readStatus: RecipientGetDocumentRecipientReadStatus$inboundSchema,
   signingStatus: RecipientGetDocumentRecipientSigningStatus$inboundSchema,
   sendStatus: RecipientGetDocumentRecipientSendStatus$inboundSchema,
   id: z.number(),
-  documentId: z.nullable(z.number()),
-  templateId: z.nullable(z.number()),
   email: z.string(),
   name: z.string(),
   token: z.string(),
@@ -2281,17 +2328,18 @@ export const RecipientGetDocumentRecipientResponse$inboundSchema: z.ZodType<
   fields: z.array(
     z.lazy(() => RecipientGetDocumentRecipientField$inboundSchema),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RecipientGetDocumentRecipientResponse$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;
@@ -2302,6 +2350,8 @@ export type RecipientGetDocumentRecipientResponse$Outbound = {
   signingOrder: number | null;
   rejectionReason: string | null;
   fields: Array<RecipientGetDocumentRecipientField$Outbound>;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -2310,13 +2360,12 @@ export const RecipientGetDocumentRecipientResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RecipientGetDocumentRecipientResponse
 > = z.object({
+  envelopeId: z.string(),
   role: RecipientGetDocumentRecipientRole$outboundSchema,
   readStatus: RecipientGetDocumentRecipientReadStatus$outboundSchema,
   signingStatus: RecipientGetDocumentRecipientSigningStatus$outboundSchema,
   sendStatus: RecipientGetDocumentRecipientSendStatus$outboundSchema,
   id: z.number(),
-  documentId: z.nullable(z.number()),
-  templateId: z.nullable(z.number()),
   email: z.string(),
   name: z.string(),
   token: z.string(),
@@ -2331,6 +2380,8 @@ export const RecipientGetDocumentRecipientResponse$outboundSchema: z.ZodType<
   fields: z.array(
     z.lazy(() => RecipientGetDocumentRecipientField$outboundSchema),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /**