@cloudpdf/sdk 3.0.0-next.15 → 3.0.0-next.16

package/dist/cjs/api/resources/doc/resources/outline/client/Client.d.ts

@@ -0,0 +1,29 @@
+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 OutlineClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class OutlineClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<OutlineClient.Options>;
+    constructor(options: OutlineClient.Options);
+    /**
+     * @param {CloudPDF.doc.GetOutlineRequest} request
+     * @param {OutlineClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.outline.get({
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    get(request: CloudPDF.doc.GetOutlineRequest, requestOptions?: OutlineClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocOutlineGet200Response>;
+    private __get;
+}

package/dist/cjs/api/resources/doc/resources/outline/client/Client.js

@@ -0,0 +1,110 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutlineClient = void 0;
+const BaseClient_js_1 = require("../../../../../../BaseClient.js");
+const headers_js_1 = require("../../../../../../core/headers.js");
+const core = __importStar(require("../../../../../../core/index.js"));
+const handleNonStatusCodeError_js_1 = require("../../../../../../errors/handleNonStatusCodeError.js");
+const errors = __importStar(require("../../../../../../errors/index.js"));
+const CloudPDF = __importStar(require("../../../../../index.js"));
+class OutlineClient {
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * @param {CloudPDF.doc.GetOutlineRequest} request
+     * @param {OutlineClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.outline.get({
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    get(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
+    }
+    __get(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, "X-Document-Password": documentPassword } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Document-Password": documentPassword }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `v1/docs/${core.url.encodePathParam(docId)}/layers/${core.url.encodePathParam(layerName)}/outline`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                timeoutMs: ((_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) !== null && _e !== void 0 ? _e : 60) * 1000,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CloudPDFError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/outline");
+        });
+    }
+}
+exports.OutlineClient = OutlineClient;

package/dist/cjs/api/resources/doc/resources/outline/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/dist/cjs/api/resources/doc/resources/outline/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./requests/index.js"), exports);

package/dist/{esm/api/resources/doc/resources/pages/client/requests/InsertPagesRequest.d.mts → cjs/api/resources/doc/resources/outline/client/requests/GetOutlineRequest.d.ts}

@@ -1,18 +1,13 @@
-import type * as core from "../../../../../../../core/index.mjs";
 /**
  * @example
  *     {
- *         file: fs.createReadStream("/path/to/your/file"),
  *         docId: "docId",
  *         layerName: "layerName"
  *     }
  */
