From dbb8698179c3bffd1309b001c2f05e5f82a44366 Mon Sep 17 00:00:00 2001 From: speakeasybot <bot@speakeasyapi.dev> Date: Tue, 6 May 2025 00:25:31 +0000 Subject: [PATCH 1/2] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.542.3 --- .gitignore | 4 + .speakeasy/gen.lock | 91 ++++- .speakeasy/gen.yaml | 3 +- .speakeasy/workflow.lock | 14 +- README.md | 5 + RELEASES.md | 12 +- ...ateembeddingpresigntokenbadrequesterror.md | 19 + ...ateembeddingpresigntokenbadrequestissue.md | 17 + ...mbeddingpresigntokeninternalservererror.md | 19 + ...ingpresigntokeninternalservererrorissue.md | 18 + ...ifyembeddingpresigntokenbadrequesterror.md | 19 + ...ifyembeddingpresigntokenbadrequestissue.md | 17 + ...mbeddingpresigntokeninternalservererror.md | 19 + ...ingpresigntokeninternalservererrorissue.md | 18 + docs/models/operations/document.md | 51 ++- .../documentcreatedocumenttemporaryfolder.md | 35 ++ ...documentcreatedocumenttemporaryresponse.md | 47 ++- .../operations/documentfinddocumentsdata.md | 8 +- .../documentfinddocumentsrequest.md | 1 + .../documentfinddocumentsresponse.md | 6 +- docs/models/operations/documentfoldertype.md | 15 + .../operations/documentfoldervisibility.md | 15 + ...ocumentgetdocumentwithdetailsbyidfolder.md | 35 ++ ...entgetdocumentwithdetailsbyidfoldertype.md | 15 + ...documentwithdetailsbyidfoldervisibility.md | 15 + ...cumentgetdocumentwithdetailsbyidrequest.md | 7 +- ...umentgetdocumentwithdetailsbyidresponse.md | 47 ++- .../documentmovedocumenttoteamresponse.md | 10 +- .../documentsenddocumentresponse.md | 10 +- .../operations/documentupdatedocumentdata.md | 3 +- .../documentupdatedocumentresponse.md | 10 +- ...esigncreateembeddingpresigntokenrequest.md | 15 + ...signcreateembeddingpresigntokenresponse.md | 23 ++ ...esignverifyembeddingpresigntokenrequest.md | 17 + ...signverifyembeddingpresigntokenresponse.md | 19 + ...emplatecreatedocumentfromtemplatefolder.md | 35 ++ ...atecreatedocumentfromtemplatefoldertype.md | 15 + ...atedocumentfromtemplatefoldervisibility.md | 15 + ...platecreatedocumentfromtemplateresponse.md | 51 ++- ...emplatecreatetemplatedirectlinkresponse.md | 2 +- .../templateduplicatetemplateresponse.md | 10 +- .../operations/templatefindtemplatesdata.md | 8 +- .../templatefindtemplatesrequest.md | 3 +- .../templatefindtemplatesresponse.md | 6 +- .../templategettemplatebyiddirectlink.md | 2 +- .../templategettemplatebyidfolder.md | 35 ++ .../templategettemplatebyidfoldertype.md | 15 + ...templategettemplatebyidfoldervisibility.md | 15 + .../templategettemplatebyidresponse.md | 23 +- .../templatemovetemplatetoteamresponse.md | 10 +- ...emplatetoggletemplatedirectlinkresponse.md | 2 +- .../operations/templateupdatetemplatedata.md | 3 +- .../templateupdatetemplateresponse.md | 10 +- docs/sdks/documents/README.md | 8 +- docs/sdks/embedding/README.md | 161 ++++++++ eslint.config.mjs | 1 + jsr.json | 2 +- package-lock.json | 8 +- package.json | 6 +- src/funcs/documentsFind.ts | 1 + src/funcs/documentsGet.ts | 7 +- ...ddingPresignCreateEmbeddingPresignToken.ts | 182 +++++++++ ...ddingPresignVerifyEmbeddingPresignToken.ts | 182 +++++++++ src/funcs/templatesFind.ts | 1 + src/lib/config.ts | 6 +- src/lib/matchers.ts | 20 + src/lib/sdks.ts | 32 +- src/mcp-server/mcp-server.ts | 2 +- src/mcp-server/server.ts | 6 +- ...ddingPresignCreateEmbeddingPresignToken.ts | 40 ++ ...ddingPresignVerifyEmbeddingPresignToken.ts | 40 ++ ...ddingpresigncreateembeddingpresigntoken.ts | 373 ++++++++++++++++++ ...ddingpresignverifyembeddingpresigntoken.ts | 373 ++++++++++++++++++ src/models/errors/index.ts | 2 + .../documentcreatedocumenttemporary.ts | 168 ++++++++ .../operations/documentfinddocuments.ts | 15 + .../documentgetdocumentwithdetailsbyid.ts | 187 +++++++++ .../operations/documentmovedocumenttoteam.ts | 8 + src/models/operations/documentsenddocument.ts | 8 + .../operations/documentupdatedocument.ts | 12 + ...ddingpresigncreateembeddingpresigntoken.ts | 169 ++++++++ ...ddingpresignverifyembeddingpresigntoken.ts | 158 ++++++++ src/models/operations/index.ts | 2 + .../templatecreatedocumentfromtemplate.ts | 180 +++++++++ .../operations/templateduplicatetemplate.ts | 8 + .../operations/templatefindtemplates.ts | 15 + .../operations/templategettemplatebyid.ts | 168 ++++++++ .../operations/templatemovetemplatetoteam.ts | 8 + .../operations/templateupdatetemplate.ts | 12 + src/sdk/embedding.ts | 45 +++ src/sdk/sdk.ts | 6 + 91 files changed, 3394 insertions(+), 167 deletions(-) create mode 100644 docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequesterror.md create mode 100644 docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequestissue.md create mode 100644 docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererror.md create mode 100644 docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererrorissue.md create mode 100644 docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequesterror.md create mode 100644 docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequestissue.md create mode 100644 docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererror.md create mode 100644 docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererrorissue.md create mode 100644 docs/models/operations/documentcreatedocumenttemporaryfolder.md create mode 100644 docs/models/operations/documentfoldertype.md create mode 100644 docs/models/operations/documentfoldervisibility.md create mode 100644 docs/models/operations/documentgetdocumentwithdetailsbyidfolder.md create mode 100644 docs/models/operations/documentgetdocumentwithdetailsbyidfoldertype.md create mode 100644 docs/models/operations/documentgetdocumentwithdetailsbyidfoldervisibility.md create mode 100644 docs/models/operations/embeddingpresigncreateembeddingpresigntokenrequest.md create mode 100644 docs/models/operations/embeddingpresigncreateembeddingpresigntokenresponse.md create mode 100644 docs/models/operations/embeddingpresignverifyembeddingpresigntokenrequest.md create mode 100644 docs/models/operations/embeddingpresignverifyembeddingpresigntokenresponse.md create mode 100644 docs/models/operations/templatecreatedocumentfromtemplatefolder.md create mode 100644 docs/models/operations/templatecreatedocumentfromtemplatefoldertype.md create mode 100644 docs/models/operations/templatecreatedocumentfromtemplatefoldervisibility.md create mode 100644 docs/models/operations/templategettemplatebyidfolder.md create mode 100644 docs/models/operations/templategettemplatebyidfoldertype.md create mode 100644 docs/models/operations/templategettemplatebyidfoldervisibility.md create mode 100644 docs/sdks/embedding/README.md create mode 100644 src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts create mode 100644 src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts create mode 100644 src/mcp-server/tools/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts create mode 100644 src/mcp-server/tools/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts create mode 100644 src/models/errors/embeddingpresigncreateembeddingpresigntoken.ts create mode 100644 src/models/errors/embeddingpresignverifyembeddingpresigntoken.ts create mode 100644 src/models/operations/embeddingpresigncreateembeddingpresigntoken.ts create mode 100644 src/models/operations/embeddingpresignverifyembeddingpresigntoken.ts create mode 100644 src/sdk/embedding.ts diff --git a/.gitignore b/.gitignore index 97ed1653..04a52ba5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +.DS_Store +**/.speakeasy/temp/ +**/.speakeasy/logs/ +.DS_Store /mcp-server /bin /.eslintcache diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 397158bf..3976af26 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: eb6c0a32ecae934190626408e9216f4e + docChecksum: 22f51060fb510897c2172538a92a9da1 docVersion: 0.0.0 - speakeasyVersion: 1.531.0 - generationVersion: 2.568.2 - releaseVersion: 0.2.0 - configChecksum: 27c1efe1a16e35a7a14dcc07a79c4578 + speakeasyVersion: 1.542.3 + generationVersion: 2.597.9 + releaseVersion: 0.2.1 + configChecksum: ef18dd9392b2ac387c3af4ac4f874c5d repoURL: https://github.com/documenso/sdk-typescript.git installationURL: https://github.com/documenso/sdk-typescript published: true @@ -14,7 +14,7 @@ features: typescript: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.11 - core: 3.21.5 + core: 3.21.7 defaultEnabledRetries: 0.1.0 enumUnions: 0.1.0 envVarSecurityUsage: 0.1.2 @@ -23,7 +23,7 @@ features: globalSecurityFlattening: 0.1.0 globalServerURLs: 2.82.4 groups: 2.81.2 - mcpServer: 0.9.1 + mcpServer: 0.9.2 nameOverrides: 2.81.2 nullables: 0.1.1 responseFormat: 0.2.3 @@ -78,6 +78,14 @@ generatedFiles: - docs/models/errors/documentupdatedocumentbadrequestissue.md - docs/models/errors/documentupdatedocumentinternalservererror.md - docs/models/errors/documentupdatedocumentinternalservererrorissue.md + - docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequesterror.md + - docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequestissue.md + - docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererror.md + - docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererrorissue.md + - docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequesterror.md + - docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequestissue.md + - docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererror.md + - docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererrorissue.md - docs/models/errors/fieldcreatedocumentfieldbadrequesterror.md - docs/models/errors/fieldcreatedocumentfieldbadrequestissue.md - docs/models/errors/fieldcreatedocumentfieldinternalservererror.md @@ -238,6 +246,7 @@ generatedFiles: - docs/models/operations/documentcreatedocumenttemporarydateformat.md - docs/models/operations/documentcreatedocumenttemporarydocumentdata.md - docs/models/operations/documentcreatedocumenttemporarydocumentmeta.md + - docs/models/operations/documentcreatedocumenttemporaryfolder.md - docs/models/operations/documentcreatedocumenttemporaryglobalaccessauthrequest.md - docs/models/operations/documentcreatedocumenttemporarylanguage.md - docs/models/operations/documentcreatedocumenttemporarymeta.md @@ -277,6 +286,8 @@ generatedFiles: - docs/models/operations/documentfinddocumentsteam.md - docs/models/operations/documentfinddocumentsuser.md - docs/models/operations/documentfinddocumentsvisibility.md + - docs/models/operations/documentfoldertype.md + - docs/models/operations/documentfoldervisibility.md - docs/models/operations/documentformvalues.md - docs/models/operations/documentgetdocumentwithdetailsbyidaccessauth.md - docs/models/operations/documentgetdocumentwithdetailsbyidactionauth.md @@ -298,6 +309,9 @@ generatedFiles: - docs/models/operations/documentgetdocumentwithdetailsbyidfieldmetatext.md - docs/models/operations/documentgetdocumentwithdetailsbyidfieldmetaunion.md - docs/models/operations/documentgetdocumentwithdetailsbyidfieldtype.md + - docs/models/operations/documentgetdocumentwithdetailsbyidfolder.md + - docs/models/operations/documentgetdocumentwithdetailsbyidfoldertype.md + - docs/models/operations/documentgetdocumentwithdetailsbyidfoldervisibility.md - docs/models/operations/documentgetdocumentwithdetailsbyidformvalues.md - docs/models/operations/documentgetdocumentwithdetailsbyidglobalaccessauth.md - docs/models/operations/documentgetdocumentwithdetailsbyidglobalactionauth.md @@ -400,6 +414,10 @@ generatedFiles: - docs/models/operations/documentvalue3.md - docs/models/operations/documentvisibility.md - docs/models/operations/emailsettingsaccount.md + - docs/models/operations/embeddingpresigncreateembeddingpresigntokenrequest.md + - docs/models/operations/embeddingpresigncreateembeddingpresigntokenresponse.md + - docs/models/operations/embeddingpresignverifyembeddingpresigntokenrequest.md + - docs/models/operations/embeddingpresignverifyembeddingpresigntokenresponse.md - docs/models/operations/fieldaccountcheckbox.md - docs/models/operations/fieldaccountdate.md - docs/models/operations/fieldaccountdropdown.md @@ -1504,6 +1522,9 @@ generatedFiles: - docs/models/operations/templatecreatedocumentfromtemplatefieldmetatypetext.md - docs/models/operations/templatecreatedocumentfromtemplatefieldmetaunion.md - docs/models/operations/templatecreatedocumentfromtemplatefieldtype.md + - docs/models/operations/templatecreatedocumentfromtemplatefolder.md + - docs/models/operations/templatecreatedocumentfromtemplatefoldertype.md + - docs/models/operations/templatecreatedocumentfromtemplatefoldervisibility.md - docs/models/operations/templatecreatedocumentfromtemplateformvalues.md - docs/models/operations/templatecreatedocumentfromtemplateglobalaccessauth.md - docs/models/operations/templatecreatedocumentfromtemplateglobalactionauth.md @@ -1617,6 +1638,9 @@ generatedFiles: - docs/models/operations/templategettemplatebyidfieldmetatext.md - docs/models/operations/templategettemplatebyidfieldmetaunion.md - docs/models/operations/templategettemplatebyidfieldtype.md + - docs/models/operations/templategettemplatebyidfolder.md + - docs/models/operations/templategettemplatebyidfoldertype.md + - docs/models/operations/templategettemplatebyidfoldervisibility.md - docs/models/operations/templategettemplatebyidglobalaccessauth.md - docs/models/operations/templategettemplatebyidglobalactionauth.md - docs/models/operations/templategettemplatebyidreadstatus.md @@ -1712,6 +1736,7 @@ generatedFiles: - docs/sdks/documents/README.md - docs/sdks/documentsfields/README.md - docs/sdks/documentsrecipients/README.md + - docs/sdks/embedding/README.md - docs/sdks/templates/README.md - docs/sdks/templatesfields/README.md - docs/sdks/templatesrecipients/README.md @@ -1740,6 +1765,8 @@ generatedFiles: - src/funcs/documentsRecipientsUpdateMany.ts - src/funcs/documentsRedistribute.ts - src/funcs/documentsUpdate.ts + - src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts + - src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts - src/funcs/templatesDelete.ts - src/funcs/templatesDirectLinkCreate.ts - src/funcs/templatesDirectLinkDelete.ts @@ -1816,6 +1843,8 @@ generatedFiles: - src/mcp-server/tools/documentsRecipientsUpdateMany.ts - src/mcp-server/tools/documentsRedistribute.ts - src/mcp-server/tools/documentsUpdate.ts + - src/mcp-server/tools/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts + - src/mcp-server/tools/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts - src/mcp-server/tools/templatesDelete.ts - src/mcp-server/tools/templatesDirectLinkCreate.ts - src/mcp-server/tools/templatesDirectLinkDelete.ts @@ -1850,6 +1879,8 @@ generatedFiles: - src/models/errors/documentresenddocument.ts - src/models/errors/documentsenddocument.ts - src/models/errors/documentupdatedocument.ts + - src/models/errors/embeddingpresigncreateembeddingpresigntoken.ts + - src/models/errors/embeddingpresignverifyembeddingpresigntoken.ts - src/models/errors/fieldcreatedocumentfield.ts - src/models/errors/fieldcreatedocumentfields.ts - src/models/errors/fieldcreatetemplatefield.ts @@ -1896,6 +1927,8 @@ generatedFiles: - src/models/operations/documentresenddocument.ts - src/models/operations/documentsenddocument.ts - src/models/operations/documentupdatedocument.ts + - src/models/operations/embeddingpresigncreateembeddingpresigntoken.ts + - src/models/operations/embeddingpresignverifyembeddingpresigntoken.ts - src/models/operations/fieldcreatedocumentfield.ts - src/models/operations/fieldcreatedocumentfields.ts - src/models/operations/fieldcreatetemplatefield.ts @@ -1935,6 +1968,7 @@ generatedFiles: - src/sdk/documents.ts - src/sdk/documentsfields.ts - src/sdk/documentsrecipients.ts + - src/sdk/embedding.ts - src/sdk/index.ts - src/sdk/sdk.ts - src/sdk/templates.ts @@ -1970,9 +2004,10 @@ examples: parameters: path: documentId: 7003.47 + query: {} responses: "200": - application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "COMPLETED", "source": "TEMPLATE", "id": 9699.61, "externalId": "<id>", "userId": 4580.49, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "PASSKEY"}, "formValues": {"key": "<value>"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1742089609879", "updatedAt": "1744023228599", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 8013.73, "templateId": 788.88, "documentData": {"type": "S3_PATH", "id": "<id>", "data": "<value>", "initialData": "<value>"}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "<id>", "subject": "<value>", "message": "<value>", "timezone": "Asia/Dushanbe", "password": "mEgZU18kgjdwKI0", "dateFormat": "<value>", "documentId": 5505.63, "redirectUrl": "https://tough-parade.name/", "typedSignatureEnabled": true, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "<value>", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "recipients": [{"role": "CC", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 5709.8, "documentId": 6076.79, "templateId": 8025.74, "email": "Mohamed39@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "EXPLICIT_NONE"}, "signingOrder": 8436.18, "rejectionReason": "<value>"}], "fields": [{"type": "FREE_SIGNATURE", "id": 7411.31, "secondaryId": "<id>", "documentId": 5036.71, "templateId": 9505.98, "recipientId": 4866.69, "page": 721.08, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "name"}}]} + application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "COMPLETED", "source": "TEMPLATE", "id": 9699.61, "externalId": "<id>", "userId": 4580.49, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "PASSKEY"}, "formValues": {"key": "<value>"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1742089609879", "updatedAt": "1744023228599", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 8013.73, "templateId": 788.88, "folderId": "<id>", "documentData": {"type": "S3_PATH", "id": "<id>", "data": "<value>", "initialData": "<value>"}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "<id>", "subject": "<value>", "message": "<value>", "timezone": "Asia/Dushanbe", "password": "mEgZU18kgjdwKI0", "dateFormat": "<value>", "documentId": 5505.63, "redirectUrl": "https://tough-parade.name/", "typedSignatureEnabled": true, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "<value>", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "folder": {"id": "<id>", "name": "<value>", "type": "TEMPLATE", "visibility": "MANAGER_AND_ABOVE", "userId": 5442.21, "teamId": 5212.35, "pinned": false, "parentId": "<id>", "createdAt": "1729400102265", "updatedAt": "1746443604539"}, "recipients": [{"role": "CC", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 5709.8, "documentId": 6076.79, "templateId": 8025.74, "email": "Mohamed39@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "EXPLICIT_NONE"}, "signingOrder": 8436.18, "rejectionReason": "<value>"}], "fields": [{"type": "FREE_SIGNATURE", "id": 7411.31, "secondaryId": "<id>", "documentId": 5036.71, "templateId": 9505.98, "recipientId": 4866.69, "page": 721.08, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "name"}}]} "400": application/json: {"message": "<value>", "code": "<value>"} "404": @@ -1985,7 +2020,7 @@ examples: application/json: {"title": "<value>"} responses: "200": - application/json: {"document": {"visibility": "EVERYONE", "status": "REJECTED", "source": "DOCUMENT", "id": 429.52, "externalId": "<id>", "userId": 5373.96, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT"}, "formValues": {"key": 4734.62, "key1": false, "key2": "<value>"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1734727887216", "updatedAt": "1744054353547", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 3570.46, "templateId": 8120.06, "documentData": {"type": "BYTES", "id": "<id>", "data": "<value>", "initialData": "<value>"}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "<id>", "subject": "<value>", "message": "<value>", "timezone": "America/Port-au-Prince", "password": "nDdQyEBdZkTA06U", "dateFormat": "<value>", "documentId": 9010.36, "redirectUrl": "https://scientific-cutover.biz/", "typedSignatureEnabled": true, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "<value>", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "recipients": [{"role": "SIGNER", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 6655.67, "documentId": 8383.97, "templateId": 3211.07, "email": "Hester7@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "TWO_FACTOR_AUTH"}, "signingOrder": 901.18, "rejectionReason": "<value>"}, {"role": "CC", "readStatus": "OPENED", "signingStatus": "NOT_SIGNED", "sendStatus": "SENT", "id": 9370.59, "documentId": 559.13, "templateId": 8443.19, "email": "Clark_Klocko95@gmail.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "ACCOUNT"}, "signingOrder": 1889.01, "rejectionReason": "<value>"}], "fields": [{"type": "INITIALS", "id": 8326.77, "secondaryId": "<id>", "documentId": 882.7, "templateId": 9365.99, "recipientId": 9528.98, "page": 850.57, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "checkbox"}}, {"type": "TEXT", "id": 3732.05, "secondaryId": "<id>", "documentId": 4883.71, "templateId": 1585.21, "recipientId": 4432.04, "page": 797.46, "customText": "<value>", "inserted": false, "fieldMeta": {"type": "radio"}}, {"type": "SIGNATURE", "id": 777.72, "secondaryId": "<id>", "documentId": 4934.61, "templateId": 6004.17, "recipientId": 6632.08, "page": 5659.98, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "checkbox"}}]}, "uploadUrl": "https://enlightened-language.biz/"} + application/json: {"document": {"visibility": "EVERYONE", "status": "REJECTED", "source": "DOCUMENT", "id": 429.52, "externalId": "<id>", "userId": 5373.96, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT"}, "formValues": {"key": 4734.62, "key1": "<value>", "key2": "<value>"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1734727887216", "updatedAt": "1744054353547", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 3570.46, "templateId": 8120.06, "folderId": "<id>", "documentData": {"type": "BYTES", "id": "<id>", "data": "<value>", "initialData": "<value>"}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "<id>", "subject": "<value>", "message": "<value>", "timezone": "America/Port-au-Prince", "password": "nDdQyEBdZkTA06U", "dateFormat": "<value>", "documentId": 9010.36, "redirectUrl": "https://scientific-cutover.biz/", "typedSignatureEnabled": true, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "<value>", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "folder": {"id": "<id>", "name": "<value>", "type": "TEMPLATE", "visibility": "EVERYONE", "userId": 429.52, "teamId": 5373.96, "pinned": true, "parentId": "<id>", "createdAt": "1740910540780", "updatedAt": "1746469254171"}, "recipients": [{"role": "SIGNER", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 6655.67, "documentId": 8383.97, "templateId": 3211.07, "email": "Hester7@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "TWO_FACTOR_AUTH"}, "signingOrder": 901.18, "rejectionReason": "<value>"}, {"role": "CC", "readStatus": "OPENED", "signingStatus": "NOT_SIGNED", "sendStatus": "SENT", "id": 9370.59, "documentId": 559.13, "templateId": 8443.19, "email": "Clark_Klocko95@gmail.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "ACCOUNT"}, "signingOrder": 1889.01, "rejectionReason": "<value>"}], "fields": [{"type": "INITIALS", "id": 8326.77, "secondaryId": "<id>", "documentId": 882.7, "templateId": 9365.99, "recipientId": 9528.98, "page": 850.57, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "checkbox"}}, {"type": "TEXT", "id": 3732.05, "secondaryId": "<id>", "documentId": 4883.71, "templateId": 1585.21, "recipientId": 4432.04, "page": 797.46, "customText": "<value>", "inserted": false, "fieldMeta": {"type": "radio"}}, {"type": "SIGNATURE", "id": 777.72, "secondaryId": "<id>", "documentId": 4934.61, "templateId": 6004.17, "recipientId": 6632.08, "page": 5659.98, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "checkbox"}}]}, "uploadUrl": "https://enlightened-language.biz/"} "400": application/json: {"message": "<value>", "code": "<value>"} "500": @@ -1996,7 +2031,7 @@ examples: application/json: {"documentId": 8574.78} responses: "200": - application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "PENDING", "source": "TEMPLATE_DIRECT_LINK", "id": 6276.9, "externalId": "<id>", "userId": 4888.52, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "TWO_FACTOR_AUTH"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1740807803350", "updatedAt": "1744023982082", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 3115.07, "templateId": 2494.4} + application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "PENDING", "source": "TEMPLATE_DIRECT_LINK", "id": 6276.9, "externalId": "<id>", "userId": 4888.52, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "TWO_FACTOR_AUTH"}, "formValues": {"key": true, "key1": 6276.9, "key2": false}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1740807803350", "updatedAt": "1744023982082", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 3115.07, "templateId": 2494.4, "folderId": "<id>", "useLegacyFieldInsertion": true} "400": application/json: {"message": "<value>", "code": "<value>"} "500": @@ -2018,7 +2053,7 @@ examples: application/json: {"documentId": 8301.72, "teamId": 6724.78} responses: "200": - application/json: {"visibility": "ADMIN", "status": "COMPLETED", "source": "TEMPLATE", "id": 7750.43, "externalId": "<id>", "userId": 780.73, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1717956283175", "updatedAt": "1744023103025", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 7007.97, "templateId": 9336.34} + application/json: {"visibility": "ADMIN", "status": "COMPLETED", "source": "TEMPLATE", "id": 7750.43, "externalId": "<id>", "userId": 780.73, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT"}, "formValues": {"key": 7264.87, "key1": 6341.95, "key2": 780.73}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1717956283175", "updatedAt": "1744023103025", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 7007.97, "templateId": 9336.34, "folderId": "<id>", "useLegacyFieldInsertion": true} "400": application/json: {"message": "<value>", "code": "<value>"} "500": @@ -2029,7 +2064,7 @@ examples: application/json: {"documentId": 4115.92} responses: "200": - application/json: {"visibility": "ADMIN", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 2654.91, "externalId": "<id>", "userId": 6765.82, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "TWO_FACTOR_AUTH"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1740688884355", "updatedAt": "1744031077894", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 2965.33, "templateId": 8368.46} + application/json: {"visibility": "ADMIN", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 2654.91, "externalId": "<id>", "userId": 6765.82, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "TWO_FACTOR_AUTH"}, "formValues": {"key": 1184.5}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1740688884355", "updatedAt": "1744031077894", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 2965.33, "templateId": 8368.46, "folderId": "<id>", "useLegacyFieldInsertion": false} "400": application/json: {"message": "<value>", "code": "<value>"} "500": @@ -2212,7 +2247,7 @@ examples: templateId: 7003.47 responses: "200": - application/json: {"type": "PRIVATE", "visibility": "MANAGER_AND_ABOVE", "id": 5212.35, "externalId": "<id>", "title": "<value>", "userId": 9699.61, "teamId": 4580.49, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "PASSKEY"}, "templateDocumentDataId": "<id>", "createdAt": "1720823294174", "updatedAt": "1744003816428", "publicTitle": "<value>", "publicDescription": "<value>", "templateDocumentData": {"type": "BYTES_64", "id": "<id>", "data": "<value>", "initialData": "<value>"}, "templateMeta": {"id": "<id>", "subject": "<value>", "message": "<value>", "timezone": "America/St_Thomas", "dateFormat": "<value>", "signingOrder": "SEQUENTIAL", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": true, "distributionMethod": "NONE", "templateId": 8058.76, "redirectUrl": "https://similar-nucleotidase.name/", "language": "<value>", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "directLink": {"id": "<id>", "templateId": 3226.12, "token": "<value>", "createdAt": "1722727748188", "enabled": true, "directTemplateRecipientId": 2433.54}, "user": {"id": 7802.62, "name": "<value>", "email": "Myrl_Rath32@gmail.com"}, "recipients": [{"role": "VIEWER", "readStatus": "NOT_OPENED", "signingStatus": "NOT_SIGNED", "sendStatus": "NOT_SENT", "id": 5505.63, "documentId": 1089.8, "templateId": 8620.18, "email": "Kali_Rempel@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "ACCOUNT"}, "signingOrder": 8084.81, "rejectionReason": "<value>"}, {"role": "VIEWER", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 8025.74, "documentId": 3974.83, "templateId": 7250, "email": "Baylee75@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "PASSKEY"}, "signingOrder": 1491.08, "rejectionReason": "<value>"}, {"role": "APPROVER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "NOT_SENT", "id": 721.08, "documentId": 813.73, "templateId": 1652.15, "email": "Mara29@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "PASSKEY"}, "signingOrder": 2379.94, "rejectionReason": "<value>"}], "fields": [{"type": "INITIALS", "id": 7869.52, "secondaryId": "<id>", "documentId": 7834.59, "templateId": 6676.45, "recipientId": 1884.2, "page": 4577.72, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "date"}}, {"type": "DROPDOWN", "id": 3951.88, "secondaryId": "<id>", "documentId": 1687.26, "templateId": 580.14, "recipientId": 5465.33, "page": 411.01, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "number"}}]} + application/json: {"type": "PRIVATE", "visibility": "MANAGER_AND_ABOVE", "id": 5212.35, "externalId": "<id>", "title": "<value>", "userId": 9699.61, "teamId": 4580.49, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "PASSKEY"}, "templateDocumentDataId": "<id>", "createdAt": "1720823294174", "updatedAt": "1744003816428", "publicTitle": "<value>", "publicDescription": "<value>", "folderId": "<id>", "templateDocumentData": {"type": "BYTES_64", "id": "<id>", "data": "<value>", "initialData": "<value>"}, "templateMeta": {"id": "<id>", "subject": "<value>", "message": "<value>", "timezone": "America/St_Thomas", "dateFormat": "<value>", "signingOrder": "SEQUENTIAL", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": true, "distributionMethod": "NONE", "templateId": 8058.76, "redirectUrl": "https://similar-nucleotidase.name/", "language": "<value>", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "directLink": {"id": "<id>", "templateId": 3226.12, "token": "<value>", "createdAt": "1722727748188", "enabled": true, "directTemplateRecipientId": 2433.54}, "user": {"id": 7802.62, "name": "<value>", "email": "Myrl_Rath32@gmail.com"}, "recipients": [{"role": "VIEWER", "readStatus": "NOT_OPENED", "signingStatus": "NOT_SIGNED", "sendStatus": "NOT_SENT", "id": 5505.63, "documentId": 1089.8, "templateId": 8620.18, "email": "Kali_Rempel@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "ACCOUNT"}, "signingOrder": 8084.81, "rejectionReason": "<value>"}, {"role": "VIEWER", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 8025.74, "documentId": 3974.83, "templateId": 7250, "email": "Baylee75@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "PASSKEY"}, "signingOrder": 1491.08, "rejectionReason": "<value>"}, {"role": "APPROVER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "NOT_SENT", "id": 721.08, "documentId": 813.73, "templateId": 1652.15, "email": "Mara29@yahoo.com", "name": "<value>", "token": "<value>", "documentDeletedAt": "<value>", "expired": "<value>", "signedAt": "<value>", "authOptions": {"accessAuth": "ACCOUNT", "actionAuth": "PASSKEY"}, "signingOrder": 2379.94, "rejectionReason": "<value>"}], "fields": [{"type": "INITIALS", "id": 7869.52, "secondaryId": "<id>", "documentId": 7834.59, "templateId": 6676.45, "recipientId": 1884.2, "page": 4577.72, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "date"}}, {"type": "DROPDOWN", "id": 3951.88, "secondaryId": "<id>", "documentId": 1687.26, "templateId": 580.14, "recipientId": 5465.33, "page": 411.01, "customText": "<value>", "inserted": true, "fieldMeta": {"type": "number"}}], "folder": {"id": "<id>", "name": "<value>", "type": "TEMPLATE", "visibility": "MANAGER_AND_ABOVE", "userId": 5442.21, "teamId": 5212.35, "pinned": false, "parentId": "<id>", "createdAt": "1729400102596", "updatedAt": "1746443604871"}} "400": application/json: {"message": "<value>", "code": "<value>"} "404": @@ -2225,7 +2260,7 @@ examples: application/json: {"templateId": 8574.78} responses: "200": - application/json: {"type": "PRIVATE", "visibility": "MANAGER_AND_ABOVE", "id": 9914.64, "externalId": "<id>", "title": "<value>", "userId": 6276.9, "teamId": 4888.52, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "TWO_FACTOR_AUTH"}, "templateDocumentDataId": "<id>", "createdAt": "1714240678864", "updatedAt": "1744062830660", "publicTitle": "<value>", "publicDescription": "<value>"} + application/json: {"type": "PRIVATE", "visibility": "MANAGER_AND_ABOVE", "id": 9914.64, "externalId": "<id>", "title": "<value>", "userId": 6276.9, "teamId": 4888.52, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "TWO_FACTOR_AUTH"}, "templateDocumentDataId": "<id>", "createdAt": "1714240678864", "updatedAt": "1744062830660", "publicTitle": "<value>", "publicDescription": "<value>", "folderId": "<id>", "useLegacyFieldInsertion": false} "400": application/json: {"message": "<value>", "code": "<value>"} "500": @@ -2236,7 +2271,7 @@ examples: application/json: {"templateId": 3523.11} responses: "200": - application/json: {"type": "PUBLIC", "visibility": "ADMIN", "id": 4611.48, "externalId": "<id>", "title": "<value>", "userId": 3488.91, "teamId": 5246.74, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT"}, "templateDocumentDataId": "<id>", "createdAt": "1725118613916", "updatedAt": "1744026797219", "publicTitle": "<value>", "publicDescription": "<value>"} + application/json: {"type": "PUBLIC", "visibility": "ADMIN", "id": 4611.48, "externalId": "<id>", "title": "<value>", "userId": 3488.91, "teamId": 5246.74, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT"}, "templateDocumentDataId": "<id>", "createdAt": "1725118613916", "updatedAt": "1744026797219", "publicTitle": "<value>", "publicDescription": "<value>", "folderId": "<id>", "useLegacyFieldInsertion": true} "400": application/json: {"message": "<value>", "code": "<value>"} "500": @@ -2258,7 +2293,7 @@ examples: application/json: {"templateId": 6626.9, "recipients": [{"id": 6473.53, "email": "August_Schmeler68@yahoo.com"}, {"id": 3772.31, "email": "Angeline.Purdy@gmail.com"}]} responses: "200": - application/json: {"visibility": "EVERYONE", "status": "DRAFT", "source": "DOCUMENT", "id": 5293.43, "externalId": "<id>", "userId": 382.49, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "PASSKEY"}, "formValues": {"key": 1071.58, "key1": "<value>", "key2": "<value>"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1719470943117", "updatedAt": "1744068648916", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 8148.18, "templateId": 6492.41, "documentData": {"type": "BYTES", "id": "<id>", "data": "<value>", "initialData": "<value>"}, "documentMeta": {"signingOrder": "SEQUENTIAL", "distributionMethod": "EMAIL", "id": "<id>", "subject": "<value>", "message": "<value>", "timezone": "America/Mazatlan", "password": "ygGKsqP0fmjT8Pg", "dateFormat": "<value>", "documentId": 4303.84, "redirectUrl": "https://disloyal-haversack.com", "typedSignatureEnabled": true, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": false, "language": "<value>", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "recipients": [], "fields": [{"type": "NAME", "id": 9874.18, "secondaryId": "<id>", "documentId": 772.27, "templateId": 472.7, "recipientId": 894.43, "page": 108.98, "customText": "<value>", "inserted": false, "fieldMeta": {"type": "name"}}]} + application/json: {"visibility": "EVERYONE", "status": "DRAFT", "source": "DOCUMENT", "id": 5293.43, "externalId": "<id>", "userId": 382.49, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "PASSKEY"}, "formValues": {"key": 1071.58, "key1": "<value>", "key2": "<value>"}, "title": "<value>", "documentDataId": "<id>", "createdAt": "1719470943117", "updatedAt": "1744068648916", "completedAt": "<value>", "deletedAt": "<value>", "teamId": 8148.18, "templateId": 6492.41, "folderId": "<id>", "documentData": {"type": "BYTES", "id": "<id>", "data": "<value>", "initialData": "<value>"}, "documentMeta": {"signingOrder": "SEQUENTIAL", "distributionMethod": "EMAIL", "id": "<id>", "subject": "<value>", "message": "<value>", "timezone": "America/Mazatlan", "password": "ygGKsqP0fmjT8Pg", "dateFormat": "<value>", "documentId": 4303.84, "redirectUrl": "https://disloyal-haversack.com", "typedSignatureEnabled": true, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": false, "language": "<value>", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "folder": {"id": "<id>", "name": "<value>", "type": "TEMPLATE", "visibility": "MANAGER_AND_ABOVE", "userId": 6473.53, "teamId": 4468.48, "pinned": true, "parentId": "<id>", "createdAt": "1734558695459", "updatedAt": "1746473654307"}, "recipients": [], "fields": [{"type": "NAME", "id": 9874.18, "secondaryId": "<id>", "documentId": 772.27, "templateId": 472.7, "recipientId": 894.43, "page": 108.98, "customText": "<value>", "inserted": false, "fieldMeta": {"type": "name"}}]} "400": application/json: {"message": "<value>", "code": "<value>"} "500": @@ -2269,7 +2304,7 @@ examples: application/json: {"templateId": 8301.72, "teamId": 6724.78} responses: "200": - application/json: {"type": "PRIVATE", "visibility": "ADMIN", "id": 6341.95, "externalId": "<id>", "title": "<value>", "userId": 7750.43, "teamId": 780.73, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT"}, "templateDocumentDataId": "<id>", "createdAt": "1712824623206", "updatedAt": "1744000224539", "publicTitle": "<value>", "publicDescription": "<value>"} + application/json: {"type": "PRIVATE", "visibility": "ADMIN", "id": 6341.95, "externalId": "<id>", "title": "<value>", "userId": 7750.43, "teamId": 780.73, "authOptions": {"globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT"}, "templateDocumentDataId": "<id>", "createdAt": "1712824623206", "updatedAt": "1744000224539", "publicTitle": "<value>", "publicDescription": "<value>", "folderId": "<id>", "useLegacyFieldInsertion": false} "400": application/json: {"message": "<value>", "code": "<value>"} "500": @@ -2445,5 +2480,27 @@ examples: application/json: {"message": "<value>", "code": "<value>"} "500": application/json: {"message": "<value>", "code": "<value>"} + embeddingPresign-createEmbeddingPresignToken: + speakeasy-default-embedding-presign-create-embedding-presign-token: + requestBody: + application/json: {"expiresIn": 60} + responses: + "200": + application/json: {"token": "<value>", "expiresAt": "1760387022894", "expiresIn": 2320.99} + "400": + application/json: {"message": "<value>", "code": "<value>"} + "500": + application/json: {"message": "<value>", "code": "<value>"} + embeddingPresign-verifyEmbeddingPresignToken: + speakeasy-default-embedding-presign-verify-embedding-presign-token: + requestBody: + application/json: {"token": "<value>"} + responses: + "200": + application/json: {"success": true} + "400": + application/json: {"message": "<value>", "code": "<value>"} + "500": + application/json: {"message": "<value>", "code": "<value>"} examplesVersion: 1.0.1 generatedTests: {} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 4138f278..c98e48e1 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -11,11 +11,12 @@ generation: parameterOrderingFeb2024: true requestResponseComponentNamesFeb2024: true securityFeb2025: false + sharedErrorComponentsApr2025: false auth: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false typescript: - version: 0.2.0 + version: 0.2.1 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index a7ea47f2..173fd989 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.531.0 +speakeasyVersion: 1.542.3 sources: Documenso v2 beta API: sourceNamespace: documenso-v-2-beta-api - sourceRevisionDigest: sha256:f6430b0cc0c2d5b7a14e59359376c04f78458dd953a630f4a58093e86b4b56f7 - sourceBlobDigest: sha256:b5ace18675a2927ed909e9e7210586bfd0bad91e1efebe408005432746a1511c + sourceRevisionDigest: sha256:d88a25dfb22ae228ff0bfca3f871428ba4db0ad7d432efe2335b62ed0d457777 + sourceBlobDigest: sha256:c34916afc9c3e86ae56648a35287de3836f8e657c5d68cc4b8d8c5d52bfe0c66 tags: - latest - - speakeasy-sdk-regen-1738455725 + - speakeasy-sdk-regen-1744935756 - 0.0.0 targets: documenso: source: Documenso v2 beta API sourceNamespace: documenso-v-2-beta-api - sourceRevisionDigest: sha256:f6430b0cc0c2d5b7a14e59359376c04f78458dd953a630f4a58093e86b4b56f7 - sourceBlobDigest: sha256:b5ace18675a2927ed909e9e7210586bfd0bad91e1efebe408005432746a1511c + sourceRevisionDigest: sha256:d88a25dfb22ae228ff0bfca3f871428ba4db0ad7d432efe2335b62ed0d457777 + sourceBlobDigest: sha256:c34916afc9c3e86ae56648a35287de3836f8e657c5d68cc4b8d8c5d52bfe0c66 codeSamplesNamespace: documenso-v-2-beta-api-typescript-code-samples - codeSamplesRevisionDigest: sha256:7e83428fa1487934908f1a11ba3bea73bbe1d662ab1fbed2c80e7f33ac7f99d2 + codeSamplesRevisionDigest: sha256:a175f2e1342b51346a6f64580c801ea33431a77306c5b1377cc9e20b2253b8a9 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 95e49291..621842ef 100644 --- a/README.md +++ b/README.md @@ -327,6 +327,11 @@ main() * [updateMany](docs/sdks/documentsrecipients/README.md#updatemany) - Update document recipients * [delete](docs/sdks/documentsrecipients/README.md#delete) - Delete document recipient +### [embedding](docs/sdks/embedding/README.md) + +* [embeddingPresignCreateEmbeddingPresignToken](docs/sdks/embedding/README.md#embeddingpresigncreateembeddingpresigntoken) - Create embedding presign token +* [embeddingPresignVerifyEmbeddingPresignToken](docs/sdks/embedding/README.md#embeddingpresignverifyembeddingpresigntoken) - Verify embedding presign token + ### [templates](docs/sdks/templates/README.md) * [find](docs/sdks/templates/README.md#find) - Find templates diff --git a/RELEASES.md b/RELEASES.md index 9e7b36e0..ce0db34c 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -28,4 +28,14 @@ Based on: ### Generated - [typescript v0.2.0] . ### Releases -- [NPM v0.2.0] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.2.0 - . \ No newline at end of file +- [NPM v0.2.0] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.2.0 - . + +## 2025-05-06 00:23:39 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.542.3 (2.597.9) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.2.1] . +### Releases +- [NPM v0.2.1] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.2.1 - . \ No newline at end of file diff --git a/docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequesterror.md b/docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequesterror.md new file mode 100644 index 00000000..3e823951 --- /dev/null +++ b/docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequesterror.md @@ -0,0 +1,19 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError + +Invalid input data + +## Example Usage + +```typescript +import { EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError } from "@documenso/sdk-typescript/models/errors"; + +// No examples available for this model +``` + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | N/A | +| `code` | *string* | :heavy_check_mark: | N/A | +| `issues` | [errors.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue](../../models/errors/embeddingpresigncreateembeddingpresigntokenbadrequestissue.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequestissue.md b/docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequestissue.md new file mode 100644 index 00000000..baf7baf7 --- /dev/null +++ b/docs/models/errors/embeddingpresigncreateembeddingpresigntokenbadrequestissue.md @@ -0,0 +1,17 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue + +## Example Usage + +```typescript +import { EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue } from "@documenso/sdk-typescript/models/errors"; + +let value: EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue = { + message: "<value>", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererror.md b/docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererror.md new file mode 100644 index 00000000..1014b664 --- /dev/null +++ b/docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererror.md @@ -0,0 +1,19 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError + +Internal server error + +## Example Usage + +```typescript +import { EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError } from "@documenso/sdk-typescript/models/errors"; + +// No examples available for this model +``` + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | N/A | +| `code` | *string* | :heavy_check_mark: | N/A | +| `issues` | [errors.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue](../../models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererrorissue.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererrorissue.md b/docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererrorissue.md new file mode 100644 index 00000000..6be3b888 --- /dev/null +++ b/docs/models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererrorissue.md @@ -0,0 +1,18 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue + +## Example Usage + +```typescript +import { EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue } from "@documenso/sdk-typescript/models/errors"; + +let value: EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue = + { + message: "<value>", + }; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequesterror.md b/docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequesterror.md new file mode 100644 index 00000000..b6029d91 --- /dev/null +++ b/docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequesterror.md @@ -0,0 +1,19 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError + +Invalid input data + +## Example Usage + +```typescript +import { EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError } from "@documenso/sdk-typescript/models/errors"; + +// No examples available for this model +``` + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | N/A | +| `code` | *string* | :heavy_check_mark: | N/A | +| `issues` | [errors.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue](../../models/errors/embeddingpresignverifyembeddingpresigntokenbadrequestissue.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequestissue.md b/docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequestissue.md new file mode 100644 index 00000000..79d61bad --- /dev/null +++ b/docs/models/errors/embeddingpresignverifyembeddingpresigntokenbadrequestissue.md @@ -0,0 +1,17 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue + +## Example Usage + +```typescript +import { EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue } from "@documenso/sdk-typescript/models/errors"; + +let value: EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue = { + message: "<value>", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererror.md b/docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererror.md new file mode 100644 index 00000000..17ca3430 --- /dev/null +++ b/docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererror.md @@ -0,0 +1,19 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError + +Internal server error + +## Example Usage + +```typescript +import { EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError } from "@documenso/sdk-typescript/models/errors"; + +// No examples available for this model +``` + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | N/A | +| `code` | *string* | :heavy_check_mark: | N/A | +| `issues` | [errors.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue](../../models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererrorissue.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererrorissue.md b/docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererrorissue.md new file mode 100644 index 00000000..c8212da9 --- /dev/null +++ b/docs/models/errors/embeddingpresignverifyembeddingpresigntokeninternalservererrorissue.md @@ -0,0 +1,18 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue + +## Example Usage + +```typescript +import { EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue } from "@documenso/sdk-typescript/models/errors"; + +let value: EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue = + { + message: "<value>", + }; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *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 84a6ddd1..d5f16d78 100644 --- a/docs/models/operations/document.md +++ b/docs/models/operations/document.md @@ -21,12 +21,13 @@ let value: Document = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1715705047832", - updatedAt: "1743998956756", + createdAt: "1718124342221", + updatedAt: "1746418251145", completedAt: "<value>", deletedAt: "<value>", teamId: 5924.72, templateId: 4759.67, + folderId: "<id>", documentData: { type: "BYTES", id: "<id>", @@ -51,16 +52,28 @@ let value: Document = { language: "<value>", emailSettings: {}, }, + folder: { + id: "<id>", + name: "<value>", + type: "DOCUMENT", + visibility: "ADMIN", + userId: 9145.72, + teamId: 8500.19, + pinned: false, + parentId: "<id>", + createdAt: "1721779637504", + updatedAt: "1746491003896", + }, recipients: [ { - role: "SIGNER", - readStatus: "OPENED", + role: "VIEWER", + readStatus: "NOT_OPENED", signingStatus: "REJECTED", - sendStatus: "SENT", - id: 2164.05, - documentId: 9991.71, - templateId: 5585.08, - email: "Veronica43@gmail.com", + sendStatus: "NOT_SENT", + id: 1593.27, + documentId: 7782.87, + templateId: 4312.28, + email: "Meggie.Toy@hotmail.com", name: "<value>", token: "<value>", documentDeletedAt: "<value>", @@ -68,25 +81,25 @@ let value: Document = { signedAt: "<value>", authOptions: { accessAuth: "ACCOUNT", - actionAuth: "TWO_FACTOR_AUTH", + actionAuth: "ACCOUNT", }, - signingOrder: 135.53, + signingOrder: 5424.29, rejectionReason: "<value>", }, ], fields: [ { - type: "CHECKBOX", - id: 2367.45, + type: "TEXT", + id: 4990.82, secondaryId: "<id>", - documentId: 6218.47, - templateId: 3434.3, - recipientId: 2415.1, - page: 5424.29, + documentId: 5482.99, + templateId: 4083.93, + recipientId: 3871.3, + page: 2497.12, customText: "<value>", inserted: false, fieldMeta: { - type: "number", + type: "initials", }, }, ], @@ -113,7 +126,9 @@ let value: Document = { | `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 | | `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 | | `recipients` | [operations.DocumentRecipient](../../models/operations/documentrecipient.md)[] | :heavy_check_mark: | N/A | | `fields` | [operations.DocumentField](../../models/operations/documentfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporaryfolder.md b/docs/models/operations/documentcreatedocumenttemporaryfolder.md new file mode 100644 index 00000000..a82be8d9 --- /dev/null +++ b/docs/models/operations/documentcreatedocumenttemporaryfolder.md @@ -0,0 +1,35 @@ +# DocumentCreateDocumentTemporaryFolder + +## Example Usage + +```typescript +import { DocumentCreateDocumentTemporaryFolder } from "@documenso/sdk-typescript/models/operations"; + +let value: DocumentCreateDocumentTemporaryFolder = { + id: "<id>", + name: "<value>", + type: "DOCUMENT", + visibility: "ADMIN", + userId: 3738.73, + teamId: 7961.24, + pinned: false, + parentId: "<id>", + createdAt: "1735517689126", + updatedAt: "1746450681488", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `id` | *string* | :heavy_check_mark: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | +| `type` | [operations.DocumentFolderType](../../models/operations/documentfoldertype.md) | :heavy_check_mark: | N/A | +| `visibility` | [operations.DocumentFolderVisibility](../../models/operations/documentfoldervisibility.md) | :heavy_check_mark: | N/A | +| `userId` | *number* | :heavy_check_mark: | N/A | +| `teamId` | *number* | :heavy_check_mark: | N/A | +| `pinned` | *boolean* | :heavy_check_mark: | N/A | +| `parentId` | *string* | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentcreatedocumenttemporaryresponse.md b/docs/models/operations/documentcreatedocumenttemporaryresponse.md index 27ba4d01..d2bb4b67 100644 --- a/docs/models/operations/documentcreatedocumenttemporaryresponse.md +++ b/docs/models/operations/documentcreatedocumenttemporaryresponse.md @@ -24,12 +24,13 @@ let value: DocumentCreateDocumentTemporaryResponse = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1736755356702", - updatedAt: "1744059121860", + createdAt: "1739174635984", + updatedAt: "1746478401142", completedAt: "<value>", deletedAt: "<value>", teamId: 1489.17, templateId: 1923.96, + folderId: "<id>", documentData: { type: "BYTES_64", id: "<id>", @@ -54,16 +55,28 @@ let value: DocumentCreateDocumentTemporaryResponse = { language: "<value>", emailSettings: {}, }, + folder: { + id: "<id>", + name: "<value>", + type: "DOCUMENT", + visibility: "MANAGER_AND_ABOVE", + userId: 344.22, + teamId: 7775.21, + pinned: false, + parentId: "<id>", + createdAt: "1733474108345", + updatedAt: "1746417798831", + }, recipients: [ { role: "SIGNER", - readStatus: "NOT_OPENED", + readStatus: "OPENED", signingStatus: "NOT_SIGNED", sendStatus: "SENT", - id: 5872.35, - documentId: 1519.38, - templateId: 2106.89, - email: "Christine64@hotmail.com", + id: 8665.89, + documentId: 1176.4, + templateId: 6498.91, + email: "Mariela82@hotmail.com", name: "<value>", token: "<value>", documentDeletedAt: "<value>", @@ -71,30 +84,30 @@ let value: DocumentCreateDocumentTemporaryResponse = { signedAt: "<value>", authOptions: { accessAuth: "ACCOUNT", - actionAuth: "TWO_FACTOR_AUTH", + actionAuth: "PASSKEY", }, - signingOrder: 4871.42, + signingOrder: 3136.7, rejectionReason: "<value>", }, ], fields: [ { - type: "DROPDOWN", - id: 4352.01, + type: "NAME", + id: 4613.02, secondaryId: "<id>", - documentId: 8230.22, - templateId: 8882.43, - recipientId: 3502.76, - page: 3136.7, + documentId: 7119.93, + templateId: 4421.64, + recipientId: 6877.53, + page: 5376.58, customText: "<value>", inserted: false, fieldMeta: { - type: "date", + type: "checkbox", }, }, ], }, - uploadUrl: "https://scented-hutch.net/", + uploadUrl: "https://cultivated-ethyl.com", }; ``` diff --git a/docs/models/operations/documentfinddocumentsdata.md b/docs/models/operations/documentfinddocumentsdata.md index 59cf4191..29e74a37 100644 --- a/docs/models/operations/documentfinddocumentsdata.md +++ b/docs/models/operations/documentfinddocumentsdata.md @@ -21,12 +21,14 @@ let value: DocumentFindDocumentsData = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1714411546378", - updatedAt: "1743987562539", + createdAt: "1716830819301", + updatedAt: "1746406835462", completedAt: "<value>", deletedAt: "<value>", teamId: 9009.09, templateId: 7399.64, + folderId: "<id>", + useLegacyFieldInsertion: false, user: { id: 7230.88, name: "<value>", @@ -82,6 +84,8 @@ let value: DocumentFindDocumentsData = { | `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 | | `user` | [operations.DocumentFindDocumentsUser](../../models/operations/documentfinddocumentsuser.md) | :heavy_check_mark: | N/A | | `recipients` | [operations.DocumentFindDocumentsRecipient](../../models/operations/documentfinddocumentsrecipient.md)[] | :heavy_check_mark: | N/A | | `team` | [operations.DocumentFindDocumentsTeam](../../models/operations/documentfinddocumentsteam.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentfinddocumentsrequest.md b/docs/models/operations/documentfinddocumentsrequest.md index 45678194..5b1ff7e7 100644 --- a/docs/models/operations/documentfinddocumentsrequest.md +++ b/docs/models/operations/documentfinddocumentsrequest.md @@ -18,5 +18,6 @@ let value: DocumentFindDocumentsRequest = {}; | `templateId` | *number* | :heavy_minus_sign: | Filter documents by the template ID used to create it. | | `source` | [operations.QueryParamSource](../../models/operations/queryparamsource.md) | :heavy_minus_sign: | Filter documents by how it was created. | | `status` | [operations.QueryParamStatus](../../models/operations/queryparamstatus.md) | :heavy_minus_sign: | Filter documents by the current status | +| `folderId` | *string* | :heavy_minus_sign: | Filter documents by folder ID | | `orderByColumn` | [operations.OrderByColumn](../../models/operations/orderbycolumn.md) | :heavy_minus_sign: | N/A | | `orderByDirection` | [operations.OrderByDirection](../../models/operations/orderbydirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentfinddocumentsresponse.md b/docs/models/operations/documentfinddocumentsresponse.md index 500cd74b..703e25ec 100644 --- a/docs/models/operations/documentfinddocumentsresponse.md +++ b/docs/models/operations/documentfinddocumentsresponse.md @@ -25,12 +25,14 @@ let value: DocumentFindDocumentsResponse = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1724665271177", - updatedAt: "1743997384880", + createdAt: "1727084536512", + updatedAt: "1746416650214", completedAt: "<value>", deletedAt: "<value>", teamId: 805.69, templateId: 4467.97, + folderId: "<id>", + useLegacyFieldInsertion: false, user: { id: 4334.93, name: "<value>", diff --git a/docs/models/operations/documentfoldertype.md b/docs/models/operations/documentfoldertype.md new file mode 100644 index 00000000..b1343835 --- /dev/null +++ b/docs/models/operations/documentfoldertype.md @@ -0,0 +1,15 @@ +# DocumentFolderType + +## Example Usage + +```typescript +import { DocumentFolderType } from "@documenso/sdk-typescript/models/operations"; + +let value: DocumentFolderType = "TEMPLATE"; +``` + +## Values + +```typescript +"DOCUMENT" | "TEMPLATE" +``` \ No newline at end of file diff --git a/docs/models/operations/documentfoldervisibility.md b/docs/models/operations/documentfoldervisibility.md new file mode 100644 index 00000000..a3c3dfee --- /dev/null +++ b/docs/models/operations/documentfoldervisibility.md @@ -0,0 +1,15 @@ +# DocumentFolderVisibility + +## Example Usage + +```typescript +import { DocumentFolderVisibility } from "@documenso/sdk-typescript/models/operations"; + +let value: DocumentFolderVisibility = "MANAGER_AND_ABOVE"; +``` + +## Values + +```typescript +"EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN" +``` \ No newline at end of file diff --git a/docs/models/operations/documentgetdocumentwithdetailsbyidfolder.md b/docs/models/operations/documentgetdocumentwithdetailsbyidfolder.md new file mode 100644 index 00000000..5e8ee4cd --- /dev/null +++ b/docs/models/operations/documentgetdocumentwithdetailsbyidfolder.md @@ -0,0 +1,35 @@ +# DocumentGetDocumentWithDetailsByIdFolder + +## Example Usage + +```typescript +import { DocumentGetDocumentWithDetailsByIdFolder } from "@documenso/sdk-typescript/models/operations"; + +let value: DocumentGetDocumentWithDetailsByIdFolder = { + id: "<id>", + name: "<value>", + type: "TEMPLATE", + visibility: "MANAGER_AND_ABOVE", + userId: 6943.14, + teamId: 4294.58, + pinned: false, + parentId: "<id>", + createdAt: "1734401625491", + updatedAt: "1746408819310", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | +| `type` | [operations.DocumentGetDocumentWithDetailsByIdFolderType](../../models/operations/documentgetdocumentwithdetailsbyidfoldertype.md) | :heavy_check_mark: | N/A | +| `visibility` | [operations.DocumentGetDocumentWithDetailsByIdFolderVisibility](../../models/operations/documentgetdocumentwithdetailsbyidfoldervisibility.md) | :heavy_check_mark: | N/A | +| `userId` | *number* | :heavy_check_mark: | N/A | +| `teamId` | *number* | :heavy_check_mark: | N/A | +| `pinned` | *boolean* | :heavy_check_mark: | N/A | +| `parentId` | *string* | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentgetdocumentwithdetailsbyidfoldertype.md b/docs/models/operations/documentgetdocumentwithdetailsbyidfoldertype.md new file mode 100644 index 00000000..4f7429f8 --- /dev/null +++ b/docs/models/operations/documentgetdocumentwithdetailsbyidfoldertype.md @@ -0,0 +1,15 @@ +# DocumentGetDocumentWithDetailsByIdFolderType + +## Example Usage + +```typescript +import { DocumentGetDocumentWithDetailsByIdFolderType } from "@documenso/sdk-typescript/models/operations"; + +let value: DocumentGetDocumentWithDetailsByIdFolderType = "DOCUMENT"; +``` + +## Values + +```typescript +"DOCUMENT" | "TEMPLATE" +``` \ No newline at end of file diff --git a/docs/models/operations/documentgetdocumentwithdetailsbyidfoldervisibility.md b/docs/models/operations/documentgetdocumentwithdetailsbyidfoldervisibility.md new file mode 100644 index 00000000..208c6a33 --- /dev/null +++ b/docs/models/operations/documentgetdocumentwithdetailsbyidfoldervisibility.md @@ -0,0 +1,15 @@ +# DocumentGetDocumentWithDetailsByIdFolderVisibility + +## Example Usage + +```typescript +import { DocumentGetDocumentWithDetailsByIdFolderVisibility } from "@documenso/sdk-typescript/models/operations"; + +let value: DocumentGetDocumentWithDetailsByIdFolderVisibility = "ADMIN"; +``` + +## Values + +```typescript +"EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN" +``` \ No newline at end of file diff --git a/docs/models/operations/documentgetdocumentwithdetailsbyidrequest.md b/docs/models/operations/documentgetdocumentwithdetailsbyidrequest.md index 64f1b3cd..b0d8a3c1 100644 --- a/docs/models/operations/documentgetdocumentwithdetailsbyidrequest.md +++ b/docs/models/operations/documentgetdocumentwithdetailsbyidrequest.md @@ -12,6 +12,7 @@ let value: DocumentGetDocumentWithDetailsByIdRequest = { ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `documentId` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | +| `documentId` | *number* | :heavy_check_mark: | N/A | +| `folderId` | *string* | :heavy_minus_sign: | Filter documents by folder ID | \ No newline at end of file diff --git a/docs/models/operations/documentgetdocumentwithdetailsbyidresponse.md b/docs/models/operations/documentgetdocumentwithdetailsbyidresponse.md index 9ec52cbb..203fc26f 100644 --- a/docs/models/operations/documentgetdocumentwithdetailsbyidresponse.md +++ b/docs/models/operations/documentgetdocumentwithdetailsbyidresponse.md @@ -23,12 +23,13 @@ let value: DocumentGetDocumentWithDetailsByIdResponse = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1715425741269", - updatedAt: "1744043002525", + createdAt: "1717845017740", + updatedAt: "1746462278996", completedAt: "<value>", deletedAt: "<value>", teamId: 9273.9, templateId: 5066.42, + folderId: "<id>", documentData: { type: "BYTES_64", id: "<id>", @@ -53,16 +54,28 @@ let value: DocumentGetDocumentWithDetailsByIdResponse = { language: "<value>", emailSettings: {}, }, + folder: { + id: "<id>", + name: "<value>", + type: "DOCUMENT", + visibility: "EVERYONE", + userId: 5355.66, + teamId: 6741.58, + pinned: false, + parentId: "<id>", + createdAt: "1737867911681", + updatedAt: "1746461808267", + }, recipients: [ { role: "CC", readStatus: "NOT_OPENED", - signingStatus: "SIGNED", + signingStatus: "REJECTED", sendStatus: "SENT", - id: 7265.62, - documentId: 6614.32, - templateId: 1154.9, - email: "Richard.Funk79@yahoo.com", + id: 2543.79, + documentId: 2369.53, + templateId: 7924.01, + email: "Chaim_Osinski53@gmail.com", name: "<value>", token: "<value>", documentDeletedAt: "<value>", @@ -70,25 +83,25 @@ let value: DocumentGetDocumentWithDetailsByIdResponse = { signedAt: "<value>", authOptions: { accessAuth: "ACCOUNT", - actionAuth: "ACCOUNT", + actionAuth: "PASSKEY", }, - signingOrder: 6847.27, + signingOrder: 2543.41, rejectionReason: "<value>", }, ], fields: [ { - type: "NUMBER", - id: 7186.6, + type: "INITIALS", + id: 1300.13, secondaryId: "<id>", - documentId: 5366.86, - templateId: 1978.18, - recipientId: 4691.92, - page: 2543.41, + documentId: 4684.8, + templateId: 4402.15, + recipientId: 3392.74, + page: 7032.91, customText: "<value>", inserted: false, fieldMeta: { - type: "name", + type: "radio", }, }, ], @@ -115,7 +128,9 @@ let value: DocumentGetDocumentWithDetailsByIdResponse = { | `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 | | `documentData` | [operations.DocumentGetDocumentWithDetailsByIdDocumentData](../../models/operations/documentgetdocumentwithdetailsbyiddocumentdata.md) | :heavy_check_mark: | N/A | | `documentMeta` | [operations.DocumentGetDocumentWithDetailsByIdDocumentMeta](../../models/operations/documentgetdocumentwithdetailsbyiddocumentmeta.md) | :heavy_check_mark: | N/A | +| `folder` | [operations.DocumentGetDocumentWithDetailsByIdFolder](../../models/operations/documentgetdocumentwithdetailsbyidfolder.md) | :heavy_check_mark: | N/A | | `recipients` | [operations.DocumentGetDocumentWithDetailsByIdRecipient](../../models/operations/documentgetdocumentwithdetailsbyidrecipient.md)[] | :heavy_check_mark: | N/A | | `fields` | [operations.DocumentGetDocumentWithDetailsByIdField](../../models/operations/documentgetdocumentwithdetailsbyidfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentmovedocumenttoteamresponse.md b/docs/models/operations/documentmovedocumenttoteamresponse.md index 9114351b..ab755892 100644 --- a/docs/models/operations/documentmovedocumenttoteamresponse.md +++ b/docs/models/operations/documentmovedocumenttoteamresponse.md @@ -23,12 +23,14 @@ let value: DocumentMoveDocumentToTeamResponse = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1714360484976", - updatedAt: "1744041325995", + createdAt: "1716779767501", + updatedAt: "1746460608520", completedAt: "<value>", deletedAt: "<value>", teamId: 8022.32, templateId: 5805.01, + folderId: "<id>", + useLegacyFieldInsertion: false, }; ``` @@ -51,4 +53,6 @@ let value: DocumentMoveDocumentToTeamResponse = { | `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 | \ No newline at end of file +| `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 diff --git a/docs/models/operations/documentsenddocumentresponse.md b/docs/models/operations/documentsenddocumentresponse.md index 2ba58ad0..68e76c26 100644 --- a/docs/models/operations/documentsenddocumentresponse.md +++ b/docs/models/operations/documentsenddocumentresponse.md @@ -23,12 +23,14 @@ let value: DocumentSendDocumentResponse = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1731473538977", - updatedAt: "1743990348429", + createdAt: "1733892820290", + updatedAt: "1746409629742", completedAt: "<value>", deletedAt: "<value>", teamId: 9044.23, templateId: 7809.65, + folderId: "<id>", + useLegacyFieldInsertion: false, }; ``` @@ -51,4 +53,6 @@ let value: DocumentSendDocumentResponse = { | `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 | \ No newline at end of file +| `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 diff --git a/docs/models/operations/documentupdatedocumentdata.md b/docs/models/operations/documentupdatedocumentdata.md index de044c45..03c5ded4 100644 --- a/docs/models/operations/documentupdatedocumentdata.md +++ b/docs/models/operations/documentupdatedocumentdata.md @@ -16,4 +16,5 @@ let value: DocumentUpdateDocumentData = {}; | `externalId` | *string* | :heavy_minus_sign: | The external ID of the document. | | `visibility` | [operations.DocumentUpdateDocumentVisibilityRequestBody](../../models/operations/documentupdatedocumentvisibilityrequestbody.md) | :heavy_minus_sign: | The visibility of the document. | | `globalAccessAuth` | [operations.DocumentUpdateDocumentGlobalAccessAuthRequestBody](../../models/operations/documentupdatedocumentglobalaccessauthrequestbody.md) | :heavy_minus_sign: | The type of authentication required for the recipient to access the document. | -| `globalActionAuth` | [operations.DocumentUpdateDocumentGlobalActionAuthRequestBody](../../models/operations/documentupdatedocumentglobalactionauthrequestbody.md) | :heavy_minus_sign: | The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. | \ No newline at end of file +| `globalActionAuth` | [operations.DocumentUpdateDocumentGlobalActionAuthRequestBody](../../models/operations/documentupdatedocumentglobalactionauthrequestbody.md) | :heavy_minus_sign: | The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. | +| `useLegacyFieldInsertion` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/documentupdatedocumentresponse.md b/docs/models/operations/documentupdatedocumentresponse.md index 2b13de24..3ef5ccc9 100644 --- a/docs/models/operations/documentupdatedocumentresponse.md +++ b/docs/models/operations/documentupdatedocumentresponse.md @@ -23,12 +23,14 @@ let value: DocumentUpdateDocumentResponse = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1719529127846", - updatedAt: "1744046959438", + createdAt: "1721948415779", + updatedAt: "1746466247371", completedAt: "<value>", deletedAt: "<value>", teamId: 8913.64, templateId: 9922.73, + folderId: "<id>", + useLegacyFieldInsertion: false, }; ``` @@ -51,4 +53,6 @@ let value: DocumentUpdateDocumentResponse = { | `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 | \ No newline at end of file +| `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 diff --git a/docs/models/operations/embeddingpresigncreateembeddingpresigntokenrequest.md b/docs/models/operations/embeddingpresigncreateembeddingpresigntokenrequest.md new file mode 100644 index 00000000..2525fe28 --- /dev/null +++ b/docs/models/operations/embeddingpresigncreateembeddingpresigntokenrequest.md @@ -0,0 +1,15 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenRequest + +## Example Usage + +```typescript +import { EmbeddingPresignCreateEmbeddingPresignTokenRequest } from "@documenso/sdk-typescript/models/operations"; + +let value: EmbeddingPresignCreateEmbeddingPresignTokenRequest = {}; +``` + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `expiresIn` | *number* | :heavy_minus_sign: | Expiration time in minutes (default: 60, max: 10,080) | \ No newline at end of file diff --git a/docs/models/operations/embeddingpresigncreateembeddingpresigntokenresponse.md b/docs/models/operations/embeddingpresigncreateembeddingpresigntokenresponse.md new file mode 100644 index 00000000..58bdb6e7 --- /dev/null +++ b/docs/models/operations/embeddingpresigncreateembeddingpresigntokenresponse.md @@ -0,0 +1,23 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenResponse + +Successful response + +## Example Usage + +```typescript +import { EmbeddingPresignCreateEmbeddingPresignTokenResponse } from "@documenso/sdk-typescript/models/operations"; + +let value: EmbeddingPresignCreateEmbeddingPresignTokenResponse = { + token: "<value>", + expiresAt: "1753273046713", + expiresIn: 3281.87, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| -------------------------- | -------------------------- | -------------------------- | -------------------------- | +| `token` | *string* | :heavy_check_mark: | N/A | +| `expiresAt` | *string* | :heavy_check_mark: | N/A | +| `expiresIn` | *number* | :heavy_check_mark: | Expiration time in seconds | \ No newline at end of file diff --git a/docs/models/operations/embeddingpresignverifyembeddingpresigntokenrequest.md b/docs/models/operations/embeddingpresignverifyembeddingpresigntokenrequest.md new file mode 100644 index 00000000..86643d71 --- /dev/null +++ b/docs/models/operations/embeddingpresignverifyembeddingpresigntokenrequest.md @@ -0,0 +1,17 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenRequest + +## Example Usage + +```typescript +import { EmbeddingPresignVerifyEmbeddingPresignTokenRequest } from "@documenso/sdk-typescript/models/operations"; + +let value: EmbeddingPresignVerifyEmbeddingPresignTokenRequest = { + token: "<value>", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `token` | *string* | :heavy_check_mark: | The presign token to verify | \ No newline at end of file diff --git a/docs/models/operations/embeddingpresignverifyembeddingpresigntokenresponse.md b/docs/models/operations/embeddingpresignverifyembeddingpresigntokenresponse.md new file mode 100644 index 00000000..f83224b1 --- /dev/null +++ b/docs/models/operations/embeddingpresignverifyembeddingpresigntokenresponse.md @@ -0,0 +1,19 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenResponse + +Successful response + +## Example Usage + +```typescript +import { EmbeddingPresignVerifyEmbeddingPresignTokenResponse } from "@documenso/sdk-typescript/models/operations"; + +let value: EmbeddingPresignVerifyEmbeddingPresignTokenResponse = { + success: false, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplatefolder.md b/docs/models/operations/templatecreatedocumentfromtemplatefolder.md new file mode 100644 index 00000000..7ca1add6 --- /dev/null +++ b/docs/models/operations/templatecreatedocumentfromtemplatefolder.md @@ -0,0 +1,35 @@ +# TemplateCreateDocumentFromTemplateFolder + +## Example Usage + +```typescript +import { TemplateCreateDocumentFromTemplateFolder } from "@documenso/sdk-typescript/models/operations"; + +let value: TemplateCreateDocumentFromTemplateFolder = { + id: "<id>", + name: "<value>", + type: "DOCUMENT", + visibility: "MANAGER_AND_ABOVE", + userId: 2075.93, + teamId: 5225.47, + pinned: false, + parentId: "<id>", + createdAt: "1721649041969", + updatedAt: "1746475575085", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | +| `type` | [operations.TemplateCreateDocumentFromTemplateFolderType](../../models/operations/templatecreatedocumentfromtemplatefoldertype.md) | :heavy_check_mark: | N/A | +| `visibility` | [operations.TemplateCreateDocumentFromTemplateFolderVisibility](../../models/operations/templatecreatedocumentfromtemplatefoldervisibility.md) | :heavy_check_mark: | N/A | +| `userId` | *number* | :heavy_check_mark: | N/A | +| `teamId` | *number* | :heavy_check_mark: | N/A | +| `pinned` | *boolean* | :heavy_check_mark: | N/A | +| `parentId` | *string* | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplatefoldertype.md b/docs/models/operations/templatecreatedocumentfromtemplatefoldertype.md new file mode 100644 index 00000000..78e19aa0 --- /dev/null +++ b/docs/models/operations/templatecreatedocumentfromtemplatefoldertype.md @@ -0,0 +1,15 @@ +# TemplateCreateDocumentFromTemplateFolderType + +## Example Usage + +```typescript +import { TemplateCreateDocumentFromTemplateFolderType } from "@documenso/sdk-typescript/models/operations"; + +let value: TemplateCreateDocumentFromTemplateFolderType = "TEMPLATE"; +``` + +## Values + +```typescript +"DOCUMENT" | "TEMPLATE" +``` \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplatefoldervisibility.md b/docs/models/operations/templatecreatedocumentfromtemplatefoldervisibility.md new file mode 100644 index 00000000..5075f21e --- /dev/null +++ b/docs/models/operations/templatecreatedocumentfromtemplatefoldervisibility.md @@ -0,0 +1,15 @@ +# TemplateCreateDocumentFromTemplateFolderVisibility + +## Example Usage + +```typescript +import { TemplateCreateDocumentFromTemplateFolderVisibility } from "@documenso/sdk-typescript/models/operations"; + +let value: TemplateCreateDocumentFromTemplateFolderVisibility = "EVERYONE"; +``` + +## Values + +```typescript +"EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN" +``` \ No newline at end of file diff --git a/docs/models/operations/templatecreatedocumentfromtemplateresponse.md b/docs/models/operations/templatecreatedocumentfromtemplateresponse.md index 55b249a2..62884784 100644 --- a/docs/models/operations/templatecreatedocumentfromtemplateresponse.md +++ b/docs/models/operations/templatecreatedocumentfromtemplateresponse.md @@ -23,12 +23,13 @@ let value: TemplateCreateDocumentFromTemplateResponse = { }, title: "<value>", documentDataId: "<id>", - createdAt: "1720708933109", - updatedAt: "1744013322859", + createdAt: "1723128213185", + updatedAt: "1746432602935", completedAt: "<value>", deletedAt: "<value>", teamId: 6974.94, templateId: 5501.18, + folderId: "<id>", documentData: { type: "BYTES", id: "<id>", @@ -53,16 +54,28 @@ let value: TemplateCreateDocumentFromTemplateResponse = { language: "<value>", emailSettings: {}, }, + folder: { + id: "<id>", + name: "<value>", + type: "DOCUMENT", + visibility: "EVERYONE", + userId: 8399.16, + teamId: 1830.45, + pinned: false, + parentId: "<id>", + createdAt: "1741834771377", + updatedAt: "1746433781810", + }, recipients: [ { - role: "SIGNER", - readStatus: "NOT_OPENED", - signingStatus: "REJECTED", - sendStatus: "NOT_SENT", - id: 8523.5, - documentId: 3370.18, - templateId: 1656.46, - email: "Gertrude.Predovic36@hotmail.com", + role: "CC", + readStatus: "OPENED", + signingStatus: "SIGNED", + sendStatus: "SENT", + id: 6966.32, + documentId: 998.89, + templateId: 3657.29, + email: "Lucious12@gmail.com", name: "<value>", token: "<value>", documentDeletedAt: "<value>", @@ -72,23 +85,23 @@ let value: TemplateCreateDocumentFromTemplateResponse = { accessAuth: "ACCOUNT", actionAuth: "TWO_FACTOR_AUTH", }, - signingOrder: 1738.36, + signingOrder: 9047.93, rejectionReason: "<value>", }, ], fields: [ { - type: "EMAIL", - id: 4250.91, + type: "SIGNATURE", + id: 9182, secondaryId: "<id>", - documentId: 1267.64, - templateId: 6947.19, - recipientId: 6892.94, - page: 9047.93, + documentId: 1734.62, + templateId: 9371.19, + recipientId: 2023.49, + page: 4830.31, customText: "<value>", inserted: false, fieldMeta: { - type: "initials", + type: "date", }, }, ], @@ -115,7 +128,9 @@ let value: TemplateCreateDocumentFromTemplateResponse = { | `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 | | `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 | | `recipients` | [operations.TemplateCreateDocumentFromTemplateRecipientResponse](../../models/operations/templatecreatedocumentfromtemplaterecipientresponse.md)[] | :heavy_check_mark: | N/A | | `fields` | [operations.TemplateCreateDocumentFromTemplateField](../../models/operations/templatecreatedocumentfromtemplatefield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatecreatetemplatedirectlinkresponse.md b/docs/models/operations/templatecreatetemplatedirectlinkresponse.md index f2a1673f..b1b48ee8 100644 --- a/docs/models/operations/templatecreatetemplatedirectlinkresponse.md +++ b/docs/models/operations/templatecreatetemplatedirectlinkresponse.md @@ -11,7 +11,7 @@ let value: TemplateCreateTemplateDirectLinkResponse = { id: "<id>", templateId: 6033.47, token: "<value>", - createdAt: "1730787513148", + createdAt: "1733206796773", enabled: false, directTemplateRecipientId: 5620.96, }; diff --git a/docs/models/operations/templateduplicatetemplateresponse.md b/docs/models/operations/templateduplicatetemplateresponse.md index 07942261..8520d8b1 100644 --- a/docs/models/operations/templateduplicatetemplateresponse.md +++ b/docs/models/operations/templateduplicatetemplateresponse.md @@ -20,10 +20,12 @@ let value: TemplateDuplicateTemplateResponse = { globalActionAuth: "TWO_FACTOR_AUTH", }, templateDocumentDataId: "<id>", - createdAt: "1733247137200", - updatedAt: "1743997265173", + createdAt: "1735666408255", + updatedAt: "1746416536229", publicTitle: "<value>", publicDescription: "<value>", + folderId: "<id>", + useLegacyFieldInsertion: false, }; ``` @@ -43,4 +45,6 @@ let value: TemplateDuplicateTemplateResponse = { | `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 | \ No newline at end of file +| `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 diff --git a/docs/models/operations/templatefindtemplatesdata.md b/docs/models/operations/templatefindtemplatesdata.md index ed40ec0b..c9521f2e 100644 --- a/docs/models/operations/templatefindtemplatesdata.md +++ b/docs/models/operations/templatefindtemplatesdata.md @@ -18,10 +18,12 @@ let value: TemplateFindTemplatesData = { globalActionAuth: "PASSKEY", }, templateDocumentDataId: "<id>", - createdAt: "1714073444849", - updatedAt: "1744010024842", + createdAt: "1716492728155", + updatedAt: "1746429308148", publicTitle: "<value>", publicDescription: "<value>", + folderId: "<id>", + useLegacyFieldInsertion: false, team: { id: 8235.06, url: "https://powerful-shadowbox.biz", @@ -93,6 +95,8 @@ let value: TemplateFindTemplatesData = { | `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 | | `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 | diff --git a/docs/models/operations/templatefindtemplatesrequest.md b/docs/models/operations/templatefindtemplatesrequest.md index ef5fd360..43f3d654 100644 --- a/docs/models/operations/templatefindtemplatesrequest.md +++ b/docs/models/operations/templatefindtemplatesrequest.md @@ -15,4 +15,5 @@ let value: TemplateFindTemplatesRequest = {}; | `query` | *string* | :heavy_minus_sign: | The search query. | | `page` | *number* | :heavy_minus_sign: | The pagination page number, starts at 1. | | `perPage` | *number* | :heavy_minus_sign: | The number of items per page. | -| `type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_minus_sign: | Filter templates by type. | \ No newline at end of file +| `type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_minus_sign: | Filter templates by type. | +| `folderId` | *string* | :heavy_minus_sign: | The ID of the folder to filter templates by. | \ No newline at end of file diff --git a/docs/models/operations/templatefindtemplatesresponse.md b/docs/models/operations/templatefindtemplatesresponse.md index 1be69b1b..ad1a850a 100644 --- a/docs/models/operations/templatefindtemplatesresponse.md +++ b/docs/models/operations/templatefindtemplatesresponse.md @@ -22,10 +22,12 @@ let value: TemplateFindTemplatesResponse = { globalActionAuth: "PASSKEY", }, templateDocumentDataId: "<id>", - createdAt: "1736152151746", - updatedAt: "1744012627265", + createdAt: "1738571426089", + updatedAt: "1746431901608", publicTitle: "<value>", publicDescription: "<value>", + folderId: "<id>", + useLegacyFieldInsertion: false, team: { id: 9469.38, url: "https://outgoing-ethyl.com/", diff --git a/docs/models/operations/templategettemplatebyiddirectlink.md b/docs/models/operations/templategettemplatebyiddirectlink.md index b0beaebf..65b876c0 100644 --- a/docs/models/operations/templategettemplatebyiddirectlink.md +++ b/docs/models/operations/templategettemplatebyiddirectlink.md @@ -9,7 +9,7 @@ let value: TemplateGetTemplateByIdDirectLink = { id: "<id>", templateId: 4516.97, token: "<value>", - createdAt: "1723784685511", + createdAt: "1726203958041", enabled: false, directTemplateRecipientId: 3461.72, }; diff --git a/docs/models/operations/templategettemplatebyidfolder.md b/docs/models/operations/templategettemplatebyidfolder.md new file mode 100644 index 00000000..7ee36bca --- /dev/null +++ b/docs/models/operations/templategettemplatebyidfolder.md @@ -0,0 +1,35 @@ +# TemplateGetTemplateByIdFolder + +## Example Usage + +```typescript +import { TemplateGetTemplateByIdFolder } from "@documenso/sdk-typescript/models/operations"; + +let value: TemplateGetTemplateByIdFolder = { + id: "<id>", + name: "<value>", + type: "DOCUMENT", + visibility: "MANAGER_AND_ABOVE", + userId: 3966.65, + teamId: 6108.7, + pinned: false, + parentId: "<id>", + createdAt: "1719075720557", + updatedAt: "1746467176226", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `id` | *string* | :heavy_check_mark: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | +| `type` | [operations.TemplateGetTemplateByIdFolderType](../../models/operations/templategettemplatebyidfoldertype.md) | :heavy_check_mark: | N/A | +| `visibility` | [operations.TemplateGetTemplateByIdFolderVisibility](../../models/operations/templategettemplatebyidfoldervisibility.md) | :heavy_check_mark: | N/A | +| `userId` | *number* | :heavy_check_mark: | N/A | +| `teamId` | *number* | :heavy_check_mark: | N/A | +| `pinned` | *boolean* | :heavy_check_mark: | N/A | +| `parentId` | *string* | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyidfoldertype.md b/docs/models/operations/templategettemplatebyidfoldertype.md new file mode 100644 index 00000000..a38f2fc7 --- /dev/null +++ b/docs/models/operations/templategettemplatebyidfoldertype.md @@ -0,0 +1,15 @@ +# TemplateGetTemplateByIdFolderType + +## Example Usage + +```typescript +import { TemplateGetTemplateByIdFolderType } from "@documenso/sdk-typescript/models/operations"; + +let value: TemplateGetTemplateByIdFolderType = "TEMPLATE"; +``` + +## Values + +```typescript +"DOCUMENT" | "TEMPLATE" +``` \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyidfoldervisibility.md b/docs/models/operations/templategettemplatebyidfoldervisibility.md new file mode 100644 index 00000000..bd27a5c9 --- /dev/null +++ b/docs/models/operations/templategettemplatebyidfoldervisibility.md @@ -0,0 +1,15 @@ +# TemplateGetTemplateByIdFolderVisibility + +## Example Usage + +```typescript +import { TemplateGetTemplateByIdFolderVisibility } from "@documenso/sdk-typescript/models/operations"; + +let value: TemplateGetTemplateByIdFolderVisibility = "EVERYONE"; +``` + +## Values + +```typescript +"EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN" +``` \ No newline at end of file diff --git a/docs/models/operations/templategettemplatebyidresponse.md b/docs/models/operations/templategettemplatebyidresponse.md index 93f2b70f..e82d6d6d 100644 --- a/docs/models/operations/templategettemplatebyidresponse.md +++ b/docs/models/operations/templategettemplatebyidresponse.md @@ -20,10 +20,11 @@ let value: TemplateGetTemplateByIdResponse = { globalActionAuth: "PASSKEY", }, templateDocumentDataId: "<id>", - createdAt: "1730997561685", - updatedAt: "1744069972056", + createdAt: "1733416837729", + updatedAt: "1746489248100", publicTitle: "<value>", publicDescription: "<value>", + folderId: "<id>", templateDocumentData: { type: "BYTES", id: "<id>", @@ -51,7 +52,7 @@ let value: TemplateGetTemplateByIdResponse = { id: "<id>", templateId: 6831.82, token: "<value>", - createdAt: "1725890596089", + createdAt: "1728309872132", enabled: false, directTemplateRecipientId: 5013.71, }, @@ -99,6 +100,18 @@ let value: TemplateGetTemplateByIdResponse = { }, }, ], + folder: { + id: "<id>", + name: "<value>", + type: "TEMPLATE", + visibility: "ADMIN", + userId: 8719, + teamId: 3527.26, + pinned: false, + parentId: "<id>", + createdAt: "1739725065955", + updatedAt: "1746426981079", + }, }; ``` @@ -119,9 +132,11 @@ let value: TemplateGetTemplateByIdResponse = { | `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 | | `templateDocumentData` | [operations.TemplateDocumentData](../../models/operations/templatedocumentdata.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 | | `user` | [operations.TemplateGetTemplateByIdUser](../../models/operations/templategettemplatebyiduser.md) | :heavy_check_mark: | N/A | | `recipients` | [operations.TemplateGetTemplateByIdRecipient](../../models/operations/templategettemplatebyidrecipient.md)[] | :heavy_check_mark: | N/A | -| `fields` | [operations.TemplateGetTemplateByIdField](../../models/operations/templategettemplatebyidfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [operations.TemplateGetTemplateByIdField](../../models/operations/templategettemplatebyidfield.md)[] | :heavy_check_mark: | N/A | +| `folder` | [operations.TemplateGetTemplateByIdFolder](../../models/operations/templategettemplatebyidfolder.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/templatemovetemplatetoteamresponse.md b/docs/models/operations/templatemovetemplatetoteamresponse.md index d7a997c1..7db318dd 100644 --- a/docs/models/operations/templatemovetemplatetoteamresponse.md +++ b/docs/models/operations/templatemovetemplatetoteamresponse.md @@ -20,10 +20,12 @@ let value: TemplateMoveTemplateToTeamResponse = { globalActionAuth: "ACCOUNT", }, templateDocumentDataId: "<id>", - createdAt: "1723770518827", - updatedAt: "1743987341155", + createdAt: "1726189797105", + updatedAt: "1746406619433", publicTitle: "<value>", publicDescription: "<value>", + folderId: "<id>", + useLegacyFieldInsertion: false, }; ``` @@ -43,4 +45,6 @@ let value: TemplateMoveTemplateToTeamResponse = { | `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 | \ No newline at end of file +| `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 diff --git a/docs/models/operations/templatetoggletemplatedirectlinkresponse.md b/docs/models/operations/templatetoggletemplatedirectlinkresponse.md index 0847b252..09aa5ed7 100644 --- a/docs/models/operations/templatetoggletemplatedirectlinkresponse.md +++ b/docs/models/operations/templatetoggletemplatedirectlinkresponse.md @@ -11,7 +11,7 @@ let value: TemplateToggleTemplateDirectLinkResponse = { id: "<id>", templateId: 2293.94, token: "<value>", - createdAt: "1713626784257", + createdAt: "1716046076516", enabled: false, directTemplateRecipientId: 8974.33, }; diff --git a/docs/models/operations/templateupdatetemplatedata.md b/docs/models/operations/templateupdatetemplatedata.md index 014b751e..4a6099ee 100644 --- a/docs/models/operations/templateupdatetemplatedata.md +++ b/docs/models/operations/templateupdatetemplatedata.md @@ -19,4 +19,5 @@ let value: TemplateUpdateTemplateData = {}; | `globalActionAuth` | [operations.TemplateUpdateTemplateGlobalActionAuthRequestBody](../../models/operations/templateupdatetemplateglobalactionauthrequestbody.md) | :heavy_minus_sign: | The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. | | `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 | \ No newline at end of file +| `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 diff --git a/docs/models/operations/templateupdatetemplateresponse.md b/docs/models/operations/templateupdatetemplateresponse.md index b591e9dc..04310144 100644 --- a/docs/models/operations/templateupdatetemplateresponse.md +++ b/docs/models/operations/templateupdatetemplateresponse.md @@ -20,10 +20,12 @@ let value: TemplateUpdateTemplateResponse = { globalActionAuth: "TWO_FACTOR_AUTH", }, templateDocumentDataId: "<id>", - createdAt: "1713372499431", - updatedAt: "1744021610314", + createdAt: "1715791776267", + updatedAt: "1746440887150", publicTitle: "<value>", publicDescription: "<value>", + folderId: "<id>", + useLegacyFieldInsertion: false, }; ``` @@ -43,4 +45,6 @@ let value: TemplateUpdateTemplateResponse = { | `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 | \ No newline at end of file +| `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 diff --git a/docs/sdks/documents/README.md b/docs/sdks/documents/README.md index 79623d75..253b9b67 100644 --- a/docs/sdks/documents/README.md +++ b/docs/sdks/documents/README.md @@ -577,9 +577,7 @@ const documenso = new Documenso({ async function run() { const result = await documenso.documents.redistribute({ documentId: 5758.65, - recipients: [ - - ], + recipients: [], }); // Handle the result @@ -606,9 +604,7 @@ const documenso = new DocumensoCore({ async function run() { const res = await documentsRedistribute(documenso, { documentId: 5758.65, - recipients: [ - - ], + recipients: [], }); if (!res.ok) { diff --git a/docs/sdks/embedding/README.md b/docs/sdks/embedding/README.md new file mode 100644 index 00000000..af0566f6 --- /dev/null +++ b/docs/sdks/embedding/README.md @@ -0,0 +1,161 @@ +# Embedding +(*embedding*) + +## Overview + +### Available Operations + +* [embeddingPresignCreateEmbeddingPresignToken](#embeddingpresigncreateembeddingpresigntoken) - Create embedding presign token +* [embeddingPresignVerifyEmbeddingPresignToken](#embeddingpresignverifyembeddingpresigntoken) - Verify embedding presign token + +## embeddingPresignCreateEmbeddingPresignToken + +Creates a presign token for embedding operations with configurable expiration time + +### Example Usage + +```typescript +import { Documenso } from "@documenso/sdk-typescript"; + +const documenso = new Documenso({ + apiKey: process.env["DOCUMENSO_API_KEY"] ?? "", +}); + +async function run() { + const result = await documenso.embedding.embeddingPresignCreateEmbeddingPresignToken({}); + + // Handle the result + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { DocumensoCore } from "@documenso/sdk-typescript/core.js"; +import { embeddingEmbeddingPresignCreateEmbeddingPresignToken } from "@documenso/sdk-typescript/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.js"; + +// Use `DocumensoCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const documenso = new DocumensoCore({ + apiKey: process.env["DOCUMENSO_API_KEY"] ?? "", +}); + +async function run() { + const res = await embeddingEmbeddingPresignCreateEmbeddingPresignToken(documenso, {}); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result); +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.EmbeddingPresignCreateEmbeddingPresignTokenRequest](../../models/operations/embeddingpresigncreateembeddingpresigntokenrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.EmbeddingPresignCreateEmbeddingPresignTokenResponse](../../models/operations/embeddingpresigncreateembeddingpresigntokenresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| errors.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError | 400 | application/json | +| errors.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError | 500 | application/json | +| errors.APIError | 4XX, 5XX | \*/\* | + +## embeddingPresignVerifyEmbeddingPresignToken + +Verifies a presign token for embedding operations and returns the associated API token + +### Example Usage + +```typescript +import { Documenso } from "@documenso/sdk-typescript"; + +const documenso = new Documenso({ + apiKey: process.env["DOCUMENSO_API_KEY"] ?? "", +}); + +async function run() { + const result = await documenso.embedding.embeddingPresignVerifyEmbeddingPresignToken({ + token: "<value>", + }); + + // Handle the result + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { DocumensoCore } from "@documenso/sdk-typescript/core.js"; +import { embeddingEmbeddingPresignVerifyEmbeddingPresignToken } from "@documenso/sdk-typescript/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.js"; + +// Use `DocumensoCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const documenso = new DocumensoCore({ + apiKey: process.env["DOCUMENSO_API_KEY"] ?? "", +}); + +async function run() { + const res = await embeddingEmbeddingPresignVerifyEmbeddingPresignToken(documenso, { + token: "<value>", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result); +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.EmbeddingPresignVerifyEmbeddingPresignTokenRequest](../../models/operations/embeddingpresignverifyembeddingpresigntokenrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.EmbeddingPresignVerifyEmbeddingPresignTokenResponse](../../models/operations/embeddingpresignverifyembeddingpresigntokenresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| errors.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError | 400 | application/json | +| errors.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError | 500 | application/json | +| errors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/eslint.config.mjs b/eslint.config.mjs index 3483f71b..67bccfec 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -11,6 +11,7 @@ export default [ { rules: { "no-constant-condition": "off", + "no-useless-escape": "off", // Handled by typescript compiler "@typescript-eslint/no-unused-vars": "off", "@typescript-eslint/no-explicit-any": "off", diff --git a/jsr.json b/jsr.json index a62d64b5..90bfef5b 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@documenso/sdk-typescript", - "version": "0.2.0", + "version": "0.2.1", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 36403d04..be9ab599 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,18 +1,18 @@ { "name": "@documenso/sdk-typescript", - "version": "0.2.0", + "version": "0.2.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@documenso/sdk-typescript", - "version": "0.2.0", + "version": "0.2.1", "bin": { "mcp": "bin/mcp-server.js" }, "devDependencies": { "@eslint/js": "^9.19.0", - "@modelcontextprotocol/sdk": "^1.5.0", + "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0", "@stricli/core": "^1.1.1", "@types/express": "^4.17.21", "bun": "^1.2.2", @@ -25,7 +25,7 @@ "zod": "^3.23.4" }, "peerDependencies": { - "@modelcontextprotocol/sdk": "^1.5.0", + "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0", "zod": ">= 3" }, "peerDependenciesMeta": { diff --git a/package.json b/package.json index 59e56b39..3c2945d5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@documenso/sdk-typescript", - "version": "0.2.0", + "version": "0.2.1", "author": "Speakeasy", "bin": { "mcp": "bin/mcp-server.js" @@ -18,7 +18,7 @@ "prepublishOnly": "npm run build" }, "peerDependencies": { - "@modelcontextprotocol/sdk": "^1.5.0", + "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0", "zod": ">= 3" }, "peerDependenciesMeta": { @@ -26,7 +26,7 @@ }, "devDependencies": { "@eslint/js": "^9.19.0", - "@modelcontextprotocol/sdk": "^1.5.0", + "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0", "@stricli/core": "^1.1.1", "@types/express": "^4.17.21", "bun": "^1.2.2", diff --git a/src/funcs/documentsFind.ts b/src/funcs/documentsFind.ts index 8c482ddc..31c7fe6a 100644 --- a/src/funcs/documentsFind.ts +++ b/src/funcs/documentsFind.ts @@ -93,6 +93,7 @@ async function $do( const path = pathToFunc("/document")(); const query = encodeFormQuery({ + "folderId": payload.folderId, "orderByColumn": payload.orderByColumn, "orderByDirection": payload.orderByDirection, "page": payload.page, diff --git a/src/funcs/documentsGet.ts b/src/funcs/documentsGet.ts index ff96a579..4125ff4b 100644 --- a/src/funcs/documentsGet.ts +++ b/src/funcs/documentsGet.ts @@ -3,7 +3,7 @@ */ import { DocumensoCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; +import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { compactMap } from "../lib/primitives.js"; import { safeParse } from "../lib/schemas.js"; @@ -101,6 +101,10 @@ async function $do( const path = pathToFunc("/document/{documentId}")(pathParams); + const query = encodeFormQuery({ + "folderId": payload.folderId, + }); + const headers = new Headers(compactMap({ Accept: "application/json", })); @@ -129,6 +133,7 @@ async function $do( baseURL: options?.serverURL, path: path, headers: headers, + query: query, body: body, timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, }, options); diff --git a/src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts b/src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts new file mode 100644 index 00000000..d71666cb --- /dev/null +++ b/src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts @@ -0,0 +1,182 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { DocumensoCore } from "../core.js"; +import { encodeJSON } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { APIError } from "../models/errors/apierror.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../models/errors/httpclienterrors.js"; +import * as errors from "../models/errors/index.js"; +import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; +import * as operations from "../models/operations/index.js"; +import { APICall, APIPromise } from "../types/async.js"; +import { Result } from "../types/fp.js"; + +/** + * Create embedding presign token + * + * @remarks + * Creates a presign token for embedding operations with configurable expiration time + */ +export function embeddingEmbeddingPresignCreateEmbeddingPresignToken( + client: DocumensoCore, + request: operations.EmbeddingPresignCreateEmbeddingPresignTokenRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.EmbeddingPresignCreateEmbeddingPresignTokenResponse, + | errors.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError + | errors.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError + | APIError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: DocumensoCore, + request: operations.EmbeddingPresignCreateEmbeddingPresignTokenRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.EmbeddingPresignCreateEmbeddingPresignTokenResponse, + | errors.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError + | errors.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError + | APIError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => + operations + .EmbeddingPresignCreateEmbeddingPresignTokenRequest$outboundSchema + .parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = encodeJSON("body", payload, { explode: true }); + + const path = pathToFunc("/embedding/create-presign-token")(); + + const headers = new Headers(compactMap({ + "Content-Type": "application/json", + Accept: "application/json", + })); + + const secConfig = await extractSecurity(client._options.apiKey); + const securityInput = secConfig == null ? {} : { apiKey: secConfig }; + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "embeddingPresign-createEmbeddingPresignToken", + oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.apiKey, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "POST", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["400", "4XX", "500", "5XX"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + HttpMeta: { Response: response, Request: req }, + }; + + const [result] = await M.match< + operations.EmbeddingPresignCreateEmbeddingPresignTokenResponse, + | errors.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError + | errors.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError + | APIError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + >( + M.json( + 200, + operations + .EmbeddingPresignCreateEmbeddingPresignTokenResponse$inboundSchema, + ), + M.jsonErr( + 400, + errors + .EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$inboundSchema, + ), + M.jsonErr( + 500, + errors + .EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$inboundSchema, + ), + M.fail("4XX"), + M.fail("5XX"), + )(response, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts b/src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts new file mode 100644 index 00000000..7c9b32f4 --- /dev/null +++ b/src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts @@ -0,0 +1,182 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { DocumensoCore } from "../core.js"; +import { encodeJSON } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { APIError } from "../models/errors/apierror.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../models/errors/httpclienterrors.js"; +import * as errors from "../models/errors/index.js"; +import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; +import * as operations from "../models/operations/index.js"; +import { APICall, APIPromise } from "../types/async.js"; +import { Result } from "../types/fp.js"; + +/** + * Verify embedding presign token + * + * @remarks + * Verifies a presign token for embedding operations and returns the associated API token + */ +export function embeddingEmbeddingPresignVerifyEmbeddingPresignToken( + client: DocumensoCore, + request: operations.EmbeddingPresignVerifyEmbeddingPresignTokenRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.EmbeddingPresignVerifyEmbeddingPresignTokenResponse, + | errors.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError + | errors.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError + | APIError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: DocumensoCore, + request: operations.EmbeddingPresignVerifyEmbeddingPresignTokenRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.EmbeddingPresignVerifyEmbeddingPresignTokenResponse, + | errors.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError + | errors.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError + | APIError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => + operations + .EmbeddingPresignVerifyEmbeddingPresignTokenRequest$outboundSchema + .parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = encodeJSON("body", payload, { explode: true }); + + const path = pathToFunc("/embedding/verify-presign-token")(); + + const headers = new Headers(compactMap({ + "Content-Type": "application/json", + Accept: "application/json", + })); + + const secConfig = await extractSecurity(client._options.apiKey); + const securityInput = secConfig == null ? {} : { apiKey: secConfig }; + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "embeddingPresign-verifyEmbeddingPresignToken", + oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.apiKey, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "POST", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["400", "4XX", "500", "5XX"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + HttpMeta: { Response: response, Request: req }, + }; + + const [result] = await M.match< + operations.EmbeddingPresignVerifyEmbeddingPresignTokenResponse, + | errors.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError + | errors.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError + | APIError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + >( + M.json( + 200, + operations + .EmbeddingPresignVerifyEmbeddingPresignTokenResponse$inboundSchema, + ), + M.jsonErr( + 400, + errors + .EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$inboundSchema, + ), + M.jsonErr( + 500, + errors + .EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$inboundSchema, + ), + M.fail("4XX"), + M.fail("5XX"), + )(response, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/templatesFind.ts b/src/funcs/templatesFind.ts index 8389b3fa..8442d592 100644 --- a/src/funcs/templatesFind.ts +++ b/src/funcs/templatesFind.ts @@ -93,6 +93,7 @@ async function $do( const path = pathToFunc("/template")(); const query = encodeFormQuery({ + "folderId": payload.folderId, "page": payload.page, "perPage": payload.perPage, "query": payload.query, diff --git a/src/lib/config.ts b/src/lib/config.ts index 58e18bce..72aacf79 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -54,8 +54,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.0.0", - sdkVersion: "0.2.0", - genVersion: "2.568.2", + sdkVersion: "0.2.1", + genVersion: "2.597.9", userAgent: - "speakeasy-sdk/typescript 0.2.0 2.568.2 0.0.0 @documenso/sdk-typescript", + "speakeasy-sdk/typescript 0.2.1 2.597.9 0.0.0 @documenso/sdk-typescript", } as const; diff --git a/src/lib/matchers.ts b/src/lib/matchers.ts index 65858ac9..17151be7 100644 --- a/src/lib/matchers.ts +++ b/src/lib/matchers.ts @@ -10,6 +10,7 @@ import { isPlainObject } from "./is-plain-object.js"; import { safeParse } from "./schemas.js"; export type Encoding = + | "jsonl" | "json" | "text" | "bytes" @@ -19,6 +20,7 @@ export type Encoding = | "fail"; const DEFAULT_CONTENT_TYPES: Record<Encoding, string> = { + jsonl: "application/jsonl", json: "application/json", text: "text/plain", bytes: "application/octet-stream", @@ -72,6 +74,21 @@ export function json<T>( return { ...options, enc: "json", codes, schema }; } +export function jsonl<T>( + codes: StatusCodePredicate, + schema: Schema<T>, + options?: MatchOptions, +): ValueMatcher<T> { + return { ...options, enc: "jsonl", codes, schema }; +} + +export function jsonlErr<E>( + codes: StatusCodePredicate, + schema: Schema<E>, + options?: MatchOptions, +): ErrorMatcher<E> { + return { ...options, err: true, enc: "jsonl", codes, schema }; +} export function textErr<E>( codes: StatusCodePredicate, schema: Schema<E>, @@ -204,6 +221,9 @@ export function match<T, E>( case "json": raw = await response.json(); break; + case "jsonl": + raw = response.body; + break; case "bytes": raw = new Uint8Array(await response.arrayBuffer()); break; diff --git a/src/lib/sdks.ts b/src/lib/sdks.ts index ec294222..aea8a7cf 100644 --- a/src/lib/sdks.ts +++ b/src/lib/sdks.ts @@ -47,12 +47,14 @@ export type RequestOptions = { */ serverURL?: string | URL; /** + * @deprecated `fetchOptions` has been flattened into `RequestOptions`. + * * Sets various request options on the `fetch` call made by an SDK method. * * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request} */ fetchOptions?: Omit<RequestInit, "method" | "body">; -}; +} & Omit<RequestInit, "method" | "body">; type RequestConfig = { method: string; @@ -172,7 +174,9 @@ export class ClientSDK { cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie; headers.set("cookie", cookie); - const userHeaders = new Headers(options?.fetchOptions?.headers); + const userHeaders = new Headers( + options?.headers ?? options?.fetchOptions?.headers, + ); for (const [k, v] of userHeaders) { headers.set(k, v); } @@ -183,20 +187,16 @@ export class ClientSDK { headers.set(conf.uaHeader ?? "user-agent", SDK_METADATA.userAgent); } - let fetchOptions = options?.fetchOptions; + const fetchOptions: Omit<RequestInit, "method" | "body"> = { + ...options?.fetchOptions, + ...options, + }; if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) { const timeoutSignal = AbortSignal.timeout(conf.timeoutMs); - if (!fetchOptions) { - fetchOptions = { signal: timeoutSignal }; - } else { - fetchOptions.signal = timeoutSignal; - } + fetchOptions.signal = timeoutSignal; } if (conf.body instanceof ReadableStream) { - if (!fetchOptions) { - fetchOptions = {}; - } Object.assign(fetchOptions, { duplex: "half" }); } @@ -302,7 +302,9 @@ export class ClientSDK { } } -const jsonLikeContentTypeRE = /^application\/(?:.{0,100}\+)?json/; +const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/; +const jsonlLikeContentTypeRE = + /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/; async function logRequest(logger: Logger | undefined, req: Request) { if (!logger) { return; @@ -368,9 +370,13 @@ async function logResponse( logger.group("Body:"); switch (true) { case matchContentType(res, "application/json") - || jsonLikeContentTypeRE.test(ct): + || jsonLikeContentTypeRE.test(ct) && !jsonlLikeContentTypeRE.test(ct): logger.log(await res.clone().json()); break; + case matchContentType(res, "application/jsonl") + || jsonlLikeContentTypeRE.test(ct): + logger.log(await res.clone().text()); + break; case matchContentType(res, "text/event-stream"): logger.log(`<${contentType}>`); break; diff --git a/src/mcp-server/mcp-server.ts b/src/mcp-server/mcp-server.ts index d643b838..abd8c812 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.2.0", + currentVersion: "0.2.1", }, }); diff --git a/src/mcp-server/server.ts b/src/mcp-server/server.ts index b7417220..7f9cdd39 100644 --- a/src/mcp-server/server.ts +++ b/src/mcp-server/server.ts @@ -34,6 +34,8 @@ import { tool$documentsRecipientsUpdate } from "./tools/documentsRecipientsUpdat import { tool$documentsRecipientsUpdateMany } from "./tools/documentsRecipientsUpdateMany.js"; import { tool$documentsRedistribute } from "./tools/documentsRedistribute.js"; import { tool$documentsUpdate } from "./tools/documentsUpdate.js"; +import { tool$embeddingEmbeddingPresignCreateEmbeddingPresignToken } from "./tools/embeddingEmbeddingPresignCreateEmbeddingPresignToken.js"; +import { tool$embeddingEmbeddingPresignVerifyEmbeddingPresignToken } from "./tools/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.js"; import { tool$templatesDelete } from "./tools/templatesDelete.js"; import { tool$templatesDirectLinkCreate } from "./tools/templatesDirectLinkCreate.js"; import { tool$templatesDirectLinkDelete } from "./tools/templatesDirectLinkDelete.js"; @@ -67,7 +69,7 @@ export function createMCPServer(deps: { }) { const server = new McpServer({ name: "Documenso", - version: "0.2.0", + version: "0.2.1", }); const client = new DocumensoCore({ @@ -113,6 +115,8 @@ export function createMCPServer(deps: { tool(tool$templatesDelete); tool(tool$templatesUse); tool(tool$templatesMoveToTeam); + tool(tool$embeddingEmbeddingPresignCreateEmbeddingPresignToken); + tool(tool$embeddingEmbeddingPresignVerifyEmbeddingPresignToken); tool(tool$documentsFieldsGet); tool(tool$documentsFieldsCreate); tool(tool$documentsFieldsCreateMany); diff --git a/src/mcp-server/tools/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts b/src/mcp-server/tools/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts new file mode 100644 index 00000000..5fe2aa43 --- /dev/null +++ b/src/mcp-server/tools/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts @@ -0,0 +1,40 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { embeddingEmbeddingPresignCreateEmbeddingPresignToken } from "../../funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.js"; +import * as operations from "../../models/operations/index.js"; +import { formatResult, ToolDefinition } from "../tools.js"; + +const args = { + request: + operations.EmbeddingPresignCreateEmbeddingPresignTokenRequest$inboundSchema, +}; + +export const tool$embeddingEmbeddingPresignCreateEmbeddingPresignToken: + ToolDefinition<typeof args> = { + name: "embedding-embedding-presign-create-embedding-presign-token", + description: `Create embedding presign token + +Creates a presign token for embedding operations with configurable expiration time`, + args, + tool: async (client, args, ctx) => { + const [result, apiCall] = + await embeddingEmbeddingPresignCreateEmbeddingPresignToken( + client, + args.request, + { fetchOptions: { signal: ctx.signal } }, + ).$inspect(); + + if (!result.ok) { + return { + content: [{ type: "text", text: result.error.message }], + isError: true, + }; + } + + const value = result.value; + + return formatResult(value, apiCall); + }, + }; diff --git a/src/mcp-server/tools/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts b/src/mcp-server/tools/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts new file mode 100644 index 00000000..668cd572 --- /dev/null +++ b/src/mcp-server/tools/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts @@ -0,0 +1,40 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { embeddingEmbeddingPresignVerifyEmbeddingPresignToken } from "../../funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.js"; +import * as operations from "../../models/operations/index.js"; +import { formatResult, ToolDefinition } from "../tools.js"; + +const args = { + request: + operations.EmbeddingPresignVerifyEmbeddingPresignTokenRequest$inboundSchema, +}; + +export const tool$embeddingEmbeddingPresignVerifyEmbeddingPresignToken: + ToolDefinition<typeof args> = { + name: "embedding-embedding-presign-verify-embedding-presign-token", + description: `Verify embedding presign token + +Verifies a presign token for embedding operations and returns the associated API token`, + args, + tool: async (client, args, ctx) => { + const [result, apiCall] = + await embeddingEmbeddingPresignVerifyEmbeddingPresignToken( + client, + args.request, + { fetchOptions: { signal: ctx.signal } }, + ).$inspect(); + + if (!result.ok) { + return { + content: [{ type: "text", text: result.error.message }], + isError: true, + }; + } + + const value = result.value; + + return formatResult(value, apiCall); + }, + }; diff --git a/src/models/errors/embeddingpresigncreateembeddingpresigntoken.ts b/src/models/errors/embeddingpresigncreateembeddingpresigntoken.ts new file mode 100644 index 00000000..47017f96 --- /dev/null +++ b/src/models/errors/embeddingpresigncreateembeddingpresigntoken.ts @@ -0,0 +1,373 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "./sdkvalidationerror.js"; + +export type EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue = + { + message: string; + }; + +/** + * Internal server error + */ +export type EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData = + { + message: string; + code: string; + issues?: + | Array< + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue + > + | undefined; + }; + +/** + * Internal server error + */ +export class EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError + extends Error +{ + code: string; + issues?: + | Array<EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue> + | undefined; + + /** The original data that was passed to this error instance. */ + data$: EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData; + + constructor( + err: EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData, + ) { + const message = "message" in err && typeof err.message === "string" + ? err.message + : `API error occurred: ${JSON.stringify(err)}`; + super(message); + this.data$ = err; + + this.code = err.code; + if (err.issues != null) this.issues = err.issues; + + this.name = + "EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError"; + } +} + +export type EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue = { + message: string; +}; + +/** + * Invalid input data + */ +export type EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData = { + message: string; + code: string; + issues?: + | Array<EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue> + | undefined; +}; + +/** + * Invalid input data + */ +export class EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError + extends Error +{ + code: string; + issues?: + | Array<EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue> + | undefined; + + /** The original data that was passed to this error instance. */ + data$: EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData; + + constructor( + err: EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData, + ) { + const message = "message" in err && typeof err.message === "string" + ? err.message + : `API error occurred: ${JSON.stringify(err)}`; + super(message); + this.data$ = err; + + this.code = err.code; + if (err.issues != null) this.issues = err.issues; + + this.name = "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError"; + } +} + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue, + z.ZodTypeDef, + unknown + > = z.object({ + message: z.string(), + }); + +/** @internal */ +export type EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$Outbound = + { + message: string; + }; + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$Outbound, + z.ZodTypeDef, + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue + > = z.object({ + message: 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 EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$ { + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$Outbound` instead. */ + export type Outbound = + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$Outbound; +} + +export function embeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssueToJSON( + embeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue: + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue, +): string { + return JSON.stringify( + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema + .parse( + embeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue, + ), + ); +} + +export function embeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssueFromJSON( + jsonString: string, +): SafeParseResult< + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema + .parse(JSON.parse(x)), + `Failed to parse 'EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue' from JSON`, + ); +} + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$inboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError, + z.ZodTypeDef, + unknown + > = z.object({ + message: z.string(), + code: z.string(), + issues: z.array( + z.lazy(() => + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema + ), + ).optional(), + }) + .transform((v) => { + return new EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError( + v, + ); + }); + +/** @internal */ +export type EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$Outbound = + { + message: string; + code: string; + issues?: + | Array< + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$Outbound + > + | undefined; + }; + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$outboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$Outbound, + z.ZodTypeDef, + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError + > = z.instanceof( + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError, + ) + .transform(v => v.data$) + .pipe(z.object({ + message: z.string(), + code: z.string(), + issues: z.array( + z.lazy(() => + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema + ), + ).optional(), + })); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$ { + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$inboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$outboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$Outbound` instead. */ + export type Outbound = + EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError$Outbound; +} + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$inboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue, + z.ZodTypeDef, + unknown + > = z.object({ + message: z.string(), + }); + +/** @internal */ +export type EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$Outbound = + { + message: string; + }; + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$outboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$Outbound, + z.ZodTypeDef, + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue + > = z.object({ + message: 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 EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$ { + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$inboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$outboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$Outbound` instead. */ + export type Outbound = + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$Outbound; +} + +export function embeddingPresignCreateEmbeddingPresignTokenBadRequestIssueToJSON( + embeddingPresignCreateEmbeddingPresignTokenBadRequestIssue: + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue, +): string { + return JSON.stringify( + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$outboundSchema + .parse(embeddingPresignCreateEmbeddingPresignTokenBadRequestIssue), + ); +} + +export function embeddingPresignCreateEmbeddingPresignTokenBadRequestIssueFromJSON( + jsonString: string, +): SafeParseResult< + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$inboundSchema + .parse(JSON.parse(x)), + `Failed to parse 'EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue' from JSON`, + ); +} + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$inboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError, + z.ZodTypeDef, + unknown + > = z.object({ + message: z.string(), + code: z.string(), + issues: z.array( + z.lazy(() => + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$inboundSchema + ), + ).optional(), + }) + .transform((v) => { + return new EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError(v); + }); + +/** @internal */ +export type EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$Outbound = + { + message: string; + code: string; + issues?: + | Array< + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$Outbound + > + | undefined; + }; + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$outboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$Outbound, + z.ZodTypeDef, + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError + > = z.instanceof(EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError) + .transform(v => v.data$) + .pipe(z.object({ + message: z.string(), + code: z.string(), + issues: z.array( + z.lazy(() => + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue$outboundSchema + ), + ).optional(), + })); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$ { + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$inboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$outboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$Outbound` instead. */ + export type Outbound = + EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError$Outbound; +} diff --git a/src/models/errors/embeddingpresignverifyembeddingpresigntoken.ts b/src/models/errors/embeddingpresignverifyembeddingpresigntoken.ts new file mode 100644 index 00000000..2b963dcc --- /dev/null +++ b/src/models/errors/embeddingpresignverifyembeddingpresigntoken.ts @@ -0,0 +1,373 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "./sdkvalidationerror.js"; + +export type EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue = + { + message: string; + }; + +/** + * Internal server error + */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData = + { + message: string; + code: string; + issues?: + | Array< + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue + > + | undefined; + }; + +/** + * Internal server error + */ +export class EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError + extends Error +{ + code: string; + issues?: + | Array<EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue> + | undefined; + + /** The original data that was passed to this error instance. */ + data$: EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData; + + constructor( + err: EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData, + ) { + const message = "message" in err && typeof err.message === "string" + ? err.message + : `API error occurred: ${JSON.stringify(err)}`; + super(message); + this.data$ = err; + + this.code = err.code; + if (err.issues != null) this.issues = err.issues; + + this.name = + "EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError"; + } +} + +export type EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue = { + message: string; +}; + +/** + * Invalid input data + */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData = { + message: string; + code: string; + issues?: + | Array<EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue> + | undefined; +}; + +/** + * Invalid input data + */ +export class EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError + extends Error +{ + code: string; + issues?: + | Array<EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue> + | undefined; + + /** The original data that was passed to this error instance. */ + data$: EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData; + + constructor( + err: EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData, + ) { + const message = "message" in err && typeof err.message === "string" + ? err.message + : `API error occurred: ${JSON.stringify(err)}`; + super(message); + this.data$ = err; + + this.code = err.code; + if (err.issues != null) this.issues = err.issues; + + this.name = "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError"; + } +} + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue, + z.ZodTypeDef, + unknown + > = z.object({ + message: z.string(), + }); + +/** @internal */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$Outbound = + { + message: string; + }; + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$Outbound, + z.ZodTypeDef, + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue + > = z.object({ + message: 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 EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$ { + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$Outbound` instead. */ + export type Outbound = + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$Outbound; +} + +export function embeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssueToJSON( + embeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue: + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue, +): string { + return JSON.stringify( + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema + .parse( + embeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue, + ), + ); +} + +export function embeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssueFromJSON( + jsonString: string, +): SafeParseResult< + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema + .parse(JSON.parse(x)), + `Failed to parse 'EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue' from JSON`, + ); +} + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$inboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError, + z.ZodTypeDef, + unknown + > = z.object({ + message: z.string(), + code: z.string(), + issues: z.array( + z.lazy(() => + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$inboundSchema + ), + ).optional(), + }) + .transform((v) => { + return new EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError( + v, + ); + }); + +/** @internal */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$Outbound = + { + message: string; + code: string; + issues?: + | Array< + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$Outbound + > + | undefined; + }; + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$outboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$Outbound, + z.ZodTypeDef, + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError + > = z.instanceof( + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError, + ) + .transform(v => v.data$) + .pipe(z.object({ + message: z.string(), + code: z.string(), + issues: z.array( + z.lazy(() => + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue$outboundSchema + ), + ).optional(), + })); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$ { + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$inboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$outboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$Outbound` instead. */ + export type Outbound = + EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError$Outbound; +} + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$inboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue, + z.ZodTypeDef, + unknown + > = z.object({ + message: z.string(), + }); + +/** @internal */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$Outbound = + { + message: string; + }; + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$outboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$Outbound, + z.ZodTypeDef, + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue + > = z.object({ + message: 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 EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$ { + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$inboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$outboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$Outbound` instead. */ + export type Outbound = + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$Outbound; +} + +export function embeddingPresignVerifyEmbeddingPresignTokenBadRequestIssueToJSON( + embeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue: + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue, +): string { + return JSON.stringify( + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$outboundSchema + .parse(embeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue), + ); +} + +export function embeddingPresignVerifyEmbeddingPresignTokenBadRequestIssueFromJSON( + jsonString: string, +): SafeParseResult< + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$inboundSchema + .parse(JSON.parse(x)), + `Failed to parse 'EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue' from JSON`, + ); +} + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$inboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError, + z.ZodTypeDef, + unknown + > = z.object({ + message: z.string(), + code: z.string(), + issues: z.array( + z.lazy(() => + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$inboundSchema + ), + ).optional(), + }) + .transform((v) => { + return new EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError(v); + }); + +/** @internal */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$Outbound = + { + message: string; + code: string; + issues?: + | Array< + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$Outbound + > + | undefined; + }; + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$outboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$Outbound, + z.ZodTypeDef, + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError + > = z.instanceof(EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError) + .transform(v => v.data$) + .pipe(z.object({ + message: z.string(), + code: z.string(), + issues: z.array( + z.lazy(() => + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue$outboundSchema + ), + ).optional(), + })); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$ { + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$inboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$outboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$Outbound` instead. */ + export type Outbound = + EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError$Outbound; +} diff --git a/src/models/errors/index.ts b/src/models/errors/index.ts index 8a8386c9..c8dfc61d 100644 --- a/src/models/errors/index.ts +++ b/src/models/errors/index.ts @@ -12,6 +12,8 @@ export * from "./documentmovedocumenttoteam.js"; export * from "./documentresenddocument.js"; export * from "./documentsenddocument.js"; export * from "./documentupdatedocument.js"; +export * from "./embeddingpresigncreateembeddingpresigntoken.js"; +export * from "./embeddingpresignverifyembeddingpresigntoken.js"; export * from "./fieldcreatedocumentfield.js"; export * from "./fieldcreatedocumentfields.js"; export * from "./fieldcreatetemplatefield.js"; diff --git a/src/models/operations/documentcreatedocumenttemporary.ts b/src/models/operations/documentcreatedocumenttemporary.ts index d377f0fa..c5a6d8f2 100644 --- a/src/models/operations/documentcreatedocumenttemporary.ts +++ b/src/models/operations/documentcreatedocumenttemporary.ts @@ -975,6 +975,34 @@ export type DocumentCreateDocumentTemporaryDocumentMeta = { emailSettings: DocumentEmailSettings | null; }; +export const DocumentFolderType = { + Document: "DOCUMENT", + Template: "TEMPLATE", +} as const; +export type DocumentFolderType = ClosedEnum<typeof DocumentFolderType>; + +export const DocumentFolderVisibility = { + Everyone: "EVERYONE", + ManagerAndAbove: "MANAGER_AND_ABOVE", + Admin: "ADMIN", +} as const; +export type DocumentFolderVisibility = ClosedEnum< + typeof DocumentFolderVisibility +>; + +export type DocumentCreateDocumentTemporaryFolder = { + id: string; + name: string; + type: DocumentFolderType; + visibility: DocumentFolderVisibility; + userId: number; + teamId: number | null; + pinned: boolean; + parentId: string | null; + createdAt: string; + updatedAt: string; +}; + export const DocumentRole = { Cc: "CC", Signer: "SIGNER", @@ -1345,8 +1373,10 @@ export type Document = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; documentData: DocumentCreateDocumentTemporaryDocumentData; documentMeta: DocumentCreateDocumentTemporaryDocumentMeta | null; + folder: DocumentCreateDocumentTemporaryFolder | null; recipients: Array<DocumentRecipient>; fields: Array<DocumentField>; }; @@ -4809,6 +4839,134 @@ export function documentCreateDocumentTemporaryDocumentMetaFromJSON( ); } +/** @internal */ +export const DocumentFolderType$inboundSchema: z.ZodNativeEnum< + typeof DocumentFolderType +> = z.nativeEnum(DocumentFolderType); + +/** @internal */ +export const DocumentFolderType$outboundSchema: z.ZodNativeEnum< + typeof DocumentFolderType +> = DocumentFolderType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace DocumentFolderType$ { + /** @deprecated use `DocumentFolderType$inboundSchema` instead. */ + export const inboundSchema = DocumentFolderType$inboundSchema; + /** @deprecated use `DocumentFolderType$outboundSchema` instead. */ + export const outboundSchema = DocumentFolderType$outboundSchema; +} + +/** @internal */ +export const DocumentFolderVisibility$inboundSchema: z.ZodNativeEnum< + typeof DocumentFolderVisibility +> = z.nativeEnum(DocumentFolderVisibility); + +/** @internal */ +export const DocumentFolderVisibility$outboundSchema: z.ZodNativeEnum< + typeof DocumentFolderVisibility +> = DocumentFolderVisibility$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace DocumentFolderVisibility$ { + /** @deprecated use `DocumentFolderVisibility$inboundSchema` instead. */ + export const inboundSchema = DocumentFolderVisibility$inboundSchema; + /** @deprecated use `DocumentFolderVisibility$outboundSchema` instead. */ + export const outboundSchema = DocumentFolderVisibility$outboundSchema; +} + +/** @internal */ +export const DocumentCreateDocumentTemporaryFolder$inboundSchema: z.ZodType< + DocumentCreateDocumentTemporaryFolder, + z.ZodTypeDef, + unknown +> = z.object({ + id: z.string(), + name: z.string(), + type: DocumentFolderType$inboundSchema, + visibility: DocumentFolderVisibility$inboundSchema, + userId: z.number(), + teamId: z.nullable(z.number()), + pinned: z.boolean(), + parentId: z.nullable(z.string()), + createdAt: z.string(), + updatedAt: z.string(), +}); + +/** @internal */ +export type DocumentCreateDocumentTemporaryFolder$Outbound = { + id: string; + name: string; + type: string; + visibility: string; + userId: number; + teamId: number | null; + pinned: boolean; + parentId: string | null; + createdAt: string; + updatedAt: string; +}; + +/** @internal */ +export const DocumentCreateDocumentTemporaryFolder$outboundSchema: z.ZodType< + DocumentCreateDocumentTemporaryFolder$Outbound, + z.ZodTypeDef, + DocumentCreateDocumentTemporaryFolder +> = z.object({ + id: z.string(), + name: z.string(), + type: DocumentFolderType$outboundSchema, + visibility: DocumentFolderVisibility$outboundSchema, + userId: z.number(), + teamId: z.nullable(z.number()), + pinned: z.boolean(), + parentId: z.nullable(z.string()), + createdAt: z.string(), + updatedAt: 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 DocumentCreateDocumentTemporaryFolder$ { + /** @deprecated use `DocumentCreateDocumentTemporaryFolder$inboundSchema` instead. */ + export const inboundSchema = + DocumentCreateDocumentTemporaryFolder$inboundSchema; + /** @deprecated use `DocumentCreateDocumentTemporaryFolder$outboundSchema` instead. */ + export const outboundSchema = + DocumentCreateDocumentTemporaryFolder$outboundSchema; + /** @deprecated use `DocumentCreateDocumentTemporaryFolder$Outbound` instead. */ + export type Outbound = DocumentCreateDocumentTemporaryFolder$Outbound; +} + +export function documentCreateDocumentTemporaryFolderToJSON( + documentCreateDocumentTemporaryFolder: DocumentCreateDocumentTemporaryFolder, +): string { + return JSON.stringify( + DocumentCreateDocumentTemporaryFolder$outboundSchema.parse( + documentCreateDocumentTemporaryFolder, + ), + ); +} + +export function documentCreateDocumentTemporaryFolderFromJSON( + jsonString: string, +): SafeParseResult<DocumentCreateDocumentTemporaryFolder, SDKValidationError> { + return safeParse( + jsonString, + (x) => + DocumentCreateDocumentTemporaryFolder$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'DocumentCreateDocumentTemporaryFolder' from JSON`, + ); +} + /** @internal */ export const DocumentRole$inboundSchema: z.ZodNativeEnum<typeof DocumentRole> = z.nativeEnum(DocumentRole); @@ -6509,12 +6667,16 @@ export const Document$inboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), documentData: z.lazy(() => DocumentCreateDocumentTemporaryDocumentData$inboundSchema ), documentMeta: z.nullable( z.lazy(() => DocumentCreateDocumentTemporaryDocumentMeta$inboundSchema), ), + folder: z.nullable( + z.lazy(() => DocumentCreateDocumentTemporaryFolder$inboundSchema), + ), recipients: z.array(z.lazy(() => DocumentRecipient$inboundSchema)), fields: z.array(z.lazy(() => DocumentField$inboundSchema)), }); @@ -6537,8 +6699,10 @@ export type Document$Outbound = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; documentData: DocumentCreateDocumentTemporaryDocumentData$Outbound; documentMeta: DocumentCreateDocumentTemporaryDocumentMeta$Outbound | null; + folder: DocumentCreateDocumentTemporaryFolder$Outbound | null; recipients: Array<DocumentRecipient$Outbound>; fields: Array<DocumentField$Outbound>; }; @@ -6569,12 +6733,16 @@ export const Document$outboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), documentData: z.lazy(() => DocumentCreateDocumentTemporaryDocumentData$outboundSchema ), documentMeta: z.nullable( z.lazy(() => DocumentCreateDocumentTemporaryDocumentMeta$outboundSchema), ), + folder: z.nullable( + z.lazy(() => DocumentCreateDocumentTemporaryFolder$outboundSchema), + ), recipients: z.array(z.lazy(() => DocumentRecipient$outboundSchema)), fields: z.array(z.lazy(() => DocumentField$outboundSchema)), }); diff --git a/src/models/operations/documentfinddocuments.ts b/src/models/operations/documentfinddocuments.ts index bd54aaba..4cac156f 100644 --- a/src/models/operations/documentfinddocuments.ts +++ b/src/models/operations/documentfinddocuments.ts @@ -71,6 +71,10 @@ export type DocumentFindDocumentsRequest = { * Filter documents by the current status */ status?: QueryParamStatus | undefined; + /** + * Filter documents by folder ID + */ + folderId?: string | undefined; orderByColumn?: OrderByColumn | undefined; orderByDirection?: OrderByDirection | undefined; }; @@ -272,6 +276,8 @@ export type DocumentFindDocumentsData = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; + useLegacyFieldInsertion: boolean; user: DocumentFindDocumentsUser; recipients: Array<DocumentFindDocumentsRecipient>; team: DocumentFindDocumentsTeam | null; @@ -396,6 +402,7 @@ export const DocumentFindDocumentsRequest$inboundSchema: z.ZodType< templateId: z.number().optional(), source: QueryParamSource$inboundSchema.optional(), status: QueryParamStatus$inboundSchema.optional(), + folderId: z.string().optional(), orderByColumn: OrderByColumn$inboundSchema.optional(), orderByDirection: OrderByDirection$inboundSchema.default("desc"), }); @@ -408,6 +415,7 @@ export type DocumentFindDocumentsRequest$Outbound = { templateId?: number | undefined; source?: string | undefined; status?: string | undefined; + folderId?: string | undefined; orderByColumn?: string | undefined; orderByDirection: string; }; @@ -424,6 +432,7 @@ export const DocumentFindDocumentsRequest$outboundSchema: z.ZodType< templateId: z.number().optional(), source: QueryParamSource$outboundSchema.optional(), status: QueryParamStatus$outboundSchema.optional(), + folderId: z.string().optional(), orderByColumn: OrderByColumn$outboundSchema.optional(), orderByDirection: OrderByDirection$outboundSchema.default("desc"), }); @@ -1132,6 +1141,8 @@ export const DocumentFindDocumentsData$inboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), user: z.lazy(() => DocumentFindDocumentsUser$inboundSchema), recipients: z.array( z.lazy(() => DocumentFindDocumentsRecipient$inboundSchema), @@ -1157,6 +1168,8 @@ export type DocumentFindDocumentsData$Outbound = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; + useLegacyFieldInsertion: boolean; user: DocumentFindDocumentsUser$Outbound; recipients: Array<DocumentFindDocumentsRecipient$Outbound>; team: DocumentFindDocumentsTeam$Outbound | null; @@ -1188,6 +1201,8 @@ export const DocumentFindDocumentsData$outboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), user: z.lazy(() => DocumentFindDocumentsUser$outboundSchema), recipients: z.array( z.lazy(() => DocumentFindDocumentsRecipient$outboundSchema), diff --git a/src/models/operations/documentgetdocumentwithdetailsbyid.ts b/src/models/operations/documentgetdocumentwithdetailsbyid.ts index 33a4b26f..e14acff9 100644 --- a/src/models/operations/documentgetdocumentwithdetailsbyid.ts +++ b/src/models/operations/documentgetdocumentwithdetailsbyid.ts @@ -10,6 +10,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js"; export type DocumentGetDocumentWithDetailsByIdRequest = { documentId: number; + /** + * Filter documents by folder ID + */ + folderId?: string | undefined; }; export const DocumentGetDocumentWithDetailsByIdVisibility = { @@ -166,6 +170,36 @@ export type DocumentGetDocumentWithDetailsByIdDocumentMeta = { emailSettings: DocumentGetDocumentWithDetailsByIdEmailSettings | null; }; +export const DocumentGetDocumentWithDetailsByIdFolderType = { + Document: "DOCUMENT", + Template: "TEMPLATE", +} as const; +export type DocumentGetDocumentWithDetailsByIdFolderType = ClosedEnum< + typeof DocumentGetDocumentWithDetailsByIdFolderType +>; + +export const DocumentGetDocumentWithDetailsByIdFolderVisibility = { + Everyone: "EVERYONE", + ManagerAndAbove: "MANAGER_AND_ABOVE", + Admin: "ADMIN", +} as const; +export type DocumentGetDocumentWithDetailsByIdFolderVisibility = ClosedEnum< + typeof DocumentGetDocumentWithDetailsByIdFolderVisibility +>; + +export type DocumentGetDocumentWithDetailsByIdFolder = { + id: string; + name: string; + type: DocumentGetDocumentWithDetailsByIdFolderType; + visibility: DocumentGetDocumentWithDetailsByIdFolderVisibility; + userId: number; + teamId: number | null; + pinned: boolean; + parentId: string | null; + createdAt: string; + updatedAt: string; +}; + export const DocumentGetDocumentWithDetailsByIdRole = { Cc: "CC", Signer: "SIGNER", @@ -577,8 +611,10 @@ export type DocumentGetDocumentWithDetailsByIdResponse = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; documentData: DocumentGetDocumentWithDetailsByIdDocumentData; documentMeta: DocumentGetDocumentWithDetailsByIdDocumentMeta | null; + folder: DocumentGetDocumentWithDetailsByIdFolder | null; recipients: Array<DocumentGetDocumentWithDetailsByIdRecipient>; fields: Array<DocumentGetDocumentWithDetailsByIdField>; }; @@ -590,11 +626,13 @@ export const DocumentGetDocumentWithDetailsByIdRequest$inboundSchema: z.ZodType< unknown > = z.object({ documentId: z.number(), + folderId: z.string().optional(), }); /** @internal */ export type DocumentGetDocumentWithDetailsByIdRequest$Outbound = { documentId: number; + folderId?: string | undefined; }; /** @internal */ @@ -605,6 +643,7 @@ export const DocumentGetDocumentWithDetailsByIdRequest$outboundSchema: DocumentGetDocumentWithDetailsByIdRequest > = z.object({ documentId: z.number(), + folderId: z.string().optional(), }); /** @@ -1263,6 +1302,144 @@ export function documentGetDocumentWithDetailsByIdDocumentMetaFromJSON( ); } +/** @internal */ +export const DocumentGetDocumentWithDetailsByIdFolderType$inboundSchema: + z.ZodNativeEnum<typeof DocumentGetDocumentWithDetailsByIdFolderType> = z + .nativeEnum(DocumentGetDocumentWithDetailsByIdFolderType); + +/** @internal */ +export const DocumentGetDocumentWithDetailsByIdFolderType$outboundSchema: + z.ZodNativeEnum<typeof DocumentGetDocumentWithDetailsByIdFolderType> = + DocumentGetDocumentWithDetailsByIdFolderType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace DocumentGetDocumentWithDetailsByIdFolderType$ { + /** @deprecated use `DocumentGetDocumentWithDetailsByIdFolderType$inboundSchema` instead. */ + export const inboundSchema = + DocumentGetDocumentWithDetailsByIdFolderType$inboundSchema; + /** @deprecated use `DocumentGetDocumentWithDetailsByIdFolderType$outboundSchema` instead. */ + export const outboundSchema = + DocumentGetDocumentWithDetailsByIdFolderType$outboundSchema; +} + +/** @internal */ +export const DocumentGetDocumentWithDetailsByIdFolderVisibility$inboundSchema: + z.ZodNativeEnum<typeof DocumentGetDocumentWithDetailsByIdFolderVisibility> = z + .nativeEnum(DocumentGetDocumentWithDetailsByIdFolderVisibility); + +/** @internal */ +export const DocumentGetDocumentWithDetailsByIdFolderVisibility$outboundSchema: + z.ZodNativeEnum<typeof DocumentGetDocumentWithDetailsByIdFolderVisibility> = + DocumentGetDocumentWithDetailsByIdFolderVisibility$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace DocumentGetDocumentWithDetailsByIdFolderVisibility$ { + /** @deprecated use `DocumentGetDocumentWithDetailsByIdFolderVisibility$inboundSchema` instead. */ + export const inboundSchema = + DocumentGetDocumentWithDetailsByIdFolderVisibility$inboundSchema; + /** @deprecated use `DocumentGetDocumentWithDetailsByIdFolderVisibility$outboundSchema` instead. */ + export const outboundSchema = + DocumentGetDocumentWithDetailsByIdFolderVisibility$outboundSchema; +} + +/** @internal */ +export const DocumentGetDocumentWithDetailsByIdFolder$inboundSchema: z.ZodType< + DocumentGetDocumentWithDetailsByIdFolder, + z.ZodTypeDef, + unknown +> = z.object({ + id: z.string(), + name: z.string(), + type: DocumentGetDocumentWithDetailsByIdFolderType$inboundSchema, + visibility: DocumentGetDocumentWithDetailsByIdFolderVisibility$inboundSchema, + userId: z.number(), + teamId: z.nullable(z.number()), + pinned: z.boolean(), + parentId: z.nullable(z.string()), + createdAt: z.string(), + updatedAt: z.string(), +}); + +/** @internal */ +export type DocumentGetDocumentWithDetailsByIdFolder$Outbound = { + id: string; + name: string; + type: string; + visibility: string; + userId: number; + teamId: number | null; + pinned: boolean; + parentId: string | null; + createdAt: string; + updatedAt: string; +}; + +/** @internal */ +export const DocumentGetDocumentWithDetailsByIdFolder$outboundSchema: z.ZodType< + DocumentGetDocumentWithDetailsByIdFolder$Outbound, + z.ZodTypeDef, + DocumentGetDocumentWithDetailsByIdFolder +> = z.object({ + id: z.string(), + name: z.string(), + type: DocumentGetDocumentWithDetailsByIdFolderType$outboundSchema, + visibility: DocumentGetDocumentWithDetailsByIdFolderVisibility$outboundSchema, + userId: z.number(), + teamId: z.nullable(z.number()), + pinned: z.boolean(), + parentId: z.nullable(z.string()), + createdAt: z.string(), + updatedAt: 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 DocumentGetDocumentWithDetailsByIdFolder$ { + /** @deprecated use `DocumentGetDocumentWithDetailsByIdFolder$inboundSchema` instead. */ + export const inboundSchema = + DocumentGetDocumentWithDetailsByIdFolder$inboundSchema; + /** @deprecated use `DocumentGetDocumentWithDetailsByIdFolder$outboundSchema` instead. */ + export const outboundSchema = + DocumentGetDocumentWithDetailsByIdFolder$outboundSchema; + /** @deprecated use `DocumentGetDocumentWithDetailsByIdFolder$Outbound` instead. */ + export type Outbound = DocumentGetDocumentWithDetailsByIdFolder$Outbound; +} + +export function documentGetDocumentWithDetailsByIdFolderToJSON( + documentGetDocumentWithDetailsByIdFolder: + DocumentGetDocumentWithDetailsByIdFolder, +): string { + return JSON.stringify( + DocumentGetDocumentWithDetailsByIdFolder$outboundSchema.parse( + documentGetDocumentWithDetailsByIdFolder, + ), + ); +} + +export function documentGetDocumentWithDetailsByIdFolderFromJSON( + jsonString: string, +): SafeParseResult< + DocumentGetDocumentWithDetailsByIdFolder, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + DocumentGetDocumentWithDetailsByIdFolder$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'DocumentGetDocumentWithDetailsByIdFolder' from JSON`, + ); +} + /** @internal */ export const DocumentGetDocumentWithDetailsByIdRole$inboundSchema: z.ZodNativeEnum<typeof DocumentGetDocumentWithDetailsByIdRole> = z.nativeEnum( @@ -3316,6 +3493,7 @@ export const DocumentGetDocumentWithDetailsByIdResponse$inboundSchema: deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), documentData: z.lazy(() => DocumentGetDocumentWithDetailsByIdDocumentData$inboundSchema ), @@ -3324,6 +3502,9 @@ export const DocumentGetDocumentWithDetailsByIdResponse$inboundSchema: DocumentGetDocumentWithDetailsByIdDocumentMeta$inboundSchema ), ), + folder: z.nullable( + z.lazy(() => DocumentGetDocumentWithDetailsByIdFolder$inboundSchema), + ), recipients: z.array( z.lazy(() => DocumentGetDocumentWithDetailsByIdRecipient$inboundSchema), ), @@ -3350,8 +3531,10 @@ export type DocumentGetDocumentWithDetailsByIdResponse$Outbound = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; documentData: DocumentGetDocumentWithDetailsByIdDocumentData$Outbound; documentMeta: DocumentGetDocumentWithDetailsByIdDocumentMeta$Outbound | null; + folder: DocumentGetDocumentWithDetailsByIdFolder$Outbound | null; recipients: Array<DocumentGetDocumentWithDetailsByIdRecipient$Outbound>; fields: Array<DocumentGetDocumentWithDetailsByIdField$Outbound>; }; @@ -3385,6 +3568,7 @@ export const DocumentGetDocumentWithDetailsByIdResponse$outboundSchema: deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), documentData: z.lazy(() => DocumentGetDocumentWithDetailsByIdDocumentData$outboundSchema ), @@ -3393,6 +3577,9 @@ export const DocumentGetDocumentWithDetailsByIdResponse$outboundSchema: DocumentGetDocumentWithDetailsByIdDocumentMeta$outboundSchema ), ), + folder: z.nullable( + z.lazy(() => DocumentGetDocumentWithDetailsByIdFolder$outboundSchema), + ), recipients: z.array( z.lazy(() => DocumentGetDocumentWithDetailsByIdRecipient$outboundSchema), ), diff --git a/src/models/operations/documentmovedocumenttoteam.ts b/src/models/operations/documentmovedocumenttoteam.ts index b901c140..891b0b09 100644 --- a/src/models/operations/documentmovedocumenttoteam.ts +++ b/src/models/operations/documentmovedocumenttoteam.ts @@ -114,6 +114,8 @@ export type DocumentMoveDocumentToTeamResponse = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -440,6 +442,8 @@ export const DocumentMoveDocumentToTeamResponse$inboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** @internal */ @@ -460,6 +464,8 @@ export type DocumentMoveDocumentToTeamResponse$Outbound = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -488,6 +494,8 @@ export const DocumentMoveDocumentToTeamResponse$outboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** diff --git a/src/models/operations/documentsenddocument.ts b/src/models/operations/documentsenddocument.ts index ac68d666..60a5d6c9 100644 --- a/src/models/operations/documentsenddocument.ts +++ b/src/models/operations/documentsenddocument.ts @@ -228,6 +228,8 @@ export type DocumentSendDocumentResponse = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -763,6 +765,8 @@ export const DocumentSendDocumentResponse$inboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** @internal */ @@ -783,6 +787,8 @@ export type DocumentSendDocumentResponse$Outbound = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -811,6 +817,8 @@ export const DocumentSendDocumentResponse$outboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** diff --git a/src/models/operations/documentupdatedocument.ts b/src/models/operations/documentupdatedocument.ts index 769e4462..257124b3 100644 --- a/src/models/operations/documentupdatedocument.ts +++ b/src/models/operations/documentupdatedocument.ts @@ -78,6 +78,7 @@ export type DocumentUpdateDocumentData = { | DocumentUpdateDocumentGlobalActionAuthRequestBody | null | undefined; + useLegacyFieldInsertion?: boolean | undefined; }; /** @@ -320,6 +321,8 @@ export type DocumentUpdateDocumentResponse = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -407,6 +410,7 @@ export const DocumentUpdateDocumentData$inboundSchema: z.ZodType< globalActionAuth: z.nullable( DocumentUpdateDocumentGlobalActionAuthRequestBody$inboundSchema, ).optional(), + useLegacyFieldInsertion: z.boolean().optional(), }); /** @internal */ @@ -416,6 +420,7 @@ export type DocumentUpdateDocumentData$Outbound = { visibility?: string | undefined; globalAccessAuth?: string | null | undefined; globalActionAuth?: string | null | undefined; + useLegacyFieldInsertion?: boolean | undefined; }; /** @internal */ @@ -434,6 +439,7 @@ export const DocumentUpdateDocumentData$outboundSchema: z.ZodType< globalActionAuth: z.nullable( DocumentUpdateDocumentGlobalActionAuthRequestBody$outboundSchema, ).optional(), + useLegacyFieldInsertion: z.boolean().optional(), }); /** @@ -1046,6 +1052,8 @@ export const DocumentUpdateDocumentResponse$inboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** @internal */ @@ -1066,6 +1074,8 @@ export type DocumentUpdateDocumentResponse$Outbound = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -1094,6 +1104,8 @@ export const DocumentUpdateDocumentResponse$outboundSchema: z.ZodType< deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** diff --git a/src/models/operations/embeddingpresigncreateembeddingpresigntoken.ts b/src/models/operations/embeddingpresigncreateembeddingpresigntoken.ts new file mode 100644 index 00000000..d56ce591 --- /dev/null +++ b/src/models/operations/embeddingpresigncreateembeddingpresigntoken.ts @@ -0,0 +1,169 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type EmbeddingPresignCreateEmbeddingPresignTokenRequest = { + /** + * Expiration time in minutes (default: 60, max: 10,080) + */ + expiresIn?: number | undefined; +}; + +/** + * Successful response + */ +export type EmbeddingPresignCreateEmbeddingPresignTokenResponse = { + token: string; + expiresAt: string; + /** + * Expiration time in seconds + */ + expiresIn: number; +}; + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenRequest$inboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenRequest, + z.ZodTypeDef, + unknown + > = z.object({ + expiresIn: z.number().default(60), + }); + +/** @internal */ +export type EmbeddingPresignCreateEmbeddingPresignTokenRequest$Outbound = { + expiresIn: number; +}; + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenRequest$outboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenRequest$Outbound, + z.ZodTypeDef, + EmbeddingPresignCreateEmbeddingPresignTokenRequest + > = z.object({ + expiresIn: z.number().default(60), + }); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace EmbeddingPresignCreateEmbeddingPresignTokenRequest$ { + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenRequest$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenRequest$inboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenRequest$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenRequest$outboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenRequest$Outbound` instead. */ + export type Outbound = + EmbeddingPresignCreateEmbeddingPresignTokenRequest$Outbound; +} + +export function embeddingPresignCreateEmbeddingPresignTokenRequestToJSON( + embeddingPresignCreateEmbeddingPresignTokenRequest: + EmbeddingPresignCreateEmbeddingPresignTokenRequest, +): string { + return JSON.stringify( + EmbeddingPresignCreateEmbeddingPresignTokenRequest$outboundSchema.parse( + embeddingPresignCreateEmbeddingPresignTokenRequest, + ), + ); +} + +export function embeddingPresignCreateEmbeddingPresignTokenRequestFromJSON( + jsonString: string, +): SafeParseResult< + EmbeddingPresignCreateEmbeddingPresignTokenRequest, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + EmbeddingPresignCreateEmbeddingPresignTokenRequest$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'EmbeddingPresignCreateEmbeddingPresignTokenRequest' from JSON`, + ); +} + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenResponse$inboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenResponse, + z.ZodTypeDef, + unknown + > = z.object({ + token: z.string(), + expiresAt: z.string(), + expiresIn: z.number(), + }); + +/** @internal */ +export type EmbeddingPresignCreateEmbeddingPresignTokenResponse$Outbound = { + token: string; + expiresAt: string; + expiresIn: number; +}; + +/** @internal */ +export const EmbeddingPresignCreateEmbeddingPresignTokenResponse$outboundSchema: + z.ZodType< + EmbeddingPresignCreateEmbeddingPresignTokenResponse$Outbound, + z.ZodTypeDef, + EmbeddingPresignCreateEmbeddingPresignTokenResponse + > = z.object({ + token: z.string(), + expiresAt: z.string(), + expiresIn: z.number(), + }); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace EmbeddingPresignCreateEmbeddingPresignTokenResponse$ { + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenResponse$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenResponse$inboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenResponse$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignCreateEmbeddingPresignTokenResponse$outboundSchema; + /** @deprecated use `EmbeddingPresignCreateEmbeddingPresignTokenResponse$Outbound` instead. */ + export type Outbound = + EmbeddingPresignCreateEmbeddingPresignTokenResponse$Outbound; +} + +export function embeddingPresignCreateEmbeddingPresignTokenResponseToJSON( + embeddingPresignCreateEmbeddingPresignTokenResponse: + EmbeddingPresignCreateEmbeddingPresignTokenResponse, +): string { + return JSON.stringify( + EmbeddingPresignCreateEmbeddingPresignTokenResponse$outboundSchema.parse( + embeddingPresignCreateEmbeddingPresignTokenResponse, + ), + ); +} + +export function embeddingPresignCreateEmbeddingPresignTokenResponseFromJSON( + jsonString: string, +): SafeParseResult< + EmbeddingPresignCreateEmbeddingPresignTokenResponse, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + EmbeddingPresignCreateEmbeddingPresignTokenResponse$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'EmbeddingPresignCreateEmbeddingPresignTokenResponse' from JSON`, + ); +} diff --git a/src/models/operations/embeddingpresignverifyembeddingpresigntoken.ts b/src/models/operations/embeddingpresignverifyembeddingpresigntoken.ts new file mode 100644 index 00000000..1b20ae07 --- /dev/null +++ b/src/models/operations/embeddingpresignverifyembeddingpresigntoken.ts @@ -0,0 +1,158 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type EmbeddingPresignVerifyEmbeddingPresignTokenRequest = { + /** + * The presign token to verify + */ + token: string; +}; + +/** + * Successful response + */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenResponse = { + success: boolean; +}; + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenRequest$inboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenRequest, + z.ZodTypeDef, + unknown + > = z.object({ + token: z.string(), + }); + +/** @internal */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenRequest$Outbound = { + token: string; +}; + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenRequest$outboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenRequest$Outbound, + z.ZodTypeDef, + EmbeddingPresignVerifyEmbeddingPresignTokenRequest + > = z.object({ + token: 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 EmbeddingPresignVerifyEmbeddingPresignTokenRequest$ { + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenRequest$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenRequest$inboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenRequest$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenRequest$outboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenRequest$Outbound` instead. */ + export type Outbound = + EmbeddingPresignVerifyEmbeddingPresignTokenRequest$Outbound; +} + +export function embeddingPresignVerifyEmbeddingPresignTokenRequestToJSON( + embeddingPresignVerifyEmbeddingPresignTokenRequest: + EmbeddingPresignVerifyEmbeddingPresignTokenRequest, +): string { + return JSON.stringify( + EmbeddingPresignVerifyEmbeddingPresignTokenRequest$outboundSchema.parse( + embeddingPresignVerifyEmbeddingPresignTokenRequest, + ), + ); +} + +export function embeddingPresignVerifyEmbeddingPresignTokenRequestFromJSON( + jsonString: string, +): SafeParseResult< + EmbeddingPresignVerifyEmbeddingPresignTokenRequest, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + EmbeddingPresignVerifyEmbeddingPresignTokenRequest$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'EmbeddingPresignVerifyEmbeddingPresignTokenRequest' from JSON`, + ); +} + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenResponse$inboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenResponse, + z.ZodTypeDef, + unknown + > = z.object({ + success: z.boolean(), + }); + +/** @internal */ +export type EmbeddingPresignVerifyEmbeddingPresignTokenResponse$Outbound = { + success: boolean; +}; + +/** @internal */ +export const EmbeddingPresignVerifyEmbeddingPresignTokenResponse$outboundSchema: + z.ZodType< + EmbeddingPresignVerifyEmbeddingPresignTokenResponse$Outbound, + z.ZodTypeDef, + EmbeddingPresignVerifyEmbeddingPresignTokenResponse + > = z.object({ + success: z.boolean(), + }); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace EmbeddingPresignVerifyEmbeddingPresignTokenResponse$ { + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenResponse$inboundSchema` instead. */ + export const inboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenResponse$inboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenResponse$outboundSchema` instead. */ + export const outboundSchema = + EmbeddingPresignVerifyEmbeddingPresignTokenResponse$outboundSchema; + /** @deprecated use `EmbeddingPresignVerifyEmbeddingPresignTokenResponse$Outbound` instead. */ + export type Outbound = + EmbeddingPresignVerifyEmbeddingPresignTokenResponse$Outbound; +} + +export function embeddingPresignVerifyEmbeddingPresignTokenResponseToJSON( + embeddingPresignVerifyEmbeddingPresignTokenResponse: + EmbeddingPresignVerifyEmbeddingPresignTokenResponse, +): string { + return JSON.stringify( + EmbeddingPresignVerifyEmbeddingPresignTokenResponse$outboundSchema.parse( + embeddingPresignVerifyEmbeddingPresignTokenResponse, + ), + ); +} + +export function embeddingPresignVerifyEmbeddingPresignTokenResponseFromJSON( + jsonString: string, +): SafeParseResult< + EmbeddingPresignVerifyEmbeddingPresignTokenResponse, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + EmbeddingPresignVerifyEmbeddingPresignTokenResponse$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'EmbeddingPresignVerifyEmbeddingPresignTokenResponse' from JSON`, + ); +} diff --git a/src/models/operations/index.ts b/src/models/operations/index.ts index 9bb41ddc..c9025363 100644 --- a/src/models/operations/index.ts +++ b/src/models/operations/index.ts @@ -11,6 +11,8 @@ export * from "./documentmovedocumenttoteam.js"; export * from "./documentresenddocument.js"; export * from "./documentsenddocument.js"; export * from "./documentupdatedocument.js"; +export * from "./embeddingpresigncreateembeddingpresigntoken.js"; +export * from "./embeddingpresignverifyembeddingpresigntoken.js"; export * from "./fieldcreatedocumentfield.js"; export * from "./fieldcreatedocumentfields.js"; export * from "./fieldcreatetemplatefield.js"; diff --git a/src/models/operations/templatecreatedocumentfromtemplate.ts b/src/models/operations/templatecreatedocumentfromtemplate.ts index 8e5cbb99..bba72e78 100644 --- a/src/models/operations/templatecreatedocumentfromtemplate.ts +++ b/src/models/operations/templatecreatedocumentfromtemplate.ts @@ -272,6 +272,36 @@ export type TemplateCreateDocumentFromTemplateDocumentMeta = { emailSettings: TemplateCreateDocumentFromTemplateEmailSettings | null; }; +export const TemplateCreateDocumentFromTemplateFolderType = { + Document: "DOCUMENT", + Template: "TEMPLATE", +} as const; +export type TemplateCreateDocumentFromTemplateFolderType = ClosedEnum< + typeof TemplateCreateDocumentFromTemplateFolderType +>; + +export const TemplateCreateDocumentFromTemplateFolderVisibility = { + Everyone: "EVERYONE", + ManagerAndAbove: "MANAGER_AND_ABOVE", + Admin: "ADMIN", +} as const; +export type TemplateCreateDocumentFromTemplateFolderVisibility = ClosedEnum< + typeof TemplateCreateDocumentFromTemplateFolderVisibility +>; + +export type TemplateCreateDocumentFromTemplateFolder = { + id: string; + name: string; + type: TemplateCreateDocumentFromTemplateFolderType; + visibility: TemplateCreateDocumentFromTemplateFolderVisibility; + userId: number; + teamId: number | null; + pinned: boolean; + parentId: string | null; + createdAt: string; + updatedAt: string; +}; + export const TemplateCreateDocumentFromTemplateRole = { Cc: "CC", Signer: "SIGNER", @@ -681,8 +711,10 @@ export type TemplateCreateDocumentFromTemplateResponse = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; documentData: TemplateCreateDocumentFromTemplateDocumentData; documentMeta: TemplateCreateDocumentFromTemplateDocumentMeta | null; + folder: TemplateCreateDocumentFromTemplateFolder | null; recipients: Array<TemplateCreateDocumentFromTemplateRecipientResponse>; fields: Array<TemplateCreateDocumentFromTemplateField>; }; @@ -1973,6 +2005,144 @@ export function templateCreateDocumentFromTemplateDocumentMetaFromJSON( ); } +/** @internal */ +export const TemplateCreateDocumentFromTemplateFolderType$inboundSchema: + z.ZodNativeEnum<typeof TemplateCreateDocumentFromTemplateFolderType> = z + .nativeEnum(TemplateCreateDocumentFromTemplateFolderType); + +/** @internal */ +export const TemplateCreateDocumentFromTemplateFolderType$outboundSchema: + z.ZodNativeEnum<typeof TemplateCreateDocumentFromTemplateFolderType> = + TemplateCreateDocumentFromTemplateFolderType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace TemplateCreateDocumentFromTemplateFolderType$ { + /** @deprecated use `TemplateCreateDocumentFromTemplateFolderType$inboundSchema` instead. */ + export const inboundSchema = + TemplateCreateDocumentFromTemplateFolderType$inboundSchema; + /** @deprecated use `TemplateCreateDocumentFromTemplateFolderType$outboundSchema` instead. */ + export const outboundSchema = + TemplateCreateDocumentFromTemplateFolderType$outboundSchema; +} + +/** @internal */ +export const TemplateCreateDocumentFromTemplateFolderVisibility$inboundSchema: + z.ZodNativeEnum<typeof TemplateCreateDocumentFromTemplateFolderVisibility> = z + .nativeEnum(TemplateCreateDocumentFromTemplateFolderVisibility); + +/** @internal */ +export const TemplateCreateDocumentFromTemplateFolderVisibility$outboundSchema: + z.ZodNativeEnum<typeof TemplateCreateDocumentFromTemplateFolderVisibility> = + TemplateCreateDocumentFromTemplateFolderVisibility$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace TemplateCreateDocumentFromTemplateFolderVisibility$ { + /** @deprecated use `TemplateCreateDocumentFromTemplateFolderVisibility$inboundSchema` instead. */ + export const inboundSchema = + TemplateCreateDocumentFromTemplateFolderVisibility$inboundSchema; + /** @deprecated use `TemplateCreateDocumentFromTemplateFolderVisibility$outboundSchema` instead. */ + export const outboundSchema = + TemplateCreateDocumentFromTemplateFolderVisibility$outboundSchema; +} + +/** @internal */ +export const TemplateCreateDocumentFromTemplateFolder$inboundSchema: z.ZodType< + TemplateCreateDocumentFromTemplateFolder, + z.ZodTypeDef, + unknown +> = z.object({ + id: z.string(), + name: z.string(), + type: TemplateCreateDocumentFromTemplateFolderType$inboundSchema, + visibility: TemplateCreateDocumentFromTemplateFolderVisibility$inboundSchema, + userId: z.number(), + teamId: z.nullable(z.number()), + pinned: z.boolean(), + parentId: z.nullable(z.string()), + createdAt: z.string(), + updatedAt: z.string(), +}); + +/** @internal */ +export type TemplateCreateDocumentFromTemplateFolder$Outbound = { + id: string; + name: string; + type: string; + visibility: string; + userId: number; + teamId: number | null; + pinned: boolean; + parentId: string | null; + createdAt: string; + updatedAt: string; +}; + +/** @internal */ +export const TemplateCreateDocumentFromTemplateFolder$outboundSchema: z.ZodType< + TemplateCreateDocumentFromTemplateFolder$Outbound, + z.ZodTypeDef, + TemplateCreateDocumentFromTemplateFolder +> = z.object({ + id: z.string(), + name: z.string(), + type: TemplateCreateDocumentFromTemplateFolderType$outboundSchema, + visibility: TemplateCreateDocumentFromTemplateFolderVisibility$outboundSchema, + userId: z.number(), + teamId: z.nullable(z.number()), + pinned: z.boolean(), + parentId: z.nullable(z.string()), + createdAt: z.string(), + updatedAt: 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 TemplateCreateDocumentFromTemplateFolder$ { + /** @deprecated use `TemplateCreateDocumentFromTemplateFolder$inboundSchema` instead. */ + export const inboundSchema = + TemplateCreateDocumentFromTemplateFolder$inboundSchema; + /** @deprecated use `TemplateCreateDocumentFromTemplateFolder$outboundSchema` instead. */ + export const outboundSchema = + TemplateCreateDocumentFromTemplateFolder$outboundSchema; + /** @deprecated use `TemplateCreateDocumentFromTemplateFolder$Outbound` instead. */ + export type Outbound = TemplateCreateDocumentFromTemplateFolder$Outbound; +} + +export function templateCreateDocumentFromTemplateFolderToJSON( + templateCreateDocumentFromTemplateFolder: + TemplateCreateDocumentFromTemplateFolder, +): string { + return JSON.stringify( + TemplateCreateDocumentFromTemplateFolder$outboundSchema.parse( + templateCreateDocumentFromTemplateFolder, + ), + ); +} + +export function templateCreateDocumentFromTemplateFolderFromJSON( + jsonString: string, +): SafeParseResult< + TemplateCreateDocumentFromTemplateFolder, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + TemplateCreateDocumentFromTemplateFolder$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'TemplateCreateDocumentFromTemplateFolder' from JSON`, + ); +} + /** @internal */ export const TemplateCreateDocumentFromTemplateRole$inboundSchema: z.ZodNativeEnum<typeof TemplateCreateDocumentFromTemplateRole> = z.nativeEnum( @@ -4035,6 +4205,7 @@ export const TemplateCreateDocumentFromTemplateResponse$inboundSchema: deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), documentData: z.lazy(() => TemplateCreateDocumentFromTemplateDocumentData$inboundSchema ), @@ -4043,6 +4214,9 @@ export const TemplateCreateDocumentFromTemplateResponse$inboundSchema: TemplateCreateDocumentFromTemplateDocumentMeta$inboundSchema ), ), + folder: z.nullable( + z.lazy(() => TemplateCreateDocumentFromTemplateFolder$inboundSchema), + ), recipients: z.array( z.lazy(() => TemplateCreateDocumentFromTemplateRecipientResponse$inboundSchema @@ -4071,8 +4245,10 @@ export type TemplateCreateDocumentFromTemplateResponse$Outbound = { deletedAt: string | null; teamId: number | null; templateId: number | null; + folderId: string | null; documentData: TemplateCreateDocumentFromTemplateDocumentData$Outbound; documentMeta: TemplateCreateDocumentFromTemplateDocumentMeta$Outbound | null; + folder: TemplateCreateDocumentFromTemplateFolder$Outbound | null; recipients: Array< TemplateCreateDocumentFromTemplateRecipientResponse$Outbound >; @@ -4108,6 +4284,7 @@ export const TemplateCreateDocumentFromTemplateResponse$outboundSchema: deletedAt: z.nullable(z.string()), teamId: z.nullable(z.number()), templateId: z.nullable(z.number()), + folderId: z.nullable(z.string()), documentData: z.lazy(() => TemplateCreateDocumentFromTemplateDocumentData$outboundSchema ), @@ -4116,6 +4293,9 @@ export const TemplateCreateDocumentFromTemplateResponse$outboundSchema: TemplateCreateDocumentFromTemplateDocumentMeta$outboundSchema ), ), + folder: z.nullable( + z.lazy(() => TemplateCreateDocumentFromTemplateFolder$outboundSchema), + ), recipients: z.array( z.lazy(() => TemplateCreateDocumentFromTemplateRecipientResponse$outboundSchema diff --git a/src/models/operations/templateduplicatetemplate.ts b/src/models/operations/templateduplicatetemplate.ts index fe3802c6..2ec50247 100644 --- a/src/models/operations/templateduplicatetemplate.ts +++ b/src/models/operations/templateduplicatetemplate.ts @@ -85,6 +85,8 @@ export type TemplateDuplicateTemplateResponse = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -324,6 +326,8 @@ export const TemplateDuplicateTemplateResponse$inboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** @internal */ @@ -341,6 +345,8 @@ export type TemplateDuplicateTemplateResponse$Outbound = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -364,6 +370,8 @@ export const TemplateDuplicateTemplateResponse$outboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** diff --git a/src/models/operations/templatefindtemplates.ts b/src/models/operations/templatefindtemplates.ts index 39ad039d..24da9bf1 100644 --- a/src/models/operations/templatefindtemplates.ts +++ b/src/models/operations/templatefindtemplates.ts @@ -37,6 +37,10 @@ export type TemplateFindTemplatesRequest = { * Filter templates by type. */ type?: QueryParamType | undefined; + /** + * The ID of the folder to filter templates by. + */ + folderId?: string | undefined; }; export const TemplateFindTemplatesDataType = { @@ -525,6 +529,8 @@ export type TemplateFindTemplatesData = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; + useLegacyFieldInsertion: boolean; team: TemplateFindTemplatesTeam | null; fields: Array<TemplateFindTemplatesField>; recipients: Array<TemplateFindTemplatesRecipient>; @@ -586,6 +592,7 @@ export const TemplateFindTemplatesRequest$inboundSchema: z.ZodType< page: z.number().optional(), perPage: z.number().optional(), type: QueryParamType$inboundSchema.optional(), + folderId: z.string().optional(), }); /** @internal */ @@ -594,6 +601,7 @@ export type TemplateFindTemplatesRequest$Outbound = { page?: number | undefined; perPage?: number | undefined; type?: string | undefined; + folderId?: string | undefined; }; /** @internal */ @@ -606,6 +614,7 @@ export const TemplateFindTemplatesRequest$outboundSchema: z.ZodType< page: z.number().optional(), perPage: z.number().optional(), type: QueryParamType$outboundSchema.optional(), + folderId: z.string().optional(), }); /** @@ -2786,6 +2795,8 @@ export const TemplateFindTemplatesData$inboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), team: z.nullable(z.lazy(() => TemplateFindTemplatesTeam$inboundSchema)), fields: z.array(z.lazy(() => TemplateFindTemplatesField$inboundSchema)), recipients: z.array( @@ -2814,6 +2825,8 @@ export type TemplateFindTemplatesData$Outbound = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; + useLegacyFieldInsertion: boolean; team: TemplateFindTemplatesTeam$Outbound | null; fields: Array<TemplateFindTemplatesField$Outbound>; recipients: Array<TemplateFindTemplatesRecipient$Outbound>; @@ -2842,6 +2855,8 @@ export const TemplateFindTemplatesData$outboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), team: z.nullable(z.lazy(() => TemplateFindTemplatesTeam$outboundSchema)), fields: z.array(z.lazy(() => TemplateFindTemplatesField$outboundSchema)), recipients: z.array( diff --git a/src/models/operations/templategettemplatebyid.ts b/src/models/operations/templategettemplatebyid.ts index 25a18955..33fe03c1 100644 --- a/src/models/operations/templategettemplatebyid.ts +++ b/src/models/operations/templategettemplatebyid.ts @@ -549,6 +549,36 @@ export type TemplateGetTemplateByIdField = { | null; }; +export const TemplateGetTemplateByIdFolderType = { + Document: "DOCUMENT", + Template: "TEMPLATE", +} as const; +export type TemplateGetTemplateByIdFolderType = ClosedEnum< + typeof TemplateGetTemplateByIdFolderType +>; + +export const TemplateGetTemplateByIdFolderVisibility = { + Everyone: "EVERYONE", + ManagerAndAbove: "MANAGER_AND_ABOVE", + Admin: "ADMIN", +} as const; +export type TemplateGetTemplateByIdFolderVisibility = ClosedEnum< + typeof TemplateGetTemplateByIdFolderVisibility +>; + +export type TemplateGetTemplateByIdFolder = { + id: string; + name: string; + type: TemplateGetTemplateByIdFolderType; + visibility: TemplateGetTemplateByIdFolderVisibility; + userId: number; + teamId: number | null; + pinned: boolean; + parentId: string | null; + createdAt: string; + updatedAt: string; +}; + /** * Successful response */ @@ -566,12 +596,14 @@ export type TemplateGetTemplateByIdResponse = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; templateDocumentData: TemplateDocumentData; templateMeta: TemplateGetTemplateByIdTemplateMeta | null; directLink: TemplateGetTemplateByIdDirectLink | null; user: TemplateGetTemplateByIdUser; recipients: Array<TemplateGetTemplateByIdRecipient>; fields: Array<TemplateGetTemplateByIdField>; + folder: TemplateGetTemplateByIdFolder | null; }; /** @internal */ @@ -3018,6 +3050,134 @@ export function templateGetTemplateByIdFieldFromJSON( ); } +/** @internal */ +export const TemplateGetTemplateByIdFolderType$inboundSchema: z.ZodNativeEnum< + typeof TemplateGetTemplateByIdFolderType +> = z.nativeEnum(TemplateGetTemplateByIdFolderType); + +/** @internal */ +export const TemplateGetTemplateByIdFolderType$outboundSchema: z.ZodNativeEnum< + typeof TemplateGetTemplateByIdFolderType +> = TemplateGetTemplateByIdFolderType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace TemplateGetTemplateByIdFolderType$ { + /** @deprecated use `TemplateGetTemplateByIdFolderType$inboundSchema` instead. */ + export const inboundSchema = TemplateGetTemplateByIdFolderType$inboundSchema; + /** @deprecated use `TemplateGetTemplateByIdFolderType$outboundSchema` instead. */ + export const outboundSchema = + TemplateGetTemplateByIdFolderType$outboundSchema; +} + +/** @internal */ +export const TemplateGetTemplateByIdFolderVisibility$inboundSchema: + z.ZodNativeEnum<typeof TemplateGetTemplateByIdFolderVisibility> = z + .nativeEnum(TemplateGetTemplateByIdFolderVisibility); + +/** @internal */ +export const TemplateGetTemplateByIdFolderVisibility$outboundSchema: + z.ZodNativeEnum<typeof TemplateGetTemplateByIdFolderVisibility> = + TemplateGetTemplateByIdFolderVisibility$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace TemplateGetTemplateByIdFolderVisibility$ { + /** @deprecated use `TemplateGetTemplateByIdFolderVisibility$inboundSchema` instead. */ + export const inboundSchema = + TemplateGetTemplateByIdFolderVisibility$inboundSchema; + /** @deprecated use `TemplateGetTemplateByIdFolderVisibility$outboundSchema` instead. */ + export const outboundSchema = + TemplateGetTemplateByIdFolderVisibility$outboundSchema; +} + +/** @internal */ +export const TemplateGetTemplateByIdFolder$inboundSchema: z.ZodType< + TemplateGetTemplateByIdFolder, + z.ZodTypeDef, + unknown +> = z.object({ + id: z.string(), + name: z.string(), + type: TemplateGetTemplateByIdFolderType$inboundSchema, + visibility: TemplateGetTemplateByIdFolderVisibility$inboundSchema, + userId: z.number(), + teamId: z.nullable(z.number()), + pinned: z.boolean(), + parentId: z.nullable(z.string()), + createdAt: z.string(), + updatedAt: z.string(), +}); + +/** @internal */ +export type TemplateGetTemplateByIdFolder$Outbound = { + id: string; + name: string; + type: string; + visibility: string; + userId: number; + teamId: number | null; + pinned: boolean; + parentId: string | null; + createdAt: string; + updatedAt: string; +}; + +/** @internal */ +export const TemplateGetTemplateByIdFolder$outboundSchema: z.ZodType< + TemplateGetTemplateByIdFolder$Outbound, + z.ZodTypeDef, + TemplateGetTemplateByIdFolder +> = z.object({ + id: z.string(), + name: z.string(), + type: TemplateGetTemplateByIdFolderType$outboundSchema, + visibility: TemplateGetTemplateByIdFolderVisibility$outboundSchema, + userId: z.number(), + teamId: z.nullable(z.number()), + pinned: z.boolean(), + parentId: z.nullable(z.string()), + createdAt: z.string(), + updatedAt: 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 TemplateGetTemplateByIdFolder$ { + /** @deprecated use `TemplateGetTemplateByIdFolder$inboundSchema` instead. */ + export const inboundSchema = TemplateGetTemplateByIdFolder$inboundSchema; + /** @deprecated use `TemplateGetTemplateByIdFolder$outboundSchema` instead. */ + export const outboundSchema = TemplateGetTemplateByIdFolder$outboundSchema; + /** @deprecated use `TemplateGetTemplateByIdFolder$Outbound` instead. */ + export type Outbound = TemplateGetTemplateByIdFolder$Outbound; +} + +export function templateGetTemplateByIdFolderToJSON( + templateGetTemplateByIdFolder: TemplateGetTemplateByIdFolder, +): string { + return JSON.stringify( + TemplateGetTemplateByIdFolder$outboundSchema.parse( + templateGetTemplateByIdFolder, + ), + ); +} + +export function templateGetTemplateByIdFolderFromJSON( + jsonString: string, +): SafeParseResult<TemplateGetTemplateByIdFolder, SDKValidationError> { + return safeParse( + jsonString, + (x) => TemplateGetTemplateByIdFolder$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'TemplateGetTemplateByIdFolder' from JSON`, + ); +} + /** @internal */ export const TemplateGetTemplateByIdResponse$inboundSchema: z.ZodType< TemplateGetTemplateByIdResponse, @@ -3039,6 +3199,7 @@ export const TemplateGetTemplateByIdResponse$inboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), templateDocumentData: z.lazy(() => TemplateDocumentData$inboundSchema), templateMeta: z.nullable( z.lazy(() => TemplateGetTemplateByIdTemplateMeta$inboundSchema), @@ -3051,6 +3212,7 @@ export const TemplateGetTemplateByIdResponse$inboundSchema: z.ZodType< z.lazy(() => TemplateGetTemplateByIdRecipient$inboundSchema), ), fields: z.array(z.lazy(() => TemplateGetTemplateByIdField$inboundSchema)), + folder: z.nullable(z.lazy(() => TemplateGetTemplateByIdFolder$inboundSchema)), }); /** @internal */ @@ -3068,12 +3230,14 @@ export type TemplateGetTemplateByIdResponse$Outbound = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; templateDocumentData: TemplateDocumentData$Outbound; templateMeta: TemplateGetTemplateByIdTemplateMeta$Outbound | null; directLink: TemplateGetTemplateByIdDirectLink$Outbound | null; user: TemplateGetTemplateByIdUser$Outbound; recipients: Array<TemplateGetTemplateByIdRecipient$Outbound>; fields: Array<TemplateGetTemplateByIdField$Outbound>; + folder: TemplateGetTemplateByIdFolder$Outbound | null; }; /** @internal */ @@ -3097,6 +3261,7 @@ export const TemplateGetTemplateByIdResponse$outboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), templateDocumentData: z.lazy(() => TemplateDocumentData$outboundSchema), templateMeta: z.nullable( z.lazy(() => TemplateGetTemplateByIdTemplateMeta$outboundSchema), @@ -3109,6 +3274,9 @@ export const TemplateGetTemplateByIdResponse$outboundSchema: z.ZodType< z.lazy(() => TemplateGetTemplateByIdRecipient$outboundSchema), ), fields: z.array(z.lazy(() => TemplateGetTemplateByIdField$outboundSchema)), + folder: z.nullable( + z.lazy(() => TemplateGetTemplateByIdFolder$outboundSchema), + ), }); /** diff --git a/src/models/operations/templatemovetemplatetoteam.ts b/src/models/operations/templatemovetemplatetoteam.ts index 54ac1932..cdbbfb48 100644 --- a/src/models/operations/templatemovetemplatetoteam.ts +++ b/src/models/operations/templatemovetemplatetoteam.ts @@ -92,6 +92,8 @@ export type TemplateMoveTemplateToTeamResponse = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -336,6 +338,8 @@ export const TemplateMoveTemplateToTeamResponse$inboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** @internal */ @@ -353,6 +357,8 @@ export type TemplateMoveTemplateToTeamResponse$Outbound = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -376,6 +382,8 @@ export const TemplateMoveTemplateToTeamResponse$outboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** diff --git a/src/models/operations/templateupdatetemplate.ts b/src/models/operations/templateupdatetemplate.ts index 400bd0d2..93b40f8c 100644 --- a/src/models/operations/templateupdatetemplate.ts +++ b/src/models/operations/templateupdatetemplate.ts @@ -80,6 +80,7 @@ export type TemplateUpdateTemplateData = { */ publicDescription?: string | undefined; type?: TemplateUpdateTemplateDataType | undefined; + useLegacyFieldInsertion?: boolean | undefined; }; /** @@ -300,6 +301,8 @@ export type TemplateUpdateTemplateResponse = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -411,6 +414,7 @@ export const TemplateUpdateTemplateData$inboundSchema: z.ZodType< publicTitle: z.string().optional(), publicDescription: z.string().optional(), type: TemplateUpdateTemplateDataType$inboundSchema.optional(), + useLegacyFieldInsertion: z.boolean().optional(), }); /** @internal */ @@ -423,6 +427,7 @@ export type TemplateUpdateTemplateData$Outbound = { publicTitle?: string | undefined; publicDescription?: string | undefined; type?: string | undefined; + useLegacyFieldInsertion?: boolean | undefined; }; /** @internal */ @@ -444,6 +449,7 @@ export const TemplateUpdateTemplateData$outboundSchema: z.ZodType< publicTitle: z.string().optional(), publicDescription: z.string().optional(), type: TemplateUpdateTemplateDataType$outboundSchema.optional(), + useLegacyFieldInsertion: z.boolean().optional(), }); /** @@ -978,6 +984,8 @@ export const TemplateUpdateTemplateResponse$inboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** @internal */ @@ -995,6 +1003,8 @@ export type TemplateUpdateTemplateResponse$Outbound = { updatedAt: string; publicTitle: string; publicDescription: string; + folderId: string | null; + useLegacyFieldInsertion: boolean; }; /** @internal */ @@ -1018,6 +1028,8 @@ export const TemplateUpdateTemplateResponse$outboundSchema: z.ZodType< updatedAt: z.string(), publicTitle: z.string(), publicDescription: z.string(), + folderId: z.nullable(z.string()), + useLegacyFieldInsertion: z.boolean(), }); /** diff --git a/src/sdk/embedding.ts b/src/sdk/embedding.ts new file mode 100644 index 00000000..1681543e --- /dev/null +++ b/src/sdk/embedding.ts @@ -0,0 +1,45 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { embeddingEmbeddingPresignCreateEmbeddingPresignToken } from "../funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.js"; +import { embeddingEmbeddingPresignVerifyEmbeddingPresignToken } from "../funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.js"; +import { ClientSDK, RequestOptions } from "../lib/sdks.js"; +import * as operations from "../models/operations/index.js"; +import { unwrapAsync } from "../types/fp.js"; + +export class Embedding extends ClientSDK { + /** + * Create embedding presign token + * + * @remarks + * Creates a presign token for embedding operations with configurable expiration time + */ + async embeddingPresignCreateEmbeddingPresignToken( + request: operations.EmbeddingPresignCreateEmbeddingPresignTokenRequest, + options?: RequestOptions, + ): Promise<operations.EmbeddingPresignCreateEmbeddingPresignTokenResponse> { + return unwrapAsync(embeddingEmbeddingPresignCreateEmbeddingPresignToken( + this, + request, + options, + )); + } + + /** + * Verify embedding presign token + * + * @remarks + * Verifies a presign token for embedding operations and returns the associated API token + */ + async embeddingPresignVerifyEmbeddingPresignToken( + request: operations.EmbeddingPresignVerifyEmbeddingPresignTokenRequest, + options?: RequestOptions, + ): Promise<operations.EmbeddingPresignVerifyEmbeddingPresignTokenResponse> { + return unwrapAsync(embeddingEmbeddingPresignVerifyEmbeddingPresignToken( + this, + request, + options, + )); + } +} diff --git a/src/sdk/sdk.ts b/src/sdk/sdk.ts index 79298997..3c10241e 100644 --- a/src/sdk/sdk.ts +++ b/src/sdk/sdk.ts @@ -4,6 +4,7 @@ import { ClientSDK } from "../lib/sdks.js"; import { Documents } from "./documents.js"; +import { Embedding } from "./embedding.js"; import { Templates } from "./templates.js"; export class Documenso extends ClientSDK { @@ -16,4 +17,9 @@ export class Documenso extends ClientSDK { get templates(): Templates { return (this._templates ??= new Templates(this._options)); } + + private _embedding?: Embedding; + get embedding(): Embedding { + return (this._embedding ??= new Embedding(this._options)); + } } From bbc776b389b09bf89b09adc5fa077cb2322f237b Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Tue, 6 May 2025 00:25:43 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow