@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
@@ -8,6 +8,14 @@ export * from "./DocAnnotationsCreateRequest.js";
8
8
  export * from "./DocAnnotationsDelete200Response.js";
9
9
  export * from "./DocAnnotationsDelete200ResponseMetaAffectedPagesItemWeakAnnotationState.js";
10
10
  export * from "./DocAnnotationsDelete404Response.js";
11
+ export * from "./DocAnnotationsExportAppearance400Response.js";
12
+ export * from "./DocAnnotationsExportAppearance404Response.js";
13
+ export * from "./DocAnnotationsExportAppearanceRequest.js";
14
+ export * from "./DocAnnotationsFlatten200Response.js";
15
+ export * from "./DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.js";
16
+ export * from "./DocAnnotationsFlatten400Response.js";
17
+ export * from "./DocAnnotationsFlatten404Response.js";
18
+ export * from "./DocAnnotationsFlattenRequest.js";
11
19
  export * from "./DocAnnotationsList200Response.js";
12
20
  export * from "./DocAnnotationsList200ResponseAnnotationsItem.js";
13
21
  export * from "./DocAnnotationsList200ResponseAnnotationsItemCaretInReplyTo.js";
@@ -177,11 +185,21 @@ export * from "./DocPagesMove200ResponseMetaAffectedPagesItemWeakAnnotationState
177
185
  export * from "./DocPagesMove400Response.js";
178
186
  export * from "./DocPagesMove404Response.js";
179
187
  export * from "./DocPagesMoveRequest.js";
188
+ export * from "./DocPagesRemoveName200Response.js";
189
+ export * from "./DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.js";
190
+ export * from "./DocPagesRemoveName400Response.js";
191
+ export * from "./DocPagesRemoveName404Response.js";
192
+ export * from "./DocPagesRemoveNameRequest.js";
180
193
  export * from "./DocPagesRotate200Response.js";
181
194
  export * from "./DocPagesRotate200ResponseMetaAffectedPagesItemWeakAnnotationState.js";
182
195
  export * from "./DocPagesRotate400Response.js";
183
196
  export * from "./DocPagesRotate404Response.js";
184
197
  export * from "./DocPagesRotateRequest.js";
198
+ export * from "./DocPagesSetName200Response.js";
199
+ export * from "./DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.js";
200
+ export * from "./DocPagesSetName400Response.js";
201
+ export * from "./DocPagesSetName404Response.js";
202
+ export * from "./DocPagesSetNameRequest.js";
185
203
  export * from "./DocRedactionsApply200Response.js";
186
204
  export * from "./DocRedactionsApply200ResponseMetaAffectedPagesItemWeakAnnotationState.js";
187
205
  export * from "./DocRedactionsApply400Response.js";
@@ -24,6 +24,14 @@ __exportStar(require("./DocAnnotationsCreateRequest.js"), exports);
24
24
  __exportStar(require("./DocAnnotationsDelete200Response.js"), exports);
