@documenso/sdk-typescript 0.3.0 → 0.4.0

package/src/models/operations/recipientgettemplaterecipient.ts

@@ -53,6 +53,7 @@ export type RecipientGetTemplateRecipientSendStatus = ClosedEnum<
  */
 export const RecipientGetTemplateRecipientAccessAuth = {
   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 RecipientGetTemplateRecipientValue2 = {
   value: string;
 };
 
+export const RecipientGetTemplateRecipientDirection = {
+  Vertical: "vertical",
+  Horizontal: "horizontal",
+} as const;
+export type RecipientGetTemplateRecipientDirection = ClosedEnum<
+  typeof RecipientGetTemplateRecipientDirection
+>;
+
 export type RecipientGetTemplateRecipientFieldMetaCheckbox = {
   label?: string | undefined;
   placeholder?: string | undefined;
@@ -143,6 +152,7 @@ export type RecipientGetTemplateRecipientFieldMetaCheckbox = {
   values?: Array<RecipientGetTemplateRecipientValue2> | undefined;
   validationRule?: string | undefined;
   validationLength?: number | undefined;
+  direction?: RecipientGetTemplateRecipientDirection | undefined;
 };
 
 export const RecipientGetTemplateRecipientTypeRadio = {
@@ -189,10 +199,10 @@ export type RecipientGetTemplateRecipientFieldMetaNumber = {
   required?: boolean | undefined;
   readOnly?: boolean | undefined;
   type: RecipientGetTemplateRecipientTypeNumber;
-  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?: RecipientGetTemplateRecipientTextAlign6 | undefined;
 };
@@ -330,22 +340,22 @@ export type RecipientGetTemplateRecipientFieldMetaInitials = {
 };
 
 export type RecipientGetTemplateRecipientFieldMetaUnion =
-  | RecipientGetTemplateRecipientFieldMetaRadio
   | RecipientGetTemplateRecipientFieldMetaInitials
   | RecipientGetTemplateRecipientFieldMetaName
   | RecipientGetTemplateRecipientFieldMetaEmail
   | RecipientGetTemplateRecipientFieldMetaDate
-  | RecipientGetTemplateRecipientFieldMetaDropdown
-  | RecipientGetTemplateRecipientFieldMetaCheckbox
   | RecipientGetTemplateRecipientFieldMetaText
-  | RecipientGetTemplateRecipientFieldMetaNumber;
+  | RecipientGetTemplateRecipientFieldMetaNumber
+  | RecipientGetTemplateRecipientFieldMetaRadio
+  | RecipientGetTemplateRecipientFieldMetaCheckbox
+  | RecipientGetTemplateRecipientFieldMetaDropdown;
 
 export type RecipientGetTemplateRecipientField = {
+  envelopeId: string;
+  envelopeItemId: string;
   type: RecipientGetTemplateRecipientType;
   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 RecipientGetTemplateRecipientField = {
   customText: string;
   inserted: boolean;
   fieldMeta:
-    | RecipientGetTemplateRecipientFieldMetaRadio
     | RecipientGetTemplateRecipientFieldMetaInitials
     | RecipientGetTemplateRecipientFieldMetaName
     | RecipientGetTemplateRecipientFieldMetaEmail
     | RecipientGetTemplateRecipientFieldMetaDate
-    | RecipientGetTemplateRecipientFieldMetaDropdown
-    | RecipientGetTemplateRecipientFieldMetaCheckbox
     | RecipientGetTemplateRecipientFieldMetaText
     | RecipientGetTemplateRecipientFieldMetaNumber
+    | RecipientGetTemplateRecipientFieldMetaRadio
+    | RecipientGetTemplateRecipientFieldMetaCheckbox
+    | RecipientGetTemplateRecipientFieldMetaDropdown
     | null;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /**
  * Successful response
  */
 export type RecipientGetTemplateRecipientResponse = {
+  envelopeId: string;
   role: RecipientGetTemplateRecipientRole;
   readStatus: RecipientGetTemplateRecipientReadStatus;
   signingStatus: RecipientGetTemplateRecipientSigningStatus;
   sendStatus: RecipientGetTemplateRecipientSendStatus;
   id: number;
-  documentId: number | null;
-  templateId: number | null;
   email: string;
   name: string;
   token: string;
@@ -394,6 +405,8 @@ export type RecipientGetTemplateRecipientResponse = {
   signingOrder: number | null;
   rejectionReason: string | null;
   fields: Array<RecipientGetTemplateRecipientField>;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -942,6 +955,30 @@ export function recipientGetTemplateRecipientValue2FromJSON(
   );
 }
 
+/** @internal */
+export const RecipientGetTemplateRecipientDirection$inboundSchema:
+  z.ZodNativeEnum<typeof RecipientGetTemplateRecipientDirection> = z.nativeEnum(
+    RecipientGetTemplateRecipientDirection,
+  );
+
+/** @internal */
+export const RecipientGetTemplateRecipientDirection$outboundSchema:
+  z.ZodNativeEnum<typeof RecipientGetTemplateRecipientDirection> =
+    RecipientGetTemplateRecipientDirection$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RecipientGetTemplateRecipientDirection$ {
+  /** @deprecated use `RecipientGetTemplateRecipientDirection$inboundSchema` instead. */
+  export const inboundSchema =
+    RecipientGetTemplateRecipientDirection$inboundSchema;
+  /** @deprecated use `RecipientGetTemplateRecipientDirection$outboundSchema` instead. */
+  export const outboundSchema =
+    RecipientGetTemplateRecipientDirection$outboundSchema;
+}
+
 /** @internal */
 export const RecipientGetTemplateRecipientFieldMetaCheckbox$inboundSchema:
   z.ZodType<
@@ -959,6 +996,9 @@ export const RecipientGetTemplateRecipientFieldMetaCheckbox$inboundSchema:
     ).optional(),
     validationRule: z.string().optional(),
     validationLength: z.number().optional(),
+    direction: RecipientGetTemplateRecipientDirection$inboundSchema.default(
+      "vertical",
+    ),
   });
 
 /** @internal */
@@ -971,6 +1011,7 @@ export type RecipientGetTemplateRecipientFieldMetaCheckbox$Outbound = {
   values?: Array<RecipientGetTemplateRecipientValue2$Outbound> | undefined;
   validationRule?: string | undefined;
   validationLength?: number | undefined;
+  direction: string;
 };
 
 /** @internal */
@@ -990,6 +1031,9 @@ export const RecipientGetTemplateRecipientFieldMetaCheckbox$outboundSchema:
     ).optional(),
     validationRule: z.string().optional(),
     validationLength: z.number().optional(),
+    direction: RecipientGetTemplateRecipientDirection$outboundSchema.default(
+      "vertical",
+    ),
   });
 
 /**
@@ -1268,10 +1312,10 @@ export const RecipientGetTemplateRecipientFieldMetaNumber$inboundSchema:
     required: z.boolean().optional(),
     readOnly: z.boolean().optional(),
     type: RecipientGetTemplateRecipientTypeNumber$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: RecipientGetTemplateRecipientTextAlign6$inboundSchema.optional(),
   });
@@ -1283,10 +1327,10 @@ export type RecipientGetTemplateRecipientFieldMetaNumber$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 RecipientGetTemplateRecipientFieldMetaNumber$outboundSchema:
     required: z.boolean().optional(),
     readOnly: z.boolean().optional(),
     type: RecipientGetTemplateRecipientTypeNumber$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: RecipientGetTemplateRecipientTextAlign6$outboundSchema
       .optional(),
@@ -2026,28 +2070,28 @@ export const RecipientGetTemplateRecipientFieldMetaUnion$inboundSchema:
     z.ZodTypeDef,
     unknown
   > = z.union([
-    z.lazy(() => RecipientGetTemplateRecipientFieldMetaRadio$inboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaInitials$inboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaName$inboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaEmail$inboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaDate$inboundSchema),
-    z.lazy(() => RecipientGetTemplateRecipientFieldMetaDropdown$inboundSchema),
-    z.lazy(() => RecipientGetTemplateRecipientFieldMetaCheckbox$inboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaText$inboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaNumber$inboundSchema),
+    z.lazy(() => RecipientGetTemplateRecipientFieldMetaRadio$inboundSchema),
+    z.lazy(() => RecipientGetTemplateRecipientFieldMetaCheckbox$inboundSchema),
+    z.lazy(() => RecipientGetTemplateRecipientFieldMetaDropdown$inboundSchema),
   ]);
 
 /** @internal */
 export type RecipientGetTemplateRecipientFieldMetaUnion$Outbound =
-  | RecipientGetTemplateRecipientFieldMetaRadio$Outbound
   | RecipientGetTemplateRecipientFieldMetaInitials$Outbound
   | RecipientGetTemplateRecipientFieldMetaName$Outbound
   | RecipientGetTemplateRecipientFieldMetaEmail$Outbound
   | RecipientGetTemplateRecipientFieldMetaDate$Outbound
-  | RecipientGetTemplateRecipientFieldMetaDropdown$Outbound
-  | RecipientGetTemplateRecipientFieldMetaCheckbox$Outbound
   | RecipientGetTemplateRecipientFieldMetaText$Outbound
-  | RecipientGetTemplateRecipientFieldMetaNumber$Outbound;
+  | RecipientGetTemplateRecipientFieldMetaNumber$Outbound
+  | RecipientGetTemplateRecipientFieldMetaRadio$Outbound
+  | RecipientGetTemplateRecipientFieldMetaCheckbox$Outbound
+  | RecipientGetTemplateRecipientFieldMetaDropdown$Outbound;
 
 /** @internal */
 export const RecipientGetTemplateRecipientFieldMetaUnion$outboundSchema:
@@ -2056,15 +2100,15 @@ export const RecipientGetTemplateRecipientFieldMetaUnion$outboundSchema:
     z.ZodTypeDef,
     RecipientGetTemplateRecipientFieldMetaUnion
   > = z.union([
-    z.lazy(() => RecipientGetTemplateRecipientFieldMetaRadio$outboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaInitials$outboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaName$outboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaEmail$outboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaDate$outboundSchema),
-    z.lazy(() => RecipientGetTemplateRecipientFieldMetaDropdown$outboundSchema),
-    z.lazy(() => RecipientGetTemplateRecipientFieldMetaCheckbox$outboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaText$outboundSchema),
     z.lazy(() => RecipientGetTemplateRecipientFieldMetaNumber$outboundSchema),
+    z.lazy(() => RecipientGetTemplateRecipientFieldMetaRadio$outboundSchema),
+    z.lazy(() => RecipientGetTemplateRecipientFieldMetaCheckbox$outboundSchema),
+    z.lazy(() => RecipientGetTemplateRecipientFieldMetaDropdown$outboundSchema),
   ]);
 
 /**
@@ -2115,11 +2159,11 @@ export const RecipientGetTemplateRecipientField$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  envelopeId: z.string(),
+  envelopeItemId: z.string(),
   type: RecipientGetTemplateRecipientType$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 RecipientGetTemplateRecipientField$inboundSchema: z.ZodType<
   inserted: z.boolean(),
   fieldMeta: z.nullable(
     z.union([
-      z.lazy(() => RecipientGetTemplateRecipientFieldMetaRadio$inboundSchema),
       z.lazy(() =>
         RecipientGetTemplateRecipientFieldMetaInitials$inboundSchema
       ),
       z.lazy(() => RecipientGetTemplateRecipientFieldMetaName$inboundSchema),
       z.lazy(() => RecipientGetTemplateRecipientFieldMetaEmail$inboundSchema),
       z.lazy(() => RecipientGetTemplateRecipientFieldMetaDate$inboundSchema),
+      z.lazy(() => RecipientGetTemplateRecipientFieldMetaText$inboundSchema),
+      z.lazy(() => RecipientGetTemplateRecipientFieldMetaNumber$inboundSchema),
+      z.lazy(() => RecipientGetTemplateRecipientFieldMetaRadio$inboundSchema),
       z.lazy(() =>
-        RecipientGetTemplateRecipientFieldMetaDropdown$inboundSchema
+        RecipientGetTemplateRecipientFieldMetaCheckbox$inboundSchema
       ),
       z.lazy(() =>
-        RecipientGetTemplateRecipientFieldMetaCheckbox$inboundSchema
+        RecipientGetTemplateRecipientFieldMetaDropdown$inboundSchema
       ),
-      z.lazy(() => RecipientGetTemplateRecipientFieldMetaText$inboundSchema),
-      z.lazy(() => RecipientGetTemplateRecipientFieldMetaNumber$inboundSchema),
     ]),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RecipientGetTemplateRecipientField$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 RecipientGetTemplateRecipientField$Outbound = {
   customText: string;
   inserted: boolean;
   fieldMeta:
-    | RecipientGetTemplateRecipientFieldMetaRadio$Outbound
     | RecipientGetTemplateRecipientFieldMetaInitials$Outbound
     | RecipientGetTemplateRecipientFieldMetaName$Outbound
     | RecipientGetTemplateRecipientFieldMetaEmail$Outbound
     | RecipientGetTemplateRecipientFieldMetaDate$Outbound
-    | RecipientGetTemplateRecipientFieldMetaDropdown$Outbound
-    | RecipientGetTemplateRecipientFieldMetaCheckbox$Outbound
     | RecipientGetTemplateRecipientFieldMetaText$Outbound
     | RecipientGetTemplateRecipientFieldMetaNumber$Outbound
+    | RecipientGetTemplateRecipientFieldMetaRadio$Outbound
+    | RecipientGetTemplateRecipientFieldMetaCheckbox$Outbound
+    | RecipientGetTemplateRecipientFieldMetaDropdown$Outbound
     | null;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -2183,11 +2231,11 @@ export const RecipientGetTemplateRecipientField$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RecipientGetTemplateRecipientField
 > = z.object({
+  envelopeId: z.string(),
+  envelopeItemId: z.string(),
   type: RecipientGetTemplateRecipientType$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 RecipientGetTemplateRecipientField$outboundSchema: z.ZodType<
   inserted: z.boolean(),
   fieldMeta: z.nullable(
     z.union([
-      z.lazy(() => RecipientGetTemplateRecipientFieldMetaRadio$outboundSchema),
       z.lazy(() =>
         RecipientGetTemplateRecipientFieldMetaInitials$outboundSchema
       ),
-      z.lazy(() =>
-        RecipientGetTemplateRecipientFieldMetaName$outboundSchema
-      ),
+      z.lazy(() => RecipientGetTemplateRecipientFieldMetaName$outboundSchema),
       z.lazy(() => RecipientGetTemplateRecipientFieldMetaEmail$outboundSchema),
       z.lazy(() => RecipientGetTemplateRecipientFieldMetaDate$outboundSchema),
+      z.lazy(() => RecipientGetTemplateRecipientFieldMetaText$outboundSchema),
+      z.lazy(() => RecipientGetTemplateRecipientFieldMetaNumber$outboundSchema),
+      z.lazy(() => RecipientGetTemplateRecipientFieldMetaRadio$outboundSchema),
       z.lazy(() =>
-        RecipientGetTemplateRecipientFieldMetaDropdown$outboundSchema
+        RecipientGetTemplateRecipientFieldMetaCheckbox$outboundSchema
       ),
       z.lazy(() =>
-        RecipientGetTemplateRecipientFieldMetaCheckbox$outboundSchema
+        RecipientGetTemplateRecipientFieldMetaDropdown$outboundSchema
       ),
-      z.lazy(() => RecipientGetTemplateRecipientFieldMetaText$outboundSchema),
-      z.lazy(() => RecipientGetTemplateRecipientFieldMetaNumber$outboundSchema),
     ]),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /**
@@ -2260,13 +2308,12 @@ export const RecipientGetTemplateRecipientResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  envelopeId: z.string(),
   role: RecipientGetTemplateRecipientRole$inboundSchema,
   readStatus: RecipientGetTemplateRecipientReadStatus$inboundSchema,
   signingStatus: RecipientGetTemplateRecipientSigningStatus$inboundSchema,
   sendStatus: RecipientGetTemplateRecipientSendStatus$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 RecipientGetTemplateRecipientResponse$inboundSchema: z.ZodType<
   fields: z.array(
     z.lazy(() => RecipientGetTemplateRecipientField$inboundSchema),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RecipientGetTemplateRecipientResponse$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 RecipientGetTemplateRecipientResponse$Outbound = {
   signingOrder: number | null;
   rejectionReason: string | null;
   fields: Array<RecipientGetTemplateRecipientField$Outbound>;
+  documentId?: number | null | undefined;
+  templateId?: number | null | undefined;
 };
 
 /** @internal */
@@ -2310,13 +2360,12 @@ export const RecipientGetTemplateRecipientResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RecipientGetTemplateRecipientResponse
 > = z.object({
+  envelopeId: z.string(),
   role: RecipientGetTemplateRecipientRole$outboundSchema,
   readStatus: RecipientGetTemplateRecipientReadStatus$outboundSchema,
   signingStatus: RecipientGetTemplateRecipientSigningStatus$outboundSchema,
   sendStatus: RecipientGetTemplateRecipientSendStatus$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 RecipientGetTemplateRecipientResponse$outboundSchema: z.ZodType<
   fields: z.array(
     z.lazy(() => RecipientGetTemplateRecipientField$outboundSchema),
   ),
+  documentId: z.nullable(z.number()).optional(),
+  templateId: z.nullable(z.number()).optional(),
 });
 
 /**