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

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.
Files changed (112) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/doc/resources/annotations/client/Client.d.ts +29 -0
  3. package/dist/cjs/api/resources/doc/resources/annotations/client/Client.js +115 -0
  4. package/dist/cjs/api/resources/doc/resources/annotations/client/requests/ExportAppearanceAnnotationsRequest.d.ts +22 -0
  5. package/dist/cjs/api/resources/doc/resources/annotations/client/requests/ExportAppearanceAnnotationsRequest.js +3 -0
  6. package/dist/cjs/api/resources/doc/resources/annotations/client/requests/FlattenAnnotationsRequest.d.ts +20 -0
  7. package/dist/cjs/api/resources/doc/resources/annotations/client/requests/FlattenAnnotationsRequest.js +3 -0
  8. package/dist/cjs/api/resources/doc/resources/annotations/client/requests/index.d.ts +2 -0
  9. package/dist/cjs/api/resources/doc/resources/pages/client/Client.d.ts +40 -0
  10. package/dist/cjs/api/resources/doc/resources/pages/client/Client.js +125 -0
  11. package/dist/cjs/api/resources/doc/resources/pages/client/requests/RemoveNamePagesRequest.d.ts +18 -0
  12. package/dist/cjs/api/resources/doc/resources/pages/client/requests/RemoveNamePagesRequest.js +3 -0
  13. package/dist/cjs/api/resources/doc/resources/pages/client/requests/SetNamePagesRequest.d.ts +18 -0
  14. package/dist/cjs/api/resources/doc/resources/pages/client/requests/SetNamePagesRequest.js +3 -0
  15. package/dist/cjs/api/resources/doc/resources/pages/client/requests/index.d.ts +2 -0
  16. package/dist/cjs/api/types/DocAnnotationsExportAppearance400Response.d.ts +34 -0
  17. package/dist/cjs/api/types/DocAnnotationsExportAppearance400Response.js +31 -0
  18. package/dist/cjs/api/types/DocAnnotationsExportAppearance404Response.d.ts +34 -0
  19. package/dist/cjs/api/types/DocAnnotationsExportAppearance404Response.js +31 -0
  20. package/dist/cjs/api/types/DocAnnotationsExportAppearanceRequest.d.ts +1 -0
  21. package/dist/cjs/api/types/DocAnnotationsExportAppearanceRequest.js +3 -0
  22. package/dist/cjs/api/types/DocAnnotationsFlatten200Response.d.ts +50 -0
  23. package/dist/cjs/api/types/DocAnnotationsFlatten200Response.js +3 -0
  24. package/dist/cjs/api/types/DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.d.ts +11 -0
  25. package/dist/cjs/api/types/DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.js +3 -0
  26. package/dist/cjs/api/types/DocAnnotationsFlatten400Response.d.ts +34 -0
  27. package/dist/cjs/api/types/DocAnnotationsFlatten400Response.js +31 -0
  28. package/dist/cjs/api/types/DocAnnotationsFlatten404Response.d.ts +34 -0
  29. package/dist/cjs/api/types/DocAnnotationsFlatten404Response.js +31 -0
  30. package/dist/cjs/api/types/DocAnnotationsFlattenRequest.d.ts +1 -0
  31. package/dist/cjs/api/types/DocAnnotationsFlattenRequest.js +3 -0
  32. package/dist/cjs/api/types/DocPagesRemoveName200Response.d.ts +50 -0
  33. package/dist/cjs/api/types/DocPagesRemoveName200Response.js +3 -0
  34. package/dist/cjs/api/types/DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.d.ts +11 -0
  35. package/dist/cjs/api/types/DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.js +3 -0
  36. package/dist/cjs/api/types/DocPagesRemoveName400Response.d.ts +34 -0
  37. package/dist/cjs/api/types/DocPagesRemoveName400Response.js +31 -0
  38. package/dist/cjs/api/types/DocPagesRemoveName404Response.d.ts +34 -0
  39. package/dist/cjs/api/types/DocPagesRemoveName404Response.js +31 -0
  40. package/dist/cjs/api/types/DocPagesRemoveNameRequest.d.ts +1 -0
  41. package/dist/cjs/api/types/DocPagesRemoveNameRequest.js +3 -0
  42. package/dist/cjs/api/types/DocPagesSetName200Response.d.ts +50 -0
  43. package/dist/cjs/api/types/DocPagesSetName200Response.js +3 -0
  44. package/dist/cjs/api/types/DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.d.ts +11 -0
  45. package/dist/cjs/api/types/DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.js +3 -0
  46. package/dist/cjs/api/types/DocPagesSetName400Response.d.ts +34 -0
  47. package/dist/cjs/api/types/DocPagesSetName400Response.js +31 -0
  48. package/dist/cjs/api/types/DocPagesSetName404Response.d.ts +34 -0
  49. package/dist/cjs/api/types/DocPagesSetName404Response.js +31 -0
  50. package/dist/cjs/api/types/DocPagesSetNameRequest.d.ts +1 -0
  51. package/dist/cjs/api/types/DocPagesSetNameRequest.js +3 -0
  52. package/dist/cjs/api/types/index.d.ts +18 -0
  53. package/dist/cjs/api/types/index.js +18 -0
  54. package/dist/cjs/version.d.ts +1 -1
  55. package/dist/cjs/version.js +1 -1
  56. package/dist/esm/BaseClient.mjs +2 -2
  57. package/dist/esm/api/resources/doc/resources/annotations/client/Client.d.mts +29 -0
  58. package/dist/esm/api/resources/doc/resources/annotations/client/Client.mjs +115 -0
  59. package/dist/esm/api/resources/doc/resources/annotations/client/requests/ExportAppearanceAnnotationsRequest.d.mts +22 -0
  60. package/dist/esm/api/resources/doc/resources/annotations/client/requests/ExportAppearanceAnnotationsRequest.mjs +2 -0
  61. package/dist/esm/api/resources/doc/resources/annotations/client/requests/FlattenAnnotationsRequest.d.mts +20 -0
  62. package/dist/esm/api/resources/doc/resources/annotations/client/requests/FlattenAnnotationsRequest.mjs +2 -0
  63. package/dist/esm/api/resources/doc/resources/annotations/client/requests/index.d.mts +2 -0
  64. package/dist/esm/api/resources/doc/resources/pages/client/Client.d.mts +40 -0
  65. package/dist/esm/api/resources/doc/resources/pages/client/Client.mjs +125 -0
  66. package/dist/esm/api/resources/doc/resources/pages/client/requests/RemoveNamePagesRequest.d.mts +18 -0
  67. package/dist/esm/api/resources/doc/resources/pages/client/requests/RemoveNamePagesRequest.mjs +2 -0
  68. package/dist/esm/api/resources/doc/resources/pages/client/requests/SetNamePagesRequest.d.mts +18 -0
  69. package/dist/esm/api/resources/doc/resources/pages/client/requests/SetNamePagesRequest.mjs +2 -0
  70. package/dist/esm/api/resources/doc/resources/pages/client/requests/index.d.mts +2 -0
  71. package/dist/esm/api/types/DocAnnotationsExportAppearance400Response.d.mts +34 -0
  72. package/dist/esm/api/types/DocAnnotationsExportAppearance400Response.mjs +28 -0
  73. package/dist/esm/api/types/DocAnnotationsExportAppearance404Response.d.mts +34 -0
  74. package/dist/esm/api/types/DocAnnotationsExportAppearance404Response.mjs +28 -0
  75. package/dist/esm/api/types/DocAnnotationsExportAppearanceRequest.d.mts +1 -0
  76. package/dist/esm/api/types/DocAnnotationsExportAppearanceRequest.mjs +2 -0
  77. package/dist/esm/api/types/DocAnnotationsFlatten200Response.d.mts +50 -0
  78. package/dist/esm/api/types/DocAnnotationsFlatten200Response.mjs +2 -0
  79. package/dist/esm/api/types/DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts +11 -0
  80. package/dist/esm/api/types/DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs +2 -0
  81. package/dist/esm/api/types/DocAnnotationsFlatten400Response.d.mts +34 -0
  82. package/dist/esm/api/types/DocAnnotationsFlatten400Response.mjs +28 -0
  83. package/dist/esm/api/types/DocAnnotationsFlatten404Response.d.mts +34 -0
  84. package/dist/esm/api/types/DocAnnotationsFlatten404Response.mjs +28 -0
  85. package/dist/esm/api/types/DocAnnotationsFlattenRequest.d.mts +1 -0
  86. package/dist/esm/api/types/DocAnnotationsFlattenRequest.mjs +2 -0
  87. package/dist/esm/api/types/DocPagesRemoveName200Response.d.mts +50 -0
  88. package/dist/esm/api/types/DocPagesRemoveName200Response.mjs +2 -0
  89. package/dist/esm/api/types/DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts +11 -0
  90. package/dist/esm/api/types/DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs +2 -0
  91. package/dist/esm/api/types/DocPagesRemoveName400Response.d.mts +34 -0
  92. package/dist/esm/api/types/DocPagesRemoveName400Response.mjs +28 -0
  93. package/dist/esm/api/types/DocPagesRemoveName404Response.d.mts +34 -0
  94. package/dist/esm/api/types/DocPagesRemoveName404Response.mjs +28 -0
  95. package/dist/esm/api/types/DocPagesRemoveNameRequest.d.mts +1 -0
  96. package/dist/esm/api/types/DocPagesRemoveNameRequest.mjs +2 -0
  97. package/dist/esm/api/types/DocPagesSetName200Response.d.mts +50 -0
  98. package/dist/esm/api/types/DocPagesSetName200Response.mjs +2 -0
  99. package/dist/esm/api/types/DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts +11 -0
  100. package/dist/esm/api/types/DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs +2 -0
  101. package/dist/esm/api/types/DocPagesSetName400Response.d.mts +34 -0
  102. package/dist/esm/api/types/DocPagesSetName400Response.mjs +28 -0
  103. package/dist/esm/api/types/DocPagesSetName404Response.d.mts +34 -0
  104. package/dist/esm/api/types/DocPagesSetName404Response.mjs +28 -0
  105. package/dist/esm/api/types/DocPagesSetNameRequest.d.mts +1 -0
  106. package/dist/esm/api/types/DocPagesSetNameRequest.mjs +2 -0
  107. package/dist/esm/api/types/index.d.mts +18 -0
  108. package/dist/esm/api/types/index.mjs +18 -0
  109. package/dist/esm/version.d.mts +1 -1
  110. package/dist/esm/version.mjs +1 -1
  111. package/package.json +1 -1
  112. package/reference.md +224 -0
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@cloudpdf/sdk",
46
- "X-Fern-SDK-Version": "3.0.0-next.11",
47
- "User-Agent": "@cloudpdf/sdk/3.0.0-next.11",
46
+ "X-Fern-SDK-Version": "3.0.0-next.12",
47
+ "User-Agent": "@cloudpdf/sdk/3.0.0-next.12",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -109,4 +109,33 @@ export declare class AnnotationsClient {
109
109
  */
110
110
  update(request: CloudPDF.doc.UpdateAnnotationsRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocAnnotationsUpdate200Response>;
111
111
  private __update;
112
+ /**
113
+ * @throws {@link CloudPDF.BadRequestError}
114
+ * @throws {@link CloudPDF.NotFoundError}
115
+ * @throws {@link errors.CloudPDFError}
116
+ * @throws {@link errors.CloudPDFTimeoutError}
117
+ */
118
+ exportAppearance(request: CloudPDF.doc.ExportAppearanceAnnotationsRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
119
+ private __exportAppearance;
120
+ /**
121
+ * @param {CloudPDF.doc.FlattenAnnotationsRequest} request
122
+ * @param {AnnotationsClient.RequestOptions} requestOptions - Request-specific configuration.
123
+ *
124
+ * @throws {@link CloudPDF.BadRequestError}
125
+ * @throws {@link CloudPDF.NotFoundError}
126
+ * @throws {@link errors.CloudPDFError}
127
+ * @throws {@link errors.CloudPDFTimeoutError}
128
+ *
129
+ * @example
130
+ * await client.doc.annotations.flatten({
131
+ * docId: "docId",
132
+ * layerName: "layerName",
133
+ * pon: 1,
134
+ * body: {
135
+ * "key": "value"
136
+ * }
137
+ * })
138
+ */
139
+ flatten(request: CloudPDF.doc.FlattenAnnotationsRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocAnnotationsFlatten200Response>;
140
+ private __flatten;
112
141
  }
@@ -361,5 +361,120 @@ class AnnotationsClient {
361
361
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/{annotKey}");
362
362
  });
363
363
  }
364
+ /**
365
+ * @throws {@link CloudPDF.BadRequestError}
366
+ * @throws {@link CloudPDF.NotFoundError}
367
+ * @throws {@link errors.CloudPDFError}
368
+ * @throws {@link errors.CloudPDFTimeoutError}
369
+ */
370
+ exportAppearance(request, requestOptions) {
371
+ return core.HttpResponsePromise.fromPromise(this.__exportAppearance(request, requestOptions));
372
+ }
373
+ __exportAppearance(request, requestOptions) {
374
+ return __awaiter(this, void 0, void 0, function* () {
375
+ var _a, _b, _c, _d, _e, _f, _g, _h;
376
+ const { docId, layerName, pon, "X-Document-Password": documentPassword, body: _body } = request;
377
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
378
+ 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);
379
+ const _response = yield core.fetcher({
380
+ 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)}/annotations/pages/${core.url.encodePathParam(pon)}/items/appearance`),
381
+ method: "POST",
382
+ headers: _headers,
383
+ contentType: "application/json",
384
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
385
+ requestType: "json",
386
+ body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
387
+ responseType: "binary-response",
388
+ 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,
389
+ 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,
390
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
391
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
392
+ logging: this._options.logging,
393
+ });
394
+ if (_response.ok) {
395
+ return { data: _response.body, rawResponse: _response.rawResponse };
396
+ }
397
+ if (_response.error.reason === "status-code") {
398
+ switch (_response.error.statusCode) {
399
+ case 400:
400
+ throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
401
+ case 404:
402
+ throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
403
+ default:
404
+ throw new errors.CloudPDFError({
405
+ statusCode: _response.error.statusCode,
406
+ body: _response.error.body,
407
+ rawResponse: _response.rawResponse,
408
+ });
409
+ }
410
+ }
411
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/appearance");
412
+ });
413
+ }
414
+ /**
415
+ * @param {CloudPDF.doc.FlattenAnnotationsRequest} request
416
+ * @param {AnnotationsClient.RequestOptions} requestOptions - Request-specific configuration.
417
+ *
418
+ * @throws {@link CloudPDF.BadRequestError}
419
+ * @throws {@link CloudPDF.NotFoundError}
420
+ * @throws {@link errors.CloudPDFError}
421
+ * @throws {@link errors.CloudPDFTimeoutError}
422
+ *
423
+ * @example
424
+ * await client.doc.annotations.flatten({
425
+ * docId: "docId",
426
+ * layerName: "layerName",
427
+ * pon: 1,
428
+ * body: {
429
+ * "key": "value"
430
+ * }
431
+ * })
432
+ */
433
+ flatten(request, requestOptions) {
434
+ return core.HttpResponsePromise.fromPromise(this.__flatten(request, requestOptions));
435
+ }
436
+ __flatten(request, requestOptions) {
437
+ return __awaiter(this, void 0, void 0, function* () {
438
+ var _a, _b, _c, _d, _e, _f, _g, _h;
439
+ const { docId, layerName, pon, "X-Document-Password": documentPassword, body: _body } = request;
440
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
441
+ 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);
442
+ const _response = yield core.fetcher({
443
+ 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)}/annotations/pages/${core.url.encodePathParam(pon)}/items/flatten`),
444
+ method: "POST",
445
+ headers: _headers,
446
+ contentType: "application/json",
447
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
448
+ requestType: "json",
449
+ body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
450
+ 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,
451
+ 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,
452
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
453
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
454
+ logging: this._options.logging,
455
+ });
456
+ if (_response.ok) {
457
+ return {
458
+ data: _response.body,
459
+ rawResponse: _response.rawResponse,
460
+ };
461
+ }
462
+ if (_response.error.reason === "status-code") {
463
+ switch (_response.error.statusCode) {
464
+ case 400:
465
+ throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
466
+ case 404:
467
+ throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
468
+ default:
469
+ throw new errors.CloudPDFError({
470
+ statusCode: _response.error.statusCode,
471
+ body: _response.error.body,
472
+ rawResponse: _response.rawResponse,
473
+ });
474
+ }
475
+ }
476
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/flatten");
477
+ });
478
+ }
364
479
  }
