@cloudpdf/sdk 3.0.0-next.10 → 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 (162) 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/FlattenAnnotationsRequest.d.ts +20 -0
  6. package/dist/cjs/api/resources/doc/resources/annotations/client/requests/index.d.ts +2 -0
  7. package/dist/cjs/api/resources/doc/resources/pages/client/Client.d.ts +40 -0
  8. package/dist/cjs/api/resources/doc/resources/pages/client/Client.js +125 -0
  9. package/dist/cjs/api/resources/doc/resources/pages/client/requests/RemoveNamePagesRequest.d.ts +18 -0
  10. package/dist/cjs/api/resources/doc/resources/pages/client/requests/RemoveNamePagesRequest.js +3 -0
  11. package/dist/cjs/api/resources/doc/resources/pages/client/requests/SetNamePagesRequest.d.ts +18 -0
  12. package/dist/cjs/api/resources/doc/resources/pages/client/requests/SetNamePagesRequest.js +3 -0
  13. package/dist/cjs/api/resources/doc/resources/pages/client/requests/index.d.ts +2 -0
  14. package/dist/cjs/api/types/DocAnnotationsExportAppearance400Response.d.ts +34 -0
  15. package/dist/cjs/api/types/DocAnnotationsExportAppearance400Response.js +31 -0
  16. package/dist/cjs/api/types/DocAnnotationsExportAppearance404Response.d.ts +34 -0
  17. package/dist/cjs/api/types/DocAnnotationsExportAppearance404Response.js +31 -0
  18. package/dist/cjs/api/types/DocAnnotationsExportAppearanceRequest.d.ts +1 -0
  19. package/dist/cjs/api/types/DocAnnotationsExportAppearanceRequest.js +3 -0
  20. package/dist/cjs/api/types/DocAnnotationsFlatten200Response.d.ts +50 -0
  21. package/dist/cjs/api/types/DocAnnotationsFlatten200Response.js +3 -0
  22. package/dist/cjs/api/types/DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.d.ts +11 -0
  23. package/dist/cjs/api/types/DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.js +3 -0
  24. package/dist/cjs/api/types/DocAnnotationsFlatten400Response.d.ts +34 -0
  25. package/dist/cjs/api/types/DocAnnotationsFlatten400Response.js +31 -0
  26. package/dist/cjs/api/types/DocAnnotationsFlatten404Response.d.ts +34 -0
  27. package/dist/cjs/api/types/DocAnnotationsFlatten404Response.js +31 -0
  28. package/dist/cjs/api/types/DocAnnotationsFlattenRequest.d.ts +1 -0
  29. package/dist/cjs/api/types/DocAnnotationsFlattenRequest.js +3 -0
  30. package/dist/cjs/api/types/DocAnnotationsList200ResponseAnnotationsItem.d.ts +78 -10186
  31. package/dist/cjs/api/types/DocAnnotationsList200ResponseAnnotationsItem.js +0 -7372
  32. package/dist/cjs/api/types/DocAnnotationsList200ResponseAnnotationsItemLinkTarget.d.ts +1 -1
  33. package/dist/cjs/api/types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItem.d.ts +78 -10186
  34. package/dist/cjs/api/types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItem.js +0 -7372
  35. package/dist/cjs/api/types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkTarget.d.ts +1 -1
  36. package/dist/cjs/api/types/DocFormsGet200ResponseFieldsItem.d.ts +8 -1576
  37. package/dist/cjs/api/types/DocFormsGet200ResponseFieldsItem.js +0 -1144
  38. package/dist/cjs/api/types/DocPagesRemoveName200Response.d.ts +50 -0
  39. package/dist/cjs/api/types/DocPagesRemoveName200Response.js +3 -0
  40. package/dist/cjs/api/types/DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.d.ts +11 -0
  41. package/dist/cjs/api/types/DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.js +3 -0
  42. package/dist/cjs/api/types/DocPagesRemoveName400Response.d.ts +34 -0
  43. package/dist/cjs/api/types/DocPagesRemoveName400Response.js +31 -0
  44. package/dist/cjs/api/types/DocPagesRemoveName404Response.d.ts +34 -0
  45. package/dist/cjs/api/types/DocPagesRemoveName404Response.js +31 -0
  46. package/dist/cjs/api/types/DocPagesRemoveNameRequest.d.ts +1 -0
  47. package/dist/cjs/api/types/DocPagesRemoveNameRequest.js +3 -0
  48. package/dist/cjs/api/types/DocPagesSetName200Response.d.ts +50 -0
  49. package/dist/cjs/api/types/DocPagesSetName200Response.js +3 -0
  50. package/dist/cjs/api/types/DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.d.ts +11 -0
  51. package/dist/cjs/api/types/DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.js +3 -0
  52. package/dist/cjs/api/types/DocPagesSetName400Response.d.ts +34 -0
  53. package/dist/cjs/api/types/DocPagesSetName400Response.js +31 -0
  54. package/dist/cjs/api/types/DocPagesSetName404Response.d.ts +34 -0
  55. package/dist/cjs/api/types/DocPagesSetName404Response.js +31 -0
  56. package/dist/cjs/api/types/DocPagesSetNameRequest.d.ts +1 -0
  57. package/dist/cjs/api/types/DocPagesSetNameRequest.js +3 -0
  58. package/dist/cjs/api/types/DocumentActionsSnapshot.d.ts +20 -0
  59. package/dist/cjs/api/types/DocumentActionsSnapshot.js +3 -0
  60. package/dist/cjs/api/types/PdfActionNode.d.ts +151 -0
  61. package/dist/cjs/api/types/PdfActionNode.js +26 -0
  62. package/dist/cjs/api/types/PdfActionTargetRef.d.ts +12 -0
  63. package/dist/cjs/api/types/PdfActionTargetRef.js +3 -0
  64. package/dist/cjs/api/types/PdfActionTree.d.ts +19 -0
  65. package/dist/cjs/api/types/PdfActionTree.js +16 -0
  66. package/dist/cjs/api/types/PdfAnnotationActions.d.ts +14 -0
  67. package/dist/cjs/api/types/PdfAnnotationActions.js +3 -0
  68. package/dist/cjs/api/types/{DocAnnotationsList200ResponseAnnotationsItemLinkTargetGotoDestination.d.ts → PdfDestination.d.ts} +2 -2
  69. package/dist/cjs/api/types/PdfDestination.js +3 -0
  70. package/dist/cjs/api/types/PdfFieldActions.d.ts +7 -0
  71. package/dist/cjs/api/types/PdfFieldActions.js +3 -0
  72. package/dist/cjs/api/types/PdfPageActions.d.ts +5 -0
  73. package/dist/cjs/api/types/PdfPageActions.js +3 -0
  74. package/dist/cjs/api/types/index.d.ts +26 -2
  75. package/dist/cjs/api/types/index.js +26 -2
  76. package/dist/cjs/version.d.ts +1 -1
  77. package/dist/cjs/version.js +1 -1
  78. package/dist/esm/BaseClient.mjs +2 -2
  79. package/dist/esm/api/resources/doc/resources/annotations/client/Client.d.mts +29 -0
  80. package/dist/esm/api/resources/doc/resources/annotations/client/Client.mjs +115 -0
  81. package/dist/esm/api/resources/doc/resources/annotations/client/requests/ExportAppearanceAnnotationsRequest.d.mts +22 -0
  82. package/dist/esm/api/resources/doc/resources/annotations/client/requests/FlattenAnnotationsRequest.d.mts +20 -0
  83. package/dist/esm/api/resources/doc/resources/annotations/client/requests/index.d.mts +2 -0
  84. package/dist/esm/api/resources/doc/resources/pages/client/Client.d.mts +40 -0
  85. package/dist/esm/api/resources/doc/resources/pages/client/Client.mjs +125 -0
  86. package/dist/esm/api/resources/doc/resources/pages/client/requests/RemoveNamePagesRequest.d.mts +18 -0
  87. package/dist/esm/api/resources/doc/resources/pages/client/requests/RemoveNamePagesRequest.mjs +2 -0
  88. package/dist/esm/api/resources/doc/resources/pages/client/requests/SetNamePagesRequest.d.mts +18 -0
  89. package/dist/esm/api/resources/doc/resources/pages/client/requests/SetNamePagesRequest.mjs +2 -0
  90. package/dist/esm/api/resources/doc/resources/pages/client/requests/index.d.mts +2 -0
  91. package/dist/esm/api/types/DocAnnotationsExportAppearance400Response.d.mts +34 -0
  92. package/dist/esm/api/types/DocAnnotationsExportAppearance400Response.mjs +28 -0
  93. package/dist/esm/api/types/DocAnnotationsExportAppearance404Response.d.mts +34 -0
  94. package/dist/esm/api/types/DocAnnotationsExportAppearance404Response.mjs +28 -0
  95. package/dist/esm/api/types/DocAnnotationsExportAppearanceRequest.d.mts +1 -0
  96. package/dist/esm/api/types/DocAnnotationsExportAppearanceRequest.mjs +2 -0
  97. package/dist/esm/api/types/DocAnnotationsFlatten200Response.d.mts +50 -0
  98. package/dist/esm/api/types/DocAnnotationsFlatten200Response.mjs +2 -0
  99. package/dist/esm/api/types/DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts +11 -0
  100. package/dist/esm/api/types/DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs +2 -0
  101. package/dist/esm/api/types/DocAnnotationsFlatten400Response.d.mts +34 -0
  102. package/dist/esm/api/types/DocAnnotationsFlatten400Response.mjs +28 -0
  103. package/dist/esm/api/types/DocAnnotationsFlatten404Response.d.mts +34 -0
  104. package/dist/esm/api/types/DocAnnotationsFlatten404Response.mjs +28 -0
  105. package/dist/esm/api/types/DocAnnotationsFlattenRequest.d.mts +1 -0
  106. package/dist/esm/api/types/DocAnnotationsFlattenRequest.mjs +2 -0
  107. package/dist/esm/api/types/DocAnnotationsList200ResponseAnnotationsItem.d.mts +78 -10186
  108. package/dist/esm/api/types/DocAnnotationsList200ResponseAnnotationsItem.mjs +0 -7372
  109. package/dist/esm/api/types/DocAnnotationsList200ResponseAnnotationsItemLinkTarget.d.mts +1 -1
  110. package/dist/esm/api/types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItem.d.mts +78 -10186
  111. package/dist/esm/api/types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItem.mjs +0 -7372
  112. package/dist/esm/api/types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkTarget.d.mts +1 -1
  113. package/dist/esm/api/types/DocFormsGet200ResponseFieldsItem.d.mts +8 -1576
  114. package/dist/esm/api/types/DocFormsGet200ResponseFieldsItem.mjs +0 -1144
  115. package/dist/esm/api/types/DocPagesRemoveName200Response.d.mts +50 -0
  116. package/dist/esm/api/types/DocPagesRemoveName200Response.mjs +2 -0
  117. package/dist/esm/api/types/DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts +11 -0
  118. package/dist/esm/api/types/DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs +2 -0
  119. package/dist/esm/api/types/DocPagesRemoveName400Response.d.mts +34 -0
  120. package/dist/esm/api/types/DocPagesRemoveName400Response.mjs +28 -0
  121. package/dist/esm/api/types/DocPagesRemoveName404Response.d.mts +34 -0
  122. package/dist/esm/api/types/DocPagesRemoveName404Response.mjs +28 -0
  123. package/dist/esm/api/types/DocPagesRemoveNameRequest.d.mts +1 -0
  124. package/dist/esm/api/types/DocPagesRemoveNameRequest.mjs +2 -0
  125. package/dist/esm/api/types/DocPagesSetName200Response.d.mts +50 -0
  126. package/dist/esm/api/types/DocPagesSetName200Response.mjs +2 -0
  127. package/dist/esm/api/types/DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts +11 -0
  128. package/dist/esm/api/types/DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs +2 -0
  129. package/dist/esm/api/types/DocPagesSetName400Response.d.mts +34 -0
  130. package/dist/esm/api/types/DocPagesSetName400Response.mjs +28 -0
  131. package/dist/esm/api/types/DocPagesSetName404Response.d.mts +34 -0
  132. package/dist/esm/api/types/DocPagesSetName404Response.mjs +28 -0
  133. package/dist/esm/api/types/DocPagesSetNameRequest.d.mts +1 -0
  134. package/dist/esm/api/types/DocPagesSetNameRequest.mjs +2 -0
  135. package/dist/esm/api/types/DocumentActionsSnapshot.d.mts +20 -0
  136. package/dist/esm/api/types/DocumentActionsSnapshot.mjs +2 -0
  137. package/dist/esm/api/types/PdfActionNode.d.mts +151 -0
  138. package/dist/esm/api/types/PdfActionNode.mjs +23 -0
  139. package/dist/esm/api/types/PdfActionTargetRef.d.mts +12 -0
  140. package/dist/esm/api/types/PdfActionTargetRef.mjs +2 -0
  141. package/dist/esm/api/types/PdfActionTree.d.mts +19 -0
  142. package/dist/esm/api/types/PdfActionTree.mjs +13 -0
  143. package/dist/esm/api/types/PdfAnnotationActions.d.mts +14 -0
  144. package/dist/esm/api/types/PdfAnnotationActions.mjs +2 -0
  145. package/dist/esm/api/types/{DocAnnotationsList200ResponseAnnotationsItemLinkTargetGotoDestination.d.mts → PdfDestination.d.mts} +2 -2
  146. package/dist/esm/api/types/PdfDestination.mjs +2 -0
  147. package/dist/esm/api/types/PdfFieldActions.d.mts +7 -0
  148. package/dist/esm/api/types/PdfFieldActions.mjs +2 -0
  149. package/dist/esm/api/types/PdfPageActions.d.mts +5 -0
  150. package/dist/esm/api/types/PdfPageActions.mjs +2 -0
  151. package/dist/esm/api/types/index.d.mts +26 -2
  152. package/dist/esm/api/types/index.mjs +26 -2
  153. package/dist/esm/version.d.mts +1 -1
  154. package/dist/esm/version.mjs +1 -1
  155. package/package.json +1 -1
  156. package/reference.md +224 -0
  157. package/dist/cjs/api/types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkTargetGotoDestination.d.ts +0 -47
  158. package/dist/esm/api/types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkTargetGotoDestination.d.mts +0 -47
  159. /package/dist/cjs/api/{types/DocAnnotationsList200ResponseAnnotationsItemLinkTargetGotoDestination.js → resources/doc/resources/annotations/client/requests/ExportAppearanceAnnotationsRequest.js} +0 -0
  160. /package/dist/cjs/api/{types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkTargetGotoDestination.js → resources/doc/resources/annotations/client/requests/FlattenAnnotationsRequest.js} +0 -0
  161. /package/dist/esm/api/{types/DocAnnotationsList200ResponseAnnotationsItemLinkTargetGotoDestination.mjs → resources/doc/resources/annotations/client/requests/ExportAppearanceAnnotationsRequest.mjs} +0 -0
  162. /package/dist/esm/api/{types/DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkTargetGotoDestination.mjs → resources/doc/resources/annotations/client/requests/FlattenAnnotationsRequest.mjs} +0 -0
