@cloudpdf/sdk 3.0.0-next.1 → 3.0.0-next.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -46
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +9 -4
- package/dist/cjs/CloudPDFClient.d.ts +20 -0
- package/dist/cjs/CloudPDFClient.js +39 -0
- package/dist/cjs/api/errors/ConflictError.d.ts +7 -0
- package/dist/cjs/api/errors/ConflictError.js +54 -0
- package/dist/cjs/api/errors/GoneError.d.ts +7 -0
- package/dist/cjs/api/errors/GoneError.js +54 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +7 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.js +54 -0
- package/dist/cjs/api/errors/index.d.ts +3 -0
- package/dist/cjs/api/errors/index.js +3 -0
- package/dist/cjs/api/resources/documents/client/Client.d.ts +14 -5
- package/dist/cjs/api/resources/documents/client/Client.js +26 -14
- package/dist/cjs/api/resources/documents/client/requests/DocumentsInitRequest.d.ts +7 -0
- package/dist/cjs/api/resources/documents/client/requests/DocumentsInitRequest.js +5 -0
- package/dist/cjs/api/resources/documents/client/requests/UploadProxyDocumentsRequest.d.ts +14 -0
- package/dist/cjs/api/resources/documents/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/shares/client/Client.d.ts +119 -0
- package/dist/cjs/api/resources/shares/client/Client.js +422 -0
- package/dist/cjs/api/resources/shares/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shares/client/index.js +17 -0
- package/dist/cjs/api/resources/shares/client/requests/DeleteSharesRequest.d.ts +11 -0
- package/dist/cjs/api/resources/shares/client/requests/GetSharesRequest.d.ts +11 -0
- package/dist/cjs/api/resources/shares/client/requests/GetSharesRequest.js +3 -0
- package/dist/cjs/api/resources/shares/client/requests/ListSharesRequest.d.ts +12 -0
- package/dist/cjs/api/resources/shares/client/requests/ListSharesRequest.js +3 -0
- package/dist/cjs/api/resources/shares/client/requests/SharesCreateRequest.d.ts +18 -0
- package/dist/cjs/api/resources/shares/client/requests/SharesCreateRequest.js +3 -0
- package/dist/cjs/api/resources/shares/client/requests/SharesExchangeRequest.d.ts +10 -0
- package/dist/cjs/api/resources/shares/client/requests/SharesExchangeRequest.js +3 -0
- package/dist/cjs/api/resources/shares/client/requests/SharesUpdateRequest.d.ts +17 -0
- package/dist/cjs/api/resources/shares/client/requests/SharesUpdateRequest.js +3 -0
- package/dist/cjs/api/resources/shares/client/requests/index.d.ts +6 -0
- package/dist/cjs/api/resources/shares/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shares/exports.d.ts +2 -0
- package/dist/cjs/api/resources/shares/exports.js +21 -0
- package/dist/cjs/api/resources/shares/index.d.ts +1 -0
- package/dist/cjs/api/resources/shares/index.js +17 -0
- package/dist/cjs/api/resources/tenants/client/Client.d.ts +50 -0
- package/dist/cjs/api/resources/tenants/client/Client.js +181 -0
- package/dist/cjs/api/resources/tenants/client/requests/ResumeTenantsRequest.d.ts +9 -0
- package/dist/cjs/api/resources/tenants/client/requests/ResumeTenantsRequest.js +3 -0
- package/dist/cjs/api/resources/tenants/client/requests/TenantsSuspendRequest.d.ts +10 -0
- package/dist/cjs/api/resources/tenants/client/requests/TenantsSuspendRequest.js +3 -0
- package/dist/cjs/api/resources/tenants/client/requests/UsageTenantsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/tenants/client/requests/UsageTenantsRequest.js +3 -0
- package/dist/cjs/api/resources/tenants/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/types/DocumentsInit200ResponseCreatedUpload.d.ts +3 -3
- package/dist/cjs/api/types/DocumentsInit200ResponseResumedUpload.d.ts +3 -3
- package/dist/cjs/api/types/DocumentsUploadProxy200Response.d.ts +3 -0
- package/dist/cjs/api/types/DocumentsUploadProxy200Response.js +3 -0
- package/dist/cjs/api/types/DocumentsUploadProxy400Response.d.ts +9 -0
- package/dist/cjs/api/types/DocumentsUploadProxy400Response.js +3 -0
- package/dist/cjs/api/types/DocumentsUploadProxy409Response.d.ts +9 -0
- package/dist/cjs/api/types/DocumentsUploadProxy409Response.js +3 -0
- package/dist/cjs/api/types/SharesCreate200Response.d.ts +22 -0
- package/dist/cjs/api/types/SharesCreate200Response.js +3 -0
- package/dist/cjs/api/types/SharesCreate400Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesCreate400Response.js +3 -0
- package/dist/cjs/api/types/SharesCreate403Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesCreate403Response.js +3 -0
- package/dist/cjs/api/types/SharesCreate404Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesCreate404Response.js +3 -0
- package/dist/cjs/api/types/SharesDeleteResponse.d.ts +9 -0
- package/dist/cjs/api/types/SharesDeleteResponse.js +3 -0
- package/dist/cjs/api/types/SharesExchange200Response.d.ts +6 -0
- package/dist/cjs/api/types/SharesExchange200Response.js +3 -0
- package/dist/cjs/api/types/SharesExchange400Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesExchange400Response.js +3 -0
- package/dist/cjs/api/types/SharesExchange403Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesExchange403Response.js +3 -0
- package/dist/cjs/api/types/SharesExchange404Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesExchange404Response.js +3 -0
- package/dist/cjs/api/types/SharesExchange410Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesExchange410Response.js +3 -0
- package/dist/cjs/api/types/SharesExchange422Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesExchange422Response.js +3 -0
- package/dist/cjs/api/types/SharesGet200Response.d.ts +22 -0
- package/dist/cjs/api/types/SharesGet200Response.js +3 -0
- package/dist/cjs/api/types/SharesGet404Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesGet404Response.js +3 -0
- package/dist/cjs/api/types/SharesList200Response.d.ts +26 -0
- package/dist/cjs/api/types/SharesList200Response.js +3 -0
- package/dist/cjs/api/types/SharesList400Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesList400Response.js +3 -0
- package/dist/cjs/api/types/SharesUpdate200Response.d.ts +22 -0
- package/dist/cjs/api/types/SharesUpdate200Response.js +3 -0
- package/dist/cjs/api/types/SharesUpdate400Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesUpdate400Response.js +3 -0
- package/dist/cjs/api/types/SharesUpdate404Response.d.ts +9 -0
- package/dist/cjs/api/types/SharesUpdate404Response.js +3 -0
- package/dist/cjs/api/types/TenantsCreate200Response.d.ts +8 -0
- package/dist/cjs/api/types/TenantsCreate200Response.js +11 -0
- package/dist/cjs/api/types/TenantsGet200Response.d.ts +8 -0
- package/dist/cjs/api/types/TenantsGet200Response.js +11 -0
- package/dist/cjs/api/types/TenantsList200Response.d.ts +8 -0
- package/dist/cjs/api/types/TenantsList200Response.js +14 -0
- package/dist/cjs/api/types/TenantsResumeResponse.d.ts +9 -0
- package/dist/cjs/api/types/TenantsResumeResponse.js +3 -0
- package/dist/cjs/api/types/TenantsSuspendResponse.d.ts +9 -0
- package/dist/cjs/api/types/TenantsSuspendResponse.js +3 -0
- package/dist/cjs/api/types/TenantsUsage200Response.d.ts +13 -0
- package/dist/cjs/api/types/TenantsUsage200Response.js +3 -0
- package/dist/cjs/api/types/TenantsUsage400Response.d.ts +9 -0
- package/dist/cjs/api/types/TenantsUsage400Response.js +3 -0
- package/dist/cjs/api/types/TenantsUsage404Response.d.ts +9 -0
- package/dist/cjs/api/types/TenantsUsage404Response.js +3 -0
- package/dist/cjs/api/types/TokensIssueRequest.d.ts +2 -1
- package/dist/cjs/api/types/index.d.ts +26 -2
- package/dist/cjs/api/types/index.js +26 -2
- package/dist/cjs/auth/BearerAuthProvider.d.ts +1 -1
- package/dist/cjs/core/form-data-utils/FormDataWrapper.d.ts +15 -0
- package/dist/cjs/core/form-data-utils/FormDataWrapper.js +188 -0
- package/dist/cjs/core/form-data-utils/encodeAsFormParameter.d.ts +1 -0
- package/dist/cjs/core/form-data-utils/encodeAsFormParameter.js +12 -0
- package/dist/cjs/core/form-data-utils/index.d.ts +2 -0
- package/dist/cjs/core/form-data-utils/index.js +20 -0
- package/dist/cjs/core/index.d.ts +1 -0
- package/dist/cjs/core/index.js +1 -0
- package/dist/cjs/index.d.ts +3 -1
- package/dist/cjs/index.js +5 -2
- package/dist/cjs/uploads/Uploads.d.ts +7 -0
- package/dist/cjs/uploads/Uploads.js +78 -0
- package/dist/cjs/uploads/index.d.ts +2 -0
- package/dist/cjs/uploads/index.js +5 -0
- package/dist/cjs/uploads/source.d.ts +10 -0
- package/dist/cjs/uploads/source.js +155 -0
- package/dist/cjs/uploads/types.d.ts +46 -0
- package/dist/cjs/uploads/types.js +2 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +5 -0
- package/dist/esm/CloudPDFClient.d.mts +20 -0
- package/dist/esm/CloudPDFClient.mjs +35 -0
- package/dist/esm/api/errors/ConflictError.d.mts +7 -0
- package/dist/esm/api/errors/ConflictError.mjs +17 -0
- package/dist/esm/api/errors/GoneError.d.mts +7 -0
- package/dist/esm/api/errors/GoneError.mjs +17 -0
- package/dist/esm/api/errors/UnprocessableEntityError.d.mts +7 -0
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +17 -0
- package/dist/esm/api/errors/index.d.mts +3 -0
- package/dist/esm/api/errors/index.mjs +3 -0
- package/dist/esm/api/resources/documents/client/Client.d.mts +14 -5
- package/dist/esm/api/resources/documents/client/Client.mjs +27 -15
- package/dist/esm/api/resources/documents/client/requests/DocumentsInitRequest.d.mts +7 -0
- package/dist/esm/api/resources/documents/client/requests/DocumentsInitRequest.mjs +5 -0
- package/dist/esm/api/resources/documents/client/requests/UploadProxyDocumentsRequest.d.mts +14 -0
- package/dist/esm/api/resources/documents/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shares/client/Client.d.mts +119 -0
- package/dist/esm/api/resources/shares/client/Client.mjs +385 -0
- package/dist/esm/api/resources/shares/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shares/client/index.mjs +1 -0
- package/dist/esm/api/resources/shares/client/requests/DeleteSharesRequest.d.mts +11 -0
- package/dist/esm/api/resources/shares/client/requests/GetSharesRequest.d.mts +11 -0
- package/dist/esm/api/resources/shares/client/requests/GetSharesRequest.mjs +2 -0
- package/dist/esm/api/resources/shares/client/requests/ListSharesRequest.d.mts +12 -0
- package/dist/esm/api/resources/shares/client/requests/ListSharesRequest.mjs +2 -0
- package/dist/esm/api/resources/shares/client/requests/SharesCreateRequest.d.mts +18 -0
- package/dist/esm/api/resources/shares/client/requests/SharesCreateRequest.mjs +2 -0
- package/dist/esm/api/resources/shares/client/requests/SharesExchangeRequest.d.mts +10 -0
- package/dist/esm/api/resources/shares/client/requests/SharesExchangeRequest.mjs +2 -0
- package/dist/esm/api/resources/shares/client/requests/SharesUpdateRequest.d.mts +17 -0
- package/dist/esm/api/resources/shares/client/requests/SharesUpdateRequest.mjs +2 -0
- package/dist/esm/api/resources/shares/client/requests/index.d.mts +6 -0
- package/dist/esm/api/resources/shares/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shares/exports.d.mts +2 -0
- package/dist/esm/api/resources/shares/exports.mjs +3 -0
- package/dist/esm/api/resources/shares/index.d.mts +1 -0
- package/dist/esm/api/resources/shares/index.mjs +1 -0
- package/dist/esm/api/resources/tenants/client/Client.d.mts +50 -0
- package/dist/esm/api/resources/tenants/client/Client.mjs +181 -0
- package/dist/esm/api/resources/tenants/client/requests/ResumeTenantsRequest.d.mts +9 -0
- package/dist/esm/api/resources/tenants/client/requests/ResumeTenantsRequest.mjs +2 -0
- package/dist/esm/api/resources/tenants/client/requests/TenantsSuspendRequest.d.mts +10 -0
- package/dist/esm/api/resources/tenants/client/requests/TenantsSuspendRequest.mjs +2 -0
- package/dist/esm/api/resources/tenants/client/requests/UsageTenantsRequest.d.mts +10 -0
- package/dist/esm/api/resources/tenants/client/requests/UsageTenantsRequest.mjs +2 -0
- package/dist/esm/api/resources/tenants/client/requests/index.d.mts +3 -0
- package/dist/esm/api/types/DocumentsInit200ResponseCreatedUpload.d.mts +3 -3
- package/dist/esm/api/types/DocumentsInit200ResponseResumedUpload.d.mts +3 -3
- package/dist/esm/api/types/DocumentsUploadProxy200Response.d.mts +3 -0
- package/dist/esm/api/types/DocumentsUploadProxy200Response.mjs +2 -0
- package/dist/esm/api/types/DocumentsUploadProxy400Response.d.mts +9 -0
- package/dist/esm/api/types/DocumentsUploadProxy400Response.mjs +2 -0
- package/dist/esm/api/types/DocumentsUploadProxy409Response.d.mts +9 -0
- package/dist/esm/api/types/DocumentsUploadProxy409Response.mjs +2 -0
- package/dist/esm/api/types/SharesCreate200Response.d.mts +22 -0
- package/dist/esm/api/types/SharesCreate200Response.mjs +2 -0
- package/dist/esm/api/types/SharesCreate400Response.d.mts +9 -0
- package/dist/esm/api/types/SharesCreate400Response.mjs +2 -0
- package/dist/esm/api/types/SharesCreate403Response.d.mts +9 -0
- package/dist/esm/api/types/SharesCreate403Response.mjs +2 -0
- package/dist/esm/api/types/SharesCreate404Response.d.mts +9 -0
- package/dist/esm/api/types/SharesCreate404Response.mjs +2 -0
- package/dist/esm/api/types/SharesDeleteResponse.d.mts +9 -0
- package/dist/esm/api/types/SharesDeleteResponse.mjs +2 -0
- package/dist/esm/api/types/SharesExchange200Response.d.mts +6 -0
- package/dist/esm/api/types/SharesExchange200Response.mjs +2 -0
- package/dist/esm/api/types/SharesExchange400Response.d.mts +9 -0
- package/dist/esm/api/types/SharesExchange400Response.mjs +2 -0
- package/dist/esm/api/types/SharesExchange403Response.d.mts +9 -0
- package/dist/esm/api/types/SharesExchange403Response.mjs +2 -0
- package/dist/esm/api/types/SharesExchange404Response.d.mts +9 -0
- package/dist/esm/api/types/SharesExchange404Response.mjs +2 -0
- package/dist/esm/api/types/SharesExchange410Response.d.mts +9 -0
- package/dist/esm/api/types/SharesExchange410Response.mjs +2 -0
- package/dist/esm/api/types/SharesExchange422Response.d.mts +9 -0
- package/dist/esm/api/types/SharesExchange422Response.mjs +2 -0
- package/dist/esm/api/types/SharesGet200Response.d.mts +22 -0
- package/dist/esm/api/types/SharesGet200Response.mjs +2 -0
- package/dist/esm/api/types/SharesGet404Response.d.mts +9 -0
- package/dist/esm/api/types/SharesGet404Response.mjs +2 -0
- package/dist/esm/api/types/SharesList200Response.d.mts +26 -0
- package/dist/esm/api/types/SharesList200Response.mjs +2 -0
- package/dist/esm/api/types/SharesList400Response.d.mts +9 -0
- package/dist/esm/api/types/SharesList400Response.mjs +2 -0
- package/dist/esm/api/types/SharesUpdate200Response.d.mts +22 -0
- package/dist/esm/api/types/SharesUpdate200Response.mjs +2 -0
- package/dist/esm/api/types/SharesUpdate400Response.d.mts +9 -0
- package/dist/esm/api/types/SharesUpdate400Response.mjs +2 -0
- package/dist/esm/api/types/SharesUpdate404Response.d.mts +9 -0
- package/dist/esm/api/types/SharesUpdate404Response.mjs +2 -0
- package/dist/esm/api/types/TenantsCreate200Response.d.mts +8 -0
- package/dist/esm/api/types/TenantsCreate200Response.mjs +10 -1
- package/dist/esm/api/types/TenantsGet200Response.d.mts +8 -0
- package/dist/esm/api/types/TenantsGet200Response.mjs +10 -1
- package/dist/esm/api/types/TenantsList200Response.d.mts +8 -0
- package/dist/esm/api/types/TenantsList200Response.mjs +13 -1
- package/dist/esm/api/types/TenantsResumeResponse.d.mts +9 -0
- package/dist/esm/api/types/TenantsResumeResponse.mjs +2 -0
- package/dist/esm/api/types/TenantsSuspendResponse.d.mts +9 -0
- package/dist/esm/api/types/TenantsSuspendResponse.mjs +2 -0
- package/dist/esm/api/types/TenantsUsage200Response.d.mts +13 -0
- package/dist/esm/api/types/TenantsUsage200Response.mjs +2 -0
- package/dist/esm/api/types/TenantsUsage400Response.d.mts +9 -0
- package/dist/esm/api/types/TenantsUsage400Response.mjs +2 -0
- package/dist/esm/api/types/TenantsUsage404Response.d.mts +9 -0
- package/dist/esm/api/types/TenantsUsage404Response.mjs +2 -0
- package/dist/esm/api/types/TokensIssueRequest.d.mts +2 -1
- package/dist/esm/api/types/index.d.mts +26 -2
- package/dist/esm/api/types/index.mjs +26 -2
- package/dist/esm/auth/BearerAuthProvider.d.mts +1 -1
- package/dist/esm/core/form-data-utils/FormDataWrapper.d.mts +15 -0
- package/dist/esm/core/form-data-utils/FormDataWrapper.mjs +150 -0
- package/dist/esm/core/form-data-utils/encodeAsFormParameter.d.mts +1 -0
- package/dist/esm/core/form-data-utils/encodeAsFormParameter.mjs +9 -0
- package/dist/esm/core/form-data-utils/index.d.mts +2 -0
- package/dist/esm/core/form-data-utils/index.mjs +2 -0
- package/dist/esm/core/index.d.mts +1 -0
- package/dist/esm/core/index.mjs +1 -0
- package/dist/esm/index.d.mts +3 -1
- package/dist/esm/index.mjs +3 -1
- package/dist/esm/uploads/Uploads.d.mts +7 -0
- package/dist/esm/uploads/Uploads.mjs +74 -0
- package/dist/esm/uploads/index.d.mts +2 -0
- package/dist/esm/uploads/index.mjs +1 -0
- package/dist/esm/uploads/source.d.mts +10 -0
- package/dist/esm/uploads/source.mjs +119 -0
- package/dist/esm/uploads/types.d.mts +46 -0
- package/dist/esm/uploads/types.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +188 -177
- package/reference.md +588 -0
- package/dist/cjs/api/types/DocumentsUploadDirect200Response.d.ts +0 -3
- package/dist/cjs/api/types/DocumentsUploadDirect400Response.d.ts +0 -9
- package/dist/esm/api/types/DocumentsUploadDirect200Response.d.mts +0 -3
- package/dist/esm/api/types/DocumentsUploadDirect400Response.d.mts +0 -9
- /package/dist/cjs/api/{types/DocumentsUploadDirect200Response.js → resources/documents/client/requests/UploadProxyDocumentsRequest.js} +0 -0
- /package/dist/cjs/api/{types/DocumentsUploadDirect400Response.js → resources/shares/client/requests/DeleteSharesRequest.js} +0 -0
- /package/dist/esm/api/{types/DocumentsUploadDirect200Response.mjs → resources/documents/client/requests/UploadProxyDocumentsRequest.mjs} +0 -0
- /package/dist/esm/api/{types/DocumentsUploadDirect400Response.mjs → resources/shares/client/requests/DeleteSharesRequest.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -313,6 +313,346 @@ await client.doc.text({
|
|
|
313
313
|
</dl>
|
|
314
314
|
|
|
315
315
|
|
|
316
|
+
</dd>
|
|
317
|
+
</dl>
|
|
318
|
+
</details>
|
|
319
|
+
|
|
320
|
+
## Shares
|
|
321
|
+
<details><summary><code>client.shares.<a href="/src/api/resources/shares/client/Client.ts">exchange</a>({ ...params }) -> CloudPDF.SharesExchange200Response</code></summary>
|
|
322
|
+
<dl>
|
|
323
|
+
<dd>
|
|
324
|
+
|
|
325
|
+
#### 📝 Description
|
|
326
|
+
|
|
327
|
+
<dl>
|
|
328
|
+
<dd>
|
|
329
|
+
|
|
330
|
+
<dl>
|
|
331
|
+
<dd>
|
|
332
|
+
|
|
333
|
+
Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, revoked, and disabled tokens are indistinguishable (404). Passphrase-protected grants return 422 SharePasswordRequired until `password` is supplied. Mounted only when the deployment can sign (HS256 mode).
|
|
334
|
+
</dd>
|
|
335
|
+
</dl>
|
|
336
|
+
</dd>
|
|
337
|
+
</dl>
|
|
338
|
+
|
|
339
|
+
#### 🔌 Usage
|
|
340
|
+
|
|
341
|
+
<dl>
|
|
342
|
+
<dd>
|
|
343
|
+
|
|
344
|
+
<dl>
|
|
345
|
+
<dd>
|
|
346
|
+
|
|
347
|
+
```typescript
|
|
348
|
+
await client.shares.exchange({
|
|
349
|
+
shareToken: "shareToken"
|
|
350
|
+
});
|
|
351
|
+
|
|
352
|
+
```
|
|
353
|
+
</dd>
|
|
354
|
+
</dl>
|
|
355
|
+
</dd>
|
|
356
|
+
</dl>
|
|
357
|
+
|
|
358
|
+
#### ⚙️ Parameters
|
|
359
|
+
|
|
360
|
+
<dl>
|
|
361
|
+
<dd>
|
|
362
|
+
|
|
363
|
+
<dl>
|
|
364
|
+
<dd>
|
|
365
|
+
|
|
366
|
+
**request:** `CloudPDF.SharesExchangeRequest`
|
|
367
|
+
|
|
368
|
+
</dd>
|
|
369
|
+
</dl>
|
|
370
|
+
|
|
371
|
+
<dl>
|
|
372
|
+
<dd>
|
|
373
|
+
|
|
374
|
+
**requestOptions:** `SharesClient.RequestOptions`
|
|
375
|
+
|
|
376
|
+
</dd>
|
|
377
|
+
</dl>
|
|
378
|
+
</dd>
|
|
379
|
+
</dl>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</dd>
|
|
383
|
+
</dl>
|
|
384
|
+
</details>
|
|
385
|
+
|
|
386
|
+
<details><summary><code>client.shares.<a href="/src/api/resources/shares/client/Client.ts">list</a>({ ...params }) -> CloudPDF.SharesList200Response</code></summary>
|
|
387
|
+
<dl>
|
|
388
|
+
<dd>
|
|
389
|
+
|
|
390
|
+
#### 🔌 Usage
|
|
391
|
+
|
|
392
|
+
<dl>
|
|
393
|
+
<dd>
|
|
394
|
+
|
|
395
|
+
<dl>
|
|
396
|
+
<dd>
|
|
397
|
+
|
|
398
|
+
```typescript
|
|
399
|
+
await client.shares.list({
|
|
400
|
+
tenantId: "tenantId"
|
|
401
|
+
});
|
|
402
|
+
|
|
403
|
+
```
|
|
404
|
+
</dd>
|
|
405
|
+
</dl>
|
|
406
|
+
</dd>
|
|
407
|
+
</dl>
|
|
408
|
+
|
|
409
|
+
#### ⚙️ Parameters
|
|
410
|
+
|
|
411
|
+
<dl>
|
|
412
|
+
<dd>
|
|
413
|
+
|
|
414
|
+
<dl>
|
|
415
|
+
<dd>
|
|
416
|
+
|
|
417
|
+
**request:** `CloudPDF.ListSharesRequest`
|
|
418
|
+
|
|
419
|
+
</dd>
|
|
420
|
+
</dl>
|
|
421
|
+
|
|
422
|
+
<dl>
|
|
423
|
+
<dd>
|
|
424
|
+
|
|
425
|
+
**requestOptions:** `SharesClient.RequestOptions`
|
|
426
|
+
|
|
427
|
+
</dd>
|
|
428
|
+
</dl>
|
|
429
|
+
</dd>
|
|
430
|
+
</dl>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
</dd>
|
|
434
|
+
</dl>
|
|
435
|
+
</details>
|
|
436
|
+
|
|
437
|
+
<details><summary><code>client.shares.<a href="/src/api/resources/shares/client/Client.ts">create</a>({ ...params }) -> CloudPDF.SharesCreate200Response</code></summary>
|
|
438
|
+
<dl>
|
|
439
|
+
<dd>
|
|
440
|
+
|
|
441
|
+
#### 📝 Description
|
|
442
|
+
|
|
443
|
+
<dl>
|
|
444
|
+
<dd>
|
|
445
|
+
|
|
446
|
+
<dl>
|
|
447
|
+
<dd>
|
|
448
|
+
|
|
449
|
+
The returned share id IS the public share token. Mounted only when the deployment can sign (HS256 mode) — exchange mints session JWTs, so grants exist only where minting does.
|
|
450
|
+
</dd>
|
|
451
|
+
</dl>
|
|
452
|
+
</dd>
|
|
453
|
+
</dl>
|
|
454
|
+
|
|
455
|
+
#### 🔌 Usage
|
|
456
|
+
|
|
457
|
+
<dl>
|
|
458
|
+
<dd>
|
|
459
|
+
|
|
460
|
+
<dl>
|
|
461
|
+
<dd>
|
|
462
|
+
|
|
463
|
+
```typescript
|
|
464
|
+
await client.shares.create({
|
|
465
|
+
tenantId: "tenantId",
|
|
466
|
+
docId: "docId",
|
|
467
|
+
scope: ["scope"]
|
|
468
|
+
});
|
|
469
|
+
|
|
470
|
+
```
|
|
471
|
+
</dd>
|
|
472
|
+
</dl>
|
|
473
|
+
</dd>
|
|
474
|
+
</dl>
|
|
475
|
+
|
|
476
|
+
#### ⚙️ Parameters
|
|
477
|
+
|
|
478
|
+
<dl>
|
|
479
|
+
<dd>
|
|
480
|
+
|
|
481
|
+
<dl>
|
|
482
|
+
<dd>
|
|
483
|
+
|
|
484
|
+
**request:** `CloudPDF.SharesCreateRequest`
|
|
485
|
+
|
|
486
|
+
</dd>
|
|
487
|
+
</dl>
|
|
488
|
+
|
|
489
|
+
<dl>
|
|
490
|
+
<dd>
|
|
491
|
+
|
|
492
|
+
**requestOptions:** `SharesClient.RequestOptions`
|
|
493
|
+
|
|
494
|
+
</dd>
|
|
495
|
+
</dl>
|
|
496
|
+
</dd>
|
|
497
|
+
</dl>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
</dd>
|
|
501
|
+
</dl>
|
|
502
|
+
</details>
|
|
503
|
+
|
|
504
|
+
<details><summary><code>client.shares.<a href="/src/api/resources/shares/client/Client.ts">get</a>({ ...params }) -> CloudPDF.SharesGet200Response</code></summary>
|
|
505
|
+
<dl>
|
|
506
|
+
<dd>
|
|
507
|
+
|
|
508
|
+
#### 🔌 Usage
|
|
509
|
+
|
|
510
|
+
<dl>
|
|
511
|
+
<dd>
|
|
512
|
+
|
|
513
|
+
<dl>
|
|
514
|
+
<dd>
|
|
515
|
+
|
|
516
|
+
```typescript
|
|
517
|
+
await client.shares.get({
|
|
518
|
+
tenantId: "tenantId",
|
|
519
|
+
shareId: "shareId"
|
|
520
|
+
});
|
|
521
|
+
|
|
522
|
+
```
|
|
523
|
+
</dd>
|
|
524
|
+
</dl>
|
|
525
|
+
</dd>
|
|
526
|
+
</dl>
|
|
527
|
+
|
|
528
|
+
#### ⚙️ Parameters
|
|
529
|
+
|
|
530
|
+
<dl>
|
|
531
|
+
<dd>
|
|
532
|
+
|
|
533
|
+
<dl>
|
|
534
|
+
<dd>
|
|
535
|
+
|
|
536
|
+
**request:** `CloudPDF.GetSharesRequest`
|
|
537
|
+
|
|
538
|
+
</dd>
|
|
539
|
+
</dl>
|
|
540
|
+
|
|
541
|
+
<dl>
|
|
542
|
+
<dd>
|
|
543
|
+
|
|
544
|
+
**requestOptions:** `SharesClient.RequestOptions`
|
|
545
|
+
|
|
546
|
+
</dd>
|
|
547
|
+
</dl>
|
|
548
|
+
</dd>
|
|
549
|
+
</dl>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
</dd>
|
|
553
|
+
</dl>
|
|
554
|
+
</details>
|
|
555
|
+
|
|
556
|
+
<details><summary><code>client.shares.<a href="/src/api/resources/shares/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
|
557
|
+
<dl>
|
|
558
|
+
<dd>
|
|
559
|
+
|
|
560
|
+
#### 🔌 Usage
|
|
561
|
+
|
|
562
|
+
<dl>
|
|
563
|
+
<dd>
|
|
564
|
+
|
|
565
|
+
<dl>
|
|
566
|
+
<dd>
|
|
567
|
+
|
|
568
|
+
```typescript
|
|
569
|
+
await client.shares.delete({
|
|
570
|
+
tenantId: "tenantId",
|
|
571
|
+
shareId: "shareId"
|
|
572
|
+
});
|
|
573
|
+
|
|
574
|
+
```
|
|
575
|
+
</dd>
|
|
576
|
+
</dl>
|
|
577
|
+
</dd>
|
|
578
|
+
</dl>
|
|
579
|
+
|
|
580
|
+
#### ⚙️ Parameters
|
|
581
|
+
|
|
582
|
+
<dl>
|
|
583
|
+
<dd>
|
|
584
|
+
|
|
585
|
+
<dl>
|
|
586
|
+
<dd>
|
|
587
|
+
|
|
588
|
+
**request:** `CloudPDF.DeleteSharesRequest`
|
|
589
|
+
|
|
590
|
+
</dd>
|
|
591
|
+
</dl>
|
|
592
|
+
|
|
593
|
+
<dl>
|
|
594
|
+
<dd>
|
|
595
|
+
|
|
596
|
+
**requestOptions:** `SharesClient.RequestOptions`
|
|
597
|
+
|
|
598
|
+
</dd>
|
|
599
|
+
</dl>
|
|
600
|
+
</dd>
|
|
601
|
+
</dl>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
</dd>
|
|
605
|
+
</dl>
|
|
606
|
+
</details>
|
|
607
|
+
|
|
608
|
+
<details><summary><code>client.shares.<a href="/src/api/resources/shares/client/Client.ts">update</a>({ ...params }) -> CloudPDF.SharesUpdate200Response</code></summary>
|
|
609
|
+
<dl>
|
|
610
|
+
<dd>
|
|
611
|
+
|
|
612
|
+
#### 🔌 Usage
|
|
613
|
+
|
|
614
|
+
<dl>
|
|
615
|
+
<dd>
|
|
616
|
+
|
|
617
|
+
<dl>
|
|
618
|
+
<dd>
|
|
619
|
+
|
|
620
|
+
```typescript
|
|
621
|
+
await client.shares.update({
|
|
622
|
+
tenantId: "tenantId",
|
|
623
|
+
shareId: "shareId"
|
|
624
|
+
});
|
|
625
|
+
|
|
626
|
+
```
|
|
627
|
+
</dd>
|
|
628
|
+
</dl>
|
|
629
|
+
</dd>
|
|
630
|
+
</dl>
|
|
631
|
+
|
|
632
|
+
#### ⚙️ Parameters
|
|
633
|
+
|
|
634
|
+
<dl>
|
|
635
|
+
<dd>
|
|
636
|
+
|
|
637
|
+
<dl>
|
|
638
|
+
<dd>
|
|
639
|
+
|
|
640
|
+
**request:** `CloudPDF.SharesUpdateRequest`
|
|
641
|
+
|
|
642
|
+
</dd>
|
|
643
|
+
</dl>
|
|
644
|
+
|
|
645
|
+
<dl>
|
|
646
|
+
<dd>
|
|
647
|
+
|
|
648
|
+
**requestOptions:** `SharesClient.RequestOptions`
|
|
649
|
+
|
|
650
|
+
</dd>
|
|
651
|
+
</dl>
|
|
652
|
+
</dd>
|
|
653
|
+
</dl>
|
|
654
|
+
|
|
655
|
+
|
|
316
656
|
</dd>
|
|
317
657
|
</dl>
|
|
318
658
|
</details>
|
|
@@ -530,6 +870,187 @@ await client.tenants.delete({
|
|
|
530
870
|
</dl>
|
|
531
871
|
|
|
532
872
|
|
|
873
|
+
</dd>
|
|
874
|
+
</dl>
|
|
875
|
+
</details>
|
|
876
|
+
|
|
877
|
+
<details><summary><code>client.tenants.<a href="/src/api/resources/tenants/client/Client.ts">resume</a>({ ...params }) -> void</code></summary>
|
|
878
|
+
<dl>
|
|
879
|
+
<dd>
|
|
880
|
+
|
|
881
|
+
#### 🔌 Usage
|
|
882
|
+
|
|
883
|
+
<dl>
|
|
884
|
+
<dd>
|
|
885
|
+
|
|
886
|
+
<dl>
|
|
887
|
+
<dd>
|
|
888
|
+
|
|
889
|
+
```typescript
|
|
890
|
+
await client.tenants.resume({
|
|
891
|
+
tenantId: "tenantId"
|
|
892
|
+
});
|
|
893
|
+
|
|
894
|
+
```
|
|
895
|
+
</dd>
|
|
896
|
+
</dl>
|
|
897
|
+
</dd>
|
|
898
|
+
</dl>
|
|
899
|
+
|
|
900
|
+
#### ⚙️ Parameters
|
|
901
|
+
|
|
902
|
+
<dl>
|
|
903
|
+
<dd>
|
|
904
|
+
|
|
905
|
+
<dl>
|
|
906
|
+
<dd>
|
|
907
|
+
|
|
908
|
+
**request:** `CloudPDF.ResumeTenantsRequest`
|
|
909
|
+
|
|
910
|
+
</dd>
|
|
911
|
+
</dl>
|
|
912
|
+
|
|
913
|
+
<dl>
|
|
914
|
+
<dd>
|
|
915
|
+
|
|
916
|
+
**requestOptions:** `TenantsClient.RequestOptions`
|
|
917
|
+
|
|
918
|
+
</dd>
|
|
919
|
+
</dl>
|
|
920
|
+
</dd>
|
|
921
|
+
</dl>
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
</dd>
|
|
925
|
+
</dl>
|
|
926
|
+
</details>
|
|
927
|
+
|
|
928
|
+
<details><summary><code>client.tenants.<a href="/src/api/resources/tenants/client/Client.ts">suspend</a>({ ...params }) -> void</code></summary>
|
|
929
|
+
<dl>
|
|
930
|
+
<dd>
|
|
931
|
+
|
|
932
|
+
#### 📝 Description
|
|
933
|
+
|
|
934
|
+
<dl>
|
|
935
|
+
<dd>
|
|
936
|
+
|
|
937
|
+
<dl>
|
|
938
|
+
<dd>
|
|
939
|
+
|
|
940
|
+
Instantly reversible with resume. The API token is exempt, so a suspended tenant can still be inspected, exported, resumed, or deleted.
|
|
941
|
+
</dd>
|
|
942
|
+
</dl>
|
|
943
|
+
</dd>
|
|
944
|
+
</dl>
|
|
945
|
+
|
|
946
|
+
#### 🔌 Usage
|
|
947
|
+
|
|
948
|
+
<dl>
|
|
949
|
+
<dd>
|
|
950
|
+
|
|
951
|
+
<dl>
|
|
952
|
+
<dd>
|
|
953
|
+
|
|
954
|
+
```typescript
|
|
955
|
+
await client.tenants.suspend({
|
|
956
|
+
tenantId: "tenantId"
|
|
957
|
+
});
|
|
958
|
+
|
|
959
|
+
```
|
|
960
|
+
</dd>
|
|
961
|
+
</dl>
|
|
962
|
+
</dd>
|
|
963
|
+
</dl>
|
|
964
|
+
|
|
965
|
+
#### ⚙️ Parameters
|
|
966
|
+
|
|
967
|
+
<dl>
|
|
968
|
+
<dd>
|
|
969
|
+
|
|
970
|
+
<dl>
|
|
971
|
+
<dd>
|
|
972
|
+
|
|
973
|
+
**request:** `CloudPDF.TenantsSuspendRequest`
|
|
974
|
+
|
|
975
|
+
</dd>
|
|
976
|
+
</dl>
|
|
977
|
+
|
|
978
|
+
<dl>
|
|
979
|
+
<dd>
|
|
980
|
+
|
|
981
|
+
**requestOptions:** `TenantsClient.RequestOptions`
|
|
982
|
+
|
|
983
|
+
</dd>
|
|
984
|
+
</dl>
|
|
985
|
+
</dd>
|
|
986
|
+
</dl>
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
</dd>
|
|
990
|
+
</dl>
|
|
991
|
+
</details>
|
|
992
|
+
|
|
993
|
+
<details><summary><code>client.tenants.<a href="/src/api/resources/tenants/client/Client.ts">usage</a>({ ...params }) -> CloudPDF.TenantsUsage200Response</code></summary>
|
|
994
|
+
<dl>
|
|
995
|
+
<dd>
|
|
996
|
+
|
|
997
|
+
#### 📝 Description
|
|
998
|
+
|
|
999
|
+
<dl>
|
|
1000
|
+
<dd>
|
|
1001
|
+
|
|
1002
|
+
<dl>
|
|
1003
|
+
<dd>
|
|
1004
|
+
|
|
1005
|
+
Facts only — no limits or billing state. Views count share exchanges plus authorized /v1/access grants, deduplicated across the two.
|
|
1006
|
+
</dd>
|
|
1007
|
+
</dl>
|
|
1008
|
+
</dd>
|
|
1009
|
+
</dl>
|
|
1010
|
+
|
|
1011
|
+
#### 🔌 Usage
|
|
1012
|
+
|
|
1013
|
+
<dl>
|
|
1014
|
+
<dd>
|
|
1015
|
+
|
|
1016
|
+
<dl>
|
|
1017
|
+
<dd>
|
|
1018
|
+
|
|
1019
|
+
```typescript
|
|
1020
|
+
await client.tenants.usage({
|
|
1021
|
+
tenantId: "tenantId"
|
|
1022
|
+
});
|
|
1023
|
+
|
|
1024
|
+
```
|
|
1025
|
+
</dd>
|
|
1026
|
+
</dl>
|
|
1027
|
+
</dd>
|
|
1028
|
+
</dl>
|
|
1029
|
+
|
|
1030
|
+
#### ⚙️ Parameters
|
|
1031
|
+
|
|
1032
|
+
<dl>
|
|
1033
|
+
<dd>
|
|
1034
|
+
|
|
1035
|
+
<dl>
|
|
1036
|
+
<dd>
|
|
1037
|
+
|
|
1038
|
+
**request:** `CloudPDF.UsageTenantsRequest`
|
|
1039
|
+
|
|
1040
|
+
</dd>
|
|
1041
|
+
</dl>
|
|
1042
|
+
|
|
1043
|
+
<dl>
|
|
1044
|
+
<dd>
|
|
1045
|
+
|
|
1046
|
+
**requestOptions:** `TenantsClient.RequestOptions`
|
|
1047
|
+
|
|
1048
|
+
</dd>
|
|
1049
|
+
</dl>
|
|
1050
|
+
</dd>
|
|
1051
|
+
</dl>
|
|
1052
|
+
|
|
1053
|
+
|
|
533
1054
|
</dd>
|
|
534
1055
|
</dl>
|
|
535
1056
|
</details>
|
|
@@ -843,6 +1364,73 @@ await client.documents.thumbnail({
|
|
|
843
1364
|
</dl>
|
|
844
1365
|
|
|
845
1366
|
|
|
1367
|
+
</dd>
|
|
1368
|
+
</dl>
|
|
1369
|
+
</details>
|
|
1370
|
+
|
|
1371
|
+
<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">uploadProxy</a>({ ...params }) -> CloudPDF.DocumentsUploadProxy200Response</code></summary>
|
|
1372
|
+
<dl>
|
|
1373
|
+
<dd>
|
|
1374
|
+
|
|
1375
|
+
#### 📝 Description
|
|
1376
|
+
|
|
1377
|
+
<dl>
|
|
1378
|
+
<dd>
|
|
1379
|
+
|
|
1380
|
+
<dl>
|
|
1381
|
+
<dd>
|
|
1382
|
+
|
|
1383
|
+
This bounded origin-mediated fallback must only be used after documents.init returns upload.kind=proxy. Auto mode prefers a presigned object-store PUT whenever available.
|
|
1384
|
+
</dd>
|
|
1385
|
+
</dl>
|
|
1386
|
+
</dd>
|
|
1387
|
+
</dl>
|
|
1388
|
+
|
|
1389
|
+
#### 🔌 Usage
|
|
1390
|
+
|
|
1391
|
+
<dl>
|
|
1392
|
+
<dd>
|
|
1393
|
+
|
|
1394
|
+
<dl>
|
|
1395
|
+
<dd>
|
|
1396
|
+
|
|
1397
|
+
```typescript
|
|
1398
|
+
await client.documents.uploadProxy({
|
|
1399
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
1400
|
+
tenantId: "tenantId",
|
|
1401
|
+
id: "id"
|
|
1402
|
+
});
|
|
1403
|
+
|
|
1404
|
+
```
|
|
1405
|
+
</dd>
|
|
1406
|
+
</dl>
|
|
1407
|
+
</dd>
|
|
1408
|
+
</dl>
|
|
1409
|
+
|
|
1410
|
+
#### ⚙️ Parameters
|
|
1411
|
+
|
|
1412
|
+
<dl>
|
|
1413
|
+
<dd>
|
|
1414
|
+
|
|
1415
|
+
<dl>
|
|
1416
|
+
<dd>
|
|
1417
|
+
|
|
1418
|
+
**request:** `CloudPDF.UploadProxyDocumentsRequest`
|
|
1419
|
+
|
|
1420
|
+
</dd>
|
|
1421
|
+
</dl>
|
|
1422
|
+
|
|
1423
|
+
<dl>
|
|
1424
|
+
<dd>
|
|
1425
|
+
|
|
1426
|
+
**requestOptions:** `DocumentsClient.RequestOptions`
|
|
1427
|
+
|
|
1428
|
+
</dd>
|
|
1429
|
+
</dl>
|
|
1430
|
+
</dd>
|
|
1431
|
+
</dl>
|
|
1432
|
+
|
|
1433
|
+
|
|
846
1434
|
</dd>
|
|
847
1435
|
</dl>
|
|
848
1436
|
</details>
|
|
File without changes
|
|
File without changes
|
|
File without changes
|