@cloudpdf/sdk 3.0.0-next.1 → 3.0.0-next.11

package/dist/cjs/api/resources/documents/client/requests/DocumentsInitRequest.js

@@ -4,8 +4,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentsInitRequest = void 0;
 var DocumentsInitRequest;
 (function (DocumentsInitRequest) {
+    /** always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice. */
     DocumentsInitRequest.DedupMode = {
         AlwaysCreate: "always-create",
         ReuseExisting: "reuse-existing",
     };
+    DocumentsInitRequest.UploadPreference = {
+        Auto: "auto",
+        Presigned: "presigned",
+        Proxy: "proxy",
+    };
 })(DocumentsInitRequest || (exports.DocumentsInitRequest = DocumentsInitRequest = {}));

package/dist/cjs/api/resources/documents/client/requests/UploadProxyDocumentsRequest.d.ts

@@ -0,0 +1,14 @@
+import type * as core from "../../../../../core/index.js";
+/**
+ * @example
+ *     {
+ *         file: fs.createReadStream("/path/to/your/file"),
+ *         tenantId: "tenantId",
+ *         id: "id"
+ *     }
+ */
+export interface UploadProxyDocumentsRequest {
+    tenantId: string;
+    id: string;
+    file: core.file.Uploadable;
+}

package/dist/cjs/api/resources/documents/client/requests/UploadProxyDocumentsRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/documents/client/requests/index.d.ts

@@ -1,7 +1,9 @@
 export type { DeleteDocumentsRequest } from "./DeleteDocumentsRequest.js";
 export type { DocumentsCommitRequest } from "./DocumentsCommitRequest.js";
+export { DocumentsImportFromRequest } from "./DocumentsImportFromRequest.js";
 export { DocumentsInitRequest } from "./DocumentsInitRequest.js";
 export type { DownloadDocumentsRequest } from "./DownloadDocumentsRequest.js";
 export type { GetDocumentsRequest } from "./GetDocumentsRequest.js";
 export type { ListDocumentsRequest } from "./ListDocumentsRequest.js";
 export type { ThumbnailDocumentsRequest } from "./ThumbnailDocumentsRequest.js";
+export type { UploadProxyDocumentsRequest } from "./UploadProxyDocumentsRequest.js";

package/dist/cjs/api/resources/documents/client/requests/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentsInitRequest = void 0;
+exports.DocumentsInitRequest = exports.DocumentsImportFromRequest = void 0;
+var DocumentsImportFromRequest_js_1 = require("./DocumentsImportFromRequest.js");
+Object.defineProperty(exports, "DocumentsImportFromRequest", { enumerable: true, get: function () { return DocumentsImportFromRequest_js_1.DocumentsImportFromRequest; } });
 var DocumentsInitRequest_js_1 = require("./DocumentsInitRequest.js");
 Object.defineProperty(exports, "DocumentsInitRequest", { enumerable: true, get: function () { return DocumentsInitRequest_js_1.DocumentsInitRequest; } });

package/dist/cjs/api/resources/documents/types/DocumentsImportFromRequestSource.d.ts

@@ -0,0 +1,27 @@
+import type * as CloudPDF from "../../../index.js";
+/**
+ * Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.
+ */
+export type DocumentsImportFromRequestSource = 
+/**
+ * The caller supplies the authority: a presigned S3/GCS/Azure/R2/MinIO GET, or any HTTPS endpoint the deployment import policy allows. The URL is a capability — treat it as a secret. CloudPDF never echoes its query string back in errors, logs, or stored failure reasons. */
+CloudPDF.DocumentsImportFromRequestSource.Url
+/**
+ * The operator pre-registered the authority: the request names a connection and a key inside it. Which provider backs the connection (S3, GCS, Azure Blob, filesystem, ...) is deployment configuration, never wire surface. */
+ | CloudPDF.DocumentsImportFromRequestSource.Connection;
+export declare namespace DocumentsImportFromRequestSource {
+    interface Url {
+        kind: "url";
+        /** The URL to fetch. Must be allowed by the deployment import policy (scheme, network range, size) and must declare a length. */
+        url: string;
+    }
+    interface Connection {
+        kind: "connection";
+        /** The operator-registered storage connection to read from. */
+        connectionId: string;
+        /** The object key to read, inside the connection's configured scope. At most 1024 UTF-8 bytes. */
+        key: string;
+        /** Pins a specific version of the object. Provider-interpreted (S3 VersionId, GCS generation, Azure version id); providers without versioning reject it. */
+        revision?: string | undefined;
+    }
+}