25
25
  __exportStar(require("./DocAnnotationsDelete200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
26
26
  __exportStar(require("./DocAnnotationsDelete404Response.js"), exports);
27
+ __exportStar(require("./DocAnnotationsExportAppearance400Response.js"), exports);
28
+ __exportStar(require("./DocAnnotationsExportAppearance404Response.js"), exports);
29
+ __exportStar(require("./DocAnnotationsExportAppearanceRequest.js"), exports);
30
+ __exportStar(require("./DocAnnotationsFlatten200Response.js"), exports);
31
+ __exportStar(require("./DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
32
+ __exportStar(require("./DocAnnotationsFlatten400Response.js"), exports);
33
+ __exportStar(require("./DocAnnotationsFlatten404Response.js"), exports);
34
+ __exportStar(require("./DocAnnotationsFlattenRequest.js"), exports);
27
35
  __exportStar(require("./DocAnnotationsList200Response.js"), exports);
28
36
  __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItem.js"), exports);
29
37
  __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemCaretInReplyTo.js"), exports);
@@ -193,11 +201,21 @@ __exportStar(require("./DocPagesMove200ResponseMetaAffectedPagesItemWeakAnnotati
193
201
  __exportStar(require("./DocPagesMove400Response.js"), exports);
194
202
  __exportStar(require("./DocPagesMove404Response.js"), exports);
195
203
  __exportStar(require("./DocPagesMoveRequest.js"), exports);
204
+ __exportStar(require("./DocPagesRemoveName200Response.js"), exports);
205
+ __exportStar(require("./DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
206
+ __exportStar(require("./DocPagesRemoveName400Response.js"), exports);
207
+ __exportStar(require("./DocPagesRemoveName404Response.js"), exports);
208
+ __exportStar(require("./DocPagesRemoveNameRequest.js"), exports);
196
209
  __exportStar(require("./DocPagesRotate200Response.js"), exports);
197
210
  __exportStar(require("./DocPagesRotate200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
198
211
  __exportStar(require("./DocPagesRotate400Response.js"), exports);
199
212
  __exportStar(require("./DocPagesRotate404Response.js"), exports);
200
213
  __exportStar(require("./DocPagesRotateRequest.js"), exports);
214
+ __exportStar(require("./DocPagesSetName200Response.js"), exports);
215
+ __exportStar(require("./DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
216
+ __exportStar(require("./DocPagesSetName400Response.js"), exports);
217
+ __exportStar(require("./DocPagesSetName404Response.js"), exports);
218
+ __exportStar(require("./DocPagesSetNameRequest.js"), exports);
201
219
  __exportStar(require("./DocRedactionsApply200Response.js"), exports);
202
220
  __exportStar(require("./DocRedactionsApply200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
203
221
  __exportStar(require("./DocRedactionsApply400Response.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "3.0.0-next.11";
1
+ export declare const SDK_VERSION = "3.0.0-next.12";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "3.0.0-next.11";
4
+ exports.SDK_VERSION = "3.0.0-next.12";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@cloudpdf/sdk",
9
- "X-Fern-SDK-Version": "3.0.0-next.11",
10
- "User-Agent": "@cloudpdf/sdk/3.0.0-next.11",
9
+ "X-Fern-SDK-Version": "3.0.0-next.12",
10
+ "User-Agent": "@cloudpdf/sdk/3.0.0-next.12",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, 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
  }
@@ -325,4 +325,119 @@ export class AnnotationsClient {
325
325
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/{annotKey}");
326
326
  });
327
327
  }
328
+ /**
329
+ * @throws {@link CloudPDF.BadRequestError}
330
+ * @throws {@link CloudPDF.NotFoundError}
331
+ * @throws {@link errors.CloudPDFError}
332
+ * @throws {@link errors.CloudPDFTimeoutError}
333
+ */
334
+ exportAppearance(request, requestOptions) {
335
+ return core.HttpResponsePromise.fromPromise(this.__exportAppearance(request, requestOptions));
336
+ }
337
+ __exportAppearance(request, requestOptions) {
338
+ return __awaiter(this, void 0, void 0, function* () {
339
+ var _a, _b, _c, _d, _e, _f, _g, _h;
340
+ const { docId, layerName, pon, "X-Document-Password": documentPassword, body: _body } = request;
341
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
342
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Document-Password": documentPassword }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
343
+ const _response = yield core.fetcher({
344
+ 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`),
345
+ method: "POST",
346
+ headers: _headers,
347
+ contentType: "application/json",
348
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
349
+ requestType: "json",
350
+ body: mergeAdditionalBodyParameters(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
351
+ responseType: "binary-response",
352
+ 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,
353
+ 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,
354
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
355
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
356
+ logging: this._options.logging,
357
+ });
358
+ if (_response.ok) {
359
+ return { data: _response.body, rawResponse: _response.rawResponse };
360
+ }
361
+ if (_response.error.reason === "status-code") {
362
+ switch (_response.error.statusCode) {
363
+ case 400:
364
+ throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
365
+ case 404:
366
+ throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
367
+ default:
368
+ throw new errors.CloudPDFError({
369
+ statusCode: _response.error.statusCode,
370
+ body: _response.error.body,
371
+ rawResponse: _response.rawResponse,
372
+ });
373
+ }
374
+ }
375
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/appearance");
376
+ });
377
+ }
378
+ /**
379
+ * @param {CloudPDF.doc.FlattenAnnotationsRequest} request
380
+ * @param {AnnotationsClient.RequestOptions} requestOptions - Request-specific configuration.
381
+ *
382
+ * @throws {@link CloudPDF.BadRequestError}
383
+ * @throws {@link CloudPDF.NotFoundError}
384
+ * @throws {@link errors.CloudPDFError}
385
+ * @throws {@link errors.CloudPDFTimeoutError}
386
+ *
387
+ * @example
388
+ * await client.doc.annotations.flatten({
389
+ * docId: "docId",
390
+ * layerName: "layerName",
391
+ * pon: 1,
392
+ * body: {
393
+ * "key": "value"
394
+ * }
395
+ * })
396
+ */
397
+ flatten(request, requestOptions) {
398
+ return core.HttpResponsePromise.fromPromise(this.__flatten(request, requestOptions));
399
+ }
400
+ __flatten(request, requestOptions) {
401
+ return __awaiter(this, void 0, void 0, function* () {
402
+ var _a, _b, _c, _d, _e, _f, _g, _h;
403
+ const { docId, layerName, pon, "X-Document-Password": documentPassword, body: _body } = request;
404
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
405
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Document-Password": documentPassword }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
406
+ const _response = yield core.fetcher({
407
+ 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`),
408
+ method: "POST",
409
+ headers: _headers,
410
+ contentType: "application/json",
411
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
412
+ requestType: "json",
413
+ body: mergeAdditionalBodyParameters(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
414
+ 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,
415
+ 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,
416
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
417
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
418
+ logging: this._options.logging,
419
+ });
420
+ if (_response.ok) {
421
+ return {
422
+ data: _response.body,
423
+ rawResponse: _response.rawResponse,
424
+ };
425
+ }
426
+ if (_response.error.reason === "status-code") {
427
+ switch (_response.error.statusCode) {
428
+ case 400:
429
+ throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
430
+ case 404:
431
+ throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
432
+ default:
433
+ throw new errors.CloudPDFError({
434
+ statusCode: _response.error.statusCode,
435
+ body: _response.error.body,
436
+ rawResponse: _response.rawResponse,
437
+ });
438
+ }
439
+ }
440
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/flatten");
441
+ });
442
+ }
328
443
  }
@@ -0,0 +1,22 @@
1
+ import type * as CloudPDF from "../../../../../../index.mjs";
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,20 @@
1
+ import type * as CloudPDF from "../../../../../../index.mjs";
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,5 +1,7 @@
1
1
  export type { CreateAnnotationsRequest } from "./CreateAnnotationsRequest.mjs";
2
2
  export type { DeleteAnnotationsRequest } from "./DeleteAnnotationsRequest.mjs";
3
+ export type { ExportAppearanceAnnotationsRequest } from "./ExportAppearanceAnnotationsRequest.mjs";
4
+ export type { FlattenAnnotationsRequest } from "./FlattenAnnotationsRequest.mjs";
3
5
  export type { ListAllAnnotationsRequest } from "./ListAllAnnotationsRequest.mjs";
4
6
  export type { ListAnnotationsRequest } from "./ListAnnotationsRequest.mjs";
5
7
  export type { UpdateAnnotationsRequest } from "./UpdateAnnotationsRequest.mjs";
@@ -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.
@@ -384,6 +384,131 @@ export class PagesClient {
384
384
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/pages/move");
385
385
  });
386
386
  }
387
+ /**
388
+ * @param {CloudPDF.doc.SetNamePagesRequest} request
389
+ * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
390
+ *
391
+ * @throws {@link CloudPDF.BadRequestError}
392
+ * @throws {@link CloudPDF.NotFoundError}
393
+ * @throws {@link errors.CloudPDFError}
394
+ * @throws {@link errors.CloudPDFTimeoutError}
395
+ *
396
+ * @example
397
+ * await client.doc.pages.setName({
398
+ * docId: "docId",
399
+ * layerName: "layerName",
400
+ * body: {
401
+ * "key": "value"
402
+ * }
403
+ * })
404
+ */
405
+ setName(request, requestOptions) {
406
+ return core.HttpResponsePromise.fromPromise(this.__setName(request, requestOptions));
407
+ }
408
+ __setName(request, requestOptions) {
409
+ return __awaiter(this, void 0, void 0, function* () {
410
+ var _a, _b, _c, _d, _e, _f, _g, _h;
411
+ const { docId, layerName, "X-Document-Password": documentPassword, body: _body } = request;
412
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
413
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Document-Password": documentPassword }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
414
+ const _response = yield core.fetcher({
415
+ 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`),
416
+ method: "POST",
417
+ headers: _headers,
418
+ contentType: "application/json",
419
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
420
+ requestType: "json",
421
+ body: mergeAdditionalBodyParameters(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
422
+ 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,
423
+ 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,
424
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
425
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
426
+ logging: this._options.logging,
427
+ });
428
+ if (_response.ok) {
429
+ return { data: _response.body, rawResponse: _response.rawResponse };
430
+ }
431
+ if (_response.error.reason === "status-code") {
432
+ switch (_response.error.statusCode) {
433
+ case 400:
434
+ throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
435
+ case 404:
436
+ throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
437
+ default:
438
+ throw new errors.CloudPDFError({
439
+ statusCode: _response.error.statusCode,
440
+ body: _response.error.body,
441
+ rawResponse: _response.rawResponse,
442
+ });
443
+ }
444
+ }
445
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/pages/names");
446
+ });
447
+ }
448
+ /**
449
+ * @param {CloudPDF.doc.RemoveNamePagesRequest} request
450
+ * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
451
+ *
452
+ * @throws {@link CloudPDF.BadRequestError}
453
+ * @throws {@link CloudPDF.NotFoundError}
454
+ * @throws {@link errors.CloudPDFError}
455
+ * @throws {@link errors.CloudPDFTimeoutError}
456
+ *
457
+ * @example
458
+ * await client.doc.pages.removeName({
459
+ * docId: "docId",
460
+ * layerName: "layerName",
461
+ * body: {
462
+ * "key": "value"
463
+ * }
464
+ * })
465
+ */
466
+ removeName(request, requestOptions) {
467
+ return core.HttpResponsePromise.fromPromise(this.__removeName(request, requestOptions));
468
+ }
469
+ __removeName(request, requestOptions) {
470
+ return __awaiter(this, void 0, void 0, function* () {
471
+ var _a, _b, _c, _d, _e, _f, _g, _h;
472
+ const { docId, layerName, "X-Document-Password": documentPassword, body: _body } = request;
473
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
474
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Document-Password": documentPassword }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
475
+ const _response = yield core.fetcher({
476
+ 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`),
477
+ method: "POST",
478
+ headers: _headers,
479
+ contentType: "application/json",
480
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
481
+ requestType: "json",
482
+ body: mergeAdditionalBodyParameters(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
483
+ 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,
484
+ 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,
485
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
486
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
487
+ logging: this._options.logging,
488
+ });
489
+ if (_response.ok) {
490
+ return {
491
+ data: _response.body,
492
+ rawResponse: _response.rawResponse,
493
+ };
494
+ }
495
+ if (_response.error.reason === "status-code") {
496
+ switch (_response.error.statusCode) {
497
+ case 400:
498
+ throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
499
+ case 404:
500
+ throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
501
+ default:
502
+ throw new errors.CloudPDFError({
503
+ statusCode: _response.error.statusCode,
504
+ body: _response.error.body,
505
+ rawResponse: _response.rawResponse,
506
+ });
507
+ }
508
+ }
509
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/pages/names/delete");
510
+ });
511
+ }
387
512
  /**
388
513
  * @param {CloudPDF.doc.RotatePagesRequest} request
389
514
  * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -0,0 +1,18 @@
1
+ import type * as CloudPDF from "../../../../../../index.mjs";
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,18 @@
1
+ import type * as CloudPDF from "../../../../../../index.mjs";
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -4,4 +4,6 @@ export type { FlattenPagesRequest } from "./FlattenPagesRequest.mjs";
4
4
  export type { InsertBlankPagesRequest } from "./InsertBlankPagesRequest.mjs";
5
5
  export type { InsertPagesRequest } from "./InsertPagesRequest.mjs";
6
6
  export type { MovePagesRequest } from "./MovePagesRequest.mjs";
7
+ export type { RemoveNamePagesRequest } from "./RemoveNamePagesRequest.mjs";
7
8
  export type { RotatePagesRequest } from "./RotatePagesRequest.mjs";
9
+ export type { SetNamePagesRequest } from "./SetNamePagesRequest.mjs";
@@ -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,28 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var DocAnnotationsExportAppearance400Response;
3
+ (function (DocAnnotationsExportAppearance400Response) {
4
+ DocAnnotationsExportAppearance400Response.Name = {
5
+ EngineError: "EngineError",
6
+ };
7
+ DocAnnotationsExportAppearance400Response.Code = {
8
+ Unknown: "Unknown",
9
+ InvalidArg: "InvalidArg",
10
+ DocNotOpen: "DocNotOpen",
11
+ DocOpenFailed: "DocOpenFailed",
12
+ DocPasswordRequired: "DocPasswordRequired",
13
+ DocPasswordIncorrect: "DocPasswordIncorrect",
14
+ SharePasswordRequired: "SharePasswordRequired",
15
+ Aborted: "Aborted",
16
+ Network: "Network",
17
+ Unauthenticated: "Unauthenticated",
18
+ Forbidden: "Forbidden",
19
+ NotFound: "NotFound",
20
+ WireFormat: "WireFormat",
21
+ RuntimeUnavailable: "RuntimeUnavailable",
22
+ InvalidReference: "InvalidReference",
23
+ WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict",
24
+ LayerVersionConflict: "LayerVersionConflict",
25
+ NotImplemented: "NotImplemented",
26
+ MalformedPdf: "MalformedPdf",
27
+ };
28
+ })(DocAnnotationsExportAppearance400Response || (DocAnnotationsExportAppearance400Response = {}));