@factify/sdk 0.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +91 -0
- package/README.md +603 -0
- package/RUNTIMES.md +48 -0
- package/_speakeasy/.github/action-inputs-config.json +53 -0
- package/_speakeasy/.github/action-security-config.json +88 -0
- package/dist/commonjs/core.d.ts +10 -0
- package/dist/commonjs/core.d.ts.map +1 -0
- package/dist/commonjs/core.js +17 -0
- package/dist/commonjs/core.js.map +1 -0
- package/dist/commonjs/funcs/documentsCreate.d.ts +19 -0
- package/dist/commonjs/funcs/documentsCreate.d.ts.map +1 -0
- package/dist/commonjs/funcs/documentsCreate.js +146 -0
- package/dist/commonjs/funcs/documentsCreate.js.map +1 -0
- package/dist/commonjs/funcs/documentsGet.d.ts +18 -0
- package/dist/commonjs/funcs/documentsGet.d.ts.map +1 -0
- package/dist/commonjs/funcs/documentsGet.js +126 -0
- package/dist/commonjs/funcs/documentsGet.js.map +1 -0
- package/dist/commonjs/funcs/documentsList.d.ts +21 -0
- package/dist/commonjs/funcs/documentsList.d.ts.map +1 -0
- package/dist/commonjs/funcs/documentsList.js +151 -0
- package/dist/commonjs/funcs/documentsList.js.map +1 -0
- package/dist/commonjs/funcs/documentsUpdate.d.ts +18 -0
- package/dist/commonjs/funcs/documentsUpdate.d.ts.map +1 -0
- package/dist/commonjs/funcs/documentsUpdate.js +127 -0
- package/dist/commonjs/funcs/documentsUpdate.js.map +1 -0
- package/dist/commonjs/funcs/entryPagesGenerate.d.ts +18 -0
- package/dist/commonjs/funcs/entryPagesGenerate.d.ts.map +1 -0
- package/dist/commonjs/funcs/entryPagesGenerate.js +126 -0
- package/dist/commonjs/funcs/entryPagesGenerate.js.map +1 -0
- package/dist/commonjs/funcs/policiesAttach.d.ts +18 -0
- package/dist/commonjs/funcs/policiesAttach.d.ts.map +1 -0
- package/dist/commonjs/funcs/policiesAttach.js +127 -0
- package/dist/commonjs/funcs/policiesAttach.js.map +1 -0
- package/dist/commonjs/funcs/policiesDetach.d.ts +18 -0
- package/dist/commonjs/funcs/policiesDetach.d.ts.map +1 -0
- package/dist/commonjs/funcs/policiesDetach.js +130 -0
- package/dist/commonjs/funcs/policiesDetach.js.map +1 -0
- package/dist/commonjs/funcs/policiesList.d.ts +21 -0
- package/dist/commonjs/funcs/policiesList.d.ts.map +1 -0
- package/dist/commonjs/funcs/policiesList.js +156 -0
- package/dist/commonjs/funcs/policiesList.js.map +1 -0
- package/dist/commonjs/funcs/versionsCreate.d.ts +18 -0
- package/dist/commonjs/funcs/versionsCreate.d.ts.map +1 -0
- package/dist/commonjs/funcs/versionsCreate.js +153 -0
- package/dist/commonjs/funcs/versionsCreate.js.map +1 -0
- package/dist/commonjs/funcs/versionsGet.d.ts +18 -0
- package/dist/commonjs/funcs/versionsGet.d.ts.map +1 -0
- package/dist/commonjs/funcs/versionsGet.js +130 -0
- package/dist/commonjs/funcs/versionsGet.js.map +1 -0
- package/dist/commonjs/funcs/versionsList.d.ts +21 -0
- package/dist/commonjs/funcs/versionsList.d.ts.map +1 -0
- package/dist/commonjs/funcs/versionsList.js +156 -0
- package/dist/commonjs/funcs/versionsList.js.map +1 -0
- package/dist/commonjs/funcs/versionsUpdate.d.ts +18 -0
- package/dist/commonjs/funcs/versionsUpdate.d.ts.map +1 -0
- package/dist/commonjs/funcs/versionsUpdate.js +131 -0
- package/dist/commonjs/funcs/versionsUpdate.js.map +1 -0
- package/dist/commonjs/hooks/hooks.d.ts +25 -0
- package/dist/commonjs/hooks/hooks.d.ts.map +1 -0
- package/dist/commonjs/hooks/hooks.js +86 -0
- package/dist/commonjs/hooks/hooks.js.map +1 -0
- package/dist/commonjs/hooks/index.d.ts +3 -0
- package/dist/commonjs/hooks/index.d.ts.map +1 -0
- package/dist/commonjs/hooks/index.js +22 -0
- package/dist/commonjs/hooks/index.js.map +1 -0
- package/dist/commonjs/hooks/registration.d.ts +3 -0
- package/dist/commonjs/hooks/registration.d.ts.map +1 -0
- package/dist/commonjs/hooks/registration.js +15 -0
- package/dist/commonjs/hooks/registration.js.map +1 -0
- package/dist/commonjs/hooks/types.d.ts +76 -0
- package/dist/commonjs/hooks/types.d.ts.map +1 -0
- package/dist/commonjs/hooks/types.js +6 -0
- package/dist/commonjs/hooks/types.js.map +1 -0
- package/dist/commonjs/index.d.ts +6 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +48 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/lib/base64.d.ts +10 -0
- package/dist/commonjs/lib/base64.d.ts.map +1 -0
- package/dist/commonjs/lib/base64.js +73 -0
- package/dist/commonjs/lib/base64.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +38 -0
- package/dist/commonjs/lib/config.d.ts.map +1 -0
- package/dist/commonjs/lib/config.js +42 -0
- package/dist/commonjs/lib/config.js.map +1 -0
- package/dist/commonjs/lib/dlv.d.ts +14 -0
- package/dist/commonjs/lib/dlv.d.ts.map +1 -0
- package/dist/commonjs/lib/dlv.js +49 -0
- package/dist/commonjs/lib/dlv.js.map +1 -0
- package/dist/commonjs/lib/encodings.d.ts +53 -0
- package/dist/commonjs/lib/encodings.d.ts.map +1 -0
- package/dist/commonjs/lib/encodings.js +384 -0
- package/dist/commonjs/lib/encodings.js.map +1 -0
- package/dist/commonjs/lib/files.d.ts +13 -0
- package/dist/commonjs/lib/files.d.ts.map +1 -0
- package/dist/commonjs/lib/files.js +77 -0
- package/dist/commonjs/lib/files.js.map +1 -0
- package/dist/commonjs/lib/http.d.ts +67 -0
- package/dist/commonjs/lib/http.d.ts.map +1 -0
- package/dist/commonjs/lib/http.js +217 -0
- package/dist/commonjs/lib/http.js.map +1 -0
- package/dist/commonjs/lib/is-plain-object.d.ts +2 -0
- package/dist/commonjs/lib/is-plain-object.d.ts.map +1 -0
- package/dist/commonjs/lib/is-plain-object.js +41 -0
- package/dist/commonjs/lib/is-plain-object.js.map +1 -0
- package/dist/commonjs/lib/logger.d.ts +6 -0
- package/dist/commonjs/lib/logger.d.ts.map +1 -0
- package/dist/commonjs/lib/logger.js +6 -0
- package/dist/commonjs/lib/logger.js.map +1 -0
- package/dist/commonjs/lib/matchers.d.ts +59 -0
- package/dist/commonjs/lib/matchers.d.ts.map +1 -0
- package/dist/commonjs/lib/matchers.js +218 -0
- package/dist/commonjs/lib/matchers.js.map +1 -0
- package/dist/commonjs/lib/primitives.d.ts +26 -0
- package/dist/commonjs/lib/primitives.d.ts.map +1 -0
- package/dist/commonjs/lib/primitives.js +111 -0
- package/dist/commonjs/lib/primitives.js.map +1 -0
- package/dist/commonjs/lib/retries.d.ts +38 -0
- package/dist/commonjs/lib/retries.d.ts.map +1 -0
- package/dist/commonjs/lib/retries.js +153 -0
- package/dist/commonjs/lib/retries.js.map +1 -0
- package/dist/commonjs/lib/schemas.d.ts +21 -0
- package/dist/commonjs/lib/schemas.d.ts.map +1 -0
- package/dist/commonjs/lib/schemas.js +95 -0
- package/dist/commonjs/lib/schemas.js.map +1 -0
- package/dist/commonjs/lib/sdks.d.ts +63 -0
- package/dist/commonjs/lib/sdks.d.ts.map +1 -0
- package/dist/commonjs/lib/sdks.js +269 -0
- package/dist/commonjs/lib/sdks.js.map +1 -0
- package/dist/commonjs/lib/security.d.ts +83 -0
- package/dist/commonjs/lib/security.d.ts.map +1 -0
- package/dist/commonjs/lib/security.js +143 -0
- package/dist/commonjs/lib/security.js.map +1 -0
- package/dist/commonjs/lib/url.d.ts +5 -0
- package/dist/commonjs/lib/url.d.ts.map +1 -0
- package/dist/commonjs/lib/url.js +25 -0
- package/dist/commonjs/lib/url.js.map +1 -0
- package/dist/commonjs/models/components/accesslevel.d.ts +13 -0
- package/dist/commonjs/models/components/accesslevel.d.ts.map +1 -0
- package/dist/commonjs/models/components/accesslevel.js +50 -0
- package/dist/commonjs/models/components/accesslevel.js.map +1 -0
- package/dist/commonjs/models/components/createdocumentrequest.d.ts +43 -0
- package/dist/commonjs/models/components/createdocumentrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/createdocumentrequest.js +76 -0
- package/dist/commonjs/models/components/createdocumentrequest.js.map +1 -0
- package/dist/commonjs/models/components/createdocumentresponse.d.ts +17 -0
- package/dist/commonjs/models/components/createdocumentresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/createdocumentresponse.js +52 -0
- package/dist/commonjs/models/components/createdocumentresponse.js.map +1 -0
- package/dist/commonjs/models/components/createversionrequest.d.ts +48 -0
- package/dist/commonjs/models/components/createversionrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/createversionrequest.js +75 -0
- package/dist/commonjs/models/components/createversionrequest.js.map +1 -0
- package/dist/commonjs/models/components/document.d.ts +49 -0
- package/dist/commonjs/models/components/document.d.ts.map +1 -0
- package/dist/commonjs/models/components/document.js +72 -0
- package/dist/commonjs/models/components/document.js.map +1 -0
- package/dist/commonjs/models/components/documentpolicy.d.ts +33 -0
- package/dist/commonjs/models/components/documentpolicy.d.ts.map +1 -0
- package/dist/commonjs/models/components/documentpolicy.js +63 -0
- package/dist/commonjs/models/components/documentpolicy.js.map +1 -0
- package/dist/commonjs/models/components/empty.d.ts +19 -0
- package/dist/commonjs/models/components/empty.d.ts.map +1 -0
- package/dist/commonjs/models/components/empty.js +48 -0
- package/dist/commonjs/models/components/empty.js.map +1 -0
- package/dist/commonjs/models/components/error.d.ts +47 -0
- package/dist/commonjs/models/components/error.d.ts.map +1 -0
- package/dist/commonjs/models/components/error.js +75 -0
- package/dist/commonjs/models/components/error.js.map +1 -0
- package/dist/commonjs/models/components/generateentrypageresponse.d.ts +16 -0
- package/dist/commonjs/models/components/generateentrypageresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/generateentrypageresponse.js +56 -0
- package/dist/commonjs/models/components/generateentrypageresponse.js.map +1 -0
- package/dist/commonjs/models/components/getdocumentresponse.d.ts +17 -0
- package/dist/commonjs/models/components/getdocumentresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/getdocumentresponse.js +52 -0
- package/dist/commonjs/models/components/getdocumentresponse.js.map +1 -0
- package/dist/commonjs/models/components/httpmetadata.d.ts +17 -0
- package/dist/commonjs/models/components/httpmetadata.d.ts.map +1 -0
- package/dist/commonjs/models/components/httpmetadata.js +57 -0
- package/dist/commonjs/models/components/httpmetadata.js.map +1 -0
- package/dist/commonjs/models/components/index.d.ts +24 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -0
- package/dist/commonjs/models/components/index.js +43 -0
- package/dist/commonjs/models/components/index.js.map +1 -0
- package/dist/commonjs/models/components/listdocumentpoliciesresponse.d.ts +25 -0
- package/dist/commonjs/models/components/listdocumentpoliciesresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/listdocumentpoliciesresponse.js +54 -0
- package/dist/commonjs/models/components/listdocumentpoliciesresponse.js.map +1 -0
- package/dist/commonjs/models/components/listdocumentsresponse.d.ts +25 -0
- package/dist/commonjs/models/components/listdocumentsresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/listdocumentsresponse.js +54 -0
- package/dist/commonjs/models/components/listdocumentsresponse.js.map +1 -0
- package/dist/commonjs/models/components/listversionsresponse.d.ts +25 -0
- package/dist/commonjs/models/components/listversionsresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/listversionsresponse.js +54 -0
- package/dist/commonjs/models/components/listversionsresponse.js.map +1 -0
- package/dist/commonjs/models/components/pagination.d.ts +33 -0
- package/dist/commonjs/models/components/pagination.d.ts.map +1 -0
- package/dist/commonjs/models/components/pagination.js +61 -0
- package/dist/commonjs/models/components/pagination.js.map +1 -0
- package/dist/commonjs/models/components/policy.d.ts +27 -0
- package/dist/commonjs/models/components/policy.d.ts.map +1 -0
- package/dist/commonjs/models/components/policy.js +58 -0
- package/dist/commonjs/models/components/policy.js.map +1 -0
- package/dist/commonjs/models/components/processingstatus.d.ts +11 -0
- package/dist/commonjs/models/components/processingstatus.d.ts.map +1 -0
- package/dist/commonjs/models/components/processingstatus.js +48 -0
- package/dist/commonjs/models/components/processingstatus.js.map +1 -0
- package/dist/commonjs/models/components/security.d.ts +12 -0
- package/dist/commonjs/models/components/security.d.ts.map +1 -0
- package/dist/commonjs/models/components/security.js +49 -0
- package/dist/commonjs/models/components/security.js.map +1 -0
- package/dist/commonjs/models/components/updatedocumentresponse.d.ts +17 -0
- package/dist/commonjs/models/components/updatedocumentresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/updatedocumentresponse.js +52 -0
- package/dist/commonjs/models/components/updatedocumentresponse.js.map +1 -0
- package/dist/commonjs/models/components/user.d.ts +25 -0
- package/dist/commonjs/models/components/user.d.ts.map +1 -0
- package/dist/commonjs/models/components/user.js +54 -0
- package/dist/commonjs/models/components/user.js.map +1 -0
- package/dist/commonjs/models/components/usertype.d.ts +10 -0
- package/dist/commonjs/models/components/usertype.d.ts.map +1 -0
- package/dist/commonjs/models/components/usertype.js +47 -0
- package/dist/commonjs/models/components/usertype.js.map +1 -0
- package/dist/commonjs/models/components/version.d.ts +49 -0
- package/dist/commonjs/models/components/version.d.ts.map +1 -0
- package/dist/commonjs/models/components/version.js +68 -0
- package/dist/commonjs/models/components/version.js.map +1 -0
- package/dist/commonjs/models/components/versionref.d.ts +19 -0
- package/dist/commonjs/models/components/versionref.d.ts.map +1 -0
- package/dist/commonjs/models/components/versionref.js +52 -0
- package/dist/commonjs/models/components/versionref.js.map +1 -0
- package/dist/commonjs/models/errors/error.d.ts +26 -0
- package/dist/commonjs/models/errors/error.d.ts.map +1 -0
- package/dist/commonjs/models/errors/error.js +75 -0
- package/dist/commonjs/models/errors/error.js.map +1 -0
- package/dist/commonjs/models/errors/factifydefaulterror.d.ts +10 -0
- package/dist/commonjs/models/errors/factifydefaulterror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/factifydefaulterror.js +34 -0
- package/dist/commonjs/models/errors/factifydefaulterror.js.map +1 -0
- package/dist/commonjs/models/errors/factifyerror.d.ts +15 -0
- package/dist/commonjs/models/errors/factifyerror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/factifyerror.js +16 -0
- package/dist/commonjs/models/errors/factifyerror.js.map +1 -0
- package/dist/commonjs/models/errors/httpclienterrors.d.ts +44 -0
- package/dist/commonjs/models/errors/httpclienterrors.d.ts.map +1 -0
- package/dist/commonjs/models/errors/httpclienterrors.js +78 -0
- package/dist/commonjs/models/errors/httpclienterrors.js.map +1 -0
- package/dist/commonjs/models/errors/index.d.ts +7 -0
- package/dist/commonjs/models/errors/index.d.ts.map +1 -0
- package/dist/commonjs/models/errors/index.js +26 -0
- package/dist/commonjs/models/errors/index.js.map +1 -0
- package/dist/commonjs/models/errors/responsevalidationerror.d.ts +26 -0
- package/dist/commonjs/models/errors/responsevalidationerror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/responsevalidationerror.js +66 -0
- package/dist/commonjs/models/errors/responsevalidationerror.js.map +1 -0
- package/dist/commonjs/models/errors/sdkvalidationerror.d.ts +21 -0
- package/dist/commonjs/models/errors/sdkvalidationerror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/sdkvalidationerror.js +82 -0
- package/dist/commonjs/models/errors/sdkvalidationerror.js.map +1 -0
- package/dist/commonjs/models/operations/attachdocumentpolicy.d.ts +55 -0
- package/dist/commonjs/models/operations/attachdocumentpolicy.d.ts.map +1 -0
- package/dist/commonjs/models/operations/attachdocumentpolicy.js +86 -0
- package/dist/commonjs/models/operations/attachdocumentpolicy.js.map +1 -0
- package/dist/commonjs/models/operations/createdocument.d.ts +18 -0
- package/dist/commonjs/models/operations/createdocument.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createdocument.js +61 -0
- package/dist/commonjs/models/operations/createdocument.js.map +1 -0
- package/dist/commonjs/models/operations/createdocumentversion.d.ts +36 -0
- package/dist/commonjs/models/operations/createdocumentversion.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createdocumentversion.js +74 -0
- package/dist/commonjs/models/operations/createdocumentversion.js.map +1 -0
- package/dist/commonjs/models/operations/detachdocumentpolicy.d.ts +42 -0
- package/dist/commonjs/models/operations/detachdocumentpolicy.d.ts.map +1 -0
- package/dist/commonjs/models/operations/detachdocumentpolicy.js +75 -0
- package/dist/commonjs/models/operations/detachdocumentpolicy.js.map +1 -0
- package/dist/commonjs/models/operations/generatedocumententrypage.d.ts +34 -0
- package/dist/commonjs/models/operations/generatedocumententrypage.d.ts.map +1 -0
- package/dist/commonjs/models/operations/generatedocumententrypage.js +73 -0
- package/dist/commonjs/models/operations/generatedocumententrypage.js.map +1 -0
- package/dist/commonjs/models/operations/getdocument.d.ts +34 -0
- package/dist/commonjs/models/operations/getdocument.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getdocument.js +73 -0
- package/dist/commonjs/models/operations/getdocument.js.map +1 -0
- package/dist/commonjs/models/operations/getdocumentversion.d.ts +42 -0
- package/dist/commonjs/models/operations/getdocumentversion.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getdocumentversion.js +75 -0
- package/dist/commonjs/models/operations/getdocumentversion.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +13 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -0
- package/dist/commonjs/models/operations/index.js +32 -0
- package/dist/commonjs/models/operations/index.js.map +1 -0
- package/dist/commonjs/models/operations/listdocumentpolicies.d.ts +48 -0
- package/dist/commonjs/models/operations/listdocumentpolicies.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listdocumentpolicies.js +77 -0
- package/dist/commonjs/models/operations/listdocumentpolicies.js.map +1 -0
- package/dist/commonjs/models/operations/listdocuments.d.ts +45 -0
- package/dist/commonjs/models/operations/listdocuments.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listdocuments.js +77 -0
- package/dist/commonjs/models/operations/listdocuments.js.map +1 -0
- package/dist/commonjs/models/operations/listdocumentversions.d.ts +48 -0
- package/dist/commonjs/models/operations/listdocumentversions.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listdocumentversions.js +77 -0
- package/dist/commonjs/models/operations/listdocumentversions.js.map +1 -0
- package/dist/commonjs/models/operations/updatedocument.d.ts +57 -0
- package/dist/commonjs/models/operations/updatedocument.d.ts.map +1 -0
- package/dist/commonjs/models/operations/updatedocument.js +83 -0
- package/dist/commonjs/models/operations/updatedocument.js.map +1 -0
- package/dist/commonjs/models/operations/updatedocumentversion.d.ts +65 -0
- package/dist/commonjs/models/operations/updatedocumentversion.d.ts.map +1 -0
- package/dist/commonjs/models/operations/updatedocumentversion.js +85 -0
- package/dist/commonjs/models/operations/updatedocumentversion.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/sdk/documents.d.ts +37 -0
- package/dist/commonjs/sdk/documents.d.ts.map +1 -0
- package/dist/commonjs/sdk/documents.js +53 -0
- package/dist/commonjs/sdk/documents.js.map +1 -0
- package/dist/commonjs/sdk/entrypages.d.ts +12 -0
- package/dist/commonjs/sdk/entrypages.d.ts.map +1 -0
- package/dist/commonjs/sdk/entrypages.js +22 -0
- package/dist/commonjs/sdk/entrypages.js.map +1 -0
- package/dist/commonjs/sdk/index.d.ts +2 -0
- package/dist/commonjs/sdk/index.d.ts.map +1 -0
- package/dist/commonjs/sdk/index.js +21 -0
- package/dist/commonjs/sdk/index.js.map +1 -0
- package/dist/commonjs/sdk/policies.d.ts +29 -0
- package/dist/commonjs/sdk/policies.d.ts.map +1 -0
- package/dist/commonjs/sdk/policies.js +43 -0
- package/dist/commonjs/sdk/policies.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +16 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -0
- package/dist/commonjs/sdk/sdk.js +27 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -0
- package/dist/commonjs/sdk/versions.d.ts +36 -0
- package/dist/commonjs/sdk/versions.d.ts.map +1 -0
- package/dist/commonjs/sdk/versions.js +53 -0
- package/dist/commonjs/sdk/versions.js.map +1 -0
- package/dist/commonjs/types/async.d.ts +23 -0
- package/dist/commonjs/types/async.d.ts.map +1 -0
- package/dist/commonjs/types/async.js +44 -0
- package/dist/commonjs/types/async.js.map +1 -0
- package/dist/commonjs/types/blobs.d.ts +4 -0
- package/dist/commonjs/types/blobs.d.ts.map +1 -0
- package/dist/commonjs/types/blobs.js +62 -0
- package/dist/commonjs/types/blobs.js.map +1 -0
- package/dist/commonjs/types/constdatetime.d.ts +3 -0
- package/dist/commonjs/types/constdatetime.d.ts.map +1 -0
- package/dist/commonjs/types/constdatetime.js +46 -0
- package/dist/commonjs/types/constdatetime.js.map +1 -0
- package/dist/commonjs/types/defaultToZeroValue.d.ts +12 -0
- package/dist/commonjs/types/defaultToZeroValue.d.ts.map +1 -0
- package/dist/commonjs/types/defaultToZeroValue.js +35 -0
- package/dist/commonjs/types/defaultToZeroValue.js.map +1 -0
- package/dist/commonjs/types/enums.d.ts +9 -0
- package/dist/commonjs/types/enums.d.ts.map +1 -0
- package/dist/commonjs/types/enums.js +66 -0
- package/dist/commonjs/types/enums.js.map +1 -0
- package/dist/commonjs/types/fp.d.ts +31 -0
- package/dist/commonjs/types/fp.d.ts.map +1 -0
- package/dist/commonjs/types/fp.js +37 -0
- package/dist/commonjs/types/fp.js.map +1 -0
- package/dist/commonjs/types/index.d.ts +10 -0
- package/dist/commonjs/types/index.d.ts.map +1 -0
- package/dist/commonjs/types/index.js +31 -0
- package/dist/commonjs/types/index.js.map +1 -0
- package/dist/commonjs/types/operations.d.ts +27 -0
- package/dist/commonjs/types/operations.d.ts.map +1 -0
- package/dist/commonjs/types/operations.js +83 -0
- package/dist/commonjs/types/operations.js.map +1 -0
- package/dist/commonjs/types/primitives.d.ts +11 -0
- package/dist/commonjs/types/primitives.d.ts.map +1 -0
- package/dist/commonjs/types/primitives.js +176 -0
- package/dist/commonjs/types/primitives.js.map +1 -0
- package/dist/commonjs/types/rfcdate.d.ts +21 -0
- package/dist/commonjs/types/rfcdate.d.ts.map +1 -0
- package/dist/commonjs/types/rfcdate.js +46 -0
- package/dist/commonjs/types/rfcdate.js.map +1 -0
- package/dist/commonjs/types/smartUnion.d.ts +7 -0
- package/dist/commonjs/types/smartUnion.d.ts.map +1 -0
- package/dist/commonjs/types/smartUnion.js +146 -0
- package/dist/commonjs/types/smartUnion.js.map +1 -0
- package/dist/commonjs/types/streams.d.ts +2 -0
- package/dist/commonjs/types/streams.d.ts.map +1 -0
- package/dist/commonjs/types/streams.js +18 -0
- package/dist/commonjs/types/streams.js.map +1 -0
- package/dist/commonjs/types/unrecognized.d.ts +16 -0
- package/dist/commonjs/types/unrecognized.d.ts.map +1 -0
- package/dist/commonjs/types/unrecognized.js +34 -0
- package/dist/commonjs/types/unrecognized.js.map +1 -0
- package/dist/esm/core.d.ts +10 -0
- package/dist/esm/core.d.ts.map +1 -0
- package/dist/esm/core.js +13 -0
- package/dist/esm/core.js.map +1 -0
- package/dist/esm/funcs/documentsCreate.d.ts +19 -0
- package/dist/esm/funcs/documentsCreate.d.ts.map +1 -0
- package/dist/esm/funcs/documentsCreate.js +110 -0
- package/dist/esm/funcs/documentsCreate.js.map +1 -0
- package/dist/esm/funcs/documentsGet.d.ts +18 -0
- package/dist/esm/funcs/documentsGet.d.ts.map +1 -0
- package/dist/esm/funcs/documentsGet.js +90 -0
- package/dist/esm/funcs/documentsGet.js.map +1 -0
- package/dist/esm/funcs/documentsList.d.ts +21 -0
- package/dist/esm/funcs/documentsList.d.ts.map +1 -0
- package/dist/esm/funcs/documentsList.js +115 -0
- package/dist/esm/funcs/documentsList.js.map +1 -0
- package/dist/esm/funcs/documentsUpdate.d.ts +18 -0
- package/dist/esm/funcs/documentsUpdate.d.ts.map +1 -0
- package/dist/esm/funcs/documentsUpdate.js +91 -0
- package/dist/esm/funcs/documentsUpdate.js.map +1 -0
- package/dist/esm/funcs/entryPagesGenerate.d.ts +18 -0
- package/dist/esm/funcs/entryPagesGenerate.d.ts.map +1 -0
- package/dist/esm/funcs/entryPagesGenerate.js +90 -0
- package/dist/esm/funcs/entryPagesGenerate.js.map +1 -0
- package/dist/esm/funcs/policiesAttach.d.ts +18 -0
- package/dist/esm/funcs/policiesAttach.d.ts.map +1 -0
- package/dist/esm/funcs/policiesAttach.js +91 -0
- package/dist/esm/funcs/policiesAttach.js.map +1 -0
- package/dist/esm/funcs/policiesDetach.d.ts +18 -0
- package/dist/esm/funcs/policiesDetach.d.ts.map +1 -0
- package/dist/esm/funcs/policiesDetach.js +94 -0
- package/dist/esm/funcs/policiesDetach.js.map +1 -0
- package/dist/esm/funcs/policiesList.d.ts +21 -0
- package/dist/esm/funcs/policiesList.d.ts.map +1 -0
- package/dist/esm/funcs/policiesList.js +120 -0
- package/dist/esm/funcs/policiesList.js.map +1 -0
- package/dist/esm/funcs/versionsCreate.d.ts +18 -0
- package/dist/esm/funcs/versionsCreate.d.ts.map +1 -0
- package/dist/esm/funcs/versionsCreate.js +117 -0
- package/dist/esm/funcs/versionsCreate.js.map +1 -0
- package/dist/esm/funcs/versionsGet.d.ts +18 -0
- package/dist/esm/funcs/versionsGet.d.ts.map +1 -0
- package/dist/esm/funcs/versionsGet.js +94 -0
- package/dist/esm/funcs/versionsGet.js.map +1 -0
- package/dist/esm/funcs/versionsList.d.ts +21 -0
- package/dist/esm/funcs/versionsList.d.ts.map +1 -0
- package/dist/esm/funcs/versionsList.js +120 -0
- package/dist/esm/funcs/versionsList.js.map +1 -0
- package/dist/esm/funcs/versionsUpdate.d.ts +18 -0
- package/dist/esm/funcs/versionsUpdate.d.ts.map +1 -0
- package/dist/esm/funcs/versionsUpdate.js +95 -0
- package/dist/esm/funcs/versionsUpdate.js.map +1 -0
- package/dist/esm/hooks/hooks.d.ts +25 -0
- package/dist/esm/hooks/hooks.d.ts.map +1 -0
- package/dist/esm/hooks/hooks.js +82 -0
- package/dist/esm/hooks/hooks.js.map +1 -0
- package/dist/esm/hooks/index.d.ts +3 -0
- package/dist/esm/hooks/index.d.ts.map +1 -0
- package/dist/esm/hooks/index.js +6 -0
- package/dist/esm/hooks/index.js.map +1 -0
- package/dist/esm/hooks/registration.d.ts +3 -0
- package/dist/esm/hooks/registration.d.ts.map +1 -0
- package/dist/esm/hooks/registration.js +12 -0
- package/dist/esm/hooks/registration.js.map +1 -0
- package/dist/esm/hooks/types.d.ts +76 -0
- package/dist/esm/hooks/types.d.ts.map +1 -0
- package/dist/esm/hooks/types.js +5 -0
- package/dist/esm/hooks/types.js.map +1 -0
- package/dist/esm/index.d.ts +6 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +8 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/lib/base64.d.ts +10 -0
- package/dist/esm/lib/base64.d.ts.map +1 -0
- package/dist/esm/lib/base64.js +31 -0
- package/dist/esm/lib/base64.js.map +1 -0
- package/dist/esm/lib/config.d.ts +38 -0
- package/dist/esm/lib/config.d.ts.map +1 -0
- package/dist/esm/lib/config.js +38 -0
- package/dist/esm/lib/config.js.map +1 -0
- package/dist/esm/lib/dlv.d.ts +14 -0
- package/dist/esm/lib/dlv.d.ts.map +1 -0
- package/dist/esm/lib/dlv.js +46 -0
- package/dist/esm/lib/dlv.js.map +1 -0
- package/dist/esm/lib/encodings.d.ts +53 -0
- package/dist/esm/lib/encodings.d.ts.map +1 -0
- package/dist/esm/lib/encodings.js +370 -0
- package/dist/esm/lib/encodings.js.map +1 -0
- package/dist/esm/lib/files.d.ts +13 -0
- package/dist/esm/lib/files.d.ts.map +1 -0
- package/dist/esm/lib/files.js +73 -0
- package/dist/esm/lib/files.js.map +1 -0
- package/dist/esm/lib/http.d.ts +67 -0
- package/dist/esm/lib/http.d.ts.map +1 -0
- package/dist/esm/lib/http.js +207 -0
- package/dist/esm/lib/http.js.map +1 -0
- package/dist/esm/lib/is-plain-object.d.ts +2 -0
- package/dist/esm/lib/is-plain-object.d.ts.map +1 -0
- package/dist/esm/lib/is-plain-object.js +38 -0
- package/dist/esm/lib/is-plain-object.js.map +1 -0
- package/dist/esm/lib/logger.d.ts +6 -0
- package/dist/esm/lib/logger.d.ts.map +1 -0
- package/dist/esm/lib/logger.js +5 -0
- package/dist/esm/lib/logger.js.map +1 -0
- package/dist/esm/lib/matchers.d.ts +59 -0
- package/dist/esm/lib/matchers.d.ts.map +1 -0
- package/dist/esm/lib/matchers.js +199 -0
- package/dist/esm/lib/matchers.js.map +1 -0
- package/dist/esm/lib/primitives.d.ts +26 -0
- package/dist/esm/lib/primitives.d.ts.map +1 -0
- package/dist/esm/lib/primitives.js +103 -0
- package/dist/esm/lib/primitives.js.map +1 -0
- package/dist/esm/lib/retries.d.ts +38 -0
- package/dist/esm/lib/retries.d.ts.map +1 -0
- package/dist/esm/lib/retries.js +147 -0
- package/dist/esm/lib/retries.js.map +1 -0
- package/dist/esm/lib/schemas.d.ts +21 -0
- package/dist/esm/lib/schemas.d.ts.map +1 -0
- package/dist/esm/lib/schemas.js +57 -0
- package/dist/esm/lib/schemas.js.map +1 -0
- package/dist/esm/lib/sdks.d.ts +63 -0
- package/dist/esm/lib/sdks.d.ts.map +1 -0
- package/dist/esm/lib/sdks.js +265 -0
- package/dist/esm/lib/sdks.js.map +1 -0
- package/dist/esm/lib/security.d.ts +83 -0
- package/dist/esm/lib/security.d.ts.map +1 -0
- package/dist/esm/lib/security.js +136 -0
- package/dist/esm/lib/security.js.map +1 -0
- package/dist/esm/lib/url.d.ts +5 -0
- package/dist/esm/lib/url.d.ts.map +1 -0
- package/dist/esm/lib/url.js +22 -0
- package/dist/esm/lib/url.js.map +1 -0
- package/dist/esm/models/components/accesslevel.d.ts +13 -0
- package/dist/esm/models/components/accesslevel.d.ts.map +1 -0
- package/dist/esm/models/components/accesslevel.js +14 -0
- package/dist/esm/models/components/accesslevel.js.map +1 -0
- package/dist/esm/models/components/createdocumentrequest.d.ts +43 -0
- package/dist/esm/models/components/createdocumentrequest.d.ts.map +1 -0
- package/dist/esm/models/components/createdocumentrequest.js +38 -0
- package/dist/esm/models/components/createdocumentrequest.js.map +1 -0
- package/dist/esm/models/components/createdocumentresponse.d.ts +17 -0
- package/dist/esm/models/components/createdocumentresponse.d.ts.map +1 -0
- package/dist/esm/models/components/createdocumentresponse.js +15 -0
- package/dist/esm/models/components/createdocumentresponse.js.map +1 -0
- package/dist/esm/models/components/createversionrequest.d.ts +48 -0
- package/dist/esm/models/components/createversionrequest.d.ts.map +1 -0
- package/dist/esm/models/components/createversionrequest.js +37 -0
- package/dist/esm/models/components/createversionrequest.js.map +1 -0
- package/dist/esm/models/components/document.d.ts +49 -0
- package/dist/esm/models/components/document.d.ts.map +1 -0
- package/dist/esm/models/components/document.js +35 -0
- package/dist/esm/models/components/document.js.map +1 -0
- package/dist/esm/models/components/documentpolicy.d.ts +33 -0
- package/dist/esm/models/components/documentpolicy.d.ts.map +1 -0
- package/dist/esm/models/components/documentpolicy.js +26 -0
- package/dist/esm/models/components/documentpolicy.js.map +1 -0
- package/dist/esm/models/components/empty.d.ts +19 -0
- package/dist/esm/models/components/empty.d.ts.map +1 -0
- package/dist/esm/models/components/empty.js +11 -0
- package/dist/esm/models/components/empty.js.map +1 -0
- package/dist/esm/models/components/error.d.ts +47 -0
- package/dist/esm/models/components/error.d.ts.map +1 -0
- package/dist/esm/models/components/error.js +38 -0
- package/dist/esm/models/components/error.js.map +1 -0
- package/dist/esm/models/components/generateentrypageresponse.d.ts +16 -0
- package/dist/esm/models/components/generateentrypageresponse.d.ts.map +1 -0
- package/dist/esm/models/components/generateentrypageresponse.js +19 -0
- package/dist/esm/models/components/generateentrypageresponse.js.map +1 -0
- package/dist/esm/models/components/getdocumentresponse.d.ts +17 -0
- package/dist/esm/models/components/getdocumentresponse.d.ts.map +1 -0
- package/dist/esm/models/components/getdocumentresponse.js +15 -0
- package/dist/esm/models/components/getdocumentresponse.js.map +1 -0
- package/dist/esm/models/components/httpmetadata.d.ts +17 -0
- package/dist/esm/models/components/httpmetadata.d.ts.map +1 -0
- package/dist/esm/models/components/httpmetadata.js +20 -0
- package/dist/esm/models/components/httpmetadata.js.map +1 -0
- package/dist/esm/models/components/index.d.ts +24 -0
- package/dist/esm/models/components/index.d.ts.map +1 -0
- package/dist/esm/models/components/index.js +27 -0
- package/dist/esm/models/components/index.js.map +1 -0
- package/dist/esm/models/components/listdocumentpoliciesresponse.d.ts +25 -0
- package/dist/esm/models/components/listdocumentpoliciesresponse.d.ts.map +1 -0
- package/dist/esm/models/components/listdocumentpoliciesresponse.js +17 -0
- package/dist/esm/models/components/listdocumentpoliciesresponse.js.map +1 -0
- package/dist/esm/models/components/listdocumentsresponse.d.ts +25 -0
- package/dist/esm/models/components/listdocumentsresponse.d.ts.map +1 -0
- package/dist/esm/models/components/listdocumentsresponse.js +17 -0
- package/dist/esm/models/components/listdocumentsresponse.js.map +1 -0
- package/dist/esm/models/components/listversionsresponse.d.ts +25 -0
- package/dist/esm/models/components/listversionsresponse.d.ts.map +1 -0
- package/dist/esm/models/components/listversionsresponse.js +17 -0
- package/dist/esm/models/components/listversionsresponse.js.map +1 -0
- package/dist/esm/models/components/pagination.d.ts +33 -0
- package/dist/esm/models/components/pagination.d.ts.map +1 -0
- package/dist/esm/models/components/pagination.js +24 -0
- package/dist/esm/models/components/pagination.js.map +1 -0
- package/dist/esm/models/components/policy.d.ts +27 -0
- package/dist/esm/models/components/policy.d.ts.map +1 -0
- package/dist/esm/models/components/policy.js +21 -0
- package/dist/esm/models/components/policy.js.map +1 -0
- package/dist/esm/models/components/processingstatus.d.ts +11 -0
- package/dist/esm/models/components/processingstatus.d.ts.map +1 -0
- package/dist/esm/models/components/processingstatus.js +12 -0
- package/dist/esm/models/components/processingstatus.js.map +1 -0
- package/dist/esm/models/components/security.d.ts +12 -0
- package/dist/esm/models/components/security.d.ts.map +1 -0
- package/dist/esm/models/components/security.js +12 -0
- package/dist/esm/models/components/security.js.map +1 -0
- package/dist/esm/models/components/updatedocumentresponse.d.ts +17 -0
- package/dist/esm/models/components/updatedocumentresponse.d.ts.map +1 -0
- package/dist/esm/models/components/updatedocumentresponse.js +15 -0
- package/dist/esm/models/components/updatedocumentresponse.js.map +1 -0
- package/dist/esm/models/components/user.d.ts +25 -0
- package/dist/esm/models/components/user.d.ts.map +1 -0
- package/dist/esm/models/components/user.js +17 -0
- package/dist/esm/models/components/user.js.map +1 -0
- package/dist/esm/models/components/usertype.d.ts +10 -0
- package/dist/esm/models/components/usertype.d.ts.map +1 -0
- package/dist/esm/models/components/usertype.js +11 -0
- package/dist/esm/models/components/usertype.js.map +1 -0
- package/dist/esm/models/components/version.d.ts +49 -0
- package/dist/esm/models/components/version.d.ts.map +1 -0
- package/dist/esm/models/components/version.js +31 -0
- package/dist/esm/models/components/version.js.map +1 -0
- package/dist/esm/models/components/versionref.d.ts +19 -0
- package/dist/esm/models/components/versionref.d.ts.map +1 -0
- package/dist/esm/models/components/versionref.js +15 -0
- package/dist/esm/models/components/versionref.js.map +1 -0
- package/dist/esm/models/errors/error.d.ts +26 -0
- package/dist/esm/models/errors/error.d.ts.map +1 -0
- package/dist/esm/models/errors/error.js +38 -0
- package/dist/esm/models/errors/error.js.map +1 -0
- package/dist/esm/models/errors/factifydefaulterror.d.ts +10 -0
- package/dist/esm/models/errors/factifydefaulterror.d.ts.map +1 -0
- package/dist/esm/models/errors/factifydefaulterror.js +30 -0
- package/dist/esm/models/errors/factifydefaulterror.js.map +1 -0
- package/dist/esm/models/errors/factifyerror.d.ts +15 -0
- package/dist/esm/models/errors/factifyerror.d.ts.map +1 -0
- package/dist/esm/models/errors/factifyerror.js +12 -0
- package/dist/esm/models/errors/factifyerror.js.map +1 -0
- package/dist/esm/models/errors/httpclienterrors.d.ts +44 -0
- package/dist/esm/models/errors/httpclienterrors.d.ts.map +1 -0
- package/dist/esm/models/errors/httpclienterrors.js +69 -0
- package/dist/esm/models/errors/httpclienterrors.js.map +1 -0
- package/dist/esm/models/errors/index.d.ts +7 -0
- package/dist/esm/models/errors/index.d.ts.map +1 -0
- package/dist/esm/models/errors/index.js +10 -0
- package/dist/esm/models/errors/index.js.map +1 -0
- package/dist/esm/models/errors/responsevalidationerror.d.ts +26 -0
- package/dist/esm/models/errors/responsevalidationerror.d.ts.map +1 -0
- package/dist/esm/models/errors/responsevalidationerror.js +29 -0
- package/dist/esm/models/errors/responsevalidationerror.js.map +1 -0
- package/dist/esm/models/errors/sdkvalidationerror.d.ts +21 -0
- package/dist/esm/models/errors/sdkvalidationerror.d.ts.map +1 -0
- package/dist/esm/models/errors/sdkvalidationerror.js +44 -0
- package/dist/esm/models/errors/sdkvalidationerror.js.map +1 -0
- package/dist/esm/models/operations/attachdocumentpolicy.d.ts +55 -0
- package/dist/esm/models/operations/attachdocumentpolicy.d.ts.map +1 -0
- package/dist/esm/models/operations/attachdocumentpolicy.js +47 -0
- package/dist/esm/models/operations/attachdocumentpolicy.js.map +1 -0
- package/dist/esm/models/operations/createdocument.d.ts +18 -0
- package/dist/esm/models/operations/createdocument.d.ts.map +1 -0
- package/dist/esm/models/operations/createdocument.js +24 -0
- package/dist/esm/models/operations/createdocument.js.map +1 -0
- package/dist/esm/models/operations/createdocumentversion.d.ts +36 -0
- package/dist/esm/models/operations/createdocumentversion.d.ts.map +1 -0
- package/dist/esm/models/operations/createdocumentversion.js +36 -0
- package/dist/esm/models/operations/createdocumentversion.js.map +1 -0
- package/dist/esm/models/operations/detachdocumentpolicy.d.ts +42 -0
- package/dist/esm/models/operations/detachdocumentpolicy.d.ts.map +1 -0
- package/dist/esm/models/operations/detachdocumentpolicy.js +37 -0
- package/dist/esm/models/operations/detachdocumentpolicy.js.map +1 -0
- package/dist/esm/models/operations/generatedocumententrypage.d.ts +34 -0
- package/dist/esm/models/operations/generatedocumententrypage.d.ts.map +1 -0
- package/dist/esm/models/operations/generatedocumententrypage.js +35 -0
- package/dist/esm/models/operations/generatedocumententrypage.js.map +1 -0
- package/dist/esm/models/operations/getdocument.d.ts +34 -0
- package/dist/esm/models/operations/getdocument.d.ts.map +1 -0
- package/dist/esm/models/operations/getdocument.js +35 -0
- package/dist/esm/models/operations/getdocument.js.map +1 -0
- package/dist/esm/models/operations/getdocumentversion.d.ts +42 -0
- package/dist/esm/models/operations/getdocumentversion.d.ts.map +1 -0
- package/dist/esm/models/operations/getdocumentversion.js +37 -0
- package/dist/esm/models/operations/getdocumentversion.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +13 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -0
- package/dist/esm/models/operations/index.js +16 -0
- package/dist/esm/models/operations/index.js.map +1 -0
- package/dist/esm/models/operations/listdocumentpolicies.d.ts +48 -0
- package/dist/esm/models/operations/listdocumentpolicies.d.ts.map +1 -0
- package/dist/esm/models/operations/listdocumentpolicies.js +39 -0
- package/dist/esm/models/operations/listdocumentpolicies.js.map +1 -0
- package/dist/esm/models/operations/listdocuments.d.ts +45 -0
- package/dist/esm/models/operations/listdocuments.d.ts.map +1 -0
- package/dist/esm/models/operations/listdocuments.js +39 -0
- package/dist/esm/models/operations/listdocuments.js.map +1 -0
- package/dist/esm/models/operations/listdocumentversions.d.ts +48 -0
- package/dist/esm/models/operations/listdocumentversions.d.ts.map +1 -0
- package/dist/esm/models/operations/listdocumentversions.js +39 -0
- package/dist/esm/models/operations/listdocumentversions.js.map +1 -0
- package/dist/esm/models/operations/updatedocument.d.ts +57 -0
- package/dist/esm/models/operations/updatedocument.d.ts.map +1 -0
- package/dist/esm/models/operations/updatedocument.js +44 -0
- package/dist/esm/models/operations/updatedocument.js.map +1 -0
- package/dist/esm/models/operations/updatedocumentversion.d.ts +65 -0
- package/dist/esm/models/operations/updatedocumentversion.d.ts.map +1 -0
- package/dist/esm/models/operations/updatedocumentversion.js +46 -0
- package/dist/esm/models/operations/updatedocumentversion.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk/documents.d.ts +37 -0
- package/dist/esm/sdk/documents.d.ts.map +1 -0
- package/dist/esm/sdk/documents.js +49 -0
- package/dist/esm/sdk/documents.js.map +1 -0
- package/dist/esm/sdk/entrypages.d.ts +12 -0
- package/dist/esm/sdk/entrypages.d.ts.map +1 -0
- package/dist/esm/sdk/entrypages.js +18 -0
- package/dist/esm/sdk/entrypages.js.map +1 -0
- package/dist/esm/sdk/index.d.ts +2 -0
- package/dist/esm/sdk/index.d.ts.map +1 -0
- package/dist/esm/sdk/index.js +5 -0
- package/dist/esm/sdk/index.js.map +1 -0
- package/dist/esm/sdk/policies.d.ts +29 -0
- package/dist/esm/sdk/policies.d.ts.map +1 -0
- package/dist/esm/sdk/policies.js +39 -0
- package/dist/esm/sdk/policies.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +16 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -0
- package/dist/esm/sdk/sdk.js +23 -0
- package/dist/esm/sdk/sdk.js.map +1 -0
- package/dist/esm/sdk/versions.d.ts +36 -0
- package/dist/esm/sdk/versions.d.ts.map +1 -0
- package/dist/esm/sdk/versions.js +49 -0
- package/dist/esm/sdk/versions.js.map +1 -0
- package/dist/esm/types/async.d.ts +23 -0
- package/dist/esm/types/async.d.ts.map +1 -0
- package/dist/esm/types/async.js +40 -0
- package/dist/esm/types/async.js.map +1 -0
- package/dist/esm/types/blobs.d.ts +4 -0
- package/dist/esm/types/blobs.d.ts.map +1 -0
- package/dist/esm/types/blobs.js +25 -0
- package/dist/esm/types/blobs.js.map +1 -0
- package/dist/esm/types/constdatetime.d.ts +3 -0
- package/dist/esm/types/constdatetime.d.ts.map +1 -0
- package/dist/esm/types/constdatetime.js +10 -0
- package/dist/esm/types/constdatetime.js.map +1 -0
- package/dist/esm/types/defaultToZeroValue.d.ts +12 -0
- package/dist/esm/types/defaultToZeroValue.d.ts.map +1 -0
- package/dist/esm/types/defaultToZeroValue.js +31 -0
- package/dist/esm/types/defaultToZeroValue.js.map +1 -0
- package/dist/esm/types/enums.d.ts +9 -0
- package/dist/esm/types/enums.d.ts.map +1 -0
- package/dist/esm/types/enums.js +27 -0
- package/dist/esm/types/enums.js.map +1 -0
- package/dist/esm/types/fp.d.ts +31 -0
- package/dist/esm/types/fp.d.ts.map +1 -0
- package/dist/esm/types/fp.js +31 -0
- package/dist/esm/types/fp.js.map +1 -0
- package/dist/esm/types/index.d.ts +10 -0
- package/dist/esm/types/index.d.ts.map +1 -0
- package/dist/esm/types/index.js +10 -0
- package/dist/esm/types/index.js.map +1 -0
- package/dist/esm/types/operations.d.ts +27 -0
- package/dist/esm/types/operations.d.ts.map +1 -0
- package/dist/esm/types/operations.js +77 -0
- package/dist/esm/types/operations.js.map +1 -0
- package/dist/esm/types/primitives.d.ts +11 -0
- package/dist/esm/types/primitives.d.ts.map +1 -0
- package/dist/esm/types/primitives.js +132 -0
- package/dist/esm/types/primitives.js.map +1 -0
- package/dist/esm/types/rfcdate.d.ts +21 -0
- package/dist/esm/types/rfcdate.d.ts.map +1 -0
- package/dist/esm/types/rfcdate.js +42 -0
- package/dist/esm/types/rfcdate.js.map +1 -0
- package/dist/esm/types/smartUnion.d.ts +7 -0
- package/dist/esm/types/smartUnion.d.ts.map +1 -0
- package/dist/esm/types/smartUnion.js +110 -0
- package/dist/esm/types/smartUnion.js.map +1 -0
- package/dist/esm/types/streams.d.ts +2 -0
- package/dist/esm/types/streams.d.ts.map +1 -0
- package/dist/esm/types/streams.js +15 -0
- package/dist/esm/types/streams.js.map +1 -0
- package/dist/esm/types/unrecognized.d.ts +16 -0
- package/dist/esm/types/unrecognized.d.ts.map +1 -0
- package/dist/esm/types/unrecognized.js +31 -0
- package/dist/esm/types/unrecognized.js.map +1 -0
- package/examples/documentsList.example.ts +31 -0
- package/examples/package-lock.json +611 -0
- package/examples/package.json +18 -0
- package/jsr.json +27 -0
- package/openapi.json +2087 -0
- package/package.json +126 -0
- package/src/core.ts +13 -0
- package/src/funcs/documentsCreate.ts +206 -0
- package/src/funcs/documentsGet.ts +180 -0
- package/src/funcs/documentsList.ts +246 -0
- package/src/funcs/documentsUpdate.ts +181 -0
- package/src/funcs/entryPagesGenerate.ts +186 -0
- package/src/funcs/policiesAttach.ts +184 -0
- package/src/funcs/policiesDetach.ts +187 -0
- package/src/funcs/policiesList.ts +251 -0
- package/src/funcs/versionsCreate.ts +221 -0
- package/src/funcs/versionsGet.ts +187 -0
- package/src/funcs/versionsList.ts +251 -0
- package/src/funcs/versionsUpdate.ts +188 -0
- package/src/hooks/hooks.ts +132 -0
- package/src/hooks/index.ts +6 -0
- package/src/hooks/registration.ts +14 -0
- package/src/hooks/types.ts +107 -0
- package/src/index.ts +9 -0
- package/src/lib/base64.ts +39 -0
- package/src/lib/config.ts +71 -0
- package/src/lib/dlv.ts +53 -0
- package/src/lib/encodings.ts +501 -0
- package/src/lib/files.ts +82 -0
- package/src/lib/http.ts +323 -0
- package/src/lib/is-plain-object.ts +43 -0
- package/src/lib/logger.ts +9 -0
- package/src/lib/matchers.ts +349 -0
- package/src/lib/primitives.ts +150 -0
- package/src/lib/retries.ts +218 -0
- package/src/lib/schemas.ts +94 -0
- package/src/lib/sdks.ts +402 -0
- package/src/lib/security.ts +263 -0
- package/src/lib/url.ts +33 -0
- package/src/models/components/accesslevel.ts +21 -0
- package/src/models/components/createdocumentrequest.ts +99 -0
- package/src/models/components/createdocumentresponse.ts +38 -0
- package/src/models/components/createversionrequest.ts +104 -0
- package/src/models/components/document.ts +90 -0
- package/src/models/components/documentpolicy.ts +67 -0
- package/src/models/components/empty.ts +34 -0
- package/src/models/components/error.ts +81 -0
- package/src/models/components/generateentrypageresponse.ts +45 -0
- package/src/models/components/getdocumentresponse.ts +38 -0
- package/src/models/components/httpmetadata.ts +45 -0
- package/src/models/components/index.ts +27 -0
- package/src/models/components/listdocumentpoliciesresponse.ts +50 -0
- package/src/models/components/listdocumentsresponse.ts +47 -0
- package/src/models/components/listversionsresponse.ts +47 -0
- package/src/models/components/pagination.ts +64 -0
- package/src/models/components/policy.ts +55 -0
- package/src/models/components/processingstatus.ts +20 -0
- package/src/models/components/security.ts +26 -0
- package/src/models/components/updatedocumentresponse.ts +38 -0
- package/src/models/components/user.ts +45 -0
- package/src/models/components/usertype.ts +17 -0
- package/src/models/components/version.ts +88 -0
- package/src/models/components/versionref.ts +38 -0
- package/src/models/errors/error.ts +61 -0
- package/src/models/errors/factifydefaulterror.ts +40 -0
- package/src/models/errors/factifyerror.ts +27 -0
- package/src/models/errors/httpclienterrors.ts +62 -0
- package/src/models/errors/index.ts +10 -0
- package/src/models/errors/responsevalidationerror.ts +50 -0
- package/src/models/errors/sdkvalidationerror.ts +54 -0
- package/src/models/operations/attachdocumentpolicy.ts +133 -0
- package/src/models/operations/createdocument.ts +51 -0
- package/src/models/operations/createdocumentversion.ts +92 -0
- package/src/models/operations/detachdocumentpolicy.ts +99 -0
- package/src/models/operations/generatedocumententrypage.ts +91 -0
- package/src/models/operations/getdocument.ts +89 -0
- package/src/models/operations/getdocumentversion.ts +97 -0
- package/src/models/operations/index.ts +16 -0
- package/src/models/operations/listdocumentpolicies.ts +111 -0
- package/src/models/operations/listdocuments.ts +106 -0
- package/src/models/operations/listdocumentversions.ts +109 -0
- package/src/models/operations/updatedocument.ts +131 -0
- package/src/models/operations/updatedocumentversion.ts +139 -0
- package/src/sdk/documents.ts +85 -0
- package/src/sdk/entrypages.ts +27 -0
- package/src/sdk/index.ts +5 -0
- package/src/sdk/policies.ts +66 -0
- package/src/sdk/sdk.ts +31 -0
- package/src/sdk/versions.ts +84 -0
- package/src/types/async.ts +68 -0
- package/src/types/blobs.ts +33 -0
- package/src/types/constdatetime.ts +15 -0
- package/src/types/defaultToZeroValue.ts +33 -0
- package/src/types/enums.ts +45 -0
- package/src/types/fp.ts +50 -0
- package/src/types/index.ts +13 -0
- package/src/types/operations.ts +105 -0
- package/src/types/primitives.ts +168 -0
- package/src/types/rfcdate.ts +54 -0
- package/src/types/smartUnion.ts +145 -0
- package/src/types/streams.ts +21 -0
- package/src/types/unrecognized.ts +35 -0
- package/tsconfig.json +40 -0
package/openapi.json
ADDED
|
@@ -0,0 +1,2087 @@
|
|
|
1
|
+
{
|
|
2
|
+
"components": {
|
|
3
|
+
"responses": {
|
|
4
|
+
"BadRequest": {
|
|
5
|
+
"content": {
|
|
6
|
+
"application/json": {
|
|
7
|
+
"examples": {
|
|
8
|
+
"validation_error": {
|
|
9
|
+
"value": {
|
|
10
|
+
"error": {
|
|
11
|
+
"code": "missing_required_field",
|
|
12
|
+
"message": "Document title cannot be empty",
|
|
13
|
+
"param": "title",
|
|
14
|
+
"retry_after": null,
|
|
15
|
+
"type": "invalid_request_error"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"schema": {
|
|
21
|
+
"$ref": "#/components/schemas/Error"
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"description": "Invalid request parameters"
|
|
26
|
+
},
|
|
27
|
+
"Forbidden": {
|
|
28
|
+
"content": {
|
|
29
|
+
"application/json": {
|
|
30
|
+
"examples": {
|
|
31
|
+
"insufficient_permissions": {
|
|
32
|
+
"value": {
|
|
33
|
+
"error": {
|
|
34
|
+
"code": "insufficient_permissions",
|
|
35
|
+
"message": "You do not have permission to access this resource",
|
|
36
|
+
"param": null,
|
|
37
|
+
"retry_after": null,
|
|
38
|
+
"type": "authorization_error"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"schema": {
|
|
44
|
+
"$ref": "#/components/schemas/Error"
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"description": "Authorization failed - valid key but insufficient permissions"
|
|
49
|
+
},
|
|
50
|
+
"InternalServerError": {
|
|
51
|
+
"content": {
|
|
52
|
+
"application/json": {
|
|
53
|
+
"examples": {
|
|
54
|
+
"internal_error": {
|
|
55
|
+
"value": {
|
|
56
|
+
"error": {
|
|
57
|
+
"code": "internal_error",
|
|
58
|
+
"message": "An unexpected error occurred. Please try again later.",
|
|
59
|
+
"param": null,
|
|
60
|
+
"retry_after": null,
|
|
61
|
+
"type": "api_error"
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"schema": {
|
|
67
|
+
"$ref": "#/components/schemas/Error"
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
"description": "Internal server error"
|
|
72
|
+
},
|
|
73
|
+
"NotFound": {
|
|
74
|
+
"content": {
|
|
75
|
+
"application/json": {
|
|
76
|
+
"examples": {
|
|
77
|
+
"resource_not_found": {
|
|
78
|
+
"value": {
|
|
79
|
+
"error": {
|
|
80
|
+
"code": "resource_not_found",
|
|
81
|
+
"message": "Document not found",
|
|
82
|
+
"param": null,
|
|
83
|
+
"retry_after": null,
|
|
84
|
+
"type": "not_found_error"
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
"schema": {
|
|
90
|
+
"$ref": "#/components/schemas/Error"
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
},
|
|
94
|
+
"description": "Resource not found"
|
|
95
|
+
},
|
|
96
|
+
"RateLimitExceeded": {
|
|
97
|
+
"content": {
|
|
98
|
+
"application/json": {
|
|
99
|
+
"examples": {
|
|
100
|
+
"rate_limit": {
|
|
101
|
+
"value": {
|
|
102
|
+
"error": {
|
|
103
|
+
"code": "rate_limit_exceeded",
|
|
104
|
+
"message": "Too many requests. Retry after 30 seconds.",
|
|
105
|
+
"param": null,
|
|
106
|
+
"retry_after": 30,
|
|
107
|
+
"type": "rate_limit_error"
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
"schema": {
|
|
113
|
+
"$ref": "#/components/schemas/Error"
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
},
|
|
117
|
+
"description": "Too many requests",
|
|
118
|
+
"headers": {
|
|
119
|
+
"X-RateLimit-Limit": {
|
|
120
|
+
"description": "Request limit per minute",
|
|
121
|
+
"schema": {
|
|
122
|
+
"type": "integer"
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
"X-RateLimit-Remaining": {
|
|
126
|
+
"description": "Remaining requests in current window",
|
|
127
|
+
"schema": {
|
|
128
|
+
"type": "integer"
|
|
129
|
+
}
|
|
130
|
+
},
|
|
131
|
+
"X-RateLimit-Reset": {
|
|
132
|
+
"description": "Unix timestamp when rate limit resets",
|
|
133
|
+
"schema": {
|
|
134
|
+
"type": "integer"
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
},
|
|
139
|
+
"Unauthorized": {
|
|
140
|
+
"content": {
|
|
141
|
+
"application/json": {
|
|
142
|
+
"examples": {
|
|
143
|
+
"missing_key": {
|
|
144
|
+
"value": {
|
|
145
|
+
"error": {
|
|
146
|
+
"code": "missing_api_key",
|
|
147
|
+
"message": "No API key provided",
|
|
148
|
+
"param": null,
|
|
149
|
+
"retry_after": null,
|
|
150
|
+
"type": "authentication_error"
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"schema": {
|
|
156
|
+
"$ref": "#/components/schemas/Error"
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
},
|
|
160
|
+
"description": "Authentication failed - missing or invalid API key"
|
|
161
|
+
}
|
|
162
|
+
},
|
|
163
|
+
"schemas": {
|
|
164
|
+
"AccessLevel": {
|
|
165
|
+
"enum": [
|
|
166
|
+
"private",
|
|
167
|
+
"organization",
|
|
168
|
+
"public"
|
|
169
|
+
]
|
|
170
|
+
},
|
|
171
|
+
"AttachPolicyRequest": {
|
|
172
|
+
"additionalProperties": false,
|
|
173
|
+
"description": "AttachPolicyRequest specifies a policy to attach to a document.",
|
|
174
|
+
"properties": {
|
|
175
|
+
"document_id": {
|
|
176
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
177
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
178
|
+
"title": "document_id",
|
|
179
|
+
"type": "string"
|
|
180
|
+
},
|
|
181
|
+
"policy_id": {
|
|
182
|
+
"description": "Policy ID to attach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
|
|
183
|
+
"pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
|
|
184
|
+
"title": "policy_id",
|
|
185
|
+
"type": "string"
|
|
186
|
+
}
|
|
187
|
+
},
|
|
188
|
+
"required": [
|
|
189
|
+
"policy_id"
|
|
190
|
+
],
|
|
191
|
+
"title": "AttachPolicyRequest",
|
|
192
|
+
"type": "object"
|
|
193
|
+
},
|
|
194
|
+
"CreateDocumentRequest": {
|
|
195
|
+
"additionalProperties": false,
|
|
196
|
+
"description": "CreateDocumentRequest contains the file and metadata for creating a document.",
|
|
197
|
+
"properties": {
|
|
198
|
+
"access_level": {
|
|
199
|
+
"$ref": "#/components/schemas/AccessLevel",
|
|
200
|
+
"description": "Document access level. Defaults to organization if user belongs to an org, otherwise private.",
|
|
201
|
+
"nullable": true,
|
|
202
|
+
"title": "access_level"
|
|
203
|
+
},
|
|
204
|
+
"description": {
|
|
205
|
+
"description": "Optional document description.",
|
|
206
|
+
"maxLength": 2000,
|
|
207
|
+
"nullable": true,
|
|
208
|
+
"title": "description",
|
|
209
|
+
"type": "string"
|
|
210
|
+
},
|
|
211
|
+
"document_id": {
|
|
212
|
+
"description": "Pre-generated document ID (set by server)",
|
|
213
|
+
"readOnly": true,
|
|
214
|
+
"title": "document_id",
|
|
215
|
+
"type": "string"
|
|
216
|
+
},
|
|
217
|
+
"payload": {
|
|
218
|
+
"description": "PDF file to upload",
|
|
219
|
+
"format": "binary",
|
|
220
|
+
"title": "payload",
|
|
221
|
+
"type": "string"
|
|
222
|
+
},
|
|
223
|
+
"payload_key": {
|
|
224
|
+
"description": "Storage key for uploaded file (set by server)",
|
|
225
|
+
"readOnly": true,
|
|
226
|
+
"title": "payload_key",
|
|
227
|
+
"type": "string"
|
|
228
|
+
},
|
|
229
|
+
"title": {
|
|
230
|
+
"description": "Document title.",
|
|
231
|
+
"maxLength": 255,
|
|
232
|
+
"minLength": 1,
|
|
233
|
+
"title": "title",
|
|
234
|
+
"type": "string"
|
|
235
|
+
},
|
|
236
|
+
"version_id": {
|
|
237
|
+
"description": "Pre-generated version ID (set by server)",
|
|
238
|
+
"readOnly": true,
|
|
239
|
+
"title": "version_id",
|
|
240
|
+
"type": "string"
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"required": [
|
|
244
|
+
"payload",
|
|
245
|
+
"title"
|
|
246
|
+
],
|
|
247
|
+
"title": "CreateDocumentRequest",
|
|
248
|
+
"type": "object"
|
|
249
|
+
},
|
|
250
|
+
"CreateDocumentResponse": {
|
|
251
|
+
"additionalProperties": false,
|
|
252
|
+
"description": "CreateDocumentResponse contains the newly created document.",
|
|
253
|
+
"properties": {
|
|
254
|
+
"document": {
|
|
255
|
+
"$ref": "#/components/schemas/Document",
|
|
256
|
+
"description": "The created document.",
|
|
257
|
+
"title": "document"
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
"title": "CreateDocumentResponse",
|
|
261
|
+
"type": "object"
|
|
262
|
+
},
|
|
263
|
+
"CreateVersionRequest": {
|
|
264
|
+
"additionalProperties": false,
|
|
265
|
+
"description": "CreateVersionRequest contains the file and metadata for creating a version.",
|
|
266
|
+
"properties": {
|
|
267
|
+
"description": {
|
|
268
|
+
"description": "Description of changes in this version.",
|
|
269
|
+
"nullable": true,
|
|
270
|
+
"title": "description",
|
|
271
|
+
"type": "string"
|
|
272
|
+
},
|
|
273
|
+
"document_id": {
|
|
274
|
+
"description": "Document ID to create version for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
275
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
276
|
+
"title": "document_id",
|
|
277
|
+
"type": "string"
|
|
278
|
+
},
|
|
279
|
+
"payload": {
|
|
280
|
+
"description": "PDF file for new version",
|
|
281
|
+
"format": "binary",
|
|
282
|
+
"title": "payload",
|
|
283
|
+
"type": "string"
|
|
284
|
+
},
|
|
285
|
+
"payload_key": {
|
|
286
|
+
"description": "Storage key for uploaded file (set by server)",
|
|
287
|
+
"readOnly": true,
|
|
288
|
+
"title": "payload_key",
|
|
289
|
+
"type": "string"
|
|
290
|
+
},
|
|
291
|
+
"title": {
|
|
292
|
+
"description": "Optional version title.",
|
|
293
|
+
"maxLength": 255,
|
|
294
|
+
"nullable": true,
|
|
295
|
+
"title": "title",
|
|
296
|
+
"type": "string"
|
|
297
|
+
},
|
|
298
|
+
"version_id": {
|
|
299
|
+
"description": "Pre-generated version ID (set by server)",
|
|
300
|
+
"readOnly": true,
|
|
301
|
+
"title": "version_id",
|
|
302
|
+
"type": "string"
|
|
303
|
+
}
|
|
304
|
+
},
|
|
305
|
+
"required": [
|
|
306
|
+
"payload"
|
|
307
|
+
],
|
|
308
|
+
"title": "CreateVersionRequest",
|
|
309
|
+
"type": "object"
|
|
310
|
+
},
|
|
311
|
+
"DetachPolicyRequest": {
|
|
312
|
+
"additionalProperties": false,
|
|
313
|
+
"description": "DetachPolicyRequest identifies a policy to detach from a document.",
|
|
314
|
+
"properties": {
|
|
315
|
+
"document_id": {
|
|
316
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
317
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
318
|
+
"title": "document_id",
|
|
319
|
+
"type": "string"
|
|
320
|
+
},
|
|
321
|
+
"policy_id": {
|
|
322
|
+
"description": "Policy ID to detach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
|
|
323
|
+
"pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
|
|
324
|
+
"title": "policy_id",
|
|
325
|
+
"type": "string"
|
|
326
|
+
}
|
|
327
|
+
},
|
|
328
|
+
"title": "DetachPolicyRequest",
|
|
329
|
+
"type": "object"
|
|
330
|
+
},
|
|
331
|
+
"Document": {
|
|
332
|
+
"additionalProperties": false,
|
|
333
|
+
"description": "Document represents a Factify document.",
|
|
334
|
+
"properties": {
|
|
335
|
+
"access_level": {
|
|
336
|
+
"$ref": "#/components/schemas/AccessLevel",
|
|
337
|
+
"description": "Document access level.",
|
|
338
|
+
"title": "access_level"
|
|
339
|
+
},
|
|
340
|
+
"created_at": {
|
|
341
|
+
"description": "Timestamp when document was created.",
|
|
342
|
+
"format": "date-time",
|
|
343
|
+
"title": "created_at",
|
|
344
|
+
"type": "string"
|
|
345
|
+
},
|
|
346
|
+
"created_by": {
|
|
347
|
+
"$ref": "#/components/schemas/User",
|
|
348
|
+
"description": "User who created the document.",
|
|
349
|
+
"title": "created_by"
|
|
350
|
+
},
|
|
351
|
+
"current_version": {
|
|
352
|
+
"$ref": "#/components/schemas/VersionRef",
|
|
353
|
+
"description": "Reference to the current version, if any.",
|
|
354
|
+
"nullable": true,
|
|
355
|
+
"title": "current_version"
|
|
356
|
+
},
|
|
357
|
+
"description": {
|
|
358
|
+
"description": "Optional document description.",
|
|
359
|
+
"example": "Quarterly financial report for Q4 2024",
|
|
360
|
+
"maxLength": 2000,
|
|
361
|
+
"nullable": true,
|
|
362
|
+
"title": "description",
|
|
363
|
+
"type": "string"
|
|
364
|
+
},
|
|
365
|
+
"id": {
|
|
366
|
+
"description": "Unique ID for the document.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
367
|
+
"example": "doc_01h2xcejqtf2nbrexx3vqjhp41",
|
|
368
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
369
|
+
"title": "id",
|
|
370
|
+
"type": "string"
|
|
371
|
+
},
|
|
372
|
+
"processing_status": {
|
|
373
|
+
"$ref": "#/components/schemas/ProcessingStatus",
|
|
374
|
+
"description": "Processing status.",
|
|
375
|
+
"title": "processing_status"
|
|
376
|
+
},
|
|
377
|
+
"title": {
|
|
378
|
+
"description": "Document title.",
|
|
379
|
+
"example": "Q4 2024 Financial Report",
|
|
380
|
+
"maxLength": 255,
|
|
381
|
+
"minLength": 1,
|
|
382
|
+
"title": "title",
|
|
383
|
+
"type": "string"
|
|
384
|
+
},
|
|
385
|
+
"url": {
|
|
386
|
+
"description": "URL for accessing the document on Factify.",
|
|
387
|
+
"example": "https://d.factify.com/d/01h2xcejqtf2nbrexx3vqjhp41",
|
|
388
|
+
"format": "uri",
|
|
389
|
+
"title": "url",
|
|
390
|
+
"type": "string"
|
|
391
|
+
}
|
|
392
|
+
},
|
|
393
|
+
"required": [
|
|
394
|
+
"id",
|
|
395
|
+
"url",
|
|
396
|
+
"title",
|
|
397
|
+
"access_level",
|
|
398
|
+
"processing_status",
|
|
399
|
+
"created_at",
|
|
400
|
+
"created_by"
|
|
401
|
+
],
|
|
402
|
+
"title": "Document",
|
|
403
|
+
"type": "object"
|
|
404
|
+
},
|
|
405
|
+
"DocumentPolicy": {
|
|
406
|
+
"additionalProperties": false,
|
|
407
|
+
"description": "DocumentPolicy represents a policy attached to a document.",
|
|
408
|
+
"properties": {
|
|
409
|
+
"attached_at": {
|
|
410
|
+
"description": "Timestamp when policy was attached.",
|
|
411
|
+
"format": "date-time",
|
|
412
|
+
"title": "attached_at",
|
|
413
|
+
"type": "string"
|
|
414
|
+
},
|
|
415
|
+
"attached_by": {
|
|
416
|
+
"$ref": "#/components/schemas/User",
|
|
417
|
+
"description": "User who attached the policy.",
|
|
418
|
+
"title": "attached_by"
|
|
419
|
+
},
|
|
420
|
+
"document_id": {
|
|
421
|
+
"description": "Document ID this policy is attached to.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
422
|
+
"example": "doc_01h2xcejqtf2nbrexx3vqjhp41",
|
|
423
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
424
|
+
"title": "document_id",
|
|
425
|
+
"type": "string"
|
|
426
|
+
},
|
|
427
|
+
"policy": {
|
|
428
|
+
"$ref": "#/components/schemas/Policy",
|
|
429
|
+
"description": "The policy details.",
|
|
430
|
+
"title": "policy"
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
"required": [
|
|
434
|
+
"document_id",
|
|
435
|
+
"attached_at",
|
|
436
|
+
"attached_by",
|
|
437
|
+
"policy"
|
|
438
|
+
],
|
|
439
|
+
"title": "DocumentPolicy",
|
|
440
|
+
"type": "object"
|
|
441
|
+
},
|
|
442
|
+
"Empty": {
|
|
443
|
+
"description": "A generic empty message that you can re-use to avoid defining duplicated\n empty messages in your APIs. A typical example is to use it as the request\n or the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }",
|
|
444
|
+
"type": "object"
|
|
445
|
+
},
|
|
446
|
+
"Error": {
|
|
447
|
+
"properties": {
|
|
448
|
+
"error": {
|
|
449
|
+
"properties": {
|
|
450
|
+
"code": {
|
|
451
|
+
"description": "Specific error code for detailed handling",
|
|
452
|
+
"type": "string"
|
|
453
|
+
},
|
|
454
|
+
"message": {
|
|
455
|
+
"description": "Human-readable error message",
|
|
456
|
+
"type": "string"
|
|
457
|
+
},
|
|
458
|
+
"param": {
|
|
459
|
+
"description": "Parameter that caused the error (for validation errors)",
|
|
460
|
+
"type": [
|
|
461
|
+
"string",
|
|
462
|
+
"null"
|
|
463
|
+
]
|
|
464
|
+
},
|
|
465
|
+
"retry_after": {
|
|
466
|
+
"description": "Seconds to wait before retrying (for rate limit errors)",
|
|
467
|
+
"type": [
|
|
468
|
+
"integer",
|
|
469
|
+
"null"
|
|
470
|
+
]
|
|
471
|
+
},
|
|
472
|
+
"type": {
|
|
473
|
+
"description": "Error type for programmatic handling",
|
|
474
|
+
"enum": [
|
|
475
|
+
"invalid_request_error",
|
|
476
|
+
"authentication_error",
|
|
477
|
+
"authorization_error",
|
|
478
|
+
"not_found_error",
|
|
479
|
+
"rate_limit_error",
|
|
480
|
+
"api_error"
|
|
481
|
+
],
|
|
482
|
+
"type": "string"
|
|
483
|
+
}
|
|
484
|
+
},
|
|
485
|
+
"required": [
|
|
486
|
+
"type",
|
|
487
|
+
"message",
|
|
488
|
+
"code",
|
|
489
|
+
"param",
|
|
490
|
+
"retry_after"
|
|
491
|
+
],
|
|
492
|
+
"type": "object"
|
|
493
|
+
}
|
|
494
|
+
},
|
|
495
|
+
"required": [
|
|
496
|
+
"error"
|
|
497
|
+
],
|
|
498
|
+
"type": "object"
|
|
499
|
+
},
|
|
500
|
+
"GenerateEntryPageRequest": {
|
|
501
|
+
"additionalProperties": false,
|
|
502
|
+
"description": "GenerateEntryPageRequest identifies a document to generate an entry page for.",
|
|
503
|
+
"properties": {
|
|
504
|
+
"document_id": {
|
|
505
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
506
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
507
|
+
"title": "document_id",
|
|
508
|
+
"type": "string"
|
|
509
|
+
}
|
|
510
|
+
},
|
|
511
|
+
"title": "GenerateEntryPageRequest",
|
|
512
|
+
"type": "object"
|
|
513
|
+
},
|
|
514
|
+
"GenerateEntryPageResponse": {
|
|
515
|
+
"additionalProperties": false,
|
|
516
|
+
"description": "GenerateEntryPageResponse contains the download URL for the entry page.",
|
|
517
|
+
"properties": {
|
|
518
|
+
"download_url": {
|
|
519
|
+
"description": "Temporary download URL for the entry page PDF.",
|
|
520
|
+
"example": "https://storage.factify.com/entry-pages/abc123.pdf?token=xyz",
|
|
521
|
+
"format": "uri",
|
|
522
|
+
"title": "download_url",
|
|
523
|
+
"type": "string"
|
|
524
|
+
}
|
|
525
|
+
},
|
|
526
|
+
"required": [
|
|
527
|
+
"download_url"
|
|
528
|
+
],
|
|
529
|
+
"title": "GenerateEntryPageResponse",
|
|
530
|
+
"type": "object"
|
|
531
|
+
},
|
|
532
|
+
"GetDocumentRequest": {
|
|
533
|
+
"additionalProperties": false,
|
|
534
|
+
"description": "GetDocumentRequest identifies a document to retrieve.",
|
|
535
|
+
"properties": {
|
|
536
|
+
"document_id": {
|
|
537
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
538
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
539
|
+
"title": "document_id",
|
|
540
|
+
"type": "string"
|
|
541
|
+
}
|
|
542
|
+
},
|
|
543
|
+
"title": "GetDocumentRequest",
|
|
544
|
+
"type": "object"
|
|
545
|
+
},
|
|
546
|
+
"GetDocumentResponse": {
|
|
547
|
+
"additionalProperties": false,
|
|
548
|
+
"description": "GetDocumentResponse contains the requested document.",
|
|
549
|
+
"properties": {
|
|
550
|
+
"document": {
|
|
551
|
+
"$ref": "#/components/schemas/Document",
|
|
552
|
+
"description": "The requested document.",
|
|
553
|
+
"title": "document"
|
|
554
|
+
}
|
|
555
|
+
},
|
|
556
|
+
"title": "GetDocumentResponse",
|
|
557
|
+
"type": "object"
|
|
558
|
+
},
|
|
559
|
+
"GetVersionRequest": {
|
|
560
|
+
"additionalProperties": false,
|
|
561
|
+
"description": "GetVersionRequest identifies a specific version to retrieve.",
|
|
562
|
+
"properties": {
|
|
563
|
+
"document_id": {
|
|
564
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
565
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
566
|
+
"title": "document_id",
|
|
567
|
+
"type": "string"
|
|
568
|
+
},
|
|
569
|
+
"version_id": {
|
|
570
|
+
"description": "Version ID.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
571
|
+
"pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
|
|
572
|
+
"title": "version_id",
|
|
573
|
+
"type": "string"
|
|
574
|
+
}
|
|
575
|
+
},
|
|
576
|
+
"title": "GetVersionRequest",
|
|
577
|
+
"type": "object"
|
|
578
|
+
},
|
|
579
|
+
"ListDocumentPoliciesRequest": {
|
|
580
|
+
"additionalProperties": false,
|
|
581
|
+
"description": "ListDocumentPoliciesRequest specifies pagination for listing document policies.\n Follows Google AIP-158 for pagination field naming.",
|
|
582
|
+
"properties": {
|
|
583
|
+
"document_id": {
|
|
584
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
585
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
586
|
+
"title": "document_id",
|
|
587
|
+
"type": "string"
|
|
588
|
+
},
|
|
589
|
+
"page_size": {
|
|
590
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
591
|
+
"format": "int32",
|
|
592
|
+
"maximum": 100,
|
|
593
|
+
"minimum": 1,
|
|
594
|
+
"nullable": true,
|
|
595
|
+
"title": "page_size",
|
|
596
|
+
"type": "integer"
|
|
597
|
+
},
|
|
598
|
+
"page_token": {
|
|
599
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
600
|
+
"example": "eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0",
|
|
601
|
+
"title": "page_token",
|
|
602
|
+
"type": "string"
|
|
603
|
+
}
|
|
604
|
+
},
|
|
605
|
+
"title": "ListDocumentPoliciesRequest",
|
|
606
|
+
"type": "object"
|
|
607
|
+
},
|
|
608
|
+
"ListDocumentPoliciesResponse": {
|
|
609
|
+
"additionalProperties": false,
|
|
610
|
+
"description": "ListDocumentPoliciesResponse contains a page of policy attachments.",
|
|
611
|
+
"properties": {
|
|
612
|
+
"items": {
|
|
613
|
+
"description": "List of policy attachments.",
|
|
614
|
+
"items": {
|
|
615
|
+
"$ref": "#/components/schemas/DocumentPolicy"
|
|
616
|
+
},
|
|
617
|
+
"title": "items",
|
|
618
|
+
"type": "array"
|
|
619
|
+
},
|
|
620
|
+
"pagination": {
|
|
621
|
+
"$ref": "#/components/schemas/Pagination",
|
|
622
|
+
"description": "Pagination metadata.",
|
|
623
|
+
"title": "pagination"
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
"title": "ListDocumentPoliciesResponse",
|
|
627
|
+
"type": "object"
|
|
628
|
+
},
|
|
629
|
+
"ListDocumentsRequest": {
|
|
630
|
+
"additionalProperties": false,
|
|
631
|
+
"description": "ListDocumentsRequest specifies filters and pagination for listing documents.\n Follows Google AIP-158 for pagination field naming.\n Note: Keeping filters flat (not nested) for cleaner REST API query parameters.\n Nested message would result in ?filters.created_after=... which is verbose.\n To implement nested filters with flat REST params would require both:\n 1. OpenAPI post-processing (cosmetic for docs)\n 2. Custom middleware/transcoding (runtime behavior)\ncreated_time_range // created_after must be before created_before\n",
|
|
632
|
+
"properties": {
|
|
633
|
+
"created_after": {
|
|
634
|
+
"description": "Filter: return documents created after this timestamp.",
|
|
635
|
+
"format": "date-time",
|
|
636
|
+
"nullable": true,
|
|
637
|
+
"title": "created_after",
|
|
638
|
+
"type": "string"
|
|
639
|
+
},
|
|
640
|
+
"created_before": {
|
|
641
|
+
"description": "Filter: return documents created before this timestamp.",
|
|
642
|
+
"format": "date-time",
|
|
643
|
+
"nullable": true,
|
|
644
|
+
"title": "created_before",
|
|
645
|
+
"type": "string"
|
|
646
|
+
},
|
|
647
|
+
"page_size": {
|
|
648
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
649
|
+
"format": "int32",
|
|
650
|
+
"maximum": 100,
|
|
651
|
+
"minimum": 1,
|
|
652
|
+
"nullable": true,
|
|
653
|
+
"title": "page_size",
|
|
654
|
+
"type": "integer"
|
|
655
|
+
},
|
|
656
|
+
"page_token": {
|
|
657
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
658
|
+
"example": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0",
|
|
659
|
+
"title": "page_token",
|
|
660
|
+
"type": "string"
|
|
661
|
+
}
|
|
662
|
+
},
|
|
663
|
+
"title": "ListDocumentsRequest",
|
|
664
|
+
"type": "object"
|
|
665
|
+
},
|
|
666
|
+
"ListDocumentsResponse": {
|
|
667
|
+
"additionalProperties": false,
|
|
668
|
+
"description": "ListDocumentsResponse contains a page of documents.",
|
|
669
|
+
"properties": {
|
|
670
|
+
"items": {
|
|
671
|
+
"description": "List of documents.",
|
|
672
|
+
"items": {
|
|
673
|
+
"$ref": "#/components/schemas/Document"
|
|
674
|
+
},
|
|
675
|
+
"title": "items",
|
|
676
|
+
"type": "array"
|
|
677
|
+
},
|
|
678
|
+
"pagination": {
|
|
679
|
+
"$ref": "#/components/schemas/Pagination",
|
|
680
|
+
"description": "Pagination metadata.",
|
|
681
|
+
"title": "pagination"
|
|
682
|
+
}
|
|
683
|
+
},
|
|
684
|
+
"title": "ListDocumentsResponse",
|
|
685
|
+
"type": "object"
|
|
686
|
+
},
|
|
687
|
+
"ListVersionsRequest": {
|
|
688
|
+
"additionalProperties": false,
|
|
689
|
+
"description": "ListVersionsRequest specifies filters and pagination for listing versions.\n Follows Google AIP-158 for pagination field naming.",
|
|
690
|
+
"properties": {
|
|
691
|
+
"document_id": {
|
|
692
|
+
"description": "Document ID to list versions for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
693
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
694
|
+
"title": "document_id",
|
|
695
|
+
"type": "string"
|
|
696
|
+
},
|
|
697
|
+
"page_size": {
|
|
698
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
699
|
+
"format": "int32",
|
|
700
|
+
"maximum": 100,
|
|
701
|
+
"minimum": 1,
|
|
702
|
+
"nullable": true,
|
|
703
|
+
"title": "page_size",
|
|
704
|
+
"type": "integer"
|
|
705
|
+
},
|
|
706
|
+
"page_token": {
|
|
707
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
708
|
+
"example": "eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0",
|
|
709
|
+
"title": "page_token",
|
|
710
|
+
"type": "string"
|
|
711
|
+
}
|
|
712
|
+
},
|
|
713
|
+
"title": "ListVersionsRequest",
|
|
714
|
+
"type": "object"
|
|
715
|
+
},
|
|
716
|
+
"ListVersionsResponse": {
|
|
717
|
+
"additionalProperties": false,
|
|
718
|
+
"description": "ListVersionsResponse contains a page of versions.",
|
|
719
|
+
"properties": {
|
|
720
|
+
"items": {
|
|
721
|
+
"description": "List of versions.",
|
|
722
|
+
"items": {
|
|
723
|
+
"$ref": "#/components/schemas/Version"
|
|
724
|
+
},
|
|
725
|
+
"title": "items",
|
|
726
|
+
"type": "array"
|
|
727
|
+
},
|
|
728
|
+
"pagination": {
|
|
729
|
+
"$ref": "#/components/schemas/Pagination",
|
|
730
|
+
"description": "Pagination metadata.",
|
|
731
|
+
"title": "pagination"
|
|
732
|
+
}
|
|
733
|
+
},
|
|
734
|
+
"title": "ListVersionsResponse",
|
|
735
|
+
"type": "object"
|
|
736
|
+
},
|
|
737
|
+
"Pagination": {
|
|
738
|
+
"additionalProperties": false,
|
|
739
|
+
"description": "Pagination contains cursor-based pagination metadata.\n Follows Google AIP-158 for pagination field naming.",
|
|
740
|
+
"properties": {
|
|
741
|
+
"has_more": {
|
|
742
|
+
"description": "Whether there are more results in the forward direction.",
|
|
743
|
+
"title": "has_more",
|
|
744
|
+
"type": "boolean"
|
|
745
|
+
},
|
|
746
|
+
"next_page_token": {
|
|
747
|
+
"description": "Token to retrieve the next page of results.\n Empty if there are no more results in the forward direction.",
|
|
748
|
+
"example": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0",
|
|
749
|
+
"title": "next_page_token",
|
|
750
|
+
"type": "string"
|
|
751
|
+
},
|
|
752
|
+
"prev_page_token": {
|
|
753
|
+
"description": "Token to retrieve the previous page of results.\n Empty if this is the first page.",
|
|
754
|
+
"example": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJwcmV2In0",
|
|
755
|
+
"title": "prev_page_token",
|
|
756
|
+
"type": "string"
|
|
757
|
+
}
|
|
758
|
+
},
|
|
759
|
+
"title": "Pagination",
|
|
760
|
+
"type": "object"
|
|
761
|
+
},
|
|
762
|
+
"Policy": {
|
|
763
|
+
"additionalProperties": false,
|
|
764
|
+
"description": "Policy represents a governance policy.",
|
|
765
|
+
"properties": {
|
|
766
|
+
"created_at": {
|
|
767
|
+
"description": "Timestamp when policy was created.",
|
|
768
|
+
"format": "date-time",
|
|
769
|
+
"title": "created_at",
|
|
770
|
+
"type": "string"
|
|
771
|
+
},
|
|
772
|
+
"id": {
|
|
773
|
+
"description": "Unique ID for the policy.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
|
|
774
|
+
"example": "pol_01h2xcejqtf2nbrexx3vqjhp41",
|
|
775
|
+
"pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
|
|
776
|
+
"title": "id",
|
|
777
|
+
"type": "string"
|
|
778
|
+
},
|
|
779
|
+
"name": {
|
|
780
|
+
"description": "Policy name.",
|
|
781
|
+
"example": "GDPR Compliance Policy",
|
|
782
|
+
"minLength": 1,
|
|
783
|
+
"title": "name",
|
|
784
|
+
"type": "string"
|
|
785
|
+
}
|
|
786
|
+
},
|
|
787
|
+
"required": [
|
|
788
|
+
"id",
|
|
789
|
+
"name",
|
|
790
|
+
"created_at"
|
|
791
|
+
],
|
|
792
|
+
"title": "Policy",
|
|
793
|
+
"type": "object"
|
|
794
|
+
},
|
|
795
|
+
"ProcessingStatus": {
|
|
796
|
+
"enum": [
|
|
797
|
+
"processing",
|
|
798
|
+
"ready",
|
|
799
|
+
"failed"
|
|
800
|
+
]
|
|
801
|
+
},
|
|
802
|
+
"UpdateDocumentRequest": {
|
|
803
|
+
"additionalProperties": false,
|
|
804
|
+
"description": "UpdateDocumentRequest specifies fields to update on a document.",
|
|
805
|
+
"properties": {
|
|
806
|
+
"description": {
|
|
807
|
+
"description": "New description (max 2000 characters).",
|
|
808
|
+
"maxLength": 2000,
|
|
809
|
+
"nullable": true,
|
|
810
|
+
"title": "description",
|
|
811
|
+
"type": "string"
|
|
812
|
+
},
|
|
813
|
+
"document_id": {
|
|
814
|
+
"description": "Document ID to update.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
815
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
816
|
+
"title": "document_id",
|
|
817
|
+
"type": "string"
|
|
818
|
+
},
|
|
819
|
+
"title": {
|
|
820
|
+
"description": "New title (1-255 characters).",
|
|
821
|
+
"maxLength": 255,
|
|
822
|
+
"minLength": 1,
|
|
823
|
+
"nullable": true,
|
|
824
|
+
"title": "title",
|
|
825
|
+
"type": "string"
|
|
826
|
+
}
|
|
827
|
+
},
|
|
828
|
+
"title": "UpdateDocumentRequest",
|
|
829
|
+
"type": "object"
|
|
830
|
+
},
|
|
831
|
+
"UpdateDocumentResponse": {
|
|
832
|
+
"additionalProperties": false,
|
|
833
|
+
"description": "UpdateDocumentResponse contains the updated document.",
|
|
834
|
+
"properties": {
|
|
835
|
+
"document": {
|
|
836
|
+
"$ref": "#/components/schemas/Document",
|
|
837
|
+
"description": "The updated document.",
|
|
838
|
+
"title": "document"
|
|
839
|
+
}
|
|
840
|
+
},
|
|
841
|
+
"title": "UpdateDocumentResponse",
|
|
842
|
+
"type": "object"
|
|
843
|
+
},
|
|
844
|
+
"UpdateVersionRequest": {
|
|
845
|
+
"additionalProperties": false,
|
|
846
|
+
"description": "UpdateVersionRequest specifies fields to update on a version.",
|
|
847
|
+
"properties": {
|
|
848
|
+
"description": {
|
|
849
|
+
"description": "New description.",
|
|
850
|
+
"nullable": true,
|
|
851
|
+
"title": "description",
|
|
852
|
+
"type": "string"
|
|
853
|
+
},
|
|
854
|
+
"document_id": {
|
|
855
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
856
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
857
|
+
"title": "document_id",
|
|
858
|
+
"type": "string"
|
|
859
|
+
},
|
|
860
|
+
"title": {
|
|
861
|
+
"description": "New title (max 255 characters).",
|
|
862
|
+
"maxLength": 255,
|
|
863
|
+
"nullable": true,
|
|
864
|
+
"title": "title",
|
|
865
|
+
"type": "string"
|
|
866
|
+
},
|
|
867
|
+
"version_id": {
|
|
868
|
+
"description": "Version ID to update.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
869
|
+
"pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
|
|
870
|
+
"title": "version_id",
|
|
871
|
+
"type": "string"
|
|
872
|
+
}
|
|
873
|
+
},
|
|
874
|
+
"title": "UpdateVersionRequest",
|
|
875
|
+
"type": "object"
|
|
876
|
+
},
|
|
877
|
+
"User": {
|
|
878
|
+
"additionalProperties": false,
|
|
879
|
+
"description": "User represents a user or service account.",
|
|
880
|
+
"properties": {
|
|
881
|
+
"id": {
|
|
882
|
+
"description": "Unique ID for the user or service account.\n Pattern: user_[0-9a-hjkmnp-tv-z]{26} for users, svc_[0-9a-hjkmnp-tv-z]{26} for service accounts",
|
|
883
|
+
"example": "user_01h2xcejqtf2nbrexx3vqjhp41",
|
|
884
|
+
"pattern": "^(user|svc)_[0-9a-hjkmnp-tv-z]{26}$",
|
|
885
|
+
"title": "id",
|
|
886
|
+
"type": "string"
|
|
887
|
+
},
|
|
888
|
+
"name": {
|
|
889
|
+
"description": "Display name of the user or service account.",
|
|
890
|
+
"example": "John Doe",
|
|
891
|
+
"minLength": 1,
|
|
892
|
+
"title": "name",
|
|
893
|
+
"type": "string"
|
|
894
|
+
},
|
|
895
|
+
"type": {
|
|
896
|
+
"$ref": "#/components/schemas/UserType",
|
|
897
|
+
"description": "User type discriminator.",
|
|
898
|
+
"title": "type"
|
|
899
|
+
}
|
|
900
|
+
},
|
|
901
|
+
"required": [
|
|
902
|
+
"id",
|
|
903
|
+
"type",
|
|
904
|
+
"name"
|
|
905
|
+
],
|
|
906
|
+
"title": "User",
|
|
907
|
+
"type": "object"
|
|
908
|
+
},
|
|
909
|
+
"UserType": {
|
|
910
|
+
"enum": [
|
|
911
|
+
"user_account",
|
|
912
|
+
"service_account"
|
|
913
|
+
]
|
|
914
|
+
},
|
|
915
|
+
"Version": {
|
|
916
|
+
"additionalProperties": false,
|
|
917
|
+
"description": "Version represents a document version.",
|
|
918
|
+
"properties": {
|
|
919
|
+
"created_at": {
|
|
920
|
+
"description": "Timestamp when version was created.",
|
|
921
|
+
"format": "date-time",
|
|
922
|
+
"title": "created_at",
|
|
923
|
+
"type": "string"
|
|
924
|
+
},
|
|
925
|
+
"created_by": {
|
|
926
|
+
"$ref": "#/components/schemas/User",
|
|
927
|
+
"description": "User who created the version.",
|
|
928
|
+
"title": "created_by"
|
|
929
|
+
},
|
|
930
|
+
"description": {
|
|
931
|
+
"description": "Description of changes in this version.",
|
|
932
|
+
"nullable": true,
|
|
933
|
+
"title": "description",
|
|
934
|
+
"type": "string"
|
|
935
|
+
},
|
|
936
|
+
"document_id": {
|
|
937
|
+
"description": "Parent document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
938
|
+
"example": "doc_01h2xcejqtf2nbrexx3vqjhp41",
|
|
939
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
940
|
+
"title": "document_id",
|
|
941
|
+
"type": "string"
|
|
942
|
+
},
|
|
943
|
+
"id": {
|
|
944
|
+
"description": "Unique ID for the version.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
945
|
+
"example": "ver_01h2abcd1234efgh5678jkmnpt",
|
|
946
|
+
"pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
|
|
947
|
+
"title": "id",
|
|
948
|
+
"type": "string"
|
|
949
|
+
},
|
|
950
|
+
"processing_status": {
|
|
951
|
+
"$ref": "#/components/schemas/ProcessingStatus",
|
|
952
|
+
"description": "Processing status.",
|
|
953
|
+
"title": "processing_status"
|
|
954
|
+
},
|
|
955
|
+
"title": {
|
|
956
|
+
"description": "Optional version title.",
|
|
957
|
+
"example": "Version 2.0",
|
|
958
|
+
"maxLength": 255,
|
|
959
|
+
"nullable": true,
|
|
960
|
+
"title": "title",
|
|
961
|
+
"type": "string"
|
|
962
|
+
},
|
|
963
|
+
"url": {
|
|
964
|
+
"description": "URL for accessing this version on Factify.",
|
|
965
|
+
"example": "https://d.factify.com/d/01h2xcejqtf2nbrexx3vqjhp41/v/1",
|
|
966
|
+
"format": "uri",
|
|
967
|
+
"title": "url",
|
|
968
|
+
"type": "string"
|
|
969
|
+
}
|
|
970
|
+
},
|
|
971
|
+
"required": [
|
|
972
|
+
"id",
|
|
973
|
+
"document_id",
|
|
974
|
+
"url",
|
|
975
|
+
"processing_status",
|
|
976
|
+
"created_at",
|
|
977
|
+
"created_by"
|
|
978
|
+
],
|
|
979
|
+
"title": "Version",
|
|
980
|
+
"type": "object"
|
|
981
|
+
},
|
|
982
|
+
"VersionRef": {
|
|
983
|
+
"additionalProperties": false,
|
|
984
|
+
"description": "VersionRef is a lightweight reference to a version.",
|
|
985
|
+
"properties": {
|
|
986
|
+
"id": {
|
|
987
|
+
"description": "Version ID.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
988
|
+
"example": "ver_01h2abcd1234efgh5678jkmnpt",
|
|
989
|
+
"pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
|
|
990
|
+
"title": "id",
|
|
991
|
+
"type": "string"
|
|
992
|
+
}
|
|
993
|
+
},
|
|
994
|
+
"required": [
|
|
995
|
+
"id"
|
|
996
|
+
],
|
|
997
|
+
"title": "VersionRef",
|
|
998
|
+
"type": "object"
|
|
999
|
+
}
|
|
1000
|
+
},
|
|
1001
|
+
"securitySchemes": {
|
|
1002
|
+
"bearerAuth": {
|
|
1003
|
+
"bearerFormat": "API Key",
|
|
1004
|
+
"description": "Bearer authentication header of the form Bearer <token>, where <token> is your auth token.",
|
|
1005
|
+
"scheme": "bearer",
|
|
1006
|
+
"type": "http"
|
|
1007
|
+
}
|
|
1008
|
+
}
|
|
1009
|
+
},
|
|
1010
|
+
"info": {
|
|
1011
|
+
"contact": {
|
|
1012
|
+
"email": "api@factify.com",
|
|
1013
|
+
"name": "Factify API Support",
|
|
1014
|
+
"url": "https://factify.com/support"
|
|
1015
|
+
},
|
|
1016
|
+
"description": "Factify API enables you to create, manage, and control access to legally-binding documents that replace PDFs.\n\n## Authentication\n\nBearer authentication header of the form Bearer <token>, where <token> is your auth token.\n\n```\nAuthorization: Bearer ffy...\n```\n\n## Rate Limiting\n\n- 1000 requests per minute per API key\n- 100 requests per minute for resource creation (POST)\n\n## Errors\n\nFactify uses conventional HTTP status codes and returns structured error responses:\n\n```json\n{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"message\": \"Document title cannot be empty\",\n \"param\": \"title\",\n \"code\": \"missing_required_field\"\n }\n}\n```\n",
|
|
1017
|
+
"license": {
|
|
1018
|
+
"name": "Proprietary",
|
|
1019
|
+
"url": "https://factify.com/terms"
|
|
1020
|
+
},
|
|
1021
|
+
"title": "Factify API",
|
|
1022
|
+
"version": "1.0.0"
|
|
1023
|
+
},
|
|
1024
|
+
"openapi": "3.1.0",
|
|
1025
|
+
"paths": {
|
|
1026
|
+
"/v1beta/documents": {
|
|
1027
|
+
"get": {
|
|
1028
|
+
"description": "List documents with cursor-based pagination.",
|
|
1029
|
+
"operationId": "listDocuments",
|
|
1030
|
+
"parameters": [
|
|
1031
|
+
{
|
|
1032
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
1033
|
+
"in": "query",
|
|
1034
|
+
"name": "page_token",
|
|
1035
|
+
"schema": {
|
|
1036
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
1037
|
+
"example": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0",
|
|
1038
|
+
"title": "page_token",
|
|
1039
|
+
"type": "string"
|
|
1040
|
+
}
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
1044
|
+
"in": "query",
|
|
1045
|
+
"name": "page_size",
|
|
1046
|
+
"schema": {
|
|
1047
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
1048
|
+
"format": "int32",
|
|
1049
|
+
"maximum": 100,
|
|
1050
|
+
"minimum": 1,
|
|
1051
|
+
"title": "page_size",
|
|
1052
|
+
"type": "integer"
|
|
1053
|
+
}
|
|
1054
|
+
},
|
|
1055
|
+
{
|
|
1056
|
+
"description": "Filter by created after (RFC 3339 format, e.g., 2024-01-15T09:30:00Z)",
|
|
1057
|
+
"in": "query",
|
|
1058
|
+
"name": "created_after",
|
|
1059
|
+
"schema": {
|
|
1060
|
+
"format": "date-time",
|
|
1061
|
+
"type": "string"
|
|
1062
|
+
}
|
|
1063
|
+
}
|
|
1064
|
+
],
|
|
1065
|
+
"responses": {
|
|
1066
|
+
"200": {
|
|
1067
|
+
"content": {
|
|
1068
|
+
"application/json": {
|
|
1069
|
+
"schema": {
|
|
1070
|
+
"$ref": "#/components/schemas/ListDocumentsResponse"
|
|
1071
|
+
}
|
|
1072
|
+
}
|
|
1073
|
+
},
|
|
1074
|
+
"description": "Success"
|
|
1075
|
+
},
|
|
1076
|
+
"400": {
|
|
1077
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1078
|
+
},
|
|
1079
|
+
"401": {
|
|
1080
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1081
|
+
},
|
|
1082
|
+
"403": {
|
|
1083
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1084
|
+
},
|
|
1085
|
+
"404": {
|
|
1086
|
+
"$ref": "#/components/responses/NotFound"
|
|
1087
|
+
},
|
|
1088
|
+
"429": {
|
|
1089
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1090
|
+
},
|
|
1091
|
+
"500": {
|
|
1092
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"summary": "List documents",
|
|
1096
|
+
"tags": [
|
|
1097
|
+
"Documents"
|
|
1098
|
+
],
|
|
1099
|
+
"x-speakeasy-name-override": "list",
|
|
1100
|
+
"x-speakeasy-pagination": {
|
|
1101
|
+
"type": "cursor",
|
|
1102
|
+
"inputs": [
|
|
1103
|
+
{
|
|
1104
|
+
"name": "page_token",
|
|
1105
|
+
"in": "parameters",
|
|
1106
|
+
"type": "cursor"
|
|
1107
|
+
}
|
|
1108
|
+
],
|
|
1109
|
+
"outputs": {
|
|
1110
|
+
"nextCursor": "$.pagination.next_page_token"
|
|
1111
|
+
}
|
|
1112
|
+
},
|
|
1113
|
+
"x-codeSamples": [
|
|
1114
|
+
{
|
|
1115
|
+
"lang": "typescript",
|
|
1116
|
+
"label": "listDocuments",
|
|
1117
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.documents.list({\n pageToken: \"eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
|
|
1118
|
+
},
|
|
1119
|
+
{
|
|
1120
|
+
"lang": "java",
|
|
1121
|
+
"label": "listDocuments",
|
|
1122
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.ListDocumentsResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n\n sdk.documents().list()\n .pageToken(\"eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0\")\n .callAsStream()\n .forEach((ListDocumentsResponse item) -> {\n // handle page\n });\n\n }\n}"
|
|
1123
|
+
}
|
|
1124
|
+
]
|
|
1125
|
+
},
|
|
1126
|
+
"post": {
|
|
1127
|
+
"description": "Creates a new document by uploading a PDF file.",
|
|
1128
|
+
"operationId": "createDocument",
|
|
1129
|
+
"requestBody": {
|
|
1130
|
+
"content": {
|
|
1131
|
+
"multipart/form-data": {
|
|
1132
|
+
"schema": {
|
|
1133
|
+
"$ref": "#/components/schemas/CreateDocumentRequest"
|
|
1134
|
+
}
|
|
1135
|
+
}
|
|
1136
|
+
},
|
|
1137
|
+
"required": true
|
|
1138
|
+
},
|
|
1139
|
+
"responses": {
|
|
1140
|
+
"200": {
|
|
1141
|
+
"content": {
|
|
1142
|
+
"application/json": {
|
|
1143
|
+
"schema": {
|
|
1144
|
+
"$ref": "#/components/schemas/CreateDocumentResponse"
|
|
1145
|
+
}
|
|
1146
|
+
}
|
|
1147
|
+
},
|
|
1148
|
+
"description": "Success"
|
|
1149
|
+
},
|
|
1150
|
+
"400": {
|
|
1151
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1152
|
+
},
|
|
1153
|
+
"401": {
|
|
1154
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1155
|
+
},
|
|
1156
|
+
"403": {
|
|
1157
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1158
|
+
},
|
|
1159
|
+
"404": {
|
|
1160
|
+
"$ref": "#/components/responses/NotFound"
|
|
1161
|
+
},
|
|
1162
|
+
"429": {
|
|
1163
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1164
|
+
},
|
|
1165
|
+
"500": {
|
|
1166
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1167
|
+
}
|
|
1168
|
+
},
|
|
1169
|
+
"summary": "Create a document",
|
|
1170
|
+
"tags": [
|
|
1171
|
+
"Documents"
|
|
1172
|
+
],
|
|
1173
|
+
"x-speakeasy-name-override": "create",
|
|
1174
|
+
"x-codeSamples": [
|
|
1175
|
+
{
|
|
1176
|
+
"lang": "typescript",
|
|
1177
|
+
"label": "createDocument",
|
|
1178
|
+
"source": "import { Factify } from \"@factify/sdk\";\nimport { openAsBlob } from \"node:fs\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.documents.create({\n payload: await openAsBlob(\"example.file\"),\n title: \"<value>\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1179
|
+
},
|
|
1180
|
+
{
|
|
1181
|
+
"lang": "java",
|
|
1182
|
+
"label": "createDocument",
|
|
1183
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport java.nio.file.Paths;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.components.CreateDocumentRequest;\nimport org.openapis.openapi.models.components.CreateDocumentRequestPayload;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.CreateDocumentResponse;\nimport org.openapis.openapi.utils.Blob;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n CreateDocumentRequest req = CreateDocumentRequest.builder()\n .payload(CreateDocumentRequestPayload.builder()\n .fileName(\"example.file\")\n .content(Blob.from(Paths.get(\"example.file\")))\n .build())\n .title(\"<value>\")\n .build();\n\n CreateDocumentResponse res = sdk.documents().create()\n .request(req)\n .call();\n\n }\n}"
|
|
1184
|
+
}
|
|
1185
|
+
]
|
|
1186
|
+
}
|
|
1187
|
+
},
|
|
1188
|
+
"/v1beta/documents/{document_id}": {
|
|
1189
|
+
"get": {
|
|
1190
|
+
"description": "Retrieve a document by ID.",
|
|
1191
|
+
"operationId": "getDocument",
|
|
1192
|
+
"parameters": [
|
|
1193
|
+
{
|
|
1194
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1195
|
+
"in": "path",
|
|
1196
|
+
"name": "document_id",
|
|
1197
|
+
"required": true,
|
|
1198
|
+
"schema": {
|
|
1199
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1200
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1201
|
+
"title": "document_id",
|
|
1202
|
+
"type": "string"
|
|
1203
|
+
}
|
|
1204
|
+
}
|
|
1205
|
+
],
|
|
1206
|
+
"responses": {
|
|
1207
|
+
"200": {
|
|
1208
|
+
"content": {
|
|
1209
|
+
"application/json": {
|
|
1210
|
+
"schema": {
|
|
1211
|
+
"$ref": "#/components/schemas/GetDocumentResponse"
|
|
1212
|
+
}
|
|
1213
|
+
}
|
|
1214
|
+
},
|
|
1215
|
+
"description": "Success"
|
|
1216
|
+
},
|
|
1217
|
+
"400": {
|
|
1218
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1219
|
+
},
|
|
1220
|
+
"401": {
|
|
1221
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1222
|
+
},
|
|
1223
|
+
"403": {
|
|
1224
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1225
|
+
},
|
|
1226
|
+
"404": {
|
|
1227
|
+
"$ref": "#/components/responses/NotFound"
|
|
1228
|
+
},
|
|
1229
|
+
"429": {
|
|
1230
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1231
|
+
},
|
|
1232
|
+
"500": {
|
|
1233
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1234
|
+
}
|
|
1235
|
+
},
|
|
1236
|
+
"summary": "Retrieve a document",
|
|
1237
|
+
"tags": [
|
|
1238
|
+
"Documents"
|
|
1239
|
+
],
|
|
1240
|
+
"x-speakeasy-name-override": "get",
|
|
1241
|
+
"x-codeSamples": [
|
|
1242
|
+
{
|
|
1243
|
+
"lang": "typescript",
|
|
1244
|
+
"label": "getDocument",
|
|
1245
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.documents.get({\n documentId: \"<id>\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1246
|
+
},
|
|
1247
|
+
{
|
|
1248
|
+
"lang": "java",
|
|
1249
|
+
"label": "getDocument",
|
|
1250
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.GetDocumentResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n GetDocumentResponse res = sdk.documents().get()\n .documentId(\"<id>\")\n .call();\n\n if (res.getDocumentResponse().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1251
|
+
}
|
|
1252
|
+
]
|
|
1253
|
+
},
|
|
1254
|
+
"patch": {
|
|
1255
|
+
"description": "Update document title and description.",
|
|
1256
|
+
"operationId": "updateDocument",
|
|
1257
|
+
"parameters": [
|
|
1258
|
+
{
|
|
1259
|
+
"description": "Document ID to update.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1260
|
+
"in": "path",
|
|
1261
|
+
"name": "document_id",
|
|
1262
|
+
"required": true,
|
|
1263
|
+
"schema": {
|
|
1264
|
+
"description": "Document ID to update.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1265
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1266
|
+
"title": "document_id",
|
|
1267
|
+
"type": "string"
|
|
1268
|
+
}
|
|
1269
|
+
}
|
|
1270
|
+
],
|
|
1271
|
+
"requestBody": {
|
|
1272
|
+
"content": {
|
|
1273
|
+
"application/json": {
|
|
1274
|
+
"schema": {
|
|
1275
|
+
"additionalProperties": false,
|
|
1276
|
+
"description": "UpdateDocumentRequest specifies fields to update on a document.",
|
|
1277
|
+
"properties": {
|
|
1278
|
+
"description": {
|
|
1279
|
+
"description": "New description (max 2000 characters).",
|
|
1280
|
+
"maxLength": 2000,
|
|
1281
|
+
"nullable": true,
|
|
1282
|
+
"title": "description",
|
|
1283
|
+
"type": "string"
|
|
1284
|
+
},
|
|
1285
|
+
"title": {
|
|
1286
|
+
"description": "New title (1-255 characters).",
|
|
1287
|
+
"maxLength": 255,
|
|
1288
|
+
"minLength": 1,
|
|
1289
|
+
"nullable": true,
|
|
1290
|
+
"title": "title",
|
|
1291
|
+
"type": "string"
|
|
1292
|
+
}
|
|
1293
|
+
},
|
|
1294
|
+
"title": "UpdateDocumentRequest",
|
|
1295
|
+
"type": "object"
|
|
1296
|
+
}
|
|
1297
|
+
}
|
|
1298
|
+
},
|
|
1299
|
+
"required": true
|
|
1300
|
+
},
|
|
1301
|
+
"responses": {
|
|
1302
|
+
"200": {
|
|
1303
|
+
"content": {
|
|
1304
|
+
"application/json": {
|
|
1305
|
+
"schema": {
|
|
1306
|
+
"$ref": "#/components/schemas/UpdateDocumentResponse"
|
|
1307
|
+
}
|
|
1308
|
+
}
|
|
1309
|
+
},
|
|
1310
|
+
"description": "Success"
|
|
1311
|
+
},
|
|
1312
|
+
"400": {
|
|
1313
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1314
|
+
},
|
|
1315
|
+
"401": {
|
|
1316
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1317
|
+
},
|
|
1318
|
+
"403": {
|
|
1319
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1320
|
+
},
|
|
1321
|
+
"404": {
|
|
1322
|
+
"$ref": "#/components/responses/NotFound"
|
|
1323
|
+
},
|
|
1324
|
+
"429": {
|
|
1325
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1326
|
+
},
|
|
1327
|
+
"500": {
|
|
1328
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1329
|
+
}
|
|
1330
|
+
},
|
|
1331
|
+
"summary": "Update a document",
|
|
1332
|
+
"tags": [
|
|
1333
|
+
"Documents"
|
|
1334
|
+
],
|
|
1335
|
+
"x-speakeasy-name-override": "update",
|
|
1336
|
+
"x-codeSamples": [
|
|
1337
|
+
{
|
|
1338
|
+
"lang": "typescript",
|
|
1339
|
+
"label": "updateDocument",
|
|
1340
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.documents.update({\n documentId: \"<id>\",\n body: {},\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1341
|
+
},
|
|
1342
|
+
{
|
|
1343
|
+
"lang": "java",
|
|
1344
|
+
"label": "updateDocument",
|
|
1345
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.UpdateDocumentResponse;\nimport org.openapis.openapi.models.operations.UpdateDocumentUpdateDocumentRequest;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n UpdateDocumentResponse res = sdk.documents().update()\n .documentId(\"<id>\")\n .body(UpdateDocumentUpdateDocumentRequest.builder()\n .build())\n .call();\n\n if (res.updateDocumentResponse().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1346
|
+
}
|
|
1347
|
+
]
|
|
1348
|
+
}
|
|
1349
|
+
},
|
|
1350
|
+
"/v1beta/documents/{document_id}/entry_page": {
|
|
1351
|
+
"post": {
|
|
1352
|
+
"description": "Generate and return a temporary downloadable URL for the document entry page PDF.",
|
|
1353
|
+
"operationId": "generateDocumentEntryPage",
|
|
1354
|
+
"parameters": [
|
|
1355
|
+
{
|
|
1356
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1357
|
+
"in": "path",
|
|
1358
|
+
"name": "document_id",
|
|
1359
|
+
"required": true,
|
|
1360
|
+
"schema": {
|
|
1361
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1362
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1363
|
+
"title": "document_id",
|
|
1364
|
+
"type": "string"
|
|
1365
|
+
}
|
|
1366
|
+
}
|
|
1367
|
+
],
|
|
1368
|
+
"responses": {
|
|
1369
|
+
"200": {
|
|
1370
|
+
"content": {
|
|
1371
|
+
"application/json": {
|
|
1372
|
+
"schema": {
|
|
1373
|
+
"$ref": "#/components/schemas/GenerateEntryPageResponse"
|
|
1374
|
+
}
|
|
1375
|
+
}
|
|
1376
|
+
},
|
|
1377
|
+
"description": "Success"
|
|
1378
|
+
},
|
|
1379
|
+
"400": {
|
|
1380
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1381
|
+
},
|
|
1382
|
+
"401": {
|
|
1383
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1384
|
+
},
|
|
1385
|
+
"403": {
|
|
1386
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1387
|
+
},
|
|
1388
|
+
"404": {
|
|
1389
|
+
"$ref": "#/components/responses/NotFound"
|
|
1390
|
+
},
|
|
1391
|
+
"429": {
|
|
1392
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1393
|
+
},
|
|
1394
|
+
"500": {
|
|
1395
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1396
|
+
}
|
|
1397
|
+
},
|
|
1398
|
+
"summary": "Generate entry page",
|
|
1399
|
+
"tags": [
|
|
1400
|
+
"Entry Pages"
|
|
1401
|
+
],
|
|
1402
|
+
"x-speakeasy-group": "entryPages",
|
|
1403
|
+
"x-speakeasy-name-override": "generate",
|
|
1404
|
+
"x-codeSamples": [
|
|
1405
|
+
{
|
|
1406
|
+
"lang": "typescript",
|
|
1407
|
+
"label": "generateDocumentEntryPage",
|
|
1408
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.entryPages.generate({\n documentId: \"<id>\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1409
|
+
},
|
|
1410
|
+
{
|
|
1411
|
+
"lang": "java",
|
|
1412
|
+
"label": "generateDocumentEntryPage",
|
|
1413
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.GenerateDocumentEntryPageResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n GenerateDocumentEntryPageResponse res = sdk.entryPages().generate()\n .documentId(\"<id>\")\n .call();\n\n if (res.generateEntryPageResponse().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1414
|
+
}
|
|
1415
|
+
]
|
|
1416
|
+
}
|
|
1417
|
+
},
|
|
1418
|
+
"/v1beta/documents/{document_id}/policies": {
|
|
1419
|
+
"get": {
|
|
1420
|
+
"description": "List policies attached to a document.",
|
|
1421
|
+
"operationId": "listDocumentPolicies",
|
|
1422
|
+
"parameters": [
|
|
1423
|
+
{
|
|
1424
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1425
|
+
"in": "path",
|
|
1426
|
+
"name": "document_id",
|
|
1427
|
+
"required": true,
|
|
1428
|
+
"schema": {
|
|
1429
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1430
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1431
|
+
"title": "document_id",
|
|
1432
|
+
"type": "string"
|
|
1433
|
+
}
|
|
1434
|
+
},
|
|
1435
|
+
{
|
|
1436
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
1437
|
+
"in": "query",
|
|
1438
|
+
"name": "page_token",
|
|
1439
|
+
"schema": {
|
|
1440
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
1441
|
+
"example": "eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0",
|
|
1442
|
+
"title": "page_token",
|
|
1443
|
+
"type": "string"
|
|
1444
|
+
}
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
1448
|
+
"in": "query",
|
|
1449
|
+
"name": "page_size",
|
|
1450
|
+
"schema": {
|
|
1451
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
1452
|
+
"format": "int32",
|
|
1453
|
+
"maximum": 100,
|
|
1454
|
+
"minimum": 1,
|
|
1455
|
+
"title": "page_size",
|
|
1456
|
+
"type": "integer"
|
|
1457
|
+
}
|
|
1458
|
+
}
|
|
1459
|
+
],
|
|
1460
|
+
"responses": {
|
|
1461
|
+
"200": {
|
|
1462
|
+
"content": {
|
|
1463
|
+
"application/json": {
|
|
1464
|
+
"schema": {
|
|
1465
|
+
"$ref": "#/components/schemas/ListDocumentPoliciesResponse"
|
|
1466
|
+
}
|
|
1467
|
+
}
|
|
1468
|
+
},
|
|
1469
|
+
"description": "Success"
|
|
1470
|
+
},
|
|
1471
|
+
"400": {
|
|
1472
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1473
|
+
},
|
|
1474
|
+
"401": {
|
|
1475
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1476
|
+
},
|
|
1477
|
+
"403": {
|
|
1478
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1479
|
+
},
|
|
1480
|
+
"404": {
|
|
1481
|
+
"$ref": "#/components/responses/NotFound"
|
|
1482
|
+
},
|
|
1483
|
+
"429": {
|
|
1484
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1485
|
+
},
|
|
1486
|
+
"500": {
|
|
1487
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1488
|
+
}
|
|
1489
|
+
},
|
|
1490
|
+
"summary": "List document policies",
|
|
1491
|
+
"tags": [
|
|
1492
|
+
"Policies"
|
|
1493
|
+
],
|
|
1494
|
+
"x-speakeasy-name-override": "list",
|
|
1495
|
+
"x-speakeasy-pagination": {
|
|
1496
|
+
"type": "cursor",
|
|
1497
|
+
"inputs": [
|
|
1498
|
+
{
|
|
1499
|
+
"name": "page_token",
|
|
1500
|
+
"in": "parameters",
|
|
1501
|
+
"type": "cursor"
|
|
1502
|
+
}
|
|
1503
|
+
],
|
|
1504
|
+
"outputs": {
|
|
1505
|
+
"nextCursor": "$.pagination.next_page_token"
|
|
1506
|
+
}
|
|
1507
|
+
},
|
|
1508
|
+
"x-codeSamples": [
|
|
1509
|
+
{
|
|
1510
|
+
"lang": "typescript",
|
|
1511
|
+
"label": "listDocumentPolicies",
|
|
1512
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.policies.list({\n documentId: \"<id>\",\n pageToken: \"eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
|
|
1513
|
+
},
|
|
1514
|
+
{
|
|
1515
|
+
"lang": "java",
|
|
1516
|
+
"label": "listDocumentPolicies",
|
|
1517
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.ListDocumentPoliciesResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n\n sdk.policies().list()\n .documentId(\"<id>\")\n .pageToken(\"eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\")\n .callAsStream()\n .forEach((ListDocumentPoliciesResponse item) -> {\n // handle page\n });\n\n }\n}"
|
|
1518
|
+
}
|
|
1519
|
+
]
|
|
1520
|
+
},
|
|
1521
|
+
"post": {
|
|
1522
|
+
"description": "Attach a policy to a document.",
|
|
1523
|
+
"operationId": "attachDocumentPolicy",
|
|
1524
|
+
"parameters": [
|
|
1525
|
+
{
|
|
1526
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1527
|
+
"in": "path",
|
|
1528
|
+
"name": "document_id",
|
|
1529
|
+
"required": true,
|
|
1530
|
+
"schema": {
|
|
1531
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1532
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1533
|
+
"title": "document_id",
|
|
1534
|
+
"type": "string"
|
|
1535
|
+
}
|
|
1536
|
+
}
|
|
1537
|
+
],
|
|
1538
|
+
"requestBody": {
|
|
1539
|
+
"content": {
|
|
1540
|
+
"application/json": {
|
|
1541
|
+
"schema": {
|
|
1542
|
+
"additionalProperties": false,
|
|
1543
|
+
"description": "AttachPolicyRequest specifies a policy to attach to a document.",
|
|
1544
|
+
"properties": {
|
|
1545
|
+
"policy_id": {
|
|
1546
|
+
"description": "Policy ID to attach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
|
|
1547
|
+
"pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1548
|
+
"title": "policy_id",
|
|
1549
|
+
"type": "string"
|
|
1550
|
+
}
|
|
1551
|
+
},
|
|
1552
|
+
"required": [
|
|
1553
|
+
"policy_id"
|
|
1554
|
+
],
|
|
1555
|
+
"title": "AttachPolicyRequest",
|
|
1556
|
+
"type": "object"
|
|
1557
|
+
}
|
|
1558
|
+
}
|
|
1559
|
+
},
|
|
1560
|
+
"required": true
|
|
1561
|
+
},
|
|
1562
|
+
"responses": {
|
|
1563
|
+
"200": {
|
|
1564
|
+
"content": {
|
|
1565
|
+
"application/json": {
|
|
1566
|
+
"schema": {
|
|
1567
|
+
"$ref": "#/components/schemas/DocumentPolicy"
|
|
1568
|
+
}
|
|
1569
|
+
}
|
|
1570
|
+
},
|
|
1571
|
+
"description": "Success"
|
|
1572
|
+
},
|
|
1573
|
+
"400": {
|
|
1574
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1575
|
+
},
|
|
1576
|
+
"401": {
|
|
1577
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1578
|
+
},
|
|
1579
|
+
"403": {
|
|
1580
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1581
|
+
},
|
|
1582
|
+
"404": {
|
|
1583
|
+
"$ref": "#/components/responses/NotFound"
|
|
1584
|
+
},
|
|
1585
|
+
"429": {
|
|
1586
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1587
|
+
},
|
|
1588
|
+
"500": {
|
|
1589
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1590
|
+
}
|
|
1591
|
+
},
|
|
1592
|
+
"summary": "Attach a policy",
|
|
1593
|
+
"tags": [
|
|
1594
|
+
"Policies"
|
|
1595
|
+
],
|
|
1596
|
+
"x-speakeasy-name-override": "attach",
|
|
1597
|
+
"x-codeSamples": [
|
|
1598
|
+
{
|
|
1599
|
+
"lang": "typescript",
|
|
1600
|
+
"label": "attachDocumentPolicy",
|
|
1601
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.policies.attach({\n documentId: \"<id>\",\n body: {\n policyId: \"<id>\",\n },\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"lang": "java",
|
|
1605
|
+
"label": "attachDocumentPolicy",
|
|
1606
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.AttachDocumentPolicyResponse;\nimport org.openapis.openapi.models.operations.AttachPolicyRequest;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n AttachDocumentPolicyResponse res = sdk.policies().attach()\n .documentId(\"<id>\")\n .body(AttachPolicyRequest.builder()\n .policyId(\"<id>\")\n .build())\n .call();\n\n if (res.documentPolicy().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1607
|
+
}
|
|
1608
|
+
]
|
|
1609
|
+
}
|
|
1610
|
+
},
|
|
1611
|
+
"/v1beta/documents/{document_id}/policies/{policy_id}": {
|
|
1612
|
+
"delete": {
|
|
1613
|
+
"description": "Detach a policy from a document.",
|
|
1614
|
+
"operationId": "detachDocumentPolicy",
|
|
1615
|
+
"parameters": [
|
|
1616
|
+
{
|
|
1617
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1618
|
+
"in": "path",
|
|
1619
|
+
"name": "document_id",
|
|
1620
|
+
"required": true,
|
|
1621
|
+
"schema": {
|
|
1622
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1623
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1624
|
+
"title": "document_id",
|
|
1625
|
+
"type": "string"
|
|
1626
|
+
}
|
|
1627
|
+
},
|
|
1628
|
+
{
|
|
1629
|
+
"description": "Policy ID to detach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
|
|
1630
|
+
"in": "path",
|
|
1631
|
+
"name": "policy_id",
|
|
1632
|
+
"required": true,
|
|
1633
|
+
"schema": {
|
|
1634
|
+
"description": "Policy ID to detach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
|
|
1635
|
+
"pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1636
|
+
"title": "policy_id",
|
|
1637
|
+
"type": "string"
|
|
1638
|
+
}
|
|
1639
|
+
}
|
|
1640
|
+
],
|
|
1641
|
+
"responses": {
|
|
1642
|
+
"200": {
|
|
1643
|
+
"content": {
|
|
1644
|
+
"application/json": {
|
|
1645
|
+
"schema": {
|
|
1646
|
+
"$ref": "#/components/schemas/Empty"
|
|
1647
|
+
}
|
|
1648
|
+
}
|
|
1649
|
+
},
|
|
1650
|
+
"description": "Success"
|
|
1651
|
+
},
|
|
1652
|
+
"400": {
|
|
1653
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1654
|
+
},
|
|
1655
|
+
"401": {
|
|
1656
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1657
|
+
},
|
|
1658
|
+
"403": {
|
|
1659
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1660
|
+
},
|
|
1661
|
+
"404": {
|
|
1662
|
+
"$ref": "#/components/responses/NotFound"
|
|
1663
|
+
},
|
|
1664
|
+
"429": {
|
|
1665
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1666
|
+
},
|
|
1667
|
+
"500": {
|
|
1668
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1669
|
+
}
|
|
1670
|
+
},
|
|
1671
|
+
"summary": "Detach a policy",
|
|
1672
|
+
"tags": [
|
|
1673
|
+
"Policies"
|
|
1674
|
+
],
|
|
1675
|
+
"x-speakeasy-name-override": "detach",
|
|
1676
|
+
"x-codeSamples": [
|
|
1677
|
+
{
|
|
1678
|
+
"lang": "typescript",
|
|
1679
|
+
"label": "detachDocumentPolicy",
|
|
1680
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.policies.detach({\n documentId: \"<id>\",\n policyId: \"<id>\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1681
|
+
},
|
|
1682
|
+
{
|
|
1683
|
+
"lang": "java",
|
|
1684
|
+
"label": "detachDocumentPolicy",
|
|
1685
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.DetachDocumentPolicyResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n DetachDocumentPolicyResponse res = sdk.policies().detach()\n .documentId(\"<id>\")\n .policyId(\"<id>\")\n .call();\n\n if (res.empty().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1686
|
+
}
|
|
1687
|
+
]
|
|
1688
|
+
}
|
|
1689
|
+
},
|
|
1690
|
+
"/v1beta/documents/{document_id}/versions": {
|
|
1691
|
+
"get": {
|
|
1692
|
+
"description": "List versions for a document with cursor-based pagination.",
|
|
1693
|
+
"operationId": "listDocumentVersions",
|
|
1694
|
+
"parameters": [
|
|
1695
|
+
{
|
|
1696
|
+
"description": "Document ID to list versions for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1697
|
+
"in": "path",
|
|
1698
|
+
"name": "document_id",
|
|
1699
|
+
"required": true,
|
|
1700
|
+
"schema": {
|
|
1701
|
+
"description": "Document ID to list versions for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1702
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1703
|
+
"title": "document_id",
|
|
1704
|
+
"type": "string"
|
|
1705
|
+
}
|
|
1706
|
+
},
|
|
1707
|
+
{
|
|
1708
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
1709
|
+
"in": "query",
|
|
1710
|
+
"name": "page_token",
|
|
1711
|
+
"schema": {
|
|
1712
|
+
"description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
|
|
1713
|
+
"example": "eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0",
|
|
1714
|
+
"title": "page_token",
|
|
1715
|
+
"type": "string"
|
|
1716
|
+
}
|
|
1717
|
+
},
|
|
1718
|
+
{
|
|
1719
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
1720
|
+
"in": "query",
|
|
1721
|
+
"name": "page_size",
|
|
1722
|
+
"schema": {
|
|
1723
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
1724
|
+
"format": "int32",
|
|
1725
|
+
"maximum": 100,
|
|
1726
|
+
"minimum": 1,
|
|
1727
|
+
"title": "page_size",
|
|
1728
|
+
"type": "integer"
|
|
1729
|
+
}
|
|
1730
|
+
}
|
|
1731
|
+
],
|
|
1732
|
+
"responses": {
|
|
1733
|
+
"200": {
|
|
1734
|
+
"content": {
|
|
1735
|
+
"application/json": {
|
|
1736
|
+
"schema": {
|
|
1737
|
+
"$ref": "#/components/schemas/ListVersionsResponse"
|
|
1738
|
+
}
|
|
1739
|
+
}
|
|
1740
|
+
},
|
|
1741
|
+
"description": "Success"
|
|
1742
|
+
},
|
|
1743
|
+
"400": {
|
|
1744
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1745
|
+
},
|
|
1746
|
+
"401": {
|
|
1747
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1748
|
+
},
|
|
1749
|
+
"403": {
|
|
1750
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1751
|
+
},
|
|
1752
|
+
"404": {
|
|
1753
|
+
"$ref": "#/components/responses/NotFound"
|
|
1754
|
+
},
|
|
1755
|
+
"429": {
|
|
1756
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1757
|
+
},
|
|
1758
|
+
"500": {
|
|
1759
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1760
|
+
}
|
|
1761
|
+
},
|
|
1762
|
+
"summary": "List document versions",
|
|
1763
|
+
"tags": [
|
|
1764
|
+
"Versions"
|
|
1765
|
+
],
|
|
1766
|
+
"x-speakeasy-name-override": "list",
|
|
1767
|
+
"x-speakeasy-pagination": {
|
|
1768
|
+
"type": "cursor",
|
|
1769
|
+
"inputs": [
|
|
1770
|
+
{
|
|
1771
|
+
"name": "page_token",
|
|
1772
|
+
"in": "parameters",
|
|
1773
|
+
"type": "cursor"
|
|
1774
|
+
}
|
|
1775
|
+
],
|
|
1776
|
+
"outputs": {
|
|
1777
|
+
"nextCursor": "$.pagination.next_page_token"
|
|
1778
|
+
}
|
|
1779
|
+
},
|
|
1780
|
+
"x-codeSamples": [
|
|
1781
|
+
{
|
|
1782
|
+
"lang": "typescript",
|
|
1783
|
+
"label": "listDocumentVersions",
|
|
1784
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.versions.list({\n documentId: \"<id>\",\n pageToken: \"eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
|
|
1785
|
+
},
|
|
1786
|
+
{
|
|
1787
|
+
"lang": "java",
|
|
1788
|
+
"label": "listDocumentVersions",
|
|
1789
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.ListDocumentVersionsResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n\n sdk.versions().list()\n .documentId(\"<id>\")\n .pageToken(\"eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\")\n .callAsStream()\n .forEach((ListDocumentVersionsResponse item) -> {\n // handle page\n });\n\n }\n}"
|
|
1790
|
+
}
|
|
1791
|
+
]
|
|
1792
|
+
},
|
|
1793
|
+
"post": {
|
|
1794
|
+
"description": "Creates a new version by uploading a PDF file.",
|
|
1795
|
+
"operationId": "createDocumentVersion",
|
|
1796
|
+
"parameters": [
|
|
1797
|
+
{
|
|
1798
|
+
"description": "Document ID to create version for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1799
|
+
"in": "path",
|
|
1800
|
+
"name": "document_id",
|
|
1801
|
+
"required": true,
|
|
1802
|
+
"schema": {
|
|
1803
|
+
"description": "Document ID to create version for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1804
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1805
|
+
"title": "document_id",
|
|
1806
|
+
"type": "string"
|
|
1807
|
+
}
|
|
1808
|
+
}
|
|
1809
|
+
],
|
|
1810
|
+
"requestBody": {
|
|
1811
|
+
"content": {
|
|
1812
|
+
"multipart/form-data": {
|
|
1813
|
+
"schema": {
|
|
1814
|
+
"$ref": "#/components/schemas/CreateVersionRequest"
|
|
1815
|
+
}
|
|
1816
|
+
}
|
|
1817
|
+
},
|
|
1818
|
+
"required": true
|
|
1819
|
+
},
|
|
1820
|
+
"responses": {
|
|
1821
|
+
"200": {
|
|
1822
|
+
"content": {
|
|
1823
|
+
"application/json": {
|
|
1824
|
+
"schema": {
|
|
1825
|
+
"$ref": "#/components/schemas/Version"
|
|
1826
|
+
}
|
|
1827
|
+
}
|
|
1828
|
+
},
|
|
1829
|
+
"description": "Success"
|
|
1830
|
+
},
|
|
1831
|
+
"400": {
|
|
1832
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1833
|
+
},
|
|
1834
|
+
"401": {
|
|
1835
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1836
|
+
},
|
|
1837
|
+
"403": {
|
|
1838
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1839
|
+
},
|
|
1840
|
+
"404": {
|
|
1841
|
+
"$ref": "#/components/responses/NotFound"
|
|
1842
|
+
},
|
|
1843
|
+
"429": {
|
|
1844
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1845
|
+
},
|
|
1846
|
+
"500": {
|
|
1847
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1848
|
+
}
|
|
1849
|
+
},
|
|
1850
|
+
"summary": "Create a new version",
|
|
1851
|
+
"tags": [
|
|
1852
|
+
"Versions"
|
|
1853
|
+
],
|
|
1854
|
+
"x-speakeasy-name-override": "create",
|
|
1855
|
+
"x-codeSamples": [
|
|
1856
|
+
{
|
|
1857
|
+
"lang": "typescript",
|
|
1858
|
+
"label": "createDocumentVersion",
|
|
1859
|
+
"source": "import { Factify } from \"@factify/sdk\";\nimport { openAsBlob } from \"node:fs\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.versions.create({\n documentId: \"<id>\",\n body: {\n payload: await openAsBlob(\"example.file\"),\n },\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1860
|
+
},
|
|
1861
|
+
{
|
|
1862
|
+
"lang": "java",
|
|
1863
|
+
"label": "createDocumentVersion",
|
|
1864
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport java.nio.file.Paths;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.components.CreateVersionRequest;\nimport org.openapis.openapi.models.components.CreateVersionRequestPayload;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.CreateDocumentVersionResponse;\nimport org.openapis.openapi.utils.Blob;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n CreateDocumentVersionResponse res = sdk.versions().create()\n .documentId(\"<id>\")\n .body(CreateVersionRequest.builder()\n .payload(CreateVersionRequestPayload.builder()\n .fileName(\"example.file\")\n .content(Blob.from(Paths.get(\"example.file\")))\n .build())\n .build())\n .call();\n\n }\n}"
|
|
1865
|
+
}
|
|
1866
|
+
]
|
|
1867
|
+
}
|
|
1868
|
+
},
|
|
1869
|
+
"/v1beta/documents/{document_id}/versions/{version_id}": {
|
|
1870
|
+
"get": {
|
|
1871
|
+
"description": "Retrieve a specific version by ID.",
|
|
1872
|
+
"operationId": "getDocumentVersion",
|
|
1873
|
+
"parameters": [
|
|
1874
|
+
{
|
|
1875
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1876
|
+
"in": "path",
|
|
1877
|
+
"name": "document_id",
|
|
1878
|
+
"required": true,
|
|
1879
|
+
"schema": {
|
|
1880
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1881
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1882
|
+
"title": "document_id",
|
|
1883
|
+
"type": "string"
|
|
1884
|
+
}
|
|
1885
|
+
},
|
|
1886
|
+
{
|
|
1887
|
+
"description": "Version ID.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
1888
|
+
"in": "path",
|
|
1889
|
+
"name": "version_id",
|
|
1890
|
+
"required": true,
|
|
1891
|
+
"schema": {
|
|
1892
|
+
"description": "Version ID.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
1893
|
+
"pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1894
|
+
"title": "version_id",
|
|
1895
|
+
"type": "string"
|
|
1896
|
+
}
|
|
1897
|
+
}
|
|
1898
|
+
],
|
|
1899
|
+
"responses": {
|
|
1900
|
+
"200": {
|
|
1901
|
+
"content": {
|
|
1902
|
+
"application/json": {
|
|
1903
|
+
"schema": {
|
|
1904
|
+
"$ref": "#/components/schemas/Version"
|
|
1905
|
+
}
|
|
1906
|
+
}
|
|
1907
|
+
},
|
|
1908
|
+
"description": "Success"
|
|
1909
|
+
},
|
|
1910
|
+
"400": {
|
|
1911
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1912
|
+
},
|
|
1913
|
+
"401": {
|
|
1914
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1915
|
+
},
|
|
1916
|
+
"403": {
|
|
1917
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1918
|
+
},
|
|
1919
|
+
"404": {
|
|
1920
|
+
"$ref": "#/components/responses/NotFound"
|
|
1921
|
+
},
|
|
1922
|
+
"429": {
|
|
1923
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1924
|
+
},
|
|
1925
|
+
"500": {
|
|
1926
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1927
|
+
}
|
|
1928
|
+
},
|
|
1929
|
+
"summary": "Retrieve a version",
|
|
1930
|
+
"tags": [
|
|
1931
|
+
"Versions"
|
|
1932
|
+
],
|
|
1933
|
+
"x-speakeasy-name-override": "get",
|
|
1934
|
+
"x-codeSamples": [
|
|
1935
|
+
{
|
|
1936
|
+
"lang": "typescript",
|
|
1937
|
+
"label": "getDocumentVersion",
|
|
1938
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.versions.get({\n documentId: \"<id>\",\n versionId: \"<id>\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1939
|
+
},
|
|
1940
|
+
{
|
|
1941
|
+
"lang": "java",
|
|
1942
|
+
"label": "getDocumentVersion",
|
|
1943
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.GetDocumentVersionResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n GetDocumentVersionResponse res = sdk.versions().get()\n .documentId(\"<id>\")\n .versionId(\"<id>\")\n .call();\n\n if (res.version().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1944
|
+
}
|
|
1945
|
+
]
|
|
1946
|
+
},
|
|
1947
|
+
"patch": {
|
|
1948
|
+
"description": "Update version title and description.",
|
|
1949
|
+
"operationId": "updateDocumentVersion",
|
|
1950
|
+
"parameters": [
|
|
1951
|
+
{
|
|
1952
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1953
|
+
"in": "path",
|
|
1954
|
+
"name": "document_id",
|
|
1955
|
+
"required": true,
|
|
1956
|
+
"schema": {
|
|
1957
|
+
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
1958
|
+
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1959
|
+
"title": "document_id",
|
|
1960
|
+
"type": "string"
|
|
1961
|
+
}
|
|
1962
|
+
},
|
|
1963
|
+
{
|
|
1964
|
+
"description": "Version ID to update.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
1965
|
+
"in": "path",
|
|
1966
|
+
"name": "version_id",
|
|
1967
|
+
"required": true,
|
|
1968
|
+
"schema": {
|
|
1969
|
+
"description": "Version ID to update.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
1970
|
+
"pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1971
|
+
"title": "version_id",
|
|
1972
|
+
"type": "string"
|
|
1973
|
+
}
|
|
1974
|
+
}
|
|
1975
|
+
],
|
|
1976
|
+
"requestBody": {
|
|
1977
|
+
"content": {
|
|
1978
|
+
"application/json": {
|
|
1979
|
+
"schema": {
|
|
1980
|
+
"additionalProperties": false,
|
|
1981
|
+
"description": "UpdateVersionRequest specifies fields to update on a version.",
|
|
1982
|
+
"properties": {
|
|
1983
|
+
"description": {
|
|
1984
|
+
"description": "New description.",
|
|
1985
|
+
"nullable": true,
|
|
1986
|
+
"title": "description",
|
|
1987
|
+
"type": "string"
|
|
1988
|
+
},
|
|
1989
|
+
"title": {
|
|
1990
|
+
"description": "New title (max 255 characters).",
|
|
1991
|
+
"maxLength": 255,
|
|
1992
|
+
"nullable": true,
|
|
1993
|
+
"title": "title",
|
|
1994
|
+
"type": "string"
|
|
1995
|
+
}
|
|
1996
|
+
},
|
|
1997
|
+
"title": "UpdateVersionRequest",
|
|
1998
|
+
"type": "object"
|
|
1999
|
+
}
|
|
2000
|
+
}
|
|
2001
|
+
},
|
|
2002
|
+
"required": true
|
|
2003
|
+
},
|
|
2004
|
+
"responses": {
|
|
2005
|
+
"200": {
|
|
2006
|
+
"content": {
|
|
2007
|
+
"application/json": {
|
|
2008
|
+
"schema": {
|
|
2009
|
+
"$ref": "#/components/schemas/Version"
|
|
2010
|
+
}
|
|
2011
|
+
}
|
|
2012
|
+
},
|
|
2013
|
+
"description": "Success"
|
|
2014
|
+
},
|
|
2015
|
+
"400": {
|
|
2016
|
+
"$ref": "#/components/responses/BadRequest"
|
|
2017
|
+
},
|
|
2018
|
+
"401": {
|
|
2019
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2020
|
+
},
|
|
2021
|
+
"403": {
|
|
2022
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2023
|
+
},
|
|
2024
|
+
"404": {
|
|
2025
|
+
"$ref": "#/components/responses/NotFound"
|
|
2026
|
+
},
|
|
2027
|
+
"429": {
|
|
2028
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
2029
|
+
},
|
|
2030
|
+
"500": {
|
|
2031
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2032
|
+
}
|
|
2033
|
+
},
|
|
2034
|
+
"summary": "Update a version",
|
|
2035
|
+
"tags": [
|
|
2036
|
+
"Versions"
|
|
2037
|
+
],
|
|
2038
|
+
"x-speakeasy-name-override": "update",
|
|
2039
|
+
"x-codeSamples": [
|
|
2040
|
+
{
|
|
2041
|
+
"lang": "typescript",
|
|
2042
|
+
"label": "updateDocumentVersion",
|
|
2043
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await factify.versions.update({\n documentId: \"<id>\",\n versionId: \"<id>\",\n body: {},\n });\n\n console.log(result);\n}\n\nrun();"
|
|
2044
|
+
},
|
|
2045
|
+
{
|
|
2046
|
+
"lang": "java",
|
|
2047
|
+
"label": "updateDocumentVersion",
|
|
2048
|
+
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.UpdateDocumentVersionResponse;\nimport org.openapis.openapi.models.operations.UpdateVersionRequest;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n UpdateDocumentVersionResponse res = sdk.versions().update()\n .documentId(\"<id>\")\n .versionId(\"<id>\")\n .body(UpdateVersionRequest.builder()\n .build())\n .call();\n\n if (res.version().isPresent()) {\n // handle response\n }\n }\n}"
|
|
2049
|
+
}
|
|
2050
|
+
]
|
|
2051
|
+
}
|
|
2052
|
+
}
|
|
2053
|
+
},
|
|
2054
|
+
"security": [
|
|
2055
|
+
{
|
|
2056
|
+
"bearerAuth": []
|
|
2057
|
+
}
|
|
2058
|
+
],
|
|
2059
|
+
"servers": [
|
|
2060
|
+
{
|
|
2061
|
+
"description": "Production",
|
|
2062
|
+
"url": "https://api.factify.com"
|
|
2063
|
+
},
|
|
2064
|
+
{
|
|
2065
|
+
"description": "Development (internal only)",
|
|
2066
|
+
"url": "https://api.factify-dev.com"
|
|
2067
|
+
}
|
|
2068
|
+
],
|
|
2069
|
+
"tags": [
|
|
2070
|
+
{
|
|
2071
|
+
"description": "Create, retrieve, update, and manage documents.",
|
|
2072
|
+
"name": "Documents"
|
|
2073
|
+
},
|
|
2074
|
+
{
|
|
2075
|
+
"description": "Manage document versions and version history.",
|
|
2076
|
+
"name": "Versions"
|
|
2077
|
+
},
|
|
2078
|
+
{
|
|
2079
|
+
"description": "Attach and manage access policies for documents.",
|
|
2080
|
+
"name": "Policies"
|
|
2081
|
+
},
|
|
2082
|
+
{
|
|
2083
|
+
"description": "Generate shareable entry pages for documents.",
|
|
2084
|
+
"name": "Entry Pages"
|
|
2085
|
+
}
|
|
2086
|
+
]
|
|
2087
|
+
}
|