@epilot/sdk 2.0.0-alpha.0
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/README.md +294 -0
- package/dist/access-token-MYDOBCIY.cjs +89 -0
- package/dist/access-token-Y5JR7PRG.js +89 -0
- package/dist/access-token.d-C2qnueDV.d.cts +553 -0
- package/dist/access-token.d-C2qnueDV.d.ts +553 -0
- package/dist/address-3RQRG3MK.js +84 -0
- package/dist/address-LQUTDOUA.cjs +84 -0
- package/dist/address-suggestions-PEKSA7B2.cjs +132 -0
- package/dist/address-suggestions-QNK5JWNH.js +132 -0
- package/dist/address-suggestions.d-CewXYNYH.d.cts +340 -0
- package/dist/address-suggestions.d-CewXYNYH.d.ts +340 -0
- package/dist/address.d-DP_aE2ex.d.cts +438 -0
- package/dist/address.d-DP_aE2ex.d.ts +438 -0
- package/dist/ai-agents-MO4PK2RJ.cjs +215 -0
- package/dist/ai-agents-OHP2F243.js +215 -0
- package/dist/ai-agents.d-vG-1utqk.d.cts +1340 -0
- package/dist/ai-agents.d-vG-1utqk.d.ts +1340 -0
- package/dist/apis/access-token.cjs +33 -0
- package/dist/apis/access-token.d.cts +18 -0
- package/dist/apis/access-token.d.ts +18 -0
- package/dist/apis/access-token.js +33 -0
- package/dist/apis/address-suggestions.cjs +33 -0
- package/dist/apis/address-suggestions.d.cts +18 -0
- package/dist/apis/address-suggestions.d.ts +18 -0
- package/dist/apis/address-suggestions.js +33 -0
- package/dist/apis/address.cjs +33 -0
- package/dist/apis/address.d.cts +18 -0
- package/dist/apis/address.d.ts +18 -0
- package/dist/apis/address.js +33 -0
- package/dist/apis/ai-agents.cjs +33 -0
- package/dist/apis/ai-agents.d.cts +18 -0
- package/dist/apis/ai-agents.d.ts +18 -0
- package/dist/apis/ai-agents.js +33 -0
- package/dist/apis/app.cjs +33 -0
- package/dist/apis/app.d.cts +18 -0
- package/dist/apis/app.d.ts +18 -0
- package/dist/apis/app.js +33 -0
- package/dist/apis/audit-logs.cjs +33 -0
- package/dist/apis/audit-logs.d.cts +18 -0
- package/dist/apis/audit-logs.d.ts +18 -0
- package/dist/apis/audit-logs.js +33 -0
- package/dist/apis/automation.cjs +33 -0
- package/dist/apis/automation.d.cts +18 -0
- package/dist/apis/automation.d.ts +18 -0
- package/dist/apis/automation.js +33 -0
- package/dist/apis/billing.cjs +33 -0
- package/dist/apis/billing.d.cts +18 -0
- package/dist/apis/billing.d.ts +18 -0
- package/dist/apis/billing.js +33 -0
- package/dist/apis/blueprint-manifest.cjs +33 -0
- package/dist/apis/blueprint-manifest.d.cts +18 -0
- package/dist/apis/blueprint-manifest.d.ts +18 -0
- package/dist/apis/blueprint-manifest.js +33 -0
- package/dist/apis/consent.cjs +33 -0
- package/dist/apis/consent.d.cts +18 -0
- package/dist/apis/consent.d.ts +18 -0
- package/dist/apis/consent.js +33 -0
- package/dist/apis/customer-portal.cjs +33 -0
- package/dist/apis/customer-portal.d.cts +18 -0
- package/dist/apis/customer-portal.d.ts +18 -0
- package/dist/apis/customer-portal.js +33 -0
- package/dist/apis/data-management.cjs +33 -0
- package/dist/apis/data-management.d.cts +18 -0
- package/dist/apis/data-management.d.ts +18 -0
- package/dist/apis/data-management.js +33 -0
- package/dist/apis/deduplication.cjs +33 -0
- package/dist/apis/deduplication.d.cts +18 -0
- package/dist/apis/deduplication.d.ts +18 -0
- package/dist/apis/deduplication.js +33 -0
- package/dist/apis/design.cjs +33 -0
- package/dist/apis/design.d.cts +18 -0
- package/dist/apis/design.d.ts +18 -0
- package/dist/apis/design.js +33 -0
- package/dist/apis/discussion.cjs +33 -0
- package/dist/apis/discussion.d.cts +18 -0
- package/dist/apis/discussion.d.ts +18 -0
- package/dist/apis/discussion.js +33 -0
- package/dist/apis/document.cjs +33 -0
- package/dist/apis/document.d.cts +18 -0
- package/dist/apis/document.d.ts +18 -0
- package/dist/apis/document.js +33 -0
- package/dist/apis/email-settings.cjs +33 -0
- package/dist/apis/email-settings.d.cts +18 -0
- package/dist/apis/email-settings.d.ts +18 -0
- package/dist/apis/email-settings.js +33 -0
- package/dist/apis/email-template.cjs +33 -0
- package/dist/apis/email-template.d.cts +18 -0
- package/dist/apis/email-template.d.ts +18 -0
- package/dist/apis/email-template.js +33 -0
- package/dist/apis/entity-mapping.cjs +33 -0
- package/dist/apis/entity-mapping.d.cts +18 -0
- package/dist/apis/entity-mapping.d.ts +18 -0
- package/dist/apis/entity-mapping.js +33 -0
- package/dist/apis/entity.cjs +33 -0
- package/dist/apis/entity.d.cts +18 -0
- package/dist/apis/entity.d.ts +18 -0
- package/dist/apis/entity.js +33 -0
- package/dist/apis/environments.cjs +33 -0
- package/dist/apis/environments.d.cts +18 -0
- package/dist/apis/environments.d.ts +18 -0
- package/dist/apis/environments.js +33 -0
- package/dist/apis/erp-integration.cjs +33 -0
- package/dist/apis/erp-integration.d.cts +18 -0
- package/dist/apis/erp-integration.d.ts +18 -0
- package/dist/apis/erp-integration.js +33 -0
- package/dist/apis/event-catalog.cjs +33 -0
- package/dist/apis/event-catalog.d.cts +18 -0
- package/dist/apis/event-catalog.d.ts +18 -0
- package/dist/apis/event-catalog.js +33 -0
- package/dist/apis/file.cjs +33 -0
- package/dist/apis/file.d.cts +18 -0
- package/dist/apis/file.d.ts +18 -0
- package/dist/apis/file.js +33 -0
- package/dist/apis/iban.cjs +33 -0
- package/dist/apis/iban.d.cts +18 -0
- package/dist/apis/iban.d.ts +18 -0
- package/dist/apis/iban.js +33 -0
- package/dist/apis/journey.cjs +33 -0
- package/dist/apis/journey.d.cts +18 -0
- package/dist/apis/journey.d.ts +18 -0
- package/dist/apis/journey.js +33 -0
- package/dist/apis/kanban.cjs +33 -0
- package/dist/apis/kanban.d.cts +18 -0
- package/dist/apis/kanban.d.ts +18 -0
- package/dist/apis/kanban.js +33 -0
- package/dist/apis/message.cjs +33 -0
- package/dist/apis/message.d.cts +18 -0
- package/dist/apis/message.d.ts +18 -0
- package/dist/apis/message.js +33 -0
- package/dist/apis/metering.cjs +33 -0
- package/dist/apis/metering.d.cts +18 -0
- package/dist/apis/metering.d.ts +18 -0
- package/dist/apis/metering.js +33 -0
- package/dist/apis/notes.cjs +33 -0
- package/dist/apis/notes.d.cts +18 -0
- package/dist/apis/notes.d.ts +18 -0
- package/dist/apis/notes.js +33 -0
- package/dist/apis/notification.cjs +33 -0
- package/dist/apis/notification.d.cts +18 -0
- package/dist/apis/notification.d.ts +18 -0
- package/dist/apis/notification.js +33 -0
- package/dist/apis/organization.cjs +33 -0
- package/dist/apis/organization.d.cts +18 -0
- package/dist/apis/organization.d.ts +18 -0
- package/dist/apis/organization.js +33 -0
- package/dist/apis/partner-directory.cjs +33 -0
- package/dist/apis/partner-directory.d.cts +18 -0
- package/dist/apis/partner-directory.d.ts +18 -0
- package/dist/apis/partner-directory.js +33 -0
- package/dist/apis/permissions.cjs +33 -0
- package/dist/apis/permissions.d.cts +18 -0
- package/dist/apis/permissions.d.ts +18 -0
- package/dist/apis/permissions.js +33 -0
- package/dist/apis/pricing-tier.cjs +33 -0
- package/dist/apis/pricing-tier.d.cts +18 -0
- package/dist/apis/pricing-tier.d.ts +18 -0
- package/dist/apis/pricing-tier.js +33 -0
- package/dist/apis/pricing.cjs +33 -0
- package/dist/apis/pricing.d.cts +18 -0
- package/dist/apis/pricing.d.ts +18 -0
- package/dist/apis/pricing.js +33 -0
- package/dist/apis/purpose.cjs +33 -0
- package/dist/apis/purpose.d.cts +18 -0
- package/dist/apis/purpose.d.ts +18 -0
- package/dist/apis/purpose.js +33 -0
- package/dist/apis/sandbox.cjs +33 -0
- package/dist/apis/sandbox.d.cts +18 -0
- package/dist/apis/sandbox.d.ts +18 -0
- package/dist/apis/sandbox.js +33 -0
- package/dist/apis/submission.cjs +33 -0
- package/dist/apis/submission.d.cts +18 -0
- package/dist/apis/submission.d.ts +18 -0
- package/dist/apis/submission.js +33 -0
- package/dist/apis/targeting.cjs +33 -0
- package/dist/apis/targeting.d.cts +18 -0
- package/dist/apis/targeting.d.ts +18 -0
- package/dist/apis/targeting.js +33 -0
- package/dist/apis/template-variables.cjs +33 -0
- package/dist/apis/template-variables.d.cts +18 -0
- package/dist/apis/template-variables.d.ts +18 -0
- package/dist/apis/template-variables.js +33 -0
- package/dist/apis/user.cjs +33 -0
- package/dist/apis/user.d.cts +18 -0
- package/dist/apis/user.d.ts +18 -0
- package/dist/apis/user.js +33 -0
- package/dist/apis/validation-rules.cjs +33 -0
- package/dist/apis/validation-rules.d.cts +18 -0
- package/dist/apis/validation-rules.d.ts +18 -0
- package/dist/apis/validation-rules.js +33 -0
- package/dist/apis/webhooks.cjs +33 -0
- package/dist/apis/webhooks.d.cts +18 -0
- package/dist/apis/webhooks.d.ts +18 -0
- package/dist/apis/webhooks.js +33 -0
- package/dist/apis/workflow-definition.cjs +33 -0
- package/dist/apis/workflow-definition.d.cts +18 -0
- package/dist/apis/workflow-definition.d.ts +18 -0
- package/dist/apis/workflow-definition.js +33 -0
- package/dist/apis/workflow.cjs +33 -0
- package/dist/apis/workflow.d.cts +18 -0
- package/dist/apis/workflow.d.ts +18 -0
- package/dist/apis/workflow.js +33 -0
- package/dist/app-UUTBO3WJ.js +573 -0
- package/dist/app-XJGY6SHO.cjs +573 -0
- package/dist/app.d-Uncn387s.d.cts +3370 -0
- package/dist/app.d-Uncn387s.d.ts +3370 -0
- package/dist/audit-logs-4IJYIOXF.js +55 -0
- package/dist/audit-logs-UWLCPBB4.cjs +55 -0
- package/dist/audit-logs.d-BxZqONu5.d.cts +288 -0
- package/dist/audit-logs.d-BxZqONu5.d.ts +288 -0
- package/dist/automation-4UQADTDO.cjs +282 -0
- package/dist/automation-PVXTQLZX.js +282 -0
- package/dist/automation.d-BteCzeFn.d.cts +4921 -0
- package/dist/automation.d-BteCzeFn.d.ts +4921 -0
- package/dist/billing-FI4V4UX5.cjs +175 -0
- package/dist/billing-OMWNJHGW.js +175 -0
- package/dist/billing.d-BH4__05Y.d.cts +994 -0
- package/dist/billing.d-BH4__05Y.d.ts +994 -0
- package/dist/bin/cli.js +135 -0
- package/dist/blueprint-manifest-CPQAL76N.cjs +504 -0
- package/dist/blueprint-manifest-FIMGDHSH.js +504 -0
- package/dist/blueprint-manifest.d-CU4v09fj.d.cts +3327 -0
- package/dist/blueprint-manifest.d-CU4v09fj.d.ts +3327 -0
- package/dist/chunk-3RG5ZIWI.js +10 -0
- package/dist/chunk-OBGZSXTJ.cjs +10 -0
- package/dist/chunk-UJTFRZMS.js +65 -0
- package/dist/chunk-YLLKMXS3.cjs +65 -0
- package/dist/consent-NHDCDJMK.js +84 -0
- package/dist/consent-R5GU3WCK.cjs +84 -0
- package/dist/consent.d-BETWwU_2.d.cts +266 -0
- package/dist/consent.d-BETWwU_2.d.ts +266 -0
- package/dist/customer-portal-6AV2W43T.cjs +2252 -0
- package/dist/customer-portal-EY57GJYV.js +2252 -0
- package/dist/customer-portal.d-Co_I6psR.d.cts +15255 -0
- package/dist/customer-portal.d-Co_I6psR.d.ts +15255 -0
- package/dist/data-management-ILQUYNTN.cjs +240 -0
- package/dist/data-management-QMXOLOEG.js +240 -0
- package/dist/data-management.d-CkR2E_Pm.d.cts +548 -0
- package/dist/data-management.d-CkR2E_Pm.d.ts +548 -0
- package/dist/deduplication-IVXANO7S.cjs +42 -0
- package/dist/deduplication-WN45DVK3.js +42 -0
- package/dist/deduplication.d-BlHnjhXk.d.cts +114 -0
- package/dist/deduplication.d-BlHnjhXk.d.ts +114 -0
- package/dist/design-ONRLY6XI.cjs +219 -0
- package/dist/design-UHMRO3PG.js +219 -0
- package/dist/design.d-JsNY_cGh.d.cts +834 -0
- package/dist/design.d-JsNY_cGh.d.ts +834 -0
- package/dist/discussion-4CZIG3ZM.cjs +134 -0
- package/dist/discussion-VWMWL2AF.js +134 -0
- package/dist/discussion.d-CxxaYKTf.d.cts +580 -0
- package/dist/discussion.d-CxxaYKTf.d.ts +580 -0
- package/dist/document-CN3JNXFF.js +78 -0
- package/dist/document-PCKNZA4K.cjs +78 -0
- package/dist/document.d-CZ_FGhEn.d.cts +649 -0
- package/dist/document.d-CZ_FGhEn.d.ts +649 -0
- package/dist/email-settings-ANURQMKZ.js +533 -0
- package/dist/email-settings-YE2XB2ZU.cjs +533 -0
- package/dist/email-settings.d-3eXYEyRr.d.cts +2278 -0
- package/dist/email-settings.d-3eXYEyRr.d.ts +2278 -0
- package/dist/email-template-4QI4YS4J.js +122 -0
- package/dist/email-template-BUJBC6HH.cjs +122 -0
- package/dist/email-template.d-C2L0dKqB.d.cts +1175 -0
- package/dist/email-template.d-C2L0dKqB.d.ts +1175 -0
- package/dist/entity-BCFE3UJT.cjs +1600 -0
- package/dist/entity-VEXNQC4Y.js +1600 -0
- package/dist/entity-mapping-PHRLSYP7.cjs +215 -0
- package/dist/entity-mapping-QK7MGNAW.js +215 -0
- package/dist/entity-mapping.d-B3Vyepok.d.cts +1093 -0
- package/dist/entity-mapping.d-B3Vyepok.d.ts +1093 -0
- package/dist/entity.d-DmER_7q5.d.cts +16018 -0
- package/dist/entity.d-DmER_7q5.d.ts +16018 -0
- package/dist/environments-266S44UM.cjs +71 -0
- package/dist/environments-AV7W6SLT.js +71 -0
- package/dist/environments.d-CpILpSNF.d.cts +254 -0
- package/dist/environments.d-CpILpSNF.d.ts +254 -0
- package/dist/erp-integration-5WNBCGWS.cjs +586 -0
- package/dist/erp-integration-EMI5WIWA.js +586 -0
- package/dist/erp-integration.d-DmxUZOUQ.d.cts +4120 -0
- package/dist/erp-integration.d-DmxUZOUQ.d.ts +4120 -0
- package/dist/event-catalog-DBWYKQ6J.cjs +130 -0
- package/dist/event-catalog-KKMXV5LB.js +130 -0
- package/dist/event-catalog.d-B2tq20gn.d.cts +1512 -0
- package/dist/event-catalog.d-B2tq20gn.d.ts +1512 -0
- package/dist/file-3ZLMS6TL.js +573 -0
- package/dist/file-Q66N5XMG.cjs +573 -0
- package/dist/file.d-Bi0EZkNu.d.cts +2993 -0
- package/dist/file.d-Bi0EZkNu.d.ts +2993 -0
- package/dist/iban-HSXVSIFW.cjs +43 -0
- package/dist/iban-Q27INTOC.js +43 -0
- package/dist/iban.d-DP7hl0Qt.d.cts +71 -0
- package/dist/iban.d-DP7hl0Qt.d.ts +71 -0
- package/dist/index.cjs +563 -0
- package/dist/index.d.cts +119 -0
- package/dist/index.d.ts +119 -0
- package/dist/index.js +563 -0
- package/dist/journey-DGKXVWZQ.js +270 -0
- package/dist/journey-T2Y72EBS.cjs +270 -0
- package/dist/journey.d-DxL16X6N.d.cts +1794 -0
- package/dist/journey.d-DxL16X6N.d.ts +1794 -0
- package/dist/kanban-A4B6RCJ2.cjs +164 -0
- package/dist/kanban-PP6WJVT2.js +164 -0
- package/dist/kanban.d-DDrBwr9h.d.cts +631 -0
- package/dist/kanban.d-DDrBwr9h.d.ts +631 -0
- package/dist/message-D6JY4GJH.cjs +673 -0
- package/dist/message-HFX2DDCV.js +673 -0
- package/dist/message.d-BeBH6vof.d.cts +3580 -0
- package/dist/message.d-BeBH6vof.d.ts +3580 -0
- package/dist/metering-63MJFCS2.cjs +399 -0
- package/dist/metering-F63PNFCZ.js +399 -0
- package/dist/metering.d-D5VR4tVa.d.cts +1842 -0
- package/dist/metering.d-D5VR4tVa.d.ts +1842 -0
- package/dist/notes-FTL5H4JE.cjs +219 -0
- package/dist/notes-GMWTQCMB.js +219 -0
- package/dist/notes.d-DZYeVo0I.d.cts +1047 -0
- package/dist/notes.d-DZYeVo0I.d.ts +1047 -0
- package/dist/notification-WXFSOORN.cjs +237 -0
- package/dist/notification-XHG3TIBW.js +237 -0
- package/dist/notification.d-BJwdFZnG.d.cts +1148 -0
- package/dist/notification.d-BJwdFZnG.d.ts +1148 -0
- package/dist/organization-CPXTUDJO.js +118 -0
- package/dist/organization-XIFV7MWP.cjs +118 -0
- package/dist/organization.d-DfUcuwKM.d.cts +629 -0
- package/dist/organization.d-DfUcuwKM.d.ts +629 -0
- package/dist/partner-directory-4WCHPJRO.js +282 -0
- package/dist/partner-directory-FKWPPO7F.cjs +282 -0
- package/dist/partner-directory.d-BRRDHFcz.d.cts +1511 -0
- package/dist/partner-directory.d-BRRDHFcz.d.ts +1511 -0
- package/dist/permissions-5E36GPG3.js +178 -0
- package/dist/permissions-PBTK5CCD.cjs +178 -0
- package/dist/permissions.d-CL7SwMFy.d.cts +1253 -0
- package/dist/permissions.d-CL7SwMFy.d.ts +1253 -0
- package/dist/pricing-FDWEBIQU.js +439 -0
- package/dist/pricing-FZQKL4DW.cjs +439 -0
- package/dist/pricing-tier-34O624R4.js +36 -0
- package/dist/pricing-tier-F4HE6WIM.cjs +36 -0
- package/dist/pricing-tier.d-VuH-NtlR.d.cts +82 -0
- package/dist/pricing-tier.d-VuH-NtlR.d.ts +82 -0
- package/dist/pricing.d-Dd1CaSX_.d.cts +12201 -0
- package/dist/pricing.d-Dd1CaSX_.d.ts +12201 -0
- package/dist/purpose-47HJIG2Q.cjs +180 -0
- package/dist/purpose-MX33NU5H.js +180 -0
- package/dist/purpose.d-D8YCSqt9.d.cts +373 -0
- package/dist/purpose.d-D8YCSqt9.d.ts +373 -0
- package/dist/sandbox-7QNLGFN2.cjs +100 -0
- package/dist/sandbox-TZCXHBJN.js +100 -0
- package/dist/sandbox.d-D1NgPMEc.d.cts +466 -0
- package/dist/sandbox.d-D1NgPMEc.d.ts +466 -0
- package/dist/submission-6LSPBI27.js +55 -0
- package/dist/submission-DBQNDJ4B.cjs +55 -0
- package/dist/submission.d-e9MPrbY1.d.cts +470 -0
- package/dist/submission.d-e9MPrbY1.d.ts +470 -0
- package/dist/targeting-HZRCLNIF.cjs +275 -0
- package/dist/targeting-MTQ6JBCY.js +275 -0
- package/dist/targeting.d-1GW3nh-y.d.cts +2058 -0
- package/dist/targeting.d-1GW3nh-y.d.ts +2058 -0
- package/dist/template-variables-S6IXK7SF.js +159 -0
- package/dist/template-variables-VPNIMC7L.cjs +159 -0
- package/dist/template-variables.d-CqqGe3sd.d.cts +1315 -0
- package/dist/template-variables.d-CqqGe3sd.d.ts +1315 -0
- package/dist/types-C5cGIwtq.d.cts +28 -0
- package/dist/types-C5cGIwtq.d.ts +28 -0
- package/dist/user-BHH4DAA5.cjs +488 -0
- package/dist/user-KBXFVRPI.js +488 -0
- package/dist/user.d-CWBgUia2.d.cts +2199 -0
- package/dist/user.d-CWBgUia2.d.ts +2199 -0
- package/dist/validation-rules-4V7KAWGW.cjs +120 -0
- package/dist/validation-rules-UGQY4ASY.js +120 -0
- package/dist/validation-rules.d-CMSvveua.d.cts +808 -0
- package/dist/validation-rules.d-CMSvveua.d.ts +808 -0
- package/dist/webhooks-JR475VD4.js +252 -0
- package/dist/webhooks-X64U3KCB.cjs +252 -0
- package/dist/webhooks.d-Bzl-u_Zs.d.cts +1201 -0
- package/dist/webhooks.d-Bzl-u_Zs.d.ts +1201 -0
- package/dist/workflow-7ANPQZDP.cjs +402 -0
- package/dist/workflow-DWSAHA5Q.js +402 -0
- package/dist/workflow-definition-2M3JBCUI.cjs +342 -0
- package/dist/workflow-definition-WLPGEU55.js +342 -0
- package/dist/workflow-definition.d-BKmIy2Qp.d.cts +2030 -0
- package/dist/workflow-definition.d-BKmIy2Qp.d.ts +2030 -0
- package/dist/workflow.d-DElz0XoQ.d.cts +3017 -0
- package/dist/workflow.d-DElz0XoQ.d.ts +3017 -0
- package/package.json +289 -0
|
@@ -0,0 +1,2993 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/* Auto-copied from file-client */
|
|
5
|
+
/* eslint-disable */
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
declare namespace Components {
|
|
10
|
+
namespace Parameters {
|
|
11
|
+
export type ActivityIdQueryParam = /**
|
|
12
|
+
* See https://github.com/ulid/spec
|
|
13
|
+
* example:
|
|
14
|
+
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
15
|
+
*/
|
|
16
|
+
Schemas.ActivityId /* ulid */;
|
|
17
|
+
export type AsyncOperationQueryParam = boolean;
|
|
18
|
+
export type DeleteTempFileQueryParam = boolean;
|
|
19
|
+
export type EntityIdPathParam = /**
|
|
20
|
+
* example:
|
|
21
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
22
|
+
*/
|
|
23
|
+
Schemas.EntityId;
|
|
24
|
+
export type FillActivityQueryParam = boolean;
|
|
25
|
+
export type StrictQueryParam = boolean;
|
|
26
|
+
export type VersionOnlyQueryParam = boolean;
|
|
27
|
+
}
|
|
28
|
+
export interface PathParameters {
|
|
29
|
+
EntityIdPathParam?: Parameters.EntityIdPathParam;
|
|
30
|
+
}
|
|
31
|
+
export interface QueryParameters {
|
|
32
|
+
StrictQueryParam?: Parameters.StrictQueryParam;
|
|
33
|
+
ActivityIdQueryParam?: Parameters.ActivityIdQueryParam;
|
|
34
|
+
FillActivityQueryParam?: Parameters.FillActivityQueryParam;
|
|
35
|
+
AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
|
|
36
|
+
DeleteTempFileQueryParam?: Parameters.DeleteTempFileQueryParam;
|
|
37
|
+
VersionOnlyQueryParam?: Parameters.VersionOnlyQueryParam;
|
|
38
|
+
}
|
|
39
|
+
namespace Responses {
|
|
40
|
+
/**
|
|
41
|
+
* A generic error returned by the API
|
|
42
|
+
* example:
|
|
43
|
+
* {
|
|
44
|
+
* "status": 400,
|
|
45
|
+
* "error": "Bad Request: filename is required"
|
|
46
|
+
* }
|
|
47
|
+
*/
|
|
48
|
+
export interface BadRequestError {
|
|
49
|
+
/**
|
|
50
|
+
* The HTTP status code of the error
|
|
51
|
+
* example:
|
|
52
|
+
* 400
|
|
53
|
+
*/
|
|
54
|
+
status?: number;
|
|
55
|
+
/**
|
|
56
|
+
* The error message
|
|
57
|
+
* example:
|
|
58
|
+
* Bad Request
|
|
59
|
+
*/
|
|
60
|
+
error?: string;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* A generic error returned by the API
|
|
64
|
+
* example:
|
|
65
|
+
* {
|
|
66
|
+
* "status": 403,
|
|
67
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
68
|
+
* }
|
|
69
|
+
*/
|
|
70
|
+
export interface ForbiddenError {
|
|
71
|
+
/**
|
|
72
|
+
* The HTTP status code of the error
|
|
73
|
+
* example:
|
|
74
|
+
* 400
|
|
75
|
+
*/
|
|
76
|
+
status?: number;
|
|
77
|
+
/**
|
|
78
|
+
* The error message
|
|
79
|
+
* example:
|
|
80
|
+
* Bad Request
|
|
81
|
+
*/
|
|
82
|
+
error?: string;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* A generic error returned by the API
|
|
86
|
+
* example:
|
|
87
|
+
* {
|
|
88
|
+
* "status": 500,
|
|
89
|
+
* "error": "Internal Server Error"
|
|
90
|
+
* }
|
|
91
|
+
*/
|
|
92
|
+
export interface InternalServerError {
|
|
93
|
+
/**
|
|
94
|
+
* The HTTP status code of the error
|
|
95
|
+
* example:
|
|
96
|
+
* 400
|
|
97
|
+
*/
|
|
98
|
+
status?: number;
|
|
99
|
+
/**
|
|
100
|
+
* The error message
|
|
101
|
+
* example:
|
|
102
|
+
* Bad Request
|
|
103
|
+
*/
|
|
104
|
+
error?: string;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* A generic error returned by the API
|
|
108
|
+
* example:
|
|
109
|
+
* {
|
|
110
|
+
* "status": 404,
|
|
111
|
+
* "error": "Not Found: File entity not found"
|
|
112
|
+
* }
|
|
113
|
+
*/
|
|
114
|
+
export interface NotFoundError {
|
|
115
|
+
/**
|
|
116
|
+
* The HTTP status code of the error
|
|
117
|
+
* example:
|
|
118
|
+
* 400
|
|
119
|
+
*/
|
|
120
|
+
status?: number;
|
|
121
|
+
/**
|
|
122
|
+
* The error message
|
|
123
|
+
* example:
|
|
124
|
+
* Bad Request
|
|
125
|
+
*/
|
|
126
|
+
error?: string;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* A generic error returned by the API
|
|
130
|
+
* example:
|
|
131
|
+
* {
|
|
132
|
+
* "status": 401,
|
|
133
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
134
|
+
* }
|
|
135
|
+
*/
|
|
136
|
+
export interface UnauthorizedError {
|
|
137
|
+
/**
|
|
138
|
+
* The HTTP status code of the error
|
|
139
|
+
* example:
|
|
140
|
+
* 400
|
|
141
|
+
*/
|
|
142
|
+
status?: number;
|
|
143
|
+
/**
|
|
144
|
+
* The error message
|
|
145
|
+
* example:
|
|
146
|
+
* Bad Request
|
|
147
|
+
*/
|
|
148
|
+
error?: string;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
namespace Schemas {
|
|
152
|
+
/**
|
|
153
|
+
* See https://github.com/ulid/spec
|
|
154
|
+
* example:
|
|
155
|
+
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
156
|
+
*/
|
|
157
|
+
export type ActivityId = string; // ulid
|
|
158
|
+
/**
|
|
159
|
+
* Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
|
|
160
|
+
*/
|
|
161
|
+
export interface BaseEntityAcl {
|
|
162
|
+
view?: string[];
|
|
163
|
+
edit?: string[];
|
|
164
|
+
delete?: string[];
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* The user / organization owning this entity.
|
|
168
|
+
*
|
|
169
|
+
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
170
|
+
*
|
|
171
|
+
*/
|
|
172
|
+
export interface BaseEntityOwner {
|
|
173
|
+
/**
|
|
174
|
+
* example:
|
|
175
|
+
* 123
|
|
176
|
+
*/
|
|
177
|
+
org_id: string;
|
|
178
|
+
/**
|
|
179
|
+
* example:
|
|
180
|
+
* 123
|
|
181
|
+
*/
|
|
182
|
+
user_id?: string;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* Payload for batch version save. Only s3ref payloads are supported.
|
|
186
|
+
*/
|
|
187
|
+
export interface BatchSaveFileVersionPayload {
|
|
188
|
+
/**
|
|
189
|
+
* Target file entity to add version to
|
|
190
|
+
* example:
|
|
191
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
192
|
+
*/
|
|
193
|
+
_id?: /**
|
|
194
|
+
* Target file entity to add version to
|
|
195
|
+
* example:
|
|
196
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
197
|
+
*/
|
|
198
|
+
string | string /* uuid */;
|
|
199
|
+
/**
|
|
200
|
+
* Deprecated, use _id instead
|
|
201
|
+
*/
|
|
202
|
+
file_entity_id?: string;
|
|
203
|
+
/**
|
|
204
|
+
* example:
|
|
205
|
+
* document.pdf
|
|
206
|
+
*/
|
|
207
|
+
filename?: string;
|
|
208
|
+
/**
|
|
209
|
+
* example:
|
|
210
|
+
* application/pdf
|
|
211
|
+
*/
|
|
212
|
+
mime_type?: string;
|
|
213
|
+
access_control?: "private" | "public-read";
|
|
214
|
+
s3ref: S3Ref;
|
|
215
|
+
}
|
|
216
|
+
export interface CommonSaveFilePayload {
|
|
217
|
+
[name: string]: any;
|
|
218
|
+
/**
|
|
219
|
+
* if passed, adds a new version to existing file entity
|
|
220
|
+
* example:
|
|
221
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
222
|
+
*/
|
|
223
|
+
_id?: /**
|
|
224
|
+
* if passed, adds a new version to existing file entity
|
|
225
|
+
* example:
|
|
226
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
227
|
+
*/
|
|
228
|
+
string | string /* uuid */;
|
|
229
|
+
/**
|
|
230
|
+
* Deprecated, use _id instead
|
|
231
|
+
*/
|
|
232
|
+
file_entity_id?: string;
|
|
233
|
+
/**
|
|
234
|
+
* List of entities to relate the file to
|
|
235
|
+
*/
|
|
236
|
+
relations?: FileRelationItem[];
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Custom external download url used for the file
|
|
240
|
+
* example:
|
|
241
|
+
* https://some-api-url.com/download?file_id=123
|
|
242
|
+
*/
|
|
243
|
+
export type CustomDownloadUrl = string; // uri
|
|
244
|
+
export type DownloadFilesPayload = {
|
|
245
|
+
id: /**
|
|
246
|
+
* example:
|
|
247
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
248
|
+
*/
|
|
249
|
+
FileEntityId;
|
|
250
|
+
/**
|
|
251
|
+
* File version
|
|
252
|
+
* example:
|
|
253
|
+
* 0
|
|
254
|
+
*/
|
|
255
|
+
version?: number;
|
|
256
|
+
}[];
|
|
257
|
+
/**
|
|
258
|
+
* example:
|
|
259
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
260
|
+
*/
|
|
261
|
+
export type EntityId = string;
|
|
262
|
+
/**
|
|
263
|
+
* URL-friendly identifier for the entity schema
|
|
264
|
+
* example:
|
|
265
|
+
* contact
|
|
266
|
+
*/
|
|
267
|
+
export type EntitySlug = string;
|
|
268
|
+
/**
|
|
269
|
+
* A generic error returned by the API
|
|
270
|
+
*/
|
|
271
|
+
export interface ErrorObject {
|
|
272
|
+
/**
|
|
273
|
+
* The HTTP status code of the error
|
|
274
|
+
* example:
|
|
275
|
+
* 400
|
|
276
|
+
*/
|
|
277
|
+
status?: number;
|
|
278
|
+
/**
|
|
279
|
+
* The error message
|
|
280
|
+
* example:
|
|
281
|
+
* Bad Request
|
|
282
|
+
*/
|
|
283
|
+
error?: string;
|
|
284
|
+
}
|
|
285
|
+
export interface FileAttributes {
|
|
286
|
+
/**
|
|
287
|
+
* example:
|
|
288
|
+
* [
|
|
289
|
+
* "tag1",
|
|
290
|
+
* "tag2"
|
|
291
|
+
* ]
|
|
292
|
+
*/
|
|
293
|
+
_tags?: string[];
|
|
294
|
+
/**
|
|
295
|
+
* example:
|
|
296
|
+
* [
|
|
297
|
+
* "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
|
|
298
|
+
* "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
|
|
299
|
+
* ]
|
|
300
|
+
*/
|
|
301
|
+
_purpose?: string[];
|
|
302
|
+
/**
|
|
303
|
+
* Manifest ID used to create/update the entity
|
|
304
|
+
*/
|
|
305
|
+
_manifest?: string /* uuid */[];
|
|
306
|
+
/**
|
|
307
|
+
* example:
|
|
308
|
+
* document.pdf
|
|
309
|
+
*/
|
|
310
|
+
filename?: string;
|
|
311
|
+
type?: FileType;
|
|
312
|
+
/**
|
|
313
|
+
* MIME type of the file
|
|
314
|
+
* example:
|
|
315
|
+
* application/pdf
|
|
316
|
+
*/
|
|
317
|
+
mime_type?: string;
|
|
318
|
+
/**
|
|
319
|
+
* File size in bytes
|
|
320
|
+
* example:
|
|
321
|
+
* 1234
|
|
322
|
+
*/
|
|
323
|
+
size_bytes?: number;
|
|
324
|
+
/**
|
|
325
|
+
* Human readable file size
|
|
326
|
+
* example:
|
|
327
|
+
* 1.2 MB
|
|
328
|
+
*/
|
|
329
|
+
readable_size?: string;
|
|
330
|
+
access_control?: "private" | "public-read";
|
|
331
|
+
/**
|
|
332
|
+
* Direct URL for file (public only if file access control is public-read)
|
|
333
|
+
* example:
|
|
334
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
335
|
+
*/
|
|
336
|
+
public_url?: string; // url
|
|
337
|
+
custom_download_url?: /**
|
|
338
|
+
* Custom external download url used for the file
|
|
339
|
+
* example:
|
|
340
|
+
* https://some-api-url.com/download?file_id=123
|
|
341
|
+
*/
|
|
342
|
+
CustomDownloadUrl /* uri */;
|
|
343
|
+
}
|
|
344
|
+
export interface FileCollectionAttributes {
|
|
345
|
+
/**
|
|
346
|
+
* Name of the collection
|
|
347
|
+
*/
|
|
348
|
+
name?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Array of parent collection slugs, empty array if top-level collection
|
|
351
|
+
*/
|
|
352
|
+
parents?: string[];
|
|
353
|
+
/**
|
|
354
|
+
* Whether the collection is starred / favorited
|
|
355
|
+
*/
|
|
356
|
+
starred?: boolean;
|
|
357
|
+
/**
|
|
358
|
+
* List of location slugs where the collection is enabled. If empty, enabled for all.
|
|
359
|
+
*/
|
|
360
|
+
enabled_locations?: string[];
|
|
361
|
+
/**
|
|
362
|
+
* List of purpose IDs where the collection is enabled. If empty, enabled for all.
|
|
363
|
+
*/
|
|
364
|
+
enabled_purposes?: string[];
|
|
365
|
+
}
|
|
366
|
+
/**
|
|
367
|
+
* Request body for creating a file collection
|
|
368
|
+
*/
|
|
369
|
+
export interface FileCollectionCreateRequest {
|
|
370
|
+
/**
|
|
371
|
+
* Name of the collection
|
|
372
|
+
*/
|
|
373
|
+
name: string;
|
|
374
|
+
/**
|
|
375
|
+
* Array of parent collection slugs, empty array if top-level collection
|
|
376
|
+
*/
|
|
377
|
+
parents?: string[];
|
|
378
|
+
/**
|
|
379
|
+
* Whether the collection is starred / favorited
|
|
380
|
+
*/
|
|
381
|
+
starred?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* List of location slugs where the collection is enabled. If empty, enabled for all.
|
|
384
|
+
*/
|
|
385
|
+
enabled_locations?: string[];
|
|
386
|
+
/**
|
|
387
|
+
* List of purpose IDs where the collection is enabled. If empty, enabled for all.
|
|
388
|
+
*/
|
|
389
|
+
enabled_purposes?: string[];
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* Generated uuid for a file collection
|
|
393
|
+
*/
|
|
394
|
+
export type FileCollectionId = string; // uuid
|
|
395
|
+
/**
|
|
396
|
+
* A file collection with identifiers and timestamps
|
|
397
|
+
*/
|
|
398
|
+
export interface FileCollectionItem {
|
|
399
|
+
/**
|
|
400
|
+
* Full slug for the collection. Format depends on collection type:
|
|
401
|
+
* - User collection: `_system_files_collection_{entity_uuid}_{user_id}:{collection_name}`
|
|
402
|
+
* Example: `_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents`
|
|
403
|
+
* - Global collection: `_system_files_collection_schema_{schema_slug}:{collection_name}`
|
|
404
|
+
* Example: `_system_files_collection_schema_opportunity:templates`
|
|
405
|
+
*
|
|
406
|
+
* example:
|
|
407
|
+
* _system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents
|
|
408
|
+
*/
|
|
409
|
+
slug?: string;
|
|
410
|
+
/**
|
|
411
|
+
* Display name of the collection
|
|
412
|
+
* example:
|
|
413
|
+
* Documents
|
|
414
|
+
*/
|
|
415
|
+
name: string;
|
|
416
|
+
id?: /* Generated uuid for a file collection */ FileCollectionId /* uuid */;
|
|
417
|
+
/**
|
|
418
|
+
* Array of parent collection slugs, empty array if top-level collection. Format depends on collection type:
|
|
419
|
+
* - User collection: `_system_files_collection_{entity_uuid}_{user_id}`
|
|
420
|
+
* Example: `["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"]`
|
|
421
|
+
* - Global collection: `_system_files_collection_schema_{schema_slug}`
|
|
422
|
+
* Example: `["_system_files_collection_schema_opportunity"]`
|
|
423
|
+
*
|
|
424
|
+
* example:
|
|
425
|
+
* [
|
|
426
|
+
* "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"
|
|
427
|
+
* ]
|
|
428
|
+
*/
|
|
429
|
+
parents?: string[];
|
|
430
|
+
/**
|
|
431
|
+
* Whether the collection is starred / favorited
|
|
432
|
+
* example:
|
|
433
|
+
* false
|
|
434
|
+
*/
|
|
435
|
+
starred?: boolean;
|
|
436
|
+
/**
|
|
437
|
+
* Display order for the collection
|
|
438
|
+
* example:
|
|
439
|
+
* 0
|
|
440
|
+
*/
|
|
441
|
+
order?: number;
|
|
442
|
+
/**
|
|
443
|
+
* List of location slugs where the collection is enabled. If empty, enabled for all.
|
|
444
|
+
*/
|
|
445
|
+
enabled_locations?: string[];
|
|
446
|
+
/**
|
|
447
|
+
* List of purpose slugs where the collection is enabled. If empty, enabled for all.
|
|
448
|
+
* example:
|
|
449
|
+
* [
|
|
450
|
+
* "9eefcb98-93cf-4c5b-a040-f1d26d57c177",
|
|
451
|
+
* "5c544c09-a691-43ed-a7fa-0a8b44b5b161"
|
|
452
|
+
* ]
|
|
453
|
+
*/
|
|
454
|
+
enabled_purposes?: string[];
|
|
455
|
+
/**
|
|
456
|
+
* Timestamp when the collection was created
|
|
457
|
+
* example:
|
|
458
|
+
* 2024-01-01T12:00:00Z
|
|
459
|
+
*/
|
|
460
|
+
created_at?: string; // date-time
|
|
461
|
+
/**
|
|
462
|
+
* Timestamp when the collection was last updated
|
|
463
|
+
* example:
|
|
464
|
+
* 2024-01-02T12:00:00Z
|
|
465
|
+
*/
|
|
466
|
+
updated_at?: string; // date-time
|
|
467
|
+
}
|
|
468
|
+
export interface FileEntity {
|
|
469
|
+
/**
|
|
470
|
+
* example:
|
|
471
|
+
* document.pdf
|
|
472
|
+
*/
|
|
473
|
+
_title: string;
|
|
474
|
+
_schema: "file";
|
|
475
|
+
/**
|
|
476
|
+
* example:
|
|
477
|
+
* 123
|
|
478
|
+
*/
|
|
479
|
+
_org: string;
|
|
480
|
+
_id: /**
|
|
481
|
+
* example:
|
|
482
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
483
|
+
*/
|
|
484
|
+
FileEntityId;
|
|
485
|
+
/**
|
|
486
|
+
* example:
|
|
487
|
+
* [
|
|
488
|
+
* "tag1",
|
|
489
|
+
* "tag2"
|
|
490
|
+
* ]
|
|
491
|
+
*/
|
|
492
|
+
_tags?: string[];
|
|
493
|
+
/**
|
|
494
|
+
* example:
|
|
495
|
+
* [
|
|
496
|
+
* "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
|
|
497
|
+
* "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
|
|
498
|
+
* ]
|
|
499
|
+
*/
|
|
500
|
+
_purpose?: string[];
|
|
501
|
+
/**
|
|
502
|
+
* Manifest ID used to create/update the entity
|
|
503
|
+
*/
|
|
504
|
+
_manifest?: string /* uuid */[];
|
|
505
|
+
/**
|
|
506
|
+
* example:
|
|
507
|
+
* document.pdf
|
|
508
|
+
*/
|
|
509
|
+
filename: string;
|
|
510
|
+
type: FileType;
|
|
511
|
+
/**
|
|
512
|
+
* MIME type of the file
|
|
513
|
+
* example:
|
|
514
|
+
* application/pdf
|
|
515
|
+
*/
|
|
516
|
+
mime_type?: string;
|
|
517
|
+
/**
|
|
518
|
+
* File size in bytes
|
|
519
|
+
* example:
|
|
520
|
+
* 1234
|
|
521
|
+
*/
|
|
522
|
+
size_bytes?: number;
|
|
523
|
+
/**
|
|
524
|
+
* Human readable file size
|
|
525
|
+
* example:
|
|
526
|
+
* 1.2 MB
|
|
527
|
+
*/
|
|
528
|
+
readable_size?: string;
|
|
529
|
+
access_control: "private" | "public-read";
|
|
530
|
+
/**
|
|
531
|
+
* Direct URL for file (public only if file access control is public-read)
|
|
532
|
+
* example:
|
|
533
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
534
|
+
*/
|
|
535
|
+
public_url?: string; // url
|
|
536
|
+
custom_download_url?: /**
|
|
537
|
+
* Custom external download url used for the file
|
|
538
|
+
* example:
|
|
539
|
+
* https://some-api-url.com/download?file_id=123
|
|
540
|
+
*/
|
|
541
|
+
CustomDownloadUrl /* uri */;
|
|
542
|
+
/**
|
|
543
|
+
* Source URL for the file. Included if the entity was created from source_url, or when ?source_url=true
|
|
544
|
+
* example:
|
|
545
|
+
* https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf
|
|
546
|
+
*/
|
|
547
|
+
source_url?: string;
|
|
548
|
+
s3ref?: S3Reference;
|
|
549
|
+
versions: FileItem[];
|
|
550
|
+
_updated_at?: string; // date-time
|
|
551
|
+
_created_at?: string; // date-time
|
|
552
|
+
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
|
|
553
|
+
_owners?: /**
|
|
554
|
+
* The user / organization owning this entity.
|
|
555
|
+
*
|
|
556
|
+
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
557
|
+
*
|
|
558
|
+
*/
|
|
559
|
+
BaseEntityOwner[];
|
|
560
|
+
/**
|
|
561
|
+
* Additional fields that are not part of the schema
|
|
562
|
+
*/
|
|
563
|
+
__additional?: {
|
|
564
|
+
[name: string]: any;
|
|
565
|
+
} | null;
|
|
566
|
+
}
|
|
567
|
+
/**
|
|
568
|
+
* example:
|
|
569
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
570
|
+
*/
|
|
571
|
+
export type FileEntityId = /**
|
|
572
|
+
* example:
|
|
573
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
574
|
+
*/
|
|
575
|
+
string | string /* uuid */;
|
|
576
|
+
export interface FileItem {
|
|
577
|
+
s3ref?: S3Ref;
|
|
578
|
+
/**
|
|
579
|
+
* example:
|
|
580
|
+
* document.pdf
|
|
581
|
+
*/
|
|
582
|
+
filename?: string;
|
|
583
|
+
/**
|
|
584
|
+
* example:
|
|
585
|
+
* 1234
|
|
586
|
+
*/
|
|
587
|
+
size_bytes?: number;
|
|
588
|
+
/**
|
|
589
|
+
* example:
|
|
590
|
+
* 1.2 MB
|
|
591
|
+
*/
|
|
592
|
+
readable_size?: string;
|
|
593
|
+
/**
|
|
594
|
+
* example:
|
|
595
|
+
* image/jpeg
|
|
596
|
+
*/
|
|
597
|
+
mime_type?: string;
|
|
598
|
+
}
|
|
599
|
+
export interface FileRelationItem {
|
|
600
|
+
entity_id: /**
|
|
601
|
+
* example:
|
|
602
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
603
|
+
*/
|
|
604
|
+
EntityId;
|
|
605
|
+
_schema?: /**
|
|
606
|
+
* URL-friendly identifier for the entity schema
|
|
607
|
+
* example:
|
|
608
|
+
* contact
|
|
609
|
+
*/
|
|
610
|
+
EntitySlug;
|
|
611
|
+
_tags?: string[];
|
|
612
|
+
}
|
|
613
|
+
export type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
|
|
614
|
+
export interface FileUpload {
|
|
615
|
+
s3ref?: S3Reference;
|
|
616
|
+
/**
|
|
617
|
+
* example:
|
|
618
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
619
|
+
*/
|
|
620
|
+
upload_url?: string; // url
|
|
621
|
+
/**
|
|
622
|
+
* Returned only if file is permanent i.e. file_entity_id is passed
|
|
623
|
+
* example:
|
|
624
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
625
|
+
*/
|
|
626
|
+
public_url?: string; // url
|
|
627
|
+
}
|
|
628
|
+
export interface PublicLink {
|
|
629
|
+
/**
|
|
630
|
+
* ID of the public link
|
|
631
|
+
* example:
|
|
632
|
+
* 3ef5c6d9-818d-45e6-8efb-b1de59079a1c
|
|
633
|
+
*/
|
|
634
|
+
id?: string;
|
|
635
|
+
/**
|
|
636
|
+
* Public link of the file
|
|
637
|
+
* example:
|
|
638
|
+
* https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c
|
|
639
|
+
*/
|
|
640
|
+
link?: string;
|
|
641
|
+
/**
|
|
642
|
+
* The most recent timestamp when the file was accessed
|
|
643
|
+
*/
|
|
644
|
+
last_accessed_at?: string;
|
|
645
|
+
}
|
|
646
|
+
export type S3Ref = S3Reference;
|
|
647
|
+
export interface S3Reference {
|
|
648
|
+
/**
|
|
649
|
+
* example:
|
|
650
|
+
* epilot-prod-user-content
|
|
651
|
+
*/
|
|
652
|
+
bucket: string;
|
|
653
|
+
/**
|
|
654
|
+
* example:
|
|
655
|
+
* 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
656
|
+
*/
|
|
657
|
+
key: string;
|
|
658
|
+
}
|
|
659
|
+
export interface SaveCustomFilePayload {
|
|
660
|
+
[name: string]: any;
|
|
661
|
+
/**
|
|
662
|
+
* if passed, adds a new version to existing file entity
|
|
663
|
+
* example:
|
|
664
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
665
|
+
*/
|
|
666
|
+
_id?: /**
|
|
667
|
+
* if passed, adds a new version to existing file entity
|
|
668
|
+
* example:
|
|
669
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
670
|
+
*/
|
|
671
|
+
string | string /* uuid */;
|
|
672
|
+
/**
|
|
673
|
+
* Deprecated, use _id instead
|
|
674
|
+
*/
|
|
675
|
+
file_entity_id?: string;
|
|
676
|
+
/**
|
|
677
|
+
* List of entities to relate the file to
|
|
678
|
+
*/
|
|
679
|
+
relations?: FileRelationItem[];
|
|
680
|
+
/**
|
|
681
|
+
* example:
|
|
682
|
+
* [
|
|
683
|
+
* "tag1",
|
|
684
|
+
* "tag2"
|
|
685
|
+
* ]
|
|
686
|
+
*/
|
|
687
|
+
_tags?: string[];
|
|
688
|
+
/**
|
|
689
|
+
* example:
|
|
690
|
+
* [
|
|
691
|
+
* "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
|
|
692
|
+
* "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
|
|
693
|
+
* ]
|
|
694
|
+
*/
|
|
695
|
+
_purpose?: string[];
|
|
696
|
+
/**
|
|
697
|
+
* Manifest ID used to create/update the entity
|
|
698
|
+
*/
|
|
699
|
+
_manifest?: string /* uuid */[];
|
|
700
|
+
/**
|
|
701
|
+
* example:
|
|
702
|
+
* document.pdf
|
|
703
|
+
*/
|
|
704
|
+
filename?: string;
|
|
705
|
+
type?: FileType;
|
|
706
|
+
/**
|
|
707
|
+
* MIME type of the file
|
|
708
|
+
* example:
|
|
709
|
+
* application/pdf
|
|
710
|
+
*/
|
|
711
|
+
mime_type?: string;
|
|
712
|
+
/**
|
|
713
|
+
* File size in bytes
|
|
714
|
+
* example:
|
|
715
|
+
* 1234
|
|
716
|
+
*/
|
|
717
|
+
size_bytes?: number;
|
|
718
|
+
/**
|
|
719
|
+
* Human readable file size
|
|
720
|
+
* example:
|
|
721
|
+
* 1.2 MB
|
|
722
|
+
*/
|
|
723
|
+
readable_size?: string;
|
|
724
|
+
access_control?: "private" | "public-read";
|
|
725
|
+
/**
|
|
726
|
+
* Direct URL for file (public only if file access control is public-read)
|
|
727
|
+
* example:
|
|
728
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
729
|
+
*/
|
|
730
|
+
public_url?: string; // url
|
|
731
|
+
custom_download_url?: /**
|
|
732
|
+
* Custom external download url used for the file
|
|
733
|
+
* example:
|
|
734
|
+
* https://some-api-url.com/download?file_id=123
|
|
735
|
+
*/
|
|
736
|
+
CustomDownloadUrl /* uri */;
|
|
737
|
+
}
|
|
738
|
+
export interface SaveFileFromSourceURLPayload {
|
|
739
|
+
[name: string]: any;
|
|
740
|
+
/**
|
|
741
|
+
* if passed, adds a new version to existing file entity
|
|
742
|
+
* example:
|
|
743
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
744
|
+
*/
|
|
745
|
+
_id?: /**
|
|
746
|
+
* if passed, adds a new version to existing file entity
|
|
747
|
+
* example:
|
|
748
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
749
|
+
*/
|
|
750
|
+
string | string /* uuid */;
|
|
751
|
+
/**
|
|
752
|
+
* Deprecated, use _id instead
|
|
753
|
+
*/
|
|
754
|
+
file_entity_id?: string;
|
|
755
|
+
/**
|
|
756
|
+
* List of entities to relate the file to
|
|
757
|
+
*/
|
|
758
|
+
relations?: FileRelationItem[];
|
|
759
|
+
/**
|
|
760
|
+
* example:
|
|
761
|
+
* [
|
|
762
|
+
* "tag1",
|
|
763
|
+
* "tag2"
|
|
764
|
+
* ]
|
|
765
|
+
*/
|
|
766
|
+
_tags?: string[];
|
|
767
|
+
/**
|
|
768
|
+
* example:
|
|
769
|
+
* [
|
|
770
|
+
* "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
|
|
771
|
+
* "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
|
|
772
|
+
* ]
|
|
773
|
+
*/
|
|
774
|
+
_purpose?: string[];
|
|
775
|
+
/**
|
|
776
|
+
* Manifest ID used to create/update the entity
|
|
777
|
+
*/
|
|
778
|
+
_manifest?: string /* uuid */[];
|
|
779
|
+
/**
|
|
780
|
+
* example:
|
|
781
|
+
* document.pdf
|
|
782
|
+
*/
|
|
783
|
+
filename?: string;
|
|
784
|
+
type?: FileType;
|
|
785
|
+
/**
|
|
786
|
+
* MIME type of the file
|
|
787
|
+
* example:
|
|
788
|
+
* application/pdf
|
|
789
|
+
*/
|
|
790
|
+
mime_type?: string;
|
|
791
|
+
/**
|
|
792
|
+
* File size in bytes
|
|
793
|
+
* example:
|
|
794
|
+
* 1234
|
|
795
|
+
*/
|
|
796
|
+
size_bytes?: number;
|
|
797
|
+
/**
|
|
798
|
+
* Human readable file size
|
|
799
|
+
* example:
|
|
800
|
+
* 1.2 MB
|
|
801
|
+
*/
|
|
802
|
+
readable_size?: string;
|
|
803
|
+
access_control?: "private" | "public-read";
|
|
804
|
+
/**
|
|
805
|
+
* Direct URL for file (public only if file access control is public-read)
|
|
806
|
+
* example:
|
|
807
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
808
|
+
*/
|
|
809
|
+
public_url?: string; // url
|
|
810
|
+
custom_download_url?: /**
|
|
811
|
+
* Custom external download url used for the file
|
|
812
|
+
* example:
|
|
813
|
+
* https://some-api-url.com/download?file_id=123
|
|
814
|
+
*/
|
|
815
|
+
CustomDownloadUrl /* uri */;
|
|
816
|
+
source_url?: /**
|
|
817
|
+
* Custom external download url used for the file
|
|
818
|
+
* example:
|
|
819
|
+
* https://some-api-url.com/download?file_id=123
|
|
820
|
+
*/
|
|
821
|
+
CustomDownloadUrl /* uri */;
|
|
822
|
+
}
|
|
823
|
+
export type SaveFilePayload = SaveS3FilePayload | SaveFileFromSourceURLPayload | SaveCustomFilePayload;
|
|
824
|
+
export type SaveFilePayloadV2 = SaveS3FilePayload | SaveFileFromSourceURLPayload | SaveCustomFilePayload;
|
|
825
|
+
export interface SaveS3FilePayload {
|
|
826
|
+
[name: string]: any;
|
|
827
|
+
/**
|
|
828
|
+
* if passed, adds a new version to existing file entity
|
|
829
|
+
* example:
|
|
830
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
831
|
+
*/
|
|
832
|
+
_id?: /**
|
|
833
|
+
* if passed, adds a new version to existing file entity
|
|
834
|
+
* example:
|
|
835
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
836
|
+
*/
|
|
837
|
+
string | string /* uuid */;
|
|
838
|
+
/**
|
|
839
|
+
* Deprecated, use _id instead
|
|
840
|
+
*/
|
|
841
|
+
file_entity_id?: string;
|
|
842
|
+
/**
|
|
843
|
+
* List of entities to relate the file to
|
|
844
|
+
*/
|
|
845
|
+
relations?: FileRelationItem[];
|
|
846
|
+
/**
|
|
847
|
+
* example:
|
|
848
|
+
* [
|
|
849
|
+
* "tag1",
|
|
850
|
+
* "tag2"
|
|
851
|
+
* ]
|
|
852
|
+
*/
|
|
853
|
+
_tags?: string[];
|
|
854
|
+
/**
|
|
855
|
+
* example:
|
|
856
|
+
* [
|
|
857
|
+
* "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
|
|
858
|
+
* "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
|
|
859
|
+
* ]
|
|
860
|
+
*/
|
|
861
|
+
_purpose?: string[];
|
|
862
|
+
/**
|
|
863
|
+
* Manifest ID used to create/update the entity
|
|
864
|
+
*/
|
|
865
|
+
_manifest?: string /* uuid */[];
|
|
866
|
+
/**
|
|
867
|
+
* example:
|
|
868
|
+
* document.pdf
|
|
869
|
+
*/
|
|
870
|
+
filename?: string;
|
|
871
|
+
type?: FileType;
|
|
872
|
+
/**
|
|
873
|
+
* MIME type of the file
|
|
874
|
+
* example:
|
|
875
|
+
* application/pdf
|
|
876
|
+
*/
|
|
877
|
+
mime_type?: string;
|
|
878
|
+
/**
|
|
879
|
+
* File size in bytes
|
|
880
|
+
* example:
|
|
881
|
+
* 1234
|
|
882
|
+
*/
|
|
883
|
+
size_bytes?: number;
|
|
884
|
+
/**
|
|
885
|
+
* Human readable file size
|
|
886
|
+
* example:
|
|
887
|
+
* 1.2 MB
|
|
888
|
+
*/
|
|
889
|
+
readable_size?: string;
|
|
890
|
+
access_control?: "private" | "public-read";
|
|
891
|
+
/**
|
|
892
|
+
* Direct URL for file (public only if file access control is public-read)
|
|
893
|
+
* example:
|
|
894
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
895
|
+
*/
|
|
896
|
+
public_url?: string; // url
|
|
897
|
+
custom_download_url?: /**
|
|
898
|
+
* Custom external download url used for the file
|
|
899
|
+
* example:
|
|
900
|
+
* https://some-api-url.com/download?file_id=123
|
|
901
|
+
*/
|
|
902
|
+
CustomDownloadUrl /* uri */;
|
|
903
|
+
s3ref?: S3Ref;
|
|
904
|
+
}
|
|
905
|
+
export interface UploadFilePayload {
|
|
906
|
+
/**
|
|
907
|
+
* example:
|
|
908
|
+
* document.pdf
|
|
909
|
+
*/
|
|
910
|
+
filename: string;
|
|
911
|
+
/**
|
|
912
|
+
* MIME type of file
|
|
913
|
+
* example:
|
|
914
|
+
* application/pdf
|
|
915
|
+
*/
|
|
916
|
+
mime_type?: string;
|
|
917
|
+
/**
|
|
918
|
+
* Used to index the file at the storage layer, which helps when browsing for this file
|
|
919
|
+
* example:
|
|
920
|
+
* 2f6a377c8e78
|
|
921
|
+
*/
|
|
922
|
+
index_tag?: string;
|
|
923
|
+
/**
|
|
924
|
+
* Allows passing in custom metadata for the file, expects key-value pairs of string type
|
|
925
|
+
* example:
|
|
926
|
+
* {
|
|
927
|
+
* "color": "blue"
|
|
928
|
+
* }
|
|
929
|
+
*/
|
|
930
|
+
metadata?: {
|
|
931
|
+
[name: string]: string;
|
|
932
|
+
};
|
|
933
|
+
}
|
|
934
|
+
export interface VerifyCustomDownloadUrlPayload {
|
|
935
|
+
/**
|
|
936
|
+
* Custom external download url with signature and expiration time
|
|
937
|
+
* example:
|
|
938
|
+
* https://some-api-url.com?file_id=123&expires_at=1699273500029&signature=abcdefg
|
|
939
|
+
*/
|
|
940
|
+
custom_download_url: string;
|
|
941
|
+
}
|
|
942
|
+
}
|
|
943
|
+
}
|
|
944
|
+
declare namespace Paths {
|
|
945
|
+
namespace AccessPublicLink {
|
|
946
|
+
namespace Parameters {
|
|
947
|
+
export type Filename = string;
|
|
948
|
+
export type Hash = string;
|
|
949
|
+
export type Id = string;
|
|
950
|
+
}
|
|
951
|
+
export interface PathParameters {
|
|
952
|
+
id: Parameters.Id;
|
|
953
|
+
filename: Parameters.Filename;
|
|
954
|
+
}
|
|
955
|
+
export interface QueryParameters {
|
|
956
|
+
hash?: Parameters.Hash;
|
|
957
|
+
}
|
|
958
|
+
namespace Responses {
|
|
959
|
+
export interface $302 {
|
|
960
|
+
}
|
|
961
|
+
export type $404 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
962
|
+
export type $500 = /**
|
|
963
|
+
* A generic error returned by the API
|
|
964
|
+
* example:
|
|
965
|
+
* {
|
|
966
|
+
* "status": 500,
|
|
967
|
+
* "error": "Internal Server Error"
|
|
968
|
+
* }
|
|
969
|
+
*/
|
|
970
|
+
Components.Responses.InternalServerError;
|
|
971
|
+
}
|
|
972
|
+
}
|
|
973
|
+
namespace CreateUserSchemaFileCollection {
|
|
974
|
+
namespace Parameters {
|
|
975
|
+
export type Slug = string;
|
|
976
|
+
}
|
|
977
|
+
export interface PathParameters {
|
|
978
|
+
slug: Parameters.Slug;
|
|
979
|
+
}
|
|
980
|
+
export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
|
|
981
|
+
namespace Responses {
|
|
982
|
+
export type $201 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
983
|
+
export type $400 = /**
|
|
984
|
+
* A generic error returned by the API
|
|
985
|
+
* example:
|
|
986
|
+
* {
|
|
987
|
+
* "status": 400,
|
|
988
|
+
* "error": "Bad Request: filename is required"
|
|
989
|
+
* }
|
|
990
|
+
*/
|
|
991
|
+
Components.Responses.BadRequestError;
|
|
992
|
+
export type $401 = /**
|
|
993
|
+
* A generic error returned by the API
|
|
994
|
+
* example:
|
|
995
|
+
* {
|
|
996
|
+
* "status": 401,
|
|
997
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
998
|
+
* }
|
|
999
|
+
*/
|
|
1000
|
+
Components.Responses.UnauthorizedError;
|
|
1001
|
+
export type $500 = /**
|
|
1002
|
+
* A generic error returned by the API
|
|
1003
|
+
* example:
|
|
1004
|
+
* {
|
|
1005
|
+
* "status": 500,
|
|
1006
|
+
* "error": "Internal Server Error"
|
|
1007
|
+
* }
|
|
1008
|
+
*/
|
|
1009
|
+
Components.Responses.InternalServerError;
|
|
1010
|
+
}
|
|
1011
|
+
}
|
|
1012
|
+
namespace DeleteFile {
|
|
1013
|
+
namespace Parameters {
|
|
1014
|
+
export type ActivityId = /**
|
|
1015
|
+
* See https://github.com/ulid/spec
|
|
1016
|
+
* example:
|
|
1017
|
+
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
1018
|
+
*/
|
|
1019
|
+
Components.Schemas.ActivityId /* ulid */;
|
|
1020
|
+
export type Id = /**
|
|
1021
|
+
* example:
|
|
1022
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1023
|
+
*/
|
|
1024
|
+
Components.Schemas.FileEntityId;
|
|
1025
|
+
/**
|
|
1026
|
+
* Provide `true` to permanently delete the file from storage, otherwise it will be soft-deleted
|
|
1027
|
+
*/
|
|
1028
|
+
export type Purge = boolean;
|
|
1029
|
+
export type Strict = boolean;
|
|
1030
|
+
}
|
|
1031
|
+
export interface PathParameters {
|
|
1032
|
+
id: Parameters.Id;
|
|
1033
|
+
}
|
|
1034
|
+
export interface QueryParameters {
|
|
1035
|
+
purge?: /* Provide `true` to permanently delete the file from storage, otherwise it will be soft-deleted */ Parameters.Purge;
|
|
1036
|
+
activity_id?: Parameters.ActivityId;
|
|
1037
|
+
strict?: Parameters.Strict;
|
|
1038
|
+
}
|
|
1039
|
+
namespace Responses {
|
|
1040
|
+
export type $200 = Components.Schemas.FileEntity;
|
|
1041
|
+
export type $401 = /**
|
|
1042
|
+
* A generic error returned by the API
|
|
1043
|
+
* example:
|
|
1044
|
+
* {
|
|
1045
|
+
* "status": 401,
|
|
1046
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1047
|
+
* }
|
|
1048
|
+
*/
|
|
1049
|
+
Components.Responses.UnauthorizedError;
|
|
1050
|
+
export type $403 = /**
|
|
1051
|
+
* A generic error returned by the API
|
|
1052
|
+
* example:
|
|
1053
|
+
* {
|
|
1054
|
+
* "status": 403,
|
|
1055
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
1056
|
+
* }
|
|
1057
|
+
*/
|
|
1058
|
+
Components.Responses.ForbiddenError;
|
|
1059
|
+
export type $404 = /**
|
|
1060
|
+
* A generic error returned by the API
|
|
1061
|
+
* example:
|
|
1062
|
+
* {
|
|
1063
|
+
* "status": 404,
|
|
1064
|
+
* "error": "Not Found: File entity not found"
|
|
1065
|
+
* }
|
|
1066
|
+
*/
|
|
1067
|
+
Components.Responses.NotFoundError;
|
|
1068
|
+
export type $500 = /**
|
|
1069
|
+
* A generic error returned by the API
|
|
1070
|
+
* example:
|
|
1071
|
+
* {
|
|
1072
|
+
* "status": 500,
|
|
1073
|
+
* "error": "Internal Server Error"
|
|
1074
|
+
* }
|
|
1075
|
+
*/
|
|
1076
|
+
Components.Responses.InternalServerError;
|
|
1077
|
+
}
|
|
1078
|
+
}
|
|
1079
|
+
namespace DeleteSession {
|
|
1080
|
+
namespace Responses {
|
|
1081
|
+
export interface $200 {
|
|
1082
|
+
}
|
|
1083
|
+
}
|
|
1084
|
+
}
|
|
1085
|
+
namespace DeleteUserSchemaFileCollection {
|
|
1086
|
+
namespace Parameters {
|
|
1087
|
+
export type CollectionSlug = string;
|
|
1088
|
+
export type Slug = string;
|
|
1089
|
+
}
|
|
1090
|
+
export interface PathParameters {
|
|
1091
|
+
slug: Parameters.Slug;
|
|
1092
|
+
collectionSlug: Parameters.CollectionSlug;
|
|
1093
|
+
}
|
|
1094
|
+
namespace Responses {
|
|
1095
|
+
export interface $200 {
|
|
1096
|
+
}
|
|
1097
|
+
export type $401 = /**
|
|
1098
|
+
* A generic error returned by the API
|
|
1099
|
+
* example:
|
|
1100
|
+
* {
|
|
1101
|
+
* "status": 401,
|
|
1102
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1103
|
+
* }
|
|
1104
|
+
*/
|
|
1105
|
+
Components.Responses.UnauthorizedError;
|
|
1106
|
+
export type $404 = /**
|
|
1107
|
+
* A generic error returned by the API
|
|
1108
|
+
* example:
|
|
1109
|
+
* {
|
|
1110
|
+
* "status": 404,
|
|
1111
|
+
* "error": "Not Found: File entity not found"
|
|
1112
|
+
* }
|
|
1113
|
+
*/
|
|
1114
|
+
Components.Responses.NotFoundError;
|
|
1115
|
+
export type $500 = /**
|
|
1116
|
+
* A generic error returned by the API
|
|
1117
|
+
* example:
|
|
1118
|
+
* {
|
|
1119
|
+
* "status": 500,
|
|
1120
|
+
* "error": "Internal Server Error"
|
|
1121
|
+
* }
|
|
1122
|
+
*/
|
|
1123
|
+
Components.Responses.InternalServerError;
|
|
1124
|
+
}
|
|
1125
|
+
}
|
|
1126
|
+
namespace DownloadFile {
|
|
1127
|
+
namespace Parameters {
|
|
1128
|
+
export type Attachment = boolean;
|
|
1129
|
+
export type Id = /**
|
|
1130
|
+
* example:
|
|
1131
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1132
|
+
*/
|
|
1133
|
+
Components.Schemas.FileEntityId;
|
|
1134
|
+
export type Version = number;
|
|
1135
|
+
}
|
|
1136
|
+
export interface PathParameters {
|
|
1137
|
+
id: Parameters.Id;
|
|
1138
|
+
}
|
|
1139
|
+
export interface QueryParameters {
|
|
1140
|
+
version?: Parameters.Version;
|
|
1141
|
+
attachment?: Parameters.Attachment;
|
|
1142
|
+
}
|
|
1143
|
+
namespace Responses {
|
|
1144
|
+
export interface $200 {
|
|
1145
|
+
/**
|
|
1146
|
+
* Pre-signed S3 URL valid for downloading the file
|
|
1147
|
+
* example:
|
|
1148
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
1149
|
+
*/
|
|
1150
|
+
download_url?: string; // uri
|
|
1151
|
+
}
|
|
1152
|
+
export type $401 = /**
|
|
1153
|
+
* A generic error returned by the API
|
|
1154
|
+
* example:
|
|
1155
|
+
* {
|
|
1156
|
+
* "status": 401,
|
|
1157
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1158
|
+
* }
|
|
1159
|
+
*/
|
|
1160
|
+
Components.Responses.UnauthorizedError;
|
|
1161
|
+
export type $403 = /**
|
|
1162
|
+
* A generic error returned by the API
|
|
1163
|
+
* example:
|
|
1164
|
+
* {
|
|
1165
|
+
* "status": 403,
|
|
1166
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
1167
|
+
* }
|
|
1168
|
+
*/
|
|
1169
|
+
Components.Responses.ForbiddenError;
|
|
1170
|
+
export type $404 = /**
|
|
1171
|
+
* A generic error returned by the API
|
|
1172
|
+
* example:
|
|
1173
|
+
* {
|
|
1174
|
+
* "status": 404,
|
|
1175
|
+
* "error": "Not Found: File entity not found"
|
|
1176
|
+
* }
|
|
1177
|
+
*/
|
|
1178
|
+
Components.Responses.NotFoundError;
|
|
1179
|
+
export type $500 = /**
|
|
1180
|
+
* A generic error returned by the API
|
|
1181
|
+
* example:
|
|
1182
|
+
* {
|
|
1183
|
+
* "status": 500,
|
|
1184
|
+
* "error": "Internal Server Error"
|
|
1185
|
+
* }
|
|
1186
|
+
*/
|
|
1187
|
+
Components.Responses.InternalServerError;
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
namespace DownloadFiles {
|
|
1191
|
+
export type RequestBody = Components.Schemas.DownloadFilesPayload;
|
|
1192
|
+
namespace Responses {
|
|
1193
|
+
export type $200 = {
|
|
1194
|
+
/**
|
|
1195
|
+
* Pre-signed S3 URL for downloading the file
|
|
1196
|
+
* example:
|
|
1197
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
1198
|
+
*/
|
|
1199
|
+
download_url?: string; // uri
|
|
1200
|
+
/**
|
|
1201
|
+
* The file entity ID (matches the requested ID)
|
|
1202
|
+
*/
|
|
1203
|
+
file_entity_id?: string; // uuid
|
|
1204
|
+
}[];
|
|
1205
|
+
export type $400 = /**
|
|
1206
|
+
* A generic error returned by the API
|
|
1207
|
+
* example:
|
|
1208
|
+
* {
|
|
1209
|
+
* "status": 400,
|
|
1210
|
+
* "error": "Bad Request: filename is required"
|
|
1211
|
+
* }
|
|
1212
|
+
*/
|
|
1213
|
+
Components.Responses.BadRequestError;
|
|
1214
|
+
export type $401 = /**
|
|
1215
|
+
* A generic error returned by the API
|
|
1216
|
+
* example:
|
|
1217
|
+
* {
|
|
1218
|
+
* "status": 401,
|
|
1219
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1220
|
+
* }
|
|
1221
|
+
*/
|
|
1222
|
+
Components.Responses.UnauthorizedError;
|
|
1223
|
+
export type $500 = /**
|
|
1224
|
+
* A generic error returned by the API
|
|
1225
|
+
* example:
|
|
1226
|
+
* {
|
|
1227
|
+
* "status": 500,
|
|
1228
|
+
* "error": "Internal Server Error"
|
|
1229
|
+
* }
|
|
1230
|
+
*/
|
|
1231
|
+
Components.Responses.InternalServerError;
|
|
1232
|
+
}
|
|
1233
|
+
}
|
|
1234
|
+
namespace DownloadS3File {
|
|
1235
|
+
namespace Parameters {
|
|
1236
|
+
export type Attachment = boolean;
|
|
1237
|
+
export type S3Bucket = string;
|
|
1238
|
+
export type S3Key = string;
|
|
1239
|
+
}
|
|
1240
|
+
export interface QueryParameters {
|
|
1241
|
+
s3_key: Parameters.S3Key;
|
|
1242
|
+
s3_bucket: Parameters.S3Bucket;
|
|
1243
|
+
attachment?: Parameters.Attachment;
|
|
1244
|
+
}
|
|
1245
|
+
namespace Responses {
|
|
1246
|
+
export interface $200 {
|
|
1247
|
+
/**
|
|
1248
|
+
* Pre-signed S3 URL valid for downloading the file
|
|
1249
|
+
* example:
|
|
1250
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
1251
|
+
*/
|
|
1252
|
+
download_url?: string; // uri
|
|
1253
|
+
}
|
|
1254
|
+
export type $400 = /**
|
|
1255
|
+
* A generic error returned by the API
|
|
1256
|
+
* example:
|
|
1257
|
+
* {
|
|
1258
|
+
* "status": 400,
|
|
1259
|
+
* "error": "Bad Request: filename is required"
|
|
1260
|
+
* }
|
|
1261
|
+
*/
|
|
1262
|
+
Components.Responses.BadRequestError;
|
|
1263
|
+
export type $401 = /**
|
|
1264
|
+
* A generic error returned by the API
|
|
1265
|
+
* example:
|
|
1266
|
+
* {
|
|
1267
|
+
* "status": 401,
|
|
1268
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1269
|
+
* }
|
|
1270
|
+
*/
|
|
1271
|
+
Components.Responses.UnauthorizedError;
|
|
1272
|
+
export type $404 = /**
|
|
1273
|
+
* A generic error returned by the API
|
|
1274
|
+
* example:
|
|
1275
|
+
* {
|
|
1276
|
+
* "status": 404,
|
|
1277
|
+
* "error": "Not Found: File entity not found"
|
|
1278
|
+
* }
|
|
1279
|
+
*/
|
|
1280
|
+
Components.Responses.NotFoundError;
|
|
1281
|
+
export type $500 = /**
|
|
1282
|
+
* A generic error returned by the API
|
|
1283
|
+
* example:
|
|
1284
|
+
* {
|
|
1285
|
+
* "status": 500,
|
|
1286
|
+
* "error": "Internal Server Error"
|
|
1287
|
+
* }
|
|
1288
|
+
*/
|
|
1289
|
+
Components.Responses.InternalServerError;
|
|
1290
|
+
}
|
|
1291
|
+
}
|
|
1292
|
+
namespace GeneratePublicLink {
|
|
1293
|
+
namespace Parameters {
|
|
1294
|
+
export type Id = /**
|
|
1295
|
+
* example:
|
|
1296
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1297
|
+
*/
|
|
1298
|
+
Components.Schemas.FileEntityId;
|
|
1299
|
+
}
|
|
1300
|
+
export interface PathParameters {
|
|
1301
|
+
id: Parameters.Id;
|
|
1302
|
+
}
|
|
1303
|
+
namespace Responses {
|
|
1304
|
+
/**
|
|
1305
|
+
* The public URL that can be shared externally
|
|
1306
|
+
*/
|
|
1307
|
+
export type $201 = string;
|
|
1308
|
+
export type $401 = /**
|
|
1309
|
+
* A generic error returned by the API
|
|
1310
|
+
* example:
|
|
1311
|
+
* {
|
|
1312
|
+
* "status": 401,
|
|
1313
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1314
|
+
* }
|
|
1315
|
+
*/
|
|
1316
|
+
Components.Responses.UnauthorizedError;
|
|
1317
|
+
export type $403 = /**
|
|
1318
|
+
* A generic error returned by the API
|
|
1319
|
+
* example:
|
|
1320
|
+
* {
|
|
1321
|
+
* "status": 403,
|
|
1322
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
1323
|
+
* }
|
|
1324
|
+
*/
|
|
1325
|
+
Components.Responses.ForbiddenError;
|
|
1326
|
+
export type $404 = /**
|
|
1327
|
+
* A generic error returned by the API
|
|
1328
|
+
* example:
|
|
1329
|
+
* {
|
|
1330
|
+
* "status": 404,
|
|
1331
|
+
* "error": "Not Found: File entity not found"
|
|
1332
|
+
* }
|
|
1333
|
+
*/
|
|
1334
|
+
Components.Responses.NotFoundError;
|
|
1335
|
+
export type $500 = /**
|
|
1336
|
+
* A generic error returned by the API
|
|
1337
|
+
* example:
|
|
1338
|
+
* {
|
|
1339
|
+
* "status": 500,
|
|
1340
|
+
* "error": "Internal Server Error"
|
|
1341
|
+
* }
|
|
1342
|
+
*/
|
|
1343
|
+
Components.Responses.InternalServerError;
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
namespace GetFile {
|
|
1347
|
+
namespace Parameters {
|
|
1348
|
+
export type Async = boolean;
|
|
1349
|
+
export type Id = /**
|
|
1350
|
+
* example:
|
|
1351
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1352
|
+
*/
|
|
1353
|
+
Components.Schemas.FileEntityId;
|
|
1354
|
+
/**
|
|
1355
|
+
* Generate a source_url for the file entity, if it doesn't have one
|
|
1356
|
+
*/
|
|
1357
|
+
export type SourceUrl = boolean;
|
|
1358
|
+
export type Strict = boolean;
|
|
1359
|
+
}
|
|
1360
|
+
export interface PathParameters {
|
|
1361
|
+
id: Parameters.Id;
|
|
1362
|
+
}
|
|
1363
|
+
export interface QueryParameters {
|
|
1364
|
+
source_url?: /* Generate a source_url for the file entity, if it doesn't have one */ Parameters.SourceUrl;
|
|
1365
|
+
strict?: Parameters.Strict;
|
|
1366
|
+
async?: Parameters.Async;
|
|
1367
|
+
}
|
|
1368
|
+
namespace Responses {
|
|
1369
|
+
export type $200 = Components.Schemas.FileEntity;
|
|
1370
|
+
export type $401 = /**
|
|
1371
|
+
* A generic error returned by the API
|
|
1372
|
+
* example:
|
|
1373
|
+
* {
|
|
1374
|
+
* "status": 401,
|
|
1375
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1376
|
+
* }
|
|
1377
|
+
*/
|
|
1378
|
+
Components.Responses.UnauthorizedError;
|
|
1379
|
+
export type $403 = /**
|
|
1380
|
+
* A generic error returned by the API
|
|
1381
|
+
* example:
|
|
1382
|
+
* {
|
|
1383
|
+
* "status": 403,
|
|
1384
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
1385
|
+
* }
|
|
1386
|
+
*/
|
|
1387
|
+
Components.Responses.ForbiddenError;
|
|
1388
|
+
export type $404 = /**
|
|
1389
|
+
* A generic error returned by the API
|
|
1390
|
+
* example:
|
|
1391
|
+
* {
|
|
1392
|
+
* "status": 404,
|
|
1393
|
+
* "error": "Not Found: File entity not found"
|
|
1394
|
+
* }
|
|
1395
|
+
*/
|
|
1396
|
+
Components.Responses.NotFoundError;
|
|
1397
|
+
export type $500 = /**
|
|
1398
|
+
* A generic error returned by the API
|
|
1399
|
+
* example:
|
|
1400
|
+
* {
|
|
1401
|
+
* "status": 500,
|
|
1402
|
+
* "error": "Internal Server Error"
|
|
1403
|
+
* }
|
|
1404
|
+
*/
|
|
1405
|
+
Components.Responses.InternalServerError;
|
|
1406
|
+
}
|
|
1407
|
+
}
|
|
1408
|
+
namespace GetFilesInCollection {
|
|
1409
|
+
namespace Parameters {
|
|
1410
|
+
export type CollectionSlug = string;
|
|
1411
|
+
export type Id = /**
|
|
1412
|
+
* example:
|
|
1413
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1414
|
+
*/
|
|
1415
|
+
Components.Schemas.EntityId;
|
|
1416
|
+
}
|
|
1417
|
+
export interface PathParameters {
|
|
1418
|
+
id: Parameters.Id;
|
|
1419
|
+
collectionSlug: Parameters.CollectionSlug;
|
|
1420
|
+
}
|
|
1421
|
+
namespace Responses {
|
|
1422
|
+
export type $200 = Components.Schemas.FileEntity[];
|
|
1423
|
+
export type $401 = /**
|
|
1424
|
+
* A generic error returned by the API
|
|
1425
|
+
* example:
|
|
1426
|
+
* {
|
|
1427
|
+
* "status": 401,
|
|
1428
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1429
|
+
* }
|
|
1430
|
+
*/
|
|
1431
|
+
Components.Responses.UnauthorizedError;
|
|
1432
|
+
export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1433
|
+
export type $404 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1434
|
+
export type $500 = /**
|
|
1435
|
+
* A generic error returned by the API
|
|
1436
|
+
* example:
|
|
1437
|
+
* {
|
|
1438
|
+
* "status": 500,
|
|
1439
|
+
* "error": "Internal Server Error"
|
|
1440
|
+
* }
|
|
1441
|
+
*/
|
|
1442
|
+
Components.Responses.InternalServerError;
|
|
1443
|
+
}
|
|
1444
|
+
}
|
|
1445
|
+
namespace GetGlobalFileCollections {
|
|
1446
|
+
namespace Parameters {
|
|
1447
|
+
export type SchemaSlug = string;
|
|
1448
|
+
}
|
|
1449
|
+
export interface PathParameters {
|
|
1450
|
+
schemaSlug: Parameters.SchemaSlug;
|
|
1451
|
+
}
|
|
1452
|
+
namespace Responses {
|
|
1453
|
+
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
|
|
1454
|
+
export type $401 = /**
|
|
1455
|
+
* A generic error returned by the API
|
|
1456
|
+
* example:
|
|
1457
|
+
* {
|
|
1458
|
+
* "status": 401,
|
|
1459
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1460
|
+
* }
|
|
1461
|
+
*/
|
|
1462
|
+
Components.Responses.UnauthorizedError;
|
|
1463
|
+
export type $500 = /**
|
|
1464
|
+
* A generic error returned by the API
|
|
1465
|
+
* example:
|
|
1466
|
+
* {
|
|
1467
|
+
* "status": 500,
|
|
1468
|
+
* "error": "Internal Server Error"
|
|
1469
|
+
* }
|
|
1470
|
+
*/
|
|
1471
|
+
Components.Responses.InternalServerError;
|
|
1472
|
+
}
|
|
1473
|
+
}
|
|
1474
|
+
namespace GetSession {
|
|
1475
|
+
namespace Responses {
|
|
1476
|
+
export interface $200 {
|
|
1477
|
+
}
|
|
1478
|
+
export type $401 = /**
|
|
1479
|
+
* A generic error returned by the API
|
|
1480
|
+
* example:
|
|
1481
|
+
* {
|
|
1482
|
+
* "status": 401,
|
|
1483
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1484
|
+
* }
|
|
1485
|
+
*/
|
|
1486
|
+
Components.Responses.UnauthorizedError;
|
|
1487
|
+
}
|
|
1488
|
+
}
|
|
1489
|
+
namespace GetUserSchemaFileCollections {
|
|
1490
|
+
namespace Parameters {
|
|
1491
|
+
export type Slug = string;
|
|
1492
|
+
}
|
|
1493
|
+
export interface PathParameters {
|
|
1494
|
+
slug: Parameters.Slug;
|
|
1495
|
+
}
|
|
1496
|
+
namespace Responses {
|
|
1497
|
+
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
|
|
1498
|
+
export type $401 = /**
|
|
1499
|
+
* A generic error returned by the API
|
|
1500
|
+
* example:
|
|
1501
|
+
* {
|
|
1502
|
+
* "status": 401,
|
|
1503
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1504
|
+
* }
|
|
1505
|
+
*/
|
|
1506
|
+
Components.Responses.UnauthorizedError;
|
|
1507
|
+
export type $500 = /**
|
|
1508
|
+
* A generic error returned by the API
|
|
1509
|
+
* example:
|
|
1510
|
+
* {
|
|
1511
|
+
* "status": 500,
|
|
1512
|
+
* "error": "Internal Server Error"
|
|
1513
|
+
* }
|
|
1514
|
+
*/
|
|
1515
|
+
Components.Responses.InternalServerError;
|
|
1516
|
+
}
|
|
1517
|
+
}
|
|
1518
|
+
namespace ListPublicLinksForFile {
|
|
1519
|
+
namespace Parameters {
|
|
1520
|
+
export type Id = string;
|
|
1521
|
+
}
|
|
1522
|
+
export interface PathParameters {
|
|
1523
|
+
id: Parameters.Id;
|
|
1524
|
+
}
|
|
1525
|
+
namespace Responses {
|
|
1526
|
+
export interface $200 {
|
|
1527
|
+
results?: Components.Schemas.PublicLink[];
|
|
1528
|
+
}
|
|
1529
|
+
export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1530
|
+
}
|
|
1531
|
+
}
|
|
1532
|
+
namespace PreviewFile {
|
|
1533
|
+
namespace Parameters {
|
|
1534
|
+
export type H = number;
|
|
1535
|
+
export type Id = /**
|
|
1536
|
+
* example:
|
|
1537
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1538
|
+
*/
|
|
1539
|
+
Components.Schemas.FileEntityId;
|
|
1540
|
+
export type Version = number;
|
|
1541
|
+
export type W = number;
|
|
1542
|
+
}
|
|
1543
|
+
export interface PathParameters {
|
|
1544
|
+
id: Parameters.Id;
|
|
1545
|
+
}
|
|
1546
|
+
export interface QueryParameters {
|
|
1547
|
+
version?: Parameters.Version;
|
|
1548
|
+
w?: Parameters.W;
|
|
1549
|
+
h?: Parameters.H;
|
|
1550
|
+
}
|
|
1551
|
+
namespace Responses {
|
|
1552
|
+
export type $200 = string; // binary
|
|
1553
|
+
export type $401 = /**
|
|
1554
|
+
* A generic error returned by the API
|
|
1555
|
+
* example:
|
|
1556
|
+
* {
|
|
1557
|
+
* "status": 401,
|
|
1558
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1559
|
+
* }
|
|
1560
|
+
*/
|
|
1561
|
+
Components.Responses.UnauthorizedError;
|
|
1562
|
+
export type $404 = /**
|
|
1563
|
+
* A generic error returned by the API
|
|
1564
|
+
* example:
|
|
1565
|
+
* {
|
|
1566
|
+
* "status": 404,
|
|
1567
|
+
* "error": "Not Found: File entity not found"
|
|
1568
|
+
* }
|
|
1569
|
+
*/
|
|
1570
|
+
Components.Responses.NotFoundError;
|
|
1571
|
+
export type $500 = /**
|
|
1572
|
+
* A generic error returned by the API
|
|
1573
|
+
* example:
|
|
1574
|
+
* {
|
|
1575
|
+
* "status": 500,
|
|
1576
|
+
* "error": "Internal Server Error"
|
|
1577
|
+
* }
|
|
1578
|
+
*/
|
|
1579
|
+
Components.Responses.InternalServerError;
|
|
1580
|
+
}
|
|
1581
|
+
}
|
|
1582
|
+
namespace PreviewPublicFile {
|
|
1583
|
+
namespace Parameters {
|
|
1584
|
+
export type H = number;
|
|
1585
|
+
export type Id = /**
|
|
1586
|
+
* example:
|
|
1587
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1588
|
+
*/
|
|
1589
|
+
Components.Schemas.FileEntityId;
|
|
1590
|
+
export type OrgId = string;
|
|
1591
|
+
export type Version = number;
|
|
1592
|
+
export type W = number;
|
|
1593
|
+
}
|
|
1594
|
+
export interface PathParameters {
|
|
1595
|
+
id: Parameters.Id;
|
|
1596
|
+
}
|
|
1597
|
+
export interface QueryParameters {
|
|
1598
|
+
version?: Parameters.Version;
|
|
1599
|
+
w?: Parameters.W;
|
|
1600
|
+
h?: Parameters.H;
|
|
1601
|
+
org_id?: Parameters.OrgId;
|
|
1602
|
+
}
|
|
1603
|
+
namespace Responses {
|
|
1604
|
+
export type $200 = string; // binary
|
|
1605
|
+
export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1606
|
+
export type $404 = /**
|
|
1607
|
+
* A generic error returned by the API
|
|
1608
|
+
* example:
|
|
1609
|
+
* {
|
|
1610
|
+
* "status": 404,
|
|
1611
|
+
* "error": "Not Found: File entity not found"
|
|
1612
|
+
* }
|
|
1613
|
+
*/
|
|
1614
|
+
Components.Responses.NotFoundError;
|
|
1615
|
+
export type $500 = /**
|
|
1616
|
+
* A generic error returned by the API
|
|
1617
|
+
* example:
|
|
1618
|
+
* {
|
|
1619
|
+
* "status": 500,
|
|
1620
|
+
* "error": "Internal Server Error"
|
|
1621
|
+
* }
|
|
1622
|
+
*/
|
|
1623
|
+
Components.Responses.InternalServerError;
|
|
1624
|
+
}
|
|
1625
|
+
}
|
|
1626
|
+
namespace PreviewS3File {
|
|
1627
|
+
namespace Parameters {
|
|
1628
|
+
export type H = number;
|
|
1629
|
+
export type W = number;
|
|
1630
|
+
}
|
|
1631
|
+
export interface QueryParameters {
|
|
1632
|
+
w?: Parameters.W;
|
|
1633
|
+
h?: Parameters.H;
|
|
1634
|
+
}
|
|
1635
|
+
export type RequestBody = Components.Schemas.S3Ref;
|
|
1636
|
+
namespace Responses {
|
|
1637
|
+
export type $200 = string; // binary
|
|
1638
|
+
export type $400 = /**
|
|
1639
|
+
* A generic error returned by the API
|
|
1640
|
+
* example:
|
|
1641
|
+
* {
|
|
1642
|
+
* "status": 400,
|
|
1643
|
+
* "error": "Bad Request: filename is required"
|
|
1644
|
+
* }
|
|
1645
|
+
*/
|
|
1646
|
+
Components.Responses.BadRequestError;
|
|
1647
|
+
export type $401 = /**
|
|
1648
|
+
* A generic error returned by the API
|
|
1649
|
+
* example:
|
|
1650
|
+
* {
|
|
1651
|
+
* "status": 401,
|
|
1652
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1653
|
+
* }
|
|
1654
|
+
*/
|
|
1655
|
+
Components.Responses.UnauthorizedError;
|
|
1656
|
+
export type $404 = /**
|
|
1657
|
+
* A generic error returned by the API
|
|
1658
|
+
* example:
|
|
1659
|
+
* {
|
|
1660
|
+
* "status": 404,
|
|
1661
|
+
* "error": "Not Found: File entity not found"
|
|
1662
|
+
* }
|
|
1663
|
+
*/
|
|
1664
|
+
Components.Responses.NotFoundError;
|
|
1665
|
+
export type $500 = /**
|
|
1666
|
+
* A generic error returned by the API
|
|
1667
|
+
* example:
|
|
1668
|
+
* {
|
|
1669
|
+
* "status": 500,
|
|
1670
|
+
* "error": "Internal Server Error"
|
|
1671
|
+
* }
|
|
1672
|
+
*/
|
|
1673
|
+
Components.Responses.InternalServerError;
|
|
1674
|
+
}
|
|
1675
|
+
}
|
|
1676
|
+
namespace PreviewS3FileGet {
|
|
1677
|
+
namespace Parameters {
|
|
1678
|
+
export type Bucket = string;
|
|
1679
|
+
export type H = number;
|
|
1680
|
+
export type Key = string;
|
|
1681
|
+
export type W = number;
|
|
1682
|
+
}
|
|
1683
|
+
export interface QueryParameters {
|
|
1684
|
+
key: Parameters.Key;
|
|
1685
|
+
bucket: Parameters.Bucket;
|
|
1686
|
+
w?: Parameters.W;
|
|
1687
|
+
h?: Parameters.H;
|
|
1688
|
+
}
|
|
1689
|
+
namespace Responses {
|
|
1690
|
+
export type $200 = string; // binary
|
|
1691
|
+
export type $400 = /**
|
|
1692
|
+
* A generic error returned by the API
|
|
1693
|
+
* example:
|
|
1694
|
+
* {
|
|
1695
|
+
* "status": 400,
|
|
1696
|
+
* "error": "Bad Request: filename is required"
|
|
1697
|
+
* }
|
|
1698
|
+
*/
|
|
1699
|
+
Components.Responses.BadRequestError;
|
|
1700
|
+
export type $401 = /**
|
|
1701
|
+
* A generic error returned by the API
|
|
1702
|
+
* example:
|
|
1703
|
+
* {
|
|
1704
|
+
* "status": 401,
|
|
1705
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1706
|
+
* }
|
|
1707
|
+
*/
|
|
1708
|
+
Components.Responses.UnauthorizedError;
|
|
1709
|
+
export type $404 = /**
|
|
1710
|
+
* A generic error returned by the API
|
|
1711
|
+
* example:
|
|
1712
|
+
* {
|
|
1713
|
+
* "status": 404,
|
|
1714
|
+
* "error": "Not Found: File entity not found"
|
|
1715
|
+
* }
|
|
1716
|
+
*/
|
|
1717
|
+
Components.Responses.NotFoundError;
|
|
1718
|
+
export type $500 = /**
|
|
1719
|
+
* A generic error returned by the API
|
|
1720
|
+
* example:
|
|
1721
|
+
* {
|
|
1722
|
+
* "status": 500,
|
|
1723
|
+
* "error": "Internal Server Error"
|
|
1724
|
+
* }
|
|
1725
|
+
*/
|
|
1726
|
+
Components.Responses.InternalServerError;
|
|
1727
|
+
}
|
|
1728
|
+
}
|
|
1729
|
+
namespace RevokePublicLink {
|
|
1730
|
+
namespace Parameters {
|
|
1731
|
+
export type Id = string;
|
|
1732
|
+
}
|
|
1733
|
+
export interface PathParameters {
|
|
1734
|
+
id: Parameters.Id;
|
|
1735
|
+
}
|
|
1736
|
+
namespace Responses {
|
|
1737
|
+
export interface $204 {
|
|
1738
|
+
}
|
|
1739
|
+
export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1740
|
+
}
|
|
1741
|
+
}
|
|
1742
|
+
namespace SaveFile {
|
|
1743
|
+
namespace Parameters {
|
|
1744
|
+
export type ActivityId = /**
|
|
1745
|
+
* See https://github.com/ulid/spec
|
|
1746
|
+
* example:
|
|
1747
|
+
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
1748
|
+
*/
|
|
1749
|
+
Components.Schemas.ActivityId /* ulid */;
|
|
1750
|
+
export type Async = boolean;
|
|
1751
|
+
export type VersionOnly = boolean;
|
|
1752
|
+
}
|
|
1753
|
+
export interface QueryParameters {
|
|
1754
|
+
activity_id?: Parameters.ActivityId;
|
|
1755
|
+
async?: Parameters.Async;
|
|
1756
|
+
version_only?: Parameters.VersionOnly;
|
|
1757
|
+
}
|
|
1758
|
+
export type RequestBody = Components.Schemas.SaveFilePayload;
|
|
1759
|
+
namespace Responses {
|
|
1760
|
+
export type $201 = Components.Schemas.FileEntity;
|
|
1761
|
+
export type $400 = /**
|
|
1762
|
+
* A generic error returned by the API
|
|
1763
|
+
* example:
|
|
1764
|
+
* {
|
|
1765
|
+
* "status": 400,
|
|
1766
|
+
* "error": "Bad Request: filename is required"
|
|
1767
|
+
* }
|
|
1768
|
+
*/
|
|
1769
|
+
Components.Responses.BadRequestError;
|
|
1770
|
+
export type $401 = /**
|
|
1771
|
+
* A generic error returned by the API
|
|
1772
|
+
* example:
|
|
1773
|
+
* {
|
|
1774
|
+
* "status": 401,
|
|
1775
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1776
|
+
* }
|
|
1777
|
+
*/
|
|
1778
|
+
Components.Responses.UnauthorizedError;
|
|
1779
|
+
export type $500 = /**
|
|
1780
|
+
* A generic error returned by the API
|
|
1781
|
+
* example:
|
|
1782
|
+
* {
|
|
1783
|
+
* "status": 500,
|
|
1784
|
+
* "error": "Internal Server Error"
|
|
1785
|
+
* }
|
|
1786
|
+
*/
|
|
1787
|
+
Components.Responses.InternalServerError;
|
|
1788
|
+
}
|
|
1789
|
+
}
|
|
1790
|
+
namespace SaveFileV2 {
|
|
1791
|
+
namespace Parameters {
|
|
1792
|
+
export type ActivityId = /**
|
|
1793
|
+
* See https://github.com/ulid/spec
|
|
1794
|
+
* example:
|
|
1795
|
+
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
1796
|
+
*/
|
|
1797
|
+
Components.Schemas.ActivityId /* ulid */;
|
|
1798
|
+
export type Async = boolean;
|
|
1799
|
+
export type DeleteTempFile = boolean;
|
|
1800
|
+
export type FillActivity = boolean;
|
|
1801
|
+
export type Strict = boolean;
|
|
1802
|
+
export type VersionOnly = boolean;
|
|
1803
|
+
}
|
|
1804
|
+
export interface QueryParameters {
|
|
1805
|
+
activity_id?: Parameters.ActivityId;
|
|
1806
|
+
fill_activity?: Parameters.FillActivity;
|
|
1807
|
+
strict?: Parameters.Strict;
|
|
1808
|
+
async?: Parameters.Async;
|
|
1809
|
+
delete_temp_file?: Parameters.DeleteTempFile;
|
|
1810
|
+
version_only?: Parameters.VersionOnly;
|
|
1811
|
+
}
|
|
1812
|
+
export type RequestBody = Components.Schemas.SaveFilePayloadV2 | [
|
|
1813
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload,
|
|
1814
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1815
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1816
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1817
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1818
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1819
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1820
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1821
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1822
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1823
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1824
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1825
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1826
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1827
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1828
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1829
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1830
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1831
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1832
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?
|
|
1833
|
+
];
|
|
1834
|
+
namespace Responses {
|
|
1835
|
+
export type $200 = Components.Schemas.FileEntity;
|
|
1836
|
+
export type $400 = /**
|
|
1837
|
+
* A generic error returned by the API
|
|
1838
|
+
* example:
|
|
1839
|
+
* {
|
|
1840
|
+
* "status": 400,
|
|
1841
|
+
* "error": "Bad Request: filename is required"
|
|
1842
|
+
* }
|
|
1843
|
+
*/
|
|
1844
|
+
Components.Responses.BadRequestError;
|
|
1845
|
+
export type $401 = /**
|
|
1846
|
+
* A generic error returned by the API
|
|
1847
|
+
* example:
|
|
1848
|
+
* {
|
|
1849
|
+
* "status": 401,
|
|
1850
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1851
|
+
* }
|
|
1852
|
+
*/
|
|
1853
|
+
Components.Responses.UnauthorizedError;
|
|
1854
|
+
export type $404 = /**
|
|
1855
|
+
* A generic error returned by the API
|
|
1856
|
+
* example:
|
|
1857
|
+
* {
|
|
1858
|
+
* "status": 404,
|
|
1859
|
+
* "error": "Not Found: File entity not found"
|
|
1860
|
+
* }
|
|
1861
|
+
*/
|
|
1862
|
+
Components.Responses.NotFoundError;
|
|
1863
|
+
export type $500 = /**
|
|
1864
|
+
* A generic error returned by the API
|
|
1865
|
+
* example:
|
|
1866
|
+
* {
|
|
1867
|
+
* "status": 500,
|
|
1868
|
+
* "error": "Internal Server Error"
|
|
1869
|
+
* }
|
|
1870
|
+
*/
|
|
1871
|
+
Components.Responses.InternalServerError;
|
|
1872
|
+
}
|
|
1873
|
+
}
|
|
1874
|
+
namespace UpdateUserSchemaFileCollection {
|
|
1875
|
+
namespace Parameters {
|
|
1876
|
+
export type CollectionSlug = string;
|
|
1877
|
+
export type Slug = string;
|
|
1878
|
+
}
|
|
1879
|
+
export interface PathParameters {
|
|
1880
|
+
slug: Parameters.Slug;
|
|
1881
|
+
collectionSlug: Parameters.CollectionSlug;
|
|
1882
|
+
}
|
|
1883
|
+
export type RequestBody = Components.Schemas.FileCollectionAttributes;
|
|
1884
|
+
namespace Responses {
|
|
1885
|
+
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
1886
|
+
export type $400 = /**
|
|
1887
|
+
* A generic error returned by the API
|
|
1888
|
+
* example:
|
|
1889
|
+
* {
|
|
1890
|
+
* "status": 400,
|
|
1891
|
+
* "error": "Bad Request: filename is required"
|
|
1892
|
+
* }
|
|
1893
|
+
*/
|
|
1894
|
+
Components.Responses.BadRequestError;
|
|
1895
|
+
export type $401 = /**
|
|
1896
|
+
* A generic error returned by the API
|
|
1897
|
+
* example:
|
|
1898
|
+
* {
|
|
1899
|
+
* "status": 401,
|
|
1900
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1901
|
+
* }
|
|
1902
|
+
*/
|
|
1903
|
+
Components.Responses.UnauthorizedError;
|
|
1904
|
+
export type $404 = /**
|
|
1905
|
+
* A generic error returned by the API
|
|
1906
|
+
* example:
|
|
1907
|
+
* {
|
|
1908
|
+
* "status": 404,
|
|
1909
|
+
* "error": "Not Found: File entity not found"
|
|
1910
|
+
* }
|
|
1911
|
+
*/
|
|
1912
|
+
Components.Responses.NotFoundError;
|
|
1913
|
+
export type $500 = /**
|
|
1914
|
+
* A generic error returned by the API
|
|
1915
|
+
* example:
|
|
1916
|
+
* {
|
|
1917
|
+
* "status": 500,
|
|
1918
|
+
* "error": "Internal Server Error"
|
|
1919
|
+
* }
|
|
1920
|
+
*/
|
|
1921
|
+
Components.Responses.InternalServerError;
|
|
1922
|
+
}
|
|
1923
|
+
}
|
|
1924
|
+
namespace UploadFile {
|
|
1925
|
+
namespace Parameters {
|
|
1926
|
+
export type FileEntityId = /**
|
|
1927
|
+
* example:
|
|
1928
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1929
|
+
*/
|
|
1930
|
+
Components.Schemas.FileEntityId;
|
|
1931
|
+
}
|
|
1932
|
+
export interface QueryParameters {
|
|
1933
|
+
file_entity_id?: Parameters.FileEntityId;
|
|
1934
|
+
}
|
|
1935
|
+
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
1936
|
+
namespace Responses {
|
|
1937
|
+
export interface $201 {
|
|
1938
|
+
s3ref?: Components.Schemas.S3Reference;
|
|
1939
|
+
/**
|
|
1940
|
+
* example:
|
|
1941
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
1942
|
+
*/
|
|
1943
|
+
upload_url?: string; // url
|
|
1944
|
+
/**
|
|
1945
|
+
* Returned only if file is permanent i.e. file_entity_id is passed
|
|
1946
|
+
* example:
|
|
1947
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
1948
|
+
*/
|
|
1949
|
+
public_url?: string; // url
|
|
1950
|
+
}
|
|
1951
|
+
export type $400 = /**
|
|
1952
|
+
* A generic error returned by the API
|
|
1953
|
+
* example:
|
|
1954
|
+
* {
|
|
1955
|
+
* "status": 400,
|
|
1956
|
+
* "error": "Bad Request: filename is required"
|
|
1957
|
+
* }
|
|
1958
|
+
*/
|
|
1959
|
+
Components.Responses.BadRequestError;
|
|
1960
|
+
export type $401 = /**
|
|
1961
|
+
* A generic error returned by the API
|
|
1962
|
+
* example:
|
|
1963
|
+
* {
|
|
1964
|
+
* "status": 401,
|
|
1965
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1966
|
+
* }
|
|
1967
|
+
*/
|
|
1968
|
+
Components.Responses.UnauthorizedError;
|
|
1969
|
+
export type $500 = /**
|
|
1970
|
+
* A generic error returned by the API
|
|
1971
|
+
* example:
|
|
1972
|
+
* {
|
|
1973
|
+
* "status": 500,
|
|
1974
|
+
* "error": "Internal Server Error"
|
|
1975
|
+
* }
|
|
1976
|
+
*/
|
|
1977
|
+
Components.Responses.InternalServerError;
|
|
1978
|
+
}
|
|
1979
|
+
}
|
|
1980
|
+
namespace UploadFilePublic {
|
|
1981
|
+
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
1982
|
+
namespace Responses {
|
|
1983
|
+
export interface $201 {
|
|
1984
|
+
s3ref?: Components.Schemas.S3Reference;
|
|
1985
|
+
/**
|
|
1986
|
+
* Pre-signed URL for uploading the file via PUT request
|
|
1987
|
+
* example:
|
|
1988
|
+
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
1989
|
+
*/
|
|
1990
|
+
upload_url?: string; // url
|
|
1991
|
+
/**
|
|
1992
|
+
* Error message if the upload preparation failed
|
|
1993
|
+
* example:
|
|
1994
|
+
* File entity not found
|
|
1995
|
+
*/
|
|
1996
|
+
error?: string;
|
|
1997
|
+
}
|
|
1998
|
+
export type $400 = /**
|
|
1999
|
+
* A generic error returned by the API
|
|
2000
|
+
* example:
|
|
2001
|
+
* {
|
|
2002
|
+
* "status": 400,
|
|
2003
|
+
* "error": "Bad Request: filename is required"
|
|
2004
|
+
* }
|
|
2005
|
+
*/
|
|
2006
|
+
Components.Responses.BadRequestError;
|
|
2007
|
+
export type $500 = /**
|
|
2008
|
+
* A generic error returned by the API
|
|
2009
|
+
* example:
|
|
2010
|
+
* {
|
|
2011
|
+
* "status": 500,
|
|
2012
|
+
* "error": "Internal Server Error"
|
|
2013
|
+
* }
|
|
2014
|
+
*/
|
|
2015
|
+
Components.Responses.InternalServerError;
|
|
2016
|
+
}
|
|
2017
|
+
}
|
|
2018
|
+
namespace UploadFileV2 {
|
|
2019
|
+
namespace Parameters {
|
|
2020
|
+
export type FileEntityId = /**
|
|
2021
|
+
* example:
|
|
2022
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
2023
|
+
*/
|
|
2024
|
+
Components.Schemas.FileEntityId;
|
|
2025
|
+
}
|
|
2026
|
+
export interface QueryParameters {
|
|
2027
|
+
file_entity_id?: Parameters.FileEntityId;
|
|
2028
|
+
}
|
|
2029
|
+
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
2030
|
+
namespace Responses {
|
|
2031
|
+
export type $201 = Components.Schemas.FileUpload;
|
|
2032
|
+
export type $400 = /**
|
|
2033
|
+
* A generic error returned by the API
|
|
2034
|
+
* example:
|
|
2035
|
+
* {
|
|
2036
|
+
* "status": 400,
|
|
2037
|
+
* "error": "Bad Request: filename is required"
|
|
2038
|
+
* }
|
|
2039
|
+
*/
|
|
2040
|
+
Components.Responses.BadRequestError;
|
|
2041
|
+
export type $401 = /**
|
|
2042
|
+
* A generic error returned by the API
|
|
2043
|
+
* example:
|
|
2044
|
+
* {
|
|
2045
|
+
* "status": 401,
|
|
2046
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
2047
|
+
* }
|
|
2048
|
+
*/
|
|
2049
|
+
Components.Responses.UnauthorizedError;
|
|
2050
|
+
export type $500 = /**
|
|
2051
|
+
* A generic error returned by the API
|
|
2052
|
+
* example:
|
|
2053
|
+
* {
|
|
2054
|
+
* "status": 500,
|
|
2055
|
+
* "error": "Internal Server Error"
|
|
2056
|
+
* }
|
|
2057
|
+
*/
|
|
2058
|
+
Components.Responses.InternalServerError;
|
|
2059
|
+
}
|
|
2060
|
+
}
|
|
2061
|
+
namespace VerifyCustomDownloadUrl {
|
|
2062
|
+
export type RequestBody = Components.Schemas.VerifyCustomDownloadUrlPayload;
|
|
2063
|
+
namespace Responses {
|
|
2064
|
+
export interface $200 {
|
|
2065
|
+
/**
|
|
2066
|
+
* Whether the URL is valid and not expired
|
|
2067
|
+
*/
|
|
2068
|
+
valid?: boolean;
|
|
2069
|
+
}
|
|
2070
|
+
export type $400 = /**
|
|
2071
|
+
* A generic error returned by the API
|
|
2072
|
+
* example:
|
|
2073
|
+
* {
|
|
2074
|
+
* "status": 400,
|
|
2075
|
+
* "error": "Bad Request: filename is required"
|
|
2076
|
+
* }
|
|
2077
|
+
*/
|
|
2078
|
+
Components.Responses.BadRequestError;
|
|
2079
|
+
export type $401 = /**
|
|
2080
|
+
* A generic error returned by the API
|
|
2081
|
+
* example:
|
|
2082
|
+
* {
|
|
2083
|
+
* "status": 401,
|
|
2084
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
2085
|
+
* }
|
|
2086
|
+
*/
|
|
2087
|
+
Components.Responses.UnauthorizedError;
|
|
2088
|
+
export type $500 = /**
|
|
2089
|
+
* A generic error returned by the API
|
|
2090
|
+
* example:
|
|
2091
|
+
* {
|
|
2092
|
+
* "status": 500,
|
|
2093
|
+
* "error": "Internal Server Error"
|
|
2094
|
+
* }
|
|
2095
|
+
*/
|
|
2096
|
+
Components.Responses.InternalServerError;
|
|
2097
|
+
}
|
|
2098
|
+
}
|
|
2099
|
+
}
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
interface OperationMethods {
|
|
2103
|
+
/**
|
|
2104
|
+
* uploadFileV2 - uploadFileV2
|
|
2105
|
+
*
|
|
2106
|
+
* Create pre-signed S3 URL to upload a file to keep temporarily (one week).
|
|
2107
|
+
*
|
|
2108
|
+
* Use the saveFileV2 operation to store file file permanently.
|
|
2109
|
+
*
|
|
2110
|
+
*/
|
|
2111
|
+
'uploadFileV2'(
|
|
2112
|
+
parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
|
|
2113
|
+
data?: Paths.UploadFileV2.RequestBody,
|
|
2114
|
+
config?: AxiosRequestConfig
|
|
2115
|
+
): OperationResponse<Paths.UploadFileV2.Responses.$201>
|
|
2116
|
+
/**
|
|
2117
|
+
* saveFileV2 - saveFileV2
|
|
2118
|
+
*
|
|
2119
|
+
* Saves a permanent file entity. Updates an existing file entity when `_id` is passed.
|
|
2120
|
+
*
|
|
2121
|
+
* Saves metadata to file entity and stores a version when `s3ref` or `source_url` is passed.
|
|
2122
|
+
*
|
|
2123
|
+
*/
|
|
2124
|
+
'saveFileV2'(
|
|
2125
|
+
parameters?: Parameters<Paths.SaveFileV2.QueryParameters> | null,
|
|
2126
|
+
data?: Paths.SaveFileV2.RequestBody,
|
|
2127
|
+
config?: AxiosRequestConfig
|
|
2128
|
+
): OperationResponse<Paths.SaveFileV2.Responses.$200>
|
|
2129
|
+
/**
|
|
2130
|
+
* uploadFile - uploadFile
|
|
2131
|
+
*
|
|
2132
|
+
* **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files/upload` instead.
|
|
2133
|
+
*
|
|
2134
|
+
* ## Migration Guide
|
|
2135
|
+
* Replace calls to this endpoint with `uploadFileV2`:
|
|
2136
|
+
*
|
|
2137
|
+
* | v1 Parameter | v2 Parameter | Notes |
|
|
2138
|
+
* |--------------|--------------|-------|
|
|
2139
|
+
* | `file_entity_id` | `file_entity_id` | No change |
|
|
2140
|
+
*
|
|
2141
|
+
* The v2 response includes the same fields with improved structure.
|
|
2142
|
+
*
|
|
2143
|
+
* ---
|
|
2144
|
+
*
|
|
2145
|
+
* Create pre-signed S3 URL to upload a file to keep temporarily (one week).
|
|
2146
|
+
*
|
|
2147
|
+
* Use the saveFile operation to store file file permanently.
|
|
2148
|
+
*
|
|
2149
|
+
*/
|
|
2150
|
+
'uploadFile'(
|
|
2151
|
+
parameters?: Parameters<Paths.UploadFile.QueryParameters> | null,
|
|
2152
|
+
data?: Paths.UploadFile.RequestBody,
|
|
2153
|
+
config?: AxiosRequestConfig
|
|
2154
|
+
): OperationResponse<Paths.UploadFile.Responses.$201>
|
|
2155
|
+
/**
|
|
2156
|
+
* saveFile - saveFile
|
|
2157
|
+
*
|
|
2158
|
+
* **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
|
|
2159
|
+
*
|
|
2160
|
+
* ## Migration Guide
|
|
2161
|
+
* Replace calls to this endpoint with `saveFileV2`:
|
|
2162
|
+
*
|
|
2163
|
+
* | v1 Feature | v2 Feature | Notes |
|
|
2164
|
+
* |------------|------------|-------|
|
|
2165
|
+
* | `activity_id` param | `activity_id` param | No change |
|
|
2166
|
+
* | `async` param | `async` param | No change |
|
|
2167
|
+
* | - | `fill_activity` param | New in v2 |
|
|
2168
|
+
* | - | `strict` param | New in v2 |
|
|
2169
|
+
* | - | `delete_temp_file` param | New in v2, defaults to true |
|
|
2170
|
+
*
|
|
2171
|
+
* The v2 endpoint supports additional parameters for better control over file saving behavior.
|
|
2172
|
+
*
|
|
2173
|
+
* ---
|
|
2174
|
+
*
|
|
2175
|
+
* Create / Update a permanent File entity.
|
|
2176
|
+
*
|
|
2177
|
+
* Makes file object permanent and saves metadata to file entity.
|
|
2178
|
+
*
|
|
2179
|
+
*/
|
|
2180
|
+
'saveFile'(
|
|
2181
|
+
parameters?: Parameters<Paths.SaveFile.QueryParameters> | null,
|
|
2182
|
+
data?: Paths.SaveFile.RequestBody,
|
|
2183
|
+
config?: AxiosRequestConfig
|
|
2184
|
+
): OperationResponse<Paths.SaveFile.Responses.$201>
|
|
2185
|
+
/**
|
|
2186
|
+
* getFile - getFile
|
|
2187
|
+
*
|
|
2188
|
+
* Get a file entity by id
|
|
2189
|
+
*/
|
|
2190
|
+
'getFile'(
|
|
2191
|
+
parameters?: Parameters<Paths.GetFile.QueryParameters & Paths.GetFile.PathParameters> | null,
|
|
2192
|
+
data?: any,
|
|
2193
|
+
config?: AxiosRequestConfig
|
|
2194
|
+
): OperationResponse<Paths.GetFile.Responses.$200>
|
|
2195
|
+
/**
|
|
2196
|
+
* deleteFile - deleteFile
|
|
2197
|
+
*
|
|
2198
|
+
* Delete a file entity by id
|
|
2199
|
+
*/
|
|
2200
|
+
'deleteFile'(
|
|
2201
|
+
parameters?: Parameters<Paths.DeleteFile.QueryParameters & Paths.DeleteFile.PathParameters> | null,
|
|
2202
|
+
data?: any,
|
|
2203
|
+
config?: AxiosRequestConfig
|
|
2204
|
+
): OperationResponse<Paths.DeleteFile.Responses.$200>
|
|
2205
|
+
/**
|
|
2206
|
+
* downloadFile - downloadFile
|
|
2207
|
+
*
|
|
2208
|
+
* Generate a pre-signed download URL for a file.
|
|
2209
|
+
*
|
|
2210
|
+
* The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.
|
|
2211
|
+
*
|
|
2212
|
+
*/
|
|
2213
|
+
'downloadFile'(
|
|
2214
|
+
parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
|
|
2215
|
+
data?: any,
|
|
2216
|
+
config?: AxiosRequestConfig
|
|
2217
|
+
): OperationResponse<Paths.DownloadFile.Responses.$200>
|
|
2218
|
+
/**
|
|
2219
|
+
* downloadS3File - downloadS3File
|
|
2220
|
+
*
|
|
2221
|
+
* Generate a pre-signed download URL for a file using its S3 reference.
|
|
2222
|
+
*
|
|
2223
|
+
* Use this endpoint when you have the S3 bucket and key but not the file entity ID.
|
|
2224
|
+
*
|
|
2225
|
+
*/
|
|
2226
|
+
'downloadS3File'(
|
|
2227
|
+
parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
|
|
2228
|
+
data?: any,
|
|
2229
|
+
config?: AxiosRequestConfig
|
|
2230
|
+
): OperationResponse<Paths.DownloadS3File.Responses.$200>
|
|
2231
|
+
/**
|
|
2232
|
+
* downloadFiles - downloadFiles
|
|
2233
|
+
*
|
|
2234
|
+
* Bulk generate pre-signed download URLs for multiple files in a single request.
|
|
2235
|
+
*
|
|
2236
|
+
* This is more efficient than calling `downloadFile` multiple times when you need to download several files.
|
|
2237
|
+
*
|
|
2238
|
+
*/
|
|
2239
|
+
'downloadFiles'(
|
|
2240
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2241
|
+
data?: Paths.DownloadFiles.RequestBody,
|
|
2242
|
+
config?: AxiosRequestConfig
|
|
2243
|
+
): OperationResponse<Paths.DownloadFiles.Responses.$200>
|
|
2244
|
+
/**
|
|
2245
|
+
* previewFile - previewFile
|
|
2246
|
+
*
|
|
2247
|
+
* Generate a thumbnail preview for a file entity.
|
|
2248
|
+
*
|
|
2249
|
+
* Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats.
|
|
2250
|
+
* The preview is returned as an image (PNG or JPEG).
|
|
2251
|
+
*
|
|
2252
|
+
* **Tip:** Use with CookieAuth to embed previews directly in `<img>` tags.
|
|
2253
|
+
*
|
|
2254
|
+
*/
|
|
2255
|
+
'previewFile'(
|
|
2256
|
+
parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
|
|
2257
|
+
data?: any,
|
|
2258
|
+
config?: AxiosRequestConfig
|
|
2259
|
+
): OperationResponse<Paths.PreviewFile.Responses.$200>
|
|
2260
|
+
/**
|
|
2261
|
+
* previewS3FileGet - previewS3FileGet
|
|
2262
|
+
*
|
|
2263
|
+
* Get a thumbnail preview from an S3 reference using query parameters.
|
|
2264
|
+
*
|
|
2265
|
+
* This GET variant is useful for embedding previews directly in `<img>` tags.
|
|
2266
|
+
*
|
|
2267
|
+
*/
|
|
2268
|
+
'previewS3FileGet'(
|
|
2269
|
+
parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
|
|
2270
|
+
data?: any,
|
|
2271
|
+
config?: AxiosRequestConfig
|
|
2272
|
+
): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
|
|
2273
|
+
/**
|
|
2274
|
+
* previewS3File - previewS3File
|
|
2275
|
+
*
|
|
2276
|
+
* Generate a thumbnail preview from an S3 reference.
|
|
2277
|
+
*
|
|
2278
|
+
* Use this endpoint when you have the S3 bucket and key but not the file entity ID.
|
|
2279
|
+
*
|
|
2280
|
+
*/
|
|
2281
|
+
'previewS3File'(
|
|
2282
|
+
parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
|
|
2283
|
+
data?: Paths.PreviewS3File.RequestBody,
|
|
2284
|
+
config?: AxiosRequestConfig
|
|
2285
|
+
): OperationResponse<Paths.PreviewS3File.Responses.$200>
|
|
2286
|
+
/**
|
|
2287
|
+
* previewPublicFile - previewPublicFile
|
|
2288
|
+
*
|
|
2289
|
+
* Generate a thumbnail preview for a public file entity.
|
|
2290
|
+
*
|
|
2291
|
+
* **No authentication required.** This endpoint only works for files with `access_control: public-read`.
|
|
2292
|
+
*
|
|
2293
|
+
*/
|
|
2294
|
+
'previewPublicFile'(
|
|
2295
|
+
parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
|
|
2296
|
+
data?: any,
|
|
2297
|
+
config?: AxiosRequestConfig
|
|
2298
|
+
): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
|
|
2299
|
+
/**
|
|
2300
|
+
* getSession - getSession
|
|
2301
|
+
*
|
|
2302
|
+
* Start a browser session by converting a Bearer token into a server-side cookie.
|
|
2303
|
+
*
|
|
2304
|
+
* **Use case:** After calling this endpoint, you can use preview URLs directly in `<img>` tags
|
|
2305
|
+
* without needing to set the Authorization header manually.
|
|
2306
|
+
*
|
|
2307
|
+
* **Example flow:**
|
|
2308
|
+
* 1. Call this endpoint with your Bearer token: `GET /v1/files/session` with `Authorization: Bearer <token>`
|
|
2309
|
+
* 2. The server sets an HTTP-only cookie named `token`
|
|
2310
|
+
* 3. Use preview URLs directly: `<img src="https://file.sls.epilot.io/v1/files/{id}/preview" />`
|
|
2311
|
+
*
|
|
2312
|
+
*/
|
|
2313
|
+
'getSession'(
|
|
2314
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2315
|
+
data?: any,
|
|
2316
|
+
config?: AxiosRequestConfig
|
|
2317
|
+
): OperationResponse<Paths.GetSession.Responses.$200>
|
|
2318
|
+
/**
|
|
2319
|
+
* deleteSession - deleteSession
|
|
2320
|
+
*
|
|
2321
|
+
* End a browser session by deleting the token cookie.
|
|
2322
|
+
*
|
|
2323
|
+
* Call this endpoint to log out and clear the session cookie.
|
|
2324
|
+
*
|
|
2325
|
+
*/
|
|
2326
|
+
'deleteSession'(
|
|
2327
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2328
|
+
data?: any,
|
|
2329
|
+
config?: AxiosRequestConfig
|
|
2330
|
+
): OperationResponse<Paths.DeleteSession.Responses.$200>
|
|
2331
|
+
/**
|
|
2332
|
+
* listPublicLinksForFile - listPublicLinksForFile
|
|
2333
|
+
*
|
|
2334
|
+
* **Not yet implemented.**
|
|
2335
|
+
*
|
|
2336
|
+
* This endpoint will fetch all public links previously generated for a file.
|
|
2337
|
+
*
|
|
2338
|
+
*/
|
|
2339
|
+
'listPublicLinksForFile'(
|
|
2340
|
+
parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
|
|
2341
|
+
data?: any,
|
|
2342
|
+
config?: AxiosRequestConfig
|
|
2343
|
+
): OperationResponse<Paths.ListPublicLinksForFile.Responses.$200>
|
|
2344
|
+
/**
|
|
2345
|
+
* generatePublicLink - generatePublicLink
|
|
2346
|
+
*
|
|
2347
|
+
* Generate a public link to share a private file externally.
|
|
2348
|
+
*
|
|
2349
|
+
* The generated link:
|
|
2350
|
+
* - Is permanent until explicitly revoked
|
|
2351
|
+
* - Includes the filename for user-friendly URLs
|
|
2352
|
+
* - Does not require authentication to access
|
|
2353
|
+
* - Redirects to a signed download URL when accessed
|
|
2354
|
+
*
|
|
2355
|
+
* **Use case:** Share invoices, contracts, or documents with external parties who don't have epilot accounts.
|
|
2356
|
+
*
|
|
2357
|
+
*/
|
|
2358
|
+
'generatePublicLink'(
|
|
2359
|
+
parameters?: Parameters<Paths.GeneratePublicLink.PathParameters> | null,
|
|
2360
|
+
data?: any,
|
|
2361
|
+
config?: AxiosRequestConfig
|
|
2362
|
+
): OperationResponse<Paths.GeneratePublicLink.Responses.$201>
|
|
2363
|
+
/**
|
|
2364
|
+
* accessPublicLink - accessPublicLink
|
|
2365
|
+
*
|
|
2366
|
+
* Access a file via its public link.
|
|
2367
|
+
*
|
|
2368
|
+
* **No authentication required.** This endpoint redirects to a signed S3 URL for downloading the file.
|
|
2369
|
+
*
|
|
2370
|
+
* The filename in the URL is for user-friendliness and SEO; the actual file is identified by the link ID.
|
|
2371
|
+
*
|
|
2372
|
+
*/
|
|
2373
|
+
'accessPublicLink'(
|
|
2374
|
+
parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
|
|
2375
|
+
data?: any,
|
|
2376
|
+
config?: AxiosRequestConfig
|
|
2377
|
+
): OperationResponse<any>
|
|
2378
|
+
/**
|
|
2379
|
+
* revokePublicLink - revokePublicLink
|
|
2380
|
+
*
|
|
2381
|
+
* **Not yet implemented.**
|
|
2382
|
+
*
|
|
2383
|
+
* This endpoint will revoke a public link, making the file inaccessible via that link.
|
|
2384
|
+
*
|
|
2385
|
+
*/
|
|
2386
|
+
'revokePublicLink'(
|
|
2387
|
+
parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
|
|
2388
|
+
data?: any,
|
|
2389
|
+
config?: AxiosRequestConfig
|
|
2390
|
+
): OperationResponse<Paths.RevokePublicLink.Responses.$204>
|
|
2391
|
+
/**
|
|
2392
|
+
* verifyCustomDownloadUrl - verifyCustomDownloadUrl
|
|
2393
|
+
*
|
|
2394
|
+
* Verify that a custom download URL is valid and has not expired.
|
|
2395
|
+
*
|
|
2396
|
+
* Use this endpoint to validate custom download URLs before redirecting users.
|
|
2397
|
+
* Custom download URLs include a signature and expiration time for security.
|
|
2398
|
+
*
|
|
2399
|
+
*/
|
|
2400
|
+
'verifyCustomDownloadUrl'(
|
|
2401
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2402
|
+
data?: Paths.VerifyCustomDownloadUrl.RequestBody,
|
|
2403
|
+
config?: AxiosRequestConfig
|
|
2404
|
+
): OperationResponse<Paths.VerifyCustomDownloadUrl.Responses.$200>
|
|
2405
|
+
/**
|
|
2406
|
+
* uploadFilePublic - uploadFilePublic
|
|
2407
|
+
*
|
|
2408
|
+
* Create a pre-signed S3 URL for uploading a file without authentication.
|
|
2409
|
+
*
|
|
2410
|
+
* **No authentication required.** This endpoint is intended for public-facing forms and journeys
|
|
2411
|
+
* where end-users need to upload files without logging in.
|
|
2412
|
+
*
|
|
2413
|
+
* The uploaded file is stored temporarily (one week). Use `saveFileV2` with proper authentication
|
|
2414
|
+
* to store the file permanently.
|
|
2415
|
+
*
|
|
2416
|
+
* **Security note:** Files uploaded via this endpoint are temporary and require authenticated
|
|
2417
|
+
* access to be saved permanently.
|
|
2418
|
+
*
|
|
2419
|
+
*/
|
|
2420
|
+
'uploadFilePublic'(
|
|
2421
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2422
|
+
data?: Paths.UploadFilePublic.RequestBody,
|
|
2423
|
+
config?: AxiosRequestConfig
|
|
2424
|
+
): OperationResponse<Paths.UploadFilePublic.Responses.$201>
|
|
2425
|
+
/**
|
|
2426
|
+
* getUserSchemaFileCollections - getUserSchemaFileCollections
|
|
2427
|
+
*
|
|
2428
|
+
* Get all file collections for the current user within a specific schema.
|
|
2429
|
+
*
|
|
2430
|
+
* Collections help organize files into logical groups (e.g., "Contracts", "Invoices").
|
|
2431
|
+
* User collections are private to the creating user.
|
|
2432
|
+
*
|
|
2433
|
+
*/
|
|
2434
|
+
'getUserSchemaFileCollections'(
|
|
2435
|
+
parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
|
|
2436
|
+
data?: any,
|
|
2437
|
+
config?: AxiosRequestConfig
|
|
2438
|
+
): OperationResponse<Paths.GetUserSchemaFileCollections.Responses.$200>
|
|
2439
|
+
/**
|
|
2440
|
+
* createUserSchemaFileCollection - createUserSchemaFileCollection
|
|
2441
|
+
*
|
|
2442
|
+
* Create a new file collection for the current user within a specific schema.
|
|
2443
|
+
*
|
|
2444
|
+
* The collection will be private to the creating user and associated with the specified schema.
|
|
2445
|
+
*
|
|
2446
|
+
*/
|
|
2447
|
+
'createUserSchemaFileCollection'(
|
|
2448
|
+
parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
|
|
2449
|
+
data?: Paths.CreateUserSchemaFileCollection.RequestBody,
|
|
2450
|
+
config?: AxiosRequestConfig
|
|
2451
|
+
): OperationResponse<Paths.CreateUserSchemaFileCollection.Responses.$201>
|
|
2452
|
+
/**
|
|
2453
|
+
* updateUserSchemaFileCollection - updateUserSchemaFileCollection
|
|
2454
|
+
*
|
|
2455
|
+
* Update an existing file collection.
|
|
2456
|
+
*
|
|
2457
|
+
* You can update the name, parent relationships, starred status, and enabled locations/purposes.
|
|
2458
|
+
*
|
|
2459
|
+
*/
|
|
2460
|
+
'updateUserSchemaFileCollection'(
|
|
2461
|
+
parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
|
|
2462
|
+
data?: Paths.UpdateUserSchemaFileCollection.RequestBody,
|
|
2463
|
+
config?: AxiosRequestConfig
|
|
2464
|
+
): OperationResponse<Paths.UpdateUserSchemaFileCollection.Responses.$200>
|
|
2465
|
+
/**
|
|
2466
|
+
* deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
|
|
2467
|
+
*
|
|
2468
|
+
* Delete a file collection.
|
|
2469
|
+
*
|
|
2470
|
+
* **Note:** Deleting a collection does not delete the files within it.
|
|
2471
|
+
* Files will remain but will no longer be associated with this collection.
|
|
2472
|
+
*
|
|
2473
|
+
*/
|
|
2474
|
+
'deleteUserSchemaFileCollection'(
|
|
2475
|
+
parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
|
|
2476
|
+
data?: any,
|
|
2477
|
+
config?: AxiosRequestConfig
|
|
2478
|
+
): OperationResponse<Paths.DeleteUserSchemaFileCollection.Responses.$200>
|
|
2479
|
+
/**
|
|
2480
|
+
* getFilesInCollection - getFilesInCollection
|
|
2481
|
+
*
|
|
2482
|
+
* Get all files within a specific collection for an entity.
|
|
2483
|
+
*
|
|
2484
|
+
* The schema is automatically derived from the entity. This endpoint requires
|
|
2485
|
+
* view permission on the parent entity to access its files.
|
|
2486
|
+
*
|
|
2487
|
+
*/
|
|
2488
|
+
'getFilesInCollection'(
|
|
2489
|
+
parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
|
|
2490
|
+
data?: any,
|
|
2491
|
+
config?: AxiosRequestConfig
|
|
2492
|
+
): OperationResponse<Paths.GetFilesInCollection.Responses.$200>
|
|
2493
|
+
/**
|
|
2494
|
+
* getGlobalFileCollections - getGlobalFileCollections
|
|
2495
|
+
*
|
|
2496
|
+
* Get all global file collections for a specific schema.
|
|
2497
|
+
*
|
|
2498
|
+
* Global collections are shared across all users in the organization for the specified schema.
|
|
2499
|
+
* Unlike user collections, these are visible to everyone with access to entities of that schema.
|
|
2500
|
+
*
|
|
2501
|
+
*/
|
|
2502
|
+
'getGlobalFileCollections'(
|
|
2503
|
+
parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
|
|
2504
|
+
data?: any,
|
|
2505
|
+
config?: AxiosRequestConfig
|
|
2506
|
+
): OperationResponse<Paths.GetGlobalFileCollections.Responses.$200>
|
|
2507
|
+
}
|
|
2508
|
+
|
|
2509
|
+
interface PathsDictionary {
|
|
2510
|
+
['/v2/files/upload']: {
|
|
2511
|
+
/**
|
|
2512
|
+
* uploadFileV2 - uploadFileV2
|
|
2513
|
+
*
|
|
2514
|
+
* Create pre-signed S3 URL to upload a file to keep temporarily (one week).
|
|
2515
|
+
*
|
|
2516
|
+
* Use the saveFileV2 operation to store file file permanently.
|
|
2517
|
+
*
|
|
2518
|
+
*/
|
|
2519
|
+
'post'(
|
|
2520
|
+
parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
|
|
2521
|
+
data?: Paths.UploadFileV2.RequestBody,
|
|
2522
|
+
config?: AxiosRequestConfig
|
|
2523
|
+
): OperationResponse<Paths.UploadFileV2.Responses.$201>
|
|
2524
|
+
}
|
|
2525
|
+
['/v2/files']: {
|
|
2526
|
+
/**
|
|
2527
|
+
* saveFileV2 - saveFileV2
|
|
2528
|
+
*
|
|
2529
|
+
* Saves a permanent file entity. Updates an existing file entity when `_id` is passed.
|
|
2530
|
+
*
|
|
2531
|
+
* Saves metadata to file entity and stores a version when `s3ref` or `source_url` is passed.
|
|
2532
|
+
*
|
|
2533
|
+
*/
|
|
2534
|
+
'post'(
|
|
2535
|
+
parameters?: Parameters<Paths.SaveFileV2.QueryParameters> | null,
|
|
2536
|
+
data?: Paths.SaveFileV2.RequestBody,
|
|
2537
|
+
config?: AxiosRequestConfig
|
|
2538
|
+
): OperationResponse<Paths.SaveFileV2.Responses.$200>
|
|
2539
|
+
}
|
|
2540
|
+
['/v1/files/upload']: {
|
|
2541
|
+
/**
|
|
2542
|
+
* uploadFile - uploadFile
|
|
2543
|
+
*
|
|
2544
|
+
* **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files/upload` instead.
|
|
2545
|
+
*
|
|
2546
|
+
* ## Migration Guide
|
|
2547
|
+
* Replace calls to this endpoint with `uploadFileV2`:
|
|
2548
|
+
*
|
|
2549
|
+
* | v1 Parameter | v2 Parameter | Notes |
|
|
2550
|
+
* |--------------|--------------|-------|
|
|
2551
|
+
* | `file_entity_id` | `file_entity_id` | No change |
|
|
2552
|
+
*
|
|
2553
|
+
* The v2 response includes the same fields with improved structure.
|
|
2554
|
+
*
|
|
2555
|
+
* ---
|
|
2556
|
+
*
|
|
2557
|
+
* Create pre-signed S3 URL to upload a file to keep temporarily (one week).
|
|
2558
|
+
*
|
|
2559
|
+
* Use the saveFile operation to store file file permanently.
|
|
2560
|
+
*
|
|
2561
|
+
*/
|
|
2562
|
+
'post'(
|
|
2563
|
+
parameters?: Parameters<Paths.UploadFile.QueryParameters> | null,
|
|
2564
|
+
data?: Paths.UploadFile.RequestBody,
|
|
2565
|
+
config?: AxiosRequestConfig
|
|
2566
|
+
): OperationResponse<Paths.UploadFile.Responses.$201>
|
|
2567
|
+
}
|
|
2568
|
+
['/v1/files']: {
|
|
2569
|
+
/**
|
|
2570
|
+
* saveFile - saveFile
|
|
2571
|
+
*
|
|
2572
|
+
* **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
|
|
2573
|
+
*
|
|
2574
|
+
* ## Migration Guide
|
|
2575
|
+
* Replace calls to this endpoint with `saveFileV2`:
|
|
2576
|
+
*
|
|
2577
|
+
* | v1 Feature | v2 Feature | Notes |
|
|
2578
|
+
* |------------|------------|-------|
|
|
2579
|
+
* | `activity_id` param | `activity_id` param | No change |
|
|
2580
|
+
* | `async` param | `async` param | No change |
|
|
2581
|
+
* | - | `fill_activity` param | New in v2 |
|
|
2582
|
+
* | - | `strict` param | New in v2 |
|
|
2583
|
+
* | - | `delete_temp_file` param | New in v2, defaults to true |
|
|
2584
|
+
*
|
|
2585
|
+
* The v2 endpoint supports additional parameters for better control over file saving behavior.
|
|
2586
|
+
*
|
|
2587
|
+
* ---
|
|
2588
|
+
*
|
|
2589
|
+
* Create / Update a permanent File entity.
|
|
2590
|
+
*
|
|
2591
|
+
* Makes file object permanent and saves metadata to file entity.
|
|
2592
|
+
*
|
|
2593
|
+
*/
|
|
2594
|
+
'post'(
|
|
2595
|
+
parameters?: Parameters<Paths.SaveFile.QueryParameters> | null,
|
|
2596
|
+
data?: Paths.SaveFile.RequestBody,
|
|
2597
|
+
config?: AxiosRequestConfig
|
|
2598
|
+
): OperationResponse<Paths.SaveFile.Responses.$201>
|
|
2599
|
+
}
|
|
2600
|
+
['/v2/files/{id}']: {
|
|
2601
|
+
/**
|
|
2602
|
+
* getFile - getFile
|
|
2603
|
+
*
|
|
2604
|
+
* Get a file entity by id
|
|
2605
|
+
*/
|
|
2606
|
+
'get'(
|
|
2607
|
+
parameters?: Parameters<Paths.GetFile.QueryParameters & Paths.GetFile.PathParameters> | null,
|
|
2608
|
+
data?: any,
|
|
2609
|
+
config?: AxiosRequestConfig
|
|
2610
|
+
): OperationResponse<Paths.GetFile.Responses.$200>
|
|
2611
|
+
/**
|
|
2612
|
+
* deleteFile - deleteFile
|
|
2613
|
+
*
|
|
2614
|
+
* Delete a file entity by id
|
|
2615
|
+
*/
|
|
2616
|
+
'delete'(
|
|
2617
|
+
parameters?: Parameters<Paths.DeleteFile.QueryParameters & Paths.DeleteFile.PathParameters> | null,
|
|
2618
|
+
data?: any,
|
|
2619
|
+
config?: AxiosRequestConfig
|
|
2620
|
+
): OperationResponse<Paths.DeleteFile.Responses.$200>
|
|
2621
|
+
}
|
|
2622
|
+
['/v1/files/{id}/download']: {
|
|
2623
|
+
/**
|
|
2624
|
+
* downloadFile - downloadFile
|
|
2625
|
+
*
|
|
2626
|
+
* Generate a pre-signed download URL for a file.
|
|
2627
|
+
*
|
|
2628
|
+
* The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.
|
|
2629
|
+
*
|
|
2630
|
+
*/
|
|
2631
|
+
'get'(
|
|
2632
|
+
parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
|
|
2633
|
+
data?: any,
|
|
2634
|
+
config?: AxiosRequestConfig
|
|
2635
|
+
): OperationResponse<Paths.DownloadFile.Responses.$200>
|
|
2636
|
+
}
|
|
2637
|
+
['/v1/files:downloadS3']: {
|
|
2638
|
+
/**
|
|
2639
|
+
* downloadS3File - downloadS3File
|
|
2640
|
+
*
|
|
2641
|
+
* Generate a pre-signed download URL for a file using its S3 reference.
|
|
2642
|
+
*
|
|
2643
|
+
* Use this endpoint when you have the S3 bucket and key but not the file entity ID.
|
|
2644
|
+
*
|
|
2645
|
+
*/
|
|
2646
|
+
'post'(
|
|
2647
|
+
parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
|
|
2648
|
+
data?: any,
|
|
2649
|
+
config?: AxiosRequestConfig
|
|
2650
|
+
): OperationResponse<Paths.DownloadS3File.Responses.$200>
|
|
2651
|
+
}
|
|
2652
|
+
['/v1/files:downloadFiles']: {
|
|
2653
|
+
/**
|
|
2654
|
+
* downloadFiles - downloadFiles
|
|
2655
|
+
*
|
|
2656
|
+
* Bulk generate pre-signed download URLs for multiple files in a single request.
|
|
2657
|
+
*
|
|
2658
|
+
* This is more efficient than calling `downloadFile` multiple times when you need to download several files.
|
|
2659
|
+
*
|
|
2660
|
+
*/
|
|
2661
|
+
'post'(
|
|
2662
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2663
|
+
data?: Paths.DownloadFiles.RequestBody,
|
|
2664
|
+
config?: AxiosRequestConfig
|
|
2665
|
+
): OperationResponse<Paths.DownloadFiles.Responses.$200>
|
|
2666
|
+
}
|
|
2667
|
+
['/v1/files/{id}/preview']: {
|
|
2668
|
+
/**
|
|
2669
|
+
* previewFile - previewFile
|
|
2670
|
+
*
|
|
2671
|
+
* Generate a thumbnail preview for a file entity.
|
|
2672
|
+
*
|
|
2673
|
+
* Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats.
|
|
2674
|
+
* The preview is returned as an image (PNG or JPEG).
|
|
2675
|
+
*
|
|
2676
|
+
* **Tip:** Use with CookieAuth to embed previews directly in `<img>` tags.
|
|
2677
|
+
*
|
|
2678
|
+
*/
|
|
2679
|
+
'get'(
|
|
2680
|
+
parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
|
|
2681
|
+
data?: any,
|
|
2682
|
+
config?: AxiosRequestConfig
|
|
2683
|
+
): OperationResponse<Paths.PreviewFile.Responses.$200>
|
|
2684
|
+
}
|
|
2685
|
+
['/v1/files:previewS3']: {
|
|
2686
|
+
/**
|
|
2687
|
+
* previewS3File - previewS3File
|
|
2688
|
+
*
|
|
2689
|
+
* Generate a thumbnail preview from an S3 reference.
|
|
2690
|
+
*
|
|
2691
|
+
* Use this endpoint when you have the S3 bucket and key but not the file entity ID.
|
|
2692
|
+
*
|
|
2693
|
+
*/
|
|
2694
|
+
'post'(
|
|
2695
|
+
parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
|
|
2696
|
+
data?: Paths.PreviewS3File.RequestBody,
|
|
2697
|
+
config?: AxiosRequestConfig
|
|
2698
|
+
): OperationResponse<Paths.PreviewS3File.Responses.$200>
|
|
2699
|
+
/**
|
|
2700
|
+
* previewS3FileGet - previewS3FileGet
|
|
2701
|
+
*
|
|
2702
|
+
* Get a thumbnail preview from an S3 reference using query parameters.
|
|
2703
|
+
*
|
|
2704
|
+
* This GET variant is useful for embedding previews directly in `<img>` tags.
|
|
2705
|
+
*
|
|
2706
|
+
*/
|
|
2707
|
+
'get'(
|
|
2708
|
+
parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
|
|
2709
|
+
data?: any,
|
|
2710
|
+
config?: AxiosRequestConfig
|
|
2711
|
+
): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
|
|
2712
|
+
}
|
|
2713
|
+
['/v1/files/public/{id}/preview']: {
|
|
2714
|
+
/**
|
|
2715
|
+
* previewPublicFile - previewPublicFile
|
|
2716
|
+
*
|
|
2717
|
+
* Generate a thumbnail preview for a public file entity.
|
|
2718
|
+
*
|
|
2719
|
+
* **No authentication required.** This endpoint only works for files with `access_control: public-read`.
|
|
2720
|
+
*
|
|
2721
|
+
*/
|
|
2722
|
+
'get'(
|
|
2723
|
+
parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
|
|
2724
|
+
data?: any,
|
|
2725
|
+
config?: AxiosRequestConfig
|
|
2726
|
+
): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
|
|
2727
|
+
}
|
|
2728
|
+
['/v1/files/session']: {
|
|
2729
|
+
/**
|
|
2730
|
+
* getSession - getSession
|
|
2731
|
+
*
|
|
2732
|
+
* Start a browser session by converting a Bearer token into a server-side cookie.
|
|
2733
|
+
*
|
|
2734
|
+
* **Use case:** After calling this endpoint, you can use preview URLs directly in `<img>` tags
|
|
2735
|
+
* without needing to set the Authorization header manually.
|
|
2736
|
+
*
|
|
2737
|
+
* **Example flow:**
|
|
2738
|
+
* 1. Call this endpoint with your Bearer token: `GET /v1/files/session` with `Authorization: Bearer <token>`
|
|
2739
|
+
* 2. The server sets an HTTP-only cookie named `token`
|
|
2740
|
+
* 3. Use preview URLs directly: `<img src="https://file.sls.epilot.io/v1/files/{id}/preview" />`
|
|
2741
|
+
*
|
|
2742
|
+
*/
|
|
2743
|
+
'get'(
|
|
2744
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2745
|
+
data?: any,
|
|
2746
|
+
config?: AxiosRequestConfig
|
|
2747
|
+
): OperationResponse<Paths.GetSession.Responses.$200>
|
|
2748
|
+
/**
|
|
2749
|
+
* deleteSession - deleteSession
|
|
2750
|
+
*
|
|
2751
|
+
* End a browser session by deleting the token cookie.
|
|
2752
|
+
*
|
|
2753
|
+
* Call this endpoint to log out and clear the session cookie.
|
|
2754
|
+
*
|
|
2755
|
+
*/
|
|
2756
|
+
'delete'(
|
|
2757
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2758
|
+
data?: any,
|
|
2759
|
+
config?: AxiosRequestConfig
|
|
2760
|
+
): OperationResponse<Paths.DeleteSession.Responses.$200>
|
|
2761
|
+
}
|
|
2762
|
+
['/v1/files/{id}/public/links']: {
|
|
2763
|
+
/**
|
|
2764
|
+
* generatePublicLink - generatePublicLink
|
|
2765
|
+
*
|
|
2766
|
+
* Generate a public link to share a private file externally.
|
|
2767
|
+
*
|
|
2768
|
+
* The generated link:
|
|
2769
|
+
* - Is permanent until explicitly revoked
|
|
2770
|
+
* - Includes the filename for user-friendly URLs
|
|
2771
|
+
* - Does not require authentication to access
|
|
2772
|
+
* - Redirects to a signed download URL when accessed
|
|
2773
|
+
*
|
|
2774
|
+
* **Use case:** Share invoices, contracts, or documents with external parties who don't have epilot accounts.
|
|
2775
|
+
*
|
|
2776
|
+
*/
|
|
2777
|
+
'post'(
|
|
2778
|
+
parameters?: Parameters<Paths.GeneratePublicLink.PathParameters> | null,
|
|
2779
|
+
data?: any,
|
|
2780
|
+
config?: AxiosRequestConfig
|
|
2781
|
+
): OperationResponse<Paths.GeneratePublicLink.Responses.$201>
|
|
2782
|
+
/**
|
|
2783
|
+
* listPublicLinksForFile - listPublicLinksForFile
|
|
2784
|
+
*
|
|
2785
|
+
* **Not yet implemented.**
|
|
2786
|
+
*
|
|
2787
|
+
* This endpoint will fetch all public links previously generated for a file.
|
|
2788
|
+
*
|
|
2789
|
+
*/
|
|
2790
|
+
'get'(
|
|
2791
|
+
parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
|
|
2792
|
+
data?: any,
|
|
2793
|
+
config?: AxiosRequestConfig
|
|
2794
|
+
): OperationResponse<Paths.ListPublicLinksForFile.Responses.$200>
|
|
2795
|
+
}
|
|
2796
|
+
['/v1/files/public/links/{id}/{filename}']: {
|
|
2797
|
+
/**
|
|
2798
|
+
* accessPublicLink - accessPublicLink
|
|
2799
|
+
*
|
|
2800
|
+
* Access a file via its public link.
|
|
2801
|
+
*
|
|
2802
|
+
* **No authentication required.** This endpoint redirects to a signed S3 URL for downloading the file.
|
|
2803
|
+
*
|
|
2804
|
+
* The filename in the URL is for user-friendliness and SEO; the actual file is identified by the link ID.
|
|
2805
|
+
*
|
|
2806
|
+
*/
|
|
2807
|
+
'get'(
|
|
2808
|
+
parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
|
|
2809
|
+
data?: any,
|
|
2810
|
+
config?: AxiosRequestConfig
|
|
2811
|
+
): OperationResponse<any>
|
|
2812
|
+
}
|
|
2813
|
+
['/v1/files/public/links/{id}']: {
|
|
2814
|
+
/**
|
|
2815
|
+
* revokePublicLink - revokePublicLink
|
|
2816
|
+
*
|
|
2817
|
+
* **Not yet implemented.**
|
|
2818
|
+
*
|
|
2819
|
+
* This endpoint will revoke a public link, making the file inaccessible via that link.
|
|
2820
|
+
*
|
|
2821
|
+
*/
|
|
2822
|
+
'delete'(
|
|
2823
|
+
parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
|
|
2824
|
+
data?: any,
|
|
2825
|
+
config?: AxiosRequestConfig
|
|
2826
|
+
): OperationResponse<Paths.RevokePublicLink.Responses.$204>
|
|
2827
|
+
}
|
|
2828
|
+
['/v1/files/download:verify']: {
|
|
2829
|
+
/**
|
|
2830
|
+
* verifyCustomDownloadUrl - verifyCustomDownloadUrl
|
|
2831
|
+
*
|
|
2832
|
+
* Verify that a custom download URL is valid and has not expired.
|
|
2833
|
+
*
|
|
2834
|
+
* Use this endpoint to validate custom download URLs before redirecting users.
|
|
2835
|
+
* Custom download URLs include a signature and expiration time for security.
|
|
2836
|
+
*
|
|
2837
|
+
*/
|
|
2838
|
+
'post'(
|
|
2839
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2840
|
+
data?: Paths.VerifyCustomDownloadUrl.RequestBody,
|
|
2841
|
+
config?: AxiosRequestConfig
|
|
2842
|
+
): OperationResponse<Paths.VerifyCustomDownloadUrl.Responses.$200>
|
|
2843
|
+
}
|
|
2844
|
+
['/v1/files/public/upload']: {
|
|
2845
|
+
/**
|
|
2846
|
+
* uploadFilePublic - uploadFilePublic
|
|
2847
|
+
*
|
|
2848
|
+
* Create a pre-signed S3 URL for uploading a file without authentication.
|
|
2849
|
+
*
|
|
2850
|
+
* **No authentication required.** This endpoint is intended for public-facing forms and journeys
|
|
2851
|
+
* where end-users need to upload files without logging in.
|
|
2852
|
+
*
|
|
2853
|
+
* The uploaded file is stored temporarily (one week). Use `saveFileV2` with proper authentication
|
|
2854
|
+
* to store the file permanently.
|
|
2855
|
+
*
|
|
2856
|
+
* **Security note:** Files uploaded via this endpoint are temporary and require authenticated
|
|
2857
|
+
* access to be saved permanently.
|
|
2858
|
+
*
|
|
2859
|
+
*/
|
|
2860
|
+
'post'(
|
|
2861
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2862
|
+
data?: Paths.UploadFilePublic.RequestBody,
|
|
2863
|
+
config?: AxiosRequestConfig
|
|
2864
|
+
): OperationResponse<Paths.UploadFilePublic.Responses.$201>
|
|
2865
|
+
}
|
|
2866
|
+
['/v1/{slug}/collections']: {
|
|
2867
|
+
/**
|
|
2868
|
+
* getUserSchemaFileCollections - getUserSchemaFileCollections
|
|
2869
|
+
*
|
|
2870
|
+
* Get all file collections for the current user within a specific schema.
|
|
2871
|
+
*
|
|
2872
|
+
* Collections help organize files into logical groups (e.g., "Contracts", "Invoices").
|
|
2873
|
+
* User collections are private to the creating user.
|
|
2874
|
+
*
|
|
2875
|
+
*/
|
|
2876
|
+
'get'(
|
|
2877
|
+
parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
|
|
2878
|
+
data?: any,
|
|
2879
|
+
config?: AxiosRequestConfig
|
|
2880
|
+
): OperationResponse<Paths.GetUserSchemaFileCollections.Responses.$200>
|
|
2881
|
+
/**
|
|
2882
|
+
* createUserSchemaFileCollection - createUserSchemaFileCollection
|
|
2883
|
+
*
|
|
2884
|
+
* Create a new file collection for the current user within a specific schema.
|
|
2885
|
+
*
|
|
2886
|
+
* The collection will be private to the creating user and associated with the specified schema.
|
|
2887
|
+
*
|
|
2888
|
+
*/
|
|
2889
|
+
'post'(
|
|
2890
|
+
parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
|
|
2891
|
+
data?: Paths.CreateUserSchemaFileCollection.RequestBody,
|
|
2892
|
+
config?: AxiosRequestConfig
|
|
2893
|
+
): OperationResponse<Paths.CreateUserSchemaFileCollection.Responses.$201>
|
|
2894
|
+
}
|
|
2895
|
+
['/v1/{slug}/collections/{collectionSlug}']: {
|
|
2896
|
+
/**
|
|
2897
|
+
* updateUserSchemaFileCollection - updateUserSchemaFileCollection
|
|
2898
|
+
*
|
|
2899
|
+
* Update an existing file collection.
|
|
2900
|
+
*
|
|
2901
|
+
* You can update the name, parent relationships, starred status, and enabled locations/purposes.
|
|
2902
|
+
*
|
|
2903
|
+
*/
|
|
2904
|
+
'put'(
|
|
2905
|
+
parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
|
|
2906
|
+
data?: Paths.UpdateUserSchemaFileCollection.RequestBody,
|
|
2907
|
+
config?: AxiosRequestConfig
|
|
2908
|
+
): OperationResponse<Paths.UpdateUserSchemaFileCollection.Responses.$200>
|
|
2909
|
+
/**
|
|
2910
|
+
* deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
|
|
2911
|
+
*
|
|
2912
|
+
* Delete a file collection.
|
|
2913
|
+
*
|
|
2914
|
+
* **Note:** Deleting a collection does not delete the files within it.
|
|
2915
|
+
* Files will remain but will no longer be associated with this collection.
|
|
2916
|
+
*
|
|
2917
|
+
*/
|
|
2918
|
+
'delete'(
|
|
2919
|
+
parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
|
|
2920
|
+
data?: any,
|
|
2921
|
+
config?: AxiosRequestConfig
|
|
2922
|
+
): OperationResponse<Paths.DeleteUserSchemaFileCollection.Responses.$200>
|
|
2923
|
+
}
|
|
2924
|
+
['/v1/entity/{id}/collections/{collectionSlug}/files']: {
|
|
2925
|
+
/**
|
|
2926
|
+
* getFilesInCollection - getFilesInCollection
|
|
2927
|
+
*
|
|
2928
|
+
* Get all files within a specific collection for an entity.
|
|
2929
|
+
*
|
|
2930
|
+
* The schema is automatically derived from the entity. This endpoint requires
|
|
2931
|
+
* view permission on the parent entity to access its files.
|
|
2932
|
+
*
|
|
2933
|
+
*/
|
|
2934
|
+
'get'(
|
|
2935
|
+
parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
|
|
2936
|
+
data?: any,
|
|
2937
|
+
config?: AxiosRequestConfig
|
|
2938
|
+
): OperationResponse<Paths.GetFilesInCollection.Responses.$200>
|
|
2939
|
+
}
|
|
2940
|
+
['/v1/collections/{schemaSlug}']: {
|
|
2941
|
+
/**
|
|
2942
|
+
* getGlobalFileCollections - getGlobalFileCollections
|
|
2943
|
+
*
|
|
2944
|
+
* Get all global file collections for a specific schema.
|
|
2945
|
+
*
|
|
2946
|
+
* Global collections are shared across all users in the organization for the specified schema.
|
|
2947
|
+
* Unlike user collections, these are visible to everyone with access to entities of that schema.
|
|
2948
|
+
*
|
|
2949
|
+
*/
|
|
2950
|
+
'get'(
|
|
2951
|
+
parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
|
|
2952
|
+
data?: any,
|
|
2953
|
+
config?: AxiosRequestConfig
|
|
2954
|
+
): OperationResponse<Paths.GetGlobalFileCollections.Responses.$200>
|
|
2955
|
+
}
|
|
2956
|
+
}
|
|
2957
|
+
|
|
2958
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2959
|
+
|
|
2960
|
+
|
|
2961
|
+
type ActivityId = Components.Schemas.ActivityId;
|
|
2962
|
+
type BaseEntityAcl = Components.Schemas.BaseEntityAcl;
|
|
2963
|
+
type BaseEntityOwner = Components.Schemas.BaseEntityOwner;
|
|
2964
|
+
type BatchSaveFileVersionPayload = Components.Schemas.BatchSaveFileVersionPayload;
|
|
2965
|
+
type CommonSaveFilePayload = Components.Schemas.CommonSaveFilePayload;
|
|
2966
|
+
type CustomDownloadUrl = Components.Schemas.CustomDownloadUrl;
|
|
2967
|
+
type DownloadFilesPayload = Components.Schemas.DownloadFilesPayload;
|
|
2968
|
+
type EntityId = Components.Schemas.EntityId;
|
|
2969
|
+
type EntitySlug = Components.Schemas.EntitySlug;
|
|
2970
|
+
type ErrorObject = Components.Schemas.ErrorObject;
|
|
2971
|
+
type FileAttributes = Components.Schemas.FileAttributes;
|
|
2972
|
+
type FileCollectionAttributes = Components.Schemas.FileCollectionAttributes;
|
|
2973
|
+
type FileCollectionCreateRequest = Components.Schemas.FileCollectionCreateRequest;
|
|
2974
|
+
type FileCollectionId = Components.Schemas.FileCollectionId;
|
|
2975
|
+
type FileCollectionItem = Components.Schemas.FileCollectionItem;
|
|
2976
|
+
type FileEntity = Components.Schemas.FileEntity;
|
|
2977
|
+
type FileEntityId = Components.Schemas.FileEntityId;
|
|
2978
|
+
type FileItem = Components.Schemas.FileItem;
|
|
2979
|
+
type FileRelationItem = Components.Schemas.FileRelationItem;
|
|
2980
|
+
type FileType = Components.Schemas.FileType;
|
|
2981
|
+
type FileUpload = Components.Schemas.FileUpload;
|
|
2982
|
+
type PublicLink = Components.Schemas.PublicLink;
|
|
2983
|
+
type S3Ref = Components.Schemas.S3Ref;
|
|
2984
|
+
type S3Reference = Components.Schemas.S3Reference;
|
|
2985
|
+
type SaveCustomFilePayload = Components.Schemas.SaveCustomFilePayload;
|
|
2986
|
+
type SaveFileFromSourceURLPayload = Components.Schemas.SaveFileFromSourceURLPayload;
|
|
2987
|
+
type SaveFilePayload = Components.Schemas.SaveFilePayload;
|
|
2988
|
+
type SaveFilePayloadV2 = Components.Schemas.SaveFilePayloadV2;
|
|
2989
|
+
type SaveS3FilePayload = Components.Schemas.SaveS3FilePayload;
|
|
2990
|
+
type UploadFilePayload = Components.Schemas.UploadFilePayload;
|
|
2991
|
+
type VerifyCustomDownloadUrlPayload = Components.Schemas.VerifyCustomDownloadUrlPayload;
|
|
2992
|
+
|
|
2993
|
+
export type { ActivityId as A, BaseEntityAcl as B, Client as C, DownloadFilesPayload as D, EntityId as E, FileAttributes as F, OperationMethods as O, PathsDictionary as P, S3Ref as S, UploadFilePayload as U, VerifyCustomDownloadUrlPayload as V, BaseEntityOwner as a, BatchSaveFileVersionPayload as b, CommonSaveFilePayload as c, CustomDownloadUrl as d, EntitySlug as e, ErrorObject as f, FileCollectionAttributes as g, FileCollectionCreateRequest as h, FileCollectionId as i, FileCollectionItem as j, FileEntity as k, FileEntityId as l, FileItem as m, FileRelationItem as n, FileType as o, FileUpload as p, PublicLink as q, S3Reference as r, SaveCustomFilePayload as s, SaveFileFromSourceURLPayload as t, SaveFilePayload as u, SaveFilePayloadV2 as v, SaveS3FilePayload as w };
|