package/dist/cjs/api/resources/documents/types/DocumentsImportFromRequestSource.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/documents/types/index.d.ts

@@ -1 +1,2 @@
+export * from "./DocumentsImportFromRequestSource.js";
 export * from "./ListDocumentsRequestState.js";

package/dist/cjs/api/resources/documents/types/index.js

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./DocumentsImportFromRequestSource.js"), exports);
 __exportStar(require("./ListDocumentsRequestState.js"), exports);

package/dist/cjs/api/resources/index.d.ts

@@ -4,6 +4,8 @@ export * as doc from "./doc/index.js";
 export * from "./documents/client/requests/index.js";
 export * as documents from "./documents/index.js";
 export * from "./documents/types/index.js";
+export * from "./shares/client/requests/index.js";
+export * as shares from "./shares/index.js";
 export * from "./tenants/client/requests/index.js";
 export * as tenants from "./tenants/index.js";
 export * from "./tokens/client/requests/index.js";

package/dist/cjs/api/resources/index.js

@@ -36,13 +36,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tokens = exports.tenants = exports.documents = exports.doc = exports.deployment = void 0;
+exports.tokens = exports.tenants = exports.shares = exports.documents = exports.doc = exports.deployment = void 0;
 exports.deployment = __importStar(require("./deployment/index.js"));
 __exportStar(require("./doc/client/requests/index.js"), exports);
 exports.doc = __importStar(require("./doc/index.js"));
 __exportStar(require("./documents/client/requests/index.js"), exports);
 exports.documents = __importStar(require("./documents/index.js"));
 __exportStar(require("./documents/types/index.js"), exports);
+__exportStar(require("./shares/client/requests/index.js"), exports);
+exports.shares = __importStar(require("./shares/index.js"));
 __exportStar(require("./tenants/client/requests/index.js"), exports);
 exports.tenants = __importStar(require("./tenants/index.js"));
 __exportStar(require("./tokens/client/requests/index.js"), exports);

package/dist/cjs/api/resources/shares/client/Client.d.ts

@@ -0,0 +1,119 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as CloudPDF from "../../../index.js";
+export declare namespace SharesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class SharesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<SharesClient.Options>;
+    constructor(options: SharesClient.Options);
+    /**
+     * 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).
+     *
+     * @param {CloudPDF.SharesExchangeRequest} request
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.ForbiddenError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link CloudPDF.GoneError}
+     * @throws {@link CloudPDF.UnprocessableEntityError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.shares.exchange({
+     *         shareToken: "shareToken"
+     *     })
+     */
+    exchange(request: CloudPDF.SharesExchangeRequest, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.SharesExchange200Response>;
+    private __exchange;
+    /**
+     * @param {CloudPDF.ListSharesRequest} request
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.shares.list({
+     *         tenantId: "tenantId"
+     *     })
+     */
+    list(request: CloudPDF.ListSharesRequest, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.SharesList200Response>;
+    private __list;
+    /**
+     * 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.
+     *
+     * @param {CloudPDF.SharesCreateRequest} request
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.ForbiddenError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.shares.create({
+     *         tenantId: "tenantId",
+     *         docId: "docId",
+     *         scope: ["scope"]
+     *     })
+     */
+    create(request: CloudPDF.SharesCreateRequest, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.SharesCreate200Response>;
+    private __create;
+    /**
+     * @param {CloudPDF.GetSharesRequest} request
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.shares.get({
+     *         tenantId: "tenantId",
+     *         shareId: "shareId"
+     *     })
+     */
+    get(request: CloudPDF.GetSharesRequest, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.SharesGet200Response>;
+    private __get;
+    /**
+     * @param {CloudPDF.DeleteSharesRequest} request
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.shares.delete({
+     *         tenantId: "tenantId",
+     *         shareId: "shareId"
+     *     })
+     */
+    delete(request: CloudPDF.DeleteSharesRequest, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+    /**
+     * @param {CloudPDF.SharesUpdateRequest} request
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.shares.update({
+     *         tenantId: "tenantId",
+     *         shareId: "shareId"
+     *     })
+     */
+    update(request: CloudPDF.SharesUpdateRequest, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.SharesUpdate200Response>;
+    private __update;
+}