365
480
  exports.AnnotationsClient = AnnotationsClient;
@@ -0,0 +1,22 @@
1
+ import type * as CloudPDF from "../../../../../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * docId: "docId",
6
+ * layerName: "layerName",
7
+ * pon: 1,
8
+ * body: {
9
+ * "string": {
10
+ * "key": "value"
11
+ * }
12
+ * }
13
+ * }
14
+ */
15
+ export interface ExportAppearanceAnnotationsRequest {
16
+ docId: string;
17
+ layerName: string;
18
+ pon: number;
19
+ /** 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. */
20
+ "X-Document-Password"?: string;
21
+ body: CloudPDF.DocAnnotationsExportAppearanceRequest;
22
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,20 @@
1
+ import type * as CloudPDF from "../../../../../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * docId: "docId",
6
+ * layerName: "layerName",
7
+ * pon: 1,
8
+ * body: {
9
+ * "key": "value"
10
+ * }
11
+ * }
12
+ */
13
+ export interface FlattenAnnotationsRequest {
14
+ docId: string;
15
+ layerName: string;
16
+ pon: number;
17
+ /** 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. */
18
+ "X-Document-Password"?: string;
19
+ body: CloudPDF.DocAnnotationsFlattenRequest;
20
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,5 +1,7 @@
1
1
  export type { CreateAnnotationsRequest } from "./CreateAnnotationsRequest.js";
2
2
  export type { DeleteAnnotationsRequest } from "./DeleteAnnotationsRequest.js";
3
+ export type { ExportAppearanceAnnotationsRequest } from "./ExportAppearanceAnnotationsRequest.js";
4
+ export type { FlattenAnnotationsRequest } from "./FlattenAnnotationsRequest.js";
3
5
  export type { ListAllAnnotationsRequest } from "./ListAllAnnotationsRequest.js";
4
6
  export type { ListAnnotationsRequest } from "./ListAnnotationsRequest.js";
5
7
  export type { UpdateAnnotationsRequest } from "./UpdateAnnotationsRequest.js";
@@ -123,6 +123,46 @@ export declare class PagesClient {
123
123
  */
124
124
  move(request: CloudPDF.doc.MovePagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesMove200Response>;
125
125
  private __move;
126
+ /**
127
+ * @param {CloudPDF.doc.SetNamePagesRequest} request
128
+ * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
129
+ *
130
+ * @throws {@link CloudPDF.BadRequestError}
131
+ * @throws {@link CloudPDF.NotFoundError}
132
+ * @throws {@link errors.CloudPDFError}
133
+ * @throws {@link errors.CloudPDFTimeoutError}
134
+ *
135
+ * @example
136
+ * await client.doc.pages.setName({
137
+ * docId: "docId",
138
+ * layerName: "layerName",
139
+ * body: {
140
+ * "key": "value"
141
+ * }
142
+ * })
143
+ */
144
+ setName(request: CloudPDF.doc.SetNamePagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesSetName200Response>;
145
+ private __setName;
146
+ /**
147
+ * @param {CloudPDF.doc.RemoveNamePagesRequest} request
148
+ * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
149
+ *
150
+ * @throws {@link CloudPDF.BadRequestError}
151
+ * @throws {@link CloudPDF.NotFoundError}
152
+ * @throws {@link errors.CloudPDFError}
153
+ * @throws {@link errors.CloudPDFTimeoutError}
154
+ *
155
+ * @example
156
+ * await client.doc.pages.removeName({
157
+ * docId: "docId",
158
+ * layerName: "layerName",
159
+ * body: {
160
+ * "key": "value"
161
+ * }
162
+ * })
163
+ */
164
+ removeName(request: CloudPDF.doc.RemoveNamePagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesRemoveName200Response>;
165
+ private __removeName;
126
166
  /**
127
167
  * @param {CloudPDF.doc.RotatePagesRequest} request
128
168
  * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -420,6 +420,131 @@ class PagesClient {
420
420
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/pages/move");
421
421
  });
422
422
  }
423
+ /**
424
+ * @param {CloudPDF.doc.SetNamePagesRequest} request
425
+ * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
426
+ *
427
+ * @throws {@link CloudPDF.BadRequestError}
428
+ * @throws {@link CloudPDF.NotFoundError}
429
+ * @throws {@link errors.CloudPDFError}
430
+ * @throws {@link errors.CloudPDFTimeoutError}
431
+ *
432
+ * @example
433
+ * await client.doc.pages.setName({
434
+ * docId: "docId",
435
+ * layerName: "layerName",
436
+ * body: {
437
+ * "key": "value"
438
+ * }
439
+ * })
440
+ */
441
+ setName(request, requestOptions) {
442
+ return core.HttpResponsePromise.fromPromise(this.__setName(request, requestOptions));
443
+ }
444
+ __setName(request, requestOptions) {
445
+ return __awaiter(this, void 0, void 0, function* () {
446
+ var _a, _b, _c, _d, _e, _f, _g, _h;
447
+ const { docId, layerName, "X-Document-Password": documentPassword, body: _body } = request;
448
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
449
+ 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);
450
+ const _response = yield core.fetcher({
451
+ 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)}/pages/names`),
452
+ method: "POST",
453
+ headers: _headers,
454
+ contentType: "application/json",
455
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
456
+ requestType: "json",
457
+ body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
458
+ 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,
459
+ 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,
460
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
461
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
462
+ logging: this._options.logging,
463
+ });
464
+ if (_response.ok) {
465
+ return { data: _response.body, rawResponse: _response.rawResponse };
466
+ }
467
+ if (_response.error.reason === "status-code") {
468
+ switch (_response.error.statusCode) {
469
+ case 400:
470
+ throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
471
+ case 404:
472
+ throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
473
+ default:
474
+ throw new errors.CloudPDFError({
475
+ statusCode: _response.error.statusCode,
476
+ body: _response.error.body,
477
+ rawResponse: _response.rawResponse,
478
+ });
479
+ }
480
+ }
481
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/pages/names");
482
+ });
483
+ }
484
+ /**
485
+ * @param {CloudPDF.doc.RemoveNamePagesRequest} request
486
+ * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
487
+ *
488
+ * @throws {@link CloudPDF.BadRequestError}
489
+ * @throws {@link CloudPDF.NotFoundError}
490
+ * @throws {@link errors.CloudPDFError}
491
+ * @throws {@link errors.CloudPDFTimeoutError}
492
+ *
493
+ * @example
494
+ * await client.doc.pages.removeName({
495
+ * docId: "docId",
496
+ * layerName: "layerName",
497
+ * body: {
498
+ * "key": "value"
499
+ * }
500
+ * })
501
+ */
502
+ removeName(request, requestOptions) {
503
+ return core.HttpResponsePromise.fromPromise(this.__removeName(request, requestOptions));
504
+ }
505
+ __removeName(request, requestOptions) {
506
+ return __awaiter(this, void 0, void 0, function* () {
507
+ var _a, _b, _c, _d, _e, _f, _g, _h;
508
+ const { docId, layerName, "X-Document-Password": documentPassword, body: _body } = request;
509
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
510
+ 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);
511
+ const _response = yield core.fetcher({
512
+ 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)}/pages/names/delete`),
513
+ method: "POST",
514
+ headers: _headers,
515
+ contentType: "application/json",
516
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
517
+ requestType: "json",
518
+ body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
519
+ 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,
520
+ 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,
521
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
522
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
523
+ logging: this._options.logging,
524
+ });
525
+ if (_response.ok) {
526
+ return {
527
+ data: _response.body,
528
+ rawResponse: _response.rawResponse,
529
+ };
530
+ }
531
+ if (_response.error.reason === "status-code") {
532
+ switch (_response.error.statusCode) {
533
+ case 400:
534
+ throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
535
+ case 404:
536
+ throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
537
+ default:
538
+ throw new errors.CloudPDFError({
539
+ statusCode: _response.error.statusCode,
540
+ body: _response.error.body,
541
+ rawResponse: _response.rawResponse,
542
+ });
543
+ }
544
+ }
545
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/pages/names/delete");
546
+ });
547
+ }
423
548
  /**
424
549
  * @param {CloudPDF.doc.RotatePagesRequest} request
425
550
  * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -0,0 +1,18 @@
1
+ import type * as CloudPDF from "../../../../../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * docId: "docId",
6
+ * layerName: "layerName",
7
+ * body: {
8
+ * "key": "value"
9
+ * }
10
+ * }
11
+ */
12
+ export interface RemoveNamePagesRequest {
13
+ docId: string;
14
+ layerName: string;
15
+ /** 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. */
16
+ "X-Document-Password"?: string;
17
+ body: CloudPDF.DocPagesRemoveNameRequest;
18
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,18 @@
1
+ import type * as CloudPDF from "../../../../../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * docId: "docId",
6
+ * layerName: "layerName",
7
+ * body: {
8
+ * "key": "value"
9
+ * }
10
+ * }
11
+ */
12
+ export interface SetNamePagesRequest {
13
+ docId: string;
14
+ layerName: string;
15
+ /** 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. */
16
+ "X-Document-Password"?: string;
17
+ body: CloudPDF.DocPagesSetNameRequest;
18
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -4,4 +4,6 @@ export type { FlattenPagesRequest } from "./FlattenPagesRequest.js";
4
4
  export type { InsertBlankPagesRequest } from "./InsertBlankPagesRequest.js";
5
5
  export type { InsertPagesRequest } from "./InsertPagesRequest.js";
6
6
  export type { MovePagesRequest } from "./MovePagesRequest.js";
7
+ export type { RemoveNamePagesRequest } from "./RemoveNamePagesRequest.js";
7
8
  export type { RotatePagesRequest } from "./RotatePagesRequest.js";
9
+ export type { SetNamePagesRequest } from "./SetNamePagesRequest.js";
@@ -0,0 +1,34 @@
1
+ export interface DocAnnotationsExportAppearance400Response {
2
+ name: DocAnnotationsExportAppearance400Response.Name;
3
+ code: DocAnnotationsExportAppearance400Response.Code;
4
+ message: string;
5
+ details?: Record<string, unknown> | undefined;
6
+ }
7
+ export declare namespace DocAnnotationsExportAppearance400Response {
8
+ const Name: {
9
+ readonly EngineError: "EngineError";
10
+ };
11
+ type Name = (typeof Name)[keyof typeof Name];
12
+ const Code: {
13
+ readonly Unknown: "Unknown";
14
+ readonly InvalidArg: "InvalidArg";
15
+ readonly DocNotOpen: "DocNotOpen";
16
+ readonly DocOpenFailed: "DocOpenFailed";
17
+ readonly DocPasswordRequired: "DocPasswordRequired";
18
+ readonly DocPasswordIncorrect: "DocPasswordIncorrect";
19
+ readonly SharePasswordRequired: "SharePasswordRequired";
20
+ readonly Aborted: "Aborted";
21
+ readonly Network: "Network";
22
+ readonly Unauthenticated: "Unauthenticated";
23
+ readonly Forbidden: "Forbidden";
24
+ readonly NotFound: "NotFound";
25
+ readonly WireFormat: "WireFormat";
26
+ readonly RuntimeUnavailable: "RuntimeUnavailable";
27
+ readonly InvalidReference: "InvalidReference";
28
+ readonly WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict";
29
+ readonly LayerVersionConflict: "LayerVersionConflict";
30
+ readonly NotImplemented: "NotImplemented";
31
+ readonly MalformedPdf: "MalformedPdf";
32
+ };
33
+ type Code = (typeof Code)[keyof typeof Code];
34
+ }
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.DocAnnotationsExportAppearance400Response = void 0;
5
+ var DocAnnotationsExportAppearance400Response;
6
+ (function (DocAnnotationsExportAppearance400Response) {
7
+ DocAnnotationsExportAppearance400Response.Name = {
8
+ EngineError: "EngineError",
9
+ };
10
+ DocAnnotationsExportAppearance400Response.Code = {
11
+ Unknown: "Unknown",
12
+ InvalidArg: "InvalidArg",
13
+ DocNotOpen: "DocNotOpen",
14
+ DocOpenFailed: "DocOpenFailed",
15
+ DocPasswordRequired: "DocPasswordRequired",
16
+ DocPasswordIncorrect: "DocPasswordIncorrect",
17
+ SharePasswordRequired: "SharePasswordRequired",
18
+ Aborted: "Aborted",
19
+ Network: "Network",
20
+ Unauthenticated: "Unauthenticated",
21
+ Forbidden: "Forbidden",
22
+ NotFound: "NotFound",
23
+ WireFormat: "WireFormat",
24
+ RuntimeUnavailable: "RuntimeUnavailable",
25
+ InvalidReference: "InvalidReference",
26
+ WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict",
27
+ LayerVersionConflict: "LayerVersionConflict",
28
+ NotImplemented: "NotImplemented",
29
+ MalformedPdf: "MalformedPdf",
30
+ };
31
+ })(DocAnnotationsExportAppearance400Response || (exports.DocAnnotationsExportAppearance400Response = DocAnnotationsExportAppearance400Response = {}));
@@ -0,0 +1,34 @@
1
+ export interface DocAnnotationsExportAppearance404Response {
2
+ name: DocAnnotationsExportAppearance404Response.Name;
3
+ code: DocAnnotationsExportAppearance404Response.Code;
4
+ message: string;
5
+ details?: Record<string, unknown> | undefined;
6
+ }
7
+ export declare namespace DocAnnotationsExportAppearance404Response {
8
+ const Name: {
9
+ readonly EngineError: "EngineError";
10
+ };
11
+ type Name = (typeof Name)[keyof typeof Name];
12
+ const Code: {
13
+ readonly Unknown: "Unknown";
14
+ readonly InvalidArg: "InvalidArg";
15
+ readonly DocNotOpen: "DocNotOpen";
16
+ readonly DocOpenFailed: "DocOpenFailed";
17
+ readonly DocPasswordRequired: "DocPasswordRequired";
18
+ readonly DocPasswordIncorrect: "DocPasswordIncorrect";
19
+ readonly SharePasswordRequired: "SharePasswordRequired";
20
+ readonly Aborted: "Aborted";
21
+ readonly Network: "Network";
22
+ readonly Unauthenticated: "Unauthenticated";
23
+ readonly Forbidden: "Forbidden";
24
+ readonly NotFound: "NotFound";
25
+ readonly WireFormat: "WireFormat";
26
+ readonly RuntimeUnavailable: "RuntimeUnavailable";
27
+ readonly InvalidReference: "InvalidReference";
28
+ readonly WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict";
29
+ readonly LayerVersionConflict: "LayerVersionConflict";
30
+ readonly NotImplemented: "NotImplemented";
31
+ readonly MalformedPdf: "MalformedPdf";
32
+ };
33
+ type Code = (typeof Code)[keyof typeof Code];
34
+ }
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.DocAnnotationsExportAppearance404Response = void 0;
5
+ var DocAnnotationsExportAppearance404Response;
6
+ (function (DocAnnotationsExportAppearance404Response) {
7
+ DocAnnotationsExportAppearance404Response.Name = {
8
+ EngineError: "EngineError",
9
+ };
10
+ DocAnnotationsExportAppearance404Response.Code = {
11
+ Unknown: "Unknown",
12
+ InvalidArg: "InvalidArg",
13
+ DocNotOpen: "DocNotOpen",
14
+ DocOpenFailed: "DocOpenFailed",
15
+ DocPasswordRequired: "DocPasswordRequired",
16
+ DocPasswordIncorrect: "DocPasswordIncorrect",
17
+ SharePasswordRequired: "SharePasswordRequired",
18
+ Aborted: "Aborted",
19
+ Network: "Network",
20
+ Unauthenticated: "Unauthenticated",
21
+ Forbidden: "Forbidden",
22
+ NotFound: "NotFound",
23
+ WireFormat: "WireFormat",
24
+ RuntimeUnavailable: "RuntimeUnavailable",
25
+ InvalidReference: "InvalidReference",
26
+ WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict",
27
+ LayerVersionConflict: "LayerVersionConflict",
28
+ NotImplemented: "NotImplemented",
29
+ MalformedPdf: "MalformedPdf",
30
+ };
31
+ })(DocAnnotationsExportAppearance404Response || (exports.DocAnnotationsExportAppearance404Response = DocAnnotationsExportAppearance404Response = {}));
@@ -0,0 +1 @@
1
+ export type DocAnnotationsExportAppearanceRequest = Record<string, unknown>;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });