diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 8419b640..110810ce 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 2f28b0c4-e21c-47c4-aada-41da1a74c452 management: - docChecksum: 0734586080f611ee0374f81f64c8399a + docChecksum: 02958eb740d2da10d29e1482c6450f0f docVersion: 0.0.0 - speakeasyVersion: 1.606.10 - generationVersion: 2.687.13 - releaseVersion: 0.3.2 - configChecksum: a8a85d0ea717d86f4be261a03e30d33d + speakeasyVersion: 1.637.3 + generationVersion: 2.727.9 + releaseVersion: 0.4.0 + configChecksum: 916fec95705de8b6bfead150a122b146 repoURL: https://github.com/documenso/sdk-typescript.git installationURL: https://github.com/documenso/sdk-typescript published: true @@ -14,22 +14,23 @@ features: typescript: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.12 - core: 3.21.20 + core: 3.22.0 defaultEnabledRetries: 0.1.0 enumUnions: 0.1.0 + enums: 2.83.0 envVarSecurityUsage: 0.1.2 - globalSecurity: 2.82.13 + globalSecurity: 2.82.14 globalSecurityCallbacks: 0.1.0 globalSecurityFlattening: 0.1.0 globalServerURLs: 2.82.5 - groups: 2.81.2 + groups: 2.81.3 mcpServer: 0.9.3 nameOverrides: 2.81.2 nullables: 0.1.1 responseFormat: 0.2.3 retries: 2.83.0 sdkHooks: 0.3.0 - unions: 2.85.11 + unions: 2.86.0 generatedFiles: - .gitattributes - .npmignore @@ -236,6 +237,7 @@ generatedFiles: - docs/models/errors/templateupdatetemplatebadrequestissue.md - docs/models/errors/templateupdatetemplateinternalservererror.md - docs/models/errors/templateupdatetemplateinternalservererrorissue.md + - docs/models/operations/customdocumentdatum.md - docs/models/operations/datasource.md - docs/models/operations/datastatus.md - docs/models/operations/document.md @@ -1821,7 +1823,6 @@ generatedFiles: - docs/models/operations/templateupdatetemplatevisibilityresponse.md - docs/models/operations/version.md - docs/sdks/directlink/README.md - - docs/sdks/documenso/README.md - docs/sdks/document/README.md - docs/sdks/documents/README.md - docs/sdks/documentsfields/README.md @@ -2118,7 +2119,7 @@ examples: application/json: {"title": ""} responses: "200": - application/json: {"document": {"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 9025.78, "externalId": "", "userId": 3553.42, "authOptions": null, "formValues": {}, "title": "", "documentDataId": "", "createdAt": "1727678986659", "updatedAt": "1735619356040", "completedAt": null, "deletedAt": "", "teamId": 2366.18, "templateId": 5940.67, "folderId": "", "documentData": {"type": "BYTES", "id": "", "data": "", "initialData": ""}, "documentMeta": {"signingOrder": "SEQUENTIAL", "distributionMethod": "NONE", "id": "", "subject": "", "message": "", "timezone": "America/Inuvik", "password": "2lXhpWYWQqLVzMm", "dateFormat": "", "documentId": 5456.09, "redirectUrl": "https://live-valentine.net", "typedSignatureEnabled": false, "uploadSignatureEnabled": false, "drawSignatureEnabled": true, "allowDictateNextSigner": false, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": null}, "folder": {"id": "", "name": "", "type": "DOCUMENT", "visibility": "MANAGER_AND_ABOVE", "userId": 9321.89, "teamId": 5395.26, "pinned": false, "parentId": "", "createdAt": "1707737138130", "updatedAt": "1735664848668"}, "recipients": [], "fields": [{"type": "DATE", "id": 6320.09, "secondaryId": "", "documentId": 6541.15, "templateId": 7534.32, "recipientId": 4439.65, "page": 5921.96, "customText": "", "inserted": false, "fieldMeta": {"type": "radio"}}]}, "uploadUrl": "https://kaleidoscopic-maestro.info/"} + application/json: {"document": {"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 9025.78, "externalId": "", "userId": 3553.42, "authOptions": null, "formValues": {}, "title": "", "createdAt": "1727678986659", "updatedAt": "1735619356040", "completedAt": null, "deletedAt": "", "teamId": 2366.18, "folderId": "", "envelopeId": "", "documentDataId": "", "documentData": {"type": "BYTES", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "documentMeta": {"signingOrder": "SEQUENTIAL", "distributionMethod": "NONE", "id": "", "subject": "", "message": "", "timezone": "America/Inuvik", "dateFormat": "", "redirectUrl": "https://live-valentine.net", "typedSignatureEnabled": false, "uploadSignatureEnabled": false, "drawSignatureEnabled": true, "allowDictateNextSigner": false, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": null, "password": null, "documentId": -1}, "folder": {"id": "", "name": "", "type": "DOCUMENT", "visibility": "MANAGER_AND_ABOVE", "userId": 9321.89, "teamId": 5395.26, "pinned": false, "parentId": "", "createdAt": "1707737138130", "updatedAt": "1735664848668"}, "recipients": [], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "DATE", "id": 6320.09, "secondaryId": "", "recipientId": 4439.65, "page": 5921.96, "customText": "", "inserted": false, "fieldMeta": {"type": "radio"}, "documentId": 6541.15, "templateId": 7534.32}]}, "uploadUrl": "https://kaleidoscopic-maestro.info/"} "400": application/json: {"message": "", "code": ""} "500": @@ -2196,7 +2197,7 @@ examples: fieldId: 6077.81 responses: "200": - application/json: {"type": "DROPDOWN", "id": 1675.25, "secondaryId": "", "documentId": 5913.76, "templateId": 5141.8, "recipientId": 41.83, "page": 2158.79, "customText": "", "inserted": true, "fieldMeta": {"type": "radio"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "DROPDOWN", "id": 1675.25, "secondaryId": "", "recipientId": 41.83, "page": 2158.79, "customText": "", "inserted": true, "fieldMeta": {"type": "radio"}} "400": application/json: {"message": "", "code": ""} "404": @@ -2209,7 +2210,7 @@ examples: application/json: {"documentId": 8001.93, "field": {"type": "NAME", "recipientId": 2564.68, "pageNumber": 791.77, "pageX": 7845.22, "pageY": 6843.16, "width": 3932.15, "height": 8879.89}} responses: "200": - application/json: {"type": "SIGNATURE", "id": 2381.57, "secondaryId": "", "documentId": 3378.71, "templateId": 787.23, "recipientId": 1080.89, "page": 9103.02, "customText": "", "inserted": false, "fieldMeta": null} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "SIGNATURE", "id": 2381.57, "secondaryId": "", "recipientId": 1080.89, "page": 9103.02, "customText": "", "inserted": false, "fieldMeta": null} "400": application/json: {"message": "", "code": ""} "500": @@ -2231,7 +2232,7 @@ examples: application/json: {"documentId": 5956.26, "field": {"type": "FREE_SIGNATURE", "id": 6955.16}} responses: "200": - application/json: {"type": "INITIALS", "id": 1295.68, "secondaryId": "", "documentId": 4731.43, "templateId": 502.03, "recipientId": 9839.63, "page": 8795.43, "customText": "", "inserted": true, "fieldMeta": {"type": "initials"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "INITIALS", "id": 1295.68, "secondaryId": "", "recipientId": 9839.63, "page": 8795.43, "customText": "", "inserted": true, "fieldMeta": {"type": "initials"}} "400": application/json: {"message": "", "code": ""} "500": @@ -2265,7 +2266,7 @@ examples: recipientId: 874.3 responses: "200": - application/json: {"role": "VIEWER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 2011.21, "documentId": 8537.53, "templateId": 7026.32, "email": "Micaela.McCullough@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["ACCOUNT"]}, "signingOrder": 2776.88, "rejectionReason": "", "fields": [{"type": "FREE_SIGNATURE", "id": 6796.74, "secondaryId": "", "documentId": null, "templateId": null, "recipientId": 4324.4, "page": 7869.52, "customText": "", "inserted": true, "fieldMeta": {"type": "checkbox", "direction": "vertical"}}]} + application/json: {"envelopeId": "", "role": "VIEWER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 2011.21, "email": "Micaela.McCullough@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["ACCOUNT"]}, "signingOrder": 2776.88, "rejectionReason": "", "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "FREE_SIGNATURE", "id": 6796.74, "secondaryId": "", "recipientId": 4324.4, "page": 7869.52, "customText": "", "inserted": true, "fieldMeta": {"type": "checkbox", "direction": "vertical"}, "documentId": null, "templateId": null}]} "400": application/json: {"message": "", "code": ""} "404": @@ -2278,7 +2279,7 @@ examples: application/json: {"documentId": 3058.31, "recipient": {"email": "Ila.Steuber@yahoo.com", "name": "", "role": "ASSISTANT"}} responses: "200": - application/json: {"role": "ASSISTANT", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 4556.07, "documentId": 2327.54, "templateId": 7160.46, "email": "Kitty_Heathcote-Huels@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["TWO_FACTOR_AUTH"]}, "signingOrder": 3961.73, "rejectionReason": null} + application/json: {"envelopeId": "", "role": "ASSISTANT", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 4556.07, "email": "Kitty_Heathcote-Huels@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["TWO_FACTOR_AUTH"]}, "signingOrder": 3961.73, "rejectionReason": null} "400": application/json: {"message": "", "code": ""} "500": @@ -2300,7 +2301,7 @@ examples: application/json: {"documentId": 7045.62, "recipient": {"id": 2224.05}} responses: "200": - application/json: {"role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 6679.58, "documentId": 1962.76, "templateId": 8876.44, "email": "Ned42@yahoo.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": [], "actionAuth": ["PASSKEY"]}, "signingOrder": 231.61, "rejectionReason": "", "fields": []} + application/json: {"envelopeId": "", "role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 6679.58, "email": "Ned42@yahoo.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": [], "actionAuth": ["PASSKEY"]}, "signingOrder": 231.61, "rejectionReason": "", "fields": []} "400": application/json: {"message": "", "code": ""} "500": @@ -2311,7 +2312,7 @@ examples: application/json: {"documentId": 3189.76, "recipients": []} responses: "200": - application/json: {"recipients": [{"role": "VIEWER", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 7967.19, "documentId": 366.25, "templateId": 5896.63, "email": "Burley.Kuhn68@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": null, "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 1407.42, "rejectionReason": "", "fields": [{"type": "NAME", "id": 9168.07, "secondaryId": "", "documentId": 7326.55, "templateId": 4970.01, "recipientId": 2204.76, "page": 9162.68, "customText": "", "inserted": true, "fieldMeta": {"type": "number"}}]}]} + application/json: {"recipients": [{"envelopeId": "", "role": "VIEWER", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 7967.19, "email": "Burley.Kuhn68@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": null, "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 1407.42, "rejectionReason": "", "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "NAME", "id": 9168.07, "secondaryId": "", "recipientId": 2204.76, "page": 9162.68, "customText": "", "inserted": true, "fieldMeta": {"type": "number"}, "documentId": 7326.55, "templateId": 4970.01}], "documentId": 366.25, "templateId": 5896.63}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2331,7 +2332,7 @@ examples: speakeasy-default-template-find-templates: responses: "200": - application/json: {"data": [{"type": "PRIVATE", "visibility": "ADMIN", "id": 8353.5, "externalId": "", "title": "", "userId": 3928.48, "teamId": 3159.46, "authOptions": {"globalAccessAuth": [], "globalActionAuth": ["TWO_FACTOR_AUTH"]}, "templateDocumentDataId": "", "createdAt": "1714153048686", "updatedAt": "1735669673106", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": true, "team": {"id": 2668.99, "url": "https://prickly-catalyst.info/"}, "fields": [], "recipients": [{"role": "APPROVER", "readStatus": "NOT_OPENED", "signingStatus": "REJECTED", "sendStatus": "NOT_SENT", "id": 2399.32, "documentId": 7002.73, "templateId": 3480.56, "email": "Trinity4@yahoo.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 7999, "rejectionReason": ""}], "templateMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL"}, "directLink": {"token": "", "enabled": false}}], "count": 3257.39, "currentPage": 6213.36, "perPage": 1087.86, "totalPages": 9305.35} + application/json: {"data": [{"type": "PRIVATE", "visibility": "ADMIN", "id": 8353.5, "externalId": "", "title": "", "userId": 3928.48, "teamId": 3159.46, "authOptions": {"globalAccessAuth": [], "globalActionAuth": ["TWO_FACTOR_AUTH"]}, "createdAt": "1714153048686", "updatedAt": "1735669673106", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": true, "envelopeId": "", "team": {"id": 2668.99, "url": "https://prickly-catalyst.info/"}, "fields": [], "recipients": [{"envelopeId": "", "role": "APPROVER", "readStatus": "NOT_OPENED", "signingStatus": "REJECTED", "sendStatus": "NOT_SENT", "id": 2399.32, "email": "Trinity4@yahoo.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 7999, "rejectionReason": "", "documentId": 7002.73, "templateId": 3480.56}], "templateMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL"}, "directLink": {"token": "", "enabled": false}, "templateDocumentDataId": ""}], "count": 3257.39, "currentPage": 6213.36, "perPage": 1087.86, "totalPages": 9305.35} "400": application/json: {"message": "", "code": ""} "404": @@ -2345,7 +2346,7 @@ examples: templateId: 2128.54 responses: "200": - application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 2786.55, "externalId": "", "title": "", "userId": 6940.89, "teamId": 3976.59, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": []}, "templateDocumentDataId": "", "createdAt": "1723768641783", "updatedAt": "1735674990008", "publicTitle": "", "publicDescription": "", "folderId": "", "templateDocumentData": {"type": "S3_PATH", "id": "", "data": "", "initialData": ""}, "templateMeta": null, "directLink": {"id": "", "templateId": 7277.86, "token": "", "createdAt": "1717601799828", "enabled": false, "directTemplateRecipientId": 834.56}, "user": {"id": 9738.42, "name": null, "email": "Mack_Medhurst1@yahoo.com"}, "recipients": [{"role": "SIGNER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 4032.33, "documentId": 1928.67, "templateId": 8554.25, "email": "Jerod84@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": null, "signingOrder": 2256.36, "rejectionReason": ""}], "fields": [{"type": "DROPDOWN", "id": 5010.54, "secondaryId": "", "documentId": 7051.15, "templateId": 2232.05, "recipientId": 1178.91, "page": 6095.28, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}}], "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "ADMIN", "userId": 3373.59, "teamId": 8767.64, "pinned": true, "parentId": "", "createdAt": "1730669445716", "updatedAt": "1735609508778"}} + application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 2786.55, "externalId": "", "title": "", "userId": 6940.89, "teamId": 3976.59, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": []}, "createdAt": "1723768641783", "updatedAt": "1735674990008", "publicTitle": "", "publicDescription": "", "folderId": "", "envelopeId": "", "templateDocumentDataId": "", "templateDocumentData": {"type": "S3_PATH", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "templateMeta": {"id": "", "subject": "", "message": "", "timezone": "America/Indiana/Indianapolis", "dateFormat": "", "signingOrder": "SEQUENTIAL", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": false, "allowDictateNextSigner": false, "distributionMethod": "EMAIL", "redirectUrl": "https://prudent-embossing.com", "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": "", "templateId": 834.56}, "directLink": {"id": "", "envelopeId": "", "token": "", "createdAt": "1717601799828", "enabled": false, "directTemplateRecipientId": 834.56, "templateId": 7277.86}, "user": {"id": 9738.42, "name": null, "email": "Mack_Medhurst1@yahoo.com"}, "recipients": [{"envelopeId": "", "role": "SIGNER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 4032.33, "email": "Jerod84@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": null, "signingOrder": 2256.36, "rejectionReason": "", "documentId": 1928.67, "templateId": 8554.25}], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "DROPDOWN", "id": 5010.54, "secondaryId": "", "recipientId": 1178.91, "page": 6095.28, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}, "documentId": 7051.15, "templateId": 2232.05}], "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "ADMIN", "userId": 3373.59, "teamId": 8767.64, "pinned": true, "parentId": "", "createdAt": "1730669445716", "updatedAt": "1735609508778"}} "400": application/json: {"message": "", "code": ""} "404": @@ -2358,7 +2359,7 @@ examples: application/json: {"templateId": 9404.77} responses: "200": - application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 5983.02, "externalId": "", "title": "", "userId": 9111.71, "teamId": 6120.86, "authOptions": {"globalAccessAuth": [], "globalActionAuth": []}, "templateDocumentDataId": "", "createdAt": "1709192090796", "updatedAt": "1735628592236", "publicTitle": "", "publicDescription": "", "folderId": null, "useLegacyFieldInsertion": false} + application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 5983.02, "externalId": "", "title": "", "userId": 9111.71, "teamId": 6120.86, "authOptions": {"globalAccessAuth": [], "globalActionAuth": []}, "createdAt": "1709192090796", "updatedAt": "1735628592236", "publicTitle": "", "publicDescription": "", "folderId": null, "useLegacyFieldInsertion": false, "envelopeId": "", "templateDocumentDataId": ""} "400": application/json: {"message": "", "code": ""} "500": @@ -2369,7 +2370,7 @@ examples: application/json: {"templateId": 2490.16} responses: "200": - application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 4866.89, "externalId": "", "title": "", "userId": 9126.65, "teamId": 4478.26, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": []}, "templateDocumentDataId": "", "createdAt": "1704548362148", "updatedAt": "1735659577102", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": true} + application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 4866.89, "externalId": "", "title": "", "userId": 9126.65, "teamId": 4478.26, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": []}, "createdAt": "1704548362148", "updatedAt": "1735659577102", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": true, "envelopeId": "", "templateDocumentDataId": ""} "400": application/json: {"message": "", "code": ""} "500": @@ -2391,7 +2392,7 @@ examples: application/json: {"templateId": 7392.96, "recipients": []} responses: "200": - application/json: {"visibility": "EVERYONE", "status": "DRAFT", "source": "DOCUMENT", "id": 5310.67, "externalId": "", "userId": 4199.74, "authOptions": {"globalAccessAuth": [], "globalActionAuth": ["PASSWORD"]}, "formValues": {"key": ""}, "title": "", "documentDataId": "", "createdAt": "1713071497395", "updatedAt": "1735653497198", "completedAt": "", "deletedAt": "", "teamId": 7804.64, "templateId": null, "folderId": "", "documentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "", "subject": "", "message": "", "timezone": "Asia/Baghdad", "password": "YbkNhe0kXAWK9Uf", "dateFormat": "", "documentId": 808.12, "redirectUrl": "https://crazy-passport.info", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": ""}, "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "EVERYONE", "userId": 1798.88, "teamId": 8271.19, "pinned": true, "parentId": "", "createdAt": "1708992067457", "updatedAt": "1735631101461"}, "recipients": [{"role": "CC", "readStatus": "OPENED", "signingStatus": "NOT_SIGNED", "sendStatus": "SENT", "id": 5426.03, "documentId": 4293.73, "templateId": 1031.22, "email": "Jada_Schowalter@hotmail.com", "name": "", "token": "", "documentDeletedAt": null, "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSWORD"]}, "signingOrder": 6463.78, "rejectionReason": null}], "fields": []} + application/json: {"visibility": "EVERYONE", "status": "DRAFT", "source": "DOCUMENT", "id": 5310.67, "externalId": "", "userId": 4199.74, "authOptions": {"globalAccessAuth": [], "globalActionAuth": ["PASSWORD"]}, "formValues": {"key": ""}, "title": "", "createdAt": "1713071497395", "updatedAt": "1735653497198", "completedAt": "", "deletedAt": "", "teamId": 7804.64, "folderId": "", "envelopeId": "", "documentDataId": "", "documentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "", "subject": "", "message": "", "timezone": "Asia/Baghdad", "dateFormat": "", "redirectUrl": "https://crazy-passport.info", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": "", "password": null, "documentId": -1}, "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "EVERYONE", "userId": 1798.88, "teamId": 8271.19, "pinned": true, "parentId": "", "createdAt": "1708992067457", "updatedAt": "1735631101461"}, "recipients": [{"envelopeId": "", "role": "CC", "readStatus": "OPENED", "signingStatus": "NOT_SIGNED", "sendStatus": "SENT", "id": 5426.03, "email": "Jada_Schowalter@hotmail.com", "name": "", "token": "", "documentDeletedAt": null, "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSWORD"]}, "signingOrder": 6463.78, "rejectionReason": null, "documentId": 4293.73, "templateId": 1031.22}], "fields": []} "400": application/json: {"message": "", "code": ""} "500": @@ -2413,7 +2414,7 @@ examples: application/json: {"templateId": 1203.71, "field": {"type": "DATE", "recipientId": 2738.54, "pageNumber": 5735.12, "pageX": 2936.28, "pageY": 8594.41, "width": 7589.39, "height": 3122.23}} responses: "200": - application/json: {"type": "NAME", "id": 3321.38, "secondaryId": "", "documentId": 7985.8, "templateId": 394.38, "recipientId": 8001.07, "page": 9090.42, "customText": "", "inserted": false, "fieldMeta": {"type": "checkbox", "direction": "vertical"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "NAME", "id": 3321.38, "secondaryId": "", "recipientId": 8001.07, "page": 9090.42, "customText": "", "inserted": false, "fieldMeta": {"type": "checkbox", "direction": "vertical"}} "400": application/json: {"message": "", "code": ""} "500": @@ -2425,7 +2426,7 @@ examples: fieldId: 1152.82 responses: "200": - application/json: {"type": "TEXT", "id": 2979.32, "secondaryId": "", "documentId": 3596.91, "templateId": 6711.15, "recipientId": 6690.25, "page": 5824.69, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "TEXT", "id": 2979.32, "secondaryId": "", "recipientId": 6690.25, "page": 5824.69, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}} "400": application/json: {"message": "", "code": ""} "404": @@ -2438,7 +2439,7 @@ examples: application/json: {"templateId": 586.2, "fields": [{"type": "SIGNATURE", "recipientId": 6990.12, "pageNumber": 3472.45, "pageX": 4747.87, "pageY": 1673.94, "width": 7215.37, "height": 9417.43}]} responses: "200": - application/json: {"fields": [{"type": "CHECKBOX", "id": 7862.02, "secondaryId": "", "documentId": 6981.63, "templateId": 9898.46, "recipientId": 8274.39, "page": 3264.78, "customText": "", "inserted": true, "fieldMeta": {"type": "name"}}]} + application/json: {"fields": [{"envelopeId": "", "envelopeItemId": "", "type": "CHECKBOX", "id": 7862.02, "secondaryId": "", "recipientId": 8274.39, "page": 3264.78, "customText": "", "inserted": true, "fieldMeta": {"type": "name"}, "documentId": 6981.63, "templateId": 9898.46}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2449,7 +2450,7 @@ examples: application/json: {"templateId": 5083.07, "field": {"type": "TEXT", "id": 1792.29}} responses: "200": - application/json: {"type": "CHECKBOX", "id": 5188.56, "secondaryId": "", "documentId": 9956.37, "templateId": 7914.68, "recipientId": 4165.02, "page": 9069.54, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "CHECKBOX", "id": 5188.56, "secondaryId": "", "recipientId": 4165.02, "page": 9069.54, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}} "400": application/json: {"message": "", "code": ""} "500": @@ -2460,7 +2461,7 @@ examples: application/json: {"templateId": 3969.1, "fields": [{"type": "DROPDOWN", "id": 2460.72}]} responses: "200": - application/json: {"fields": [{"type": "CHECKBOX", "id": 5681.05, "secondaryId": "", "documentId": 3141.26, "templateId": 6919.19, "recipientId": 3658.89, "page": 6460.06, "customText": "", "inserted": true, "fieldMeta": {"type": "initials"}}]} + application/json: {"fields": [{"envelopeId": "", "envelopeItemId": "", "type": "CHECKBOX", "id": 5681.05, "secondaryId": "", "recipientId": 3658.89, "page": 6460.06, "customText": "", "inserted": true, "fieldMeta": {"type": "initials"}, "documentId": 3141.26, "templateId": 6919.19}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2483,7 +2484,7 @@ examples: recipientId: 9436.42 responses: "200": - application/json: {"role": "SIGNER", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 3084.26, "documentId": 9767.45, "templateId": 4075, "email": "Clovis_Stoltenberg@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": null, "signedAt": "", "authOptions": {"accessAuth": [], "actionAuth": ["PASSWORD"]}, "signingOrder": 5048.3, "rejectionReason": null, "fields": [{"type": "DROPDOWN", "id": 1498.08, "secondaryId": "", "documentId": 3041.54, "templateId": 8898.39, "recipientId": 5421.45, "page": 5530.65, "customText": "", "inserted": false, "fieldMeta": {"type": "radio"}}]} + application/json: {"envelopeId": "", "role": "SIGNER", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 3084.26, "email": "Clovis_Stoltenberg@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": null, "signedAt": "", "authOptions": {"accessAuth": [], "actionAuth": ["PASSWORD"]}, "signingOrder": 5048.3, "rejectionReason": null, "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "DROPDOWN", "id": 1498.08, "secondaryId": "", "recipientId": 5421.45, "page": 5530.65, "customText": "", "inserted": false, "fieldMeta": {"type": "radio"}, "documentId": 3041.54, "templateId": 8898.39}]} "400": application/json: {"message": "", "code": ""} "404": @@ -2496,7 +2497,7 @@ examples: application/json: {"templateId": 5712.95, "recipient": {"email": "Gerhard88@yahoo.com", "name": "", "role": "SIGNER"}} responses: "200": - application/json: {"role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 3391.15, "documentId": 1642.76, "templateId": 1072.6, "email": "Vida29@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": null, "signingOrder": 8644.53, "rejectionReason": ""} + application/json: {"envelopeId": "", "role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 3391.15, "email": "Vida29@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": null, "signingOrder": 8644.53, "rejectionReason": ""} "400": application/json: {"message": "", "code": ""} "500": @@ -2518,7 +2519,7 @@ examples: application/json: {"templateId": 2984.61, "recipient": {"id": 8617.99}} responses: "200": - application/json: {"role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 3174.79, "documentId": 149.88, "templateId": 5506.77, "email": "Esperanza_Moen@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 6494.69, "rejectionReason": "", "fields": []} + application/json: {"envelopeId": "", "role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 3174.79, "email": "Esperanza_Moen@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 6494.69, "rejectionReason": "", "fields": []} "400": application/json: {"message": "", "code": ""} "500": @@ -2529,7 +2530,7 @@ examples: application/json: {"templateId": 5597.58, "recipients": [{"id": 1630.42}]} responses: "200": - application/json: {"recipients": [{"role": "CC", "readStatus": "NOT_OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 653.82, "documentId": 3004.48, "templateId": null, "email": "Ramona58@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 9903.26, "rejectionReason": "", "fields": [{"type": "EMAIL", "id": 4590.2, "secondaryId": "", "documentId": null, "templateId": 893.72, "recipientId": 3286.18, "page": 3712.73, "customText": "", "inserted": false, "fieldMeta": {"type": "text"}}]}]} + application/json: {"recipients": [{"envelopeId": "", "role": "CC", "readStatus": "NOT_OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 653.82, "email": "Ramona58@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 9903.26, "rejectionReason": "", "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "EMAIL", "id": 4590.2, "secondaryId": "", "recipientId": 3286.18, "page": 3712.73, "customText": "", "inserted": false, "fieldMeta": {"type": "text"}, "documentId": null, "templateId": 893.72}], "documentId": 3004.48, "templateId": null}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2551,7 +2552,7 @@ examples: application/json: {"templateId": 5094.31} responses: "200": - application/json: {"id": "", "templateId": 9525.52, "token": "", "createdAt": "1721338708803", "enabled": true, "directTemplateRecipientId": 892.62} + application/json: {"id": "", "token": "", "createdAt": "1721338708803", "enabled": true, "directTemplateRecipientId": 892.62, "envelopeId": "", "templateId": 9525.52} "400": application/json: {"message": "", "code": ""} "500": @@ -2573,7 +2574,7 @@ examples: application/json: {"templateId": 6583.54, "enabled": false} responses: "200": - application/json: {"id": "", "templateId": 3373.72, "token": "", "createdAt": "1718653442722", "enabled": false, "directTemplateRecipientId": 6029.67} + application/json: {"id": "", "token": "", "createdAt": "1718653442722", "enabled": false, "directTemplateRecipientId": 6029.67, "envelopeId": "", "templateId": 3373.72} "400": application/json: {"message": "", "code": ""} "500": @@ -2607,7 +2608,7 @@ examples: documentId: 6150.61 responses: "200": - application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "COMPLETED", "source": "TEMPLATE_DIRECT_LINK", "id": 790.23, "externalId": "", "userId": 6931.1, "authOptions": {"globalAccessAuth": [], "globalActionAuth": ["PASSWORD"]}, "formValues": {"key": true}, "title": "", "documentDataId": "", "createdAt": "1711154896799", "updatedAt": "1735666806591", "completedAt": "", "deletedAt": "", "teamId": 3827.21, "templateId": 4732.99, "folderId": null, "documentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "", "subject": "", "message": "", "timezone": "Asia/Irkutsk", "password": "umjrsCYmtCVkTfk", "dateFormat": "", "documentId": 7995.91, "redirectUrl": "https://male-solution.biz", "typedSignatureEnabled": true, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": ""}, "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "EVERYONE", "userId": 3251.85, "teamId": 8449.35, "pinned": false, "parentId": "", "createdAt": "1708562085192", "updatedAt": "1735658632171"}, "recipients": [], "fields": []} + application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "COMPLETED", "source": "TEMPLATE_DIRECT_LINK", "id": 790.23, "externalId": "", "userId": 6931.1, "authOptions": {"globalAccessAuth": [], "globalActionAuth": ["PASSWORD"]}, "formValues": {"key": true}, "title": "", "createdAt": "1711154896799", "updatedAt": "1735666806591", "completedAt": "", "deletedAt": "", "teamId": 3827.21, "folderId": null, "envelopeId": "", "documentDataId": "", "documentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "", "subject": "", "message": "", "timezone": "Asia/Irkutsk", "dateFormat": "", "redirectUrl": "https://male-solution.biz", "typedSignatureEnabled": true, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": "", "password": null, "documentId": -1}, "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "EVERYONE", "userId": 3251.85, "teamId": 8449.35, "pinned": false, "parentId": "", "createdAt": "1708562085192", "updatedAt": "1735658632171"}, "recipients": [], "fields": []} "400": application/json: {"message": "", "code": ""} "404": @@ -2621,7 +2622,7 @@ examples: orderByDirection: "desc" responses: "200": - application/json: {"data": [{"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 7654.95, "externalId": "", "userId": 7633.68, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": []}, "formValues": {"key": ""}, "title": "", "documentDataId": "", "createdAt": "1727038710195", "updatedAt": "1735623651736", "completedAt": "", "deletedAt": "", "teamId": 4974.29, "templateId": 2770.63, "folderId": "", "useLegacyFieldInsertion": false, "user": {"id": 2349.98, "name": "", "email": "Houston76@gmail.com"}, "recipients": [{"role": "SIGNER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "NOT_SENT", "id": 41.02, "documentId": null, "templateId": 6978.53, "email": "Max.Quigley12@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 3026.85, "rejectionReason": ""}], "team": {"id": 392.69, "url": "https://whopping-obligation.biz/"}}], "count": 5292.54, "currentPage": 6035.56, "perPage": 5604.88, "totalPages": 6554.44} + application/json: {"data": [{"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 7654.95, "externalId": "", "userId": 7633.68, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": []}, "formValues": {"key": ""}, "title": "", "createdAt": "1727038710195", "updatedAt": "1735623651736", "completedAt": "", "deletedAt": "", "teamId": 4974.29, "folderId": "", "useLegacyFieldInsertion": false, "envelopeId": "", "documentDataId": "", "templateId": 2770.63, "user": {"id": 2349.98, "name": "", "email": "Houston76@gmail.com"}, "recipients": [{"envelopeId": "", "role": "SIGNER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "NOT_SENT", "id": 41.02, "email": "Max.Quigley12@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": []}, "signingOrder": 3026.85, "rejectionReason": "", "documentId": null, "templateId": 6978.53}], "team": {"id": 392.69, "url": "https://whopping-obligation.biz/"}}], "count": 5292.54, "currentPage": 6035.56, "perPage": 5604.88, "totalPages": 6554.44} "400": application/json: {"message": "", "code": ""} "404": @@ -2634,7 +2635,7 @@ examples: application/json: {"documentId": 3428.95} responses: "200": - application/json: {"visibility": "EVERYONE", "status": "COMPLETED", "source": "TEMPLATE_DIRECT_LINK", "id": 3519.03, "externalId": null, "userId": 7295.76, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["PASSKEY"]}, "formValues": {"key": 2836.38}, "title": "", "documentDataId": "", "createdAt": "1715198116202", "updatedAt": "1735678172451", "completedAt": null, "deletedAt": "", "teamId": 6211.31, "templateId": null, "folderId": "", "useLegacyFieldInsertion": true} + application/json: {"visibility": "EVERYONE", "status": "COMPLETED", "source": "TEMPLATE_DIRECT_LINK", "id": 3519.03, "externalId": null, "userId": 7295.76, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["PASSKEY"]}, "formValues": {"key": 2836.38}, "title": "", "createdAt": "1715198116202", "updatedAt": "1735678172451", "completedAt": null, "deletedAt": "", "teamId": 6211.31, "folderId": "", "useLegacyFieldInsertion": true, "envelopeId": "", "documentDataId": ""} "400": application/json: {"message": "", "code": ""} "500": @@ -2656,7 +2657,7 @@ examples: application/json: {"documentId": 5285.3} responses: "200": - application/json: {"documentId": 1846.9} + application/json: {"id": "", "documentId": 1846.9} "400": application/json: {"message": "", "code": ""} "500": @@ -2667,7 +2668,7 @@ examples: application/json: {"documentId": 7548.74} responses: "200": - application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE", "id": 4202.33, "externalId": "", "userId": 139.61, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["ACCOUNT"]}, "formValues": {"key": 3939.25}, "title": "", "documentDataId": "", "createdAt": "1711393054424", "updatedAt": "1735639958766", "completedAt": "", "deletedAt": "", "teamId": 3513.5, "templateId": 7969.92, "folderId": "", "useLegacyFieldInsertion": false} + application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE", "id": 4202.33, "externalId": "", "userId": 139.61, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["ACCOUNT"]}, "formValues": {"key": 3939.25}, "title": "", "createdAt": "1711393054424", "updatedAt": "1735639958766", "completedAt": "", "deletedAt": "", "teamId": 3513.5, "folderId": "", "useLegacyFieldInsertion": false, "envelopeId": "", "documentDataId": ""} "400": application/json: {"message": "", "code": ""} "500": @@ -2705,11 +2706,11 @@ examples: application/json: {"title": ""} responses: "200": - application/json: {"template": {"type": "PUBLIC", "visibility": "ADMIN", "id": 8391.69, "externalId": "", "title": "", "userId": 6247.95, "teamId": 5122.65, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["TWO_FACTOR_AUTH"]}, "templateDocumentDataId": "", "createdAt": "1712192211407", "updatedAt": "1735675735056", "publicTitle": "", "publicDescription": "", "folderId": "", "templateDocumentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": ""}, "templateMeta": {"id": "", "subject": "", "message": "", "timezone": "Asia/Sakhalin", "dateFormat": "", "signingOrder": "PARALLEL", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "distributionMethod": "NONE", "templateId": 7720.82, "redirectUrl": "https://vivid-kiss.biz/", "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": ""}, "directLink": {"id": "", "templateId": 8606.18, "token": "", "createdAt": "1721483827272", "enabled": false, "directTemplateRecipientId": 697.57}, "user": {"id": 1951.08, "name": "", "email": "Irving.Wilderman49@yahoo.com"}, "recipients": [], "fields": [{"type": "FREE_SIGNATURE", "id": 7540.28, "secondaryId": "", "documentId": 4328.3, "templateId": 18.79, "recipientId": 19.81, "page": 1036.07, "customText": "", "inserted": true, "fieldMeta": {"type": "email"}}], "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "ADMIN", "userId": 668.9, "teamId": 9535.83, "pinned": true, "parentId": null, "createdAt": "1721370013638", "updatedAt": "1735673140541"}}, "uploadUrl": "https://blank-stranger.name"} + application/json: {"template": {"type": "PUBLIC", "visibility": "ADMIN", "id": 8391.69, "externalId": "", "title": "", "userId": 6247.95, "teamId": 5122.65, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["TWO_FACTOR_AUTH"]}, "createdAt": "1712192211407", "updatedAt": "1735675735056", "publicTitle": "", "publicDescription": "", "folderId": "", "envelopeId": "", "templateDocumentDataId": "", "templateDocumentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "templateMeta": {"id": "", "subject": "", "message": "", "timezone": "Asia/Sakhalin", "dateFormat": "", "signingOrder": "PARALLEL", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "distributionMethod": "NONE", "redirectUrl": "https://vivid-kiss.biz/", "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": "", "templateId": 7720.82}, "directLink": {"id": "", "envelopeId": "", "token": "", "createdAt": "1721483827272", "enabled": false, "directTemplateRecipientId": 697.57, "templateId": 8606.18}, "user": {"id": 1951.08, "name": "", "email": "Irving.Wilderman49@yahoo.com"}, "recipients": [], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "FREE_SIGNATURE", "id": 7540.28, "secondaryId": "", "recipientId": 19.81, "page": 1036.07, "customText": "", "inserted": true, "fieldMeta": {"type": "email"}, "documentId": 4328.3, "templateId": 18.79}], "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "ADMIN", "userId": 668.9, "teamId": 9535.83, "pinned": true, "parentId": null, "createdAt": "1721370013638", "updatedAt": "1735673140541"}}, "uploadUrl": "https://blank-stranger.name"} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} examplesVersion: 1.0.2 generatedTests: {} -releaseNotes: "## SDK Changes Detected:\n* `documenso.documents.get()`: \n * `request.folderId` **Removed** **Breaking** :warning:\n * `response` **Changed**\n* `documenso.documents.recipients.update()`: `response.fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.templates.fields.updateMany()`: \n * `request.fields.[].[class].fieldMeta.direction` **Added**\n * `response.fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.template.templateCreateTemplateTemporary()`: **Added**\n* `documenso.documents.createV0()`: \n * `request` **Changed**\n * `response.document` **Changed**\n* `documenso.documents.distribute()`: \n * `request.meta` **Changed**\n* `documenso.documents.fields.get()`: `response.fieldmeta.[class].direction` **Added**\n* `documenso.documents.fields.create()`: \n * `request.field.[class].fieldMeta.direction` **Added**\n * `response.fieldmeta.[class].direction` **Added**\n* `documenso.documents.fields.createMany()`: \n * `request.fields.[].[class].fieldMeta.direction` **Added**\n * `response.fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.documents.fields.update()`: \n * `request.field.[class].fieldMeta.direction` **Added**\n * `response.fieldmeta.[class].direction` **Added**\n* `documenso.documents.fields.updateMany()`: \n * `request.fields.[].[class].fieldMeta.direction` **Added**\n * `response.fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.documents.recipients.get()`: `response.fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.document.documentDownload()`: **Added**\n* `documenso.documents.update()`: \n * `request.meta` **Changed**\n* `documenso.templates.get()`: `response` **Changed**\n* `documenso.documents.recipients.updateMany()`: `response.recipients.[].fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.templates.update()`: \n * `request.meta` **Changed**\n* `documenso.templates.use()`: \n * `request.folderId` **Added**\n * `response` **Changed**\n* `documenso.templates.fields.create()`: \n * `request.field.[class].fieldMeta.direction` **Added**\n * `response.fieldmeta.[class].direction` **Added**\n* `documenso.templates.fields.get()`: `response.fieldmeta.[class].direction` **Added**\n* `documenso.templates.fields.createMany()`: \n * `request.fields.[].[class].fieldMeta.direction` **Added**\n * `response.fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.templates.fields.update()`: \n * `request.field.[class].fieldMeta.direction` **Added**\n * `response.fieldmeta.[class].direction` **Added**\n* `documenso.templates.find()`: `response.data.[].fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.templates.recipients.get()`: `response.fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.templates.recipients.update()`: `response.fields.[].fieldMeta.[class].direction` **Added**\n* `documenso.templates.recipients.updateMany()`: `response.recipients.[].fields.[].fieldMeta.[class].direction` **Added**\n" +releaseNotes: "## Typescript SDK Changes Detected:\n* `documenso.templates.find()`: `response.data.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.template.templateCreateTemplateTemporary()`: `response.template` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.updateMany()`: `response.recipients.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.update()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.createV0()`: \n * `request` **Changed**\n * `response.document` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.create()`: \n * `request.field.[class].fieldMeta` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.createMany()`: \n * `request.fields.[].[class].fieldMeta` **Changed**\n * `response.fields.[]` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.update()`: \n * `request.field.[class].fieldMeta` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.updateMany()`: \n * `request.fields.[].[class].fieldMeta` **Changed**\n * `response.fields.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.update()`: \n * `request.field.[class].fieldMeta` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.update()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.updateMany()`: `response.recipients.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.createMany()`: \n * `request.fields.[].[class].fieldMeta` **Changed**\n * `response.fields.[]` **Changed** **Breaking** :warning:\n* `documenso.documents.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.updateMany()`: \n * `request.fields.[].[class].fieldMeta` **Changed**\n * `response.fields.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.templates.use()`: \n * `request.customDocumentData` **Added**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.create()`: \n * `request.field.[class].fieldMeta` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.templates.duplicate()`: `response` **Changed**\n* `documenso.documents.find()`: `response.data.[]` **Changed**\n* `documenso.documents.recipients.createMany()`: `response.recipients.[]` **Changed**\n* `documenso.documents.recipients.create()`: `response` **Changed**\n* `documenso.templates.update()`: \n * `request.data.folderId` **Added**\n * `response` **Changed**\n* `documenso.templates.recipients.create()`: `response` **Changed**\n* `documenso.templates.recipients.createMany()`: `response.recipients.[]` **Changed**\n* `documenso.documents.distribute()`: `response` **Changed**\n* `documenso.documents.duplicate()`: `response.id` **Added**\n* `documenso.templates.directLink.create()`: `response.envelopeid` **Added**\n* `documenso.templates.directLink.toggle()`: `response.envelopeid` **Added**\n* `documenso.documents.update()`: \n * `request` **Changed**\n * `response` **Changed**\n" diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 6b16ff91..7e6209f2 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -16,12 +16,16 @@ generation: auth: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false + hoistGlobalSecurity: true + schemas: + allOfMergeStrategy: shallowMerge tests: generateTests: true generateNewTests: false skipResponseBodyAssertions: false typescript: - version: 0.3.2 + version: 0.4.0 + acceptHeaderEnum: true additionalDependencies: dependencies: {} devDependencies: {} @@ -52,10 +56,12 @@ typescript: jsonpath: legacy maxMethodParams: 0 methodArguments: require-security-and-request + modelPropertyCasing: camel moduleFormat: commonjs outputModelSuffix: output packageName: '@documenso/sdk-typescript' responseFormat: flat + sseFlatResponse: false templateVersion: v2 usageSDKInitImports: [] useIndexModules: true diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index f66fa465..6308d91c 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.606.10 +speakeasyVersion: 1.637.3 sources: Documenso v2 beta API: sourceNamespace: documenso-v-2-beta-api - sourceRevisionDigest: sha256:442d296d692d7ffe641ab405c4bc6a569b8fe538a6718f3d12331a4be92e51e6 - sourceBlobDigest: sha256:4211e6fd5beb2648e5d85775f81ffd7cb5f213d21f156295156e01a40e61340a + sourceRevisionDigest: sha256:5655c327963c859a6b2690d2f07ff5a14c557dae975710c55e1e94a3a8ca03c5 + sourceBlobDigest: sha256:628fee4fefdec824deaa24deaf158a9f7e61fea8a997f4e39e47dca425903deb tags: - latest - - speakeasy-sdk-regen-1752107119 + - speakeasy-sdk-regen-1761011807 - 0.0.0 targets: documenso: source: Documenso v2 beta API sourceNamespace: documenso-v-2-beta-api - sourceRevisionDigest: sha256:442d296d692d7ffe641ab405c4bc6a569b8fe538a6718f3d12331a4be92e51e6 - sourceBlobDigest: sha256:4211e6fd5beb2648e5d85775f81ffd7cb5f213d21f156295156e01a40e61340a + sourceRevisionDigest: sha256:5655c327963c859a6b2690d2f07ff5a14c557dae975710c55e1e94a3a8ca03c5 + sourceBlobDigest: sha256:628fee4fefdec824deaa24deaf158a9f7e61fea8a997f4e39e47dca425903deb codeSamplesNamespace: documenso-v-2-beta-api-typescript-code-samples - codeSamplesRevisionDigest: sha256:16b65d25065a50ebfeefc2cb72c565a726698d9385afa8b9fe281067747a3b58 + codeSamplesRevisionDigest: sha256:37b05993bb40943f140a099b917322a9f24e727e5a3c86f6caa5551e4cb41b68 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 256c84f8..11de532c 100644 --- a/README.md +++ b/README.md @@ -74,10 +74,7 @@ bun add @documenso/sdk-typescript ### Yarn ```bash -yarn add @documenso/sdk-typescript zod - -# Note that Yarn does not install peer dependencies automatically. You will need -# to install zod as shown above. +yarn add @documenso/sdk-typescript ``` @@ -296,7 +293,6 @@ main()
Available methods - ### [document](docs/sdks/document/README.md) * [documentDownload](docs/sdks/document/README.md#documentdownload) - Download document (beta) diff --git a/RELEASES.md b/RELEASES.md index d0d6d2fa..6f2b4960 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -58,4 +58,14 @@ Based on: ### Generated - [typescript v0.3.2] . ### Releases -- [NPM v0.3.2] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.3.2 - . \ No newline at end of file +- [NPM v0.3.2] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.3.2 - . + +## 2025-10-21 01:56:28 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.637.3 (2.727.9) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.4.0] . +### Releases +- [NPM v0.4.0] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.4.0 - . \ No newline at end of file diff --git a/RUNTIMES.md b/RUNTIMES.md index db7ea942..27731c3b 100644 --- a/RUNTIMES.md +++ b/RUNTIMES.md @@ -2,9 +2,9 @@ This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features: -* [Web Fetch API][web-fetch] -* [Web Streams API][web-streams] and in particular `ReadableStream` -* [Async iterables][async-iter] using `Symbol.asyncIterator` +- [Web Fetch API][web-fetch] +- [Web Streams API][web-streams] and in particular `ReadableStream` +- [Async iterables][async-iter] using `Symbol.asyncIterator` [web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API [web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API @@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are: The following `tsconfig.json` options are recommended for projects using this SDK in order to get static type support for features like async iterables, -streams and `fetch`-related APIs ([`for await...of`][for-await-of], +streams and `fetch`-related APIs ([`for await...of`][for-await-of], [`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and so on): @@ -38,11 +38,11 @@ so on): { "compilerOptions": { "target": "es2020", // or higher - "lib": ["es2020", "dom", "dom.iterable"], + "lib": ["es2020", "dom", "dom.iterable"] } } ``` While `target` can be set to older ECMAScript versions, it may result in extra, unnecessary compatibility code being generated if you are not targeting old -runtimes. \ No newline at end of file +runtimes. diff --git a/docs/models/operations/customdocumentdatum.md b/docs/models/operations/customdocumentdatum.md new file mode 100644 index 00000000..1e2a5633 --- /dev/null +++ b/docs/models/operations/customdocumentdatum.md @@ -0,0 +1,19 @@ +# CustomDocumentDatum + +## Example Usage + +```typescript +import { CustomDocumentDatum } from "@documenso/sdk-typescript/models/operations"; + +let value: CustomDocumentDatum = { + documentDataId: "", + envelopeItemId: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `documentDataId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/document.md b/docs/models/operations/document.md index 2d32ecc3..fe89e7c3 100644 --- a/docs/models/operations/document.md +++ b/docs/models/operations/document.md @@ -18,43 +18,59 @@ let value: Document = { }, formValues: {}, title: "", - documentDataId: "", createdAt: "1722717346634", updatedAt: "1735630218593", completedAt: "", deletedAt: "", teamId: 4947.13, - templateId: 3493.89, folderId: "", + envelopeId: "", documentData: { type: "BYTES", id: "", data: "", initialData: "", + envelopeItemId: "", + }, + documentMeta: { + signingOrder: "PARALLEL", + distributionMethod: "EMAIL", + id: "", + subject: null, + message: "", + timezone: null, + dateFormat: "", + redirectUrl: "https://scornful-doubter.org/", + typedSignatureEnabled: true, + uploadSignatureEnabled: false, + drawSignatureEnabled: false, + allowDictateNextSigner: false, + language: "", + emailSettings: {}, + emailId: "", + emailReplyTo: "", }, - documentMeta: null, folder: { id: "", name: "", type: "DOCUMENT", visibility: "ADMIN", - userId: 1957.61, - teamId: 1166.69, + userId: 3810.18, + teamId: 9987.45, pinned: false, parentId: "", - createdAt: "1734873840846", - updatedAt: "1735609619846", + createdAt: "1727319290753", + updatedAt: "1735682218085", }, recipients: [ { - role: "APPROVER", + envelopeId: "", + role: "SIGNER", readStatus: "OPENED", signingStatus: "SIGNED", - sendStatus: "SENT", - id: 5867.64, - documentId: 4967.71, - templateId: 3810.18, - email: "Karl_Rice85@hotmail.com", + sendStatus: "NOT_SENT", + id: 9590.12, + email: "Carmen_Keeling70@gmail.com", name: "", token: "", documentDeletedAt: "", @@ -66,7 +82,7 @@ let value: Document = { "TWO_FACTOR_AUTH", ], }, - signingOrder: 1593.27, + signingOrder: 5424.29, rejectionReason: "", }, ], @@ -87,14 +103,15 @@ let value: Document = { | `authOptions` | [operations.DocumentCreateDocumentTemporaryAuthOptions](../../models/operations/documentcreatedocumenttemporaryauthoptions.md) | :heavy_check_mark: | N/A | | `formValues` | Record | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `documentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `completedAt` | *string* | :heavy_check_mark: | N/A | | `deletedAt` | *string* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | +| `documentDataId` | *string* | :heavy_minus_sign: | N/A | | `documentData` | [operations.DocumentCreateDocumentTemporaryDocumentData](../../models/operations/documentcreatedocumenttemporarydocumentdata.md) | :heavy_check_mark: | N/A | | `documentMeta` | [operations.DocumentCreateDocumentTemporaryDocumentMeta](../../models/operations/documentcreatedocumenttemporarydocumentmeta.md) | :heavy_check_mark: | N/A | | `folder` | [operations.DocumentCreateDocumentTemporaryFolder](../../models/operations/documentcreatedocumenttemporaryfolder.md) | :heavy_check_mark: | N/A | diff --git a/docs/models/operations/documentaccessauth.md b/docs/models/operations/documentaccessauth.md index dd392531..d67ec2be 100644 --- a/docs/models/operations/documentaccessauth.md +++ b/docs/models/operations/documentaccessauth.md @@ -13,5 +13,5 @@ let value: DocumentAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporaryaccessauthrequest.md b/docs/models/operations/documentcreatedocumenttemporaryaccessauthrequest.md index d875f6c9..c50402f0 100644 --- a/docs/models/operations/documentcreatedocumenttemporaryaccessauthrequest.md +++ b/docs/models/operations/documentcreatedocumenttemporaryaccessauthrequest.md @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document. ```typescript import { DocumentCreateDocumentTemporaryAccessAuthRequest } from "@documenso/sdk-typescript/models/operations"; -let value: DocumentCreateDocumentTemporaryAccessAuthRequest = "ACCOUNT"; +let value: DocumentCreateDocumentTemporaryAccessAuthRequest = "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporarydateformat.md b/docs/models/operations/documentcreatedocumenttemporarydateformat.md index 01f0fd11..9787a4c5 100644 --- a/docs/models/operations/documentcreatedocumenttemporarydateformat.md +++ b/docs/models/operations/documentcreatedocumenttemporarydateformat.md @@ -7,11 +7,11 @@ The date format to use for date fields and signing the document. ```typescript import { DocumentCreateDocumentTemporaryDateFormat } from "@documenso/sdk-typescript/models/operations"; -let value: DocumentCreateDocumentTemporaryDateFormat = "yyyy-MM-dd HH:mm:ss"; +let value: DocumentCreateDocumentTemporaryDateFormat = "yy-MM-dd HH:mm"; ``` ## Values ```typescript -"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy hh:mm a" | "MM/dd/yyyy hh:mm a" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy hh:mm a" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" +"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy" | "MM/dd/yyyy" | "yy-MM-dd" | "MMMM dd, yyyy" | "EEEE, MMMM dd, yyyy" | "dd/MM/yyyy hh:mm a" | "dd/MM/yyyy HH:mm" | "MM/dd/yyyy hh:mm a" | "MM/dd/yyyy HH:mm" | "dd.MM.yyyy" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yy-MM-dd HH:mm" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "MMMM dd, yyyy HH:mm" | "EEEE, MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy HH:mm" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ``` \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporarydocumentdata.md b/docs/models/operations/documentcreatedocumenttemporarydocumentdata.md index 987fac8f..c2d516c0 100644 --- a/docs/models/operations/documentcreatedocumenttemporarydocumentdata.md +++ b/docs/models/operations/documentcreatedocumenttemporarydocumentdata.md @@ -10,6 +10,7 @@ let value: DocumentCreateDocumentTemporaryDocumentData = { id: "", data: "", initialData: "", + envelopeItemId: "", }; ``` @@ -20,4 +21,5 @@ let value: DocumentCreateDocumentTemporaryDocumentData = { | `type` | [operations.DocumentDocumentDataType](../../models/operations/documentdocumentdatatype.md) | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `data` | *string* | :heavy_check_mark: | N/A | -| `initialData` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `initialData` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporarydocumentmeta.md b/docs/models/operations/documentcreatedocumenttemporarydocumentmeta.md index 7b4456bc..94c2ad26 100644 --- a/docs/models/operations/documentcreatedocumenttemporarydocumentmeta.md +++ b/docs/models/operations/documentcreatedocumenttemporarydocumentmeta.md @@ -12,14 +12,12 @@ let value: DocumentCreateDocumentTemporaryDocumentMeta = { subject: "", message: "", timezone: null, - password: "I8VTgcjCf6_DabT", dateFormat: "", - documentId: 9694.59, - redirectUrl: "https://wide-eyed-thyme.name/", + redirectUrl: "https://exotic-meander.name/", typedSignatureEnabled: false, uploadSignatureEnabled: false, - drawSignatureEnabled: true, - allowDictateNextSigner: false, + drawSignatureEnabled: false, + allowDictateNextSigner: true, language: "", emailSettings: {}, emailId: "", @@ -37,9 +35,7 @@ let value: DocumentCreateDocumentTemporaryDocumentMeta = { | `subject` | *string* | :heavy_check_mark: | N/A | | `message` | *string* | :heavy_check_mark: | N/A | | `timezone` | *string* | :heavy_check_mark: | N/A | -| `password` | *string* | :heavy_check_mark: | N/A | | `dateFormat` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | | `redirectUrl` | *string* | :heavy_check_mark: | N/A | | `typedSignatureEnabled` | *boolean* | :heavy_check_mark: | N/A | | `uploadSignatureEnabled` | *boolean* | :heavy_check_mark: | N/A | @@ -48,4 +44,6 @@ let value: DocumentCreateDocumentTemporaryDocumentMeta = { | `language` | *string* | :heavy_check_mark: | N/A | | `emailSettings` | [operations.DocumentEmailSettings](../../models/operations/documentemailsettings.md) | :heavy_check_mark: | N/A | | `emailId` | *string* | :heavy_check_mark: | N/A | -| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | +| `password` | *string* | :heavy_minus_sign: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporaryglobalaccessauthrequest.md b/docs/models/operations/documentcreatedocumenttemporaryglobalaccessauthrequest.md index b54611a1..eeda0b14 100644 --- a/docs/models/operations/documentcreatedocumenttemporaryglobalaccessauthrequest.md +++ b/docs/models/operations/documentcreatedocumenttemporaryglobalaccessauthrequest.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { DocumentCreateDocumentTemporaryGlobalAccessAuthRequest } from "@documenso/sdk-typescript/models/operations"; -let value: DocumentCreateDocumentTemporaryGlobalAccessAuthRequest = "ACCOUNT"; +let value: DocumentCreateDocumentTemporaryGlobalAccessAuthRequest = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporarymeta.md b/docs/models/operations/documentcreatedocumenttemporarymeta.md index 3286f58b..af268d09 100644 --- a/docs/models/operations/documentcreatedocumenttemporarymeta.md +++ b/docs/models/operations/documentcreatedocumenttemporarymeta.md @@ -18,9 +18,12 @@ let value: DocumentCreateDocumentTemporaryMeta = {}; | `dateFormat` | [operations.DocumentCreateDocumentTemporaryDateFormat](../../models/operations/documentcreatedocumenttemporarydateformat.md) | :heavy_minus_sign: | The date format to use for date fields and signing the document. | | `distributionMethod` | [operations.DocumentCreateDocumentTemporaryDistributionMethodRequest](../../models/operations/documentcreatedocumenttemporarydistributionmethodrequest.md) | :heavy_minus_sign: | The distribution method to use when sending the document to the recipients. | | `signingOrder` | [operations.DocumentCreateDocumentTemporarySigningOrderRequest](../../models/operations/documentcreatedocumenttemporarysigningorderrequest.md) | :heavy_minus_sign: | N/A | +| `allowDictateNextSigner` | *boolean* | :heavy_minus_sign: | N/A | | `redirectUrl` | *string* | :heavy_minus_sign: | The URL to which the recipient should be redirected after signing the document. | | `language` | [operations.DocumentCreateDocumentTemporaryLanguage](../../models/operations/documentcreatedocumenttemporarylanguage.md) | :heavy_minus_sign: | The language to use for email communications with recipients. | | `typedSignatureEnabled` | *boolean* | :heavy_minus_sign: | Whether to allow recipients to sign using a typed signature. | -| `drawSignatureEnabled` | *boolean* | :heavy_minus_sign: | Whether to allow recipients to sign using a draw signature. | | `uploadSignatureEnabled` | *boolean* | :heavy_minus_sign: | Whether to allow recipients to sign using an uploaded signature. | +| `drawSignatureEnabled` | *boolean* | :heavy_minus_sign: | Whether to allow recipients to sign using a draw signature. | +| `emailId` | *string* | :heavy_minus_sign: | N/A | +| `emailReplyTo` | *string* | :heavy_minus_sign: | N/A | | `emailSettings` | [operations.DocumentCreateDocumentTemporaryEmailSettingsRequest](../../models/operations/documentcreatedocumenttemporaryemailsettingsrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporaryresponse.md b/docs/models/operations/documentcreatedocumenttemporaryresponse.md index f0b7f011..57615767 100644 --- a/docs/models/operations/documentcreatedocumenttemporaryresponse.md +++ b/docs/models/operations/documentcreatedocumenttemporaryresponse.md @@ -23,35 +23,33 @@ let value: DocumentCreateDocumentTemporaryResponse = { "key": "", }, title: "", - documentDataId: "", createdAt: "1710221001590", updatedAt: "1735684112912", completedAt: "", deletedAt: "", teamId: 1389.58, - templateId: 2750.13, folderId: "", + envelopeId: "", documentData: { type: "BYTES", id: "", data: "", initialData: "", + envelopeItemId: "", }, documentMeta: { - signingOrder: "SEQUENTIAL", - distributionMethod: "NONE", + signingOrder: "PARALLEL", + distributionMethod: "EMAIL", id: "", - subject: "", + subject: null, message: "", - timezone: "America/Grand_Turk", - password: "Wd1ipeD8AVnAjX5", + timezone: null, dateFormat: "", - documentId: 1848.73, - redirectUrl: "https://clear-cut-patroller.org", - typedSignatureEnabled: false, - uploadSignatureEnabled: true, + redirectUrl: "https://scornful-doubter.org/", + typedSignatureEnabled: true, + uploadSignatureEnabled: false, drawSignatureEnabled: false, - allowDictateNextSigner: true, + allowDictateNextSigner: false, language: "", emailSettings: {}, emailId: "", @@ -62,17 +60,17 @@ let value: DocumentCreateDocumentTemporaryResponse = { name: "", type: "DOCUMENT", visibility: "ADMIN", - userId: 1957.61, - teamId: 1166.69, + userId: 3810.18, + teamId: 9987.45, pinned: false, parentId: "", - createdAt: "1734873840846", - updatedAt: "1735609619846", + createdAt: "1727319290753", + updatedAt: "1735682218085", }, recipients: [], fields: [], }, - uploadUrl: "https://judicious-poetry.name", + uploadUrl: "https://reasonable-receptor.info", }; ``` diff --git a/docs/models/operations/documentdistributedateformat.md b/docs/models/operations/documentdistributedateformat.md index 4faef533..30cd23d7 100644 --- a/docs/models/operations/documentdistributedateformat.md +++ b/docs/models/operations/documentdistributedateformat.md @@ -7,11 +7,11 @@ The date format to use for date fields and signing the document. ```typescript import { DocumentDistributeDateFormat } from "@documenso/sdk-typescript/models/operations"; -let value: DocumentDistributeDateFormat = "yyyy-MM-dd"; +let value: DocumentDistributeDateFormat = "dd/MM/yyyy"; ``` ## Values ```typescript -"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy hh:mm a" | "MM/dd/yyyy hh:mm a" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy hh:mm a" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" +"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy" | "MM/dd/yyyy" | "yy-MM-dd" | "MMMM dd, yyyy" | "EEEE, MMMM dd, yyyy" | "dd/MM/yyyy hh:mm a" | "dd/MM/yyyy HH:mm" | "MM/dd/yyyy hh:mm a" | "MM/dd/yyyy HH:mm" | "dd.MM.yyyy" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yy-MM-dd HH:mm" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "MMMM dd, yyyy HH:mm" | "EEEE, MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy HH:mm" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ``` \ No newline at end of file diff --git a/docs/models/operations/documentdistributeglobalaccessauth.md b/docs/models/operations/documentdistributeglobalaccessauth.md index cb7a1343..7819e754 100644 --- a/docs/models/operations/documentdistributeglobalaccessauth.md +++ b/docs/models/operations/documentdistributeglobalaccessauth.md @@ -13,5 +13,5 @@ let value: DocumentDistributeGlobalAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentdistributeresponse.md b/docs/models/operations/documentdistributeresponse.md index 10064d4d..55ef7682 100644 --- a/docs/models/operations/documentdistributeresponse.md +++ b/docs/models/operations/documentdistributeresponse.md @@ -24,15 +24,14 @@ let value: DocumentDistributeResponse = { "key": 6982.35, }, title: "", - documentDataId: "", createdAt: "1704272449510", updatedAt: "1735611513690", completedAt: "", deletedAt: "", teamId: 4166.81, - templateId: 4763.09, folderId: "", useLegacyFieldInsertion: true, + envelopeId: "", }; ``` @@ -49,12 +48,13 @@ let value: DocumentDistributeResponse = { | `authOptions` | [operations.DocumentDistributeAuthOptions](../../models/operations/documentdistributeauthoptions.md) | :heavy_check_mark: | N/A | | `formValues` | Record | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `documentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `completedAt` | *string* | :heavy_check_mark: | N/A | | `deletedAt` | *string* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | -| `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `documentDataId` | *string* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | \ No newline at end of file diff --git a/docs/models/operations/documentduplicateresponse.md b/docs/models/operations/documentduplicateresponse.md index c574debb..57f049a6 100644 --- a/docs/models/operations/documentduplicateresponse.md +++ b/docs/models/operations/documentduplicateresponse.md @@ -8,12 +8,14 @@ Successful response import { DocumentDuplicateResponse } from "@documenso/sdk-typescript/models/operations"; let value: DocumentDuplicateResponse = { + id: "", documentId: 9719.34, }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `documentId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------- | ---------------------- | ---------------------- | ---------------------- | +| `id` | *string* | :heavy_check_mark: | The envelope ID | +| `documentId` | *number* | :heavy_check_mark: | The legacy document ID | \ No newline at end of file diff --git a/docs/models/operations/documentfield.md b/docs/models/operations/documentfield.md index 317a8e32..b2864196 100644 --- a/docs/models/operations/documentfield.md +++ b/docs/models/operations/documentfield.md @@ -6,18 +6,16 @@ import { DocumentField } from "@documenso/sdk-typescript/models/operations"; let value: DocumentField = { + envelopeId: "", + envelopeItemId: "", type: "EMAIL", id: 6761.94, secondaryId: "", - documentId: 3142.11, - templateId: 179.72, - recipientId: 123.33, - page: 2591.61, + recipientId: 2069.76, + page: 3142.11, customText: "", inserted: false, - fieldMeta: { - type: "text", - }, + fieldMeta: null, }; ``` @@ -25,11 +23,11 @@ let value: DocumentField = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.DocumentFieldType](../../models/operations/documentfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +36,6 @@ let value: DocumentField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.DocumentFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.DocumentFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentfindaccessauth.md b/docs/models/operations/documentfindaccessauth.md index cd6a95e3..85a2e84c 100644 --- a/docs/models/operations/documentfindaccessauth.md +++ b/docs/models/operations/documentfindaccessauth.md @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document. ```typescript import { DocumentFindAccessAuth } from "@documenso/sdk-typescript/models/operations"; -let value: DocumentFindAccessAuth = "ACCOUNT"; +let value: DocumentFindAccessAuth = "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentfinddata.md b/docs/models/operations/documentfinddata.md index c5900104..be138228 100644 --- a/docs/models/operations/documentfinddata.md +++ b/docs/models/operations/documentfinddata.md @@ -18,26 +18,46 @@ let value: DocumentFindData = { ], globalActionAuth: [], }, - formValues: null, + formValues: {}, title: "", - documentDataId: "", - createdAt: "1707865978611", - updatedAt: "1735616330381", + createdAt: "1728001866847", + updatedAt: "1735618616447", completedAt: "", - deletedAt: "", - teamId: 1387.13, - templateId: null, + deletedAt: null, + teamId: 4867.45, folderId: "", useLegacyFieldInsertion: true, + envelopeId: "", user: { - id: 4875.96, + id: 4968.94, name: "", - email: "Jessica33@yahoo.com", + email: "Jabari.Gleichner99@yahoo.com", }, - recipients: [], + recipients: [ + { + envelopeId: "", + role: "CC", + readStatus: "OPENED", + signingStatus: "NOT_SIGNED", + sendStatus: "NOT_SENT", + id: 2972.6, + email: "Sabryna98@gmail.com", + name: "", + token: "", + documentDeletedAt: "", + expired: null, + signedAt: null, + authOptions: { + accessAuth: [], + actionAuth: [], + }, + signingOrder: 839.49, + rejectionReason: "", + }, + ], team: { - id: 721.66, - url: "https://enraged-advancement.biz", + id: 5369.77, + url: "https://blank-fold.net", }, }; ``` @@ -55,15 +75,16 @@ let value: DocumentFindData = { | `authOptions` | [operations.DocumentFindAuthOptions](../../models/operations/documentfindauthoptions.md) | :heavy_check_mark: | N/A | | `formValues` | Record | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `documentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `completedAt` | *string* | :heavy_check_mark: | N/A | | `deletedAt` | *string* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | | `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `documentDataId` | *string* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | | `user` | [operations.DocumentFindUser](../../models/operations/documentfinduser.md) | :heavy_check_mark: | N/A | | `recipients` | [operations.DocumentFindRecipient](../../models/operations/documentfindrecipient.md)[] | :heavy_check_mark: | N/A | | `team` | [operations.DocumentFindTeam](../../models/operations/documentfindteam.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentfindglobalaccessauth.md b/docs/models/operations/documentfindglobalaccessauth.md index 5fcc9ccd..84acaa98 100644 --- a/docs/models/operations/documentfindglobalaccessauth.md +++ b/docs/models/operations/documentfindglobalaccessauth.md @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document. ```typescript import { DocumentFindGlobalAccessAuth } from "@documenso/sdk-typescript/models/operations"; -let value: DocumentFindGlobalAccessAuth = "ACCOUNT"; +let value: DocumentFindGlobalAccessAuth = "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentfindrecipient.md b/docs/models/operations/documentfindrecipient.md index a19782e0..3d743ad3 100644 --- a/docs/models/operations/documentfindrecipient.md +++ b/docs/models/operations/documentfindrecipient.md @@ -6,28 +6,23 @@ import { DocumentFindRecipient } from "@documenso/sdk-typescript/models/operations"; let value: DocumentFindRecipient = { + envelopeId: "", role: "VIEWER", readStatus: "OPENED", signingStatus: "SIGNED", sendStatus: "NOT_SENT", id: 7314.5, - documentId: 7294.15, - templateId: null, - email: "Hassan28@gmail.com", + email: "Monte88@yahoo.com", name: "", token: "", documentDeletedAt: "", expired: "", - signedAt: null, + signedAt: "", authOptions: { - accessAuth: [ - "ACCOUNT", - ], - actionAuth: [ - "PASSKEY", - ], + accessAuth: [], + actionAuth: [], }, - signingOrder: 538.83, + signingOrder: 5139.37, rejectionReason: "", }; ``` @@ -36,13 +31,12 @@ let value: DocumentFindRecipient = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.DocumentFindRole](../../models/operations/documentfindrole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.DocumentFindReadStatus](../../models/operations/documentfindreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.DocumentFindSigningStatus](../../models/operations/documentfindsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.DocumentFindSendStatus](../../models/operations/documentfindsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -51,4 +45,6 @@ let value: DocumentFindRecipient = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.DocumentFindRecipientAuthOptions](../../models/operations/documentfindrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentfindresponse.md b/docs/models/operations/documentfindresponse.md index d1b100c6..4d416a3d 100644 --- a/docs/models/operations/documentfindresponse.md +++ b/docs/models/operations/documentfindresponse.md @@ -24,31 +24,48 @@ let value: DocumentFindResponse = { }, formValues: {}, title: "", - documentDataId: "", createdAt: "1705204726944", updatedAt: "1735656163417", completedAt: "", deletedAt: null, teamId: 9234.15, - templateId: 8660.44, folderId: "", - useLegacyFieldInsertion: true, + useLegacyFieldInsertion: false, + envelopeId: "", user: { - id: 4875.96, + id: 4968.94, name: "", - email: "Jessica33@yahoo.com", - }, - recipients: [], - team: { - id: 721.66, - url: "https://enraged-advancement.biz", + email: "Jabari.Gleichner99@yahoo.com", }, + recipients: [ + { + envelopeId: "", + role: "CC", + readStatus: "OPENED", + signingStatus: "NOT_SIGNED", + sendStatus: "NOT_SENT", + id: 2972.6, + email: "Sabryna98@gmail.com", + name: "", + token: "", + documentDeletedAt: "", + expired: null, + signedAt: null, + authOptions: { + accessAuth: [], + actionAuth: [], + }, + signingOrder: 839.49, + rejectionReason: "", + }, + ], + team: null, }, ], - count: 1717.5, - currentPage: 5717.91, - perPage: 4907.67, - totalPages: 9207.47, + count: 3857.43, + currentPage: 1846.05, + perPage: 1717.5, + totalPages: 5717.91, }; ``` diff --git a/docs/models/operations/documentgetaccessauth.md b/docs/models/operations/documentgetaccessauth.md index 94213200..114fd708 100644 --- a/docs/models/operations/documentgetaccessauth.md +++ b/docs/models/operations/documentgetaccessauth.md @@ -13,5 +13,5 @@ let value: DocumentGetAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentgetdocumentdata.md b/docs/models/operations/documentgetdocumentdata.md index 86723454..deb65cfc 100644 --- a/docs/models/operations/documentgetdocumentdata.md +++ b/docs/models/operations/documentgetdocumentdata.md @@ -10,6 +10,7 @@ let value: DocumentGetDocumentData = { id: "", data: "", initialData: "", + envelopeItemId: "", }; ``` @@ -20,4 +21,5 @@ let value: DocumentGetDocumentData = { | `type` | [operations.DocumentGetDocumentDataType](../../models/operations/documentgetdocumentdatatype.md) | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `data` | *string* | :heavy_check_mark: | N/A | -| `initialData` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `initialData` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentgetdocumentmeta.md b/docs/models/operations/documentgetdocumentmeta.md index 87392ab1..bf675c74 100644 --- a/docs/models/operations/documentgetdocumentmeta.md +++ b/docs/models/operations/documentgetdocumentmeta.md @@ -12,14 +12,12 @@ let value: DocumentGetDocumentMeta = { subject: "", message: "", timezone: "Asia/Kabul", - password: "Arf0eB1hteyfkko", dateFormat: "", - documentId: 3525.39, - redirectUrl: "https://rich-trick.biz/", + redirectUrl: "https://tinted-eyeliner.net/", typedSignatureEnabled: true, - uploadSignatureEnabled: true, + uploadSignatureEnabled: false, drawSignatureEnabled: true, - allowDictateNextSigner: false, + allowDictateNextSigner: true, language: "", emailSettings: {}, emailId: "", @@ -37,9 +35,7 @@ let value: DocumentGetDocumentMeta = { | `subject` | *string* | :heavy_check_mark: | N/A | | `message` | *string* | :heavy_check_mark: | N/A | | `timezone` | *string* | :heavy_check_mark: | N/A | -| `password` | *string* | :heavy_check_mark: | N/A | | `dateFormat` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | | `redirectUrl` | *string* | :heavy_check_mark: | N/A | | `typedSignatureEnabled` | *boolean* | :heavy_check_mark: | N/A | | `uploadSignatureEnabled` | *boolean* | :heavy_check_mark: | N/A | @@ -48,4 +44,6 @@ let value: DocumentGetDocumentMeta = { | `language` | *string* | :heavy_check_mark: | N/A | | `emailSettings` | [operations.DocumentGetEmailSettings](../../models/operations/documentgetemailsettings.md) | :heavy_check_mark: | N/A | | `emailId` | *string* | :heavy_check_mark: | N/A | -| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | +| `password` | *string* | :heavy_minus_sign: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentgetfield.md b/docs/models/operations/documentgetfield.md index 68a5d37b..bf87a119 100644 --- a/docs/models/operations/documentgetfield.md +++ b/docs/models/operations/documentgetfield.md @@ -6,15 +6,15 @@ import { DocumentGetField } from "@documenso/sdk-typescript/models/operations"; let value: DocumentGetField = { + envelopeId: "", + envelopeItemId: "", type: "NAME", id: 360.06, secondaryId: "", - documentId: null, - templateId: 8098.07, - recipientId: 4974.55, - page: 7914.94, + recipientId: 472.22, + page: 3997.02, customText: "", - inserted: true, + inserted: false, fieldMeta: { type: "checkbox", direction: "vertical", @@ -26,11 +26,11 @@ let value: DocumentGetField = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.DocumentGetFieldType](../../models/operations/documentgetfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -39,4 +39,6 @@ let value: DocumentGetField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.DocumentGetFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.DocumentGetFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentgetglobalaccessauth.md b/docs/models/operations/documentgetglobalaccessauth.md index 8cecfee9..42203275 100644 --- a/docs/models/operations/documentgetglobalaccessauth.md +++ b/docs/models/operations/documentgetglobalaccessauth.md @@ -13,5 +13,5 @@ let value: DocumentGetGlobalAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentgetrecipient.md b/docs/models/operations/documentgetrecipient.md index 5654c2eb..02ab46f9 100644 --- a/docs/models/operations/documentgetrecipient.md +++ b/docs/models/operations/documentgetrecipient.md @@ -6,28 +6,25 @@ import { DocumentGetRecipient } from "@documenso/sdk-typescript/models/operations"; let value: DocumentGetRecipient = { + envelopeId: "", role: "APPROVER", readStatus: "OPENED", signingStatus: "REJECTED", sendStatus: "NOT_SENT", id: 1962.21, - documentId: 9105.73, - templateId: 9490.38, - email: "Newton_Larkin@yahoo.com", + email: "Talon_White@hotmail.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", authOptions: { - accessAuth: [ - "ACCOUNT", - ], + accessAuth: [], actionAuth: [ - "EXPLICIT_NONE", + "PASSWORD", ], }, - signingOrder: 5254.4, + signingOrder: 5931.41, rejectionReason: "", }; ``` @@ -36,13 +33,12 @@ let value: DocumentGetRecipient = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.DocumentGetRole](../../models/operations/documentgetrole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.DocumentGetReadStatus](../../models/operations/documentgetreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.DocumentGetSigningStatus](../../models/operations/documentgetsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.DocumentGetSendStatus](../../models/operations/documentgetsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -51,4 +47,6 @@ let value: DocumentGetRecipient = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.DocumentGetRecipientAuthOptions](../../models/operations/documentgetrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentgetresponse.md b/docs/models/operations/documentgetresponse.md index 38f1a3dd..563f0ac9 100644 --- a/docs/models/operations/documentgetresponse.md +++ b/docs/models/operations/documentgetresponse.md @@ -22,54 +22,90 @@ let value: DocumentGetResponse = { }, formValues: {}, title: "", - documentDataId: "", createdAt: "1713009204049", updatedAt: "1735633248980", completedAt: "", deletedAt: "", teamId: 9528.55, - templateId: null, - folderId: "", + folderId: null, + envelopeId: "", documentData: { - type: "S3_PATH", + type: "BYTES_64", id: "", data: "", initialData: "", + envelopeItemId: "", }, documentMeta: { - signingOrder: "SEQUENTIAL", - distributionMethod: "EMAIL", + signingOrder: "PARALLEL", + distributionMethod: "NONE", id: "", subject: "", message: "", - timezone: "Asia/Novokuznetsk", - password: "IeIRJCC4GL2UVi5", + timezone: "America/Detroit", dateFormat: "", - documentId: 8359.84, - redirectUrl: "https://fuzzy-individual.net", + redirectUrl: "https://breakable-hose.net/", typedSignatureEnabled: true, uploadSignatureEnabled: true, drawSignatureEnabled: true, - allowDictateNextSigner: false, + allowDictateNextSigner: true, language: "", - emailSettings: {}, + emailSettings: null, emailId: "", emailReplyTo: "", }, folder: { id: "", name: "", - type: "TEMPLATE", + type: "DOCUMENT", visibility: "MANAGER_AND_ABOVE", - userId: 6907.24, - teamId: 3554.34, + userId: 2056.58, + teamId: 4008.9, pinned: true, - parentId: "", - createdAt: "1732423256945", - updatedAt: "1735668877318", + parentId: null, + createdAt: "1709913177849", + updatedAt: "1735650994084", }, - recipients: [], - fields: [], + recipients: [ + { + envelopeId: "", + role: "APPROVER", + readStatus: "NOT_OPENED", + signingStatus: "SIGNED", + sendStatus: "SENT", + id: 4660.31, + email: "Elsa.Rosenbaum49@hotmail.com", + name: "", + token: "", + documentDeletedAt: "", + expired: "", + signedAt: "", + authOptions: { + accessAuth: [], + actionAuth: [ + "PASSWORD", + ], + }, + signingOrder: 9488.58, + rejectionReason: "", + }, + ], + fields: [ + { + envelopeId: "", + envelopeItemId: "", + type: "NAME", + id: 2613.19, + secondaryId: "", + recipientId: 2768.96, + page: 8964.25, + customText: "", + inserted: false, + fieldMeta: { + type: "name", + }, + }, + ], }; ``` @@ -86,14 +122,15 @@ let value: DocumentGetResponse = { | `authOptions` | [operations.DocumentGetAuthOptions](../../models/operations/documentgetauthoptions.md) | :heavy_check_mark: | N/A | | `formValues` | Record | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `documentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `completedAt` | *string* | :heavy_check_mark: | N/A | | `deletedAt` | *string* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | +| `documentDataId` | *string* | :heavy_minus_sign: | N/A | | `documentData` | [operations.DocumentGetDocumentData](../../models/operations/documentgetdocumentdata.md) | :heavy_check_mark: | N/A | | `documentMeta` | [operations.DocumentGetDocumentMeta](../../models/operations/documentgetdocumentmeta.md) | :heavy_check_mark: | N/A | | `folder` | [operations.DocumentGetFolder](../../models/operations/documentgetfolder.md) | :heavy_check_mark: | N/A | diff --git a/docs/models/operations/documentglobalaccessauth.md b/docs/models/operations/documentglobalaccessauth.md index fdc609d2..b6251ef7 100644 --- a/docs/models/operations/documentglobalaccessauth.md +++ b/docs/models/operations/documentglobalaccessauth.md @@ -13,5 +13,5 @@ let value: DocumentGlobalAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentrecipient.md b/docs/models/operations/documentrecipient.md index 67693350..331465aa 100644 --- a/docs/models/operations/documentrecipient.md +++ b/docs/models/operations/documentrecipient.md @@ -6,14 +6,13 @@ import { DocumentRecipient } from "@documenso/sdk-typescript/models/operations"; let value: DocumentRecipient = { + envelopeId: "", role: "APPROVER", readStatus: "OPENED", signingStatus: "SIGNED", sendStatus: "SENT", id: 6319.31, - documentId: 5259.55, - templateId: 6868.91, - email: "Ciara70@yahoo.com", + email: "Julian18@gmail.com", name: "", token: "", documentDeletedAt: "", @@ -25,7 +24,7 @@ let value: DocumentRecipient = { "TWO_FACTOR_AUTH", ], }, - signingOrder: 2816.42, + signingOrder: 827.39, rejectionReason: "", }; ``` @@ -34,13 +33,12 @@ let value: DocumentRecipient = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.DocumentRole](../../models/operations/documentrole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.DocumentCreateDocumentTemporaryReadStatus](../../models/operations/documentcreatedocumenttemporaryreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.DocumentCreateDocumentTemporarySigningStatus](../../models/operations/documentcreatedocumenttemporarysigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.DocumentCreateDocumentTemporarySendStatus](../../models/operations/documentcreatedocumenttemporarysendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -49,4 +47,6 @@ let value: DocumentRecipient = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.DocumentCreateDocumentTemporaryRecipientAuthOptions](../../models/operations/documentcreatedocumenttemporaryrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentupdateauthoptions.md b/docs/models/operations/documentupdateauthoptions.md index b7424828..b10da5d4 100644 --- a/docs/models/operations/documentupdateauthoptions.md +++ b/docs/models/operations/documentupdateauthoptions.md @@ -7,7 +7,7 @@ import { DocumentUpdateAuthOptions } from "@documenso/sdk-typescript/models/oper let value: DocumentUpdateAuthOptions = { globalAccessAuth: [ - "ACCOUNT", + "TWO_FACTOR_AUTH", ], globalActionAuth: [ "PASSWORD", diff --git a/docs/models/operations/documentupdatedata.md b/docs/models/operations/documentupdatedata.md index e77c7206..6e129000 100644 --- a/docs/models/operations/documentupdatedata.md +++ b/docs/models/operations/documentupdatedata.md @@ -17,4 +17,5 @@ let value: DocumentUpdateData = {}; | `visibility` | [operations.DocumentUpdateVisibilityRequest](../../models/operations/documentupdatevisibilityrequest.md) | :heavy_minus_sign: | The visibility of the document. | | `globalAccessAuth` | [operations.DocumentUpdateGlobalAccessAuthRequest](../../models/operations/documentupdateglobalaccessauthrequest.md)[] | :heavy_minus_sign: | N/A | | `globalActionAuth` | [operations.DocumentUpdateGlobalActionAuthRequest](../../models/operations/documentupdateglobalactionauthrequest.md)[] | :heavy_minus_sign: | N/A | -| `useLegacyFieldInsertion` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `useLegacyFieldInsertion` | *boolean* | :heavy_minus_sign: | N/A | +| `folderId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentupdatedateformat.md b/docs/models/operations/documentupdatedateformat.md index 9b259002..0c66956c 100644 --- a/docs/models/operations/documentupdatedateformat.md +++ b/docs/models/operations/documentupdatedateformat.md @@ -7,11 +7,11 @@ The date format to use for date fields and signing the document. ```typescript import { DocumentUpdateDateFormat } from "@documenso/sdk-typescript/models/operations"; -let value: DocumentUpdateDateFormat = "yy-MM-dd hh:mm a"; +let value: DocumentUpdateDateFormat = "yyyy-MM-dd HH:mm"; ``` ## Values ```typescript -"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy hh:mm a" | "MM/dd/yyyy hh:mm a" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy hh:mm a" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" +"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy" | "MM/dd/yyyy" | "yy-MM-dd" | "MMMM dd, yyyy" | "EEEE, MMMM dd, yyyy" | "dd/MM/yyyy hh:mm a" | "dd/MM/yyyy HH:mm" | "MM/dd/yyyy hh:mm a" | "MM/dd/yyyy HH:mm" | "dd.MM.yyyy" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yy-MM-dd HH:mm" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "MMMM dd, yyyy HH:mm" | "EEEE, MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy HH:mm" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ``` \ No newline at end of file diff --git a/docs/models/operations/documentupdateglobalaccessauthrequest.md b/docs/models/operations/documentupdateglobalaccessauthrequest.md index bc8bd63a..b7183615 100644 --- a/docs/models/operations/documentupdateglobalaccessauthrequest.md +++ b/docs/models/operations/documentupdateglobalaccessauthrequest.md @@ -13,5 +13,5 @@ let value: DocumentUpdateGlobalAccessAuthRequest = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentupdateglobalaccessauthresponse.md b/docs/models/operations/documentupdateglobalaccessauthresponse.md index 757fe7e2..686a3e50 100644 --- a/docs/models/operations/documentupdateglobalaccessauthresponse.md +++ b/docs/models/operations/documentupdateglobalaccessauthresponse.md @@ -13,5 +13,5 @@ let value: DocumentUpdateGlobalAccessAuthResponse = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/documentupdateresponse.md b/docs/models/operations/documentupdateresponse.md index 9021dea4..da6f681e 100644 --- a/docs/models/operations/documentupdateresponse.md +++ b/docs/models/operations/documentupdateresponse.md @@ -24,15 +24,14 @@ let value: DocumentUpdateResponse = { "key": true, }, title: "", - documentDataId: "", createdAt: "1727576894467", updatedAt: "1735615198185", completedAt: "", deletedAt: "", teamId: 5403.09, - templateId: null, - folderId: "", - useLegacyFieldInsertion: false, + folderId: null, + useLegacyFieldInsertion: true, + envelopeId: "", }; ``` @@ -49,12 +48,13 @@ let value: DocumentUpdateResponse = { | `authOptions` | [operations.DocumentUpdateAuthOptions](../../models/operations/documentupdateauthoptions.md) | :heavy_check_mark: | N/A | | `formValues` | Record | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `documentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `completedAt` | *string* | :heavy_check_mark: | N/A | | `deletedAt` | *string* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | -| `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `documentDataId` | *string* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | \ No newline at end of file diff --git a/docs/models/operations/fieldcreatedocumentfieldresponse.md b/docs/models/operations/fieldcreatedocumentfieldresponse.md index 914f2d76..6223ad61 100644 --- a/docs/models/operations/fieldcreatedocumentfieldresponse.md +++ b/docs/models/operations/fieldcreatedocumentfieldresponse.md @@ -8,17 +8,17 @@ Successful response import { FieldCreateDocumentFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldCreateDocumentFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "NAME", id: 4449.71, secondaryId: "", - documentId: 5701.48, - templateId: 1924.19, - recipientId: 6020.59, - page: 2815.91, + recipientId: 1726.85, + page: 5701.48, customText: "", - inserted: false, + inserted: true, fieldMeta: { - type: "radio", + type: "number", }, }; ``` @@ -27,11 +27,11 @@ let value: FieldCreateDocumentFieldResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldCreateDocumentFieldTypeResponse](../../models/operations/fieldcreatedocumentfieldtyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -40,4 +40,6 @@ let value: FieldCreateDocumentFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldCreateDocumentFieldFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldCreateDocumentFieldFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldcreatedocumentfieldsfieldresponse.md b/docs/models/operations/fieldcreatedocumentfieldsfieldresponse.md index 663d3594..e2de2174 100644 --- a/docs/models/operations/fieldcreatedocumentfieldsfieldresponse.md +++ b/docs/models/operations/fieldcreatedocumentfieldsfieldresponse.md @@ -6,13 +6,13 @@ import { FieldCreateDocumentFieldsFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldCreateDocumentFieldsFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "RADIO", id: 3256.67, secondaryId: "", - documentId: 145.84, - templateId: 8743.58, - recipientId: 1700.24, - page: 6783.9, + recipientId: 2411.58, + page: 145.84, customText: "", inserted: true, fieldMeta: { @@ -25,11 +25,11 @@ let value: FieldCreateDocumentFieldsFieldResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldCreateDocumentFieldsTypeResponse](../../models/operations/fieldcreatedocumentfieldstyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: FieldCreateDocumentFieldsFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldCreateDocumentFieldsFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldCreateDocumentFieldsFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldcreatetemplatefieldresponse.md b/docs/models/operations/fieldcreatetemplatefieldresponse.md index 53cc7c48..69298394 100644 --- a/docs/models/operations/fieldcreatetemplatefieldresponse.md +++ b/docs/models/operations/fieldcreatetemplatefieldresponse.md @@ -8,16 +8,19 @@ Successful response import { FieldCreateTemplateFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldCreateTemplateFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "CHECKBOX", id: 994.15, secondaryId: "", - documentId: 9901.8, - templateId: 3859.65, - recipientId: 7861.45, - page: 5905.76, + recipientId: 8747.47, + page: 9901.8, customText: "", - inserted: false, - fieldMeta: null, + inserted: true, + fieldMeta: { + type: "checkbox", + direction: "vertical", + }, }; ``` @@ -25,11 +28,11 @@ let value: FieldCreateTemplateFieldResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldCreateTemplateFieldTypeResponse](../../models/operations/fieldcreatetemplatefieldtyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +41,6 @@ let value: FieldCreateTemplateFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldCreateTemplateFieldFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldCreateTemplateFieldFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldcreatetemplatefieldsfieldresponse.md b/docs/models/operations/fieldcreatetemplatefieldsfieldresponse.md index a5f72d5a..cd6a1346 100644 --- a/docs/models/operations/fieldcreatetemplatefieldsfieldresponse.md +++ b/docs/models/operations/fieldcreatetemplatefieldsfieldresponse.md @@ -6,17 +6,17 @@ import { FieldCreateTemplateFieldsFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldCreateTemplateFieldsFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "EMAIL", id: 5388.94, secondaryId: "", - documentId: 6246.65, - templateId: 2063.27, - recipientId: 2864.51, - page: 1505.85, + recipientId: 3420.05, + page: 6246.65, customText: "", inserted: true, fieldMeta: { - type: "radio", + type: "email", }, }; ``` @@ -25,11 +25,11 @@ let value: FieldCreateTemplateFieldsFieldResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldCreateTemplateFieldsTypeResponse](../../models/operations/fieldcreatetemplatefieldstyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: FieldCreateTemplateFieldsFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldCreateTemplateFieldsFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldCreateTemplateFieldsFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldgetdocumentfieldresponse.md b/docs/models/operations/fieldgetdocumentfieldresponse.md index b873f6c8..694341b8 100644 --- a/docs/models/operations/fieldgetdocumentfieldresponse.md +++ b/docs/models/operations/fieldgetdocumentfieldresponse.md @@ -8,17 +8,17 @@ Successful response import { FieldGetDocumentFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldGetDocumentFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "INITIALS", id: 4256.77, secondaryId: "", - documentId: 6822.42, - templateId: 8991.32, - recipientId: 2659.39, - page: 4332.76, + recipientId: 7400.94, + page: 6822.42, customText: "", inserted: false, fieldMeta: { - type: "number", + type: "email", }, }; ``` @@ -27,11 +27,11 @@ let value: FieldGetDocumentFieldResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldGetDocumentFieldType](../../models/operations/fieldgetdocumentfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -40,4 +40,6 @@ let value: FieldGetDocumentFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldGetDocumentFieldFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldGetDocumentFieldFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldgettemplatefieldresponse.md b/docs/models/operations/fieldgettemplatefieldresponse.md index 34b1558a..c324a6c4 100644 --- a/docs/models/operations/fieldgettemplatefieldresponse.md +++ b/docs/models/operations/fieldgettemplatefieldresponse.md @@ -8,17 +8,17 @@ Successful response import { FieldGetTemplateFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldGetTemplateFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "EMAIL", id: 9395.67, secondaryId: "", - documentId: 9753.93, - templateId: 3656.68, - recipientId: 9095.87, - page: 2090.36, + recipientId: 9346.03, + page: 9753.93, customText: "", - inserted: true, + inserted: false, fieldMeta: { - type: "radio", + type: "dropdown", }, }; ``` @@ -27,11 +27,11 @@ let value: FieldGetTemplateFieldResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldGetTemplateFieldType](../../models/operations/fieldgettemplatefieldtype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -40,4 +40,6 @@ let value: FieldGetTemplateFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldGetTemplateFieldFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldGetTemplateFieldFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldupdatedocumentfieldresponse.md b/docs/models/operations/fieldupdatedocumentfieldresponse.md index 2328a929..5a44b14c 100644 --- a/docs/models/operations/fieldupdatedocumentfieldresponse.md +++ b/docs/models/operations/fieldupdatedocumentfieldresponse.md @@ -8,18 +8,16 @@ Successful response import { FieldUpdateDocumentFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldUpdateDocumentFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "INITIALS", id: 4615.62, secondaryId: "", - documentId: 2178.8, - templateId: null, - recipientId: 712.57, - page: 9356.51, + recipientId: 3723.26, + page: 2178.8, customText: "", - inserted: false, - fieldMeta: { - type: "date", - }, + inserted: true, + fieldMeta: null, }; ``` @@ -27,11 +25,11 @@ let value: FieldUpdateDocumentFieldResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldUpdateDocumentFieldTypeResponse](../../models/operations/fieldupdatedocumentfieldtyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -40,4 +38,6 @@ let value: FieldUpdateDocumentFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldUpdateDocumentFieldFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldUpdateDocumentFieldFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldupdatedocumentfieldsfieldresponse.md b/docs/models/operations/fieldupdatedocumentfieldsfieldresponse.md index bcca6075..dc59a852 100644 --- a/docs/models/operations/fieldupdatedocumentfieldsfieldresponse.md +++ b/docs/models/operations/fieldupdatedocumentfieldsfieldresponse.md @@ -6,17 +6,17 @@ import { FieldUpdateDocumentFieldsFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldUpdateDocumentFieldsFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "SIGNATURE", id: 1175.92, secondaryId: "", - documentId: 649.18, - templateId: 6389.86, - recipientId: 3695.14, - page: 1154.05, + recipientId: 1075.03, + page: 649.18, customText: "", inserted: true, fieldMeta: { - type: "text", + type: "date", }, }; ``` @@ -25,11 +25,11 @@ let value: FieldUpdateDocumentFieldsFieldResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldUpdateDocumentFieldsTypeResponse](../../models/operations/fieldupdatedocumentfieldstyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: FieldUpdateDocumentFieldsFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldUpdateDocumentFieldsFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldUpdateDocumentFieldsFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldupdatedocumentfieldsresponse.md b/docs/models/operations/fieldupdatedocumentfieldsresponse.md index f3c04a7b..472ded80 100644 --- a/docs/models/operations/fieldupdatedocumentfieldsresponse.md +++ b/docs/models/operations/fieldupdatedocumentfieldsresponse.md @@ -10,18 +10,16 @@ import { FieldUpdateDocumentFieldsResponse } from "@documenso/sdk-typescript/mod let value: FieldUpdateDocumentFieldsResponse = { fields: [ { + envelopeId: "", + envelopeItemId: "", type: "NAME", id: 6326.22, secondaryId: "", - documentId: 892, - templateId: 608.73, - recipientId: 7078.42, - page: 724.02, + recipientId: 4223.59, + page: 892, customText: "", - inserted: true, - fieldMeta: { - type: "initials", - }, + inserted: false, + fieldMeta: null, }, ], }; diff --git a/docs/models/operations/fieldupdatetemplatefieldresponse.md b/docs/models/operations/fieldupdatetemplatefieldresponse.md index a9381d2a..b30b71ca 100644 --- a/docs/models/operations/fieldupdatetemplatefieldresponse.md +++ b/docs/models/operations/fieldupdatetemplatefieldresponse.md @@ -8,17 +8,17 @@ Successful response import { FieldUpdateTemplateFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldUpdateTemplateFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "DATE", id: 3406.4, secondaryId: "", - documentId: 6934.43, - templateId: 3439.01, - recipientId: 26.74, - page: 6308.89, + recipientId: 5425.03, + page: 6934.43, customText: "", - inserted: true, + inserted: false, fieldMeta: { - type: "radio", + type: "initials", }, }; ``` @@ -27,11 +27,11 @@ let value: FieldUpdateTemplateFieldResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldUpdateTemplateFieldTypeResponse](../../models/operations/fieldupdatetemplatefieldtyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -40,4 +40,6 @@ let value: FieldUpdateTemplateFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldUpdateTemplateFieldFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldUpdateTemplateFieldFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldupdatetemplatefieldsfieldresponse.md b/docs/models/operations/fieldupdatetemplatefieldsfieldresponse.md index 1212e117..8d941b4e 100644 --- a/docs/models/operations/fieldupdatetemplatefieldsfieldresponse.md +++ b/docs/models/operations/fieldupdatetemplatefieldsfieldresponse.md @@ -6,17 +6,18 @@ import { FieldUpdateTemplateFieldsFieldResponse } from "@documenso/sdk-typescript/models/operations"; let value: FieldUpdateTemplateFieldsFieldResponse = { + envelopeId: "", + envelopeItemId: "", type: "TEXT", id: 3097.8, secondaryId: "", - documentId: null, - templateId: 7826.05, - recipientId: 5764.37, - page: 8208.39, + recipientId: 375.86, + page: 4055.95, customText: "", inserted: false, fieldMeta: { - type: "radio", + type: "checkbox", + direction: "vertical", }, }; ``` @@ -25,11 +26,11 @@ let value: FieldUpdateTemplateFieldsFieldResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.FieldUpdateTemplateFieldsTypeResponse](../../models/operations/fieldupdatetemplatefieldstyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +39,6 @@ let value: FieldUpdateTemplateFieldsFieldResponse = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.FieldUpdateTemplateFieldsFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.FieldUpdateTemplateFieldsFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/fieldupdatetemplatefieldsresponse.md b/docs/models/operations/fieldupdatetemplatefieldsresponse.md index 43eded4d..7fed6fcd 100644 --- a/docs/models/operations/fieldupdatetemplatefieldsresponse.md +++ b/docs/models/operations/fieldupdatetemplatefieldsresponse.md @@ -10,17 +10,17 @@ import { FieldUpdateTemplateFieldsResponse } from "@documenso/sdk-typescript/mod let value: FieldUpdateTemplateFieldsResponse = { fields: [ { + envelopeId: "", + envelopeItemId: "", type: "FREE_SIGNATURE", id: 6817.07, secondaryId: "", - documentId: 2673.63, - templateId: 6356.17, - recipientId: 2551.5, - page: 107.6, + recipientId: 1094.84, + page: 2673.63, customText: "", inserted: false, fieldMeta: { - type: "date", + type: "email", }, }, ], diff --git a/docs/models/operations/recipientcreatedocumentrecipientaccessauthrequest.md b/docs/models/operations/recipientcreatedocumentrecipientaccessauthrequest.md index 8f4c07b4..2dd625b2 100644 --- a/docs/models/operations/recipientcreatedocumentrecipientaccessauthrequest.md +++ b/docs/models/operations/recipientcreatedocumentrecipientaccessauthrequest.md @@ -13,5 +13,5 @@ let value: RecipientCreateDocumentRecipientAccessAuthRequest = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientcreatedocumentrecipientaccessauthresponse.md b/docs/models/operations/recipientcreatedocumentrecipientaccessauthresponse.md index 2605349e..f523166f 100644 --- a/docs/models/operations/recipientcreatedocumentrecipientaccessauthresponse.md +++ b/docs/models/operations/recipientcreatedocumentrecipientaccessauthresponse.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { RecipientCreateDocumentRecipientAccessAuthResponse } from "@documenso/sdk-typescript/models/operations"; -let value: RecipientCreateDocumentRecipientAccessAuthResponse = "ACCOUNT"; +let value: RecipientCreateDocumentRecipientAccessAuthResponse = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientcreatedocumentrecipientresponse.md b/docs/models/operations/recipientcreatedocumentrecipientresponse.md index 535a5b10..5471a1b0 100644 --- a/docs/models/operations/recipientcreatedocumentrecipientresponse.md +++ b/docs/models/operations/recipientcreatedocumentrecipientresponse.md @@ -8,28 +8,23 @@ Successful response import { RecipientCreateDocumentRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientCreateDocumentRecipientResponse = { + envelopeId: "", role: "APPROVER", readStatus: "NOT_OPENED", signingStatus: "NOT_SIGNED", sendStatus: "NOT_SENT", id: 8655.25, - documentId: 8731.13, - templateId: 6183.83, - email: "Estelle_Padberg10@gmail.com", + email: "Scarlett.Mosciski@hotmail.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", authOptions: { - accessAuth: [ - "ACCOUNT", - ], - actionAuth: [ - "PASSKEY", - ], + accessAuth: [], + actionAuth: [], }, - signingOrder: 9998.68, + signingOrder: 3417.13, rejectionReason: "", }; ``` @@ -38,13 +33,12 @@ let value: RecipientCreateDocumentRecipientResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientCreateDocumentRecipientRoleResponse](../../models/operations/recipientcreatedocumentrecipientroleresponse.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientCreateDocumentRecipientReadStatus](../../models/operations/recipientcreatedocumentrecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientCreateDocumentRecipientSigningStatus](../../models/operations/recipientcreatedocumentrecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientCreateDocumentRecipientSendStatus](../../models/operations/recipientcreatedocumentrecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -53,4 +47,6 @@ let value: RecipientCreateDocumentRecipientResponse = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.RecipientCreateDocumentRecipientAuthOptions](../../models/operations/recipientcreatedocumentrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientcreatedocumentrecipientsaccessauthrequest.md b/docs/models/operations/recipientcreatedocumentrecipientsaccessauthrequest.md index fe518d5e..6a265a06 100644 --- a/docs/models/operations/recipientcreatedocumentrecipientsaccessauthrequest.md +++ b/docs/models/operations/recipientcreatedocumentrecipientsaccessauthrequest.md @@ -13,5 +13,5 @@ let value: RecipientCreateDocumentRecipientsAccessAuthRequest = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientcreatedocumentrecipientsaccessauthresponse.md b/docs/models/operations/recipientcreatedocumentrecipientsaccessauthresponse.md index 93f63dc9..28608d69 100644 --- a/docs/models/operations/recipientcreatedocumentrecipientsaccessauthresponse.md +++ b/docs/models/operations/recipientcreatedocumentrecipientsaccessauthresponse.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { RecipientCreateDocumentRecipientsAccessAuthResponse } from "@documenso/sdk-typescript/models/operations"; -let value: RecipientCreateDocumentRecipientsAccessAuthResponse = "ACCOUNT"; +let value: RecipientCreateDocumentRecipientsAccessAuthResponse = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientcreatedocumentrecipientsrecipientresponse.md b/docs/models/operations/recipientcreatedocumentrecipientsrecipientresponse.md index ba2030ad..c0b35e9d 100644 --- a/docs/models/operations/recipientcreatedocumentrecipientsrecipientresponse.md +++ b/docs/models/operations/recipientcreatedocumentrecipientsrecipientresponse.md @@ -6,14 +6,13 @@ import { RecipientCreateDocumentRecipientsRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientCreateDocumentRecipientsRecipientResponse = { + envelopeId: "", role: "ASSISTANT", readStatus: "NOT_OPENED", signingStatus: "SIGNED", sendStatus: "SENT", id: 1467.53, - documentId: 1172.97, - templateId: 7126.99, - email: "Vernice_Hirthe-Harvey@gmail.com", + email: "Bianka95@gmail.com", name: "", token: "", documentDeletedAt: "", @@ -23,7 +22,7 @@ let value: RecipientCreateDocumentRecipientsRecipientResponse = { accessAuth: [], actionAuth: [], }, - signingOrder: 7756.01, + signingOrder: 6441.41, rejectionReason: "", }; ``` @@ -32,13 +31,12 @@ let value: RecipientCreateDocumentRecipientsRecipientResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientCreateDocumentRecipientsRoleResponse](../../models/operations/recipientcreatedocumentrecipientsroleresponse.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientCreateDocumentRecipientsReadStatus](../../models/operations/recipientcreatedocumentrecipientsreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientCreateDocumentRecipientsSigningStatus](../../models/operations/recipientcreatedocumentrecipientssigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientCreateDocumentRecipientsSendStatus](../../models/operations/recipientcreatedocumentrecipientssendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -47,4 +45,6 @@ let value: RecipientCreateDocumentRecipientsRecipientResponse = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.RecipientCreateDocumentRecipientsAuthOptions](../../models/operations/recipientcreatedocumentrecipientsauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientcreatedocumentrecipientsresponse.md b/docs/models/operations/recipientcreatedocumentrecipientsresponse.md index 9515d105..03ef0ae2 100644 --- a/docs/models/operations/recipientcreatedocumentrecipientsresponse.md +++ b/docs/models/operations/recipientcreatedocumentrecipientsresponse.md @@ -10,24 +10,23 @@ import { RecipientCreateDocumentRecipientsResponse } from "@documenso/sdk-typesc let value: RecipientCreateDocumentRecipientsResponse = { recipients: [ { + envelopeId: "", role: "SIGNER", readStatus: "OPENED", signingStatus: "SIGNED", sendStatus: "NOT_SENT", id: 3084.15, - documentId: 855.15, - templateId: 4355.39, - email: "Eduardo.Dicki@hotmail.com", + email: "Arvid_Kertzmann@hotmail.com", name: "", token: "", documentDeletedAt: "", - expired: "", + expired: null, signedAt: "", authOptions: { accessAuth: [], actionAuth: [], }, - signingOrder: 6259.51, + signingOrder: 3063.65, rejectionReason: "", }, ], diff --git a/docs/models/operations/recipientcreatetemplaterecipientaccessauthrequest.md b/docs/models/operations/recipientcreatetemplaterecipientaccessauthrequest.md index 0fc8fe5c..5ad38533 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientaccessauthrequest.md +++ b/docs/models/operations/recipientcreatetemplaterecipientaccessauthrequest.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { RecipientCreateTemplateRecipientAccessAuthRequest } from "@documenso/sdk-typescript/models/operations"; -let value: RecipientCreateTemplateRecipientAccessAuthRequest = "ACCOUNT"; +let value: RecipientCreateTemplateRecipientAccessAuthRequest = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientcreatetemplaterecipientaccessauthresponse.md b/docs/models/operations/recipientcreatetemplaterecipientaccessauthresponse.md index 25395b7f..5d922e6e 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientaccessauthresponse.md +++ b/docs/models/operations/recipientcreatetemplaterecipientaccessauthresponse.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { RecipientCreateTemplateRecipientAccessAuthResponse } from "@documenso/sdk-typescript/models/operations"; -let value: RecipientCreateTemplateRecipientAccessAuthResponse = "ACCOUNT"; +let value: RecipientCreateTemplateRecipientAccessAuthResponse = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientcreatetemplaterecipientauthoptions.md b/docs/models/operations/recipientcreatetemplaterecipientauthoptions.md index 96d60e54..e302e7a0 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientauthoptions.md +++ b/docs/models/operations/recipientcreatetemplaterecipientauthoptions.md @@ -9,7 +9,9 @@ let value: RecipientCreateTemplateRecipientAuthOptions = { accessAuth: [ "ACCOUNT", ], - actionAuth: [], + actionAuth: [ + "TWO_FACTOR_AUTH", + ], }; ``` diff --git a/docs/models/operations/recipientcreatetemplaterecipientresponse.md b/docs/models/operations/recipientcreatetemplaterecipientresponse.md index 5884eeed..b1baf3dd 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientresponse.md +++ b/docs/models/operations/recipientcreatetemplaterecipientresponse.md @@ -8,28 +8,23 @@ Successful response import { RecipientCreateTemplateRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientCreateTemplateRecipientResponse = { + envelopeId: "", role: "VIEWER", readStatus: "OPENED", signingStatus: "REJECTED", sendStatus: "NOT_SENT", id: 2950.75, - documentId: 2217.57, - templateId: 4092.37, - email: "Stephon_Pfeffer12@yahoo.com", + email: "Dalton_Jast90@yahoo.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", authOptions: { - accessAuth: [ - "ACCOUNT", - ], - actionAuth: [ - "PASSKEY", - ], + accessAuth: [], + actionAuth: [], }, - signingOrder: 9690.33, + signingOrder: 6693.85, rejectionReason: "", }; ``` @@ -38,13 +33,12 @@ let value: RecipientCreateTemplateRecipientResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientCreateTemplateRecipientRoleResponse](../../models/operations/recipientcreatetemplaterecipientroleresponse.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientCreateTemplateRecipientReadStatus](../../models/operations/recipientcreatetemplaterecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientCreateTemplateRecipientSigningStatus](../../models/operations/recipientcreatetemplaterecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientCreateTemplateRecipientSendStatus](../../models/operations/recipientcreatetemplaterecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -53,4 +47,6 @@ let value: RecipientCreateTemplateRecipientResponse = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.RecipientCreateTemplateRecipientAuthOptions](../../models/operations/recipientcreatetemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientcreatetemplaterecipientsaccessauthrequest.md b/docs/models/operations/recipientcreatetemplaterecipientsaccessauthrequest.md index 1d841279..fb0870c7 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientsaccessauthrequest.md +++ b/docs/models/operations/recipientcreatetemplaterecipientsaccessauthrequest.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { RecipientCreateTemplateRecipientsAccessAuthRequest } from "@documenso/sdk-typescript/models/operations"; -let value: RecipientCreateTemplateRecipientsAccessAuthRequest = "ACCOUNT"; +let value: RecipientCreateTemplateRecipientsAccessAuthRequest = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientcreatetemplaterecipientsaccessauthresponse.md b/docs/models/operations/recipientcreatetemplaterecipientsaccessauthresponse.md index 4737f160..5a439d74 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientsaccessauthresponse.md +++ b/docs/models/operations/recipientcreatetemplaterecipientsaccessauthresponse.md @@ -13,5 +13,5 @@ let value: RecipientCreateTemplateRecipientsAccessAuthResponse = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientcreatetemplaterecipientsauthoptions.md b/docs/models/operations/recipientcreatetemplaterecipientsauthoptions.md index f272f08d..726da3cc 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientsauthoptions.md +++ b/docs/models/operations/recipientcreatetemplaterecipientsauthoptions.md @@ -7,10 +7,10 @@ import { RecipientCreateTemplateRecipientsAuthOptions } from "@documenso/sdk-typ let value: RecipientCreateTemplateRecipientsAuthOptions = { accessAuth: [ - "ACCOUNT", + "TWO_FACTOR_AUTH", ], actionAuth: [ - "TWO_FACTOR_AUTH", + "ACCOUNT", ], }; ``` diff --git a/docs/models/operations/recipientcreatetemplaterecipientsrecipientresponse.md b/docs/models/operations/recipientcreatetemplaterecipientsrecipientresponse.md index 2704c207..8b327cb6 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientsrecipientresponse.md +++ b/docs/models/operations/recipientcreatetemplaterecipientsrecipientresponse.md @@ -6,14 +6,13 @@ import { RecipientCreateTemplateRecipientsRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientCreateTemplateRecipientsRecipientResponse = { + envelopeId: "", role: "ASSISTANT", readStatus: "NOT_OPENED", signingStatus: "NOT_SIGNED", sendStatus: "NOT_SENT", id: 8686.43, - documentId: 5978.96, - templateId: 2853.52, - email: "Kaleigh.Effertz@yahoo.com", + email: "Laverne.Graham53@hotmail.com", name: "", token: "", documentDeletedAt: "", @@ -24,10 +23,10 @@ let value: RecipientCreateTemplateRecipientsRecipientResponse = { "ACCOUNT", ], actionAuth: [ - "PASSKEY", + "EXPLICIT_NONE", ], }, - signingOrder: null, + signingOrder: 6065.36, rejectionReason: "", }; ``` @@ -36,13 +35,12 @@ let value: RecipientCreateTemplateRecipientsRecipientResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientCreateTemplateRecipientsRoleResponse](../../models/operations/recipientcreatetemplaterecipientsroleresponse.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientCreateTemplateRecipientsReadStatus](../../models/operations/recipientcreatetemplaterecipientsreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientCreateTemplateRecipientsSigningStatus](../../models/operations/recipientcreatetemplaterecipientssigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientCreateTemplateRecipientsSendStatus](../../models/operations/recipientcreatetemplaterecipientssendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -51,4 +49,6 @@ let value: RecipientCreateTemplateRecipientsRecipientResponse = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.RecipientCreateTemplateRecipientsAuthOptions](../../models/operations/recipientcreatetemplaterecipientsauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientcreatetemplaterecipientsresponse.md b/docs/models/operations/recipientcreatetemplaterecipientsresponse.md index 3a955702..fc889ca6 100644 --- a/docs/models/operations/recipientcreatetemplaterecipientsresponse.md +++ b/docs/models/operations/recipientcreatetemplaterecipientsresponse.md @@ -10,28 +10,27 @@ import { RecipientCreateTemplateRecipientsResponse } from "@documenso/sdk-typesc let value: RecipientCreateTemplateRecipientsResponse = { recipients: [ { + envelopeId: "", role: "SIGNER", readStatus: "NOT_OPENED", signingStatus: "NOT_SIGNED", sendStatus: "NOT_SENT", id: 6134.75, - documentId: 9304.9, - templateId: 8591.06, - email: "Rylan_Mills@hotmail.com", + email: "Tomas_Stokes@gmail.com", name: "", token: "", documentDeletedAt: "", - expired: null, + expired: "", signedAt: "", authOptions: { accessAuth: [ "ACCOUNT", ], actionAuth: [ - "PASSKEY", + "EXPLICIT_NONE", ], }, - signingOrder: null, + signingOrder: 325.59, rejectionReason: "", }, ], diff --git a/docs/models/operations/recipientgetdocumentrecipientaccessauth.md b/docs/models/operations/recipientgetdocumentrecipientaccessauth.md index 86fd09d5..292e93ae 100644 --- a/docs/models/operations/recipientgetdocumentrecipientaccessauth.md +++ b/docs/models/operations/recipientgetdocumentrecipientaccessauth.md @@ -13,5 +13,5 @@ let value: RecipientGetDocumentRecipientAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientgetdocumentrecipientauthoptions.md b/docs/models/operations/recipientgetdocumentrecipientauthoptions.md index da3bbc77..c123f274 100644 --- a/docs/models/operations/recipientgetdocumentrecipientauthoptions.md +++ b/docs/models/operations/recipientgetdocumentrecipientauthoptions.md @@ -7,11 +7,9 @@ import { RecipientGetDocumentRecipientAuthOptions } from "@documenso/sdk-typescr let value: RecipientGetDocumentRecipientAuthOptions = { accessAuth: [ - "ACCOUNT", - ], - actionAuth: [ - "PASSKEY", + "TWO_FACTOR_AUTH", ], + actionAuth: [], }; ``` diff --git a/docs/models/operations/recipientgetdocumentrecipientfield.md b/docs/models/operations/recipientgetdocumentrecipientfield.md index aa639342..49b20c75 100644 --- a/docs/models/operations/recipientgetdocumentrecipientfield.md +++ b/docs/models/operations/recipientgetdocumentrecipientfield.md @@ -6,17 +6,17 @@ import { RecipientGetDocumentRecipientField } from "@documenso/sdk-typescript/models/operations"; let value: RecipientGetDocumentRecipientField = { + envelopeId: "", + envelopeItemId: "", type: "SIGNATURE", id: 7743.27, secondaryId: "", - documentId: 2973.96, - templateId: 3890.13, - recipientId: 565.05, - page: 3748.71, + recipientId: 5918.62, + page: 2973.96, customText: "", - inserted: true, + inserted: false, fieldMeta: { - type: "dropdown", + type: "initials", }, }; ``` @@ -25,11 +25,11 @@ let value: RecipientGetDocumentRecipientField = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.RecipientGetDocumentRecipientType](../../models/operations/recipientgetdocumentrecipienttype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: RecipientGetDocumentRecipientField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.RecipientGetDocumentRecipientFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.RecipientGetDocumentRecipientFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientgetdocumentrecipientresponse.md b/docs/models/operations/recipientgetdocumentrecipientresponse.md index a26a3edc..303dc4d2 100644 --- a/docs/models/operations/recipientgetdocumentrecipientresponse.md +++ b/docs/models/operations/recipientgetdocumentrecipientresponse.md @@ -8,30 +8,37 @@ Successful response import { RecipientGetDocumentRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientGetDocumentRecipientResponse = { + envelopeId: "", role: "VIEWER", readStatus: "OPENED", signingStatus: "SIGNED", sendStatus: "NOT_SENT", id: 2726.18, - documentId: 4860.57, - templateId: 7115.56, - email: "Amelie.Smith28@hotmail.com", + email: "Jeanie_Rath@hotmail.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", - authOptions: { - accessAuth: [ - "ACCOUNT", - ], - actionAuth: [ - "TWO_FACTOR_AUTH", - ], - }, - signingOrder: 2471.84, + authOptions: null, + signingOrder: 8092.34, rejectionReason: "", - fields: [], + fields: [ + { + envelopeId: "", + envelopeItemId: "", + type: "TEXT", + id: 5215.72, + secondaryId: "", + recipientId: 5000.26, + page: 2647.84, + customText: "", + inserted: true, + fieldMeta: { + type: "name", + }, + }, + ], }; ``` @@ -39,13 +46,12 @@ let value: RecipientGetDocumentRecipientResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientGetDocumentRecipientRole](../../models/operations/recipientgetdocumentrecipientrole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientGetDocumentRecipientReadStatus](../../models/operations/recipientgetdocumentrecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientGetDocumentRecipientSigningStatus](../../models/operations/recipientgetdocumentrecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientGetDocumentRecipientSendStatus](../../models/operations/recipientgetdocumentrecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -55,4 +61,6 @@ let value: RecipientGetDocumentRecipientResponse = { | `authOptions` | [operations.RecipientGetDocumentRecipientAuthOptions](../../models/operations/recipientgetdocumentrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejectionReason` | *string* | :heavy_check_mark: | N/A | -| `fields` | [operations.RecipientGetDocumentRecipientField](../../models/operations/recipientgetdocumentrecipientfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [operations.RecipientGetDocumentRecipientField](../../models/operations/recipientgetdocumentrecipientfield.md)[] | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientgettemplaterecipientaccessauth.md b/docs/models/operations/recipientgettemplaterecipientaccessauth.md index ef8b6eff..c468bf92 100644 --- a/docs/models/operations/recipientgettemplaterecipientaccessauth.md +++ b/docs/models/operations/recipientgettemplaterecipientaccessauth.md @@ -13,5 +13,5 @@ let value: RecipientGetTemplateRecipientAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientgettemplaterecipientfield.md b/docs/models/operations/recipientgettemplaterecipientfield.md index 57737d86..20493587 100644 --- a/docs/models/operations/recipientgettemplaterecipientfield.md +++ b/docs/models/operations/recipientgettemplaterecipientfield.md @@ -6,16 +6,18 @@ import { RecipientGetTemplateRecipientField } from "@documenso/sdk-typescript/models/operations"; let value: RecipientGetTemplateRecipientField = { + envelopeId: "", + envelopeItemId: "", type: "CHECKBOX", id: 353.33, secondaryId: "", - documentId: 9460.94, - templateId: 3908.47, - recipientId: 1853.99, - page: 5820.22, + recipientId: 7147.87, + page: 9460.94, customText: "", inserted: false, - fieldMeta: null, + fieldMeta: { + type: "name", + }, }; ``` @@ -23,11 +25,11 @@ let value: RecipientGetTemplateRecipientField = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.RecipientGetTemplateRecipientType](../../models/operations/recipientgettemplaterecipienttype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -36,4 +38,6 @@ let value: RecipientGetTemplateRecipientField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.RecipientGetTemplateRecipientFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.RecipientGetTemplateRecipientFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientgettemplaterecipientresponse.md b/docs/models/operations/recipientgettemplaterecipientresponse.md index 0d031ae0..da166f4f 100644 --- a/docs/models/operations/recipientgettemplaterecipientresponse.md +++ b/docs/models/operations/recipientgettemplaterecipientresponse.md @@ -8,23 +8,40 @@ Successful response import { RecipientGetTemplateRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientGetTemplateRecipientResponse = { + envelopeId: "", role: "APPROVER", readStatus: "NOT_OPENED", signingStatus: "NOT_SIGNED", sendStatus: "NOT_SENT", id: 3337.61, - documentId: 7280.75, - templateId: 7981.3, - email: "Destiny96@gmail.com", + email: "Monroe.Schmeler25@yahoo.com", name: "", token: "", - documentDeletedAt: "", + documentDeletedAt: null, expired: "", signedAt: "", - authOptions: null, - signingOrder: 8958.78, + authOptions: { + accessAuth: [], + actionAuth: [], + }, + signingOrder: 405.35, rejectionReason: "", - fields: [], + fields: [ + { + envelopeId: "", + envelopeItemId: "", + type: "FREE_SIGNATURE", + id: 2531.29, + secondaryId: "", + recipientId: 580.24, + page: 3455.3, + customText: "", + inserted: false, + fieldMeta: { + type: "number", + }, + }, + ], }; ``` @@ -32,13 +49,12 @@ let value: RecipientGetTemplateRecipientResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientGetTemplateRecipientRole](../../models/operations/recipientgettemplaterecipientrole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientGetTemplateRecipientReadStatus](../../models/operations/recipientgettemplaterecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientGetTemplateRecipientSigningStatus](../../models/operations/recipientgettemplaterecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientGetTemplateRecipientSendStatus](../../models/operations/recipientgettemplaterecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -48,4 +64,6 @@ let value: RecipientGetTemplateRecipientResponse = { | `authOptions` | [operations.RecipientGetTemplateRecipientAuthOptions](../../models/operations/recipientgettemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejectionReason` | *string* | :heavy_check_mark: | N/A | -| `fields` | [operations.RecipientGetTemplateRecipientField](../../models/operations/recipientgettemplaterecipientfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [operations.RecipientGetTemplateRecipientField](../../models/operations/recipientgettemplaterecipientfield.md)[] | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientaccessauthrequest.md b/docs/models/operations/recipientupdatedocumentrecipientaccessauthrequest.md index bfea9245..9922c90c 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientaccessauthrequest.md +++ b/docs/models/operations/recipientupdatedocumentrecipientaccessauthrequest.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { RecipientUpdateDocumentRecipientAccessAuthRequest } from "@documenso/sdk-typescript/models/operations"; -let value: RecipientUpdateDocumentRecipientAccessAuthRequest = "ACCOUNT"; +let value: RecipientUpdateDocumentRecipientAccessAuthRequest = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientaccessauthresponse.md b/docs/models/operations/recipientupdatedocumentrecipientaccessauthresponse.md index f7a079f2..ee674420 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientaccessauthresponse.md +++ b/docs/models/operations/recipientupdatedocumentrecipientaccessauthresponse.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { RecipientUpdateDocumentRecipientAccessAuthResponse } from "@documenso/sdk-typescript/models/operations"; -let value: RecipientUpdateDocumentRecipientAccessAuthResponse = "ACCOUNT"; +let value: RecipientUpdateDocumentRecipientAccessAuthResponse = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientfield.md b/docs/models/operations/recipientupdatedocumentrecipientfield.md index 721c9b45..a938c363 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientfield.md +++ b/docs/models/operations/recipientupdatedocumentrecipientfield.md @@ -6,17 +6,18 @@ import { RecipientUpdateDocumentRecipientField } from "@documenso/sdk-typescript/models/operations"; let value: RecipientUpdateDocumentRecipientField = { + envelopeId: "", + envelopeItemId: "", type: "DROPDOWN", id: 460.56, secondaryId: "", - documentId: 8322.25, - templateId: 7652.17, - recipientId: 8431.36, - page: 2181.5, + recipientId: 2031.68, + page: 8322.25, customText: "", - inserted: true, + inserted: false, fieldMeta: { - type: "dropdown", + type: "checkbox", + direction: "vertical", }, }; ``` @@ -25,11 +26,11 @@ let value: RecipientUpdateDocumentRecipientField = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.RecipientUpdateDocumentRecipientType](../../models/operations/recipientupdatedocumentrecipienttype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +39,6 @@ let value: RecipientUpdateDocumentRecipientField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.RecipientUpdateDocumentRecipientFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.RecipientUpdateDocumentRecipientFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientresponse.md b/docs/models/operations/recipientupdatedocumentrecipientresponse.md index ee73193c..17ae930c 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientresponse.md +++ b/docs/models/operations/recipientupdatedocumentrecipientresponse.md @@ -8,41 +8,29 @@ Successful response import { RecipientUpdateDocumentRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientUpdateDocumentRecipientResponse = { + envelopeId: "", role: "CC", readStatus: "OPENED", signingStatus: "REJECTED", sendStatus: "SENT", id: 3861.76, - documentId: 4292.95, - templateId: 8133.14, - email: "Kianna.Hagenes@yahoo.com", + email: "Hillary.Schulist57@yahoo.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", authOptions: { - accessAuth: [], - actionAuth: [], + accessAuth: [ + "TWO_FACTOR_AUTH", + ], + actionAuth: [ + "PASSWORD", + ], }, - signingOrder: 2300.2, + signingOrder: null, rejectionReason: "", - fields: [ - { - type: "FREE_SIGNATURE", - id: 1796.09, - secondaryId: "", - documentId: null, - templateId: 1330.56, - recipientId: 231.9, - page: 2724.77, - customText: "", - inserted: true, - fieldMeta: { - type: "dropdown", - }, - }, - ], + fields: [], }; ``` @@ -50,13 +38,12 @@ let value: RecipientUpdateDocumentRecipientResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientUpdateDocumentRecipientRoleResponse](../../models/operations/recipientupdatedocumentrecipientroleresponse.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientUpdateDocumentRecipientReadStatus](../../models/operations/recipientupdatedocumentrecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientUpdateDocumentRecipientSigningStatus](../../models/operations/recipientupdatedocumentrecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientUpdateDocumentRecipientSendStatus](../../models/operations/recipientupdatedocumentrecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -66,4 +53,6 @@ let value: RecipientUpdateDocumentRecipientResponse = { | `authOptions` | [operations.RecipientUpdateDocumentRecipientAuthOptions](../../models/operations/recipientupdatedocumentrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejectionReason` | *string* | :heavy_check_mark: | N/A | -| `fields` | [operations.RecipientUpdateDocumentRecipientField](../../models/operations/recipientupdatedocumentrecipientfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [operations.RecipientUpdateDocumentRecipientField](../../models/operations/recipientupdatedocumentrecipientfield.md)[] | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientsaccessauthrequest.md b/docs/models/operations/recipientupdatedocumentrecipientsaccessauthrequest.md index e506b8bf..385b0595 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientsaccessauthrequest.md +++ b/docs/models/operations/recipientupdatedocumentrecipientsaccessauthrequest.md @@ -13,5 +13,5 @@ let value: RecipientUpdateDocumentRecipientsAccessAuthRequest = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientsaccessauthresponse.md b/docs/models/operations/recipientupdatedocumentrecipientsaccessauthresponse.md index 44c98d7a..25bb76ab 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientsaccessauthresponse.md +++ b/docs/models/operations/recipientupdatedocumentrecipientsaccessauthresponse.md @@ -13,5 +13,5 @@ let value: RecipientUpdateDocumentRecipientsAccessAuthResponse = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientsauthoptions.md b/docs/models/operations/recipientupdatedocumentrecipientsauthoptions.md index fde040e2..a7a7cade 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientsauthoptions.md +++ b/docs/models/operations/recipientupdatedocumentrecipientsauthoptions.md @@ -7,11 +7,9 @@ import { RecipientUpdateDocumentRecipientsAuthOptions } from "@documenso/sdk-typ let value: RecipientUpdateDocumentRecipientsAuthOptions = { accessAuth: [ - "ACCOUNT", - ], - actionAuth: [ "TWO_FACTOR_AUTH", ], + actionAuth: [], }; ``` diff --git a/docs/models/operations/recipientupdatedocumentrecipientsfield.md b/docs/models/operations/recipientupdatedocumentrecipientsfield.md index 307f7446..4b886cd9 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientsfield.md +++ b/docs/models/operations/recipientupdatedocumentrecipientsfield.md @@ -6,17 +6,17 @@ import { RecipientUpdateDocumentRecipientsField } from "@documenso/sdk-typescript/models/operations"; let value: RecipientUpdateDocumentRecipientsField = { + envelopeId: "", + envelopeItemId: "", type: "CHECKBOX", id: 9425.41, secondaryId: "", - documentId: 2727.77, - templateId: 3022.68, - recipientId: 4941.45, - page: 1442.72, + recipientId: 3620.25, + page: 2727.77, customText: "", - inserted: false, + inserted: true, fieldMeta: { - type: "dropdown", + type: "text", }, }; ``` @@ -25,11 +25,11 @@ let value: RecipientUpdateDocumentRecipientsField = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.RecipientUpdateDocumentRecipientsType](../../models/operations/recipientupdatedocumentrecipientstype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: RecipientUpdateDocumentRecipientsField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.RecipientUpdateDocumentRecipientsFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.RecipientUpdateDocumentRecipientsFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientsrecipientresponse.md b/docs/models/operations/recipientupdatedocumentrecipientsrecipientresponse.md index b47f8a47..e49f4a76 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientsrecipientresponse.md +++ b/docs/models/operations/recipientupdatedocumentrecipientsrecipientresponse.md @@ -6,26 +6,25 @@ import { RecipientUpdateDocumentRecipientsRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientUpdateDocumentRecipientsRecipientResponse = { + envelopeId: "", role: "CC", readStatus: "OPENED", signingStatus: "SIGNED", sendStatus: "NOT_SENT", id: 4456.3, - documentId: null, - templateId: 5486.19, - email: "Sarai_Collins35@yahoo.com", + email: "Elwyn_Moore59@gmail.com", name: "", token: "", documentDeletedAt: "", - expired: null, + expired: "", signedAt: "", authOptions: { accessAuth: [], actionAuth: [ - "PASSKEY", + "PASSWORD", ], }, - signingOrder: null, + signingOrder: 6939.51, rejectionReason: "", fields: [], }; @@ -35,13 +34,12 @@ let value: RecipientUpdateDocumentRecipientsRecipientResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientUpdateDocumentRecipientsRoleResponse](../../models/operations/recipientupdatedocumentrecipientsroleresponse.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientUpdateDocumentRecipientsReadStatus](../../models/operations/recipientupdatedocumentrecipientsreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientUpdateDocumentRecipientsSigningStatus](../../models/operations/recipientupdatedocumentrecipientssigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientUpdateDocumentRecipientsSendStatus](../../models/operations/recipientupdatedocumentrecipientssendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -51,4 +49,6 @@ let value: RecipientUpdateDocumentRecipientsRecipientResponse = { | `authOptions` | [operations.RecipientUpdateDocumentRecipientsAuthOptions](../../models/operations/recipientupdatedocumentrecipientsauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejectionReason` | *string* | :heavy_check_mark: | N/A | -| `fields` | [operations.RecipientUpdateDocumentRecipientsField](../../models/operations/recipientupdatedocumentrecipientsfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [operations.RecipientUpdateDocumentRecipientsField](../../models/operations/recipientupdatedocumentrecipientsfield.md)[] | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatedocumentrecipientsresponse.md b/docs/models/operations/recipientupdatedocumentrecipientsresponse.md index 5f3a0ccf..b6c6509f 100644 --- a/docs/models/operations/recipientupdatedocumentrecipientsresponse.md +++ b/docs/models/operations/recipientupdatedocumentrecipientsresponse.md @@ -10,26 +10,25 @@ import { RecipientUpdateDocumentRecipientsResponse } from "@documenso/sdk-typesc let value: RecipientUpdateDocumentRecipientsResponse = { recipients: [ { + envelopeId: "", role: "VIEWER", readStatus: "OPENED", signingStatus: "NOT_SIGNED", sendStatus: "NOT_SENT", id: 4016.96, - documentId: 1315.53, - templateId: 2618.83, - email: "Misael37@gmail.com", + email: "Brenden.Gibson72@yahoo.com", name: "", token: "", - documentDeletedAt: null, + documentDeletedAt: "", expired: "", signedAt: "", authOptions: { accessAuth: [], actionAuth: [ - "PASSKEY", + "PASSWORD", ], }, - signingOrder: 3524.23, + signingOrder: null, rejectionReason: "", fields: [], }, diff --git a/docs/models/operations/recipientupdatetemplaterecipientaccessauthrequest.md b/docs/models/operations/recipientupdatetemplaterecipientaccessauthrequest.md index 434ac8a8..b3511db0 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientaccessauthrequest.md +++ b/docs/models/operations/recipientupdatetemplaterecipientaccessauthrequest.md @@ -13,5 +13,5 @@ let value: RecipientUpdateTemplateRecipientAccessAuthRequest = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientupdatetemplaterecipientaccessauthresponse.md b/docs/models/operations/recipientupdatetemplaterecipientaccessauthresponse.md index 9b7880e5..3c12a8b6 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientaccessauthresponse.md +++ b/docs/models/operations/recipientupdatetemplaterecipientaccessauthresponse.md @@ -13,5 +13,5 @@ let value: RecipientUpdateTemplateRecipientAccessAuthResponse = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientupdatetemplaterecipientauthoptions.md b/docs/models/operations/recipientupdatetemplaterecipientauthoptions.md index ab034ebb..724c94f6 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientauthoptions.md +++ b/docs/models/operations/recipientupdatetemplaterecipientauthoptions.md @@ -7,10 +7,10 @@ import { RecipientUpdateTemplateRecipientAuthOptions } from "@documenso/sdk-type let value: RecipientUpdateTemplateRecipientAuthOptions = { accessAuth: [ - "ACCOUNT", + "TWO_FACTOR_AUTH", ], actionAuth: [ - "TWO_FACTOR_AUTH", + "PASSKEY", ], }; ``` diff --git a/docs/models/operations/recipientupdatetemplaterecipientfield.md b/docs/models/operations/recipientupdatetemplaterecipientfield.md index 835351c9..8640bdde 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientfield.md +++ b/docs/models/operations/recipientupdatetemplaterecipientfield.md @@ -6,17 +6,17 @@ import { RecipientUpdateTemplateRecipientField } from "@documenso/sdk-typescript/models/operations"; let value: RecipientUpdateTemplateRecipientField = { + envelopeId: "", + envelopeItemId: "", type: "INITIALS", id: 9505.51, secondaryId: "", - documentId: 9540.89, - templateId: 9258.68, - recipientId: 2806.91, - page: 9015.04, + recipientId: 2916.73, + page: 9540.89, customText: "", inserted: true, fieldMeta: { - type: "initials", + type: "email", }, }; ``` @@ -25,11 +25,11 @@ let value: RecipientUpdateTemplateRecipientField = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.RecipientUpdateTemplateRecipientType](../../models/operations/recipientupdatetemplaterecipienttype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: RecipientUpdateTemplateRecipientField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.RecipientUpdateTemplateRecipientFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.RecipientUpdateTemplateRecipientFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatetemplaterecipientresponse.md b/docs/models/operations/recipientupdatetemplaterecipientresponse.md index 5fc39312..83cfaf7b 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientresponse.md +++ b/docs/models/operations/recipientupdatetemplaterecipientresponse.md @@ -8,14 +8,13 @@ Successful response import { RecipientUpdateTemplateRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientUpdateTemplateRecipientResponse = { + envelopeId: "", role: "CC", readStatus: "OPENED", signingStatus: "REJECTED", sendStatus: "SENT", id: 7508, - documentId: 6708.46, - templateId: 2269.09, - email: "Hillary_Miller@gmail.com", + email: "Marcos.Farrell42@gmail.com", name: "", token: "", documentDeletedAt: "", @@ -24,12 +23,27 @@ let value: RecipientUpdateTemplateRecipientResponse = { authOptions: { accessAuth: [], actionAuth: [ - "PASSWORD", + "EXPLICIT_NONE", ], }, - signingOrder: 8779.58, + signingOrder: 334.66, rejectionReason: "", - fields: [], + fields: [ + { + envelopeId: "", + envelopeItemId: "", + type: "NUMBER", + id: 8779.58, + secondaryId: "", + recipientId: 9184.11, + page: 1870.47, + customText: "", + inserted: false, + fieldMeta: { + type: "name", + }, + }, + ], }; ``` @@ -37,13 +51,12 @@ let value: RecipientUpdateTemplateRecipientResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientUpdateTemplateRecipientRoleResponse](../../models/operations/recipientupdatetemplaterecipientroleresponse.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientUpdateTemplateRecipientReadStatus](../../models/operations/recipientupdatetemplaterecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientUpdateTemplateRecipientSigningStatus](../../models/operations/recipientupdatetemplaterecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientUpdateTemplateRecipientSendStatus](../../models/operations/recipientupdatetemplaterecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -53,4 +66,6 @@ let value: RecipientUpdateTemplateRecipientResponse = { | `authOptions` | [operations.RecipientUpdateTemplateRecipientAuthOptions](../../models/operations/recipientupdatetemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejectionReason` | *string* | :heavy_check_mark: | N/A | -| `fields` | [operations.RecipientUpdateTemplateRecipientField](../../models/operations/recipientupdatetemplaterecipientfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [operations.RecipientUpdateTemplateRecipientField](../../models/operations/recipientupdatetemplaterecipientfield.md)[] | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatetemplaterecipientsaccessauthrequest.md b/docs/models/operations/recipientupdatetemplaterecipientsaccessauthrequest.md index 4fbc401d..b0105aae 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientsaccessauthrequest.md +++ b/docs/models/operations/recipientupdatetemplaterecipientsaccessauthrequest.md @@ -13,5 +13,5 @@ let value: RecipientUpdateTemplateRecipientsAccessAuthRequest = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientupdatetemplaterecipientsaccessauthresponse.md b/docs/models/operations/recipientupdatetemplaterecipientsaccessauthresponse.md index d00607db..ae0474ac 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientsaccessauthresponse.md +++ b/docs/models/operations/recipientupdatetemplaterecipientsaccessauthresponse.md @@ -13,5 +13,5 @@ let value: RecipientUpdateTemplateRecipientsAccessAuthResponse = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/recipientupdatetemplaterecipientsauthoptions.md b/docs/models/operations/recipientupdatetemplaterecipientsauthoptions.md index 316837dd..0e459184 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientsauthoptions.md +++ b/docs/models/operations/recipientupdatetemplaterecipientsauthoptions.md @@ -7,10 +7,10 @@ import { RecipientUpdateTemplateRecipientsAuthOptions } from "@documenso/sdk-typ let value: RecipientUpdateTemplateRecipientsAuthOptions = { accessAuth: [ - "ACCOUNT", + "TWO_FACTOR_AUTH", ], actionAuth: [ - "EXPLICIT_NONE", + "PASSKEY", ], }; ``` diff --git a/docs/models/operations/recipientupdatetemplaterecipientsfield.md b/docs/models/operations/recipientupdatetemplaterecipientsfield.md index 49882894..588a2570 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientsfield.md +++ b/docs/models/operations/recipientupdatetemplaterecipientsfield.md @@ -6,17 +6,17 @@ import { RecipientUpdateTemplateRecipientsField } from "@documenso/sdk-typescript/models/operations"; let value: RecipientUpdateTemplateRecipientsField = { + envelopeId: "", + envelopeItemId: "", type: "DROPDOWN", id: 4484.24, secondaryId: "", - documentId: 1643.06, - templateId: null, - recipientId: 9197.51, - page: 7388.94, + recipientId: 8585.62, + page: 1643.06, customText: "", - inserted: false, + inserted: true, fieldMeta: { - type: "name", + type: "radio", }, }; ``` @@ -25,11 +25,11 @@ let value: RecipientUpdateTemplateRecipientsField = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.RecipientUpdateTemplateRecipientsType](../../models/operations/recipientupdatetemplaterecipientstype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: RecipientUpdateTemplateRecipientsField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.RecipientUpdateTemplateRecipientsFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.RecipientUpdateTemplateRecipientsFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatetemplaterecipientsrecipientresponse.md b/docs/models/operations/recipientupdatetemplaterecipientsrecipientresponse.md index 010aa7a1..da3caf84 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientsrecipientresponse.md +++ b/docs/models/operations/recipientupdatetemplaterecipientsrecipientresponse.md @@ -6,35 +6,41 @@ import { RecipientUpdateTemplateRecipientsRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: RecipientUpdateTemplateRecipientsRecipientResponse = { + envelopeId: "", role: "SIGNER", readStatus: "NOT_OPENED", signingStatus: "REJECTED", sendStatus: "SENT", id: 749.51, - documentId: 2280.13, - templateId: 1596.97, - email: "Walter.Champlin@hotmail.com", + email: "Danny97@yahoo.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", - authOptions: null, + authOptions: { + accessAuth: [ + "ACCOUNT", + ], + actionAuth: [ + "ACCOUNT", + ], + }, signingOrder: 2795.49, rejectionReason: "", fields: [ { + envelopeId: "", + envelopeItemId: "", type: "DATE", id: 7418.3, secondaryId: "", - documentId: 4748.46, - templateId: null, - recipientId: 1160.41, - page: 2538.43, + recipientId: 5371.46, + page: 4748.46, customText: "", - inserted: false, + inserted: true, fieldMeta: { - type: "number", + type: "email", }, }, ], @@ -45,13 +51,12 @@ let value: RecipientUpdateTemplateRecipientsRecipientResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.RecipientUpdateTemplateRecipientsRoleResponse](../../models/operations/recipientupdatetemplaterecipientsroleresponse.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.RecipientUpdateTemplateRecipientsReadStatus](../../models/operations/recipientupdatetemplaterecipientsreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.RecipientUpdateTemplateRecipientsSigningStatus](../../models/operations/recipientupdatetemplaterecipientssigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.RecipientUpdateTemplateRecipientsSendStatus](../../models/operations/recipientupdatetemplaterecipientssendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -61,4 +66,6 @@ let value: RecipientUpdateTemplateRecipientsRecipientResponse = { | `authOptions` | [operations.RecipientUpdateTemplateRecipientsAuthOptions](../../models/operations/recipientupdatetemplaterecipientsauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejectionReason` | *string* | :heavy_check_mark: | N/A | -| `fields` | [operations.RecipientUpdateTemplateRecipientsField](../../models/operations/recipientupdatetemplaterecipientsfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [operations.RecipientUpdateTemplateRecipientsField](../../models/operations/recipientupdatetemplaterecipientsfield.md)[] | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/recipientupdatetemplaterecipientsresponse.md b/docs/models/operations/recipientupdatetemplaterecipientsresponse.md index 9b1e2385..b632827b 100644 --- a/docs/models/operations/recipientupdatetemplaterecipientsresponse.md +++ b/docs/models/operations/recipientupdatetemplaterecipientsresponse.md @@ -10,28 +10,44 @@ import { RecipientUpdateTemplateRecipientsResponse } from "@documenso/sdk-typesc let value: RecipientUpdateTemplateRecipientsResponse = { recipients: [ { + envelopeId: "", role: "APPROVER", readStatus: "OPENED", signingStatus: "REJECTED", sendStatus: "NOT_SENT", id: 1170.08, - documentId: 7745.35, - templateId: 9455.53, - email: "Gerry52@gmail.com", + email: "Onie38@gmail.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", authOptions: { - accessAuth: [], + accessAuth: [ + "ACCOUNT", + ], actionAuth: [ - "EXPLICIT_NONE", + "ACCOUNT", ], }, - signingOrder: 7782.94, + signingOrder: 4661.45, rejectionReason: "", - fields: [], + fields: [ + { + envelopeId: "", + envelopeItemId: "", + type: "DATE", + id: 7418.3, + secondaryId: "", + recipientId: 5371.46, + page: 4748.46, + customText: "", + inserted: true, + fieldMeta: { + type: "email", + }, + }, + ], }, ], }; diff --git a/docs/models/operations/template.md b/docs/models/operations/template.md index c1b4ab98..85c085c3 100644 --- a/docs/models/operations/template.md +++ b/docs/models/operations/template.md @@ -17,60 +17,61 @@ let value: Template = { globalAccessAuth: [], globalActionAuth: [], }, - templateDocumentDataId: "", createdAt: "1706149971951", updatedAt: "1735654227391", publicTitle: "", publicDescription: "", folderId: null, + envelopeId: "", templateDocumentData: { type: "S3_PATH", id: "", data: "", initialData: "", + envelopeItemId: "", }, templateMeta: { id: "", subject: "", message: "", - timezone: "Europe/Skopje", - dateFormat: null, + timezone: "America/Anchorage", + dateFormat: "", signingOrder: "PARALLEL", typedSignatureEnabled: false, - uploadSignatureEnabled: false, - drawSignatureEnabled: true, - allowDictateNextSigner: true, - distributionMethod: "NONE", - templateId: 535.07, - redirectUrl: "https://pitiful-extent.com", + uploadSignatureEnabled: true, + drawSignatureEnabled: false, + allowDictateNextSigner: false, + distributionMethod: "EMAIL", + redirectUrl: "https://awesome-jellyfish.org", language: "", emailSettings: {}, emailId: "", - emailReplyTo: "", + emailReplyTo: null, + templateId: 6491.25, }, directLink: { id: "", - templateId: 2906.33, + envelopeId: "", token: "", - createdAt: "1719848666818", + createdAt: "1726866861086", enabled: true, - directTemplateRecipientId: 7492.04, + directTemplateRecipientId: 4976.87, + templateId: 4407.15, }, user: { - id: 2012.56, + id: 7492.04, name: "", - email: "Domenica.DuBuque@hotmail.com", + email: "Rosina27@hotmail.com", }, recipients: [ { + envelopeId: "", role: "ASSISTANT", readStatus: "OPENED", - signingStatus: "SIGNED", - sendStatus: "NOT_SENT", - id: 1921.91, - documentId: 8540.85, - templateId: null, - email: "Bernard_Sipes@hotmail.com", + signingStatus: "REJECTED", + sendStatus: "SENT", + id: 2297.91, + email: "Davin_Beahan10@gmail.com", name: "", token: "", documentDeletedAt: "", @@ -78,12 +79,10 @@ let value: Template = { signedAt: "", authOptions: { accessAuth: [], - actionAuth: [ - "PASSKEY", - ], + actionAuth: [], }, - signingOrder: 135.48, - rejectionReason: null, + signingOrder: 7528.64, + rejectionReason: "", }, ], fields: [], @@ -91,13 +90,13 @@ let value: Template = { id: "", name: "", type: "DOCUMENT", - visibility: "ADMIN", - userId: 9120.37, - teamId: 5757.17, + visibility: "EVERYONE", + userId: 2470.86, + teamId: 8054.81, pinned: true, - parentId: null, - createdAt: "1729360187536", - updatedAt: "1735634686334", + parentId: "", + createdAt: "1732915599752", + updatedAt: "1735652941400", }, }; ``` @@ -114,12 +113,13 @@ let value: Template = { | `userId` | *number* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateCreateTemplateTemporaryAuthOptions](../../models/operations/templatecreatetemplatetemporaryauthoptions.md) | :heavy_check_mark: | N/A | -| `templateDocumentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `publicTitle` | *string* | :heavy_check_mark: | N/A | | `publicDescription` | *string* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateDocumentDataId` | *string* | :heavy_minus_sign: | N/A | | `templateDocumentData` | [operations.TemplateCreateTemplateTemporaryTemplateDocumentData](../../models/operations/templatecreatetemplatetemporarytemplatedocumentdata.md) | :heavy_check_mark: | N/A | | `templateMeta` | [operations.TemplateCreateTemplateTemporaryTemplateMeta](../../models/operations/templatecreatetemplatetemporarytemplatemeta.md) | :heavy_check_mark: | N/A | | `directLink` | [operations.TemplateCreateTemplateTemporaryDirectLink](../../models/operations/templatecreatetemplatetemporarydirectlink.md) | :heavy_check_mark: | N/A | diff --git a/docs/models/operations/templatecreatedocumentfromtemplateaccessauth.md b/docs/models/operations/templatecreatedocumentfromtemplateaccessauth.md index 9b5c90ad..045618e4 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplateaccessauth.md +++ b/docs/models/operations/templatecreatedocumentfromtemplateaccessauth.md @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document. ```typescript import { TemplateCreateDocumentFromTemplateAccessAuth } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateCreateDocumentFromTemplateAccessAuth = "ACCOUNT"; +let value: TemplateCreateDocumentFromTemplateAccessAuth = "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplatedocumentdata.md b/docs/models/operations/templatecreatedocumentfromtemplatedocumentdata.md index c0e2c385..8b4c83f0 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplatedocumentdata.md +++ b/docs/models/operations/templatecreatedocumentfromtemplatedocumentdata.md @@ -10,6 +10,7 @@ let value: TemplateCreateDocumentFromTemplateDocumentData = { id: "", data: "", initialData: "", + envelopeItemId: "", }; ``` @@ -20,4 +21,5 @@ let value: TemplateCreateDocumentFromTemplateDocumentData = { | `type` | [operations.TemplateCreateDocumentFromTemplateDocumentDataType](../../models/operations/templatecreatedocumentfromtemplatedocumentdatatype.md) | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `data` | *string* | :heavy_check_mark: | N/A | -| `initialData` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `initialData` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplatedocumentmeta.md b/docs/models/operations/templatecreatedocumentfromtemplatedocumentmeta.md index 389c63e8..72c87bdb 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplatedocumentmeta.md +++ b/docs/models/operations/templatecreatedocumentfromtemplatedocumentmeta.md @@ -12,14 +12,12 @@ let value: TemplateCreateDocumentFromTemplateDocumentMeta = { subject: "", message: "", timezone: "America/Boa_Vista", - password: null, - dateFormat: "", - documentId: 8195.45, - redirectUrl: "https://subdued-stock.net", - typedSignatureEnabled: true, - uploadSignatureEnabled: true, + dateFormat: null, + redirectUrl: "https://rich-suitcase.net", + typedSignatureEnabled: false, + uploadSignatureEnabled: false, drawSignatureEnabled: true, - allowDictateNextSigner: false, + allowDictateNextSigner: true, language: "", emailSettings: {}, emailId: "", @@ -37,9 +35,7 @@ let value: TemplateCreateDocumentFromTemplateDocumentMeta = { | `subject` | *string* | :heavy_check_mark: | N/A | | `message` | *string* | :heavy_check_mark: | N/A | | `timezone` | *string* | :heavy_check_mark: | N/A | -| `password` | *string* | :heavy_check_mark: | N/A | | `dateFormat` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | | `redirectUrl` | *string* | :heavy_check_mark: | N/A | | `typedSignatureEnabled` | *boolean* | :heavy_check_mark: | N/A | | `uploadSignatureEnabled` | *boolean* | :heavy_check_mark: | N/A | @@ -48,4 +44,6 @@ let value: TemplateCreateDocumentFromTemplateDocumentMeta = { | `language` | *string* | :heavy_check_mark: | N/A | | `emailSettings` | [operations.TemplateCreateDocumentFromTemplateEmailSettings](../../models/operations/templatecreatedocumentfromtemplateemailsettings.md) | :heavy_check_mark: | N/A | | `emailId` | *string* | :heavy_check_mark: | N/A | -| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | +| `password` | *string* | :heavy_minus_sign: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplatefield.md b/docs/models/operations/templatecreatedocumentfromtemplatefield.md index 382cf82f..4c24764d 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplatefield.md +++ b/docs/models/operations/templatecreatedocumentfromtemplatefield.md @@ -6,17 +6,17 @@ import { TemplateCreateDocumentFromTemplateField } from "@documenso/sdk-typescript/models/operations"; let value: TemplateCreateDocumentFromTemplateField = { + envelopeId: "", + envelopeItemId: "", type: "INITIALS", id: 5022.06, secondaryId: "", - documentId: 9731.51, - templateId: 4100.66, - recipientId: 9639.67, - page: 1900.27, + recipientId: 1543.88, + page: 9731.51, customText: "", - inserted: true, + inserted: false, fieldMeta: { - type: "name", + type: "dropdown", }, }; ``` @@ -25,11 +25,11 @@ let value: TemplateCreateDocumentFromTemplateField = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.TemplateCreateDocumentFromTemplateFieldType](../../models/operations/templatecreatedocumentfromtemplatefieldtype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: TemplateCreateDocumentFromTemplateField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.TemplateCreateDocumentFromTemplateFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.TemplateCreateDocumentFromTemplateFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplateglobalaccessauth.md b/docs/models/operations/templatecreatedocumentfromtemplateglobalaccessauth.md index 0ef33519..5b86a6d3 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplateglobalaccessauth.md +++ b/docs/models/operations/templatecreatedocumentfromtemplateglobalaccessauth.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { TemplateCreateDocumentFromTemplateGlobalAccessAuth } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateCreateDocumentFromTemplateGlobalAccessAuth = "ACCOUNT"; +let value: TemplateCreateDocumentFromTemplateGlobalAccessAuth = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplaterecipientauthoptions.md b/docs/models/operations/templatecreatedocumentfromtemplaterecipientauthoptions.md index f40f9261..e40e92c0 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplaterecipientauthoptions.md +++ b/docs/models/operations/templatecreatedocumentfromtemplaterecipientauthoptions.md @@ -7,10 +7,10 @@ import { TemplateCreateDocumentFromTemplateRecipientAuthOptions } from "@documen let value: TemplateCreateDocumentFromTemplateRecipientAuthOptions = { accessAuth: [ - "ACCOUNT", + "TWO_FACTOR_AUTH", ], actionAuth: [ - "TWO_FACTOR_AUTH", + "ACCOUNT", ], }; ``` diff --git a/docs/models/operations/templatecreatedocumentfromtemplaterecipientresponse.md b/docs/models/operations/templatecreatedocumentfromtemplaterecipientresponse.md index 23c299be..d32ac39b 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplaterecipientresponse.md +++ b/docs/models/operations/templatecreatedocumentfromtemplaterecipientresponse.md @@ -6,26 +6,25 @@ import { TemplateCreateDocumentFromTemplateRecipientResponse } from "@documenso/sdk-typescript/models/operations"; let value: TemplateCreateDocumentFromTemplateRecipientResponse = { + envelopeId: "", role: "VIEWER", readStatus: "NOT_OPENED", signingStatus: "REJECTED", sendStatus: "NOT_SENT", id: 2242.56, - documentId: 8035.37, - templateId: 5116.96, - email: "Thelma.Orn98@yahoo.com", + email: "Queen43@hotmail.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", authOptions: { - accessAuth: [], - actionAuth: [ - "EXPLICIT_NONE", + accessAuth: [ + "ACCOUNT", ], + actionAuth: [], }, - signingOrder: 3272.56, + signingOrder: 5127.24, rejectionReason: "", }; ``` @@ -34,13 +33,12 @@ let value: TemplateCreateDocumentFromTemplateRecipientResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.TemplateCreateDocumentFromTemplateRole](../../models/operations/templatecreatedocumentfromtemplaterole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.TemplateCreateDocumentFromTemplateReadStatus](../../models/operations/templatecreatedocumentfromtemplatereadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.TemplateCreateDocumentFromTemplateSigningStatus](../../models/operations/templatecreatedocumentfromtemplatesigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.TemplateCreateDocumentFromTemplateSendStatus](../../models/operations/templatecreatedocumentfromtemplatesendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -49,4 +47,6 @@ let value: TemplateCreateDocumentFromTemplateRecipientResponse = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateCreateDocumentFromTemplateRecipientAuthOptions](../../models/operations/templatecreatedocumentfromtemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplaterequest.md b/docs/models/operations/templatecreatedocumentfromtemplaterequest.md index 98055e15..9e7774de 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplaterequest.md +++ b/docs/models/operations/templatecreatedocumentfromtemplaterequest.md @@ -18,11 +18,12 @@ let value: TemplateCreateDocumentFromTemplateRequest = { ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `templateId` | *number* | :heavy_check_mark: | N/A | -| `recipients` | [operations.TemplateCreateDocumentFromTemplateRecipientRequest](../../models/operations/templatecreatedocumentfromtemplaterecipientrequest.md)[] | :heavy_check_mark: | The information of the recipients to create the document with. | -| `distributeDocument` | *boolean* | :heavy_minus_sign: | Whether to create the document as pending and distribute it to recipients. | -| `customDocumentDataId` | *string* | :heavy_minus_sign: | The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. | -| `folderId` | *string* | :heavy_minus_sign: | The ID of the folder to create the document in. If not provided, the document will be created in the root folder. | -| `prefillFields` | *operations.PrefillField*[] | :heavy_minus_sign: | The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `templateId` | *number* | :heavy_check_mark: | N/A | +| `recipients` | [operations.TemplateCreateDocumentFromTemplateRecipientRequest](../../models/operations/templatecreatedocumentfromtemplaterecipientrequest.md)[] | :heavy_check_mark: | The information of the recipients to create the document with. | +| `distributeDocument` | *boolean* | :heavy_minus_sign: | Whether to create the document as pending and distribute it to recipients. | +| `customDocumentDataId` | *string* | :heavy_minus_sign: | [DEPRECATED] - Use customDocumentData instead. The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. | +| `customDocumentData` | [operations.CustomDocumentDatum](../../models/operations/customdocumentdatum.md)[] | :heavy_minus_sign: | The data IDs of alternative PDFs to use when creating the document. If not provided, the PDF attached to the template will be used. | +| `folderId` | *string* | :heavy_minus_sign: | The ID of the folder to create the document in. If not provided, the document will be created in the root folder. | +| `prefillFields` | *operations.PrefillField*[] | :heavy_minus_sign: | The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values. | \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplateresponse.md b/docs/models/operations/templatecreatedocumentfromtemplateresponse.md index a0852ab4..72fe8406 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplateresponse.md +++ b/docs/models/operations/templatecreatedocumentfromtemplateresponse.md @@ -17,35 +17,33 @@ let value: TemplateCreateDocumentFromTemplateResponse = { authOptions: null, formValues: {}, title: "", - documentDataId: "", createdAt: "1726149769095", updatedAt: "1735650729634", completedAt: "", deletedAt: "", teamId: 3542.33, - templateId: 4534.72, folderId: "", + envelopeId: "", documentData: { - type: "S3_PATH", + type: "BYTES", id: "", data: "", initialData: "", + envelopeItemId: "", }, documentMeta: { - signingOrder: "SEQUENTIAL", - distributionMethod: "NONE", + signingOrder: "PARALLEL", + distributionMethod: "EMAIL", id: "", subject: "", message: "", - timezone: null, - password: "O6uaCuVNSI9nx0p", + timezone: "America/St_Vincent", dateFormat: "", - documentId: 8523.5, - redirectUrl: "https://ruddy-governance.org/", - typedSignatureEnabled: false, + redirectUrl: null, + typedSignatureEnabled: true, uploadSignatureEnabled: true, drawSignatureEnabled: true, - allowDictateNextSigner: true, + allowDictateNextSigner: false, language: "", emailSettings: {}, emailId: "", @@ -54,14 +52,14 @@ let value: TemplateCreateDocumentFromTemplateResponse = { folder: { id: "", name: "", - type: "DOCUMENT", - visibility: "ADMIN", - userId: 6892.94, - teamId: 9047.93, + type: "TEMPLATE", + visibility: "MANAGER_AND_ABOVE", + userId: 5322.52, + teamId: 4295.56, pinned: true, parentId: "", - createdAt: "1709623896980", - updatedAt: "1735684166118", + createdAt: "1733236008688", + updatedAt: "1735617418007", }, recipients: [], fields: [], @@ -81,14 +79,15 @@ let value: TemplateCreateDocumentFromTemplateResponse = { | `authOptions` | [operations.TemplateCreateDocumentFromTemplateAuthOptions](../../models/operations/templatecreatedocumentfromtemplateauthoptions.md) | :heavy_check_mark: | N/A | | `formValues` | Record | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `documentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `completedAt` | *string* | :heavy_check_mark: | N/A | | `deletedAt` | *string* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | +| `documentDataId` | *string* | :heavy_minus_sign: | N/A | | `documentData` | [operations.TemplateCreateDocumentFromTemplateDocumentData](../../models/operations/templatecreatedocumentfromtemplatedocumentdata.md) | :heavy_check_mark: | N/A | | `documentMeta` | [operations.TemplateCreateDocumentFromTemplateDocumentMeta](../../models/operations/templatecreatedocumentfromtemplatedocumentmeta.md) | :heavy_check_mark: | N/A | | `folder` | [operations.TemplateCreateDocumentFromTemplateFolder](../../models/operations/templatecreatedocumentfromtemplatefolder.md) | :heavy_check_mark: | N/A | diff --git a/docs/models/operations/templatecreatetemplatedirectlinkresponse.md b/docs/models/operations/templatecreatetemplatedirectlinkresponse.md index 1b292e8e..060591d1 100644 --- a/docs/models/operations/templatecreatetemplatedirectlinkresponse.md +++ b/docs/models/operations/templatecreatetemplatedirectlinkresponse.md @@ -9,11 +9,12 @@ import { TemplateCreateTemplateDirectLinkResponse } from "@documenso/sdk-typescr let value: TemplateCreateTemplateDirectLinkResponse = { id: "", - templateId: 6033.47, token: "", - createdAt: "1722405330738", + createdAt: "1723180732501", enabled: false, - directTemplateRecipientId: 8025.23, + directTemplateRecipientId: 5620.96, + envelopeId: "", + templateId: 8025.23, }; ``` @@ -22,8 +23,9 @@ let value: TemplateCreateTemplateDirectLinkResponse = { | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `enabled` | *boolean* | :heavy_check_mark: | N/A | -| `directTemplateRecipientId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `directTemplateRecipientId` | *number* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporaryaccessauth.md b/docs/models/operations/templatecreatetemplatetemporaryaccessauth.md index 73f666fb..1d032471 100644 --- a/docs/models/operations/templatecreatetemplatetemporaryaccessauth.md +++ b/docs/models/operations/templatecreatetemplatetemporaryaccessauth.md @@ -13,5 +13,5 @@ let value: TemplateCreateTemplateTemporaryAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporaryauthoptions.md b/docs/models/operations/templatecreatetemplatetemporaryauthoptions.md index a8fbce74..3f9cf6eb 100644 --- a/docs/models/operations/templatecreatetemplatetemporaryauthoptions.md +++ b/docs/models/operations/templatecreatetemplatetemporaryauthoptions.md @@ -9,7 +9,9 @@ let value: TemplateCreateTemplateTemporaryAuthOptions = { globalAccessAuth: [ "ACCOUNT", ], - globalActionAuth: [], + globalActionAuth: [ + "PASSWORD", + ], }; ``` diff --git a/docs/models/operations/templatecreatetemplatetemporarydateformat.md b/docs/models/operations/templatecreatetemplatetemporarydateformat.md index 24e1765d..6bb7154a 100644 --- a/docs/models/operations/templatecreatetemplatetemporarydateformat.md +++ b/docs/models/operations/templatecreatetemplatetemporarydateformat.md @@ -7,11 +7,11 @@ The date format to use for date fields and signing the document. ```typescript import { TemplateCreateTemplateTemporaryDateFormat } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateCreateTemplateTemporaryDateFormat = "MM/dd/yyyy hh:mm a"; +let value: TemplateCreateTemplateTemporaryDateFormat = "dd/MM/yyyy hh:mm a"; ``` ## Values ```typescript -"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy hh:mm a" | "MM/dd/yyyy hh:mm a" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy hh:mm a" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" +"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy" | "MM/dd/yyyy" | "yy-MM-dd" | "MMMM dd, yyyy" | "EEEE, MMMM dd, yyyy" | "dd/MM/yyyy hh:mm a" | "dd/MM/yyyy HH:mm" | "MM/dd/yyyy hh:mm a" | "MM/dd/yyyy HH:mm" | "dd.MM.yyyy" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yy-MM-dd HH:mm" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "MMMM dd, yyyy HH:mm" | "EEEE, MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy HH:mm" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ``` \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporarydirectlink.md b/docs/models/operations/templatecreatetemplatetemporarydirectlink.md index 902c9b8f..43ada18c 100644 --- a/docs/models/operations/templatecreatetemplatetemporarydirectlink.md +++ b/docs/models/operations/templatecreatetemplatetemporarydirectlink.md @@ -7,11 +7,12 @@ import { TemplateCreateTemplateTemporaryDirectLink } from "@documenso/sdk-typesc let value: TemplateCreateTemplateTemporaryDirectLink = { id: "", - templateId: 4956.06, + envelopeId: "", token: "", - createdAt: "1712932663488", - enabled: false, - directTemplateRecipientId: 3396.23, + createdAt: "1719783018032", + enabled: true, + directTemplateRecipientId: 7235.8, + templateId: 3396.23, }; ``` @@ -20,8 +21,9 @@ let value: TemplateCreateTemplateTemporaryDirectLink = { | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `enabled` | *boolean* | :heavy_check_mark: | N/A | -| `directTemplateRecipientId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `directTemplateRecipientId` | *number* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporaryfield.md b/docs/models/operations/templatecreatetemplatetemporaryfield.md index 32eb9322..67e23792 100644 --- a/docs/models/operations/templatecreatetemplatetemporaryfield.md +++ b/docs/models/operations/templatecreatetemplatetemporaryfield.md @@ -6,17 +6,17 @@ import { TemplateCreateTemplateTemporaryField } from "@documenso/sdk-typescript/models/operations"; let value: TemplateCreateTemplateTemporaryField = { + envelopeId: "", + envelopeItemId: "", type: "INITIALS", id: 1895.75, secondaryId: "", - documentId: 9048.82, - templateId: 2241.51, - recipientId: 3206.92, - page: 3007.37, + recipientId: 1086.24, + page: 9048.82, customText: "", inserted: true, fieldMeta: { - type: "number", + type: "email", }, }; ``` @@ -25,11 +25,11 @@ let value: TemplateCreateTemplateTemporaryField = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.TemplateCreateTemplateTemporaryFieldType](../../models/operations/templatecreatetemplatetemporaryfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: TemplateCreateTemplateTemporaryField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.TemplateCreateTemplateTemporaryFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.TemplateCreateTemplateTemporaryFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporaryglobalaccessauthrequest.md b/docs/models/operations/templatecreatetemplatetemporaryglobalaccessauthrequest.md index 793f35ec..a56bac1f 100644 --- a/docs/models/operations/templatecreatetemplatetemporaryglobalaccessauthrequest.md +++ b/docs/models/operations/templatecreatetemplatetemporaryglobalaccessauthrequest.md @@ -13,5 +13,5 @@ let value: TemplateCreateTemplateTemporaryGlobalAccessAuthRequest = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporaryglobalaccessauthresponse.md b/docs/models/operations/templatecreatetemplatetemporaryglobalaccessauthresponse.md index db590592..70cc2cf5 100644 --- a/docs/models/operations/templatecreatetemplatetemporaryglobalaccessauthresponse.md +++ b/docs/models/operations/templatecreatetemplatetemporaryglobalaccessauthresponse.md @@ -7,11 +7,12 @@ The type of authentication required for the recipient to access the document. ```typescript import { TemplateCreateTemplateTemporaryGlobalAccessAuthResponse } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateCreateTemplateTemporaryGlobalAccessAuthResponse = "ACCOUNT"; +let value: TemplateCreateTemplateTemporaryGlobalAccessAuthResponse = + "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporaryrecipient.md b/docs/models/operations/templatecreatetemplatetemporaryrecipient.md index 23eea341..88700140 100644 --- a/docs/models/operations/templatecreatetemplatetemporaryrecipient.md +++ b/docs/models/operations/templatecreatetemplatetemporaryrecipient.md @@ -6,26 +6,23 @@ import { TemplateCreateTemplateTemporaryRecipient } from "@documenso/sdk-typescript/models/operations"; let value: TemplateCreateTemplateTemporaryRecipient = { + envelopeId: "", role: "VIEWER", readStatus: "NOT_OPENED", signingStatus: "SIGNED", sendStatus: "NOT_SENT", id: 9949.48, - documentId: 8760.41, - templateId: 902.04, - email: "Vinnie_Runte@yahoo.com", + email: "Selena_Borer96@hotmail.com", name: "", token: "", - documentDeletedAt: null, + documentDeletedAt: "", expired: "", signedAt: "", authOptions: { accessAuth: [], - actionAuth: [ - "PASSKEY", - ], + actionAuth: [], }, - signingOrder: 9560.13, + signingOrder: 9462.32, rejectionReason: "", }; ``` @@ -34,13 +31,12 @@ let value: TemplateCreateTemplateTemporaryRecipient = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.TemplateCreateTemplateTemporaryRole](../../models/operations/templatecreatetemplatetemporaryrole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.TemplateCreateTemplateTemporaryReadStatus](../../models/operations/templatecreatetemplatetemporaryreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.TemplateCreateTemplateTemporarySigningStatus](../../models/operations/templatecreatetemplatetemporarysigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.TemplateCreateTemplateTemporarySendStatus](../../models/operations/templatecreatetemplatetemporarysendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -49,4 +45,6 @@ let value: TemplateCreateTemplateTemporaryRecipient = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateCreateTemplateTemporaryRecipientAuthOptions](../../models/operations/templatecreatetemplatetemporaryrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporaryresponse.md b/docs/models/operations/templatecreatetemplatetemporaryresponse.md index fab67e40..ba7a34bf 100644 --- a/docs/models/operations/templatecreatetemplatetemporaryresponse.md +++ b/docs/models/operations/templatecreatetemplatetemporaryresponse.md @@ -20,65 +20,75 @@ let value: TemplateCreateTemplateTemporaryResponse = { globalAccessAuth: [], globalActionAuth: [], }, - templateDocumentDataId: "", createdAt: "1735365426728", updatedAt: "1735677554870", publicTitle: "", publicDescription: "", folderId: "", + envelopeId: "", templateDocumentData: { type: "S3_PATH", id: "", data: "", initialData: "", + envelopeItemId: "", + }, + templateMeta: { + id: "", + subject: "", + message: "", + timezone: "America/Anchorage", + dateFormat: "", + signingOrder: "PARALLEL", + typedSignatureEnabled: false, + uploadSignatureEnabled: true, + drawSignatureEnabled: false, + allowDictateNextSigner: false, + distributionMethod: "EMAIL", + redirectUrl: "https://awesome-jellyfish.org", + language: "", + emailSettings: {}, + emailId: "", + emailReplyTo: null, + templateId: 6491.25, }, - templateMeta: null, directLink: null, user: { - id: 2012.56, + id: 7492.04, name: "", - email: "Domenica.DuBuque@hotmail.com", + email: "Rosina27@hotmail.com", }, - recipients: [ + recipients: [], + fields: [ { - role: "ASSISTANT", - readStatus: "OPENED", - signingStatus: "SIGNED", - sendStatus: "NOT_SENT", - id: 1921.91, - documentId: 8540.85, - templateId: null, - email: "Bernard_Sipes@hotmail.com", - name: "", - token: "", - documentDeletedAt: "", - expired: "", - signedAt: "", - authOptions: { - accessAuth: [], - actionAuth: [ - "PASSKEY", - ], + envelopeId: "", + envelopeItemId: "", + type: "FREE_SIGNATURE", + id: 3408.88, + secondaryId: "", + recipientId: 6489.9, + page: 9528.83, + customText: "", + inserted: false, + fieldMeta: { + type: "text", }, - signingOrder: 135.48, - rejectionReason: null, }, ], - fields: [], folder: { id: "", name: "", type: "DOCUMENT", - visibility: "ADMIN", - userId: 9120.37, - teamId: 5757.17, + visibility: "EVERYONE", + userId: 2470.86, + teamId: 8054.81, pinned: true, - parentId: null, - createdAt: "1729360187536", - updatedAt: "1735634686334", + parentId: "", + createdAt: "1732915599752", + updatedAt: "1735652941400", }, }, - uploadUrl: "https://well-groomed-sermon.org", + uploadUrl: "https://huge-toaster.biz", }; ``` diff --git a/docs/models/operations/templatecreatetemplatetemporarytemplatedocumentdata.md b/docs/models/operations/templatecreatetemplatetemporarytemplatedocumentdata.md index b5ec2d50..aa8b2d0a 100644 --- a/docs/models/operations/templatecreatetemplatetemporarytemplatedocumentdata.md +++ b/docs/models/operations/templatecreatetemplatetemporarytemplatedocumentdata.md @@ -10,6 +10,7 @@ let value: TemplateCreateTemplateTemporaryTemplateDocumentData = { id: "", data: "", initialData: "", + envelopeItemId: "", }; ``` @@ -20,4 +21,5 @@ let value: TemplateCreateTemplateTemporaryTemplateDocumentData = { | `type` | [operations.TemplateCreateTemplateTemporaryTemplateDocumentDataType](../../models/operations/templatecreatetemplatetemporarytemplatedocumentdatatype.md) | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `data` | *string* | :heavy_check_mark: | N/A | -| `initialData` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `initialData` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatetemporarytemplatemeta.md b/docs/models/operations/templatecreatetemplatetemporarytemplatemeta.md index 3a9b2118..0f14a69f 100644 --- a/docs/models/operations/templatecreatetemplatetemporarytemplatemeta.md +++ b/docs/models/operations/templatecreatetemplatetemporarytemplatemeta.md @@ -11,18 +11,18 @@ let value: TemplateCreateTemplateTemporaryTemplateMeta = { message: "", timezone: "Europe/Paris", dateFormat: "", - signingOrder: "PARALLEL", - typedSignatureEnabled: false, - uploadSignatureEnabled: true, + signingOrder: "SEQUENTIAL", + typedSignatureEnabled: true, + uploadSignatureEnabled: false, drawSignatureEnabled: true, allowDictateNextSigner: true, distributionMethod: "EMAIL", - templateId: 3470.83, - redirectUrl: "https://better-overcoat.org/", + redirectUrl: "https://sparse-disappointment.com/", language: "", - emailSettings: null, - emailId: null, - emailReplyTo: "", + emailSettings: {}, + emailId: "", + emailReplyTo: null, + templateId: null, }; ``` @@ -41,9 +41,9 @@ let value: TemplateCreateTemplateTemporaryTemplateMeta = { | `drawSignatureEnabled` | *boolean* | :heavy_check_mark: | N/A | | `allowDictateNextSigner` | *boolean* | :heavy_check_mark: | N/A | | `distributionMethod` | [operations.TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod](../../models/operations/templatecreatetemplatetemporarytemplatemetadistributionmethod.md) | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `redirectUrl` | *string* | :heavy_check_mark: | N/A | | `language` | *string* | :heavy_check_mark: | N/A | | `emailSettings` | [operations.TemplateCreateTemplateTemporaryTemplateMetaEmailSettings](../../models/operations/templatecreatetemplatetemporarytemplatemetaemailsettings.md) | :heavy_check_mark: | N/A | | `emailId` | *string* | :heavy_check_mark: | N/A | -| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templateduplicatetemplateauthoptions.md b/docs/models/operations/templateduplicatetemplateauthoptions.md index 66df681f..c5273741 100644 --- a/docs/models/operations/templateduplicatetemplateauthoptions.md +++ b/docs/models/operations/templateduplicatetemplateauthoptions.md @@ -9,7 +9,9 @@ let value: TemplateDuplicateTemplateAuthOptions = { globalAccessAuth: [ "ACCOUNT", ], - globalActionAuth: [], + globalActionAuth: [ + "ACCOUNT", + ], }; ``` diff --git a/docs/models/operations/templateduplicatetemplateglobalaccessauth.md b/docs/models/operations/templateduplicatetemplateglobalaccessauth.md index e79ec3c8..87d5a408 100644 --- a/docs/models/operations/templateduplicatetemplateglobalaccessauth.md +++ b/docs/models/operations/templateduplicatetemplateglobalaccessauth.md @@ -13,5 +13,5 @@ let value: TemplateDuplicateTemplateGlobalAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templateduplicatetemplateresponse.md b/docs/models/operations/templateduplicatetemplateresponse.md index ce0800c2..5506c346 100644 --- a/docs/models/operations/templateduplicatetemplateresponse.md +++ b/docs/models/operations/templateduplicatetemplateresponse.md @@ -21,13 +21,13 @@ let value: TemplateDuplicateTemplateResponse = { "PASSWORD", ], }, - templateDocumentDataId: "", createdAt: "1733976405841", updatedAt: "1735649842067", publicTitle: "", publicDescription: "", folderId: "", useLegacyFieldInsertion: false, + envelopeId: "", }; ``` @@ -43,10 +43,11 @@ let value: TemplateDuplicateTemplateResponse = { | `userId` | *number* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateDuplicateTemplateAuthOptions](../../models/operations/templateduplicatetemplateauthoptions.md) | :heavy_check_mark: | N/A | -| `templateDocumentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `publicTitle` | *string* | :heavy_check_mark: | N/A | | `publicDescription` | *string* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | -| `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateDocumentDataId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatefindtemplatesaccessauth.md b/docs/models/operations/templatefindtemplatesaccessauth.md index 4dbe7bf8..fa6cd782 100644 --- a/docs/models/operations/templatefindtemplatesaccessauth.md +++ b/docs/models/operations/templatefindtemplatesaccessauth.md @@ -13,5 +13,5 @@ let value: TemplateFindTemplatesAccessAuth = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templatefindtemplatesdata.md b/docs/models/operations/templatefindtemplatesdata.md index 7d09c564..eeb2b2f0 100644 --- a/docs/models/operations/templatefindtemplatesdata.md +++ b/docs/models/operations/templatefindtemplatesdata.md @@ -14,13 +14,13 @@ let value: TemplateFindTemplatesData = { userId: 3295.89, teamId: 5651.61, authOptions: null, - templateDocumentDataId: "", createdAt: "1713144859293", updatedAt: "1735674350045", publicTitle: "", publicDescription: "", folderId: "", useLegacyFieldInsertion: false, + envelopeId: "", team: { id: 1814.63, url: "https://insecure-pharmacopoeia.name", @@ -33,7 +33,7 @@ let value: TemplateFindTemplatesData = { }, directLink: { token: "", - enabled: true, + enabled: false, }, }; ``` @@ -50,15 +50,16 @@ let value: TemplateFindTemplatesData = { | `userId` | *number* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateFindTemplatesAuthOptions](../../models/operations/templatefindtemplatesauthoptions.md) | :heavy_check_mark: | N/A | -| `templateDocumentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `publicTitle` | *string* | :heavy_check_mark: | N/A | | `publicDescription` | *string* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | | `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `team` | [operations.TemplateFindTemplatesTeam](../../models/operations/templatefindtemplatesteam.md) | :heavy_check_mark: | N/A | | `fields` | [operations.TemplateFindTemplatesField](../../models/operations/templatefindtemplatesfield.md)[] | :heavy_check_mark: | N/A | | `recipients` | [operations.TemplateFindTemplatesRecipient](../../models/operations/templatefindtemplatesrecipient.md)[] | :heavy_check_mark: | N/A | | `templateMeta` | [operations.TemplateFindTemplatesTemplateMeta](../../models/operations/templatefindtemplatestemplatemeta.md) | :heavy_check_mark: | N/A | -| `directLink` | [operations.TemplateFindTemplatesDirectLink](../../models/operations/templatefindtemplatesdirectlink.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `directLink` | [operations.TemplateFindTemplatesDirectLink](../../models/operations/templatefindtemplatesdirectlink.md) | :heavy_check_mark: | N/A | +| `templateDocumentDataId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatefindtemplatesfield.md b/docs/models/operations/templatefindtemplatesfield.md index 2f01ccc5..4f2c7dfd 100644 --- a/docs/models/operations/templatefindtemplatesfield.md +++ b/docs/models/operations/templatefindtemplatesfield.md @@ -6,16 +6,18 @@ import { TemplateFindTemplatesField } from "@documenso/sdk-typescript/models/operations"; let value: TemplateFindTemplatesField = { + envelopeId: "", + envelopeItemId: "", type: "DATE", id: 7270, secondaryId: "", - documentId: 3090.81, - templateId: 8529.11, - recipientId: 3354.67, - page: 6148.64, + recipientId: 1138.27, + page: 3090.81, customText: "", inserted: false, - fieldMeta: null, + fieldMeta: { + type: "date", + }, }; ``` @@ -23,11 +25,11 @@ let value: TemplateFindTemplatesField = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.TemplateFindTemplatesFieldType](../../models/operations/templatefindtemplatesfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -36,4 +38,6 @@ let value: TemplateFindTemplatesField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.TemplateFindTemplatesFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.TemplateFindTemplatesFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatefindtemplatesglobalaccessauth.md b/docs/models/operations/templatefindtemplatesglobalaccessauth.md index 6d04f6ab..d0d4e356 100644 --- a/docs/models/operations/templatefindtemplatesglobalaccessauth.md +++ b/docs/models/operations/templatefindtemplatesglobalaccessauth.md @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document. ```typescript import { TemplateFindTemplatesGlobalAccessAuth } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateFindTemplatesGlobalAccessAuth = "ACCOUNT"; +let value: TemplateFindTemplatesGlobalAccessAuth = "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templatefindtemplatesrecipient.md b/docs/models/operations/templatefindtemplatesrecipient.md index 5849b711..cebbde76 100644 --- a/docs/models/operations/templatefindtemplatesrecipient.md +++ b/docs/models/operations/templatefindtemplatesrecipient.md @@ -6,26 +6,27 @@ import { TemplateFindTemplatesRecipient } from "@documenso/sdk-typescript/models/operations"; let value: TemplateFindTemplatesRecipient = { + envelopeId: "", role: "VIEWER", readStatus: "OPENED", signingStatus: "REJECTED", sendStatus: "SENT", id: 1377.33, - documentId: 8929.31, - templateId: 1915.13, - email: "Haylie_Mante80@yahoo.com", + email: "Sister.Dicki@gmail.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", authOptions: { - accessAuth: [], + accessAuth: [ + "TWO_FACTOR_AUTH", + ], actionAuth: [ "EXPLICIT_NONE", ], }, - signingOrder: 1069.41, + signingOrder: 6149.7, rejectionReason: "", }; ``` @@ -34,13 +35,12 @@ let value: TemplateFindTemplatesRecipient = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.TemplateFindTemplatesRole](../../models/operations/templatefindtemplatesrole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.TemplateFindTemplatesReadStatus](../../models/operations/templatefindtemplatesreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.TemplateFindTemplatesSigningStatus](../../models/operations/templatefindtemplatessigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.TemplateFindTemplatesSendStatus](../../models/operations/templatefindtemplatessendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -49,4 +49,6 @@ let value: TemplateFindTemplatesRecipient = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateFindTemplatesRecipientAuthOptions](../../models/operations/templatefindtemplatesrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatefindtemplatesrecipientauthoptions.md b/docs/models/operations/templatefindtemplatesrecipientauthoptions.md index 0c7bc83d..681b8e16 100644 --- a/docs/models/operations/templatefindtemplatesrecipientauthoptions.md +++ b/docs/models/operations/templatefindtemplatesrecipientauthoptions.md @@ -7,11 +7,9 @@ import { TemplateFindTemplatesRecipientAuthOptions } from "@documenso/sdk-typesc let value: TemplateFindTemplatesRecipientAuthOptions = { accessAuth: [ - "ACCOUNT", - ], - actionAuth: [ "TWO_FACTOR_AUTH", ], + actionAuth: [], }; ``` diff --git a/docs/models/operations/templatefindtemplatestemplatemeta.md b/docs/models/operations/templatefindtemplatestemplatemeta.md index 9c0f575d..02f74bcd 100644 --- a/docs/models/operations/templatefindtemplatestemplatemeta.md +++ b/docs/models/operations/templatefindtemplatestemplatemeta.md @@ -6,7 +6,7 @@ import { TemplateFindTemplatesTemplateMeta } from "@documenso/sdk-typescript/models/operations"; let value: TemplateFindTemplatesTemplateMeta = { - signingOrder: null, + signingOrder: "PARALLEL", distributionMethod: "NONE", }; ``` diff --git a/docs/models/operations/templategettemplatebyidaccessauth.md b/docs/models/operations/templategettemplatebyidaccessauth.md index e12e47e7..aa0106c1 100644 --- a/docs/models/operations/templategettemplatebyidaccessauth.md +++ b/docs/models/operations/templategettemplatebyidaccessauth.md @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document. ```typescript import { TemplateGetTemplateByIdAccessAuth } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateGetTemplateByIdAccessAuth = "ACCOUNT"; +let value: TemplateGetTemplateByIdAccessAuth = "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyiddirectlink.md b/docs/models/operations/templategettemplatebyiddirectlink.md index c2b37a90..add3803d 100644 --- a/docs/models/operations/templategettemplatebyiddirectlink.md +++ b/docs/models/operations/templategettemplatebyiddirectlink.md @@ -7,11 +7,12 @@ import { TemplateGetTemplateByIdDirectLink } from "@documenso/sdk-typescript/mod let value: TemplateGetTemplateByIdDirectLink = { id: "", - templateId: 4516.97, + envelopeId: "", token: "", - createdAt: "1715402496227", + createdAt: "1718398304435", enabled: true, - directTemplateRecipientId: 3184.27, + directTemplateRecipientId: 3461.72, + templateId: 3184.27, }; ``` @@ -20,8 +21,9 @@ let value: TemplateGetTemplateByIdDirectLink = { | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `enabled` | *boolean* | :heavy_check_mark: | N/A | -| `directTemplateRecipientId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `directTemplateRecipientId` | *number* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyidfield.md b/docs/models/operations/templategettemplatebyidfield.md index 92bf4305..a71b6349 100644 --- a/docs/models/operations/templategettemplatebyidfield.md +++ b/docs/models/operations/templategettemplatebyidfield.md @@ -6,17 +6,17 @@ import { TemplateGetTemplateByIdField } from "@documenso/sdk-typescript/models/operations"; let value: TemplateGetTemplateByIdField = { + envelopeId: "", + envelopeItemId: "", type: "CHECKBOX", id: 9718.06, secondaryId: "", - documentId: 7559.54, - templateId: 5207.36, - recipientId: 2803.38, - page: 9949.9, + recipientId: 7520.74, + page: 7559.54, customText: "", - inserted: true, + inserted: false, fieldMeta: { - type: "dropdown", + type: "email", }, }; ``` @@ -25,11 +25,11 @@ let value: TemplateGetTemplateByIdField = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | | `type` | [operations.TemplateGetTemplateByIdFieldType](../../models/operations/templategettemplatebyidfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | | `secondaryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `recipientId` | *number* | :heavy_check_mark: | N/A | | `page` | *number* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `positionX` | *any* | :heavy_minus_sign: | N/A | @@ -38,4 +38,6 @@ let value: TemplateGetTemplateByIdField = { | `height` | *any* | :heavy_minus_sign: | N/A | | `customText` | *string* | :heavy_check_mark: | N/A | | `inserted` | *boolean* | :heavy_check_mark: | N/A | -| `fieldMeta` | *operations.TemplateGetTemplateByIdFieldMetaUnion* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fieldMeta` | *operations.TemplateGetTemplateByIdFieldMetaUnion* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyidglobalaccessauth.md b/docs/models/operations/templategettemplatebyidglobalaccessauth.md index e92dec0c..71ec1f20 100644 --- a/docs/models/operations/templategettemplatebyidglobalaccessauth.md +++ b/docs/models/operations/templategettemplatebyidglobalaccessauth.md @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document. ```typescript import { TemplateGetTemplateByIdGlobalAccessAuth } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateGetTemplateByIdGlobalAccessAuth = "ACCOUNT"; +let value: TemplateGetTemplateByIdGlobalAccessAuth = "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyidrecipient.md b/docs/models/operations/templategettemplatebyidrecipient.md index 4a5530f1..787b31c1 100644 --- a/docs/models/operations/templategettemplatebyidrecipient.md +++ b/docs/models/operations/templategettemplatebyidrecipient.md @@ -6,26 +6,25 @@ import { TemplateGetTemplateByIdRecipient } from "@documenso/sdk-typescript/models/operations"; let value: TemplateGetTemplateByIdRecipient = { + envelopeId: "", role: "CC", readStatus: "NOT_OPENED", signingStatus: "NOT_SIGNED", sendStatus: "SENT", id: 9979.58, - documentId: 9567.96, - templateId: 1045.43, - email: "Dannie.Kuhn@gmail.com", + email: "Verna.Braun@hotmail.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", authOptions: { - accessAuth: [], - actionAuth: [ - "EXPLICIT_NONE", + accessAuth: [ + "ACCOUNT", ], + actionAuth: [], }, - signingOrder: 6573.86, + signingOrder: 4856.49, rejectionReason: "", }; ``` @@ -34,13 +33,12 @@ let value: TemplateGetTemplateByIdRecipient = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | | `role` | [operations.TemplateGetTemplateByIdRole](../../models/operations/templategettemplatebyidrole.md) | :heavy_check_mark: | N/A | | `readStatus` | [operations.TemplateGetTemplateByIdReadStatus](../../models/operations/templategettemplatebyidreadstatus.md) | :heavy_check_mark: | N/A | | `signingStatus` | [operations.TemplateGetTemplateByIdSigningStatus](../../models/operations/templategettemplatebyidsigningstatus.md) | :heavy_check_mark: | N/A | | `sendStatus` | [operations.TemplateGetTemplateByIdSendStatus](../../models/operations/templategettemplatebyidsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *number* | :heavy_check_mark: | N/A | -| `documentId` | *number* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | @@ -49,4 +47,6 @@ let value: TemplateGetTemplateByIdRecipient = { | `signedAt` | *string* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateGetTemplateByIdRecipientAuthOptions](../../models/operations/templategettemplatebyidrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signingOrder` | *number* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejectionReason` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejectionReason` | *string* | :heavy_check_mark: | N/A | +| `documentId` | *number* | :heavy_minus_sign: | N/A | +| `templateId` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyidresponse.md b/docs/models/operations/templategettemplatebyidresponse.md index 7bed9502..08ee4cb8 100644 --- a/docs/models/operations/templategettemplatebyidresponse.md +++ b/docs/models/operations/templategettemplatebyidresponse.md @@ -17,78 +17,72 @@ let value: TemplateGetTemplateByIdResponse = { teamId: 5309.8, authOptions: { globalAccessAuth: [ - "ACCOUNT", - ], - globalActionAuth: [ - "PASSKEY", + "TWO_FACTOR_AUTH", ], + globalActionAuth: [], }, - templateDocumentDataId: "", createdAt: "1723877045893", updatedAt: "1735638161284", publicTitle: "", publicDescription: "", folderId: "", + envelopeId: "", templateDocumentData: { type: "BYTES_64", id: "", data: "", initialData: "", + envelopeItemId: "", }, templateMeta: { id: "", subject: "", - message: null, - timezone: "America/Scoresbysund", + message: "", + timezone: null, dateFormat: "", - signingOrder: "SEQUENTIAL", + signingOrder: "PARALLEL", typedSignatureEnabled: false, uploadSignatureEnabled: true, drawSignatureEnabled: false, allowDictateNextSigner: false, distributionMethod: "EMAIL", - templateId: 8228.41, - redirectUrl: "https://descriptive-grandson.com/", + redirectUrl: "https://clean-slipper.info", language: "", - emailSettings: {}, + emailSettings: null, emailId: "", emailReplyTo: "", + templateId: 6456.18, }, directLink: { id: "", - templateId: 9058.72, + envelopeId: "", token: "", - createdAt: "1706660459834", + createdAt: "1728004754117", enabled: true, - directTemplateRecipientId: 691.67, + directTemplateRecipientId: 9058.72, + templateId: 794.92, }, user: { - id: 6866.29, - name: "", - email: "Wilton_Koelpin83@gmail.com", + id: 1979.33, + name: null, + email: "Roselyn45@hotmail.com", }, recipients: [ { - role: "APPROVER", + envelopeId: "", + role: "CC", readStatus: "OPENED", - signingStatus: "REJECTED", - sendStatus: "NOT_SENT", - id: 7854.52, - documentId: 3886.16, - templateId: 359.79, - email: "Roman.Koelpin@hotmail.com", + signingStatus: "SIGNED", + sendStatus: "SENT", + id: 8719, + email: "Pablo3@yahoo.com", name: "", token: "", documentDeletedAt: "", expired: "", signedAt: "", - authOptions: { - accessAuth: [], - actionAuth: [ - "EXPLICIT_NONE", - ], - }, - signingOrder: 7521.2, + authOptions: null, + signingOrder: 3803.25, rejectionReason: "", }, ], @@ -96,14 +90,14 @@ let value: TemplateGetTemplateByIdResponse = { folder: { id: "", name: "", - type: "TEMPLATE", - visibility: "MANAGER_AND_ABOVE", - userId: 604.34, - teamId: 5592.12, - pinned: false, + type: "DOCUMENT", + visibility: "EVERYONE", + userId: 7521.2, + teamId: 4101.26, + pinned: true, parentId: "", - createdAt: "1712996151462", - updatedAt: "1735637856379", + createdAt: "1722500604046", + updatedAt: "1735660534658", }, }; ``` @@ -120,12 +114,13 @@ let value: TemplateGetTemplateByIdResponse = { | `userId` | *number* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateGetTemplateByIdAuthOptions](../../models/operations/templategettemplatebyidauthoptions.md) | :heavy_check_mark: | N/A | -| `templateDocumentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `publicTitle` | *string* | :heavy_check_mark: | N/A | | `publicDescription` | *string* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateDocumentDataId` | *string* | :heavy_minus_sign: | N/A | | `templateDocumentData` | [operations.TemplateGetTemplateByIdTemplateDocumentData](../../models/operations/templategettemplatebyidtemplatedocumentdata.md) | :heavy_check_mark: | N/A | | `templateMeta` | [operations.TemplateGetTemplateByIdTemplateMeta](../../models/operations/templategettemplatebyidtemplatemeta.md) | :heavy_check_mark: | N/A | | `directLink` | [operations.TemplateGetTemplateByIdDirectLink](../../models/operations/templategettemplatebyiddirectlink.md) | :heavy_check_mark: | N/A | diff --git a/docs/models/operations/templategettemplatebyidtemplatedocumentdata.md b/docs/models/operations/templategettemplatebyidtemplatedocumentdata.md index 090c8400..a2dbc54f 100644 --- a/docs/models/operations/templategettemplatebyidtemplatedocumentdata.md +++ b/docs/models/operations/templategettemplatebyidtemplatedocumentdata.md @@ -10,6 +10,7 @@ let value: TemplateGetTemplateByIdTemplateDocumentData = { id: "", data: "", initialData: "", + envelopeItemId: "", }; ``` @@ -20,4 +21,5 @@ let value: TemplateGetTemplateByIdTemplateDocumentData = { | `type` | [operations.TemplateGetTemplateByIdTemplateDocumentDataType](../../models/operations/templategettemplatebyidtemplatedocumentdatatype.md) | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `data` | *string* | :heavy_check_mark: | N/A | -| `initialData` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `initialData` | *string* | :heavy_check_mark: | N/A | +| `envelopeItemId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyidtemplatemeta.md b/docs/models/operations/templategettemplatebyidtemplatemeta.md index 19c8a546..889f6a42 100644 --- a/docs/models/operations/templategettemplatebyidtemplatemeta.md +++ b/docs/models/operations/templategettemplatebyidtemplatemeta.md @@ -13,16 +13,16 @@ let value: TemplateGetTemplateByIdTemplateMeta = { dateFormat: "", signingOrder: "PARALLEL", typedSignatureEnabled: true, - uploadSignatureEnabled: false, - drawSignatureEnabled: true, - allowDictateNextSigner: false, + uploadSignatureEnabled: true, + drawSignatureEnabled: false, + allowDictateNextSigner: true, distributionMethod: "NONE", - templateId: 7473.54, - redirectUrl: "https://boiling-skeleton.name", + redirectUrl: "https://outlying-wombat.com", language: "", - emailSettings: null, + emailSettings: {}, emailId: "", emailReplyTo: null, + templateId: 998.6, }; ``` @@ -41,9 +41,9 @@ let value: TemplateGetTemplateByIdTemplateMeta = { | `drawSignatureEnabled` | *boolean* | :heavy_check_mark: | N/A | | `allowDictateNextSigner` | *boolean* | :heavy_check_mark: | N/A | | `distributionMethod` | [operations.TemplateGetTemplateByIdDistributionMethod](../../models/operations/templategettemplatebyiddistributionmethod.md) | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `redirectUrl` | *string* | :heavy_check_mark: | N/A | | `language` | *string* | :heavy_check_mark: | N/A | | `emailSettings` | [operations.TemplateGetTemplateByIdEmailSettings](../../models/operations/templategettemplatebyidemailsettings.md) | :heavy_check_mark: | N/A | | `emailId` | *string* | :heavy_check_mark: | N/A | -| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `emailReplyTo` | *string* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatetoggletemplatedirectlinkresponse.md b/docs/models/operations/templatetoggletemplatedirectlinkresponse.md index 950d6ed8..84242315 100644 --- a/docs/models/operations/templatetoggletemplatedirectlinkresponse.md +++ b/docs/models/operations/templatetoggletemplatedirectlinkresponse.md @@ -9,11 +9,12 @@ import { TemplateToggleTemplateDirectLinkResponse } from "@documenso/sdk-typescr let value: TemplateToggleTemplateDirectLinkResponse = { id: "", - templateId: 2293.94, token: "", - createdAt: "1705244607010", - enabled: false, - directTemplateRecipientId: 8689.94, + createdAt: "1711387768661", + enabled: true, + directTemplateRecipientId: 8974.33, + envelopeId: "", + templateId: 8689.94, }; ``` @@ -22,8 +23,9 @@ let value: TemplateToggleTemplateDirectLinkResponse = { | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `templateId` | *number* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `enabled` | *boolean* | :heavy_check_mark: | N/A | -| `directTemplateRecipientId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `directTemplateRecipientId` | *number* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templateupdatetemplateauthoptions.md b/docs/models/operations/templateupdatetemplateauthoptions.md index 7fa8b107..3f597f0f 100644 --- a/docs/models/operations/templateupdatetemplateauthoptions.md +++ b/docs/models/operations/templateupdatetemplateauthoptions.md @@ -9,7 +9,9 @@ let value: TemplateUpdateTemplateAuthOptions = { globalAccessAuth: [ "ACCOUNT", ], - globalActionAuth: [], + globalActionAuth: [ + "PASSKEY", + ], }; ``` diff --git a/docs/models/operations/templateupdatetemplatedata.md b/docs/models/operations/templateupdatetemplatedata.md index 2e47ff45..3a7d0c16 100644 --- a/docs/models/operations/templateupdatetemplatedata.md +++ b/docs/models/operations/templateupdatetemplatedata.md @@ -20,4 +20,5 @@ let value: TemplateUpdateTemplateData = {}; | `publicTitle` | *string* | :heavy_minus_sign: | The title of the template that will be displayed to the public. Only applicable for public templates. | | `publicDescription` | *string* | :heavy_minus_sign: | The description of the template that will be displayed to the public. Only applicable for public templates. | | `type` | [operations.TemplateUpdateTemplateDataType](../../models/operations/templateupdatetemplatedatatype.md) | :heavy_minus_sign: | N/A | -| `useLegacyFieldInsertion` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `useLegacyFieldInsertion` | *boolean* | :heavy_minus_sign: | N/A | +| `folderId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templateupdatetemplatedateformat.md b/docs/models/operations/templateupdatetemplatedateformat.md index f2505aba..ce1a3152 100644 --- a/docs/models/operations/templateupdatetemplatedateformat.md +++ b/docs/models/operations/templateupdatetemplatedateformat.md @@ -7,11 +7,11 @@ The date format to use for date fields and signing the document. ```typescript import { TemplateUpdateTemplateDateFormat } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateUpdateTemplateDateFormat = "MMMM dd, yyyy hh:mm a"; +let value: TemplateUpdateTemplateDateFormat = "yyyy-MM-dd HH:mm:ss"; ``` ## Values ```typescript -"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy hh:mm a" | "MM/dd/yyyy hh:mm a" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy hh:mm a" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" +"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy" | "MM/dd/yyyy" | "yy-MM-dd" | "MMMM dd, yyyy" | "EEEE, MMMM dd, yyyy" | "dd/MM/yyyy hh:mm a" | "dd/MM/yyyy HH:mm" | "MM/dd/yyyy hh:mm a" | "MM/dd/yyyy HH:mm" | "dd.MM.yyyy" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yy-MM-dd HH:mm" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "MMMM dd, yyyy HH:mm" | "EEEE, MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy HH:mm" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ``` \ No newline at end of file diff --git a/docs/models/operations/templateupdatetemplateglobalaccessauthrequest.md b/docs/models/operations/templateupdatetemplateglobalaccessauthrequest.md index 8a04a730..7a5c3f79 100644 --- a/docs/models/operations/templateupdatetemplateglobalaccessauthrequest.md +++ b/docs/models/operations/templateupdatetemplateglobalaccessauthrequest.md @@ -13,5 +13,5 @@ let value: TemplateUpdateTemplateGlobalAccessAuthRequest = "ACCOUNT"; ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templateupdatetemplateglobalaccessauthresponse.md b/docs/models/operations/templateupdatetemplateglobalaccessauthresponse.md index 9e6aac2b..4a5c92b7 100644 --- a/docs/models/operations/templateupdatetemplateglobalaccessauthresponse.md +++ b/docs/models/operations/templateupdatetemplateglobalaccessauthresponse.md @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document. ```typescript import { TemplateUpdateTemplateGlobalAccessAuthResponse } from "@documenso/sdk-typescript/models/operations"; -let value: TemplateUpdateTemplateGlobalAccessAuthResponse = "ACCOUNT"; +let value: TemplateUpdateTemplateGlobalAccessAuthResponse = "TWO_FACTOR_AUTH"; ``` ## Values ```typescript -"ACCOUNT" +"ACCOUNT" | "TWO_FACTOR_AUTH" ``` \ No newline at end of file diff --git a/docs/models/operations/templateupdatetemplateresponse.md b/docs/models/operations/templateupdatetemplateresponse.md index f64c939e..869061e9 100644 --- a/docs/models/operations/templateupdatetemplateresponse.md +++ b/docs/models/operations/templateupdatetemplateresponse.md @@ -16,13 +16,13 @@ let value: TemplateUpdateTemplateResponse = { userId: 9635.03, teamId: 8537.95, authOptions: null, - templateDocumentDataId: "", createdAt: "1717372713880", updatedAt: "1735666211656", publicTitle: "", publicDescription: "", folderId: "", useLegacyFieldInsertion: false, + envelopeId: "", }; ``` @@ -38,10 +38,11 @@ let value: TemplateUpdateTemplateResponse = { | `userId` | *number* | :heavy_check_mark: | N/A | | `teamId` | *number* | :heavy_check_mark: | N/A | | `authOptions` | [operations.TemplateUpdateTemplateAuthOptions](../../models/operations/templateupdatetemplateauthoptions.md) | :heavy_check_mark: | N/A | -| `templateDocumentDataId` | *string* | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | `publicTitle` | *string* | :heavy_check_mark: | N/A | | `publicDescription` | *string* | :heavy_check_mark: | N/A | | `folderId` | *string* | :heavy_check_mark: | N/A | -| `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `useLegacyFieldInsertion` | *boolean* | :heavy_check_mark: | N/A | +| `envelopeId` | *string* | :heavy_check_mark: | N/A | +| `templateDocumentDataId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdks/documenso/README.md b/docs/sdks/documenso/README.md deleted file mode 100644 index 1a7081fc..00000000 --- a/docs/sdks/documenso/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Documenso SDK - -## Overview - -Documenso v2 beta API: Subject to breaking changes until v2 is fully released. - -### Available Operations diff --git a/examples/.env.template b/examples/.env.template index f2ca3c27..33eefbf2 100644 --- a/examples/.env.template +++ b/examples/.env.template @@ -11,4 +11,4 @@ DOCUMENSO_API_KEY=your_apikey_here # Debug Configuration # Enable HTTP request/response logging for debugging -DOCUMENSO_DEBUG=false +DOCUMENSO_DEBUG=true diff --git a/examples/documentsGet.example.ts b/examples/documentsGet.example.ts index 79e194a2..bc4d5654 100644 --- a/examples/documentsGet.example.ts +++ b/examples/documentsGet.example.ts @@ -18,7 +18,7 @@ const documenso = new Documenso({ }); async function main() { - const result = await documenso.get({ + const result = await documenso.documents.get({ documentId: 6150.61, }); diff --git a/examples/package-lock.json b/examples/package-lock.json index 493bb93b..6d5f03e4 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "@documenso/sdk-typescript", - "version": "0.3.2", + "version": "0.4.0", "dependencies": { "zod": "^3.20.0" }, diff --git a/jsr.json b/jsr.json index da15b80b..f12172d2 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@documenso/sdk-typescript", - "version": "0.3.2", + "version": "0.4.0", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 65c85af7..39f1a6ab 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@documenso/sdk-typescript", - "version": "0.3.2", + "version": "0.4.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@documenso/sdk-typescript", - "version": "0.3.2", + "version": "0.4.0", "dependencies": { "zod": "^3.20.0" }, diff --git a/package.json b/package.json index 7b64d21c..a1fb2f31 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@documenso/sdk-typescript", - "version": "0.3.2", + "version": "0.4.0", "author": "Speakeasy", "bin": { "mcp": "bin/mcp-server.js" diff --git a/src/funcs/documentDocumentDownload.ts b/src/funcs/documentDocumentDownload.ts index 7c29017d..0ac16fd7 100644 --- a/src/funcs/documentDocumentDownload.ts +++ b/src/funcs/documentDocumentDownload.ts @@ -117,7 +117,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-download", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsCreateV0.ts b/src/funcs/documentsCreateV0.ts index 958b1b25..966bc5d3 100644 --- a/src/funcs/documentsCreateV0.ts +++ b/src/funcs/documentsCreateV0.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-createDocumentTemporary", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsDelete.ts b/src/funcs/documentsDelete.ts index 05bb6853..63c4a087 100644 --- a/src/funcs/documentsDelete.ts +++ b/src/funcs/documentsDelete.ts @@ -102,7 +102,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-delete", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsDistribute.ts b/src/funcs/documentsDistribute.ts index 5ddd6c71..5abeb985 100644 --- a/src/funcs/documentsDistribute.ts +++ b/src/funcs/documentsDistribute.ts @@ -105,7 +105,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-distribute", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsDuplicate.ts b/src/funcs/documentsDuplicate.ts index d83e7476..3b849ed3 100644 --- a/src/funcs/documentsDuplicate.ts +++ b/src/funcs/documentsDuplicate.ts @@ -102,7 +102,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-duplicate", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsFieldsCreate.ts b/src/funcs/documentsFieldsCreate.ts index 95f8bc8a..776b001d 100644 --- a/src/funcs/documentsFieldsCreate.ts +++ b/src/funcs/documentsFieldsCreate.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-createDocumentField", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsFieldsCreateMany.ts b/src/funcs/documentsFieldsCreateMany.ts index cbff8b0a..1b82963b 100644 --- a/src/funcs/documentsFieldsCreateMany.ts +++ b/src/funcs/documentsFieldsCreateMany.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-createDocumentFields", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsFieldsDelete.ts b/src/funcs/documentsFieldsDelete.ts index f8306809..a10e8161 100644 --- a/src/funcs/documentsFieldsDelete.ts +++ b/src/funcs/documentsFieldsDelete.ts @@ -103,7 +103,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-deleteDocumentField", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsFieldsGet.ts b/src/funcs/documentsFieldsGet.ts index c01391b8..d8dcbe31 100644 --- a/src/funcs/documentsFieldsGet.ts +++ b/src/funcs/documentsFieldsGet.ts @@ -114,7 +114,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-getDocumentField", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsFieldsUpdate.ts b/src/funcs/documentsFieldsUpdate.ts index bbc6d8d3..adb96263 100644 --- a/src/funcs/documentsFieldsUpdate.ts +++ b/src/funcs/documentsFieldsUpdate.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-updateDocumentField", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsFieldsUpdateMany.ts b/src/funcs/documentsFieldsUpdateMany.ts index c2218fad..3cf61ef1 100644 --- a/src/funcs/documentsFieldsUpdateMany.ts +++ b/src/funcs/documentsFieldsUpdateMany.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-updateDocumentFields", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsFind.ts b/src/funcs/documentsFind.ts index 5ec0226e..b77cf023 100644 --- a/src/funcs/documentsFind.ts +++ b/src/funcs/documentsFind.ts @@ -118,7 +118,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-find", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsGet.ts b/src/funcs/documentsGet.ts index 42f7a491..5c896ba4 100644 --- a/src/funcs/documentsGet.ts +++ b/src/funcs/documentsGet.ts @@ -113,7 +113,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-get", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsRecipientsCreate.ts b/src/funcs/documentsRecipientsCreate.ts index 66cdd504..6eae4c99 100644 --- a/src/funcs/documentsRecipientsCreate.ts +++ b/src/funcs/documentsRecipientsCreate.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-createDocumentRecipient", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsRecipientsCreateMany.ts b/src/funcs/documentsRecipientsCreateMany.ts index bdad5e71..5015d0e5 100644 --- a/src/funcs/documentsRecipientsCreateMany.ts +++ b/src/funcs/documentsRecipientsCreateMany.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-createDocumentRecipients", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsRecipientsDelete.ts b/src/funcs/documentsRecipientsDelete.ts index c2f83458..616589bf 100644 --- a/src/funcs/documentsRecipientsDelete.ts +++ b/src/funcs/documentsRecipientsDelete.ts @@ -105,7 +105,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-deleteDocumentRecipient", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsRecipientsGet.ts b/src/funcs/documentsRecipientsGet.ts index dd8b6dbd..2b91af6c 100644 --- a/src/funcs/documentsRecipientsGet.ts +++ b/src/funcs/documentsRecipientsGet.ts @@ -116,7 +116,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-getDocumentRecipient", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsRecipientsUpdate.ts b/src/funcs/documentsRecipientsUpdate.ts index 44d9b9ff..1e63dbc9 100644 --- a/src/funcs/documentsRecipientsUpdate.ts +++ b/src/funcs/documentsRecipientsUpdate.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-updateDocumentRecipient", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsRecipientsUpdateMany.ts b/src/funcs/documentsRecipientsUpdateMany.ts index 169df984..ddac4b53 100644 --- a/src/funcs/documentsRecipientsUpdateMany.ts +++ b/src/funcs/documentsRecipientsUpdateMany.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-updateDocumentRecipients", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsRedistribute.ts b/src/funcs/documentsRedistribute.ts index 00dfecb3..7586e275 100644 --- a/src/funcs/documentsRedistribute.ts +++ b/src/funcs/documentsRedistribute.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-redistribute", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/documentsUpdate.ts b/src/funcs/documentsUpdate.ts index f6399763..2a74b7f5 100644 --- a/src/funcs/documentsUpdate.ts +++ b/src/funcs/documentsUpdate.ts @@ -102,7 +102,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "document-update", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts b/src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts index eb506c5b..9c4156a6 100644 --- a/src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts +++ b/src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "embeddingPresign-createEmbeddingPresignToken", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts b/src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts index 3abca341..265b34df 100644 --- a/src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts +++ b/src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "embeddingPresign-verifyEmbeddingPresignToken", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templateTemplateCreateTemplateTemporary.ts b/src/funcs/templateTemplateCreateTemplateTemporary.ts index 6195abbc..2b3541db 100644 --- a/src/funcs/templateTemplateCreateTemplateTemporary.ts +++ b/src/funcs/templateTemplateCreateTemplateTemporary.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-createTemplateTemporary", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesDelete.ts b/src/funcs/templatesDelete.ts index 97290cd9..64b2e2bb 100644 --- a/src/funcs/templatesDelete.ts +++ b/src/funcs/templatesDelete.ts @@ -103,7 +103,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-deleteTemplate", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesDirectLinkCreate.ts b/src/funcs/templatesDirectLinkCreate.ts index a5656cd2..797d99d2 100644 --- a/src/funcs/templatesDirectLinkCreate.ts +++ b/src/funcs/templatesDirectLinkCreate.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-createTemplateDirectLink", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesDirectLinkDelete.ts b/src/funcs/templatesDirectLinkDelete.ts index 88a104a8..d0d16900 100644 --- a/src/funcs/templatesDirectLinkDelete.ts +++ b/src/funcs/templatesDirectLinkDelete.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-deleteTemplateDirectLink", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesDirectLinkToggle.ts b/src/funcs/templatesDirectLinkToggle.ts index 9e55bcfb..76234a42 100644 --- a/src/funcs/templatesDirectLinkToggle.ts +++ b/src/funcs/templatesDirectLinkToggle.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-toggleTemplateDirectLink", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesDuplicate.ts b/src/funcs/templatesDuplicate.ts index cb0acca2..07133e21 100644 --- a/src/funcs/templatesDuplicate.ts +++ b/src/funcs/templatesDuplicate.ts @@ -103,7 +103,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-duplicateTemplate", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesFieldsCreate.ts b/src/funcs/templatesFieldsCreate.ts index a9daab11..7e5042fd 100644 --- a/src/funcs/templatesFieldsCreate.ts +++ b/src/funcs/templatesFieldsCreate.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-createTemplateField", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesFieldsCreateMany.ts b/src/funcs/templatesFieldsCreateMany.ts index 007339ed..eeb98204 100644 --- a/src/funcs/templatesFieldsCreateMany.ts +++ b/src/funcs/templatesFieldsCreateMany.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-createTemplateFields", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesFieldsDelete.ts b/src/funcs/templatesFieldsDelete.ts index fe8e3de5..f3bf7e70 100644 --- a/src/funcs/templatesFieldsDelete.ts +++ b/src/funcs/templatesFieldsDelete.ts @@ -103,7 +103,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-deleteTemplateField", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesFieldsGet.ts b/src/funcs/templatesFieldsGet.ts index c36c7eaf..89ffea9a 100644 --- a/src/funcs/templatesFieldsGet.ts +++ b/src/funcs/templatesFieldsGet.ts @@ -114,7 +114,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-getTemplateField", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesFieldsUpdate.ts b/src/funcs/templatesFieldsUpdate.ts index 1ae12527..7c6f32b0 100644 --- a/src/funcs/templatesFieldsUpdate.ts +++ b/src/funcs/templatesFieldsUpdate.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-updateTemplateField", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesFieldsUpdateMany.ts b/src/funcs/templatesFieldsUpdateMany.ts index 3293b27c..7903de21 100644 --- a/src/funcs/templatesFieldsUpdateMany.ts +++ b/src/funcs/templatesFieldsUpdateMany.ts @@ -106,7 +106,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "field-updateTemplateFields", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesFind.ts b/src/funcs/templatesFind.ts index b20f8e39..613e9576 100644 --- a/src/funcs/templatesFind.ts +++ b/src/funcs/templatesFind.ts @@ -115,7 +115,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-findTemplates", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesGet.ts b/src/funcs/templatesGet.ts index 93d4b1db..9e182900 100644 --- a/src/funcs/templatesGet.ts +++ b/src/funcs/templatesGet.ts @@ -111,7 +111,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-getTemplateById", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesRecipientsCreate.ts b/src/funcs/templatesRecipientsCreate.ts index f0950763..6551fd49 100644 --- a/src/funcs/templatesRecipientsCreate.ts +++ b/src/funcs/templatesRecipientsCreate.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-createTemplateRecipient", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesRecipientsCreateMany.ts b/src/funcs/templatesRecipientsCreateMany.ts index 621d053f..be483dc6 100644 --- a/src/funcs/templatesRecipientsCreateMany.ts +++ b/src/funcs/templatesRecipientsCreateMany.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-createTemplateRecipients", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesRecipientsDelete.ts b/src/funcs/templatesRecipientsDelete.ts index 3a6a4256..03bcec4a 100644 --- a/src/funcs/templatesRecipientsDelete.ts +++ b/src/funcs/templatesRecipientsDelete.ts @@ -105,7 +105,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-deleteTemplateRecipient", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesRecipientsGet.ts b/src/funcs/templatesRecipientsGet.ts index ab473b05..f14c5fe4 100644 --- a/src/funcs/templatesRecipientsGet.ts +++ b/src/funcs/templatesRecipientsGet.ts @@ -116,7 +116,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-getTemplateRecipient", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesRecipientsUpdate.ts b/src/funcs/templatesRecipientsUpdate.ts index 12927076..20faf5c2 100644 --- a/src/funcs/templatesRecipientsUpdate.ts +++ b/src/funcs/templatesRecipientsUpdate.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-updateTemplateRecipient", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesRecipientsUpdateMany.ts b/src/funcs/templatesRecipientsUpdateMany.ts index 4e6a5b24..e9209e00 100644 --- a/src/funcs/templatesRecipientsUpdateMany.ts +++ b/src/funcs/templatesRecipientsUpdateMany.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "recipient-updateTemplateRecipients", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesUpdate.ts b/src/funcs/templatesUpdate.ts index 2cfe02d0..243c284e 100644 --- a/src/funcs/templatesUpdate.ts +++ b/src/funcs/templatesUpdate.ts @@ -103,7 +103,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-updateTemplate", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/funcs/templatesUse.ts b/src/funcs/templatesUse.ts index 7812dffd..f9e48f30 100644 --- a/src/funcs/templatesUse.ts +++ b/src/funcs/templatesUse.ts @@ -108,7 +108,7 @@ async function $do( options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "template-createDocumentFromTemplate", - oAuth2Scopes: [], + oAuth2Scopes: null, resolvedSecurity: requestSecurity, diff --git a/src/lib/config.ts b/src/lib/config.ts index aa5aa33e..1e260488 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.0.0", - sdkVersion: "0.3.2", - genVersion: "2.687.13", + sdkVersion: "0.4.0", + genVersion: "2.727.9", userAgent: - "speakeasy-sdk/typescript 0.3.2 2.687.13 0.0.0 @documenso/sdk-typescript", + "speakeasy-sdk/typescript 0.4.0 2.727.9 0.0.0 @documenso/sdk-typescript", } as const; diff --git a/src/lib/env.ts b/src/lib/env.ts index 56d3ac74..5af641a5 100644 --- a/src/lib/env.ts +++ b/src/lib/env.ts @@ -18,6 +18,18 @@ export const envSchema: z.ZodType = z.object({ DOCUMENSO_DEBUG: z.coerce.boolean().optional(), }); +/** + * Checks for the existence of the Deno global object to determine the environment. + * @returns {boolean} True if the runtime is Deno, false otherwise. + */ +function isDeno() { + if ("Deno" in globalThis) { + return true; + } + + return false; +} + let envMemo: Env | undefined = undefined; /** * Reads and validates environment variables. @@ -27,9 +39,14 @@ export function env(): Env { return envMemo; } - envMemo = envSchema.parse( - dlv(globalThis, "process.env") ?? dlv(globalThis, "Deno.env") ?? {}, - ); + let envObject: Record = {}; + if (isDeno()) { + envObject = (globalThis as any).Deno?.env?.toObject?.() ?? {}; + } else { + envObject = dlv(globalThis, "process.env") ?? {}; + } + + envMemo = envSchema.parse(envObject); return envMemo; } diff --git a/src/lib/url.ts b/src/lib/url.ts index 6bc6356e..f3a8de6c 100644 --- a/src/lib/url.ts +++ b/src/lib/url.ts @@ -10,7 +10,7 @@ export function pathToFunc( pathPattern: string, options?: { charEncoding?: "percent" | "none" }, ): (params?: Params) => string { - const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; + const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g; return function buildURLPath(params: Record = {}): string { return pathPattern.replace(paramRE, function (_, placeholder) { diff --git a/src/mcp-server/mcp-server.ts b/src/mcp-server/mcp-server.ts index 84bb0677..f2be1190 100644 --- a/src/mcp-server/mcp-server.ts +++ b/src/mcp-server/mcp-server.ts @@ -19,7 +19,7 @@ const routes = buildRouteMap({ export const app = buildApplication(routes, { name: "mcp", versionInfo: { - currentVersion: "0.3.2", + currentVersion: "0.4.0", }, }); diff --git a/src/mcp-server/server.ts b/src/mcp-server/server.ts index 1a7bed16..8f709731 100644 --- a/src/mcp-server/server.ts +++ b/src/mcp-server/server.ts @@ -69,7 +69,7 @@ export function createMCPServer(deps: { }) { const server = new McpServer({ name: "Documenso", - version: "0.3.2", + version: "0.4.0", }); const client = new DocumensoCore({ diff --git a/src/models/errors/index.ts b/src/models/errors/index.ts index 57fe02b4..469df6a6 100644 --- a/src/models/errors/index.ts +++ b/src/models/errors/index.ts @@ -3,6 +3,7 @@ */ export * from "./apierror.js"; +export * from "./documensoerror.js"; export * from "./documentcreatedocumenttemporary.js"; export * from "./documentdelete.js"; export * from "./documentdistribute.js"; diff --git a/src/models/operations/documentcreatedocumenttemporary.ts b/src/models/operations/documentcreatedocumenttemporary.ts index 6bc54176..ef6c747b 100644 --- a/src/models/operations/documentcreatedocumenttemporary.ts +++ b/src/models/operations/documentcreatedocumenttemporary.ts @@ -28,6 +28,7 @@ export type DocumentCreateDocumentTemporaryVisibilityRequest = ClosedEnum< */ export const DocumentCreateDocumentTemporaryGlobalAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -70,6 +71,7 @@ export type DocumentCreateDocumentTemporaryRoleRequest = ClosedEnum< */ export const DocumentCreateDocumentTemporaryAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -302,10 +304,10 @@ export type DocumentCreateDocumentTemporaryRecipientFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: DocumentCreateDocumentTemporaryRecipientTypeNumber2; - 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?: DocumentCreateDocumentTemporaryTextAlignNumber | undefined; }; @@ -740,17 +742,28 @@ export type DocumentCreateDocumentTemporaryRecipientRequest = { * The date format to use for date fields and signing the document. */ export const DocumentCreateDocumentTemporaryDateFormat = { - YyyyMMDdHhMMA: "yyyy-MM-dd hh:mm a", - YyyyMMDd: "yyyy-MM-dd", - DdMMYyyyHhMMA: "dd/MM/yyyy hh:mm a", - MMDdYyyyHhMMA: "MM/dd/yyyy hh:mm a", - DdMMYyyyHHMM: "dd.MM.yyyy HH:mm", - YyyyMMDdHHMM: "yyyy-MM-dd HH:mm", - YyMMDdHhMMA: "yy-MM-dd hh:mm a", - YyyyMMDdHHMMSs: "yyyy-MM-dd HH:mm:ss", - MMMMDdYyyyHhMmA: "MMMM dd, yyyy hh:mm a", - EEEEMMMMDdYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", - YyyyMMDdTHHMMSsSSSXXX: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", + YyyyMMddHhMmA: "yyyy-MM-dd hh:mm a", + YyyyMMdd: "yyyy-MM-dd", + DdMMSlashYyyy: "dd/MM/yyyy", + MmDdSlashYyyy: "MM/dd/yyyy", + YyMMdd: "yy-MM-dd", + MmmmDdCommaYyyy: "MMMM dd, yyyy", + EeeeMmmmDdCommaYyyy: "EEEE, MMMM dd, yyyy", + DdMMSlashYyyyHhMMA: "dd/MM/yyyy hh:mm a", + DdMMSlashYyyyHHmm: "dd/MM/yyyy HH:mm", + MmDdSlashYyyyHhMmA: "MM/dd/yyyy hh:mm a", + MmDdSlashYyyyHHmm: "MM/dd/yyyy HH:mm", + DdDotMmDotYyyy: "dd.MM.yyyy", + DdDotMmDotYyyyHHmm: "dd.MM.yyyy HH:mm", + YyyyMMddHHmm: "yyyy-MM-dd HH:mm", + YyMMddHhMmA: "yy-MM-dd hh:mm a", + YyMMddHHmm: "yy-MM-dd HH:mm", + YyyyMMddHHmmss: "yyyy-MM-dd HH:mm:ss", + MmmmDdCommaYyyyHhMmA: "MMMM dd, yyyy hh:mm a", + MmmmDdCommaYyyyHHmm: "MMMM dd, yyyy HH:mm", + EeeeMmmmDdCommaYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", + EeeeMmmmDdCommaYyyyHHmm: "EEEE, MMMM dd, yyyy HH:mm", + Iso8601Full: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", } as const; /** * The date format to use for date fields and signing the document. @@ -853,6 +866,7 @@ export type DocumentCreateDocumentTemporaryMeta = { | DocumentCreateDocumentTemporaryDistributionMethodRequest | undefined; signingOrder?: DocumentCreateDocumentTemporarySigningOrderRequest | undefined; + allowDictateNextSigner?: boolean | undefined; /** * The URL to which the recipient should be redirected after signing the document. */ @@ -865,16 +879,19 @@ export type DocumentCreateDocumentTemporaryMeta = { * Whether to allow recipients to sign using a typed signature. */ typedSignatureEnabled?: boolean | undefined; - /** - * Whether to allow recipients to sign using a draw signature. - */ - drawSignatureEnabled?: boolean | undefined; /** * Whether to allow recipients to sign using an uploaded signature. */ uploadSignatureEnabled?: boolean | undefined; + /** + * Whether to allow recipients to sign using a draw signature. + */ + drawSignatureEnabled?: boolean | undefined; + emailId?: string | null | undefined; + emailReplyTo?: string | null | undefined; emailSettings?: | DocumentCreateDocumentTemporaryEmailSettingsRequest + | null | undefined; }; @@ -939,6 +956,7 @@ export type DocumentCreateDocumentTemporarySource = ClosedEnum< */ export const DocumentGlobalAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -984,6 +1002,7 @@ export type DocumentCreateDocumentTemporaryDocumentData = { id: string; data: string; initialData: string; + envelopeItemId: string; }; export const DocumentSigningOrder = { @@ -1038,9 +1057,7 @@ export type DocumentCreateDocumentTemporaryDocumentMeta = { subject: string | null; message: string | null; timezone: string | null; - password: string | null; dateFormat: string | null; - documentId: number; redirectUrl: string | null; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; @@ -1050,6 +1067,8 @@ export type DocumentCreateDocumentTemporaryDocumentMeta = { emailSettings: DocumentEmailSettings | null; emailId: string | null; emailReplyTo: string | null; + password?: string | null | undefined; + documentId?: number | undefined; }; export const DocumentFolderType = { @@ -1119,6 +1138,7 @@ export type DocumentCreateDocumentTemporarySendStatus = ClosedEnum< */ export const DocumentAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -1146,13 +1166,12 @@ export type DocumentCreateDocumentTemporaryRecipientAuthOptions = { }; export type DocumentRecipient = { + envelopeId: string; role: DocumentRole; readStatus: DocumentCreateDocumentTemporaryReadStatus; signingStatus: DocumentCreateDocumentTemporarySigningStatus; sendStatus: DocumentCreateDocumentTemporarySendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -1165,6 +1184,8 @@ export type DocumentRecipient = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const DocumentFieldType = { @@ -1268,10 +1289,10 @@ export type FieldMetaDocumentNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: DocumentTypeNumber; - 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?: DocumentTextAlign6 | undefined; }; @@ -1400,11 +1421,11 @@ export type DocumentFieldMetaUnion = | FieldMetaDocumentDropdown; export type DocumentField = { + envelopeId: string; + envelopeItemId: string; type: DocumentFieldType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -1427,6 +1448,8 @@ export type DocumentField = { | FieldMetaDocumentCheckbox | FieldMetaDocumentDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export type Document = { @@ -1445,16 +1468,20 @@ export type Document = { authOptions: DocumentCreateDocumentTemporaryAuthOptions | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; + envelopeId: string; + /** + * The ID of the template that the document was created from, if any. + */ + templateId?: number | null | undefined; + documentDataId?: string | undefined; documentData: DocumentCreateDocumentTemporaryDocumentData; - documentMeta: DocumentCreateDocumentTemporaryDocumentMeta | null; + documentMeta: DocumentCreateDocumentTemporaryDocumentMeta; folder: DocumentCreateDocumentTemporaryFolder | null; recipients: Array; fields: Array; @@ -2673,10 +2700,10 @@ export const DocumentCreateDocumentTemporaryRecipientFieldMetaNumber$inboundSche required: z.boolean().optional(), readOnly: z.boolean().optional(), type: DocumentCreateDocumentTemporaryRecipientTypeNumber2$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: DocumentCreateDocumentTemporaryTextAlignNumber$inboundSchema .optional(), @@ -2689,10 +2716,10 @@ export type DocumentCreateDocumentTemporaryRecipientFieldMetaNumber$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; }; @@ -2709,10 +2736,10 @@ export const DocumentCreateDocumentTemporaryRecipientFieldMetaNumber$outboundSch required: z.boolean().optional(), readOnly: z.boolean().optional(), type: DocumentCreateDocumentTemporaryRecipientTypeNumber2$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: DocumentCreateDocumentTemporaryTextAlignNumber$outboundSchema .optional(), @@ -4748,13 +4775,18 @@ export const DocumentCreateDocumentTemporaryMeta$inboundSchema: z.ZodType< .optional(), signingOrder: DocumentCreateDocumentTemporarySigningOrderRequest$inboundSchema .optional(), + allowDictateNextSigner: z.boolean().optional(), redirectUrl: z.string().optional(), language: DocumentCreateDocumentTemporaryLanguage$inboundSchema.optional(), typedSignatureEnabled: z.boolean().optional(), - drawSignatureEnabled: z.boolean().optional(), uploadSignatureEnabled: z.boolean().optional(), - emailSettings: z.lazy(() => - DocumentCreateDocumentTemporaryEmailSettingsRequest$inboundSchema + drawSignatureEnabled: z.boolean().optional(), + emailId: z.nullable(z.string()).optional(), + emailReplyTo: z.nullable(z.string()).optional(), + emailSettings: z.nullable( + z.lazy(() => + DocumentCreateDocumentTemporaryEmailSettingsRequest$inboundSchema + ), ).optional(), }); @@ -4766,13 +4798,17 @@ export type DocumentCreateDocumentTemporaryMeta$Outbound = { dateFormat?: string | undefined; distributionMethod?: string | undefined; signingOrder?: string | undefined; + allowDictateNextSigner?: boolean | undefined; redirectUrl?: string | undefined; language?: string | undefined; typedSignatureEnabled?: boolean | undefined; - drawSignatureEnabled?: boolean | undefined; uploadSignatureEnabled?: boolean | undefined; + drawSignatureEnabled?: boolean | undefined; + emailId?: string | null | undefined; + emailReplyTo?: string | null | undefined; emailSettings?: | DocumentCreateDocumentTemporaryEmailSettingsRequest$Outbound + | null | undefined; }; @@ -4793,13 +4829,18 @@ export const DocumentCreateDocumentTemporaryMeta$outboundSchema: z.ZodType< signingOrder: DocumentCreateDocumentTemporarySigningOrderRequest$outboundSchema .optional(), + allowDictateNextSigner: z.boolean().optional(), redirectUrl: z.string().optional(), language: DocumentCreateDocumentTemporaryLanguage$outboundSchema.optional(), typedSignatureEnabled: z.boolean().optional(), - drawSignatureEnabled: z.boolean().optional(), uploadSignatureEnabled: z.boolean().optional(), - emailSettings: z.lazy(() => - DocumentCreateDocumentTemporaryEmailSettingsRequest$outboundSchema + drawSignatureEnabled: z.boolean().optional(), + emailId: z.nullable(z.string()).optional(), + emailReplyTo: z.nullable(z.string()).optional(), + emailSettings: z.nullable( + z.lazy(() => + DocumentCreateDocumentTemporaryEmailSettingsRequest$outboundSchema + ), ).optional(), }); @@ -5203,6 +5244,7 @@ export const DocumentCreateDocumentTemporaryDocumentData$inboundSchema: id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @internal */ @@ -5211,6 +5253,7 @@ export type DocumentCreateDocumentTemporaryDocumentData$Outbound = { id: string; data: string; initialData: string; + envelopeItemId: string; }; /** @internal */ @@ -5224,6 +5267,7 @@ export const DocumentCreateDocumentTemporaryDocumentData$outboundSchema: id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @@ -5395,9 +5439,7 @@ export const DocumentCreateDocumentTemporaryDocumentMeta$inboundSchema: subject: z.nullable(z.string()), message: z.nullable(z.string()), timezone: z.nullable(z.string()), - password: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - documentId: z.number(), redirectUrl: z.nullable(z.string()), typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), @@ -5409,6 +5451,8 @@ export const DocumentCreateDocumentTemporaryDocumentMeta$inboundSchema: ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + password: z.nullable(z.string()).default(null), + documentId: z.number().default(-1), }); /** @internal */ @@ -5419,9 +5463,7 @@ export type DocumentCreateDocumentTemporaryDocumentMeta$Outbound = { subject: string | null; message: string | null; timezone: string | null; - password: string | null; dateFormat: string | null; - documentId: number; redirectUrl: string | null; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; @@ -5431,6 +5473,8 @@ export type DocumentCreateDocumentTemporaryDocumentMeta$Outbound = { emailSettings: DocumentEmailSettings$Outbound | null; emailId: string | null; emailReplyTo: string | null; + password: string | null; + documentId: number; }; /** @internal */ @@ -5446,9 +5490,7 @@ export const DocumentCreateDocumentTemporaryDocumentMeta$outboundSchema: subject: z.nullable(z.string()), message: z.nullable(z.string()), timezone: z.nullable(z.string()), - password: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - documentId: z.number(), redirectUrl: z.nullable(z.string()), typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), @@ -5460,6 +5502,8 @@ export const DocumentCreateDocumentTemporaryDocumentMeta$outboundSchema: ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + password: z.nullable(z.string()).default(null), + documentId: z.number().default(-1), }); /** @@ -5839,13 +5883,12 @@ export const DocumentRecipient$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: DocumentRole$inboundSchema, readStatus: DocumentCreateDocumentTemporaryReadStatus$inboundSchema, signingStatus: DocumentCreateDocumentTemporarySigningStatus$inboundSchema, sendStatus: DocumentCreateDocumentTemporarySendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -5859,17 +5902,18 @@ export const DocumentRecipient$inboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type DocumentRecipient$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; @@ -5881,6 +5925,8 @@ export type DocumentRecipient$Outbound = { | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5889,13 +5935,12 @@ export const DocumentRecipient$outboundSchema: z.ZodType< z.ZodTypeDef, DocumentRecipient > = z.object({ + envelopeId: z.string(), role: DocumentRole$outboundSchema, readStatus: DocumentCreateDocumentTemporaryReadStatus$outboundSchema, signingStatus: DocumentCreateDocumentTemporarySigningStatus$outboundSchema, sendStatus: DocumentCreateDocumentTemporarySendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -5909,6 +5954,8 @@ export const DocumentRecipient$outboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -6481,10 +6528,10 @@ export const FieldMetaDocumentNumber$inboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: DocumentTypeNumber$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: DocumentTextAlign6$inboundSchema.optional(), }); @@ -6496,10 +6543,10 @@ export type FieldMetaDocumentNumber$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; }; @@ -6515,10 +6562,10 @@ export const FieldMetaDocumentNumber$outboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: DocumentTypeNumber$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: DocumentTextAlign6$outboundSchema.optional(), }); @@ -7213,11 +7260,11 @@ export const DocumentField$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: DocumentFieldType$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(), @@ -7239,15 +7286,17 @@ export const DocumentField$inboundSchema: z.ZodType< z.lazy(() => FieldMetaDocumentDropdown$inboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type DocumentField$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -7267,6 +7316,8 @@ export type DocumentField$Outbound = { | FieldMetaDocumentCheckbox$Outbound | FieldMetaDocumentDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -7275,11 +7326,11 @@ export const DocumentField$outboundSchema: z.ZodType< z.ZodTypeDef, DocumentField > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: DocumentFieldType$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(), @@ -7301,6 +7352,8 @@ export const DocumentField$outboundSchema: z.ZodType< z.lazy(() => FieldMetaDocumentDropdown$outboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -7349,19 +7402,20 @@ export const Document$inboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateId: z.nullable(z.number()).optional(), + documentDataId: z.string().default(""), documentData: z.lazy(() => DocumentCreateDocumentTemporaryDocumentData$inboundSchema ), - documentMeta: z.nullable( - z.lazy(() => DocumentCreateDocumentTemporaryDocumentMeta$inboundSchema), + documentMeta: z.lazy(() => + DocumentCreateDocumentTemporaryDocumentMeta$inboundSchema ), folder: z.nullable( z.lazy(() => DocumentCreateDocumentTemporaryFolder$inboundSchema), @@ -7381,16 +7435,17 @@ export type Document$Outbound = { authOptions: DocumentCreateDocumentTemporaryAuthOptions$Outbound | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; + envelopeId: string; + templateId?: number | null | undefined; + documentDataId: string; documentData: DocumentCreateDocumentTemporaryDocumentData$Outbound; - documentMeta: DocumentCreateDocumentTemporaryDocumentMeta$Outbound | null; + documentMeta: DocumentCreateDocumentTemporaryDocumentMeta$Outbound; folder: DocumentCreateDocumentTemporaryFolder$Outbound | null; recipients: Array; fields: Array; @@ -7415,19 +7470,20 @@ export const Document$outboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateId: z.nullable(z.number()).optional(), + documentDataId: z.string().default(""), documentData: z.lazy(() => DocumentCreateDocumentTemporaryDocumentData$outboundSchema ), - documentMeta: z.nullable( - z.lazy(() => DocumentCreateDocumentTemporaryDocumentMeta$outboundSchema), + documentMeta: z.lazy(() => + DocumentCreateDocumentTemporaryDocumentMeta$outboundSchema ), folder: z.nullable( z.lazy(() => DocumentCreateDocumentTemporaryFolder$outboundSchema), diff --git a/src/models/operations/documentdistribute.ts b/src/models/operations/documentdistribute.ts index 957e162e..fa88918c 100644 --- a/src/models/operations/documentdistribute.ts +++ b/src/models/operations/documentdistribute.ts @@ -12,17 +12,28 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js"; * The date format to use for date fields and signing the document. */ export const DocumentDistributeDateFormat = { - YyyyMMDdHhMMA: "yyyy-MM-dd hh:mm a", - YyyyMMDd: "yyyy-MM-dd", - DdMMYyyyHhMMA: "dd/MM/yyyy hh:mm a", - MMDdYyyyHhMMA: "MM/dd/yyyy hh:mm a", - DdMMYyyyHHMM: "dd.MM.yyyy HH:mm", - YyyyMMDdHHMM: "yyyy-MM-dd HH:mm", - YyMMDdHhMMA: "yy-MM-dd hh:mm a", - YyyyMMDdHHMMSs: "yyyy-MM-dd HH:mm:ss", - MMMMDdYyyyHhMmA: "MMMM dd, yyyy hh:mm a", - EEEEMMMMDdYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", - YyyyMMDdTHHMMSsSSSXXX: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", + YyyyMMddHhMmA: "yyyy-MM-dd hh:mm a", + YyyyMMdd: "yyyy-MM-dd", + DdMMSlashYyyy: "dd/MM/yyyy", + MmDdSlashYyyy: "MM/dd/yyyy", + YyMMdd: "yy-MM-dd", + MmmmDdCommaYyyy: "MMMM dd, yyyy", + EeeeMmmmDdCommaYyyy: "EEEE, MMMM dd, yyyy", + DdMMSlashYyyyHhMMA: "dd/MM/yyyy hh:mm a", + DdMMSlashYyyyHHmm: "dd/MM/yyyy HH:mm", + MmDdSlashYyyyHhMmA: "MM/dd/yyyy hh:mm a", + MmDdSlashYyyyHHmm: "MM/dd/yyyy HH:mm", + DdDotMmDotYyyy: "dd.MM.yyyy", + DdDotMmDotYyyyHHmm: "dd.MM.yyyy HH:mm", + YyyyMMddHHmm: "yyyy-MM-dd HH:mm", + YyMMddHhMmA: "yy-MM-dd hh:mm a", + YyMMddHHmm: "yy-MM-dd HH:mm", + YyyyMMddHHmmss: "yyyy-MM-dd HH:mm:ss", + MmmmDdCommaYyyyHhMmA: "MMMM dd, yyyy hh:mm a", + MmmmDdCommaYyyyHHmm: "MMMM dd, yyyy HH:mm", + EeeeMmmmDdCommaYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", + EeeeMmmmDdCommaYyyyHHmm: "EEEE, MMMM dd, yyyy HH:mm", + Iso8601Full: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", } as const; /** * The date format to use for date fields and signing the document. @@ -169,6 +180,7 @@ export type DocumentDistributeSource = ClosedEnum< */ export const DocumentDistributeGlobalAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -219,15 +231,19 @@ export type DocumentDistributeResponse = { authOptions: DocumentDistributeAuthOptions | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + documentDataId?: string | undefined; + /** + * The ID of the template that the document was created from, if any. + */ + templateId?: number | null | undefined; }; /** @internal */ @@ -747,15 +763,16 @@ export const DocumentDistributeResponse$inboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + documentDataId: z.string().default(""), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ @@ -769,15 +786,16 @@ export type DocumentDistributeResponse$Outbound = { authOptions: DocumentDistributeAuthOptions$Outbound | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + documentDataId: string; + templateId?: number | null | undefined; }; /** @internal */ @@ -799,15 +817,16 @@ export const DocumentDistributeResponse$outboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + documentDataId: z.string().default(""), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/documentduplicate.ts b/src/models/operations/documentduplicate.ts index b48b6f03..82abde08 100644 --- a/src/models/operations/documentduplicate.ts +++ b/src/models/operations/documentduplicate.ts @@ -15,6 +15,13 @@ export type DocumentDuplicateRequest = { * Successful response */ export type DocumentDuplicateResponse = { + /** + * The envelope ID + */ + id: string; + /** + * The legacy document ID + */ documentId: number; }; @@ -78,11 +85,13 @@ export const DocumentDuplicateResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + id: z.string(), documentId: z.number(), }); /** @internal */ export type DocumentDuplicateResponse$Outbound = { + id: string; documentId: number; }; @@ -92,6 +101,7 @@ export const DocumentDuplicateResponse$outboundSchema: z.ZodType< z.ZodTypeDef, DocumentDuplicateResponse > = z.object({ + id: z.string(), documentId: z.number(), }); diff --git a/src/models/operations/documentfind.ts b/src/models/operations/documentfind.ts index 039e298c..34848432 100644 --- a/src/models/operations/documentfind.ts +++ b/src/models/operations/documentfind.ts @@ -106,6 +106,7 @@ export type DataSource = ClosedEnum; */ export const DocumentFindGlobalAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -178,6 +179,7 @@ export type DocumentFindSendStatus = ClosedEnum; */ export const DocumentFindAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -205,13 +207,12 @@ export type DocumentFindRecipientAuthOptions = { }; export type DocumentFindRecipient = { + envelopeId: string; role: DocumentFindRole; readStatus: DocumentFindReadStatus; signingStatus: DocumentFindSigningStatus; sendStatus: DocumentFindSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -224,6 +225,8 @@ export type DocumentFindRecipient = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export type DocumentFindTeam = { @@ -247,15 +250,19 @@ export type DocumentFindData = { authOptions: DocumentFindAuthOptions | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + documentDataId?: string | undefined; + /** + * The ID of the template that the document was created from, if any. + */ + templateId?: number | null | undefined; user: DocumentFindUser; recipients: Array; team: DocumentFindTeam | null; @@ -903,13 +910,12 @@ export const DocumentFindRecipient$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: DocumentFindRole$inboundSchema, readStatus: DocumentFindReadStatus$inboundSchema, signingStatus: DocumentFindSigningStatus$inboundSchema, sendStatus: DocumentFindSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -921,17 +927,18 @@ export const DocumentFindRecipient$inboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type DocumentFindRecipient$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; @@ -941,6 +948,8 @@ export type DocumentFindRecipient$Outbound = { authOptions: DocumentFindRecipientAuthOptions$Outbound | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -949,13 +958,12 @@ export const DocumentFindRecipient$outboundSchema: z.ZodType< z.ZodTypeDef, DocumentFindRecipient > = z.object({ + envelopeId: z.string(), role: DocumentFindRole$outboundSchema, readStatus: DocumentFindReadStatus$outboundSchema, signingStatus: DocumentFindSigningStatus$outboundSchema, sendStatus: DocumentFindSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -967,6 +975,8 @@ export const DocumentFindRecipient$outboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -1074,15 +1084,16 @@ export const DocumentFindData$inboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + documentDataId: z.string().default(""), + templateId: z.nullable(z.number()).optional(), user: z.lazy(() => DocumentFindUser$inboundSchema), recipients: z.array(z.lazy(() => DocumentFindRecipient$inboundSchema)), team: z.nullable(z.lazy(() => DocumentFindTeam$inboundSchema)), @@ -1099,15 +1110,16 @@ export type DocumentFindData$Outbound = { authOptions: DocumentFindAuthOptions$Outbound | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + documentDataId: string; + templateId?: number | null | undefined; user: DocumentFindUser$Outbound; recipients: Array; team: DocumentFindTeam$Outbound | null; @@ -1130,15 +1142,16 @@ export const DocumentFindData$outboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + documentDataId: z.string().default(""), + templateId: z.nullable(z.number()).optional(), user: z.lazy(() => DocumentFindUser$outboundSchema), recipients: z.array(z.lazy(() => DocumentFindRecipient$outboundSchema)), team: z.nullable(z.lazy(() => DocumentFindTeam$outboundSchema)), diff --git a/src/models/operations/documentget.ts b/src/models/operations/documentget.ts index 13557402..9e7a4946 100644 --- a/src/models/operations/documentget.ts +++ b/src/models/operations/documentget.ts @@ -39,6 +39,7 @@ export type DocumentGetSource = ClosedEnum; */ export const DocumentGetGlobalAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -84,6 +85,7 @@ export type DocumentGetDocumentData = { id: string; data: string; initialData: string; + envelopeItemId: string; }; export const DocumentGetSigningOrder = { @@ -140,9 +142,7 @@ export type DocumentGetDocumentMeta = { subject: string | null; message: string | null; timezone: string | null; - password: string | null; dateFormat: string | null; - documentId: number; redirectUrl: string | null; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; @@ -152,6 +152,8 @@ export type DocumentGetDocumentMeta = { emailSettings: DocumentGetEmailSettings | null; emailId: string | null; emailReplyTo: string | null; + password?: string | null | undefined; + documentId?: number | undefined; }; export const DocumentGetFolderType = { @@ -217,6 +219,7 @@ export type DocumentGetSendStatus = ClosedEnum; */ export const DocumentGetAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -244,13 +247,12 @@ export type DocumentGetRecipientAuthOptions = { }; export type DocumentGetRecipient = { + envelopeId: string; role: DocumentGetRole; readStatus: DocumentGetReadStatus; signingStatus: DocumentGetSigningStatus; sendStatus: DocumentGetSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -263,6 +265,8 @@ export type DocumentGetRecipient = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const DocumentGetFieldType = { @@ -370,10 +374,10 @@ export type DocumentGetFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: DocumentGetTypeNumber; - 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?: DocumentGetTextAlign6 | undefined; }; @@ -504,11 +508,11 @@ export type DocumentGetFieldMetaUnion = | DocumentGetFieldMetaDropdown; export type DocumentGetField = { + envelopeId: string; + envelopeItemId: string; type: DocumentGetFieldType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -531,6 +535,8 @@ export type DocumentGetField = { | DocumentGetFieldMetaCheckbox | DocumentGetFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -552,16 +558,20 @@ export type DocumentGetResponse = { authOptions: DocumentGetAuthOptions | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; + envelopeId: string; + /** + * The ID of the template that the document was created from, if any. + */ + templateId?: number | null | undefined; + documentDataId?: string | undefined; documentData: DocumentGetDocumentData; - documentMeta: DocumentGetDocumentMeta | null; + documentMeta: DocumentGetDocumentMeta; folder: DocumentGetFolder | null; recipients: Array; fields: Array; @@ -862,6 +872,7 @@ export const DocumentGetDocumentData$inboundSchema: z.ZodType< id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @internal */ @@ -870,6 +881,7 @@ export type DocumentGetDocumentData$Outbound = { id: string; data: string; initialData: string; + envelopeItemId: string; }; /** @internal */ @@ -882,6 +894,7 @@ export const DocumentGetDocumentData$outboundSchema: z.ZodType< id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @@ -1041,9 +1054,7 @@ export const DocumentGetDocumentMeta$inboundSchema: z.ZodType< subject: z.nullable(z.string()), message: z.nullable(z.string()), timezone: z.nullable(z.string()), - password: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - documentId: z.number(), redirectUrl: z.nullable(z.string()), typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), @@ -1055,6 +1066,8 @@ export const DocumentGetDocumentMeta$inboundSchema: z.ZodType< ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + password: z.nullable(z.string()).default(null), + documentId: z.number().default(-1), }); /** @internal */ @@ -1065,9 +1078,7 @@ export type DocumentGetDocumentMeta$Outbound = { subject: string | null; message: string | null; timezone: string | null; - password: string | null; dateFormat: string | null; - documentId: number; redirectUrl: string | null; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; @@ -1077,6 +1088,8 @@ export type DocumentGetDocumentMeta$Outbound = { emailSettings: DocumentGetEmailSettings$Outbound | null; emailId: string | null; emailReplyTo: string | null; + password: string | null; + documentId: number; }; /** @internal */ @@ -1091,9 +1104,7 @@ export const DocumentGetDocumentMeta$outboundSchema: z.ZodType< subject: z.nullable(z.string()), message: z.nullable(z.string()), timezone: z.nullable(z.string()), - password: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - documentId: z.number(), redirectUrl: z.nullable(z.string()), typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), @@ -1105,6 +1116,8 @@ export const DocumentGetDocumentMeta$outboundSchema: z.ZodType< ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + password: z.nullable(z.string()).default(null), + documentId: z.number().default(-1), }); /** @@ -1452,13 +1465,12 @@ export const DocumentGetRecipient$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: DocumentGetRole$inboundSchema, readStatus: DocumentGetReadStatus$inboundSchema, signingStatus: DocumentGetSigningStatus$inboundSchema, sendStatus: DocumentGetSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -1470,17 +1482,18 @@ export const DocumentGetRecipient$inboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type DocumentGetRecipient$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; @@ -1490,6 +1503,8 @@ export type DocumentGetRecipient$Outbound = { authOptions: DocumentGetRecipientAuthOptions$Outbound | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1498,13 +1513,12 @@ export const DocumentGetRecipient$outboundSchema: z.ZodType< z.ZodTypeDef, DocumentGetRecipient > = z.object({ + envelopeId: z.string(), role: DocumentGetRole$outboundSchema, readStatus: DocumentGetReadStatus$outboundSchema, signingStatus: DocumentGetSigningStatus$outboundSchema, sendStatus: DocumentGetSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -1516,6 +1530,8 @@ export const DocumentGetRecipient$outboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2104,10 +2120,10 @@ export const DocumentGetFieldMetaNumber$inboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: DocumentGetTypeNumber$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: DocumentGetTextAlign6$inboundSchema.optional(), }); @@ -2119,10 +2135,10 @@ export type DocumentGetFieldMetaNumber$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; }; @@ -2138,10 +2154,10 @@ export const DocumentGetFieldMetaNumber$outboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: DocumentGetTypeNumber$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: DocumentGetTextAlign6$outboundSchema.optional(), }); @@ -2838,11 +2854,11 @@ export const DocumentGetField$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: DocumentGetFieldType$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(), @@ -2864,15 +2880,17 @@ export const DocumentGetField$inboundSchema: z.ZodType< z.lazy(() => DocumentGetFieldMetaDropdown$inboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type DocumentGetField$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -2892,6 +2910,8 @@ export type DocumentGetField$Outbound = { | DocumentGetFieldMetaCheckbox$Outbound | DocumentGetFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2900,11 +2920,11 @@ export const DocumentGetField$outboundSchema: z.ZodType< z.ZodTypeDef, DocumentGetField > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: DocumentGetFieldType$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(), @@ -2926,6 +2946,8 @@ export const DocumentGetField$outboundSchema: z.ZodType< z.lazy(() => DocumentGetFieldMetaDropdown$outboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2976,16 +2998,17 @@ export const DocumentGetResponse$inboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateId: z.nullable(z.number()).optional(), + documentDataId: z.string().default(""), documentData: z.lazy(() => DocumentGetDocumentData$inboundSchema), - documentMeta: z.nullable(z.lazy(() => DocumentGetDocumentMeta$inboundSchema)), + documentMeta: z.lazy(() => DocumentGetDocumentMeta$inboundSchema), folder: z.nullable(z.lazy(() => DocumentGetFolder$inboundSchema)), recipients: z.array(z.lazy(() => DocumentGetRecipient$inboundSchema)), fields: z.array(z.lazy(() => DocumentGetField$inboundSchema)), @@ -3002,16 +3025,17 @@ export type DocumentGetResponse$Outbound = { authOptions: DocumentGetAuthOptions$Outbound | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; + envelopeId: string; + templateId?: number | null | undefined; + documentDataId: string; documentData: DocumentGetDocumentData$Outbound; - documentMeta: DocumentGetDocumentMeta$Outbound | null; + documentMeta: DocumentGetDocumentMeta$Outbound; folder: DocumentGetFolder$Outbound | null; recipients: Array; fields: Array; @@ -3034,18 +3058,17 @@ export const DocumentGetResponse$outboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateId: z.nullable(z.number()).optional(), + documentDataId: z.string().default(""), documentData: z.lazy(() => DocumentGetDocumentData$outboundSchema), - documentMeta: z.nullable( - z.lazy(() => DocumentGetDocumentMeta$outboundSchema), - ), + documentMeta: z.lazy(() => DocumentGetDocumentMeta$outboundSchema), folder: z.nullable(z.lazy(() => DocumentGetFolder$outboundSchema)), recipients: z.array(z.lazy(() => DocumentGetRecipient$outboundSchema)), fields: z.array(z.lazy(() => DocumentGetField$outboundSchema)), diff --git a/src/models/operations/documentupdate.ts b/src/models/operations/documentupdate.ts index 3bf6aaac..f934ae7c 100644 --- a/src/models/operations/documentupdate.ts +++ b/src/models/operations/documentupdate.ts @@ -28,6 +28,7 @@ export type DocumentUpdateVisibilityRequest = ClosedEnum< */ export const DocumentUpdateGlobalAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -68,23 +69,35 @@ export type DocumentUpdateData = { globalAccessAuth?: Array | undefined; globalActionAuth?: Array | undefined; useLegacyFieldInsertion?: boolean | undefined; + folderId?: string | null | undefined; }; /** * The date format to use for date fields and signing the document. */ export const DocumentUpdateDateFormat = { - YyyyMMDdHhMMA: "yyyy-MM-dd hh:mm a", - YyyyMMDd: "yyyy-MM-dd", - DdMMYyyyHhMMA: "dd/MM/yyyy hh:mm a", - MMDdYyyyHhMMA: "MM/dd/yyyy hh:mm a", - DdMMYyyyHHMM: "dd.MM.yyyy HH:mm", - YyyyMMDdHHMM: "yyyy-MM-dd HH:mm", - YyMMDdHhMMA: "yy-MM-dd hh:mm a", - YyyyMMDdHHMMSs: "yyyy-MM-dd HH:mm:ss", - MMMMDdYyyyHhMmA: "MMMM dd, yyyy hh:mm a", - EEEEMMMMDdYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", - YyyyMMDdTHHMMSsSSSXXX: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", + YyyyMMddHhMmA: "yyyy-MM-dd hh:mm a", + YyyyMMdd: "yyyy-MM-dd", + DdMMSlashYyyy: "dd/MM/yyyy", + MmDdSlashYyyy: "MM/dd/yyyy", + YyMMdd: "yy-MM-dd", + MmmmDdCommaYyyy: "MMMM dd, yyyy", + EeeeMmmmDdCommaYyyy: "EEEE, MMMM dd, yyyy", + DdMMSlashYyyyHhMMA: "dd/MM/yyyy hh:mm a", + DdMMSlashYyyyHHmm: "dd/MM/yyyy HH:mm", + MmDdSlashYyyyHhMmA: "MM/dd/yyyy hh:mm a", + MmDdSlashYyyyHHmm: "MM/dd/yyyy HH:mm", + DdDotMmDotYyyy: "dd.MM.yyyy", + DdDotMmDotYyyyHHmm: "dd.MM.yyyy HH:mm", + YyyyMMddHHmm: "yyyy-MM-dd HH:mm", + YyMMddHhMmA: "yy-MM-dd hh:mm a", + YyMMddHHmm: "yy-MM-dd HH:mm", + YyyyMMddHHmmss: "yyyy-MM-dd HH:mm:ss", + MmmmDdCommaYyyyHhMmA: "MMMM dd, yyyy hh:mm a", + MmmmDdCommaYyyyHHmm: "MMMM dd, yyyy HH:mm", + EeeeMmmmDdCommaYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", + EeeeMmmmDdCommaYyyyHHmm: "EEEE, MMMM dd, yyyy HH:mm", + Iso8601Full: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", } as const; /** * The date format to use for date fields and signing the document. @@ -207,7 +220,7 @@ export type DocumentUpdateMeta = { drawSignatureEnabled?: boolean | undefined; emailId?: string | null | undefined; emailReplyTo?: string | null | undefined; - emailSettings?: DocumentUpdateEmailSettings | undefined; + emailSettings?: DocumentUpdateEmailSettings | null | undefined; }; export type DocumentUpdateRequest = { @@ -245,6 +258,7 @@ export type DocumentUpdateSource = ClosedEnum; */ export const DocumentUpdateGlobalAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -295,15 +309,19 @@ export type DocumentUpdateResponse = { authOptions: DocumentUpdateAuthOptions | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + documentDataId?: string | undefined; + /** + * The ID of the template that the document was created from, if any. + */ + templateId?: number | null | undefined; }; /** @internal */ @@ -389,6 +407,7 @@ export const DocumentUpdateData$inboundSchema: z.ZodType< globalActionAuth: z.array(DocumentUpdateGlobalActionAuthRequest$inboundSchema) .optional(), useLegacyFieldInsertion: z.boolean().optional(), + folderId: z.nullable(z.string()).optional(), }); /** @internal */ @@ -399,6 +418,7 @@ export type DocumentUpdateData$Outbound = { globalAccessAuth?: Array | undefined; globalActionAuth?: Array | undefined; useLegacyFieldInsertion?: boolean | undefined; + folderId?: string | null | undefined; }; /** @internal */ @@ -417,6 +437,7 @@ export const DocumentUpdateData$outboundSchema: z.ZodType< DocumentUpdateGlobalActionAuthRequest$outboundSchema, ).optional(), useLegacyFieldInsertion: z.boolean().optional(), + folderId: z.nullable(z.string()).optional(), }); /** @@ -628,8 +649,9 @@ export const DocumentUpdateMeta$inboundSchema: z.ZodType< drawSignatureEnabled: z.boolean().optional(), emailId: z.nullable(z.string()).optional(), emailReplyTo: z.nullable(z.string()).optional(), - emailSettings: z.lazy(() => DocumentUpdateEmailSettings$inboundSchema) - .optional(), + emailSettings: z.nullable( + z.lazy(() => DocumentUpdateEmailSettings$inboundSchema), + ).optional(), }); /** @internal */ @@ -648,7 +670,7 @@ export type DocumentUpdateMeta$Outbound = { drawSignatureEnabled?: boolean | undefined; emailId?: string | null | undefined; emailReplyTo?: string | null | undefined; - emailSettings?: DocumentUpdateEmailSettings$Outbound | undefined; + emailSettings?: DocumentUpdateEmailSettings$Outbound | null | undefined; }; /** @internal */ @@ -672,8 +694,9 @@ export const DocumentUpdateMeta$outboundSchema: z.ZodType< drawSignatureEnabled: z.boolean().optional(), emailId: z.nullable(z.string()).optional(), emailReplyTo: z.nullable(z.string()).optional(), - emailSettings: z.lazy(() => DocumentUpdateEmailSettings$outboundSchema) - .optional(), + emailSettings: z.nullable( + z.lazy(() => DocumentUpdateEmailSettings$outboundSchema), + ).optional(), }); /** @@ -1010,15 +1033,16 @@ export const DocumentUpdateResponse$inboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + documentDataId: z.string().default(""), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ @@ -1032,15 +1056,16 @@ export type DocumentUpdateResponse$Outbound = { authOptions: DocumentUpdateAuthOptions$Outbound | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + documentDataId: string; + templateId?: number | null | undefined; }; /** @internal */ @@ -1062,15 +1087,16 @@ export const DocumentUpdateResponse$outboundSchema: z.ZodType< z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + documentDataId: z.string().default(""), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldcreatedocumentfield.ts b/src/models/operations/fieldcreatedocumentfield.ts index c6d7fdb2..9d693f04 100644 --- a/src/models/operations/fieldcreatedocumentfield.ts +++ b/src/models/operations/fieldcreatedocumentfield.ts @@ -221,10 +221,10 @@ export type FieldCreateDocumentFieldFieldMetaNumberRequest = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldCreateDocumentFieldTypeNumberRequest2; - 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?: FieldCreateDocumentFieldTextAlignNumber | undefined; }; @@ -784,10 +784,10 @@ export type FieldCreateDocumentFieldFieldMetaNumberResponse = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldCreateDocumentFieldFieldMetaTypeNumber; - 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?: FieldCreateDocumentFieldTextAlignResponse6 | undefined; }; @@ -939,11 +939,11 @@ export type FieldCreateDocumentFieldFieldMetaUnion = * Successful response */ export type FieldCreateDocumentFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldCreateDocumentFieldTypeResponse; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -966,6 +966,8 @@ export type FieldCreateDocumentFieldResponse = { | FieldCreateDocumentFieldFieldMetaCheckboxResponse | FieldCreateDocumentFieldFieldMetaDropdownResponse | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1931,10 +1933,10 @@ export const FieldCreateDocumentFieldFieldMetaNumberRequest$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateDocumentFieldTypeNumberRequest2$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: FieldCreateDocumentFieldTextAlignNumber$inboundSchema.optional(), }); @@ -1946,10 +1948,10 @@ export type FieldCreateDocumentFieldFieldMetaNumberRequest$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; }; @@ -1966,10 +1968,10 @@ export const FieldCreateDocumentFieldFieldMetaNumberRequest$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateDocumentFieldTypeNumberRequest2$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: FieldCreateDocumentFieldTextAlignNumber$outboundSchema .optional(), @@ -4335,10 +4337,10 @@ export const FieldCreateDocumentFieldFieldMetaNumberResponse$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateDocumentFieldFieldMetaTypeNumber$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: FieldCreateDocumentFieldTextAlignResponse6$inboundSchema .optional(), @@ -4351,10 +4353,10 @@ export type FieldCreateDocumentFieldFieldMetaNumberResponse$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; }; @@ -4371,10 +4373,10 @@ export const FieldCreateDocumentFieldFieldMetaNumberResponse$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateDocumentFieldFieldMetaTypeNumber$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: FieldCreateDocumentFieldTextAlignResponse6$outboundSchema .optional(), @@ -5191,11 +5193,11 @@ export const FieldCreateDocumentFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldCreateDocumentFieldTypeResponse$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(), @@ -5229,15 +5231,17 @@ export const FieldCreateDocumentFieldResponse$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldCreateDocumentFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -5257,6 +5261,8 @@ export type FieldCreateDocumentFieldResponse$Outbound = { | FieldCreateDocumentFieldFieldMetaCheckboxResponse$Outbound | FieldCreateDocumentFieldFieldMetaDropdownResponse$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5265,11 +5271,11 @@ export const FieldCreateDocumentFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldCreateDocumentFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldCreateDocumentFieldTypeResponse$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(), @@ -5309,6 +5315,8 @@ export const FieldCreateDocumentFieldResponse$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldcreatedocumentfields.ts b/src/models/operations/fieldcreatedocumentfields.ts index 382becc6..2c5ca48e 100644 --- a/src/models/operations/fieldcreatedocumentfields.ts +++ b/src/models/operations/fieldcreatedocumentfields.ts @@ -221,10 +221,10 @@ export type FieldCreateDocumentFieldsFieldMetaNumberRequest = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldCreateDocumentFieldsTypeNumberRequest2; - 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?: FieldCreateDocumentFieldsTextAlignNumber | undefined; }; @@ -785,10 +785,10 @@ export type FieldCreateDocumentFieldsFieldMetaNumberResponse = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldCreateDocumentFieldsFieldMetaTypeNumber; - 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?: FieldCreateDocumentFieldsTextAlignResponse6 | undefined; }; @@ -937,11 +937,11 @@ export type FieldCreateDocumentFieldsFieldMetaUnion = | FieldCreateDocumentFieldsFieldMetaDropdownResponse; export type FieldCreateDocumentFieldsFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldCreateDocumentFieldsTypeResponse; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -964,6 +964,8 @@ export type FieldCreateDocumentFieldsFieldResponse = { | FieldCreateDocumentFieldsFieldMetaCheckboxResponse | FieldCreateDocumentFieldsFieldMetaDropdownResponse | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -1943,10 +1945,10 @@ export const FieldCreateDocumentFieldsFieldMetaNumberRequest$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateDocumentFieldsTypeNumberRequest2$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: FieldCreateDocumentFieldsTextAlignNumber$inboundSchema .optional(), @@ -1959,10 +1961,10 @@ export type FieldCreateDocumentFieldsFieldMetaNumberRequest$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; }; @@ -1979,10 +1981,10 @@ export const FieldCreateDocumentFieldsFieldMetaNumberRequest$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateDocumentFieldsTypeNumberRequest2$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: FieldCreateDocumentFieldsTextAlignNumber$outboundSchema .optional(), @@ -4388,10 +4390,10 @@ export const FieldCreateDocumentFieldsFieldMetaNumberResponse$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateDocumentFieldsFieldMetaTypeNumber$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: FieldCreateDocumentFieldsTextAlignResponse6$inboundSchema .optional(), @@ -4404,10 +4406,10 @@ export type FieldCreateDocumentFieldsFieldMetaNumberResponse$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; }; @@ -4424,10 +4426,10 @@ export const FieldCreateDocumentFieldsFieldMetaNumberResponse$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateDocumentFieldsFieldMetaTypeNumber$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: FieldCreateDocumentFieldsTextAlignResponse6$outboundSchema .optional(), @@ -5258,11 +5260,11 @@ export const FieldCreateDocumentFieldsFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldCreateDocumentFieldsTypeResponse$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(), @@ -5302,15 +5304,17 @@ export const FieldCreateDocumentFieldsFieldResponse$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldCreateDocumentFieldsFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -5330,6 +5334,8 @@ export type FieldCreateDocumentFieldsFieldResponse$Outbound = { | FieldCreateDocumentFieldsFieldMetaCheckboxResponse$Outbound | FieldCreateDocumentFieldsFieldMetaDropdownResponse$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5338,11 +5344,11 @@ export const FieldCreateDocumentFieldsFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldCreateDocumentFieldsFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldCreateDocumentFieldsTypeResponse$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(), @@ -5382,6 +5388,8 @@ export const FieldCreateDocumentFieldsFieldResponse$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldcreatetemplatefield.ts b/src/models/operations/fieldcreatetemplatefield.ts index 806d32e6..9f227cbc 100644 --- a/src/models/operations/fieldcreatetemplatefield.ts +++ b/src/models/operations/fieldcreatetemplatefield.ts @@ -221,10 +221,10 @@ export type FieldCreateTemplateFieldFieldMetaNumberRequest = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldCreateTemplateFieldTypeNumberRequest2; - 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?: FieldCreateTemplateFieldTextAlignNumber | undefined; }; @@ -784,10 +784,10 @@ export type FieldCreateTemplateFieldFieldMetaNumberResponse = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldCreateTemplateFieldFieldMetaTypeNumber; - 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?: FieldCreateTemplateFieldTextAlignResponse6 | undefined; }; @@ -939,11 +939,11 @@ export type FieldCreateTemplateFieldFieldMetaUnion = * Successful response */ export type FieldCreateTemplateFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldCreateTemplateFieldTypeResponse; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -966,6 +966,8 @@ export type FieldCreateTemplateFieldResponse = { | FieldCreateTemplateFieldFieldMetaCheckboxResponse | FieldCreateTemplateFieldFieldMetaDropdownResponse | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1931,10 +1933,10 @@ export const FieldCreateTemplateFieldFieldMetaNumberRequest$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateTemplateFieldTypeNumberRequest2$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: FieldCreateTemplateFieldTextAlignNumber$inboundSchema.optional(), }); @@ -1946,10 +1948,10 @@ export type FieldCreateTemplateFieldFieldMetaNumberRequest$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; }; @@ -1966,10 +1968,10 @@ export const FieldCreateTemplateFieldFieldMetaNumberRequest$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateTemplateFieldTypeNumberRequest2$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: FieldCreateTemplateFieldTextAlignNumber$outboundSchema .optional(), @@ -4335,10 +4337,10 @@ export const FieldCreateTemplateFieldFieldMetaNumberResponse$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateTemplateFieldFieldMetaTypeNumber$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: FieldCreateTemplateFieldTextAlignResponse6$inboundSchema .optional(), @@ -4351,10 +4353,10 @@ export type FieldCreateTemplateFieldFieldMetaNumberResponse$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; }; @@ -4371,10 +4373,10 @@ export const FieldCreateTemplateFieldFieldMetaNumberResponse$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateTemplateFieldFieldMetaTypeNumber$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: FieldCreateTemplateFieldTextAlignResponse6$outboundSchema .optional(), @@ -5191,11 +5193,11 @@ export const FieldCreateTemplateFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldCreateTemplateFieldTypeResponse$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(), @@ -5229,15 +5231,17 @@ export const FieldCreateTemplateFieldResponse$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldCreateTemplateFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -5257,6 +5261,8 @@ export type FieldCreateTemplateFieldResponse$Outbound = { | FieldCreateTemplateFieldFieldMetaCheckboxResponse$Outbound | FieldCreateTemplateFieldFieldMetaDropdownResponse$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5265,11 +5271,11 @@ export const FieldCreateTemplateFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldCreateTemplateFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldCreateTemplateFieldTypeResponse$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(), @@ -5309,6 +5315,8 @@ export const FieldCreateTemplateFieldResponse$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldcreatetemplatefields.ts b/src/models/operations/fieldcreatetemplatefields.ts index 14e2440b..dffd935e 100644 --- a/src/models/operations/fieldcreatetemplatefields.ts +++ b/src/models/operations/fieldcreatetemplatefields.ts @@ -221,10 +221,10 @@ export type FieldCreateTemplateFieldsFieldMetaNumberRequest = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldCreateTemplateFieldsTypeNumberRequest2; - 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?: FieldCreateTemplateFieldsTextAlignNumber | undefined; }; @@ -785,10 +785,10 @@ export type FieldCreateTemplateFieldsFieldMetaNumberResponse = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldCreateTemplateFieldsFieldMetaTypeNumber; - 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?: FieldCreateTemplateFieldsTextAlignResponse6 | undefined; }; @@ -937,11 +937,11 @@ export type FieldCreateTemplateFieldsFieldMetaUnion = | FieldCreateTemplateFieldsFieldMetaDropdownResponse; export type FieldCreateTemplateFieldsFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldCreateTemplateFieldsTypeResponse; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -964,6 +964,8 @@ export type FieldCreateTemplateFieldsFieldResponse = { | FieldCreateTemplateFieldsFieldMetaCheckboxResponse | FieldCreateTemplateFieldsFieldMetaDropdownResponse | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -1943,10 +1945,10 @@ export const FieldCreateTemplateFieldsFieldMetaNumberRequest$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateTemplateFieldsTypeNumberRequest2$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: FieldCreateTemplateFieldsTextAlignNumber$inboundSchema .optional(), @@ -1959,10 +1961,10 @@ export type FieldCreateTemplateFieldsFieldMetaNumberRequest$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; }; @@ -1979,10 +1981,10 @@ export const FieldCreateTemplateFieldsFieldMetaNumberRequest$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateTemplateFieldsTypeNumberRequest2$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: FieldCreateTemplateFieldsTextAlignNumber$outboundSchema .optional(), @@ -4388,10 +4390,10 @@ export const FieldCreateTemplateFieldsFieldMetaNumberResponse$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateTemplateFieldsFieldMetaTypeNumber$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: FieldCreateTemplateFieldsTextAlignResponse6$inboundSchema .optional(), @@ -4404,10 +4406,10 @@ export type FieldCreateTemplateFieldsFieldMetaNumberResponse$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; }; @@ -4424,10 +4426,10 @@ export const FieldCreateTemplateFieldsFieldMetaNumberResponse$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldCreateTemplateFieldsFieldMetaTypeNumber$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: FieldCreateTemplateFieldsTextAlignResponse6$outboundSchema .optional(), @@ -5258,11 +5260,11 @@ export const FieldCreateTemplateFieldsFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldCreateTemplateFieldsTypeResponse$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(), @@ -5302,15 +5304,17 @@ export const FieldCreateTemplateFieldsFieldResponse$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldCreateTemplateFieldsFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -5330,6 +5334,8 @@ export type FieldCreateTemplateFieldsFieldResponse$Outbound = { | FieldCreateTemplateFieldsFieldMetaCheckboxResponse$Outbound | FieldCreateTemplateFieldsFieldMetaDropdownResponse$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5338,11 +5344,11 @@ export const FieldCreateTemplateFieldsFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldCreateTemplateFieldsFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldCreateTemplateFieldsTypeResponse$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(), @@ -5382,6 +5388,8 @@ export const FieldCreateTemplateFieldsFieldResponse$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldgetdocumentfield.ts b/src/models/operations/fieldgetdocumentfield.ts index b2672524..328d7a68 100644 --- a/src/models/operations/fieldgetdocumentfield.ts +++ b/src/models/operations/fieldgetdocumentfield.ts @@ -127,10 +127,10 @@ export type FieldGetDocumentFieldFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldGetDocumentFieldTypeNumber; - 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?: FieldGetDocumentFieldTextAlign6 | undefined; }; @@ -282,11 +282,11 @@ export type FieldGetDocumentFieldFieldMetaUnion = * Successful response */ export type FieldGetDocumentFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldGetDocumentFieldType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -309,6 +309,8 @@ export type FieldGetDocumentFieldResponse = { | FieldGetDocumentFieldFieldMetaCheckbox | FieldGetDocumentFieldFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -949,10 +951,10 @@ export const FieldGetDocumentFieldFieldMetaNumber$inboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldGetDocumentFieldTypeNumber$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: FieldGetDocumentFieldTextAlign6$inboundSchema.optional(), }); @@ -964,10 +966,10 @@ export type FieldGetDocumentFieldFieldMetaNumber$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; }; @@ -983,10 +985,10 @@ export const FieldGetDocumentFieldFieldMetaNumber$outboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldGetDocumentFieldTypeNumber$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: FieldGetDocumentFieldTextAlign6$outboundSchema.optional(), }); @@ -1715,11 +1717,11 @@ export const FieldGetDocumentFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldGetDocumentFieldType$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(), @@ -1741,15 +1743,17 @@ export const FieldGetDocumentFieldResponse$inboundSchema: z.ZodType< z.lazy(() => FieldGetDocumentFieldFieldMetaDropdown$inboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldGetDocumentFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -1769,6 +1773,8 @@ export type FieldGetDocumentFieldResponse$Outbound = { | FieldGetDocumentFieldFieldMetaCheckbox$Outbound | FieldGetDocumentFieldFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1777,11 +1783,11 @@ export const FieldGetDocumentFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldGetDocumentFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldGetDocumentFieldType$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(), @@ -1803,6 +1809,8 @@ export const FieldGetDocumentFieldResponse$outboundSchema: z.ZodType< z.lazy(() => FieldGetDocumentFieldFieldMetaDropdown$outboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldgettemplatefield.ts b/src/models/operations/fieldgettemplatefield.ts index cbc5fcb8..b00ae2a1 100644 --- a/src/models/operations/fieldgettemplatefield.ts +++ b/src/models/operations/fieldgettemplatefield.ts @@ -127,10 +127,10 @@ export type FieldGetTemplateFieldFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldGetTemplateFieldTypeNumber; - 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?: FieldGetTemplateFieldTextAlign6 | undefined; }; @@ -282,11 +282,11 @@ export type FieldGetTemplateFieldFieldMetaUnion = * Successful response */ export type FieldGetTemplateFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldGetTemplateFieldType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -309,6 +309,8 @@ export type FieldGetTemplateFieldResponse = { | FieldGetTemplateFieldFieldMetaCheckbox | FieldGetTemplateFieldFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -949,10 +951,10 @@ export const FieldGetTemplateFieldFieldMetaNumber$inboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldGetTemplateFieldTypeNumber$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: FieldGetTemplateFieldTextAlign6$inboundSchema.optional(), }); @@ -964,10 +966,10 @@ export type FieldGetTemplateFieldFieldMetaNumber$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; }; @@ -983,10 +985,10 @@ export const FieldGetTemplateFieldFieldMetaNumber$outboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldGetTemplateFieldTypeNumber$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: FieldGetTemplateFieldTextAlign6$outboundSchema.optional(), }); @@ -1715,11 +1717,11 @@ export const FieldGetTemplateFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldGetTemplateFieldType$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(), @@ -1741,15 +1743,17 @@ export const FieldGetTemplateFieldResponse$inboundSchema: z.ZodType< z.lazy(() => FieldGetTemplateFieldFieldMetaDropdown$inboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldGetTemplateFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -1769,6 +1773,8 @@ export type FieldGetTemplateFieldResponse$Outbound = { | FieldGetTemplateFieldFieldMetaCheckbox$Outbound | FieldGetTemplateFieldFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1777,11 +1783,11 @@ export const FieldGetTemplateFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldGetTemplateFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldGetTemplateFieldType$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(), @@ -1803,6 +1809,8 @@ export const FieldGetTemplateFieldResponse$outboundSchema: z.ZodType< z.lazy(() => FieldGetTemplateFieldFieldMetaDropdown$outboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldupdatedocumentfield.ts b/src/models/operations/fieldupdatedocumentfield.ts index ccff8bed..f38e22e2 100644 --- a/src/models/operations/fieldupdatedocumentfield.ts +++ b/src/models/operations/fieldupdatedocumentfield.ts @@ -221,10 +221,10 @@ export type FieldUpdateDocumentFieldFieldMetaNumberRequest = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldUpdateDocumentFieldTypeNumberRequest2; - 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?: FieldUpdateDocumentFieldTextAlignNumber | undefined; }; @@ -784,10 +784,10 @@ export type FieldUpdateDocumentFieldFieldMetaNumberResponse = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldUpdateDocumentFieldFieldMetaTypeNumber; - 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?: FieldUpdateDocumentFieldTextAlignResponse6 | undefined; }; @@ -939,11 +939,11 @@ export type FieldUpdateDocumentFieldFieldMetaUnion = * Successful response */ export type FieldUpdateDocumentFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldUpdateDocumentFieldTypeResponse; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -966,6 +966,8 @@ export type FieldUpdateDocumentFieldResponse = { | FieldUpdateDocumentFieldFieldMetaCheckboxResponse | FieldUpdateDocumentFieldFieldMetaDropdownResponse | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1931,10 +1933,10 @@ export const FieldUpdateDocumentFieldFieldMetaNumberRequest$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateDocumentFieldTypeNumberRequest2$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: FieldUpdateDocumentFieldTextAlignNumber$inboundSchema.optional(), }); @@ -1946,10 +1948,10 @@ export type FieldUpdateDocumentFieldFieldMetaNumberRequest$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; }; @@ -1966,10 +1968,10 @@ export const FieldUpdateDocumentFieldFieldMetaNumberRequest$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateDocumentFieldTypeNumberRequest2$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: FieldUpdateDocumentFieldTextAlignNumber$outboundSchema .optional(), @@ -4335,10 +4337,10 @@ export const FieldUpdateDocumentFieldFieldMetaNumberResponse$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateDocumentFieldFieldMetaTypeNumber$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: FieldUpdateDocumentFieldTextAlignResponse6$inboundSchema .optional(), @@ -4351,10 +4353,10 @@ export type FieldUpdateDocumentFieldFieldMetaNumberResponse$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; }; @@ -4371,10 +4373,10 @@ export const FieldUpdateDocumentFieldFieldMetaNumberResponse$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateDocumentFieldFieldMetaTypeNumber$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: FieldUpdateDocumentFieldTextAlignResponse6$outboundSchema .optional(), @@ -5191,11 +5193,11 @@ export const FieldUpdateDocumentFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldUpdateDocumentFieldTypeResponse$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(), @@ -5229,15 +5231,17 @@ export const FieldUpdateDocumentFieldResponse$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldUpdateDocumentFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -5257,6 +5261,8 @@ export type FieldUpdateDocumentFieldResponse$Outbound = { | FieldUpdateDocumentFieldFieldMetaCheckboxResponse$Outbound | FieldUpdateDocumentFieldFieldMetaDropdownResponse$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5265,11 +5271,11 @@ export const FieldUpdateDocumentFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldUpdateDocumentFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldUpdateDocumentFieldTypeResponse$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(), @@ -5309,6 +5315,8 @@ export const FieldUpdateDocumentFieldResponse$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldupdatedocumentfields.ts b/src/models/operations/fieldupdatedocumentfields.ts index 2c4f0432..5e6adcaf 100644 --- a/src/models/operations/fieldupdatedocumentfields.ts +++ b/src/models/operations/fieldupdatedocumentfields.ts @@ -221,10 +221,10 @@ export type FieldUpdateDocumentFieldsFieldMetaNumberRequest = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldUpdateDocumentFieldsTypeNumberRequest2; - 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?: FieldUpdateDocumentFieldsTextAlignNumber | undefined; }; @@ -785,10 +785,10 @@ export type FieldUpdateDocumentFieldsFieldMetaNumberResponse = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldUpdateDocumentFieldsFieldMetaTypeNumber; - 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?: FieldUpdateDocumentFieldsTextAlignResponse6 | undefined; }; @@ -937,11 +937,11 @@ export type FieldUpdateDocumentFieldsFieldMetaUnion = | FieldUpdateDocumentFieldsFieldMetaDropdownResponse; export type FieldUpdateDocumentFieldsFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldUpdateDocumentFieldsTypeResponse; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -964,6 +964,8 @@ export type FieldUpdateDocumentFieldsFieldResponse = { | FieldUpdateDocumentFieldsFieldMetaCheckboxResponse | FieldUpdateDocumentFieldsFieldMetaDropdownResponse | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -1943,10 +1945,10 @@ export const FieldUpdateDocumentFieldsFieldMetaNumberRequest$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateDocumentFieldsTypeNumberRequest2$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: FieldUpdateDocumentFieldsTextAlignNumber$inboundSchema .optional(), @@ -1959,10 +1961,10 @@ export type FieldUpdateDocumentFieldsFieldMetaNumberRequest$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; }; @@ -1979,10 +1981,10 @@ export const FieldUpdateDocumentFieldsFieldMetaNumberRequest$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateDocumentFieldsTypeNumberRequest2$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: FieldUpdateDocumentFieldsTextAlignNumber$outboundSchema .optional(), @@ -4388,10 +4390,10 @@ export const FieldUpdateDocumentFieldsFieldMetaNumberResponse$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateDocumentFieldsFieldMetaTypeNumber$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: FieldUpdateDocumentFieldsTextAlignResponse6$inboundSchema .optional(), @@ -4404,10 +4406,10 @@ export type FieldUpdateDocumentFieldsFieldMetaNumberResponse$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; }; @@ -4424,10 +4426,10 @@ export const FieldUpdateDocumentFieldsFieldMetaNumberResponse$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateDocumentFieldsFieldMetaTypeNumber$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: FieldUpdateDocumentFieldsTextAlignResponse6$outboundSchema .optional(), @@ -5258,11 +5260,11 @@ export const FieldUpdateDocumentFieldsFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldUpdateDocumentFieldsTypeResponse$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(), @@ -5302,15 +5304,17 @@ export const FieldUpdateDocumentFieldsFieldResponse$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldUpdateDocumentFieldsFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -5330,6 +5334,8 @@ export type FieldUpdateDocumentFieldsFieldResponse$Outbound = { | FieldUpdateDocumentFieldsFieldMetaCheckboxResponse$Outbound | FieldUpdateDocumentFieldsFieldMetaDropdownResponse$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5338,11 +5344,11 @@ export const FieldUpdateDocumentFieldsFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldUpdateDocumentFieldsFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldUpdateDocumentFieldsTypeResponse$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(), @@ -5382,6 +5388,8 @@ export const FieldUpdateDocumentFieldsFieldResponse$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldupdatetemplatefield.ts b/src/models/operations/fieldupdatetemplatefield.ts index 51a7ddf1..752fed5c 100644 --- a/src/models/operations/fieldupdatetemplatefield.ts +++ b/src/models/operations/fieldupdatetemplatefield.ts @@ -221,10 +221,10 @@ export type FieldUpdateTemplateFieldFieldMetaNumberRequest = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldUpdateTemplateFieldTypeNumberRequest2; - 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?: FieldUpdateTemplateFieldTextAlignNumber | undefined; }; @@ -784,10 +784,10 @@ export type FieldUpdateTemplateFieldFieldMetaNumberResponse = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldUpdateTemplateFieldFieldMetaTypeNumber; - 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?: FieldUpdateTemplateFieldTextAlignResponse6 | undefined; }; @@ -939,11 +939,11 @@ export type FieldUpdateTemplateFieldFieldMetaUnion = * Successful response */ export type FieldUpdateTemplateFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldUpdateTemplateFieldTypeResponse; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -966,6 +966,8 @@ export type FieldUpdateTemplateFieldResponse = { | FieldUpdateTemplateFieldFieldMetaCheckboxResponse | FieldUpdateTemplateFieldFieldMetaDropdownResponse | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1931,10 +1933,10 @@ export const FieldUpdateTemplateFieldFieldMetaNumberRequest$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateTemplateFieldTypeNumberRequest2$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: FieldUpdateTemplateFieldTextAlignNumber$inboundSchema.optional(), }); @@ -1946,10 +1948,10 @@ export type FieldUpdateTemplateFieldFieldMetaNumberRequest$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; }; @@ -1966,10 +1968,10 @@ export const FieldUpdateTemplateFieldFieldMetaNumberRequest$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateTemplateFieldTypeNumberRequest2$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: FieldUpdateTemplateFieldTextAlignNumber$outboundSchema .optional(), @@ -4335,10 +4337,10 @@ export const FieldUpdateTemplateFieldFieldMetaNumberResponse$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateTemplateFieldFieldMetaTypeNumber$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: FieldUpdateTemplateFieldTextAlignResponse6$inboundSchema .optional(), @@ -4351,10 +4353,10 @@ export type FieldUpdateTemplateFieldFieldMetaNumberResponse$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; }; @@ -4371,10 +4373,10 @@ export const FieldUpdateTemplateFieldFieldMetaNumberResponse$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateTemplateFieldFieldMetaTypeNumber$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: FieldUpdateTemplateFieldTextAlignResponse6$outboundSchema .optional(), @@ -5191,11 +5193,11 @@ export const FieldUpdateTemplateFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldUpdateTemplateFieldTypeResponse$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(), @@ -5229,15 +5231,17 @@ export const FieldUpdateTemplateFieldResponse$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldUpdateTemplateFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -5257,6 +5261,8 @@ export type FieldUpdateTemplateFieldResponse$Outbound = { | FieldUpdateTemplateFieldFieldMetaCheckboxResponse$Outbound | FieldUpdateTemplateFieldFieldMetaDropdownResponse$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5265,11 +5271,11 @@ export const FieldUpdateTemplateFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldUpdateTemplateFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldUpdateTemplateFieldTypeResponse$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(), @@ -5309,6 +5315,8 @@ export const FieldUpdateTemplateFieldResponse$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/fieldupdatetemplatefields.ts b/src/models/operations/fieldupdatetemplatefields.ts index 2d90d3cc..bbd847bc 100644 --- a/src/models/operations/fieldupdatetemplatefields.ts +++ b/src/models/operations/fieldupdatetemplatefields.ts @@ -221,10 +221,10 @@ export type FieldUpdateTemplateFieldsFieldMetaNumberRequest = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldUpdateTemplateFieldsTypeNumberRequest2; - 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?: FieldUpdateTemplateFieldsTextAlignNumber | undefined; }; @@ -785,10 +785,10 @@ export type FieldUpdateTemplateFieldsFieldMetaNumberResponse = { required?: boolean | undefined; readOnly?: boolean | undefined; type: FieldUpdateTemplateFieldsFieldMetaTypeNumber; - 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?: FieldUpdateTemplateFieldsTextAlignResponse6 | undefined; }; @@ -937,11 +937,11 @@ export type FieldUpdateTemplateFieldsFieldMetaUnion = | FieldUpdateTemplateFieldsFieldMetaDropdownResponse; export type FieldUpdateTemplateFieldsFieldResponse = { + envelopeId: string; + envelopeItemId: string; type: FieldUpdateTemplateFieldsTypeResponse; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -964,6 +964,8 @@ export type FieldUpdateTemplateFieldsFieldResponse = { | FieldUpdateTemplateFieldsFieldMetaCheckboxResponse | FieldUpdateTemplateFieldsFieldMetaDropdownResponse | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -1943,10 +1945,10 @@ export const FieldUpdateTemplateFieldsFieldMetaNumberRequest$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateTemplateFieldsTypeNumberRequest2$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: FieldUpdateTemplateFieldsTextAlignNumber$inboundSchema .optional(), @@ -1959,10 +1961,10 @@ export type FieldUpdateTemplateFieldsFieldMetaNumberRequest$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; }; @@ -1979,10 +1981,10 @@ export const FieldUpdateTemplateFieldsFieldMetaNumberRequest$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateTemplateFieldsTypeNumberRequest2$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: FieldUpdateTemplateFieldsTextAlignNumber$outboundSchema .optional(), @@ -4388,10 +4390,10 @@ export const FieldUpdateTemplateFieldsFieldMetaNumberResponse$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateTemplateFieldsFieldMetaTypeNumber$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: FieldUpdateTemplateFieldsTextAlignResponse6$inboundSchema .optional(), @@ -4404,10 +4406,10 @@ export type FieldUpdateTemplateFieldsFieldMetaNumberResponse$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; }; @@ -4424,10 +4426,10 @@ export const FieldUpdateTemplateFieldsFieldMetaNumberResponse$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: FieldUpdateTemplateFieldsFieldMetaTypeNumber$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: FieldUpdateTemplateFieldsTextAlignResponse6$outboundSchema .optional(), @@ -5258,11 +5260,11 @@ export const FieldUpdateTemplateFieldsFieldResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldUpdateTemplateFieldsTypeResponse$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(), @@ -5302,15 +5304,17 @@ export const FieldUpdateTemplateFieldsFieldResponse$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type FieldUpdateTemplateFieldsFieldResponse$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -5330,6 +5334,8 @@ export type FieldUpdateTemplateFieldsFieldResponse$Outbound = { | FieldUpdateTemplateFieldsFieldMetaCheckboxResponse$Outbound | FieldUpdateTemplateFieldsFieldMetaDropdownResponse$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -5338,11 +5344,11 @@ export const FieldUpdateTemplateFieldsFieldResponse$outboundSchema: z.ZodType< z.ZodTypeDef, FieldUpdateTemplateFieldsFieldResponse > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: FieldUpdateTemplateFieldsTypeResponse$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(), @@ -5382,6 +5388,8 @@ export const FieldUpdateTemplateFieldsFieldResponse$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/recipientcreatedocumentrecipient.ts b/src/models/operations/recipientcreatedocumentrecipient.ts index 0adbe7e3..112191e0 100644 --- a/src/models/operations/recipientcreatedocumentrecipient.ts +++ b/src/models/operations/recipientcreatedocumentrecipient.ts @@ -24,6 +24,7 @@ export type RecipientCreateDocumentRecipientRoleRequest = ClosedEnum< */ export const RecipientCreateDocumentRecipientAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -108,6 +109,7 @@ export type RecipientCreateDocumentRecipientSendStatus = ClosedEnum< */ export const RecipientCreateDocumentRecipientAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -142,13 +144,12 @@ export type RecipientCreateDocumentRecipientAuthOptions = { * Successful response */ export type RecipientCreateDocumentRecipientResponse = { + envelopeId: string; role: RecipientCreateDocumentRecipientRoleResponse; readStatus: RecipientCreateDocumentRecipientReadStatus; signingStatus: RecipientCreateDocumentRecipientSigningStatus; sendStatus: RecipientCreateDocumentRecipientSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -161,6 +162,8 @@ export type RecipientCreateDocumentRecipientResponse = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -615,13 +618,12 @@ export const RecipientCreateDocumentRecipientResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: RecipientCreateDocumentRecipientRoleResponse$inboundSchema, readStatus: RecipientCreateDocumentRecipientReadStatus$inboundSchema, signingStatus: RecipientCreateDocumentRecipientSigningStatus$inboundSchema, sendStatus: RecipientCreateDocumentRecipientSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -633,17 +635,18 @@ export const RecipientCreateDocumentRecipientResponse$inboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type RecipientCreateDocumentRecipientResponse$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; @@ -653,6 +656,8 @@ export type RecipientCreateDocumentRecipientResponse$Outbound = { authOptions: RecipientCreateDocumentRecipientAuthOptions$Outbound | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -661,13 +666,12 @@ export const RecipientCreateDocumentRecipientResponse$outboundSchema: z.ZodType< z.ZodTypeDef, RecipientCreateDocumentRecipientResponse > = z.object({ + envelopeId: z.string(), role: RecipientCreateDocumentRecipientRoleResponse$outboundSchema, readStatus: RecipientCreateDocumentRecipientReadStatus$outboundSchema, signingStatus: RecipientCreateDocumentRecipientSigningStatus$outboundSchema, sendStatus: RecipientCreateDocumentRecipientSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -679,6 +683,8 @@ export const RecipientCreateDocumentRecipientResponse$outboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/recipientcreatedocumentrecipients.ts b/src/models/operations/recipientcreatedocumentrecipients.ts index 7a407a46..d4826888 100644 --- a/src/models/operations/recipientcreatedocumentrecipients.ts +++ b/src/models/operations/recipientcreatedocumentrecipients.ts @@ -24,6 +24,7 @@ export type RecipientCreateDocumentRecipientsRoleRequest = ClosedEnum< */ export const RecipientCreateDocumentRecipientsAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -108,6 +109,7 @@ export type RecipientCreateDocumentRecipientsSendStatus = ClosedEnum< */ export const RecipientCreateDocumentRecipientsAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -139,13 +141,12 @@ export type RecipientCreateDocumentRecipientsAuthOptions = { }; export type RecipientCreateDocumentRecipientsRecipientResponse = { + envelopeId: string; role: RecipientCreateDocumentRecipientsRoleResponse; readStatus: RecipientCreateDocumentRecipientsReadStatus; signingStatus: RecipientCreateDocumentRecipientsSigningStatus; sendStatus: RecipientCreateDocumentRecipientsSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -158,6 +159,8 @@ export type RecipientCreateDocumentRecipientsRecipientResponse = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -626,13 +629,12 @@ export const RecipientCreateDocumentRecipientsRecipientResponse$inboundSchema: z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: RecipientCreateDocumentRecipientsRoleResponse$inboundSchema, readStatus: RecipientCreateDocumentRecipientsReadStatus$inboundSchema, signingStatus: RecipientCreateDocumentRecipientsSigningStatus$inboundSchema, sendStatus: RecipientCreateDocumentRecipientsSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -644,17 +646,18 @@ export const RecipientCreateDocumentRecipientsRecipientResponse$inboundSchema: ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type RecipientCreateDocumentRecipientsRecipientResponse$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; @@ -664,6 +667,8 @@ export type RecipientCreateDocumentRecipientsRecipientResponse$Outbound = { authOptions: RecipientCreateDocumentRecipientsAuthOptions$Outbound | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -673,14 +678,13 @@ export const RecipientCreateDocumentRecipientsRecipientResponse$outboundSchema: z.ZodTypeDef, RecipientCreateDocumentRecipientsRecipientResponse > = z.object({ + envelopeId: z.string(), role: RecipientCreateDocumentRecipientsRoleResponse$outboundSchema, readStatus: RecipientCreateDocumentRecipientsReadStatus$outboundSchema, signingStatus: RecipientCreateDocumentRecipientsSigningStatus$outboundSchema, sendStatus: RecipientCreateDocumentRecipientsSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -692,6 +696,8 @@ export const RecipientCreateDocumentRecipientsRecipientResponse$outboundSchema: ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/recipientcreatetemplaterecipient.ts b/src/models/operations/recipientcreatetemplaterecipient.ts index ea45af1a..ebc12558 100644 --- a/src/models/operations/recipientcreatetemplaterecipient.ts +++ b/src/models/operations/recipientcreatetemplaterecipient.ts @@ -24,6 +24,7 @@ export type RecipientCreateTemplateRecipientRoleRequest = ClosedEnum< */ export const RecipientCreateTemplateRecipientAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -108,6 +109,7 @@ export type RecipientCreateTemplateRecipientSendStatus = ClosedEnum< */ export const RecipientCreateTemplateRecipientAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -142,13 +144,12 @@ export type RecipientCreateTemplateRecipientAuthOptions = { * Successful response */ export type RecipientCreateTemplateRecipientResponse = { + envelopeId: string; role: RecipientCreateTemplateRecipientRoleResponse; readStatus: RecipientCreateTemplateRecipientReadStatus; signingStatus: RecipientCreateTemplateRecipientSigningStatus; sendStatus: RecipientCreateTemplateRecipientSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -161,6 +162,8 @@ export type RecipientCreateTemplateRecipientResponse = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -615,13 +618,12 @@ export const RecipientCreateTemplateRecipientResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: RecipientCreateTemplateRecipientRoleResponse$inboundSchema, readStatus: RecipientCreateTemplateRecipientReadStatus$inboundSchema, signingStatus: RecipientCreateTemplateRecipientSigningStatus$inboundSchema, sendStatus: RecipientCreateTemplateRecipientSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -633,17 +635,18 @@ export const RecipientCreateTemplateRecipientResponse$inboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type RecipientCreateTemplateRecipientResponse$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; @@ -653,6 +656,8 @@ export type RecipientCreateTemplateRecipientResponse$Outbound = { authOptions: RecipientCreateTemplateRecipientAuthOptions$Outbound | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -661,13 +666,12 @@ export const RecipientCreateTemplateRecipientResponse$outboundSchema: z.ZodType< z.ZodTypeDef, RecipientCreateTemplateRecipientResponse > = z.object({ + envelopeId: z.string(), role: RecipientCreateTemplateRecipientRoleResponse$outboundSchema, readStatus: RecipientCreateTemplateRecipientReadStatus$outboundSchema, signingStatus: RecipientCreateTemplateRecipientSigningStatus$outboundSchema, sendStatus: RecipientCreateTemplateRecipientSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -679,6 +683,8 @@ export const RecipientCreateTemplateRecipientResponse$outboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/recipientcreatetemplaterecipients.ts b/src/models/operations/recipientcreatetemplaterecipients.ts index 095e82f6..d58cc59c 100644 --- a/src/models/operations/recipientcreatetemplaterecipients.ts +++ b/src/models/operations/recipientcreatetemplaterecipients.ts @@ -24,6 +24,7 @@ export type RecipientCreateTemplateRecipientsRoleRequest = ClosedEnum< */ export const RecipientCreateTemplateRecipientsAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -108,6 +109,7 @@ export type RecipientCreateTemplateRecipientsSendStatus = ClosedEnum< */ export const RecipientCreateTemplateRecipientsAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -139,13 +141,12 @@ export type RecipientCreateTemplateRecipientsAuthOptions = { }; export type RecipientCreateTemplateRecipientsRecipientResponse = { + envelopeId: string; role: RecipientCreateTemplateRecipientsRoleResponse; readStatus: RecipientCreateTemplateRecipientsReadStatus; signingStatus: RecipientCreateTemplateRecipientsSigningStatus; sendStatus: RecipientCreateTemplateRecipientsSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -158,6 +159,8 @@ export type RecipientCreateTemplateRecipientsRecipientResponse = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -626,13 +629,12 @@ export const RecipientCreateTemplateRecipientsRecipientResponse$inboundSchema: z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: RecipientCreateTemplateRecipientsRoleResponse$inboundSchema, readStatus: RecipientCreateTemplateRecipientsReadStatus$inboundSchema, signingStatus: RecipientCreateTemplateRecipientsSigningStatus$inboundSchema, sendStatus: RecipientCreateTemplateRecipientsSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -644,17 +646,18 @@ export const RecipientCreateTemplateRecipientsRecipientResponse$inboundSchema: ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type RecipientCreateTemplateRecipientsRecipientResponse$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; @@ -664,6 +667,8 @@ export type RecipientCreateTemplateRecipientsRecipientResponse$Outbound = { authOptions: RecipientCreateTemplateRecipientsAuthOptions$Outbound | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -673,14 +678,13 @@ export const RecipientCreateTemplateRecipientsRecipientResponse$outboundSchema: z.ZodTypeDef, RecipientCreateTemplateRecipientsRecipientResponse > = z.object({ + envelopeId: z.string(), role: RecipientCreateTemplateRecipientsRoleResponse$outboundSchema, readStatus: RecipientCreateTemplateRecipientsReadStatus$outboundSchema, signingStatus: RecipientCreateTemplateRecipientsSigningStatus$outboundSchema, sendStatus: RecipientCreateTemplateRecipientsSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -692,6 +696,8 @@ export const RecipientCreateTemplateRecipientsRecipientResponse$outboundSchema: ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/recipientgetdocumentrecipient.ts b/src/models/operations/recipientgetdocumentrecipient.ts index 550aa0af..6e9a5c68 100644 --- a/src/models/operations/recipientgetdocumentrecipient.ts +++ b/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. @@ -198,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; }; @@ -350,11 +351,11 @@ export type RecipientGetDocumentRecipientFieldMetaUnion = | 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. @@ -377,19 +378,20 @@ export type RecipientGetDocumentRecipientField = { | 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; @@ -403,6 +405,8 @@ export type RecipientGetDocumentRecipientResponse = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1308,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(), }); @@ -1323,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; }; @@ -1343,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(), @@ -2155,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(), @@ -2187,15 +2191,17 @@ export const RecipientGetDocumentRecipientField$inboundSchema: z.ZodType< ), ]), ), + 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; @@ -2215,6 +2221,8 @@ export type RecipientGetDocumentRecipientField$Outbound = { | RecipientGetDocumentRecipientFieldMetaCheckbox$Outbound | RecipientGetDocumentRecipientFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2223,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(), @@ -2255,6 +2263,8 @@ export const RecipientGetDocumentRecipientField$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2298,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(), @@ -2319,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; @@ -2340,6 +2350,8 @@ export type RecipientGetDocumentRecipientResponse$Outbound = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2348,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(), @@ -2369,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(), }); /** diff --git a/src/models/operations/recipientgettemplaterecipient.ts b/src/models/operations/recipientgettemplaterecipient.ts index 061e4cd3..36b90186 100644 --- a/src/models/operations/recipientgettemplaterecipient.ts +++ b/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. @@ -198,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; }; @@ -350,11 +351,11 @@ export type RecipientGetTemplateRecipientFieldMetaUnion = | 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. @@ -377,19 +378,20 @@ export type RecipientGetTemplateRecipientField = { | 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; @@ -403,6 +405,8 @@ export type RecipientGetTemplateRecipientResponse = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1308,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(), }); @@ -1323,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; }; @@ -1343,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(), @@ -2155,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(), @@ -2187,15 +2191,17 @@ export const RecipientGetTemplateRecipientField$inboundSchema: z.ZodType< ), ]), ), + 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; @@ -2215,6 +2221,8 @@ export type RecipientGetTemplateRecipientField$Outbound = { | RecipientGetTemplateRecipientFieldMetaCheckbox$Outbound | RecipientGetTemplateRecipientFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2223,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(), @@ -2255,6 +2263,8 @@ export const RecipientGetTemplateRecipientField$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2298,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(), @@ -2319,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; @@ -2340,6 +2350,8 @@ export type RecipientGetTemplateRecipientResponse$Outbound = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2348,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(), @@ -2369,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(), }); /** diff --git a/src/models/operations/recipientupdatedocumentrecipient.ts b/src/models/operations/recipientupdatedocumentrecipient.ts index 31a371f6..a96e9575 100644 --- a/src/models/operations/recipientupdatedocumentrecipient.ts +++ b/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. @@ -257,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; }; @@ -409,11 +411,11 @@ export type RecipientUpdateDocumentRecipientFieldMetaUnion = | 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. @@ -436,19 +438,20 @@ export type RecipientUpdateDocumentRecipientField = { | 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; @@ -462,6 +465,8 @@ export type RecipientUpdateDocumentRecipientResponse = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1556,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(), @@ -1572,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; }; @@ -1592,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(), @@ -2428,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(), @@ -2466,15 +2471,17 @@ export const RecipientUpdateDocumentRecipientField$inboundSchema: z.ZodType< ), ]), ), + 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; @@ -2494,6 +2501,8 @@ export type RecipientUpdateDocumentRecipientField$Outbound = { | RecipientUpdateDocumentRecipientFieldMetaCheckbox$Outbound | RecipientUpdateDocumentRecipientFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2502,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(), @@ -2546,6 +2555,8 @@ export const RecipientUpdateDocumentRecipientField$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2590,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(), @@ -2611,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; @@ -2632,6 +2643,8 @@ export type RecipientUpdateDocumentRecipientResponse$Outbound = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2640,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(), @@ -2661,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(), }); /** diff --git a/src/models/operations/recipientupdatedocumentrecipients.ts b/src/models/operations/recipientupdatedocumentrecipients.ts index b0acaee2..c2783170 100644 --- a/src/models/operations/recipientupdatedocumentrecipients.ts +++ b/src/models/operations/recipientupdatedocumentrecipients.ts @@ -24,6 +24,7 @@ export type RecipientUpdateDocumentRecipientsRoleRequest = ClosedEnum< */ export const RecipientUpdateDocumentRecipientsAccessAuthRequest = { 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 RecipientUpdateDocumentRecipientsSendStatus = ClosedEnum< */ export const RecipientUpdateDocumentRecipientsAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -257,10 +259,10 @@ export type RecipientUpdateDocumentRecipientsFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: RecipientUpdateDocumentRecipientsTypeNumber; - 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?: RecipientUpdateDocumentRecipientsTextAlign6 | undefined; }; @@ -409,11 +411,11 @@ export type RecipientUpdateDocumentRecipientsFieldMetaUnion = | RecipientUpdateDocumentRecipientsFieldMetaDropdown; export type RecipientUpdateDocumentRecipientsField = { + envelopeId: string; + envelopeItemId: string; type: RecipientUpdateDocumentRecipientsType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -436,16 +438,17 @@ export type RecipientUpdateDocumentRecipientsField = { | RecipientUpdateDocumentRecipientsFieldMetaCheckbox | RecipientUpdateDocumentRecipientsFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export type RecipientUpdateDocumentRecipientsRecipientResponse = { + envelopeId: string; role: RecipientUpdateDocumentRecipientsRoleResponse; readStatus: RecipientUpdateDocumentRecipientsReadStatus; signingStatus: RecipientUpdateDocumentRecipientsSigningStatus; sendStatus: RecipientUpdateDocumentRecipientsSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -459,6 +462,8 @@ export type RecipientUpdateDocumentRecipientsRecipientResponse = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -1581,10 +1586,10 @@ export const RecipientUpdateDocumentRecipientsFieldMetaNumber$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: RecipientUpdateDocumentRecipientsTypeNumber$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: RecipientUpdateDocumentRecipientsTextAlign6$inboundSchema .optional(), @@ -1597,10 +1602,10 @@ export type RecipientUpdateDocumentRecipientsFieldMetaNumber$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; }; @@ -1617,10 +1622,10 @@ export const RecipientUpdateDocumentRecipientsFieldMetaNumber$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: RecipientUpdateDocumentRecipientsTypeNumber$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: RecipientUpdateDocumentRecipientsTextAlign6$outboundSchema .optional(), @@ -2462,11 +2467,11 @@ export const RecipientUpdateDocumentRecipientsField$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: RecipientUpdateDocumentRecipientsType$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(), @@ -2506,15 +2511,17 @@ export const RecipientUpdateDocumentRecipientsField$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type RecipientUpdateDocumentRecipientsField$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -2534,6 +2541,8 @@ export type RecipientUpdateDocumentRecipientsField$Outbound = { | RecipientUpdateDocumentRecipientsFieldMetaCheckbox$Outbound | RecipientUpdateDocumentRecipientsFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2542,11 +2551,11 @@ export const RecipientUpdateDocumentRecipientsField$outboundSchema: z.ZodType< z.ZodTypeDef, RecipientUpdateDocumentRecipientsField > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: RecipientUpdateDocumentRecipientsType$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(), @@ -2586,6 +2595,8 @@ export const RecipientUpdateDocumentRecipientsField$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2632,13 +2643,12 @@ export const RecipientUpdateDocumentRecipientsRecipientResponse$inboundSchema: z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: RecipientUpdateDocumentRecipientsRoleResponse$inboundSchema, readStatus: RecipientUpdateDocumentRecipientsReadStatus$inboundSchema, signingStatus: RecipientUpdateDocumentRecipientsSigningStatus$inboundSchema, sendStatus: RecipientUpdateDocumentRecipientsSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2653,17 +2663,18 @@ export const RecipientUpdateDocumentRecipientsRecipientResponse$inboundSchema: fields: z.array( z.lazy(() => RecipientUpdateDocumentRecipientsField$inboundSchema), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type RecipientUpdateDocumentRecipientsRecipientResponse$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; @@ -2674,6 +2685,8 @@ export type RecipientUpdateDocumentRecipientsRecipientResponse$Outbound = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2683,14 +2696,13 @@ export const RecipientUpdateDocumentRecipientsRecipientResponse$outboundSchema: z.ZodTypeDef, RecipientUpdateDocumentRecipientsRecipientResponse > = z.object({ + envelopeId: z.string(), role: RecipientUpdateDocumentRecipientsRoleResponse$outboundSchema, readStatus: RecipientUpdateDocumentRecipientsReadStatus$outboundSchema, signingStatus: RecipientUpdateDocumentRecipientsSigningStatus$outboundSchema, sendStatus: RecipientUpdateDocumentRecipientsSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2705,6 +2717,8 @@ export const RecipientUpdateDocumentRecipientsRecipientResponse$outboundSchema: fields: z.array( z.lazy(() => RecipientUpdateDocumentRecipientsField$outboundSchema), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/recipientupdatetemplaterecipient.ts b/src/models/operations/recipientupdatetemplaterecipient.ts index bd2dc7e4..c2185fc6 100644 --- a/src/models/operations/recipientupdatetemplaterecipient.ts +++ b/src/models/operations/recipientupdatetemplaterecipient.ts @@ -24,6 +24,7 @@ export type RecipientUpdateTemplateRecipientRoleRequest = ClosedEnum< */ export const RecipientUpdateTemplateRecipientAccessAuthRequest = { 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 RecipientUpdateTemplateRecipientSendStatus = ClosedEnum< */ export const RecipientUpdateTemplateRecipientAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -257,10 +259,10 @@ export type RecipientUpdateTemplateRecipientFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: RecipientUpdateTemplateRecipientTypeNumber; - 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?: RecipientUpdateTemplateRecipientTextAlign6 | undefined; }; @@ -409,11 +411,11 @@ export type RecipientUpdateTemplateRecipientFieldMetaUnion = | RecipientUpdateTemplateRecipientFieldMetaDropdown; export type RecipientUpdateTemplateRecipientField = { + envelopeId: string; + envelopeItemId: string; type: RecipientUpdateTemplateRecipientType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -436,19 +438,20 @@ export type RecipientUpdateTemplateRecipientField = { | RecipientUpdateTemplateRecipientFieldMetaCheckbox | RecipientUpdateTemplateRecipientFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** * Successful response */ export type RecipientUpdateTemplateRecipientResponse = { + envelopeId: string; role: RecipientUpdateTemplateRecipientRoleResponse; readStatus: RecipientUpdateTemplateRecipientReadStatus; signingStatus: RecipientUpdateTemplateRecipientSigningStatus; sendStatus: RecipientUpdateTemplateRecipientSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -462,6 +465,8 @@ export type RecipientUpdateTemplateRecipientResponse = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1556,10 +1561,10 @@ export const RecipientUpdateTemplateRecipientFieldMetaNumber$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: RecipientUpdateTemplateRecipientTypeNumber$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: RecipientUpdateTemplateRecipientTextAlign6$inboundSchema .optional(), @@ -1572,10 +1577,10 @@ export type RecipientUpdateTemplateRecipientFieldMetaNumber$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; }; @@ -1592,10 +1597,10 @@ export const RecipientUpdateTemplateRecipientFieldMetaNumber$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: RecipientUpdateTemplateRecipientTypeNumber$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: RecipientUpdateTemplateRecipientTextAlign6$outboundSchema .optional(), @@ -2428,11 +2433,11 @@ export const RecipientUpdateTemplateRecipientField$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: RecipientUpdateTemplateRecipientType$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(), @@ -2466,15 +2471,17 @@ export const RecipientUpdateTemplateRecipientField$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type RecipientUpdateTemplateRecipientField$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -2494,6 +2501,8 @@ export type RecipientUpdateTemplateRecipientField$Outbound = { | RecipientUpdateTemplateRecipientFieldMetaCheckbox$Outbound | RecipientUpdateTemplateRecipientFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2502,11 +2511,11 @@ export const RecipientUpdateTemplateRecipientField$outboundSchema: z.ZodType< z.ZodTypeDef, RecipientUpdateTemplateRecipientField > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: RecipientUpdateTemplateRecipientType$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(), @@ -2546,6 +2555,8 @@ export const RecipientUpdateTemplateRecipientField$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2590,13 +2601,12 @@ export const RecipientUpdateTemplateRecipientResponse$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: RecipientUpdateTemplateRecipientRoleResponse$inboundSchema, readStatus: RecipientUpdateTemplateRecipientReadStatus$inboundSchema, signingStatus: RecipientUpdateTemplateRecipientSigningStatus$inboundSchema, sendStatus: RecipientUpdateTemplateRecipientSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2611,17 +2621,18 @@ export const RecipientUpdateTemplateRecipientResponse$inboundSchema: z.ZodType< fields: z.array( z.lazy(() => RecipientUpdateTemplateRecipientField$inboundSchema), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type RecipientUpdateTemplateRecipientResponse$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; @@ -2632,6 +2643,8 @@ export type RecipientUpdateTemplateRecipientResponse$Outbound = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2640,13 +2653,12 @@ export const RecipientUpdateTemplateRecipientResponse$outboundSchema: z.ZodType< z.ZodTypeDef, RecipientUpdateTemplateRecipientResponse > = z.object({ + envelopeId: z.string(), role: RecipientUpdateTemplateRecipientRoleResponse$outboundSchema, readStatus: RecipientUpdateTemplateRecipientReadStatus$outboundSchema, signingStatus: RecipientUpdateTemplateRecipientSigningStatus$outboundSchema, sendStatus: RecipientUpdateTemplateRecipientSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2661,6 +2673,8 @@ export const RecipientUpdateTemplateRecipientResponse$outboundSchema: z.ZodType< fields: z.array( z.lazy(() => RecipientUpdateTemplateRecipientField$outboundSchema), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** diff --git a/src/models/operations/recipientupdatetemplaterecipients.ts b/src/models/operations/recipientupdatetemplaterecipients.ts index 50c52344..d595db4b 100644 --- a/src/models/operations/recipientupdatetemplaterecipients.ts +++ b/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. @@ -257,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; }; @@ -409,11 +411,11 @@ export type RecipientUpdateTemplateRecipientsFieldMetaUnion = | 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. @@ -436,16 +438,17 @@ export type RecipientUpdateTemplateRecipientsField = { | 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; @@ -459,6 +462,8 @@ export type RecipientUpdateTemplateRecipientsRecipientResponse = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -1581,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(), @@ -1597,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; }; @@ -1617,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(), @@ -2462,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(), @@ -2506,15 +2511,17 @@ export const RecipientUpdateTemplateRecipientsField$inboundSchema: z.ZodType< ), ]), ), + 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; @@ -2534,6 +2541,8 @@ export type RecipientUpdateTemplateRecipientsField$Outbound = { | RecipientUpdateTemplateRecipientsFieldMetaCheckbox$Outbound | RecipientUpdateTemplateRecipientsFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2542,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(), @@ -2586,6 +2595,8 @@ export const RecipientUpdateTemplateRecipientsField$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2632,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(), @@ -2653,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; @@ -2674,6 +2685,8 @@ export type RecipientUpdateTemplateRecipientsRecipientResponse$Outbound = { signingOrder: number | null; rejectionReason: string | null; fields: Array; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2683,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(), @@ -2705,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(), }); /** diff --git a/src/models/operations/templatecreatedocumentfromtemplate.ts b/src/models/operations/templatecreatedocumentfromtemplate.ts index f5203086..2e889ca0 100644 --- a/src/models/operations/templatecreatedocumentfromtemplate.ts +++ b/src/models/operations/templatecreatedocumentfromtemplate.ts @@ -17,6 +17,11 @@ export type TemplateCreateDocumentFromTemplateRecipientRequest = { name?: string | undefined; }; +export type CustomDocumentDatum = { + documentDataId: string; + envelopeItemId: string; +}; + export const PrefillFieldTypeDate = { Date: "date", } as const; @@ -113,9 +118,13 @@ export type TemplateCreateDocumentFromTemplateRequest = { */ distributeDocument?: boolean | undefined; /** - * The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. + * [DEPRECATED] - Use customDocumentData instead. The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. */ customDocumentDataId?: string | undefined; + /** + * The data IDs of alternative PDFs to use when creating the document. If not provided, the PDF attached to the template will be used. + */ + customDocumentData?: Array | undefined; /** * The ID of the folder to create the document in. If not provided, the document will be created in the root folder. */ @@ -168,6 +177,7 @@ export type TemplateCreateDocumentFromTemplateSource = ClosedEnum< */ export const TemplateCreateDocumentFromTemplateGlobalAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -216,6 +226,7 @@ export type TemplateCreateDocumentFromTemplateDocumentData = { id: string; data: string; initialData: string; + envelopeItemId: string; }; export const TemplateCreateDocumentFromTemplateSigningOrder = { @@ -272,9 +283,7 @@ export type TemplateCreateDocumentFromTemplateDocumentMeta = { subject: string | null; message: string | null; timezone: string | null; - password: string | null; dateFormat: string | null; - documentId: number; redirectUrl: string | null; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; @@ -284,6 +293,8 @@ export type TemplateCreateDocumentFromTemplateDocumentMeta = { emailSettings: TemplateCreateDocumentFromTemplateEmailSettings | null; emailId: string | null; emailReplyTo: string | null; + password?: string | null | undefined; + documentId?: number | undefined; }; export const TemplateCreateDocumentFromTemplateFolderType = { @@ -357,6 +368,7 @@ export type TemplateCreateDocumentFromTemplateSendStatus = ClosedEnum< */ export const TemplateCreateDocumentFromTemplateAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -388,13 +400,12 @@ export type TemplateCreateDocumentFromTemplateRecipientAuthOptions = { }; export type TemplateCreateDocumentFromTemplateRecipientResponse = { + envelopeId: string; role: TemplateCreateDocumentFromTemplateRole; readStatus: TemplateCreateDocumentFromTemplateReadStatus; signingStatus: TemplateCreateDocumentFromTemplateSigningStatus; sendStatus: TemplateCreateDocumentFromTemplateSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -407,6 +418,8 @@ export type TemplateCreateDocumentFromTemplateRecipientResponse = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const TemplateCreateDocumentFromTemplateFieldType = { @@ -522,10 +535,10 @@ export type TemplateCreateDocumentFromTemplateFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: TemplateCreateDocumentFromTemplateFieldMetaTypeNumber; - 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?: TemplateCreateDocumentFromTemplateTextAlign6 | undefined; }; @@ -674,11 +687,11 @@ export type TemplateCreateDocumentFromTemplateFieldMetaUnion = | TemplateCreateDocumentFromTemplateFieldMetaDropdown; export type TemplateCreateDocumentFromTemplateField = { + envelopeId: string; + envelopeItemId: string; type: TemplateCreateDocumentFromTemplateFieldType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -701,6 +714,8 @@ export type TemplateCreateDocumentFromTemplateField = { | TemplateCreateDocumentFromTemplateFieldMetaCheckbox | TemplateCreateDocumentFromTemplateFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @@ -722,16 +737,20 @@ export type TemplateCreateDocumentFromTemplateResponse = { authOptions: TemplateCreateDocumentFromTemplateAuthOptions | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; + envelopeId: string; + /** + * The ID of the template that the document was created from, if any. + */ + templateId?: number | null | undefined; + documentDataId?: string | undefined; documentData: TemplateCreateDocumentFromTemplateDocumentData; - documentMeta: TemplateCreateDocumentFromTemplateDocumentMeta | null; + documentMeta: TemplateCreateDocumentFromTemplateDocumentMeta; folder: TemplateCreateDocumentFromTemplateFolder | null; recipients: Array; fields: Array; @@ -811,6 +830,63 @@ export function templateCreateDocumentFromTemplateRecipientRequestFromJSON( ); } +/** @internal */ +export const CustomDocumentDatum$inboundSchema: z.ZodType< + CustomDocumentDatum, + z.ZodTypeDef, + unknown +> = z.object({ + documentDataId: z.string(), + envelopeItemId: z.string(), +}); + +/** @internal */ +export type CustomDocumentDatum$Outbound = { + documentDataId: string; + envelopeItemId: string; +}; + +/** @internal */ +export const CustomDocumentDatum$outboundSchema: z.ZodType< + CustomDocumentDatum$Outbound, + z.ZodTypeDef, + CustomDocumentDatum +> = z.object({ + documentDataId: z.string(), + envelopeItemId: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomDocumentDatum$ { + /** @deprecated use `CustomDocumentDatum$inboundSchema` instead. */ + export const inboundSchema = CustomDocumentDatum$inboundSchema; + /** @deprecated use `CustomDocumentDatum$outboundSchema` instead. */ + export const outboundSchema = CustomDocumentDatum$outboundSchema; + /** @deprecated use `CustomDocumentDatum$Outbound` instead. */ + export type Outbound = CustomDocumentDatum$Outbound; +} + +export function customDocumentDatumToJSON( + customDocumentDatum: CustomDocumentDatum, +): string { + return JSON.stringify( + CustomDocumentDatum$outboundSchema.parse(customDocumentDatum), + ); +} + +export function customDocumentDatumFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => CustomDocumentDatum$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'CustomDocumentDatum' from JSON`, + ); +} + /** @internal */ export const PrefillFieldTypeDate$inboundSchema: z.ZodNativeEnum< typeof PrefillFieldTypeDate @@ -1396,6 +1472,8 @@ export const TemplateCreateDocumentFromTemplateRequest$inboundSchema: z.ZodType< ), distributeDocument: z.boolean().optional(), customDocumentDataId: z.string().optional(), + customDocumentData: z.array(z.lazy(() => CustomDocumentDatum$inboundSchema)) + .optional(), folderId: z.string().optional(), prefillFields: z.array( z.union([ @@ -1417,6 +1495,7 @@ export type TemplateCreateDocumentFromTemplateRequest$Outbound = { >; distributeDocument?: boolean | undefined; customDocumentDataId?: string | undefined; + customDocumentData?: Array | undefined; folderId?: string | undefined; prefillFields?: | Array< @@ -1445,6 +1524,9 @@ export const TemplateCreateDocumentFromTemplateRequest$outboundSchema: ), distributeDocument: z.boolean().optional(), customDocumentDataId: z.string().optional(), + customDocumentData: z.array( + z.lazy(() => CustomDocumentDatum$outboundSchema), + ).optional(), folderId: z.string().optional(), prefillFields: z.array( z.union([ @@ -1791,6 +1873,7 @@ export const TemplateCreateDocumentFromTemplateDocumentData$inboundSchema: id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @internal */ @@ -1799,6 +1882,7 @@ export type TemplateCreateDocumentFromTemplateDocumentData$Outbound = { id: string; data: string; initialData: string; + envelopeItemId: string; }; /** @internal */ @@ -1812,6 +1896,7 @@ export const TemplateCreateDocumentFromTemplateDocumentData$outboundSchema: id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @@ -2003,9 +2088,7 @@ export const TemplateCreateDocumentFromTemplateDocumentMeta$inboundSchema: subject: z.nullable(z.string()), message: z.nullable(z.string()), timezone: z.nullable(z.string()), - password: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - documentId: z.number(), redirectUrl: z.nullable(z.string()), typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), @@ -2019,6 +2102,8 @@ export const TemplateCreateDocumentFromTemplateDocumentMeta$inboundSchema: ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + password: z.nullable(z.string()).default(null), + documentId: z.number().default(-1), }); /** @internal */ @@ -2029,9 +2114,7 @@ export type TemplateCreateDocumentFromTemplateDocumentMeta$Outbound = { subject: string | null; message: string | null; timezone: string | null; - password: string | null; dateFormat: string | null; - documentId: number; redirectUrl: string | null; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; @@ -2043,6 +2126,8 @@ export type TemplateCreateDocumentFromTemplateDocumentMeta$Outbound = { | null; emailId: string | null; emailReplyTo: string | null; + password: string | null; + documentId: number; }; /** @internal */ @@ -2059,9 +2144,7 @@ export const TemplateCreateDocumentFromTemplateDocumentMeta$outboundSchema: subject: z.nullable(z.string()), message: z.nullable(z.string()), timezone: z.nullable(z.string()), - password: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - documentId: z.number(), redirectUrl: z.nullable(z.string()), typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), @@ -2075,6 +2158,8 @@ export const TemplateCreateDocumentFromTemplateDocumentMeta$outboundSchema: ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + password: z.nullable(z.string()).default(null), + documentId: z.number().default(-1), }); /** @@ -2482,14 +2567,13 @@ export const TemplateCreateDocumentFromTemplateRecipientResponse$inboundSchema: z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: TemplateCreateDocumentFromTemplateRole$inboundSchema, readStatus: TemplateCreateDocumentFromTemplateReadStatus$inboundSchema, signingStatus: TemplateCreateDocumentFromTemplateSigningStatus$inboundSchema, sendStatus: TemplateCreateDocumentFromTemplateSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2503,17 +2587,18 @@ export const TemplateCreateDocumentFromTemplateRecipientResponse$inboundSchema: ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type TemplateCreateDocumentFromTemplateRecipientResponse$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; @@ -2525,6 +2610,8 @@ export type TemplateCreateDocumentFromTemplateRecipientResponse$Outbound = { | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2534,14 +2621,13 @@ export const TemplateCreateDocumentFromTemplateRecipientResponse$outboundSchema: z.ZodTypeDef, TemplateCreateDocumentFromTemplateRecipientResponse > = z.object({ + envelopeId: z.string(), role: TemplateCreateDocumentFromTemplateRole$outboundSchema, readStatus: TemplateCreateDocumentFromTemplateReadStatus$outboundSchema, signingStatus: TemplateCreateDocumentFromTemplateSigningStatus$outboundSchema, sendStatus: TemplateCreateDocumentFromTemplateSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2555,6 +2641,8 @@ export const TemplateCreateDocumentFromTemplateRecipientResponse$outboundSchema: ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -3263,10 +3351,10 @@ export const TemplateCreateDocumentFromTemplateFieldMetaNumber$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: TemplateCreateDocumentFromTemplateFieldMetaTypeNumber$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: TemplateCreateDocumentFromTemplateTextAlign6$inboundSchema .optional(), @@ -3279,10 +3367,10 @@ export type TemplateCreateDocumentFromTemplateFieldMetaNumber$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; }; @@ -3299,10 +3387,10 @@ export const TemplateCreateDocumentFromTemplateFieldMetaNumber$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: TemplateCreateDocumentFromTemplateFieldMetaTypeNumber$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: TemplateCreateDocumentFromTemplateTextAlign6$outboundSchema .optional(), @@ -4154,11 +4242,11 @@ export const TemplateCreateDocumentFromTemplateField$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: TemplateCreateDocumentFromTemplateFieldType$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(), @@ -4198,15 +4286,17 @@ export const TemplateCreateDocumentFromTemplateField$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type TemplateCreateDocumentFromTemplateField$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -4226,6 +4316,8 @@ export type TemplateCreateDocumentFromTemplateField$Outbound = { | TemplateCreateDocumentFromTemplateFieldMetaCheckbox$Outbound | TemplateCreateDocumentFromTemplateFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -4234,11 +4326,11 @@ export const TemplateCreateDocumentFromTemplateField$outboundSchema: z.ZodType< z.ZodTypeDef, TemplateCreateDocumentFromTemplateField > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: TemplateCreateDocumentFromTemplateFieldType$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(), @@ -4278,6 +4370,8 @@ export const TemplateCreateDocumentFromTemplateField$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -4341,21 +4435,20 @@ export const TemplateCreateDocumentFromTemplateResponse$inboundSchema: z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateId: z.nullable(z.number()).optional(), + documentDataId: z.string().default(""), documentData: z.lazy(() => TemplateCreateDocumentFromTemplateDocumentData$inboundSchema ), - documentMeta: z.nullable( - z.lazy(() => - TemplateCreateDocumentFromTemplateDocumentMeta$inboundSchema - ), + documentMeta: z.lazy(() => + TemplateCreateDocumentFromTemplateDocumentMeta$inboundSchema ), folder: z.nullable( z.lazy(() => TemplateCreateDocumentFromTemplateFolder$inboundSchema), @@ -4381,16 +4474,17 @@ export type TemplateCreateDocumentFromTemplateResponse$Outbound = { authOptions: TemplateCreateDocumentFromTemplateAuthOptions$Outbound | null; formValues: { [k: string]: string | boolean | number } | null; title: string; - documentDataId: string; createdAt: string; updatedAt: string; completedAt: string | null; deletedAt: string | null; teamId: number; - templateId: number | null; folderId: string | null; + envelopeId: string; + templateId?: number | null | undefined; + documentDataId: string; documentData: TemplateCreateDocumentFromTemplateDocumentData$Outbound; - documentMeta: TemplateCreateDocumentFromTemplateDocumentMeta$Outbound | null; + documentMeta: TemplateCreateDocumentFromTemplateDocumentMeta$Outbound; folder: TemplateCreateDocumentFromTemplateFolder$Outbound | null; recipients: Array< TemplateCreateDocumentFromTemplateRecipientResponse$Outbound @@ -4420,21 +4514,20 @@ export const TemplateCreateDocumentFromTemplateResponse$outboundSchema: z.record(z.union([z.string(), z.boolean(), z.number()])), ), title: z.string(), - documentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), completedAt: z.nullable(z.string()), deletedAt: z.nullable(z.string()), teamId: z.number(), - templateId: z.nullable(z.number()), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateId: z.nullable(z.number()).optional(), + documentDataId: z.string().default(""), documentData: z.lazy(() => TemplateCreateDocumentFromTemplateDocumentData$outboundSchema ), - documentMeta: z.nullable( - z.lazy(() => - TemplateCreateDocumentFromTemplateDocumentMeta$outboundSchema - ), + documentMeta: z.lazy(() => + TemplateCreateDocumentFromTemplateDocumentMeta$outboundSchema ), folder: z.nullable( z.lazy(() => TemplateCreateDocumentFromTemplateFolder$outboundSchema), diff --git a/src/models/operations/templatecreatetemplatedirectlink.ts b/src/models/operations/templatecreatetemplatedirectlink.ts index cfb408db..e659648f 100644 --- a/src/models/operations/templatecreatetemplatedirectlink.ts +++ b/src/models/operations/templatecreatetemplatedirectlink.ts @@ -20,11 +20,12 @@ export type TemplateCreateTemplateDirectLinkRequest = { */ export type TemplateCreateTemplateDirectLinkResponse = { id: string; - templateId: number; token: string; createdAt: string; enabled: boolean; directTemplateRecipientId: number; + envelopeId: string; + templateId: number; }; /** @internal */ @@ -102,21 +103,23 @@ export const TemplateCreateTemplateDirectLinkResponse$inboundSchema: z.ZodType< unknown > = z.object({ id: z.string(), - templateId: z.number(), token: z.string(), createdAt: z.string(), enabled: z.boolean(), directTemplateRecipientId: z.number(), + envelopeId: z.string(), + templateId: z.number(), }); /** @internal */ export type TemplateCreateTemplateDirectLinkResponse$Outbound = { id: string; - templateId: number; token: string; createdAt: string; enabled: boolean; directTemplateRecipientId: number; + envelopeId: string; + templateId: number; }; /** @internal */ @@ -126,11 +129,12 @@ export const TemplateCreateTemplateDirectLinkResponse$outboundSchema: z.ZodType< TemplateCreateTemplateDirectLinkResponse > = z.object({ id: z.string(), - templateId: z.number(), token: z.string(), createdAt: z.string(), enabled: z.boolean(), directTemplateRecipientId: z.number(), + envelopeId: z.string(), + templateId: z.number(), }); /** diff --git a/src/models/operations/templatecreatetemplatetemporary.ts b/src/models/operations/templatecreatetemplatetemporary.ts index 53ba4472..7f77a324 100644 --- a/src/models/operations/templatecreatetemplatetemporary.ts +++ b/src/models/operations/templatecreatetemplatetemporary.ts @@ -22,6 +22,7 @@ export type TemplateCreateTemplateTemporaryVisibilityRequest = ClosedEnum< */ export const TemplateCreateTemplateTemporaryGlobalAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -58,17 +59,28 @@ export type TemplateCreateTemplateTemporaryTypeRequest = ClosedEnum< * The date format to use for date fields and signing the document. */ export const TemplateCreateTemplateTemporaryDateFormat = { - YyyyMMDdHhMMA: "yyyy-MM-dd hh:mm a", - YyyyMMDd: "yyyy-MM-dd", - DdMMYyyyHhMMA: "dd/MM/yyyy hh:mm a", - MMDdYyyyHhMMA: "MM/dd/yyyy hh:mm a", - DdMMYyyyHHMM: "dd.MM.yyyy HH:mm", - YyyyMMDdHHMM: "yyyy-MM-dd HH:mm", - YyMMDdHhMMA: "yy-MM-dd hh:mm a", - YyyyMMDdHHMMSs: "yyyy-MM-dd HH:mm:ss", - MMMMDdYyyyHhMmA: "MMMM dd, yyyy hh:mm a", - EEEEMMMMDdYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", - YyyyMMDdTHHMMSsSSSXXX: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", + YyyyMMddHhMmA: "yyyy-MM-dd hh:mm a", + YyyyMMdd: "yyyy-MM-dd", + DdMMSlashYyyy: "dd/MM/yyyy", + MmDdSlashYyyy: "MM/dd/yyyy", + YyMMdd: "yy-MM-dd", + MmmmDdCommaYyyy: "MMMM dd, yyyy", + EeeeMmmmDdCommaYyyy: "EEEE, MMMM dd, yyyy", + DdMMSlashYyyyHhMMA: "dd/MM/yyyy hh:mm a", + DdMMSlashYyyyHHmm: "dd/MM/yyyy HH:mm", + MmDdSlashYyyyHhMmA: "MM/dd/yyyy hh:mm a", + MmDdSlashYyyyHHmm: "MM/dd/yyyy HH:mm", + DdDotMmDotYyyy: "dd.MM.yyyy", + DdDotMmDotYyyyHHmm: "dd.MM.yyyy HH:mm", + YyyyMMddHHmm: "yyyy-MM-dd HH:mm", + YyMMddHhMmA: "yy-MM-dd hh:mm a", + YyMMddHHmm: "yy-MM-dd HH:mm", + YyyyMMddHHmmss: "yyyy-MM-dd HH:mm:ss", + MmmmDdCommaYyyyHhMmA: "MMMM dd, yyyy hh:mm a", + MmmmDdCommaYyyyHHmm: "MMMM dd, yyyy HH:mm", + EeeeMmmmDdCommaYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", + EeeeMmmmDdCommaYyyyHHmm: "EEEE, MMMM dd, yyyy HH:mm", + Iso8601Full: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", } as const; /** * The date format to use for date fields and signing the document. @@ -247,6 +259,7 @@ export type TemplateCreateTemplateTemporaryVisibilityResponse = ClosedEnum< */ export const TemplateCreateTemplateTemporaryGlobalAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -291,6 +304,7 @@ export type TemplateCreateTemplateTemporaryTemplateDocumentData = { id: string; data: string; initialData: string; + envelopeItemId: string; }; export const TemplateCreateTemplateTemporaryTemplateMetaSigningOrder = { @@ -346,14 +360,13 @@ export type TemplateCreateTemplateTemporaryTemplateMeta = { message: string | null; timezone: string | null; dateFormat: string | null; - signingOrder: TemplateCreateTemplateTemporaryTemplateMetaSigningOrder | null; + signingOrder: TemplateCreateTemplateTemporaryTemplateMetaSigningOrder; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; drawSignatureEnabled: boolean; allowDictateNextSigner: boolean; distributionMethod: TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod; - templateId: number; redirectUrl: string | null; language: string; emailSettings: @@ -361,15 +374,17 @@ export type TemplateCreateTemplateTemporaryTemplateMeta = { | null; emailId: string | null; emailReplyTo: string | null; + templateId: number | null; }; export type TemplateCreateTemplateTemporaryDirectLink = { id: string; - templateId: number; + envelopeId: string; token: string; createdAt: string; enabled: boolean; directTemplateRecipientId: number; + templateId: number; }; export type TemplateCreateTemplateTemporaryUser = { @@ -419,6 +434,7 @@ export type TemplateCreateTemplateTemporarySendStatus = ClosedEnum< */ export const TemplateCreateTemplateTemporaryAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -450,13 +466,12 @@ export type TemplateCreateTemplateTemporaryRecipientAuthOptions = { }; export type TemplateCreateTemplateTemporaryRecipient = { + envelopeId: string; role: TemplateCreateTemplateTemporaryRole; readStatus: TemplateCreateTemplateTemporaryReadStatus; signingStatus: TemplateCreateTemplateTemporarySigningStatus; sendStatus: TemplateCreateTemplateTemporarySendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -469,6 +484,8 @@ export type TemplateCreateTemplateTemporaryRecipient = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const TemplateCreateTemplateTemporaryFieldType = { @@ -586,10 +603,10 @@ export type TemplateCreateTemplateTemporaryFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: TemplateCreateTemplateTemporaryTypeNumber; - 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?: TemplateCreateTemplateTemporaryTextAlign6 | undefined; }; @@ -738,11 +755,11 @@ export type TemplateCreateTemplateTemporaryFieldMetaUnion = | TemplateCreateTemplateTemporaryFieldMetaDropdown; export type TemplateCreateTemplateTemporaryField = { + envelopeId: string; + envelopeItemId: string; type: TemplateCreateTemplateTemporaryFieldType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -765,6 +782,8 @@ export type TemplateCreateTemplateTemporaryField = { | TemplateCreateTemplateTemporaryFieldMetaCheckbox | TemplateCreateTemplateTemporaryFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const TemplateCreateTemplateTemporaryFolderType = { @@ -806,14 +825,15 @@ export type Template = { userId: number; teamId: number; authOptions: TemplateCreateTemplateTemporaryAuthOptions | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; + envelopeId: string; + templateDocumentDataId?: string | undefined; templateDocumentData: TemplateCreateTemplateTemporaryTemplateDocumentData; - templateMeta: TemplateCreateTemplateTemporaryTemplateMeta | null; + templateMeta: TemplateCreateTemplateTemporaryTemplateMeta; directLink: TemplateCreateTemplateTemporaryDirectLink | null; user: TemplateCreateTemplateTemporaryUser; recipients: Array; @@ -1527,6 +1547,7 @@ export const TemplateCreateTemplateTemporaryTemplateDocumentData$inboundSchema: id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @internal */ @@ -1535,6 +1556,7 @@ export type TemplateCreateTemplateTemporaryTemplateDocumentData$Outbound = { id: string; data: string; initialData: string; + envelopeItemId: string; }; /** @internal */ @@ -1549,6 +1571,7 @@ export const TemplateCreateTemplateTemporaryTemplateDocumentData$outboundSchema: id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @@ -1744,16 +1767,14 @@ export const TemplateCreateTemplateTemporaryTemplateMeta$inboundSchema: message: z.nullable(z.string()), timezone: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - signingOrder: z.nullable( + signingOrder: TemplateCreateTemplateTemporaryTemplateMetaSigningOrder$inboundSchema, - ), typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), drawSignatureEnabled: z.boolean(), allowDictateNextSigner: z.boolean(), distributionMethod: TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod$inboundSchema, - templateId: z.number(), redirectUrl: z.nullable(z.string()), language: z.string(), emailSettings: z.nullable( @@ -1763,6 +1784,7 @@ export const TemplateCreateTemplateTemporaryTemplateMeta$inboundSchema: ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + templateId: z.nullable(z.number()), }); /** @internal */ @@ -1772,13 +1794,12 @@ export type TemplateCreateTemplateTemporaryTemplateMeta$Outbound = { message: string | null; timezone: string | null; dateFormat: string | null; - signingOrder: string | null; + signingOrder: string; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; drawSignatureEnabled: boolean; allowDictateNextSigner: boolean; distributionMethod: string; - templateId: number; redirectUrl: string | null; language: string; emailSettings: @@ -1786,6 +1807,7 @@ export type TemplateCreateTemplateTemporaryTemplateMeta$Outbound = { | null; emailId: string | null; emailReplyTo: string | null; + templateId: number | null; }; /** @internal */ @@ -1800,16 +1822,14 @@ export const TemplateCreateTemplateTemporaryTemplateMeta$outboundSchema: message: z.nullable(z.string()), timezone: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - signingOrder: z.nullable( + signingOrder: TemplateCreateTemplateTemporaryTemplateMetaSigningOrder$outboundSchema, - ), typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), drawSignatureEnabled: z.boolean(), allowDictateNextSigner: z.boolean(), distributionMethod: TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod$outboundSchema, - templateId: z.number(), redirectUrl: z.nullable(z.string()), language: z.string(), emailSettings: z.nullable( @@ -1819,6 +1839,7 @@ export const TemplateCreateTemplateTemporaryTemplateMeta$outboundSchema: ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + templateId: z.nullable(z.number()), }); /** @@ -1870,21 +1891,23 @@ export const TemplateCreateTemplateTemporaryDirectLink$inboundSchema: z.ZodType< unknown > = z.object({ id: z.string(), - templateId: z.number(), + envelopeId: z.string(), token: z.string(), createdAt: z.string(), enabled: z.boolean(), directTemplateRecipientId: z.number(), + templateId: z.number(), }); /** @internal */ export type TemplateCreateTemplateTemporaryDirectLink$Outbound = { id: string; - templateId: number; + envelopeId: string; token: string; createdAt: string; enabled: boolean; directTemplateRecipientId: number; + templateId: number; }; /** @internal */ @@ -1895,11 +1918,12 @@ export const TemplateCreateTemplateTemporaryDirectLink$outboundSchema: TemplateCreateTemplateTemporaryDirectLink > = z.object({ id: z.string(), - templateId: z.number(), + envelopeId: z.string(), token: z.string(), createdAt: z.string(), enabled: z.boolean(), directTemplateRecipientId: z.number(), + templateId: z.number(), }); /** @@ -2232,13 +2256,12 @@ export const TemplateCreateTemplateTemporaryRecipient$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: TemplateCreateTemplateTemporaryRole$inboundSchema, readStatus: TemplateCreateTemplateTemporaryReadStatus$inboundSchema, signingStatus: TemplateCreateTemplateTemporarySigningStatus$inboundSchema, sendStatus: TemplateCreateTemplateTemporarySendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2252,17 +2275,18 @@ export const TemplateCreateTemplateTemporaryRecipient$inboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type TemplateCreateTemplateTemporaryRecipient$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; @@ -2274,6 +2298,8 @@ export type TemplateCreateTemplateTemporaryRecipient$Outbound = { | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2282,13 +2308,12 @@ export const TemplateCreateTemplateTemporaryRecipient$outboundSchema: z.ZodType< z.ZodTypeDef, TemplateCreateTemplateTemporaryRecipient > = z.object({ + envelopeId: z.string(), role: TemplateCreateTemplateTemporaryRole$outboundSchema, readStatus: TemplateCreateTemplateTemporaryReadStatus$outboundSchema, signingStatus: TemplateCreateTemplateTemporarySigningStatus$outboundSchema, sendStatus: TemplateCreateTemplateTemporarySendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2302,6 +2327,8 @@ export const TemplateCreateTemplateTemporaryRecipient$outboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2984,10 +3011,10 @@ export const TemplateCreateTemplateTemporaryFieldMetaNumber$inboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: TemplateCreateTemplateTemporaryTypeNumber$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: TemplateCreateTemplateTemporaryTextAlign6$inboundSchema .optional(), @@ -3000,10 +3027,10 @@ export type TemplateCreateTemplateTemporaryFieldMetaNumber$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; }; @@ -3020,10 +3047,10 @@ export const TemplateCreateTemplateTemporaryFieldMetaNumber$outboundSchema: required: z.boolean().optional(), readOnly: z.boolean().optional(), type: TemplateCreateTemplateTemporaryTypeNumber$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: TemplateCreateTemplateTemporaryTextAlign6$outboundSchema .optional(), @@ -3852,11 +3879,11 @@ export const TemplateCreateTemplateTemporaryField$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: TemplateCreateTemplateTemporaryFieldType$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(), @@ -3886,15 +3913,17 @@ export const TemplateCreateTemplateTemporaryField$inboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type TemplateCreateTemplateTemporaryField$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -3914,6 +3943,8 @@ export type TemplateCreateTemplateTemporaryField$Outbound = { | TemplateCreateTemplateTemporaryFieldMetaCheckbox$Outbound | TemplateCreateTemplateTemporaryFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -3922,11 +3953,11 @@ export const TemplateCreateTemplateTemporaryField$outboundSchema: z.ZodType< z.ZodTypeDef, TemplateCreateTemplateTemporaryField > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: TemplateCreateTemplateTemporaryFieldType$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(), @@ -3960,6 +3991,8 @@ export const TemplateCreateTemplateTemporaryField$outboundSchema: z.ZodType< ), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -4146,17 +4179,18 @@ export const Template$inboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateCreateTemplateTemporaryAuthOptions$inboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateDocumentDataId: z.string().default(""), templateDocumentData: z.lazy(() => TemplateCreateTemplateTemporaryTemplateDocumentData$inboundSchema ), - templateMeta: z.nullable( - z.lazy(() => TemplateCreateTemplateTemporaryTemplateMeta$inboundSchema), + templateMeta: z.lazy(() => + TemplateCreateTemplateTemporaryTemplateMeta$inboundSchema ), directLink: z.nullable( z.lazy(() => TemplateCreateTemplateTemporaryDirectLink$inboundSchema), @@ -4183,15 +4217,16 @@ export type Template$Outbound = { userId: number; teamId: number; authOptions: TemplateCreateTemplateTemporaryAuthOptions$Outbound | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; + envelopeId: string; + templateDocumentDataId: string; templateDocumentData: TemplateCreateTemplateTemporaryTemplateDocumentData$Outbound; - templateMeta: TemplateCreateTemplateTemporaryTemplateMeta$Outbound | null; + templateMeta: TemplateCreateTemplateTemporaryTemplateMeta$Outbound; directLink: TemplateCreateTemplateTemporaryDirectLink$Outbound | null; user: TemplateCreateTemplateTemporaryUser$Outbound; recipients: Array; @@ -4215,17 +4250,18 @@ export const Template$outboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateCreateTemplateTemporaryAuthOptions$outboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateDocumentDataId: z.string().default(""), templateDocumentData: z.lazy(() => TemplateCreateTemplateTemporaryTemplateDocumentData$outboundSchema ), - templateMeta: z.nullable( - z.lazy(() => TemplateCreateTemplateTemporaryTemplateMeta$outboundSchema), + templateMeta: z.lazy(() => + TemplateCreateTemplateTemporaryTemplateMeta$outboundSchema ), directLink: z.nullable( z.lazy(() => TemplateCreateTemplateTemporaryDirectLink$outboundSchema), diff --git a/src/models/operations/templateduplicatetemplate.ts b/src/models/operations/templateduplicatetemplate.ts index ec6ef47b..d5ade624 100644 --- a/src/models/operations/templateduplicatetemplate.ts +++ b/src/models/operations/templateduplicatetemplate.ts @@ -34,6 +34,7 @@ export type TemplateDuplicateTemplateVisibility = ClosedEnum< */ export const TemplateDuplicateTemplateGlobalAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -75,13 +76,14 @@ export type TemplateDuplicateTemplateResponse = { userId: number; teamId: number; authOptions: TemplateDuplicateTemplateAuthOptions | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + templateDocumentDataId?: string | undefined; }; /** @internal */ @@ -316,13 +318,14 @@ export const TemplateDuplicateTemplateResponse$inboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateDuplicateTemplateAuthOptions$inboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + templateDocumentDataId: z.string().default(""), }); /** @internal */ @@ -335,13 +338,14 @@ export type TemplateDuplicateTemplateResponse$Outbound = { userId: number; teamId: number; authOptions: TemplateDuplicateTemplateAuthOptions$Outbound | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + templateDocumentDataId: string; }; /** @internal */ @@ -360,13 +364,14 @@ export const TemplateDuplicateTemplateResponse$outboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateDuplicateTemplateAuthOptions$outboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + templateDocumentDataId: z.string().default(""), }); /** diff --git a/src/models/operations/templatefindtemplates.ts b/src/models/operations/templatefindtemplates.ts index 150d0218..c027d42a 100644 --- a/src/models/operations/templatefindtemplates.ts +++ b/src/models/operations/templatefindtemplates.ts @@ -65,6 +65,7 @@ export type TemplateFindTemplatesVisibility = ClosedEnum< */ export const TemplateFindTemplatesGlobalAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -214,10 +215,10 @@ export type TemplateFindTemplatesFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: TemplateFindTemplatesTypeNumber; - 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?: TemplateFindTemplatesTextAlign6 | undefined; }; @@ -366,11 +367,11 @@ export type TemplateFindTemplatesFieldMetaUnion = | TemplateFindTemplatesFieldMetaDropdown; export type TemplateFindTemplatesField = { + envelopeId: string; + envelopeItemId: string; type: TemplateFindTemplatesFieldType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -393,6 +394,8 @@ export type TemplateFindTemplatesField = { | TemplateFindTemplatesFieldMetaCheckbox | TemplateFindTemplatesFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const TemplateFindTemplatesRole = { @@ -436,6 +439,7 @@ export type TemplateFindTemplatesSendStatus = ClosedEnum< */ export const TemplateFindTemplatesAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -467,13 +471,12 @@ export type TemplateFindTemplatesRecipientAuthOptions = { }; export type TemplateFindTemplatesRecipient = { + envelopeId: string; role: TemplateFindTemplatesRole; readStatus: TemplateFindTemplatesReadStatus; signingStatus: TemplateFindTemplatesSigningStatus; sendStatus: TemplateFindTemplatesSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -486,6 +489,8 @@ export type TemplateFindTemplatesRecipient = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const TemplateFindTemplatesSigningOrder = { @@ -505,7 +510,7 @@ export type TemplateFindTemplatesDistributionMethod = ClosedEnum< >; export type TemplateFindTemplatesTemplateMeta = { - signingOrder: TemplateFindTemplatesSigningOrder | null; + signingOrder: TemplateFindTemplatesSigningOrder; distributionMethod: TemplateFindTemplatesDistributionMethod; }; @@ -523,18 +528,19 @@ export type TemplateFindTemplatesData = { userId: number; teamId: number; authOptions: TemplateFindTemplatesAuthOptions | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; team: TemplateFindTemplatesTeam | null; fields: Array; recipients: Array; templateMeta: TemplateFindTemplatesTemplateMeta | null; directLink: TemplateFindTemplatesDirectLink | null; + templateDocumentDataId?: string | undefined; }; /** @@ -1445,10 +1451,10 @@ export const TemplateFindTemplatesFieldMetaNumber$inboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: TemplateFindTemplatesTypeNumber$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: TemplateFindTemplatesTextAlign6$inboundSchema.optional(), }); @@ -1460,10 +1466,10 @@ export type TemplateFindTemplatesFieldMetaNumber$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; }; @@ -1479,10 +1485,10 @@ export const TemplateFindTemplatesFieldMetaNumber$outboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: TemplateFindTemplatesTypeNumber$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: TemplateFindTemplatesTextAlign6$outboundSchema.optional(), }); @@ -2211,11 +2217,11 @@ export const TemplateFindTemplatesField$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: TemplateFindTemplatesFieldType$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(), @@ -2237,15 +2243,17 @@ export const TemplateFindTemplatesField$inboundSchema: z.ZodType< z.lazy(() => TemplateFindTemplatesFieldMetaDropdown$inboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type TemplateFindTemplatesField$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -2265,6 +2273,8 @@ export type TemplateFindTemplatesField$Outbound = { | TemplateFindTemplatesFieldMetaCheckbox$Outbound | TemplateFindTemplatesFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2273,11 +2283,11 @@ export const TemplateFindTemplatesField$outboundSchema: z.ZodType< z.ZodTypeDef, TemplateFindTemplatesField > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: TemplateFindTemplatesFieldType$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(), @@ -2299,6 +2309,8 @@ export const TemplateFindTemplatesField$outboundSchema: z.ZodType< z.lazy(() => TemplateFindTemplatesFieldMetaDropdown$outboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2534,13 +2546,12 @@ export const TemplateFindTemplatesRecipient$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: TemplateFindTemplatesRole$inboundSchema, readStatus: TemplateFindTemplatesReadStatus$inboundSchema, signingStatus: TemplateFindTemplatesSigningStatus$inboundSchema, sendStatus: TemplateFindTemplatesSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2552,17 +2563,18 @@ export const TemplateFindTemplatesRecipient$inboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type TemplateFindTemplatesRecipient$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; @@ -2572,6 +2584,8 @@ export type TemplateFindTemplatesRecipient$Outbound = { authOptions: TemplateFindTemplatesRecipientAuthOptions$Outbound | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -2580,13 +2594,12 @@ export const TemplateFindTemplatesRecipient$outboundSchema: z.ZodType< z.ZodTypeDef, TemplateFindTemplatesRecipient > = z.object({ + envelopeId: z.string(), role: TemplateFindTemplatesRole$outboundSchema, readStatus: TemplateFindTemplatesReadStatus$outboundSchema, signingStatus: TemplateFindTemplatesSigningStatus$outboundSchema, sendStatus: TemplateFindTemplatesSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -2598,6 +2611,8 @@ export const TemplateFindTemplatesRecipient$outboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2684,13 +2699,13 @@ export const TemplateFindTemplatesTemplateMeta$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - signingOrder: z.nullable(TemplateFindTemplatesSigningOrder$inboundSchema), + signingOrder: TemplateFindTemplatesSigningOrder$inboundSchema, distributionMethod: TemplateFindTemplatesDistributionMethod$inboundSchema, }); /** @internal */ export type TemplateFindTemplatesTemplateMeta$Outbound = { - signingOrder: string | null; + signingOrder: string; distributionMethod: string; }; @@ -2700,7 +2715,7 @@ export const TemplateFindTemplatesTemplateMeta$outboundSchema: z.ZodType< z.ZodTypeDef, TemplateFindTemplatesTemplateMeta > = z.object({ - signingOrder: z.nullable(TemplateFindTemplatesSigningOrder$outboundSchema), + signingOrder: TemplateFindTemplatesSigningOrder$outboundSchema, distributionMethod: TemplateFindTemplatesDistributionMethod$outboundSchema, }); @@ -2813,13 +2828,13 @@ export const TemplateFindTemplatesData$inboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateFindTemplatesAuthOptions$inboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), team: z.nullable(z.lazy(() => TemplateFindTemplatesTeam$inboundSchema)), fields: z.array(z.lazy(() => TemplateFindTemplatesField$inboundSchema)), recipients: z.array( @@ -2831,6 +2846,7 @@ export const TemplateFindTemplatesData$inboundSchema: z.ZodType< directLink: z.nullable( z.lazy(() => TemplateFindTemplatesDirectLink$inboundSchema), ), + templateDocumentDataId: z.string().default(""), }); /** @internal */ @@ -2843,18 +2859,19 @@ export type TemplateFindTemplatesData$Outbound = { userId: number; teamId: number; authOptions: TemplateFindTemplatesAuthOptions$Outbound | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; team: TemplateFindTemplatesTeam$Outbound | null; fields: Array; recipients: Array; templateMeta: TemplateFindTemplatesTemplateMeta$Outbound | null; directLink: TemplateFindTemplatesDirectLink$Outbound | null; + templateDocumentDataId: string; }; /** @internal */ @@ -2873,13 +2890,13 @@ export const TemplateFindTemplatesData$outboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateFindTemplatesAuthOptions$outboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), team: z.nullable(z.lazy(() => TemplateFindTemplatesTeam$outboundSchema)), fields: z.array(z.lazy(() => TemplateFindTemplatesField$outboundSchema)), recipients: z.array( @@ -2891,6 +2908,7 @@ export const TemplateFindTemplatesData$outboundSchema: z.ZodType< directLink: z.nullable( z.lazy(() => TemplateFindTemplatesDirectLink$outboundSchema), ), + templateDocumentDataId: z.string().default(""), }); /** diff --git a/src/models/operations/templategettemplatebyid.ts b/src/models/operations/templategettemplatebyid.ts index dd1a45ea..6120ca8e 100644 --- a/src/models/operations/templategettemplatebyid.ts +++ b/src/models/operations/templategettemplatebyid.ts @@ -34,6 +34,7 @@ export type TemplateGetTemplateByIdVisibility = ClosedEnum< */ export const TemplateGetTemplateByIdGlobalAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -77,6 +78,7 @@ export type TemplateGetTemplateByIdTemplateDocumentData = { id: string; data: string; initialData: string; + envelopeItemId: string; }; export const TemplateGetTemplateByIdSigningOrder = { @@ -132,27 +134,28 @@ export type TemplateGetTemplateByIdTemplateMeta = { message: string | null; timezone: string | null; dateFormat: string | null; - signingOrder: TemplateGetTemplateByIdSigningOrder | null; + signingOrder: TemplateGetTemplateByIdSigningOrder; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; drawSignatureEnabled: boolean; allowDictateNextSigner: boolean; distributionMethod: TemplateGetTemplateByIdDistributionMethod; - templateId: number; redirectUrl: string | null; language: string; emailSettings: TemplateGetTemplateByIdEmailSettings | null; emailId: string | null; emailReplyTo: string | null; + templateId: number | null; }; export type TemplateGetTemplateByIdDirectLink = { id: string; - templateId: number; + envelopeId: string; token: string; createdAt: string; enabled: boolean; directTemplateRecipientId: number; + templateId: number; }; export type TemplateGetTemplateByIdUser = { @@ -202,6 +205,7 @@ export type TemplateGetTemplateByIdSendStatus = ClosedEnum< */ export const TemplateGetTemplateByIdAccessAuth = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -233,13 +237,12 @@ export type TemplateGetTemplateByIdRecipientAuthOptions = { }; export type TemplateGetTemplateByIdRecipient = { + envelopeId: string; role: TemplateGetTemplateByIdRole; readStatus: TemplateGetTemplateByIdReadStatus; signingStatus: TemplateGetTemplateByIdSigningStatus; sendStatus: TemplateGetTemplateByIdSendStatus; id: number; - documentId: number | null; - templateId: number | null; email: string; name: string; token: string; @@ -252,6 +255,8 @@ export type TemplateGetTemplateByIdRecipient = { */ signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const TemplateGetTemplateByIdFieldType = { @@ -369,10 +374,10 @@ export type TemplateGetTemplateByIdFieldMetaNumber = { required?: boolean | undefined; readOnly?: boolean | undefined; type: TemplateGetTemplateByIdTypeNumber; - 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?: TemplateGetTemplateByIdTextAlign6 | undefined; }; @@ -521,11 +526,11 @@ export type TemplateGetTemplateByIdFieldMetaUnion = | TemplateGetTemplateByIdFieldMetaDropdown; export type TemplateGetTemplateByIdField = { + envelopeId: string; + envelopeItemId: string; type: TemplateGetTemplateByIdFieldType; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; /** * The page number of the field on the document. Starts from 1. @@ -548,6 +553,8 @@ export type TemplateGetTemplateByIdField = { | TemplateGetTemplateByIdFieldMetaCheckbox | TemplateGetTemplateByIdFieldMetaDropdown | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; export const TemplateGetTemplateByIdFolderType = { @@ -592,14 +599,15 @@ export type TemplateGetTemplateByIdResponse = { userId: number; teamId: number; authOptions: TemplateGetTemplateByIdAuthOptions | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; + envelopeId: string; + templateDocumentDataId?: string | undefined; templateDocumentData: TemplateGetTemplateByIdTemplateDocumentData; - templateMeta: TemplateGetTemplateByIdTemplateMeta | null; + templateMeta: TemplateGetTemplateByIdTemplateMeta; directLink: TemplateGetTemplateByIdDirectLink | null; user: TemplateGetTemplateByIdUser; recipients: Array; @@ -855,6 +863,7 @@ export const TemplateGetTemplateByIdTemplateDocumentData$inboundSchema: id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @internal */ @@ -863,6 +872,7 @@ export type TemplateGetTemplateByIdTemplateDocumentData$Outbound = { id: string; data: string; initialData: string; + envelopeItemId: string; }; /** @internal */ @@ -876,6 +886,7 @@ export const TemplateGetTemplateByIdTemplateDocumentData$outboundSchema: id: z.string(), data: z.string(), initialData: z.string(), + envelopeItemId: z.string(), }); /** @@ -1054,13 +1065,12 @@ export const TemplateGetTemplateByIdTemplateMeta$inboundSchema: z.ZodType< message: z.nullable(z.string()), timezone: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - signingOrder: z.nullable(TemplateGetTemplateByIdSigningOrder$inboundSchema), + signingOrder: TemplateGetTemplateByIdSigningOrder$inboundSchema, typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), drawSignatureEnabled: z.boolean(), allowDictateNextSigner: z.boolean(), distributionMethod: TemplateGetTemplateByIdDistributionMethod$inboundSchema, - templateId: z.number(), redirectUrl: z.nullable(z.string()), language: z.string(), emailSettings: z.nullable( @@ -1068,6 +1078,7 @@ export const TemplateGetTemplateByIdTemplateMeta$inboundSchema: z.ZodType< ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + templateId: z.nullable(z.number()), }); /** @internal */ @@ -1077,18 +1088,18 @@ export type TemplateGetTemplateByIdTemplateMeta$Outbound = { message: string | null; timezone: string | null; dateFormat: string | null; - signingOrder: string | null; + signingOrder: string; typedSignatureEnabled: boolean; uploadSignatureEnabled: boolean; drawSignatureEnabled: boolean; allowDictateNextSigner: boolean; distributionMethod: string; - templateId: number; redirectUrl: string | null; language: string; emailSettings: TemplateGetTemplateByIdEmailSettings$Outbound | null; emailId: string | null; emailReplyTo: string | null; + templateId: number | null; }; /** @internal */ @@ -1102,13 +1113,12 @@ export const TemplateGetTemplateByIdTemplateMeta$outboundSchema: z.ZodType< message: z.nullable(z.string()), timezone: z.nullable(z.string()), dateFormat: z.nullable(z.string()), - signingOrder: z.nullable(TemplateGetTemplateByIdSigningOrder$outboundSchema), + signingOrder: TemplateGetTemplateByIdSigningOrder$outboundSchema, typedSignatureEnabled: z.boolean(), uploadSignatureEnabled: z.boolean(), drawSignatureEnabled: z.boolean(), allowDictateNextSigner: z.boolean(), distributionMethod: TemplateGetTemplateByIdDistributionMethod$outboundSchema, - templateId: z.number(), redirectUrl: z.nullable(z.string()), language: z.string(), emailSettings: z.nullable( @@ -1116,6 +1126,7 @@ export const TemplateGetTemplateByIdTemplateMeta$outboundSchema: z.ZodType< ), emailId: z.nullable(z.string()), emailReplyTo: z.nullable(z.string()), + templateId: z.nullable(z.number()), }); /** @@ -1161,21 +1172,23 @@ export const TemplateGetTemplateByIdDirectLink$inboundSchema: z.ZodType< unknown > = z.object({ id: z.string(), - templateId: z.number(), + envelopeId: z.string(), token: z.string(), createdAt: z.string(), enabled: z.boolean(), directTemplateRecipientId: z.number(), + templateId: z.number(), }); /** @internal */ export type TemplateGetTemplateByIdDirectLink$Outbound = { id: string; - templateId: number; + envelopeId: string; token: string; createdAt: string; enabled: boolean; directTemplateRecipientId: number; + templateId: number; }; /** @internal */ @@ -1185,11 +1198,12 @@ export const TemplateGetTemplateByIdDirectLink$outboundSchema: z.ZodType< TemplateGetTemplateByIdDirectLink > = z.object({ id: z.string(), - templateId: z.number(), + envelopeId: z.string(), token: z.string(), createdAt: z.string(), enabled: z.boolean(), directTemplateRecipientId: z.number(), + templateId: z.number(), }); /** @@ -1497,13 +1511,12 @@ export const TemplateGetTemplateByIdRecipient$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), role: TemplateGetTemplateByIdRole$inboundSchema, readStatus: TemplateGetTemplateByIdReadStatus$inboundSchema, signingStatus: TemplateGetTemplateByIdSigningStatus$inboundSchema, sendStatus: TemplateGetTemplateByIdSendStatus$inboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -1515,17 +1528,18 @@ export const TemplateGetTemplateByIdRecipient$inboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type TemplateGetTemplateByIdRecipient$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; @@ -1535,6 +1549,8 @@ export type TemplateGetTemplateByIdRecipient$Outbound = { authOptions: TemplateGetTemplateByIdRecipientAuthOptions$Outbound | null; signingOrder: number | null; rejectionReason: string | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -1543,13 +1559,12 @@ export const TemplateGetTemplateByIdRecipient$outboundSchema: z.ZodType< z.ZodTypeDef, TemplateGetTemplateByIdRecipient > = z.object({ + envelopeId: z.string(), role: TemplateGetTemplateByIdRole$outboundSchema, readStatus: TemplateGetTemplateByIdReadStatus$outboundSchema, signingStatus: TemplateGetTemplateByIdSigningStatus$outboundSchema, sendStatus: TemplateGetTemplateByIdSendStatus$outboundSchema, id: z.number(), - documentId: z.nullable(z.number()), - templateId: z.nullable(z.number()), email: z.string(), name: z.string(), token: z.string(), @@ -1561,6 +1576,8 @@ export const TemplateGetTemplateByIdRecipient$outboundSchema: z.ZodType< ), signingOrder: z.nullable(z.number()), rejectionReason: z.nullable(z.string()), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -2194,10 +2211,10 @@ export const TemplateGetTemplateByIdFieldMetaNumber$inboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: TemplateGetTemplateByIdTypeNumber$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: TemplateGetTemplateByIdTextAlign6$inboundSchema.optional(), }); @@ -2209,10 +2226,10 @@ export type TemplateGetTemplateByIdFieldMetaNumber$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; }; @@ -2228,10 +2245,10 @@ export const TemplateGetTemplateByIdFieldMetaNumber$outboundSchema: z.ZodType< required: z.boolean().optional(), readOnly: z.boolean().optional(), type: TemplateGetTemplateByIdTypeNumber$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: TemplateGetTemplateByIdTextAlign6$outboundSchema.optional(), }); @@ -2975,11 +2992,11 @@ export const TemplateGetTemplateByIdField$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: TemplateGetTemplateByIdFieldType$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(), @@ -3001,15 +3018,17 @@ export const TemplateGetTemplateByIdField$inboundSchema: z.ZodType< z.lazy(() => TemplateGetTemplateByIdFieldMetaDropdown$inboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @internal */ export type TemplateGetTemplateByIdField$Outbound = { + envelopeId: string; + envelopeItemId: string; type: string; id: number; secondaryId: string; - documentId: number | null; - templateId: number | null; recipientId: number; page: number; positionX?: any | undefined; @@ -3029,6 +3048,8 @@ export type TemplateGetTemplateByIdField$Outbound = { | TemplateGetTemplateByIdFieldMetaCheckbox$Outbound | TemplateGetTemplateByIdFieldMetaDropdown$Outbound | null; + documentId?: number | null | undefined; + templateId?: number | null | undefined; }; /** @internal */ @@ -3037,11 +3058,11 @@ export const TemplateGetTemplateByIdField$outboundSchema: z.ZodType< z.ZodTypeDef, TemplateGetTemplateByIdField > = z.object({ + envelopeId: z.string(), + envelopeItemId: z.string(), type: TemplateGetTemplateByIdFieldType$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(), @@ -3063,6 +3084,8 @@ export const TemplateGetTemplateByIdField$outboundSchema: z.ZodType< z.lazy(() => TemplateGetTemplateByIdFieldMetaDropdown$outboundSchema), ]), ), + documentId: z.nullable(z.number()).optional(), + templateId: z.nullable(z.number()).optional(), }); /** @@ -3242,18 +3265,17 @@ export const TemplateGetTemplateByIdResponse$inboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateGetTemplateByIdAuthOptions$inboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateDocumentDataId: z.string().default(""), templateDocumentData: z.lazy(() => TemplateGetTemplateByIdTemplateDocumentData$inboundSchema ), - templateMeta: z.nullable( - z.lazy(() => TemplateGetTemplateByIdTemplateMeta$inboundSchema), - ), + templateMeta: z.lazy(() => TemplateGetTemplateByIdTemplateMeta$inboundSchema), directLink: z.nullable( z.lazy(() => TemplateGetTemplateByIdDirectLink$inboundSchema), ), @@ -3275,14 +3297,15 @@ export type TemplateGetTemplateByIdResponse$Outbound = { userId: number; teamId: number; authOptions: TemplateGetTemplateByIdAuthOptions$Outbound | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; + envelopeId: string; + templateDocumentDataId: string; templateDocumentData: TemplateGetTemplateByIdTemplateDocumentData$Outbound; - templateMeta: TemplateGetTemplateByIdTemplateMeta$Outbound | null; + templateMeta: TemplateGetTemplateByIdTemplateMeta$Outbound; directLink: TemplateGetTemplateByIdDirectLink$Outbound | null; user: TemplateGetTemplateByIdUser$Outbound; recipients: Array; @@ -3306,17 +3329,18 @@ export const TemplateGetTemplateByIdResponse$outboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateGetTemplateByIdAuthOptions$outboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), + envelopeId: z.string(), + templateDocumentDataId: z.string().default(""), templateDocumentData: z.lazy(() => TemplateGetTemplateByIdTemplateDocumentData$outboundSchema ), - templateMeta: z.nullable( - z.lazy(() => TemplateGetTemplateByIdTemplateMeta$outboundSchema), + templateMeta: z.lazy(() => + TemplateGetTemplateByIdTemplateMeta$outboundSchema ), directLink: z.nullable( z.lazy(() => TemplateGetTemplateByIdDirectLink$outboundSchema), diff --git a/src/models/operations/templatetoggletemplatedirectlink.ts b/src/models/operations/templatetoggletemplatedirectlink.ts index f01df47d..c3730047 100644 --- a/src/models/operations/templatetoggletemplatedirectlink.ts +++ b/src/models/operations/templatetoggletemplatedirectlink.ts @@ -17,11 +17,12 @@ export type TemplateToggleTemplateDirectLinkRequest = { */ export type TemplateToggleTemplateDirectLinkResponse = { id: string; - templateId: number; token: string; createdAt: string; enabled: boolean; directTemplateRecipientId: number; + envelopeId: string; + templateId: number; }; /** @internal */ @@ -99,21 +100,23 @@ export const TemplateToggleTemplateDirectLinkResponse$inboundSchema: z.ZodType< unknown > = z.object({ id: z.string(), - templateId: z.number(), token: z.string(), createdAt: z.string(), enabled: z.boolean(), directTemplateRecipientId: z.number(), + envelopeId: z.string(), + templateId: z.number(), }); /** @internal */ export type TemplateToggleTemplateDirectLinkResponse$Outbound = { id: string; - templateId: number; token: string; createdAt: string; enabled: boolean; directTemplateRecipientId: number; + envelopeId: string; + templateId: number; }; /** @internal */ @@ -123,11 +126,12 @@ export const TemplateToggleTemplateDirectLinkResponse$outboundSchema: z.ZodType< TemplateToggleTemplateDirectLinkResponse > = z.object({ id: z.string(), - templateId: z.number(), token: z.string(), createdAt: z.string(), enabled: z.boolean(), directTemplateRecipientId: z.number(), + envelopeId: z.string(), + templateId: z.number(), }); /** diff --git a/src/models/operations/templateupdatetemplate.ts b/src/models/operations/templateupdatetemplate.ts index d56c69be..ea56b1ab 100644 --- a/src/models/operations/templateupdatetemplate.ts +++ b/src/models/operations/templateupdatetemplate.ts @@ -22,6 +22,7 @@ export type TemplateUpdateTemplateVisibilityRequest = ClosedEnum< */ export const TemplateUpdateTemplateGlobalAccessAuthRequest = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -77,23 +78,35 @@ export type TemplateUpdateTemplateData = { publicDescription?: string | undefined; type?: TemplateUpdateTemplateDataType | undefined; useLegacyFieldInsertion?: boolean | undefined; + folderId?: string | null | undefined; }; /** * The date format to use for date fields and signing the document. */ export const TemplateUpdateTemplateDateFormat = { - YyyyMMDdHhMMA: "yyyy-MM-dd hh:mm a", - YyyyMMDd: "yyyy-MM-dd", - DdMMYyyyHhMMA: "dd/MM/yyyy hh:mm a", - MMDdYyyyHhMMA: "MM/dd/yyyy hh:mm a", - DdMMYyyyHHMM: "dd.MM.yyyy HH:mm", - YyyyMMDdHHMM: "yyyy-MM-dd HH:mm", - YyMMDdHhMMA: "yy-MM-dd hh:mm a", - YyyyMMDdHHMMSs: "yyyy-MM-dd HH:mm:ss", - MMMMDdYyyyHhMmA: "MMMM dd, yyyy hh:mm a", - EEEEMMMMDdYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", - YyyyMMDdTHHMMSsSSSXXX: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", + YyyyMMddHhMmA: "yyyy-MM-dd hh:mm a", + YyyyMMdd: "yyyy-MM-dd", + DdMMSlashYyyy: "dd/MM/yyyy", + MmDdSlashYyyy: "MM/dd/yyyy", + YyMMdd: "yy-MM-dd", + MmmmDdCommaYyyy: "MMMM dd, yyyy", + EeeeMmmmDdCommaYyyy: "EEEE, MMMM dd, yyyy", + DdMMSlashYyyyHhMMA: "dd/MM/yyyy hh:mm a", + DdMMSlashYyyyHHmm: "dd/MM/yyyy HH:mm", + MmDdSlashYyyyHhMmA: "MM/dd/yyyy hh:mm a", + MmDdSlashYyyyHHmm: "MM/dd/yyyy HH:mm", + DdDotMmDotYyyy: "dd.MM.yyyy", + DdDotMmDotYyyyHHmm: "dd.MM.yyyy HH:mm", + YyyyMMddHHmm: "yyyy-MM-dd HH:mm", + YyMMddHhMmA: "yy-MM-dd hh:mm a", + YyMMddHHmm: "yy-MM-dd HH:mm", + YyyyMMddHHmmss: "yyyy-MM-dd HH:mm:ss", + MmmmDdCommaYyyyHhMmA: "MMMM dd, yyyy hh:mm a", + MmmmDdCommaYyyyHHmm: "MMMM dd, yyyy HH:mm", + EeeeMmmmDdCommaYyyyHhMmA: "EEEE, MMMM dd, yyyy hh:mm a", + EeeeMmmmDdCommaYyyyHHmm: "EEEE, MMMM dd, yyyy HH:mm", + Iso8601Full: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", } as const; /** * The date format to use for date fields and signing the document. @@ -249,6 +262,7 @@ export type TemplateUpdateTemplateVisibilityResponse = ClosedEnum< */ export const TemplateUpdateTemplateGlobalAccessAuthResponse = { Account: "ACCOUNT", + TwoFactorAuth: "TWO_FACTOR_AUTH", } as const; /** * The type of authentication required for the recipient to access the document. @@ -290,13 +304,14 @@ export type TemplateUpdateTemplateResponse = { userId: number; teamId: number; authOptions: TemplateUpdateTemplateAuthOptions | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + templateDocumentDataId?: string | undefined; }; /** @internal */ @@ -408,6 +423,7 @@ export const TemplateUpdateTemplateData$inboundSchema: z.ZodType< publicDescription: z.string().optional(), type: TemplateUpdateTemplateDataType$inboundSchema.optional(), useLegacyFieldInsertion: z.boolean().optional(), + folderId: z.nullable(z.string()).optional(), }); /** @internal */ @@ -421,6 +437,7 @@ export type TemplateUpdateTemplateData$Outbound = { publicDescription?: string | undefined; type?: string | undefined; useLegacyFieldInsertion?: boolean | undefined; + folderId?: string | null | undefined; }; /** @internal */ @@ -442,6 +459,7 @@ export const TemplateUpdateTemplateData$outboundSchema: z.ZodType< publicDescription: z.string().optional(), type: TemplateUpdateTemplateDataType$outboundSchema.optional(), useLegacyFieldInsertion: z.boolean().optional(), + folderId: z.nullable(z.string()).optional(), }); /** @@ -977,13 +995,14 @@ export const TemplateUpdateTemplateResponse$inboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateUpdateTemplateAuthOptions$inboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + templateDocumentDataId: z.string().default(""), }); /** @internal */ @@ -996,13 +1015,14 @@ export type TemplateUpdateTemplateResponse$Outbound = { userId: number; teamId: number; authOptions: TemplateUpdateTemplateAuthOptions$Outbound | null; - templateDocumentDataId: string; createdAt: string; updatedAt: string; publicTitle: string; publicDescription: string; folderId: string | null; useLegacyFieldInsertion: boolean; + envelopeId: string; + templateDocumentDataId: string; }; /** @internal */ @@ -1021,13 +1041,14 @@ export const TemplateUpdateTemplateResponse$outboundSchema: z.ZodType< authOptions: z.nullable( z.lazy(() => TemplateUpdateTemplateAuthOptions$outboundSchema), ), - templateDocumentDataId: z.string(), createdAt: z.string(), updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), folderId: z.nullable(z.string()), useLegacyFieldInsertion: z.boolean(), + envelopeId: z.string(), + templateDocumentDataId: z.string().default(""), }); /**