@factify/sdk 0.3.8 → 0.3.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +5 -7
- package/README.md +46 -54
- package/dist/commonjs/funcs/apiKeysCreateAPIKey.d.ts +19 -0
- package/dist/commonjs/funcs/apiKeysCreateAPIKey.d.ts.map +1 -0
- package/dist/commonjs/funcs/apiKeysCreateAPIKey.js +122 -0
- package/dist/commonjs/funcs/apiKeysCreateAPIKey.js.map +1 -0
- package/dist/commonjs/funcs/{versionsUpdate.d.ts → apiKeysListAPIKeys.d.ts} +4 -4
- package/dist/commonjs/funcs/apiKeysListAPIKeys.d.ts.map +1 -0
- package/dist/commonjs/funcs/apiKeysListAPIKeys.js +127 -0
- package/dist/commonjs/funcs/apiKeysListAPIKeys.js.map +1 -0
- package/dist/commonjs/funcs/apiKeysRevokeAPIKey.d.ts +18 -0
- package/dist/commonjs/funcs/apiKeysRevokeAPIKey.d.ts.map +1 -0
- package/dist/commonjs/funcs/apiKeysRevokeAPIKey.js +127 -0
- package/dist/commonjs/funcs/apiKeysRevokeAPIKey.js.map +1 -0
- package/dist/commonjs/funcs/organizationsCreateOrganization.d.ts +19 -0
- package/dist/commonjs/funcs/organizationsCreateOrganization.d.ts.map +1 -0
- package/dist/commonjs/funcs/organizationsCreateOrganization.js +122 -0
- package/dist/commonjs/funcs/organizationsCreateOrganization.js.map +1 -0
- package/dist/commonjs/funcs/organizationsGetOrganization.d.ts +18 -0
- package/dist/commonjs/funcs/organizationsGetOrganization.d.ts.map +1 -0
- package/dist/commonjs/funcs/organizationsGetOrganization.js +126 -0
- package/dist/commonjs/funcs/organizationsGetOrganization.js.map +1 -0
- package/dist/commonjs/funcs/organizationsListOrganizations.d.ts +18 -0
- package/dist/commonjs/funcs/organizationsListOrganizations.d.ts.map +1 -0
- package/dist/commonjs/funcs/organizationsListOrganizations.js +125 -0
- package/dist/commonjs/funcs/organizationsListOrganizations.js.map +1 -0
- package/dist/{esm/funcs/versionsUpdate.d.ts → commonjs/funcs/versionsGetVersion.d.ts} +4 -4
- package/dist/commonjs/funcs/versionsGetVersion.d.ts.map +1 -0
- package/dist/commonjs/funcs/{versionsGet.js → versionsGetVersion.js} +7 -11
- package/dist/commonjs/funcs/versionsGetVersion.js.map +1 -0
- package/dist/commonjs/funcs/{versionsGet.d.ts → versionsUpdateVersion.d.ts} +4 -4
- package/dist/commonjs/funcs/versionsUpdateVersion.d.ts.map +1 -0
- package/dist/commonjs/funcs/{versionsUpdate.js → versionsUpdateVersion.js} +7 -11
- package/dist/commonjs/funcs/{versionsGet.js.map → versionsUpdateVersion.js.map} +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/lib/sdks.js +2 -2
- package/dist/commonjs/lib/sdks.js.map +1 -1
- package/dist/commonjs/models/components/apikey.d.ts +56 -0
- package/dist/commonjs/models/components/apikey.d.ts.map +1 -0
- package/dist/commonjs/models/components/apikey.js +68 -0
- package/dist/commonjs/models/components/apikey.js.map +1 -0
- package/dist/commonjs/models/components/createapikeyrequest.d.ts +37 -0
- package/dist/commonjs/models/components/createapikeyrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/createapikeyrequest.js +57 -0
- package/dist/commonjs/models/components/createapikeyrequest.js.map +1 -0
- package/dist/commonjs/models/components/createapikeyresponse.d.ts +29 -0
- package/dist/commonjs/models/components/createapikeyresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/createapikeyresponse.js +58 -0
- package/dist/commonjs/models/components/createapikeyresponse.js.map +1 -0
- package/dist/commonjs/models/components/createdocumentresponse.d.ts +1 -1
- package/dist/commonjs/models/components/createdocumentresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/createdocumentresponse.js +1 -2
- package/dist/commonjs/models/components/createdocumentresponse.js.map +1 -1
- package/dist/commonjs/models/components/createorganizationrequest.d.ts +28 -0
- package/dist/commonjs/models/components/createorganizationrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/createorganizationrequest.js +55 -0
- package/dist/commonjs/models/components/createorganizationrequest.js.map +1 -0
- package/dist/commonjs/models/components/createorganizationresponse.d.ts +17 -0
- package/dist/commonjs/models/components/createorganizationresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/createorganizationresponse.js +51 -0
- package/dist/commonjs/models/components/createorganizationresponse.js.map +1 -0
- package/dist/commonjs/models/components/getdocumentresponse.d.ts +1 -1
- package/dist/commonjs/models/components/getdocumentresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/getdocumentresponse.js +1 -2
- package/dist/commonjs/models/components/getdocumentresponse.js.map +1 -1
- package/dist/commonjs/models/components/getorganizationresponse.d.ts +17 -0
- package/dist/commonjs/models/components/getorganizationresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/getorganizationresponse.js +51 -0
- package/dist/commonjs/models/components/getorganizationresponse.js.map +1 -0
- package/dist/commonjs/models/components/index.d.ts +10 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +10 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/listapikeysresponse.d.ts +25 -0
- package/dist/commonjs/models/components/listapikeysresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/listapikeysresponse.js +54 -0
- package/dist/commonjs/models/components/listapikeysresponse.js.map +1 -0
- package/dist/commonjs/models/components/listdocumentpoliciesresponse.d.ts +1 -1
- package/dist/commonjs/models/components/listdocumentpoliciesresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/listdocumentpoliciesresponse.js +1 -1
- package/dist/commonjs/models/components/listdocumentpoliciesresponse.js.map +1 -1
- package/dist/commonjs/models/components/listdocumentsresponse.d.ts +1 -1
- package/dist/commonjs/models/components/listdocumentsresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/listdocumentsresponse.js +1 -1
- package/dist/commonjs/models/components/listdocumentsresponse.js.map +1 -1
- package/dist/commonjs/models/components/listorganizationsresponse.d.ts +25 -0
- package/dist/commonjs/models/components/listorganizationsresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/listorganizationsresponse.js +54 -0
- package/dist/commonjs/models/components/listorganizationsresponse.js.map +1 -0
- package/dist/commonjs/models/components/listversionsresponse.d.ts +1 -1
- package/dist/commonjs/models/components/listversionsresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/listversionsresponse.js +1 -1
- package/dist/commonjs/models/components/listversionsresponse.js.map +1 -1
- package/dist/commonjs/models/components/organization.d.ts +27 -0
- package/dist/commonjs/models/components/organization.d.ts.map +1 -0
- package/dist/commonjs/models/components/organization.js +58 -0
- package/dist/commonjs/models/components/organization.js.map +1 -0
- package/dist/commonjs/models/components/revokeapikeyresponse.d.ts +17 -0
- package/dist/commonjs/models/components/revokeapikeyresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/revokeapikeyresponse.js +56 -0
- package/dist/commonjs/models/components/revokeapikeyresponse.js.map +1 -0
- package/dist/commonjs/models/components/updatedocumentresponse.d.ts +1 -1
- package/dist/commonjs/models/components/updatedocumentresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/updatedocumentresponse.js +1 -2
- package/dist/commonjs/models/components/updatedocumentresponse.js.map +1 -1
- package/dist/commonjs/models/operations/createapikey.d.ts +18 -0
- package/dist/commonjs/models/operations/createapikey.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createapikey.js +61 -0
- package/dist/commonjs/models/operations/createapikey.js.map +1 -0
- package/dist/commonjs/models/operations/createorganization.d.ts +18 -0
- package/dist/commonjs/models/operations/createorganization.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createorganization.js +61 -0
- package/dist/commonjs/models/operations/createorganization.js.map +1 -0
- package/dist/commonjs/models/operations/getorganization.d.ts +34 -0
- package/dist/commonjs/models/operations/getorganization.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getorganization.js +73 -0
- package/dist/commonjs/models/operations/getorganization.js.map +1 -0
- package/dist/commonjs/models/operations/getversion.d.ts +34 -0
- package/dist/commonjs/models/operations/getversion.d.ts.map +1 -0
- package/dist/commonjs/models/operations/{getdocumentversion.js → getversion.js} +10 -12
- package/dist/commonjs/models/operations/getversion.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +8 -2
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +8 -2
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/listapikeys.d.ts +54 -0
- package/dist/commonjs/models/operations/listapikeys.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listapikeys.js +79 -0
- package/dist/commonjs/models/operations/listapikeys.js.map +1 -0
- package/dist/commonjs/models/operations/listorganizations.d.ts +36 -0
- package/dist/commonjs/models/operations/listorganizations.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listorganizations.js +75 -0
- package/dist/commonjs/models/operations/listorganizations.js.map +1 -0
- package/dist/commonjs/models/operations/revokeapikey.d.ts +55 -0
- package/dist/commonjs/models/operations/revokeapikey.d.ts.map +1 -0
- package/dist/commonjs/models/operations/revokeapikey.js +82 -0
- package/dist/commonjs/models/operations/revokeapikey.js.map +1 -0
- package/dist/commonjs/models/operations/{updatedocumentversion.d.ts → updateversion.d.ts} +14 -22
- package/dist/commonjs/models/operations/updateversion.d.ts.map +1 -0
- package/dist/commonjs/models/operations/{updatedocumentversion.js → updateversion.js} +14 -16
- package/dist/commonjs/models/operations/updateversion.js.map +1 -0
- package/dist/commonjs/sdk/apikeys.d.ts +27 -0
- package/dist/commonjs/sdk/apikeys.d.ts.map +1 -0
- package/dist/commonjs/sdk/apikeys.js +42 -0
- package/dist/commonjs/sdk/apikeys.js.map +1 -0
- package/dist/commonjs/sdk/organizations.d.ts +27 -0
- package/dist/commonjs/sdk/organizations.d.ts.map +1 -0
- package/dist/commonjs/sdk/organizations.js +42 -0
- package/dist/commonjs/sdk/organizations.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +6 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +8 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/commonjs/sdk/versions.d.ts +2 -2
- package/dist/commonjs/sdk/versions.d.ts.map +1 -1
- package/dist/commonjs/sdk/versions.js +6 -6
- package/dist/commonjs/sdk/versions.js.map +1 -1
- package/dist/esm/funcs/apiKeysCreateAPIKey.d.ts +19 -0
- package/dist/esm/funcs/apiKeysCreateAPIKey.d.ts.map +1 -0
- package/dist/esm/funcs/apiKeysCreateAPIKey.js +86 -0
- package/dist/esm/funcs/apiKeysCreateAPIKey.js.map +1 -0
- package/dist/esm/funcs/apiKeysListAPIKeys.d.ts +18 -0
- package/dist/esm/funcs/apiKeysListAPIKeys.d.ts.map +1 -0
- package/dist/esm/funcs/apiKeysListAPIKeys.js +91 -0
- package/dist/esm/funcs/apiKeysListAPIKeys.js.map +1 -0
- package/dist/esm/funcs/apiKeysRevokeAPIKey.d.ts +18 -0
- package/dist/esm/funcs/apiKeysRevokeAPIKey.d.ts.map +1 -0
- package/dist/esm/funcs/apiKeysRevokeAPIKey.js +91 -0
- package/dist/esm/funcs/apiKeysRevokeAPIKey.js.map +1 -0
- package/dist/esm/funcs/organizationsCreateOrganization.d.ts +19 -0
- package/dist/esm/funcs/organizationsCreateOrganization.d.ts.map +1 -0
- package/dist/esm/funcs/organizationsCreateOrganization.js +86 -0
- package/dist/esm/funcs/organizationsCreateOrganization.js.map +1 -0
- package/dist/esm/funcs/organizationsGetOrganization.d.ts +18 -0
- package/dist/esm/funcs/organizationsGetOrganization.d.ts.map +1 -0
- package/dist/esm/funcs/organizationsGetOrganization.js +90 -0
- package/dist/esm/funcs/organizationsGetOrganization.js.map +1 -0
- package/dist/esm/funcs/organizationsListOrganizations.d.ts +18 -0
- package/dist/esm/funcs/organizationsListOrganizations.d.ts.map +1 -0
- package/dist/esm/funcs/organizationsListOrganizations.js +89 -0
- package/dist/esm/funcs/organizationsListOrganizations.js.map +1 -0
- package/dist/esm/funcs/versionsGetVersion.d.ts +18 -0
- package/dist/esm/funcs/versionsGetVersion.d.ts.map +1 -0
- package/dist/esm/funcs/{versionsGet.js → versionsGetVersion.js} +6 -10
- package/dist/esm/funcs/versionsGetVersion.js.map +1 -0
- package/dist/esm/funcs/{versionsGet.d.ts → versionsUpdateVersion.d.ts} +4 -4
- package/dist/esm/funcs/versionsUpdateVersion.d.ts.map +1 -0
- package/dist/esm/funcs/{versionsUpdate.js → versionsUpdateVersion.js} +6 -10
- package/dist/esm/funcs/versionsUpdateVersion.js.map +1 -0
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/lib/sdks.js +2 -2
- package/dist/esm/lib/sdks.js.map +1 -1
- package/dist/esm/models/components/apikey.d.ts +56 -0
- package/dist/esm/models/components/apikey.d.ts.map +1 -0
- package/dist/esm/models/components/apikey.js +31 -0
- package/dist/esm/models/components/apikey.js.map +1 -0
- package/dist/esm/models/components/createapikeyrequest.d.ts +37 -0
- package/dist/esm/models/components/createapikeyrequest.d.ts.map +1 -0
- package/dist/esm/models/components/createapikeyrequest.js +20 -0
- package/dist/esm/models/components/createapikeyrequest.js.map +1 -0
- package/dist/esm/models/components/createapikeyresponse.d.ts +29 -0
- package/dist/esm/models/components/createapikeyresponse.d.ts.map +1 -0
- package/dist/esm/models/components/createapikeyresponse.js +21 -0
- package/dist/esm/models/components/createapikeyresponse.js.map +1 -0
- package/dist/esm/models/components/createdocumentresponse.d.ts +1 -1
- package/dist/esm/models/components/createdocumentresponse.d.ts.map +1 -1
- package/dist/esm/models/components/createdocumentresponse.js +1 -2
- package/dist/esm/models/components/createdocumentresponse.js.map +1 -1
- package/dist/esm/models/components/createorganizationrequest.d.ts +28 -0
- package/dist/esm/models/components/createorganizationrequest.d.ts.map +1 -0
- package/dist/esm/models/components/createorganizationrequest.js +18 -0
- package/dist/esm/models/components/createorganizationrequest.js.map +1 -0
- package/dist/esm/models/components/createorganizationresponse.d.ts +17 -0
- package/dist/esm/models/components/createorganizationresponse.d.ts.map +1 -0
- package/dist/esm/models/components/createorganizationresponse.js +14 -0
- package/dist/esm/models/components/createorganizationresponse.js.map +1 -0
- package/dist/esm/models/components/getdocumentresponse.d.ts +1 -1
- package/dist/esm/models/components/getdocumentresponse.d.ts.map +1 -1
- package/dist/esm/models/components/getdocumentresponse.js +1 -2
- package/dist/esm/models/components/getdocumentresponse.js.map +1 -1
- package/dist/esm/models/components/getorganizationresponse.d.ts +17 -0
- package/dist/esm/models/components/getorganizationresponse.d.ts.map +1 -0
- package/dist/esm/models/components/getorganizationresponse.js +14 -0
- package/dist/esm/models/components/getorganizationresponse.js.map +1 -0
- package/dist/esm/models/components/index.d.ts +10 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +10 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/listapikeysresponse.d.ts +25 -0
- package/dist/esm/models/components/listapikeysresponse.d.ts.map +1 -0
- package/dist/esm/models/components/listapikeysresponse.js +17 -0
- package/dist/esm/models/components/listapikeysresponse.js.map +1 -0
- package/dist/esm/models/components/listdocumentpoliciesresponse.d.ts +1 -1
- package/dist/esm/models/components/listdocumentpoliciesresponse.d.ts.map +1 -1
- package/dist/esm/models/components/listdocumentpoliciesresponse.js +1 -1
- package/dist/esm/models/components/listdocumentpoliciesresponse.js.map +1 -1
- package/dist/esm/models/components/listdocumentsresponse.d.ts +1 -1
- package/dist/esm/models/components/listdocumentsresponse.d.ts.map +1 -1
- package/dist/esm/models/components/listdocumentsresponse.js +1 -1
- package/dist/esm/models/components/listdocumentsresponse.js.map +1 -1
- package/dist/esm/models/components/listorganizationsresponse.d.ts +25 -0
- package/dist/esm/models/components/listorganizationsresponse.d.ts.map +1 -0
- package/dist/esm/models/components/listorganizationsresponse.js +17 -0
- package/dist/esm/models/components/listorganizationsresponse.js.map +1 -0
- package/dist/esm/models/components/listversionsresponse.d.ts +1 -1
- package/dist/esm/models/components/listversionsresponse.d.ts.map +1 -1
- package/dist/esm/models/components/listversionsresponse.js +1 -1
- package/dist/esm/models/components/listversionsresponse.js.map +1 -1
- package/dist/esm/models/components/organization.d.ts +27 -0
- package/dist/esm/models/components/organization.d.ts.map +1 -0
- package/dist/esm/models/components/organization.js +21 -0
- package/dist/esm/models/components/organization.js.map +1 -0
- package/dist/esm/models/components/revokeapikeyresponse.d.ts +17 -0
- package/dist/esm/models/components/revokeapikeyresponse.d.ts.map +1 -0
- package/dist/esm/models/components/revokeapikeyresponse.js +19 -0
- package/dist/esm/models/components/revokeapikeyresponse.js.map +1 -0
- package/dist/esm/models/components/updatedocumentresponse.d.ts +1 -1
- package/dist/esm/models/components/updatedocumentresponse.d.ts.map +1 -1
- package/dist/esm/models/components/updatedocumentresponse.js +1 -2
- package/dist/esm/models/components/updatedocumentresponse.js.map +1 -1
- package/dist/esm/models/operations/createapikey.d.ts +18 -0
- package/dist/esm/models/operations/createapikey.d.ts.map +1 -0
- package/dist/esm/models/operations/createapikey.js +24 -0
- package/dist/esm/models/operations/createapikey.js.map +1 -0
- package/dist/esm/models/operations/createorganization.d.ts +18 -0
- package/dist/esm/models/operations/createorganization.d.ts.map +1 -0
- package/dist/esm/models/operations/createorganization.js +24 -0
- package/dist/esm/models/operations/createorganization.js.map +1 -0
- package/dist/esm/models/operations/getorganization.d.ts +34 -0
- package/dist/esm/models/operations/getorganization.d.ts.map +1 -0
- package/dist/esm/models/operations/getorganization.js +35 -0
- package/dist/esm/models/operations/getorganization.js.map +1 -0
- package/dist/esm/models/operations/getversion.d.ts +34 -0
- package/dist/esm/models/operations/getversion.d.ts.map +1 -0
- package/dist/esm/models/operations/{getdocumentversion.js → getversion.js} +7 -9
- package/dist/esm/models/operations/getversion.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +8 -2
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +8 -2
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/listapikeys.d.ts +54 -0
- package/dist/esm/models/operations/listapikeys.d.ts.map +1 -0
- package/dist/esm/models/operations/listapikeys.js +41 -0
- package/dist/esm/models/operations/listapikeys.js.map +1 -0
- package/dist/esm/models/operations/listorganizations.d.ts +36 -0
- package/dist/esm/models/operations/listorganizations.d.ts.map +1 -0
- package/dist/esm/models/operations/listorganizations.js +37 -0
- package/dist/esm/models/operations/listorganizations.js.map +1 -0
- package/dist/esm/models/operations/revokeapikey.d.ts +55 -0
- package/dist/esm/models/operations/revokeapikey.d.ts.map +1 -0
- package/dist/esm/models/operations/revokeapikey.js +43 -0
- package/dist/esm/models/operations/revokeapikey.js.map +1 -0
- package/dist/esm/models/operations/{updatedocumentversion.d.ts → updateversion.d.ts} +14 -22
- package/dist/esm/models/operations/updateversion.d.ts.map +1 -0
- package/dist/esm/models/operations/{updatedocumentversion.js → updateversion.js} +11 -13
- package/dist/esm/models/operations/updateversion.js.map +1 -0
- package/dist/esm/sdk/apikeys.d.ts +27 -0
- package/dist/esm/sdk/apikeys.d.ts.map +1 -0
- package/dist/esm/sdk/apikeys.js +38 -0
- package/dist/esm/sdk/apikeys.js.map +1 -0
- package/dist/esm/sdk/organizations.d.ts +27 -0
- package/dist/esm/sdk/organizations.d.ts.map +1 -0
- package/dist/esm/sdk/organizations.js +38 -0
- package/dist/esm/sdk/organizations.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +6 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +8 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/dist/esm/sdk/versions.d.ts +2 -2
- package/dist/esm/sdk/versions.d.ts.map +1 -1
- package/dist/esm/sdk/versions.js +6 -6
- package/dist/esm/sdk/versions.js.map +1 -1
- package/examples/{documentsList.example.ts → apiKeysListAPIKeys.example.ts} +4 -7
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/openapi.json +830 -219
- package/package.json +1 -1
- package/src/funcs/apiKeysCreateAPIKey.ts +175 -0
- package/src/funcs/apiKeysListAPIKeys.ts +181 -0
- package/src/funcs/apiKeysRevokeAPIKey.ts +181 -0
- package/src/funcs/organizationsCreateOrganization.ts +176 -0
- package/src/funcs/organizationsGetOrganization.ts +182 -0
- package/src/funcs/organizationsListOrganizations.ts +183 -0
- package/src/funcs/{versionsGet.ts → versionsGetVersion.ts} +10 -17
- package/src/funcs/{versionsUpdate.ts → versionsUpdateVersion.ts} +10 -17
- package/src/lib/config.ts +3 -3
- package/src/lib/sdks.ts +2 -2
- package/src/models/components/apikey.ts +94 -0
- package/src/models/components/createapikeyrequest.ts +66 -0
- package/src/models/components/createapikeyresponse.ts +59 -0
- package/src/models/components/createdocumentresponse.ts +2 -3
- package/src/models/components/createorganizationrequest.ts +55 -0
- package/src/models/components/createorganizationresponse.ts +37 -0
- package/src/models/components/getdocumentresponse.ts +2 -3
- package/src/models/components/getorganizationresponse.ts +37 -0
- package/src/models/components/index.ts +10 -0
- package/src/models/components/listapikeysresponse.ts +47 -0
- package/src/models/components/listdocumentpoliciesresponse.ts +2 -2
- package/src/models/components/listdocumentsresponse.ts +2 -2
- package/src/models/components/listorganizationsresponse.ts +47 -0
- package/src/models/components/listversionsresponse.ts +2 -2
- package/src/models/components/organization.ts +56 -0
- package/src/models/components/revokeapikeyresponse.ts +45 -0
- package/src/models/components/updatedocumentresponse.ts +2 -3
- package/src/models/operations/createapikey.ts +51 -0
- package/src/models/operations/createorganization.ts +53 -0
- package/src/models/operations/getorganization.ts +89 -0
- package/src/models/operations/{getdocumentversion.ts → getversion.ts} +16 -26
- package/src/models/operations/index.ts +8 -2
- package/src/models/operations/listapikeys.ts +115 -0
- package/src/models/operations/listorganizations.ts +93 -0
- package/src/models/operations/revokeapikey.ts +128 -0
- package/src/models/operations/{updatedocumentversion.ts → updateversion.ts} +28 -38
- package/src/sdk/apikeys.ts +64 -0
- package/src/sdk/organizations.ts +64 -0
- package/src/sdk/sdk.ts +12 -0
- package/src/sdk/versions.ts +10 -10
- package/dist/commonjs/funcs/versionsGet.d.ts.map +0 -1
- package/dist/commonjs/funcs/versionsUpdate.d.ts.map +0 -1
- package/dist/commonjs/funcs/versionsUpdate.js.map +0 -1
- package/dist/commonjs/models/operations/getdocumentversion.d.ts +0 -42
- package/dist/commonjs/models/operations/getdocumentversion.d.ts.map +0 -1
- package/dist/commonjs/models/operations/getdocumentversion.js.map +0 -1
- package/dist/commonjs/models/operations/updatedocumentversion.d.ts.map +0 -1
- package/dist/commonjs/models/operations/updatedocumentversion.js.map +0 -1
- package/dist/esm/funcs/versionsGet.d.ts.map +0 -1
- package/dist/esm/funcs/versionsGet.js.map +0 -1
- package/dist/esm/funcs/versionsUpdate.d.ts.map +0 -1
- package/dist/esm/funcs/versionsUpdate.js.map +0 -1
- package/dist/esm/models/operations/getdocumentversion.d.ts +0 -42
- package/dist/esm/models/operations/getdocumentversion.d.ts.map +0 -1
- package/dist/esm/models/operations/getdocumentversion.js.map +0 -1
- package/dist/esm/models/operations/updatedocumentversion.d.ts.map +0 -1
- package/dist/esm/models/operations/updatedocumentversion.js.map +0 -1
package/openapi.json
CHANGED
|
@@ -168,6 +168,77 @@
|
|
|
168
168
|
"public"
|
|
169
169
|
]
|
|
170
170
|
},
|
|
171
|
+
"ApiKey": {
|
|
172
|
+
"additionalProperties": false,
|
|
173
|
+
"description": "ApiKey represents an authentication credential for programmatic API access.",
|
|
174
|
+
"properties": {
|
|
175
|
+
"created_at": {
|
|
176
|
+
"description": "Timestamp when the key was created.",
|
|
177
|
+
"format": "date-time",
|
|
178
|
+
"title": "created_at",
|
|
179
|
+
"type": "string"
|
|
180
|
+
},
|
|
181
|
+
"expires_at": {
|
|
182
|
+
"description": "Expiration timestamp. If set, the key becomes invalid after this time.",
|
|
183
|
+
"format": "date-time",
|
|
184
|
+
"title": "expires_at",
|
|
185
|
+
"type": "string"
|
|
186
|
+
},
|
|
187
|
+
"id": {
|
|
188
|
+
"description": "Unique ID for the API key.\n Pattern: key_[0-9a-hjkmnp-tv-z]{26}",
|
|
189
|
+
"example": "key_01jd4h5mck9gq6zrp8bn2t4w3x",
|
|
190
|
+
"pattern": "^key_[0-9a-hjkmnp-tv-z]{26}$",
|
|
191
|
+
"title": "id",
|
|
192
|
+
"type": "string"
|
|
193
|
+
},
|
|
194
|
+
"is_active": {
|
|
195
|
+
"description": "Whether the key is currently active (not revoked and not expired).\n Computed: is_active = (revoked_at == null) \u0026\u0026 (expires_at == null || expires_at \u003e now())",
|
|
196
|
+
"readOnly": true,
|
|
197
|
+
"title": "is_active",
|
|
198
|
+
"type": "boolean"
|
|
199
|
+
},
|
|
200
|
+
"key_prefix": {
|
|
201
|
+
"description": "Truncated key prefix for identification in UI (e.g., \"ffy_prod_01jd4h5...\").\n Shows the first 16 characters for better uniqueness while maintaining security.",
|
|
202
|
+
"example": "ffy_prod_01jd4h5...",
|
|
203
|
+
"maxLength": 20,
|
|
204
|
+
"minLength": 16,
|
|
205
|
+
"title": "key_prefix",
|
|
206
|
+
"type": "string"
|
|
207
|
+
},
|
|
208
|
+
"name": {
|
|
209
|
+
"description": "Human-readable name for the key (e.g., \"Production\", \"Staging\").",
|
|
210
|
+
"example": "Production",
|
|
211
|
+
"maxLength": 63,
|
|
212
|
+
"minLength": 1,
|
|
213
|
+
"title": "name",
|
|
214
|
+
"type": "string"
|
|
215
|
+
},
|
|
216
|
+
"organization_id": {
|
|
217
|
+
"description": "ID of the organization this key belongs to.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
218
|
+
"example": "org_01h2xcejqtf2nbrexx3vqjhp41",
|
|
219
|
+
"pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
|
|
220
|
+
"title": "organization_id",
|
|
221
|
+
"type": "string"
|
|
222
|
+
},
|
|
223
|
+
"revoked_at": {
|
|
224
|
+
"description": "Timestamp when the key was revoked. Null if the key has not been revoked.",
|
|
225
|
+
"format": "date-time",
|
|
226
|
+
"readOnly": true,
|
|
227
|
+
"title": "revoked_at",
|
|
228
|
+
"type": "string"
|
|
229
|
+
}
|
|
230
|
+
},
|
|
231
|
+
"required": [
|
|
232
|
+
"id",
|
|
233
|
+
"name",
|
|
234
|
+
"organization_id",
|
|
235
|
+
"created_at",
|
|
236
|
+
"is_active",
|
|
237
|
+
"key_prefix"
|
|
238
|
+
],
|
|
239
|
+
"title": "ApiKey",
|
|
240
|
+
"type": "object"
|
|
241
|
+
},
|
|
171
242
|
"AttachPolicyRequest": {
|
|
172
243
|
"additionalProperties": false,
|
|
173
244
|
"description": "AttachPolicyRequest specifies a policy to attach to a document.",
|
|
@@ -191,6 +262,62 @@
|
|
|
191
262
|
"title": "AttachPolicyRequest",
|
|
192
263
|
"type": "object"
|
|
193
264
|
},
|
|
265
|
+
"CreateApiKeyRequest": {
|
|
266
|
+
"additionalProperties": false,
|
|
267
|
+
"description": "CreateApiKeyRequest contains the data needed to create a new API key.",
|
|
268
|
+
"properties": {
|
|
269
|
+
"expires_at": {
|
|
270
|
+
"description": "Expiration timestamp. If not set, the key does not expire.\n When set, must be in the future and within 1 year.\n Security note: Keys without expiration should be rotated periodically.\ntimestamp.gt_now = true\ntimestamp.within = 8760h0m0s\n",
|
|
271
|
+
"format": "date-time",
|
|
272
|
+
"title": "expires_at",
|
|
273
|
+
"type": "string"
|
|
274
|
+
},
|
|
275
|
+
"name": {
|
|
276
|
+
"description": "Human-readable name for the key (e.g., \"Production\", \"Staging\").",
|
|
277
|
+
"maxLength": 63,
|
|
278
|
+
"minLength": 1,
|
|
279
|
+
"title": "name",
|
|
280
|
+
"type": "string"
|
|
281
|
+
},
|
|
282
|
+
"organization_id": {
|
|
283
|
+
"description": "Organization ID to create the key for.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
284
|
+
"pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
|
|
285
|
+
"title": "organization_id",
|
|
286
|
+
"type": "string"
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
"required": [
|
|
290
|
+
"organization_id",
|
|
291
|
+
"name"
|
|
292
|
+
],
|
|
293
|
+
"title": "CreateApiKeyRequest",
|
|
294
|
+
"type": "object"
|
|
295
|
+
},
|
|
296
|
+
"CreateApiKeyResponse": {
|
|
297
|
+
"additionalProperties": false,
|
|
298
|
+
"description": "CreateApiKeyResponse contains the newly created API key and its secret.",
|
|
299
|
+
"properties": {
|
|
300
|
+
"api_key": {
|
|
301
|
+
"$ref": "#/components/schemas/ApiKey",
|
|
302
|
+
"description": "The created API key metadata.",
|
|
303
|
+
"title": "api_key"
|
|
304
|
+
},
|
|
305
|
+
"secret": {
|
|
306
|
+
"description": "The API key secret. This is only returned once and cannot be retrieved later.\n Format: ffy_{env}_{base32_uuid7}{base62_random}\n - env: \"prod\" or \"test\"\n - base32_uuid7: 26 chars (TypeID base32 alphabet: 0-9a-hjkmnp-tv-z)\n - base62_random: 43 chars (0-9A-Za-z)\n Store this value securely - it will not be shown again.\n SECURITY WARNING: This field must NEVER be logged. Handlers must redact secrets from all logs.",
|
|
307
|
+
"example": "ffy_prod_01h2xcejqtf2nbrexx3vqjhp41KJ8f3mNpQrStUvWxYz0123456789ABCDEFGHIJKLmNo",
|
|
308
|
+
"minLength": 78,
|
|
309
|
+
"pattern": "^ffy_(prod|test)_[A-Za-z0-9]+$",
|
|
310
|
+
"title": "secret",
|
|
311
|
+
"type": "string"
|
|
312
|
+
}
|
|
313
|
+
},
|
|
314
|
+
"required": [
|
|
315
|
+
"api_key",
|
|
316
|
+
"secret"
|
|
317
|
+
],
|
|
318
|
+
"title": "CreateApiKeyResponse",
|
|
319
|
+
"type": "object"
|
|
320
|
+
},
|
|
194
321
|
"CreateDocumentRequest": {
|
|
195
322
|
"additionalProperties": false,
|
|
196
323
|
"description": "CreateDocumentRequest contains the file and metadata for creating a document.",
|
|
@@ -257,9 +384,52 @@
|
|
|
257
384
|
"title": "document"
|
|
258
385
|
}
|
|
259
386
|
},
|
|
387
|
+
"required": [
|
|
388
|
+
"document"
|
|
389
|
+
],
|
|
260
390
|
"title": "CreateDocumentResponse",
|
|
261
391
|
"type": "object"
|
|
262
392
|
},
|
|
393
|
+
"CreateOrganizationRequest": {
|
|
394
|
+
"additionalProperties": false,
|
|
395
|
+
"description": "CreateOrganizationRequest contains the data needed to create a new organization.",
|
|
396
|
+
"properties": {
|
|
397
|
+
"name": {
|
|
398
|
+
"description": "Human-readable organization name.",
|
|
399
|
+
"maxLength": 255,
|
|
400
|
+
"minLength": 1,
|
|
401
|
+
"title": "name",
|
|
402
|
+
"type": "string"
|
|
403
|
+
},
|
|
404
|
+
"owner_user_id": {
|
|
405
|
+
"description": "Owner user ID. If not provided, the authenticated user becomes the owner.\n Authorization: Specifying a different user requires system maintainer role.\n Required when the caller is a service account (service accounts cannot own organizations).\n Pattern: user_[0-9a-hjkmnp-tv-z]{26}",
|
|
406
|
+
"pattern": "^user_[0-9a-hjkmnp-tv-z]{26}$",
|
|
407
|
+
"title": "owner_user_id",
|
|
408
|
+
"type": "string"
|
|
409
|
+
}
|
|
410
|
+
},
|
|
411
|
+
"required": [
|
|
412
|
+
"name"
|
|
413
|
+
],
|
|
414
|
+
"title": "CreateOrganizationRequest",
|
|
415
|
+
"type": "object"
|
|
416
|
+
},
|
|
417
|
+
"CreateOrganizationResponse": {
|
|
418
|
+
"additionalProperties": false,
|
|
419
|
+
"description": "CreateOrganizationResponse contains the newly created organization.",
|
|
420
|
+
"properties": {
|
|
421
|
+
"organization": {
|
|
422
|
+
"$ref": "#/components/schemas/Organization",
|
|
423
|
+
"description": "The created organization.",
|
|
424
|
+
"title": "organization"
|
|
425
|
+
}
|
|
426
|
+
},
|
|
427
|
+
"required": [
|
|
428
|
+
"organization"
|
|
429
|
+
],
|
|
430
|
+
"title": "CreateOrganizationResponse",
|
|
431
|
+
"type": "object"
|
|
432
|
+
},
|
|
263
433
|
"CreateVersionRequest": {
|
|
264
434
|
"additionalProperties": false,
|
|
265
435
|
"description": "CreateVersionRequest contains the file and metadata for creating a version.",
|
|
@@ -553,21 +723,51 @@
|
|
|
553
723
|
"title": "document"
|
|
554
724
|
}
|
|
555
725
|
},
|
|
726
|
+
"required": [
|
|
727
|
+
"document"
|
|
728
|
+
],
|
|
556
729
|
"title": "GetDocumentResponse",
|
|
557
730
|
"type": "object"
|
|
558
731
|
},
|
|
732
|
+
"GetOrganizationRequest": {
|
|
733
|
+
"additionalProperties": false,
|
|
734
|
+
"description": "GetOrganizationRequest identifies an organization to retrieve.",
|
|
735
|
+
"properties": {
|
|
736
|
+
"organization_id": {
|
|
737
|
+
"description": "Organization ID.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
738
|
+
"pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
|
|
739
|
+
"title": "organization_id",
|
|
740
|
+
"type": "string"
|
|
741
|
+
}
|
|
742
|
+
},
|
|
743
|
+
"required": [
|
|
744
|
+
"organization_id"
|
|
745
|
+
],
|
|
746
|
+
"title": "GetOrganizationRequest",
|
|
747
|
+
"type": "object"
|
|
748
|
+
},
|
|
749
|
+
"GetOrganizationResponse": {
|
|
750
|
+
"additionalProperties": false,
|
|
751
|
+
"description": "GetOrganizationResponse contains the requested organization.",
|
|
752
|
+
"properties": {
|
|
753
|
+
"organization": {
|
|
754
|
+
"$ref": "#/components/schemas/Organization",
|
|
755
|
+
"description": "The requested organization.",
|
|
756
|
+
"title": "organization"
|
|
757
|
+
}
|
|
758
|
+
},
|
|
759
|
+
"required": [
|
|
760
|
+
"organization"
|
|
761
|
+
],
|
|
762
|
+
"title": "GetOrganizationResponse",
|
|
763
|
+
"type": "object"
|
|
764
|
+
},
|
|
559
765
|
"GetVersionRequest": {
|
|
560
766
|
"additionalProperties": false,
|
|
561
767
|
"description": "GetVersionRequest identifies a specific version to retrieve.",
|
|
562
768
|
"properties": {
|
|
563
|
-
"document_id": {
|
|
564
|
-
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
565
|
-
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
566
|
-
"title": "document_id",
|
|
567
|
-
"type": "string"
|
|
568
|
-
},
|
|
569
769
|
"version_id": {
|
|
570
|
-
"description": "Version ID.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
770
|
+
"description": "Version ID to retrieve.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
571
771
|
"pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
|
|
572
772
|
"title": "version_id",
|
|
573
773
|
"type": "string"
|
|
@@ -576,6 +776,66 @@
|
|
|
576
776
|
"title": "GetVersionRequest",
|
|
577
777
|
"type": "object"
|
|
578
778
|
},
|
|
779
|
+
"ListApiKeysRequest": {
|
|
780
|
+
"additionalProperties": false,
|
|
781
|
+
"description": "ListApiKeysRequest specifies filters and pagination for listing API keys.",
|
|
782
|
+
"properties": {
|
|
783
|
+
"include_revoked": {
|
|
784
|
+
"description": "Whether to include revoked keys in the response.\n Default: false (only active and expired-but-not-revoked keys are returned).\n When true, all keys including revoked ones are returned.\n Note: Expired keys are always included unless also revoked; use is_active to filter.",
|
|
785
|
+
"title": "include_revoked",
|
|
786
|
+
"type": "boolean"
|
|
787
|
+
},
|
|
788
|
+
"organization_id": {
|
|
789
|
+
"description": "Organization ID to list keys for.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
790
|
+
"pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
|
|
791
|
+
"title": "organization_id",
|
|
792
|
+
"type": "string"
|
|
793
|
+
},
|
|
794
|
+
"page_size": {
|
|
795
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
796
|
+
"format": "int32",
|
|
797
|
+
"maximum": 100,
|
|
798
|
+
"minimum": 1,
|
|
799
|
+
"nullable": true,
|
|
800
|
+
"title": "page_size",
|
|
801
|
+
"type": "integer"
|
|
802
|
+
},
|
|
803
|
+
"page_token": {
|
|
804
|
+
"description": "Opaque pagination token from a previous response.",
|
|
805
|
+
"title": "page_token",
|
|
806
|
+
"type": "string"
|
|
807
|
+
}
|
|
808
|
+
},
|
|
809
|
+
"required": [
|
|
810
|
+
"organization_id"
|
|
811
|
+
],
|
|
812
|
+
"title": "ListApiKeysRequest",
|
|
813
|
+
"type": "object"
|
|
814
|
+
},
|
|
815
|
+
"ListApiKeysResponse": {
|
|
816
|
+
"additionalProperties": false,
|
|
817
|
+
"description": "ListApiKeysResponse contains a page of API keys.",
|
|
818
|
+
"properties": {
|
|
819
|
+
"items": {
|
|
820
|
+
"description": "List of API keys (secrets are never included).",
|
|
821
|
+
"items": {
|
|
822
|
+
"$ref": "#/components/schemas/ApiKey"
|
|
823
|
+
},
|
|
824
|
+
"title": "items",
|
|
825
|
+
"type": "array"
|
|
826
|
+
},
|
|
827
|
+
"pagination": {
|
|
828
|
+
"$ref": "#/components/schemas/Pagination",
|
|
829
|
+
"description": "Pagination metadata.",
|
|
830
|
+
"title": "pagination"
|
|
831
|
+
}
|
|
832
|
+
},
|
|
833
|
+
"required": [
|
|
834
|
+
"pagination"
|
|
835
|
+
],
|
|
836
|
+
"title": "ListApiKeysResponse",
|
|
837
|
+
"type": "object"
|
|
838
|
+
},
|
|
579
839
|
"ListDocumentPoliciesRequest": {
|
|
580
840
|
"additionalProperties": false,
|
|
581
841
|
"description": "ListDocumentPoliciesRequest specifies pagination for listing document policies.\n Follows Google AIP-158 for pagination field naming.",
|
|
@@ -623,6 +883,9 @@
|
|
|
623
883
|
"title": "pagination"
|
|
624
884
|
}
|
|
625
885
|
},
|
|
886
|
+
"required": [
|
|
887
|
+
"pagination"
|
|
888
|
+
],
|
|
626
889
|
"title": "ListDocumentPoliciesResponse",
|
|
627
890
|
"type": "object"
|
|
628
891
|
},
|
|
@@ -692,9 +955,58 @@
|
|
|
692
955
|
"title": "pagination"
|
|
693
956
|
}
|
|
694
957
|
},
|
|
958
|
+
"required": [
|
|
959
|
+
"pagination"
|
|
960
|
+
],
|
|
695
961
|
"title": "ListDocumentsResponse",
|
|
696
962
|
"type": "object"
|
|
697
963
|
},
|
|
964
|
+
"ListOrganizationsRequest": {
|
|
965
|
+
"additionalProperties": false,
|
|
966
|
+
"description": "ListOrganizationsRequest specifies pagination for listing organizations.",
|
|
967
|
+
"properties": {
|
|
968
|
+
"page_size": {
|
|
969
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
970
|
+
"format": "int32",
|
|
971
|
+
"maximum": 100,
|
|
972
|
+
"minimum": 1,
|
|
973
|
+
"nullable": true,
|
|
974
|
+
"title": "page_size",
|
|
975
|
+
"type": "integer"
|
|
976
|
+
},
|
|
977
|
+
"page_token": {
|
|
978
|
+
"description": "Opaque pagination token from a previous response.",
|
|
979
|
+
"title": "page_token",
|
|
980
|
+
"type": "string"
|
|
981
|
+
}
|
|
982
|
+
},
|
|
983
|
+
"title": "ListOrganizationsRequest",
|
|
984
|
+
"type": "object"
|
|
985
|
+
},
|
|
986
|
+
"ListOrganizationsResponse": {
|
|
987
|
+
"additionalProperties": false,
|
|
988
|
+
"description": "ListOrganizationsResponse contains a page of organizations.",
|
|
989
|
+
"properties": {
|
|
990
|
+
"items": {
|
|
991
|
+
"description": "List of organizations.",
|
|
992
|
+
"items": {
|
|
993
|
+
"$ref": "#/components/schemas/Organization"
|
|
994
|
+
},
|
|
995
|
+
"title": "items",
|
|
996
|
+
"type": "array"
|
|
997
|
+
},
|
|
998
|
+
"pagination": {
|
|
999
|
+
"$ref": "#/components/schemas/Pagination",
|
|
1000
|
+
"description": "Pagination metadata.",
|
|
1001
|
+
"title": "pagination"
|
|
1002
|
+
}
|
|
1003
|
+
},
|
|
1004
|
+
"required": [
|
|
1005
|
+
"pagination"
|
|
1006
|
+
],
|
|
1007
|
+
"title": "ListOrganizationsResponse",
|
|
1008
|
+
"type": "object"
|
|
1009
|
+
},
|
|
698
1010
|
"ListVersionsRequest": {
|
|
699
1011
|
"additionalProperties": false,
|
|
700
1012
|
"description": "ListVersionsRequest specifies filters and pagination for listing versions.\n Follows Google AIP-158 for pagination field naming.",
|
|
@@ -742,9 +1054,46 @@
|
|
|
742
1054
|
"title": "pagination"
|
|
743
1055
|
}
|
|
744
1056
|
},
|
|
1057
|
+
"required": [
|
|
1058
|
+
"pagination"
|
|
1059
|
+
],
|
|
745
1060
|
"title": "ListVersionsResponse",
|
|
746
1061
|
"type": "object"
|
|
747
1062
|
},
|
|
1063
|
+
"Organization": {
|
|
1064
|
+
"additionalProperties": false,
|
|
1065
|
+
"description": "Organization represents a Factify organization.",
|
|
1066
|
+
"properties": {
|
|
1067
|
+
"created_at": {
|
|
1068
|
+
"description": "Timestamp when the organization was created.",
|
|
1069
|
+
"format": "date-time",
|
|
1070
|
+
"title": "created_at",
|
|
1071
|
+
"type": "string"
|
|
1072
|
+
},
|
|
1073
|
+
"id": {
|
|
1074
|
+
"description": "Unique ID for the organization.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
1075
|
+
"example": "org_01h2xcejqtf2nbrexx3vqjhp41",
|
|
1076
|
+
"pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1077
|
+
"title": "id",
|
|
1078
|
+
"type": "string"
|
|
1079
|
+
},
|
|
1080
|
+
"name": {
|
|
1081
|
+
"description": "Human-readable organization name.",
|
|
1082
|
+
"example": "Acme Corporation",
|
|
1083
|
+
"maxLength": 255,
|
|
1084
|
+
"minLength": 1,
|
|
1085
|
+
"title": "name",
|
|
1086
|
+
"type": "string"
|
|
1087
|
+
}
|
|
1088
|
+
},
|
|
1089
|
+
"required": [
|
|
1090
|
+
"id",
|
|
1091
|
+
"name",
|
|
1092
|
+
"created_at"
|
|
1093
|
+
],
|
|
1094
|
+
"title": "Organization",
|
|
1095
|
+
"type": "object"
|
|
1096
|
+
},
|
|
748
1097
|
"Pagination": {
|
|
749
1098
|
"additionalProperties": false,
|
|
750
1099
|
"description": "Pagination contains cursor-based pagination metadata.\n Follows Google AIP-158 for pagination field naming.",
|
|
@@ -810,6 +1159,47 @@
|
|
|
810
1159
|
"failed"
|
|
811
1160
|
]
|
|
812
1161
|
},
|
|
1162
|
+
"RevokeApiKeyRequest": {
|
|
1163
|
+
"additionalProperties": false,
|
|
1164
|
+
"description": "RevokeApiKeyRequest identifies an API key to revoke.",
|
|
1165
|
+
"properties": {
|
|
1166
|
+
"api_key_id": {
|
|
1167
|
+
"description": "API key ID to revoke.\n Pattern: key_[0-9a-hjkmnp-tv-z]{26}",
|
|
1168
|
+
"pattern": "^key_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1169
|
+
"title": "api_key_id",
|
|
1170
|
+
"type": "string"
|
|
1171
|
+
},
|
|
1172
|
+
"reason": {
|
|
1173
|
+
"description": "Optional reason for revocation (for audit purposes).\n The revoking user's identity and timestamp are captured in audit logs separately.",
|
|
1174
|
+
"maxLength": 500,
|
|
1175
|
+
"minLength": 1,
|
|
1176
|
+
"nullable": true,
|
|
1177
|
+
"title": "reason",
|
|
1178
|
+
"type": "string"
|
|
1179
|
+
}
|
|
1180
|
+
},
|
|
1181
|
+
"required": [
|
|
1182
|
+
"api_key_id"
|
|
1183
|
+
],
|
|
1184
|
+
"title": "RevokeApiKeyRequest",
|
|
1185
|
+
"type": "object"
|
|
1186
|
+
},
|
|
1187
|
+
"RevokeApiKeyResponse": {
|
|
1188
|
+
"additionalProperties": false,
|
|
1189
|
+
"description": "RevokeApiKeyResponse contains the revoked API key.",
|
|
1190
|
+
"properties": {
|
|
1191
|
+
"api_key": {
|
|
1192
|
+
"$ref": "#/components/schemas/ApiKey",
|
|
1193
|
+
"description": "The revoked API key with updated revoked_at timestamp.",
|
|
1194
|
+
"title": "api_key"
|
|
1195
|
+
}
|
|
1196
|
+
},
|
|
1197
|
+
"required": [
|
|
1198
|
+
"api_key"
|
|
1199
|
+
],
|
|
1200
|
+
"title": "RevokeApiKeyResponse",
|
|
1201
|
+
"type": "object"
|
|
1202
|
+
},
|
|
813
1203
|
"TimestampFilter": {
|
|
814
1204
|
"additionalProperties": false,
|
|
815
1205
|
"description": "TimestampFilter specifies a time range for filtering.\n Used with Vanguard dot notation: ?created.after=...\u0026created.before=...",
|
|
@@ -871,6 +1261,9 @@
|
|
|
871
1261
|
"title": "document"
|
|
872
1262
|
}
|
|
873
1263
|
},
|
|
1264
|
+
"required": [
|
|
1265
|
+
"document"
|
|
1266
|
+
],
|
|
874
1267
|
"title": "UpdateDocumentResponse",
|
|
875
1268
|
"type": "object"
|
|
876
1269
|
},
|
|
@@ -884,12 +1277,6 @@
|
|
|
884
1277
|
"title": "description",
|
|
885
1278
|
"type": "string"
|
|
886
1279
|
},
|
|
887
|
-
"document_id": {
|
|
888
|
-
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
889
|
-
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
890
|
-
"title": "document_id",
|
|
891
|
-
"type": "string"
|
|
892
|
-
},
|
|
893
1280
|
"title": {
|
|
894
1281
|
"description": "New title (max 255 characters).",
|
|
895
1282
|
"maxLength": 255,
|
|
@@ -1056,7 +1443,241 @@
|
|
|
1056
1443
|
},
|
|
1057
1444
|
"openapi": "3.1.0",
|
|
1058
1445
|
"paths": {
|
|
1059
|
-
"/v1beta/
|
|
1446
|
+
"/v1beta/api-keys": {
|
|
1447
|
+
"get": {
|
|
1448
|
+
"description": "Lists API keys for an organization.",
|
|
1449
|
+
"operationId": "listApiKeys",
|
|
1450
|
+
"parameters": [
|
|
1451
|
+
{
|
|
1452
|
+
"description": "Organization ID to list keys for.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
1453
|
+
"in": "query",
|
|
1454
|
+
"name": "organization_id",
|
|
1455
|
+
"required": true,
|
|
1456
|
+
"schema": {
|
|
1457
|
+
"description": "Organization ID to list keys for.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
1458
|
+
"pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1459
|
+
"title": "organization_id",
|
|
1460
|
+
"type": "string"
|
|
1461
|
+
}
|
|
1462
|
+
},
|
|
1463
|
+
{
|
|
1464
|
+
"description": "Whether to include revoked keys in the response.\n Default: false (only active and expired-but-not-revoked keys are returned).\n When true, all keys including revoked ones are returned.\n Note: Expired keys are always included unless also revoked; use is_active to filter.",
|
|
1465
|
+
"in": "query",
|
|
1466
|
+
"name": "include_revoked",
|
|
1467
|
+
"schema": {
|
|
1468
|
+
"description": "Whether to include revoked keys in the response.\n Default: false (only active and expired-but-not-revoked keys are returned).\n When true, all keys including revoked ones are returned.\n Note: Expired keys are always included unless also revoked; use is_active to filter.",
|
|
1469
|
+
"title": "include_revoked",
|
|
1470
|
+
"type": "boolean"
|
|
1471
|
+
}
|
|
1472
|
+
},
|
|
1473
|
+
{
|
|
1474
|
+
"description": "Opaque pagination token from a previous response.",
|
|
1475
|
+
"in": "query",
|
|
1476
|
+
"name": "page_token",
|
|
1477
|
+
"schema": {
|
|
1478
|
+
"description": "Opaque pagination token from a previous response.",
|
|
1479
|
+
"title": "page_token",
|
|
1480
|
+
"type": "string"
|
|
1481
|
+
}
|
|
1482
|
+
},
|
|
1483
|
+
{
|
|
1484
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
1485
|
+
"in": "query",
|
|
1486
|
+
"name": "page_size",
|
|
1487
|
+
"schema": {
|
|
1488
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
1489
|
+
"format": "int32",
|
|
1490
|
+
"maximum": 100,
|
|
1491
|
+
"minimum": 1,
|
|
1492
|
+
"title": "page_size",
|
|
1493
|
+
"type": "integer"
|
|
1494
|
+
}
|
|
1495
|
+
}
|
|
1496
|
+
],
|
|
1497
|
+
"responses": {
|
|
1498
|
+
"200": {
|
|
1499
|
+
"content": {
|
|
1500
|
+
"application/json": {
|
|
1501
|
+
"schema": {
|
|
1502
|
+
"$ref": "#/components/schemas/ListApiKeysResponse"
|
|
1503
|
+
}
|
|
1504
|
+
}
|
|
1505
|
+
},
|
|
1506
|
+
"description": "Success"
|
|
1507
|
+
},
|
|
1508
|
+
"400": {
|
|
1509
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1510
|
+
},
|
|
1511
|
+
"401": {
|
|
1512
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1513
|
+
},
|
|
1514
|
+
"403": {
|
|
1515
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1516
|
+
},
|
|
1517
|
+
"404": {
|
|
1518
|
+
"$ref": "#/components/responses/NotFound"
|
|
1519
|
+
},
|
|
1520
|
+
"429": {
|
|
1521
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1522
|
+
},
|
|
1523
|
+
"500": {
|
|
1524
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1525
|
+
}
|
|
1526
|
+
},
|
|
1527
|
+
"summary": "List API keys",
|
|
1528
|
+
"tags": [
|
|
1529
|
+
"API Keys"
|
|
1530
|
+
],
|
|
1531
|
+
"x-codeSamples": [
|
|
1532
|
+
{
|
|
1533
|
+
"lang": "typescript",
|
|
1534
|
+
"label": "listApiKeys",
|
|
1535
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.apiKeys.listApiKeys({\n organizationId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1536
|
+
}
|
|
1537
|
+
]
|
|
1538
|
+
},
|
|
1539
|
+
"post": {
|
|
1540
|
+
"description": "Creates a new API key for the specified organization. The secret is only returned once in the response and cannot be retrieved later.",
|
|
1541
|
+
"operationId": "createApiKey",
|
|
1542
|
+
"requestBody": {
|
|
1543
|
+
"content": {
|
|
1544
|
+
"application/json": {
|
|
1545
|
+
"schema": {
|
|
1546
|
+
"$ref": "#/components/schemas/CreateApiKeyRequest"
|
|
1547
|
+
}
|
|
1548
|
+
}
|
|
1549
|
+
},
|
|
1550
|
+
"required": true
|
|
1551
|
+
},
|
|
1552
|
+
"responses": {
|
|
1553
|
+
"200": {
|
|
1554
|
+
"content": {
|
|
1555
|
+
"application/json": {
|
|
1556
|
+
"schema": {
|
|
1557
|
+
"$ref": "#/components/schemas/CreateApiKeyResponse"
|
|
1558
|
+
}
|
|
1559
|
+
}
|
|
1560
|
+
},
|
|
1561
|
+
"description": "Success"
|
|
1562
|
+
},
|
|
1563
|
+
"400": {
|
|
1564
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1565
|
+
},
|
|
1566
|
+
"401": {
|
|
1567
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1568
|
+
},
|
|
1569
|
+
"403": {
|
|
1570
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1571
|
+
},
|
|
1572
|
+
"404": {
|
|
1573
|
+
"$ref": "#/components/responses/NotFound"
|
|
1574
|
+
},
|
|
1575
|
+
"429": {
|
|
1576
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1577
|
+
},
|
|
1578
|
+
"500": {
|
|
1579
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1580
|
+
}
|
|
1581
|
+
},
|
|
1582
|
+
"summary": "Create an API key",
|
|
1583
|
+
"tags": [
|
|
1584
|
+
"API Keys"
|
|
1585
|
+
],
|
|
1586
|
+
"x-codeSamples": [
|
|
1587
|
+
{
|
|
1588
|
+
"lang": "typescript",
|
|
1589
|
+
"label": "createApiKey",
|
|
1590
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.apiKeys.createApiKey({\n name: \"\u003cvalue\u003e\",\n organizationId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1591
|
+
}
|
|
1592
|
+
]
|
|
1593
|
+
}
|
|
1594
|
+
},
|
|
1595
|
+
"/v1beta/api-keys/{api_key_id}/revoke": {
|
|
1596
|
+
"post": {
|
|
1597
|
+
"description": "Revokes an API key, immediately preventing it from being used for authentication.",
|
|
1598
|
+
"operationId": "revokeApiKey",
|
|
1599
|
+
"parameters": [
|
|
1600
|
+
{
|
|
1601
|
+
"description": "API key ID to revoke.\n Pattern: key_[0-9a-hjkmnp-tv-z]{26}",
|
|
1602
|
+
"in": "path",
|
|
1603
|
+
"name": "api_key_id",
|
|
1604
|
+
"required": true,
|
|
1605
|
+
"schema": {
|
|
1606
|
+
"description": "API key ID to revoke.\n Pattern: key_[0-9a-hjkmnp-tv-z]{26}",
|
|
1607
|
+
"pattern": "^key_[0-9a-hjkmnp-tv-z]{26}$",
|
|
1608
|
+
"title": "api_key_id",
|
|
1609
|
+
"type": "string"
|
|
1610
|
+
}
|
|
1611
|
+
}
|
|
1612
|
+
],
|
|
1613
|
+
"requestBody": {
|
|
1614
|
+
"content": {
|
|
1615
|
+
"application/json": {
|
|
1616
|
+
"schema": {
|
|
1617
|
+
"additionalProperties": false,
|
|
1618
|
+
"description": "RevokeApiKeyRequest identifies an API key to revoke.",
|
|
1619
|
+
"properties": {
|
|
1620
|
+
"reason": {
|
|
1621
|
+
"description": "Optional reason for revocation (for audit purposes).\n The revoking user's identity and timestamp are captured in audit logs separately.",
|
|
1622
|
+
"maxLength": 500,
|
|
1623
|
+
"minLength": 1,
|
|
1624
|
+
"nullable": true,
|
|
1625
|
+
"title": "reason",
|
|
1626
|
+
"type": "string"
|
|
1627
|
+
}
|
|
1628
|
+
},
|
|
1629
|
+
"required": [],
|
|
1630
|
+
"title": "RevokeApiKeyRequest",
|
|
1631
|
+
"type": "object"
|
|
1632
|
+
}
|
|
1633
|
+
}
|
|
1634
|
+
},
|
|
1635
|
+
"required": true
|
|
1636
|
+
},
|
|
1637
|
+
"responses": {
|
|
1638
|
+
"200": {
|
|
1639
|
+
"content": {
|
|
1640
|
+
"application/json": {
|
|
1641
|
+
"schema": {
|
|
1642
|
+
"$ref": "#/components/schemas/RevokeApiKeyResponse"
|
|
1643
|
+
}
|
|
1644
|
+
}
|
|
1645
|
+
},
|
|
1646
|
+
"description": "Success"
|
|
1647
|
+
},
|
|
1648
|
+
"400": {
|
|
1649
|
+
"$ref": "#/components/responses/BadRequest"
|
|
1650
|
+
},
|
|
1651
|
+
"401": {
|
|
1652
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1653
|
+
},
|
|
1654
|
+
"403": {
|
|
1655
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1656
|
+
},
|
|
1657
|
+
"404": {
|
|
1658
|
+
"$ref": "#/components/responses/NotFound"
|
|
1659
|
+
},
|
|
1660
|
+
"429": {
|
|
1661
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
1662
|
+
},
|
|
1663
|
+
"500": {
|
|
1664
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1665
|
+
}
|
|
1666
|
+
},
|
|
1667
|
+
"summary": "Revoke an API key",
|
|
1668
|
+
"tags": [
|
|
1669
|
+
"API Keys"
|
|
1670
|
+
],
|
|
1671
|
+
"x-codeSamples": [
|
|
1672
|
+
{
|
|
1673
|
+
"lang": "typescript",
|
|
1674
|
+
"label": "revokeApiKey",
|
|
1675
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.apiKeys.revokeApiKey({\n apiKeyId: \"\u003cid\u003e\",\n body: {},\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1676
|
+
}
|
|
1677
|
+
]
|
|
1678
|
+
}
|
|
1679
|
+
},
|
|
1680
|
+
"/v1beta/documents": {
|
|
1060
1681
|
"get": {
|
|
1061
1682
|
"description": "List documents with cursor-based pagination.",
|
|
1062
1683
|
"operationId": "listDocuments",
|
|
@@ -1203,21 +1824,6 @@
|
|
|
1203
1824
|
"lang": "typescript",
|
|
1204
1825
|
"label": "listDocuments",
|
|
1205
1826
|
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.documents.list({\n pageToken: \"eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
|
|
1206
|
-
},
|
|
1207
|
-
{
|
|
1208
|
-
"lang": "python",
|
|
1209
|
-
"label": "listDocuments",
|
|
1210
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.documents.list(page_token=\"eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0\")\n\n while res is not None:\n # Handle items\n\n res = res.next()"
|
|
1211
|
-
},
|
|
1212
|
-
{
|
|
1213
|
-
"lang": "go",
|
|
1214
|
-
"label": "listDocuments",
|
|
1215
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"undefined/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Documents.List(ctx, operations.ListDocumentsRequest{\n PageToken: undefined.Pointer(\"eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0\"),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.ListDocumentsResponse != nil {\n for {\n // handle items\n\n res, err = res.Next()\n\n if err != nil {\n // handle error\n }\n\n if res == nil {\n break\n }\n }\n }\n}"
|
|
1216
|
-
},
|
|
1217
|
-
{
|
|
1218
|
-
"lang": "java",
|
|
1219
|
-
"label": "listDocuments",
|
|
1220
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.ListDocumentsRequest;\nimport org.openapis.openapi.models.operations.ListDocumentsResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n ListDocumentsRequest req = ListDocumentsRequest.builder()\n .pageToken(\"eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0\")\n .build();\n\n\n sdk.documents().list()\n .callAsStream()\n .forEach((ListDocumentsResponse item) -\u003e {\n // handle page\n });\n\n }\n}"
|
|
1221
1827
|
}
|
|
1222
1828
|
]
|
|
1223
1829
|
},
|
|
@@ -1274,21 +1880,6 @@
|
|
|
1274
1880
|
"lang": "typescript",
|
|
1275
1881
|
"label": "createDocument",
|
|
1276
1882
|
"source": "import { Factify } from \"@factify/sdk\";\nimport { openAsBlob } from \"node:fs\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.documents.create({\n payload: await openAsBlob(\"example.file\"),\n title: \"\u003cvalue\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1277
|
-
},
|
|
1278
|
-
{
|
|
1279
|
-
"lang": "python",
|
|
1280
|
-
"label": "createDocument",
|
|
1281
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.documents.create(payload={\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n }, title=\"\u003cvalue\u003e\")\n\n # Handle response\n print(res)"
|
|
1282
|
-
},
|
|
1283
|
-
{
|
|
1284
|
-
"lang": "go",
|
|
1285
|
-
"label": "createDocument",
|
|
1286
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"os\"\n\t\"undefined/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n example, fileErr := os.Open(\"example.file\")\n if fileErr != nil {\n panic(fileErr)\n }\n\n res, err := s.Documents.Create(ctx, components.CreateDocumentRequest{\n Payload: components.CreateDocumentRequestPayload{\n FileName: \"example.file\",\n Content: example,\n },\n Title: \"\u003cvalue\u003e\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.CreateDocumentResponse != nil {\n // handle response\n }\n}"
|
|
1287
|
-
},
|
|
1288
|
-
{
|
|
1289
|
-
"lang": "java",
|
|
1290
|
-
"label": "createDocument",
|
|
1291
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport java.nio.file.Paths;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.components.CreateDocumentRequest;\nimport org.openapis.openapi.models.components.CreateDocumentRequestPayload;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.CreateDocumentResponse;\nimport org.openapis.openapi.utils.Blob;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n CreateDocumentRequest req = CreateDocumentRequest.builder()\n .payload(CreateDocumentRequestPayload.builder()\n .fileName(\"example.file\")\n .content(Blob.from(Paths.get(\"example.file\")))\n .build())\n .title(\"\u003cvalue\u003e\")\n .build();\n\n CreateDocumentResponse res = sdk.documents().create()\n .request(req)\n .call();\n\n }\n}"
|
|
1292
1883
|
}
|
|
1293
1884
|
]
|
|
1294
1885
|
}
|
|
@@ -1351,21 +1942,6 @@
|
|
|
1351
1942
|
"lang": "typescript",
|
|
1352
1943
|
"label": "getDocument",
|
|
1353
1944
|
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.documents.get({\n documentId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1354
|
-
},
|
|
1355
|
-
{
|
|
1356
|
-
"lang": "python",
|
|
1357
|
-
"label": "getDocument",
|
|
1358
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.documents.get(document_id=\"\u003cid\u003e\")\n\n # Handle response\n print(res)"
|
|
1359
|
-
},
|
|
1360
|
-
{
|
|
1361
|
-
"lang": "go",
|
|
1362
|
-
"label": "getDocument",
|
|
1363
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Documents.Get(ctx, \"\u003cid\u003e\")\n if err != nil {\n log.Fatal(err)\n }\n if res.GetDocumentResponse != nil {\n // handle response\n }\n}"
|
|
1364
|
-
},
|
|
1365
|
-
{
|
|
1366
|
-
"lang": "java",
|
|
1367
|
-
"label": "getDocument",
|
|
1368
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.GetDocumentResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n GetDocumentResponse res = sdk.documents().get()\n .documentId(\"\u003cid\u003e\")\n .call();\n\n if (res.getDocumentResponse().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1369
1945
|
}
|
|
1370
1946
|
]
|
|
1371
1947
|
},
|
|
@@ -1456,21 +2032,6 @@
|
|
|
1456
2032
|
"lang": "typescript",
|
|
1457
2033
|
"label": "updateDocument",
|
|
1458
2034
|
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.documents.update({\n documentId: \"\u003cid\u003e\",\n body: {},\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1459
|
-
},
|
|
1460
|
-
{
|
|
1461
|
-
"lang": "python",
|
|
1462
|
-
"label": "updateDocument",
|
|
1463
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.documents.update(document_id=\"\u003cid\u003e\")\n\n # Handle response\n print(res)"
|
|
1464
|
-
},
|
|
1465
|
-
{
|
|
1466
|
-
"lang": "go",
|
|
1467
|
-
"label": "updateDocument",
|
|
1468
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"undefined/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Documents.Update(ctx, \"\u003cid\u003e\", operations.UpdateDocumentUpdateDocumentRequest{})\n if err != nil {\n log.Fatal(err)\n }\n if res.UpdateDocumentResponse != nil {\n // handle response\n }\n}"
|
|
1469
|
-
},
|
|
1470
|
-
{
|
|
1471
|
-
"lang": "java",
|
|
1472
|
-
"label": "updateDocument",
|
|
1473
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.UpdateDocumentResponse;\nimport org.openapis.openapi.models.operations.UpdateDocumentUpdateDocumentRequest;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n UpdateDocumentResponse res = sdk.documents().update()\n .documentId(\"\u003cid\u003e\")\n .body(UpdateDocumentUpdateDocumentRequest.builder()\n .build())\n .call();\n\n if (res.updateDocumentResponse().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1474
2035
|
}
|
|
1475
2036
|
]
|
|
1476
2037
|
}
|
|
@@ -1525,7 +2086,7 @@
|
|
|
1525
2086
|
},
|
|
1526
2087
|
"summary": "Generate entry page",
|
|
1527
2088
|
"tags": [
|
|
1528
|
-
"
|
|
2089
|
+
"Sharing \u0026 Distribution"
|
|
1529
2090
|
],
|
|
1530
2091
|
"x-speakeasy-group": "entryPages",
|
|
1531
2092
|
"x-speakeasy-name-override": "generate",
|
|
@@ -1534,21 +2095,6 @@
|
|
|
1534
2095
|
"lang": "typescript",
|
|
1535
2096
|
"label": "generateDocumentEntryPage",
|
|
1536
2097
|
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.entryPages.generate({\n documentId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1537
|
-
},
|
|
1538
|
-
{
|
|
1539
|
-
"lang": "python",
|
|
1540
|
-
"label": "generateDocumentEntryPage",
|
|
1541
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.entry_pages.generate(document_id=\"\u003cid\u003e\")\n\n # Handle response\n print(res)"
|
|
1542
|
-
},
|
|
1543
|
-
{
|
|
1544
|
-
"lang": "go",
|
|
1545
|
-
"label": "generateDocumentEntryPage",
|
|
1546
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.EntryPages.Generate(ctx, \"\u003cid\u003e\")\n if err != nil {\n log.Fatal(err)\n }\n if res.GenerateEntryPageResponse != nil {\n // handle response\n }\n}"
|
|
1547
|
-
},
|
|
1548
|
-
{
|
|
1549
|
-
"lang": "java",
|
|
1550
|
-
"label": "generateDocumentEntryPage",
|
|
1551
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.GenerateDocumentEntryPageResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n GenerateDocumentEntryPageResponse res = sdk.entryPages().generate()\n .documentId(\"\u003cid\u003e\")\n .call();\n\n if (res.generateEntryPageResponse().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1552
2098
|
}
|
|
1553
2099
|
]
|
|
1554
2100
|
}
|
|
@@ -1648,21 +2194,6 @@
|
|
|
1648
2194
|
"lang": "typescript",
|
|
1649
2195
|
"label": "listDocumentPolicies",
|
|
1650
2196
|
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.policies.list({\n documentId: \"\u003cid\u003e\",\n pageToken: \"eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
|
|
1651
|
-
},
|
|
1652
|
-
{
|
|
1653
|
-
"lang": "python",
|
|
1654
|
-
"label": "listDocumentPolicies",
|
|
1655
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.policies.list(document_id=\"\u003cid\u003e\", page_token=\"eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\")\n\n while res is not None:\n # Handle items\n\n res = res.next()"
|
|
1656
|
-
},
|
|
1657
|
-
{
|
|
1658
|
-
"lang": "go",
|
|
1659
|
-
"label": "listDocumentPolicies",
|
|
1660
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Policies.List(ctx, \"\u003cid\u003e\", undefined.Pointer(\"eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\"), nil)\n if err != nil {\n log.Fatal(err)\n }\n if res.ListDocumentPoliciesResponse != nil {\n for {\n // handle items\n\n res, err = res.Next()\n\n if err != nil {\n // handle error\n }\n\n if res == nil {\n break\n }\n }\n }\n}"
|
|
1661
|
-
},
|
|
1662
|
-
{
|
|
1663
|
-
"lang": "java",
|
|
1664
|
-
"label": "listDocumentPolicies",
|
|
1665
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.ListDocumentPoliciesResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n\n sdk.policies().list()\n .documentId(\"\u003cid\u003e\")\n .pageToken(\"eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\")\n .callAsStream()\n .forEach((ListDocumentPoliciesResponse item) -\u003e {\n // handle page\n });\n\n }\n}"
|
|
1666
2197
|
}
|
|
1667
2198
|
]
|
|
1668
2199
|
},
|
|
@@ -1747,21 +2278,6 @@
|
|
|
1747
2278
|
"lang": "typescript",
|
|
1748
2279
|
"label": "attachDocumentPolicy",
|
|
1749
2280
|
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.policies.attach({\n documentId: \"\u003cid\u003e\",\n body: {\n policyId: \"\u003cid\u003e\",\n },\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1750
|
-
},
|
|
1751
|
-
{
|
|
1752
|
-
"lang": "python",
|
|
1753
|
-
"label": "attachDocumentPolicy",
|
|
1754
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.policies.attach(document_id=\"\u003cid\u003e\", policy_id=\"\u003cid\u003e\")\n\n # Handle response\n print(res)"
|
|
1755
|
-
},
|
|
1756
|
-
{
|
|
1757
|
-
"lang": "go",
|
|
1758
|
-
"label": "attachDocumentPolicy",
|
|
1759
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"undefined/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Policies.Attach(ctx, \"\u003cid\u003e\", operations.AttachPolicyRequest{\n PolicyID: \"\u003cid\u003e\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.DocumentPolicy != nil {\n // handle response\n }\n}"
|
|
1760
|
-
},
|
|
1761
|
-
{
|
|
1762
|
-
"lang": "java",
|
|
1763
|
-
"label": "attachDocumentPolicy",
|
|
1764
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.AttachDocumentPolicyResponse;\nimport org.openapis.openapi.models.operations.AttachPolicyRequest;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n AttachDocumentPolicyResponse res = sdk.policies().attach()\n .documentId(\"\u003cid\u003e\")\n .body(AttachPolicyRequest.builder()\n .policyId(\"\u003cid\u003e\")\n .build())\n .call();\n\n if (res.documentPolicy().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1765
2281
|
}
|
|
1766
2282
|
]
|
|
1767
2283
|
}
|
|
@@ -1836,21 +2352,6 @@
|
|
|
1836
2352
|
"lang": "typescript",
|
|
1837
2353
|
"label": "detachDocumentPolicy",
|
|
1838
2354
|
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.policies.detach({\n documentId: \"\u003cid\u003e\",\n policyId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
1839
|
-
},
|
|
1840
|
-
{
|
|
1841
|
-
"lang": "python",
|
|
1842
|
-
"label": "detachDocumentPolicy",
|
|
1843
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.policies.detach(document_id=\"\u003cid\u003e\", policy_id=\"\u003cid\u003e\")\n\n # Handle response\n print(res)"
|
|
1844
|
-
},
|
|
1845
|
-
{
|
|
1846
|
-
"lang": "go",
|
|
1847
|
-
"label": "detachDocumentPolicy",
|
|
1848
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Policies.Detach(ctx, \"\u003cid\u003e\", \"\u003cid\u003e\")\n if err != nil {\n log.Fatal(err)\n }\n if res.Empty != nil {\n // handle response\n }\n}"
|
|
1849
|
-
},
|
|
1850
|
-
{
|
|
1851
|
-
"lang": "java",
|
|
1852
|
-
"label": "detachDocumentPolicy",
|
|
1853
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.DetachDocumentPolicyResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n DetachDocumentPolicyResponse res = sdk.policies().detach()\n .documentId(\"\u003cid\u003e\")\n .policyId(\"\u003cid\u003e\")\n .call();\n\n if (res.empty().isPresent()) {\n // handle response\n }\n }\n}"
|
|
1854
2355
|
}
|
|
1855
2356
|
]
|
|
1856
2357
|
}
|
|
@@ -1950,21 +2451,6 @@
|
|
|
1950
2451
|
"lang": "typescript",
|
|
1951
2452
|
"label": "listDocumentVersions",
|
|
1952
2453
|
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.list({\n documentId: \"\u003cid\u003e\",\n pageToken: \"eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
|
|
1953
|
-
},
|
|
1954
|
-
{
|
|
1955
|
-
"lang": "python",
|
|
1956
|
-
"label": "listDocumentVersions",
|
|
1957
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.versions.list(document_id=\"\u003cid\u003e\", page_token=\"eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\")\n\n while res is not None:\n # Handle items\n\n res = res.next()"
|
|
1958
|
-
},
|
|
1959
|
-
{
|
|
1960
|
-
"lang": "go",
|
|
1961
|
-
"label": "listDocumentVersions",
|
|
1962
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Versions.List(ctx, \"\u003cid\u003e\", undefined.Pointer(\"eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\"), nil)\n if err != nil {\n log.Fatal(err)\n }\n if res.ListVersionsResponse != nil {\n for {\n // handle items\n\n res, err = res.Next()\n\n if err != nil {\n // handle error\n }\n\n if res == nil {\n break\n }\n }\n }\n}"
|
|
1963
|
-
},
|
|
1964
|
-
{
|
|
1965
|
-
"lang": "java",
|
|
1966
|
-
"label": "listDocumentVersions",
|
|
1967
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.ListDocumentVersionsResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n\n sdk.versions().list()\n .documentId(\"\u003cid\u003e\")\n .pageToken(\"eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\")\n .callAsStream()\n .forEach((ListDocumentVersionsResponse item) -\u003e {\n // handle page\n });\n\n }\n}"
|
|
1968
2454
|
}
|
|
1969
2455
|
]
|
|
1970
2456
|
},
|
|
@@ -2035,49 +2521,210 @@
|
|
|
2035
2521
|
"lang": "typescript",
|
|
2036
2522
|
"label": "createDocumentVersion",
|
|
2037
2523
|
"source": "import { Factify } from \"@factify/sdk\";\nimport { openAsBlob } from \"node:fs\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.create({\n documentId: \"\u003cid\u003e\",\n body: {\n payload: await openAsBlob(\"example.file\"),\n },\n });\n\n console.log(result);\n}\n\nrun();"
|
|
2524
|
+
}
|
|
2525
|
+
]
|
|
2526
|
+
}
|
|
2527
|
+
},
|
|
2528
|
+
"/v1beta/organizations": {
|
|
2529
|
+
"get": {
|
|
2530
|
+
"description": "List organizations the caller has access to.",
|
|
2531
|
+
"operationId": "listOrganizations",
|
|
2532
|
+
"parameters": [
|
|
2533
|
+
{
|
|
2534
|
+
"description": "Opaque pagination token from a previous response.",
|
|
2535
|
+
"in": "query",
|
|
2536
|
+
"name": "page_token",
|
|
2537
|
+
"schema": {
|
|
2538
|
+
"description": "Opaque pagination token from a previous response.",
|
|
2539
|
+
"title": "page_token",
|
|
2540
|
+
"type": "string"
|
|
2541
|
+
}
|
|
2038
2542
|
},
|
|
2039
2543
|
{
|
|
2040
|
-
"
|
|
2041
|
-
"
|
|
2042
|
-
"
|
|
2544
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
2545
|
+
"in": "query",
|
|
2546
|
+
"name": "page_size",
|
|
2547
|
+
"schema": {
|
|
2548
|
+
"description": "Maximum number of items to return per page (1-100). Default: 50.",
|
|
2549
|
+
"format": "int32",
|
|
2550
|
+
"maximum": 100,
|
|
2551
|
+
"minimum": 1,
|
|
2552
|
+
"title": "page_size",
|
|
2553
|
+
"type": "integer"
|
|
2554
|
+
}
|
|
2555
|
+
}
|
|
2556
|
+
],
|
|
2557
|
+
"responses": {
|
|
2558
|
+
"200": {
|
|
2559
|
+
"content": {
|
|
2560
|
+
"application/json": {
|
|
2561
|
+
"schema": {
|
|
2562
|
+
"$ref": "#/components/schemas/ListOrganizationsResponse"
|
|
2563
|
+
}
|
|
2564
|
+
}
|
|
2565
|
+
},
|
|
2566
|
+
"description": "Success"
|
|
2567
|
+
},
|
|
2568
|
+
"400": {
|
|
2569
|
+
"$ref": "#/components/responses/BadRequest"
|
|
2570
|
+
},
|
|
2571
|
+
"401": {
|
|
2572
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2573
|
+
},
|
|
2574
|
+
"403": {
|
|
2575
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2576
|
+
},
|
|
2577
|
+
"404": {
|
|
2578
|
+
"$ref": "#/components/responses/NotFound"
|
|
2579
|
+
},
|
|
2580
|
+
"429": {
|
|
2581
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
2043
2582
|
},
|
|
2583
|
+
"500": {
|
|
2584
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2585
|
+
}
|
|
2586
|
+
},
|
|
2587
|
+
"summary": "List organizations",
|
|
2588
|
+
"tags": [
|
|
2589
|
+
"Organizations"
|
|
2590
|
+
],
|
|
2591
|
+
"x-codeSamples": [
|
|
2044
2592
|
{
|
|
2045
|
-
"lang": "
|
|
2046
|
-
"label": "
|
|
2047
|
-
"source": "
|
|
2593
|
+
"lang": "typescript",
|
|
2594
|
+
"label": "listOrganizations",
|
|
2595
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.organizations.listOrganizations();\n\n console.log(result);\n}\n\nrun();"
|
|
2596
|
+
}
|
|
2597
|
+
]
|
|
2598
|
+
},
|
|
2599
|
+
"post": {
|
|
2600
|
+
"description": "Creates a new organization. The authenticated user becomes the organization owner.",
|
|
2601
|
+
"operationId": "createOrganization",
|
|
2602
|
+
"requestBody": {
|
|
2603
|
+
"content": {
|
|
2604
|
+
"application/json": {
|
|
2605
|
+
"schema": {
|
|
2606
|
+
"$ref": "#/components/schemas/CreateOrganizationRequest"
|
|
2607
|
+
}
|
|
2608
|
+
}
|
|
2609
|
+
},
|
|
2610
|
+
"required": true
|
|
2611
|
+
},
|
|
2612
|
+
"responses": {
|
|
2613
|
+
"200": {
|
|
2614
|
+
"content": {
|
|
2615
|
+
"application/json": {
|
|
2616
|
+
"schema": {
|
|
2617
|
+
"$ref": "#/components/schemas/CreateOrganizationResponse"
|
|
2618
|
+
}
|
|
2619
|
+
}
|
|
2620
|
+
},
|
|
2621
|
+
"description": "Success"
|
|
2048
2622
|
},
|
|
2623
|
+
"400": {
|
|
2624
|
+
"$ref": "#/components/responses/BadRequest"
|
|
2625
|
+
},
|
|
2626
|
+
"401": {
|
|
2627
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2628
|
+
},
|
|
2629
|
+
"403": {
|
|
2630
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2631
|
+
},
|
|
2632
|
+
"404": {
|
|
2633
|
+
"$ref": "#/components/responses/NotFound"
|
|
2634
|
+
},
|
|
2635
|
+
"429": {
|
|
2636
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
2637
|
+
},
|
|
2638
|
+
"500": {
|
|
2639
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2640
|
+
}
|
|
2641
|
+
},
|
|
2642
|
+
"summary": "Create an organization",
|
|
2643
|
+
"tags": [
|
|
2644
|
+
"Organizations"
|
|
2645
|
+
],
|
|
2646
|
+
"x-codeSamples": [
|
|
2049
2647
|
{
|
|
2050
|
-
"lang": "
|
|
2051
|
-
"label": "
|
|
2052
|
-
"source": "
|
|
2648
|
+
"lang": "typescript",
|
|
2649
|
+
"label": "createOrganization",
|
|
2650
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.organizations.createOrganization({\n name: \"\u003cvalue\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
2053
2651
|
}
|
|
2054
2652
|
]
|
|
2055
2653
|
}
|
|
2056
2654
|
},
|
|
2057
|
-
"/v1beta/
|
|
2655
|
+
"/v1beta/organizations/{organization_id}": {
|
|
2058
2656
|
"get": {
|
|
2059
|
-
"description": "Retrieve
|
|
2060
|
-
"operationId": "
|
|
2657
|
+
"description": "Retrieve an organization by ID.",
|
|
2658
|
+
"operationId": "getOrganization",
|
|
2061
2659
|
"parameters": [
|
|
2062
2660
|
{
|
|
2063
|
-
"description": "
|
|
2661
|
+
"description": "Organization ID.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
2064
2662
|
"in": "path",
|
|
2065
|
-
"name": "
|
|
2663
|
+
"name": "organization_id",
|
|
2066
2664
|
"required": true,
|
|
2067
2665
|
"schema": {
|
|
2068
|
-
"description": "
|
|
2069
|
-
"pattern": "^
|
|
2070
|
-
"title": "
|
|
2666
|
+
"description": "Organization ID.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
|
|
2667
|
+
"pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
|
|
2668
|
+
"title": "organization_id",
|
|
2071
2669
|
"type": "string"
|
|
2072
2670
|
}
|
|
2671
|
+
}
|
|
2672
|
+
],
|
|
2673
|
+
"responses": {
|
|
2674
|
+
"200": {
|
|
2675
|
+
"content": {
|
|
2676
|
+
"application/json": {
|
|
2677
|
+
"schema": {
|
|
2678
|
+
"$ref": "#/components/schemas/GetOrganizationResponse"
|
|
2679
|
+
}
|
|
2680
|
+
}
|
|
2681
|
+
},
|
|
2682
|
+
"description": "Success"
|
|
2683
|
+
},
|
|
2684
|
+
"400": {
|
|
2685
|
+
"$ref": "#/components/responses/BadRequest"
|
|
2686
|
+
},
|
|
2687
|
+
"401": {
|
|
2688
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2073
2689
|
},
|
|
2690
|
+
"403": {
|
|
2691
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2692
|
+
},
|
|
2693
|
+
"404": {
|
|
2694
|
+
"$ref": "#/components/responses/NotFound"
|
|
2695
|
+
},
|
|
2696
|
+
"429": {
|
|
2697
|
+
"$ref": "#/components/responses/RateLimitExceeded"
|
|
2698
|
+
},
|
|
2699
|
+
"500": {
|
|
2700
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2701
|
+
}
|
|
2702
|
+
},
|
|
2703
|
+
"summary": "Retrieve an organization",
|
|
2704
|
+
"tags": [
|
|
2705
|
+
"Organizations"
|
|
2706
|
+
],
|
|
2707
|
+
"x-codeSamples": [
|
|
2074
2708
|
{
|
|
2075
|
-
"
|
|
2709
|
+
"lang": "typescript",
|
|
2710
|
+
"label": "getOrganization",
|
|
2711
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.organizations.getOrganization({\n organizationId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
2712
|
+
}
|
|
2713
|
+
]
|
|
2714
|
+
}
|
|
2715
|
+
},
|
|
2716
|
+
"/v1beta/versions/{version_id}": {
|
|
2717
|
+
"get": {
|
|
2718
|
+
"description": "Retrieve a specific version by ID.",
|
|
2719
|
+
"operationId": "getVersion",
|
|
2720
|
+
"parameters": [
|
|
2721
|
+
{
|
|
2722
|
+
"description": "Version ID to retrieve.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
2076
2723
|
"in": "path",
|
|
2077
2724
|
"name": "version_id",
|
|
2078
2725
|
"required": true,
|
|
2079
2726
|
"schema": {
|
|
2080
|
-
"description": "Version ID.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
2727
|
+
"description": "Version ID to retrieve.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
2081
2728
|
"pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
|
|
2082
2729
|
"title": "version_id",
|
|
2083
2730
|
"type": "string"
|
|
@@ -2118,46 +2765,18 @@
|
|
|
2118
2765
|
"tags": [
|
|
2119
2766
|
"Versions"
|
|
2120
2767
|
],
|
|
2121
|
-
"x-speakeasy-name-override": "get",
|
|
2122
2768
|
"x-codeSamples": [
|
|
2123
2769
|
{
|
|
2124
2770
|
"lang": "typescript",
|
|
2125
|
-
"label": "
|
|
2126
|
-
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.
|
|
2127
|
-
},
|
|
2128
|
-
{
|
|
2129
|
-
"lang": "python",
|
|
2130
|
-
"label": "getDocumentVersion",
|
|
2131
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.versions.get(document_id=\"\u003cid\u003e\", version_id=\"\u003cid\u003e\")\n\n # Handle response\n print(res)"
|
|
2132
|
-
},
|
|
2133
|
-
{
|
|
2134
|
-
"lang": "go",
|
|
2135
|
-
"label": "getDocumentVersion",
|
|
2136
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Versions.Get(ctx, \"\u003cid\u003e\", \"\u003cid\u003e\")\n if err != nil {\n log.Fatal(err)\n }\n if res.Version != nil {\n // handle response\n }\n}"
|
|
2137
|
-
},
|
|
2138
|
-
{
|
|
2139
|
-
"lang": "java",
|
|
2140
|
-
"label": "getDocumentVersion",
|
|
2141
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.GetDocumentVersionResponse;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n GetDocumentVersionResponse res = sdk.versions().get()\n .documentId(\"\u003cid\u003e\")\n .versionId(\"\u003cid\u003e\")\n .call();\n\n if (res.version().isPresent()) {\n // handle response\n }\n }\n}"
|
|
2771
|
+
"label": "getVersion",
|
|
2772
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.getVersion({\n versionId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
|
|
2142
2773
|
}
|
|
2143
2774
|
]
|
|
2144
2775
|
},
|
|
2145
2776
|
"patch": {
|
|
2146
2777
|
"description": "Update version title and description.",
|
|
2147
|
-
"operationId": "
|
|
2778
|
+
"operationId": "updateVersion",
|
|
2148
2779
|
"parameters": [
|
|
2149
|
-
{
|
|
2150
|
-
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
2151
|
-
"in": "path",
|
|
2152
|
-
"name": "document_id",
|
|
2153
|
-
"required": true,
|
|
2154
|
-
"schema": {
|
|
2155
|
-
"description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
|
|
2156
|
-
"pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
|
|
2157
|
-
"title": "document_id",
|
|
2158
|
-
"type": "string"
|
|
2159
|
-
}
|
|
2160
|
-
},
|
|
2161
2780
|
{
|
|
2162
2781
|
"description": "Version ID to update.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
|
|
2163
2782
|
"in": "path",
|
|
@@ -2233,27 +2852,11 @@
|
|
|
2233
2852
|
"tags": [
|
|
2234
2853
|
"Versions"
|
|
2235
2854
|
],
|
|
2236
|
-
"x-speakeasy-name-override": "update",
|
|
2237
2855
|
"x-codeSamples": [
|
|
2238
2856
|
{
|
|
2239
2857
|
"lang": "typescript",
|
|
2240
|
-
"label": "
|
|
2241
|
-
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.
|
|
2242
|
-
},
|
|
2243
|
-
{
|
|
2244
|
-
"lang": "python",
|
|
2245
|
-
"label": "updateDocumentVersion",
|
|
2246
|
-
"source": "from openapi import Factify\n\n\nwith Factify(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n) as factify:\n\n res = factify.versions.update(document_id=\"\u003cid\u003e\", version_id=\"\u003cid\u003e\")\n\n # Handle response\n print(res)"
|
|
2247
|
-
},
|
|
2248
|
-
{
|
|
2249
|
-
"lang": "go",
|
|
2250
|
-
"label": "updateDocumentVersion",
|
|
2251
|
-
"source": "package main\n\nimport(\n\t\"context\"\n\t\"undefined\"\n\t\"undefined/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := undefined.New(\n undefined.WithSecurity(\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\"),\n )\n\n res, err := s.Versions.Update(ctx, \"\u003cid\u003e\", \"\u003cid\u003e\", operations.UpdateVersionRequest{})\n if err != nil {\n log.Fatal(err)\n }\n if res.Version != nil {\n // handle response\n }\n}"
|
|
2252
|
-
},
|
|
2253
|
-
{
|
|
2254
|
-
"lang": "java",
|
|
2255
|
-
"label": "updateDocumentVersion",
|
|
2256
|
-
"source": "package hello.world;\n\nimport java.lang.Exception;\nimport org.openapis.openapi.Factify;\nimport org.openapis.openapi.models.errors.Error;\nimport org.openapis.openapi.models.operations.UpdateDocumentVersionResponse;\nimport org.openapis.openapi.models.operations.UpdateVersionRequest;\n\npublic class Application {\n\n public static void main(String[] args) throws Error, Exception {\n\n Factify sdk = Factify.builder()\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n UpdateDocumentVersionResponse res = sdk.versions().update()\n .documentId(\"\u003cid\u003e\")\n .versionId(\"\u003cid\u003e\")\n .body(UpdateVersionRequest.builder()\n .build())\n .call();\n\n if (res.version().isPresent()) {\n // handle response\n }\n }\n}"
|
|
2858
|
+
"label": "updateVersion",
|
|
2859
|
+
"source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.updateVersion({\n versionId: \"\u003cid\u003e\",\n body: {},\n });\n\n console.log(result);\n}\n\nrun();"
|
|
2257
2860
|
}
|
|
2258
2861
|
]
|
|
2259
2862
|
}
|
|
@@ -2283,13 +2886,21 @@
|
|
|
2283
2886
|
"description": "Manage document versions and version history.",
|
|
2284
2887
|
"name": "Versions"
|
|
2285
2888
|
},
|
|
2889
|
+
{
|
|
2890
|
+
"description": "Create and manage organizations.",
|
|
2891
|
+
"name": "Organizations"
|
|
2892
|
+
},
|
|
2893
|
+
{
|
|
2894
|
+
"description": "Generate and manage API keys for authentication.",
|
|
2895
|
+
"name": "API Keys"
|
|
2896
|
+
},
|
|
2286
2897
|
{
|
|
2287
2898
|
"description": "Attach and manage access policies for documents.",
|
|
2288
2899
|
"name": "Policies"
|
|
2289
2900
|
},
|
|
2290
2901
|
{
|
|
2291
2902
|
"description": "Generate shareable entry pages for documents.",
|
|
2292
|
-
"name": "
|
|
2903
|
+
"name": "Sharing \u0026 Distribution"
|
|
2293
2904
|
}
|
|
2294
2905
|
]
|
|
2295
2906
|
}
|