@cloudpdf/sdk 3.0.0-next.6 → 3.0.0-next.8

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@cloudpdf/sdk",
-        "X-Fern-SDK-Version": "3.0.0-next.6",
-        "User-Agent": "@cloudpdf/sdk/3.0.0-next.6",
+        "X-Fern-SDK-Version": "3.0.0-next.8",
+        "User-Agent": "@cloudpdf/sdk/3.0.0-next.8",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

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

@@ -11,24 +11,36 @@ import type * as CloudPDF from "../../../../index.js";
  */
 export interface DocumentsImportFromRequest {
     tenantId: string;
+    /** 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. */
     source: CloudPDF.DocumentsImportFromRequestSource;
+    /** Integrity pins, enforced when present. When absent, the server-observed values become authoritative. */
     expected?: DocumentsImportFromRequest.Expected;
     metadata?: Record<string, unknown>;
+    /** Retrying with the same key resumes the same document rather than importing a second copy — including after a 502. */
     idempotencyKey?: string;
+    /** 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. */
     dedupMode?: DocumentsImportFromRequest.DedupMode;
     docId?: string;
+    /** sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256. */
     mode?: DocumentsImportFromRequest.Mode;
 }
 export declare namespace DocumentsImportFromRequest {
+    /**
+     * Integrity pins, enforced when present. When absent, the server-observed values become authoritative.
+     */
     interface Expected {
+        /** Checked against the source's declared Content-Length before the transfer. */
         sizeBytes?: number | undefined;
+        /** Checked against the server-observed digest after the transfer. Required when dedupMode is reuse-existing. */
         sha256?: string | undefined;
     }
+    /** 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. */
     const DedupMode: {
         readonly AlwaysCreate: "always-create";
         readonly ReuseExisting: "reuse-existing";
     };
     type DedupMode = (typeof DedupMode)[keyof typeof DedupMode];
+    /** sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256. */
     const Mode: {
         readonly Sync: "sync";
         readonly Async: "async";

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

@@ -4,10 +4,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentsImportFromRequest = void 0;
 var DocumentsImportFromRequest;
 (function (DocumentsImportFromRequest) {
+    /** 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. */
     DocumentsImportFromRequest.DedupMode = {
         AlwaysCreate: "always-create",
         ReuseExisting: "reuse-existing",
     };
+    /** sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256. */
     DocumentsImportFromRequest.Mode = {
         Sync: "sync",
         Async: "async",

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

@@ -12,12 +12,14 @@ export interface DocumentsInitRequest {
     contentSha256: string;
     metadata?: Record<string, unknown>;
     idempotencyKey?: string;
+    /** 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. */
     dedupMode?: DocumentsInitRequest.DedupMode;
     docId?: string;
     uploadTtlSec?: number;
     uploadPreference?: DocumentsInitRequest.UploadPreference;
 }
 export declare namespace 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. */
     const DedupMode: {
         readonly AlwaysCreate: "always-create";
         readonly ReuseExisting: "reuse-existing";

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

@@ -4,6 +4,7 @@ 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",

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

@@ -1,14 +1,27 @@
 import type * as CloudPDF from "../../../index.js";
-export type DocumentsImportFromRequestSource = CloudPDF.DocumentsImportFromRequestSource.Url | CloudPDF.DocumentsImportFromRequestSource.Connection;
+/**
+ * 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/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.0.0-next.6";
+export declare const SDK_VERSION = "3.0.0-next.8";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "3.0.0-next.6";
+exports.SDK_VERSION = "3.0.0-next.8";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@cloudpdf/sdk",
-        "X-Fern-SDK-Version": "3.0.0-next.6",
-        "User-Agent": "@cloudpdf/sdk/3.0.0-next.6",
+        "X-Fern-SDK-Version": "3.0.0-next.8",
+        "User-Agent": "@cloudpdf/sdk/3.0.0-next.8",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/resources/documents/client/requests/DocumentsImportFromRequest.d.mts

@@ -11,24 +11,36 @@ import type * as CloudPDF from "../../../../index.mjs";
  */
 export interface DocumentsImportFromRequest {
     tenantId: string;
+    /** 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. */
     source: CloudPDF.DocumentsImportFromRequestSource;
+    /** Integrity pins, enforced when present. When absent, the server-observed values become authoritative. */
     expected?: DocumentsImportFromRequest.Expected;
     metadata?: Record<string, unknown>;
+    /** Retrying with the same key resumes the same document rather than importing a second copy — including after a 502. */
     idempotencyKey?: string;
+    /** 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. */
     dedupMode?: DocumentsImportFromRequest.DedupMode;
     docId?: string;
+    /** sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256. */
     mode?: DocumentsImportFromRequest.Mode;
 }
 export declare namespace DocumentsImportFromRequest {
+    /**
+     * Integrity pins, enforced when present. When absent, the server-observed values become authoritative.
+     */
     interface Expected {
+        /** Checked against the source's declared Content-Length before the transfer. */
         sizeBytes?: number | undefined;
+        /** Checked against the server-observed digest after the transfer. Required when dedupMode is reuse-existing. */
         sha256?: string | undefined;
     }
+    /** 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. */
     const DedupMode: {
         readonly AlwaysCreate: "always-create";
         readonly ReuseExisting: "reuse-existing";
     };
     type DedupMode = (typeof DedupMode)[keyof typeof DedupMode];
+    /** sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256. */
     const Mode: {
         readonly Sync: "sync";
         readonly Async: "async";

package/dist/esm/api/resources/documents/client/requests/DocumentsImportFromRequest.mjs

@@ -1,10 +1,12 @@
 // This file was auto-generated by Fern from our API Definition.
 export var DocumentsImportFromRequest;
 (function (DocumentsImportFromRequest) {
+    /** 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. */
     DocumentsImportFromRequest.DedupMode = {
         AlwaysCreate: "always-create",
         ReuseExisting: "reuse-existing",
     };
+    /** sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256. */
     DocumentsImportFromRequest.Mode = {
         Sync: "sync",
         Async: "async",

package/dist/esm/api/resources/documents/client/requests/DocumentsInitRequest.d.mts

@@ -12,12 +12,14 @@ export interface DocumentsInitRequest {
     contentSha256: string;
     metadata?: Record<string, unknown>;
     idempotencyKey?: string;
+    /** 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. */
     dedupMode?: DocumentsInitRequest.DedupMode;
     docId?: string;
     uploadTtlSec?: number;
     uploadPreference?: DocumentsInitRequest.UploadPreference;
 }
 export declare namespace 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. */
     const DedupMode: {
         readonly AlwaysCreate: "always-create";
         readonly ReuseExisting: "reuse-existing";

package/dist/esm/api/resources/documents/client/requests/DocumentsInitRequest.mjs

@@ -1,6 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 export 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",

package/dist/esm/api/resources/documents/types/DocumentsImportFromRequestSource.d.mts

@@ -1,14 +1,27 @@
 import type * as CloudPDF from "../../../index.mjs";
-export type DocumentsImportFromRequestSource = CloudPDF.DocumentsImportFromRequestSource.Url | CloudPDF.DocumentsImportFromRequestSource.Connection;
+/**
+ * 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/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.0.0-next.6";
+export declare const SDK_VERSION = "3.0.0-next.8";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "3.0.0-next.6";
+export const SDK_VERSION = "3.0.0-next.8";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudpdf/sdk",
-  "version": "3.0.0-next.6",
+  "version": "3.0.0-next.8",
   "private": false,
   "license": "Apache-2.0",
   "type": "commonjs",