-export interface InsertPagesRequest {
+export interface GetOutlineRequest {
     docId: string;
     layerName: string;
     /** Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead. */
     "X-Document-Password"?: string;
-    /** Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing. */
-    "Idempotency-Key"?: string;
-    file: core.file.Uploadable;
 }

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

@@ -0,0 +1 @@
+export type { GetOutlineRequest } from "./GetOutlineRequest.js";

package/dist/cjs/api/resources/doc/resources/outline/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/doc/resources/outline/exports.d.ts

@@ -0,0 +1,2 @@
+export { OutlineClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/doc/resources/outline/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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.OutlineClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "OutlineClient", { enumerable: true, get: function () { return Client_js_1.OutlineClient; } });
+__exportStar(require("./client/index.js"), exports);

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

@@ -0,0 +1 @@
+export * from "./client/index.js";

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./client/index.js"), exports);

package/dist/cjs/api/resources/doc/resources/pages/client/Client.d.ts

@@ -46,27 +46,7 @@ export declare class PagesClient {
     viewports(request: CloudPDF.doc.ViewportsPagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesViewports200Response>;
     private __viewports;
     /**
-     * @param {CloudPDF.doc.DeletePagesRequest} request
-     * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link CloudPDF.BadRequestError}
-     * @throws {@link CloudPDF.NotFoundError}
-     * @throws {@link errors.CloudPDFError}
-     * @throws {@link errors.CloudPDFTimeoutError}
-     *
-     * @example
-     *     await client.doc.pages.delete({
-     *         docId: "docId",
-     *         layerName: "layerName",
-     *         body: {
-     *             "key": "value"
-     *         }
-     *     })
-     */
-    delete(request: CloudPDF.doc.DeletePagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesDelete200Response>;
-    private __delete;
-    /**
-     * A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[]}`; the response body is the new PDF.
+     * A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[], "flatten"?: {"usage"?: "display" | "print"}, "includeAnnotations"?: boolean, "includeFormFields"?: boolean}`; the response body is the new PDF. With `flatten` the copy is the pages as they draw for `usage` (`"print"`: a print copy): the annotations and form fields painted in, nothing interactive left, layers in their state for the usage. A flattened copy takes `doc.download` or `doc.download.flattened`, and paints only what the caller may read; `includeAnnotations` and `includeFormFields` choose what it paints, and are refused without `flatten`.
      *
      * @throws {@link CloudPDF.BadRequestError}
      * @throws {@link CloudPDF.NotFoundError}
@@ -95,49 +75,6 @@ export declare class PagesClient {
      */
     flatten(request: CloudPDF.doc.FlattenPagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesFlatten200Response>;
     private __flatten;
-    /**
-     * Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source": "<key>"}}` (position omitted → the end), and the standalone PDF whose pages are copied in as the part `resource:<key>`. The inserted copies get fresh page object numbers, returned in insertion order.
-     *
-     * @param {CloudPDF.doc.InsertPagesRequest} request
-     * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link CloudPDF.BadRequestError}
-     * @throws {@link CloudPDF.NotFoundError}
-     * @throws {@link errors.CloudPDFError}
-     * @throws {@link errors.CloudPDFTimeoutError}
-     *
-     * @example
-     *     import { createReadStream } from "fs";
-     *     await client.doc.pages.insert({
-     *         file: fs.createReadStream("/path/to/your/file"),
-     *         docId: "docId",
-     *         layerName: "layerName"
-     *     })
-     */
-    insert(request: CloudPDF.doc.InsertPagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesInsert200Response>;
-    private __insert;
-    /**
-     * Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF points, count in [1, 100], `position` a `PagePosition` (omitted → the end).
-     *
-     * @param {CloudPDF.doc.InsertBlankPagesRequest} request
-     * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link CloudPDF.BadRequestError}
-     * @throws {@link CloudPDF.NotFoundError}
-     * @throws {@link errors.CloudPDFError}
-     * @throws {@link errors.CloudPDFTimeoutError}
-     *
-     * @example
-     *     await client.doc.pages.insertBlank({
-     *         docId: "docId",
-     *         layerName: "layerName",
-     *         body: {
-     *             "key": "value"
-     *         }
-     *     })
-     */
-    insertBlank(request: CloudPDF.doc.InsertBlankPagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesInsertBlank200Response>;
-    private __insertBlank;
     /**
      * @param {CloudPDF.doc.SetNamePagesRequest} request
      * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -178,46 +115,4 @@ export declare class PagesClient {
      */
     removeName(request: CloudPDF.doc.RemoveNamePagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesRemoveName200Response>;
     private __removeName;
-    /**
-     * @param {CloudPDF.doc.DocPagesReorderRequest} request
-     * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link CloudPDF.BadRequestError}
-     * @throws {@link CloudPDF.NotFoundError}
-     * @throws {@link errors.CloudPDFError}
-     * @throws {@link errors.CloudPDFTimeoutError}
-     *
-     * @example
-     *     await client.doc.pages.reorder({
-     *         docId: "docId",
-     *         layerName: "layerName",
-     *         pages: [{
-     *                 kind: "objectNumber",
-     *                 objectNumber: 1
-     *             }],
-     *         position: "start"
-     *     })
-     */
-    reorder(request: CloudPDF.doc.DocPagesReorderRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesReorder200Response>;
-    private __reorder;
-    /**
-     * @param {CloudPDF.doc.RotatePagesRequest} request
-     * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link CloudPDF.BadRequestError}
-     * @throws {@link CloudPDF.NotFoundError}
-     * @throws {@link errors.CloudPDFError}
-     * @throws {@link errors.CloudPDFTimeoutError}
-     *
-     * @example
-     *     await client.doc.pages.rotate({
-     *         docId: "docId",
-     *         layerName: "layerName",
-     *         body: {
-     *             "key": "value"
-     *         }
-     *     })
-     */
-    rotate(request: CloudPDF.doc.RotatePagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesRotate200Response>;
-    private __rotate;
 }