@@ -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 = {}));
@@ -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,28 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var DocAnnotationsExportAppearance404Response;
3
+ (function (DocAnnotationsExportAppearance404Response) {
4
+ DocAnnotationsExportAppearance404Response.Name = {
5
+ EngineError: "EngineError",
6
+ };
7
+ DocAnnotationsExportAppearance404Response.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
+ })(DocAnnotationsExportAppearance404Response || (DocAnnotationsExportAppearance404Response = {}));
@@ -0,0 +1 @@
1
+ export type DocAnnotationsExportAppearanceRequest = Record<string, unknown>;
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,50 @@
1
+ import type * as CloudPDF from "../index.mjs";
2
+ export interface DocAnnotationsFlatten200Response {
3
+ meta: DocAnnotationsFlatten200Response.Meta;
4
+ /** Accepts any additional properties */
5
+ [key: string]: any;
6
+ }
7
+ export declare namespace DocAnnotationsFlatten200Response {
8
+ interface Meta {
9
+ affectedPages: Meta.AffectedPages.Item[];
10
+ cacheDelta: Meta.CacheDelta | null;
11
+ }
12
+ namespace Meta {
13
+ type AffectedPages = AffectedPages.Item[];
14
+ namespace AffectedPages {
15
+ interface Item {
16
+ pageObjectNumber: number;
17
+ revision: Item.Revision;
18
+ weakAnnotationState: CloudPDF.DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState;
19
+ }
20
+ namespace Item {
21
+ interface Revision {
22
+ docSessionId: string;
23
+ pageObjectNumber: number;
24
+ generation: number;
25
+ }
26
+ }
27
+ }
28
+ interface CacheDelta {
29
+ previousDocVersion: number;
30
+ docVersion: number;
31
+ annotationsVersion?: number | undefined;
32
+ pages: CacheDelta.Pages.Item[];
33
+ }
34
+ namespace CacheDelta {
35
+ type Pages = Pages.Item[];
36
+ namespace Pages {
37
+ interface Item {
38
+ pageObjectNumber: number;
39
+ cache: Item.Cache;
40
+ }
41
+ namespace Item {
42
+ interface Cache {
43
+ contentVersion: number;
44
+ annotationVersion: number;
45
+ }
46
+ }
47
+ }
48
+ }
49
+ }
50
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,11 @@
1
+ import type * as CloudPDF from "../index.mjs";
2
+ export type DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState = CloudPDF.DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.Unknown | CloudPDF.DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState.Known;
3
+ export declare namespace DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState {
4
+ interface Unknown {
5
+ kind: "unknown";
6
+ }
7
+ interface Known {
8
+ kind: "known";
9
+ hasAnyWeakAnnotations: boolean;
10
+ }
11
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,34 @@
1
+ export interface DocAnnotationsFlatten400Response {
2
+ name: DocAnnotationsFlatten400Response.Name;
3
+ code: DocAnnotationsFlatten400Response.Code;
4
+ message: string;
5
+ details?: Record<string, unknown> | undefined;
6
+ }
7
+ export declare namespace DocAnnotationsFlatten400Response {
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 DocAnnotationsFlatten400Response;
3
+ (function (DocAnnotationsFlatten400Response) {
4
+ DocAnnotationsFlatten400Response.Name = {
5
+ EngineError: "EngineError",
6
+ };
7
+ DocAnnotationsFlatten400Response.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
+ })(DocAnnotationsFlatten400Response || (DocAnnotationsFlatten400Response = {}));
@@ -0,0 +1,34 @@
1
+ export interface DocAnnotationsFlatten404Response {
2
+ name: DocAnnotationsFlatten404Response.Name;
3
+ code: DocAnnotationsFlatten404Response.Code;
4
+ message: string;
5
+ details?: Record<string, unknown> | undefined;
6
+ }
7
+ export declare namespace DocAnnotationsFlatten404Response {
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 DocAnnotationsFlatten404Response;
3
+ (function (DocAnnotationsFlatten404Response) {
4
+ DocAnnotationsFlatten404Response.Name = {
5
+ EngineError: "EngineError",
6
+ };
7
+ DocAnnotationsFlatten404Response.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
+ })(DocAnnotationsFlatten404Response || (DocAnnotationsFlatten404Response = {}));
@@ -0,0 +1 @@
1
+ export type DocAnnotationsFlattenRequest = Record<string, unknown>;
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};