@cloudpdf/sdk 3.0.0-next.8 → 3.0.0-next.9
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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/doc/resources/pages/client/Client.d.ts +53 -0
- package/dist/cjs/api/resources/doc/resources/pages/client/Client.js +182 -0
- package/dist/cjs/api/resources/doc/resources/pages/client/requests/ExtractPagesRequest.d.ts +20 -0
- package/dist/cjs/api/resources/doc/resources/pages/client/requests/ExtractPagesRequest.js +3 -0
- package/dist/cjs/api/resources/doc/resources/pages/client/requests/InsertBlankPagesRequest.d.ts +18 -0
- package/dist/cjs/api/resources/doc/resources/pages/client/requests/InsertBlankPagesRequest.js +3 -0
- package/dist/cjs/api/resources/doc/resources/pages/client/requests/InsertPagesRequest.d.ts +16 -0
- package/dist/cjs/api/resources/doc/resources/pages/client/requests/InsertPagesRequest.js +3 -0
- package/dist/cjs/api/resources/doc/resources/pages/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/types/DocPagesExtract400Response.d.ts +34 -0
- package/dist/cjs/api/types/DocPagesExtract400Response.js +31 -0
- package/dist/cjs/api/types/DocPagesExtract404Response.d.ts +34 -0
- package/dist/cjs/api/types/DocPagesExtract404Response.js +31 -0
- package/dist/cjs/api/types/DocPagesExtractRequest.d.ts +1 -0
- package/dist/cjs/api/types/DocPagesExtractRequest.js +3 -0
- package/dist/cjs/api/types/DocPagesInsert200Response.d.ts +49 -0
- package/dist/cjs/api/types/DocPagesInsert200Response.js +3 -0
- package/dist/cjs/api/types/DocPagesInsert200ResponseMetaAffectedPagesItemWeakAnnotationState.d.ts +11 -0
- package/dist/cjs/api/types/DocPagesInsert200ResponseMetaAffectedPagesItemWeakAnnotationState.js +3 -0
- package/dist/cjs/api/types/DocPagesInsert400Response.d.ts +34 -0
- package/dist/cjs/api/types/DocPagesInsert400Response.js +31 -0
- package/dist/cjs/api/types/DocPagesInsert404Response.d.ts +34 -0
- package/dist/cjs/api/types/DocPagesInsert404Response.js +31 -0
- package/dist/cjs/api/types/DocPagesInsertBlank200Response.d.ts +49 -0
- package/dist/cjs/api/types/DocPagesInsertBlank200Response.js +3 -0
- package/dist/cjs/api/types/DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationState.d.ts +11 -0
- package/dist/cjs/api/types/DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationState.js +3 -0
- package/dist/cjs/api/types/DocPagesInsertBlank400Response.d.ts +34 -0
- package/dist/cjs/api/types/DocPagesInsertBlank400Response.js +31 -0
- package/dist/cjs/api/types/DocPagesInsertBlank404Response.d.ts +34 -0
- package/dist/cjs/api/types/DocPagesInsertBlank404Response.js +31 -0
- package/dist/cjs/api/types/DocPagesInsertBlankRequest.d.ts +1 -0
- package/dist/cjs/api/types/DocPagesInsertBlankRequest.js +3 -0
- package/dist/cjs/api/types/index.d.ts +12 -0
- package/dist/cjs/api/types/index.js +12 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/doc/resources/pages/client/Client.d.mts +53 -0
- package/dist/esm/api/resources/doc/resources/pages/client/Client.mjs +182 -0
- package/dist/esm/api/resources/doc/resources/pages/client/requests/ExtractPagesRequest.d.mts +20 -0
- package/dist/esm/api/resources/doc/resources/pages/client/requests/ExtractPagesRequest.mjs +2 -0
- package/dist/esm/api/resources/doc/resources/pages/client/requests/InsertBlankPagesRequest.d.mts +18 -0
- package/dist/esm/api/resources/doc/resources/pages/client/requests/InsertBlankPagesRequest.mjs +2 -0
- package/dist/esm/api/resources/doc/resources/pages/client/requests/InsertPagesRequest.d.mts +16 -0
- package/dist/esm/api/resources/doc/resources/pages/client/requests/InsertPagesRequest.mjs +2 -0
- package/dist/esm/api/resources/doc/resources/pages/client/requests/index.d.mts +3 -0
- package/dist/esm/api/types/DocPagesExtract400Response.d.mts +34 -0
- package/dist/esm/api/types/DocPagesExtract400Response.mjs +28 -0
- package/dist/esm/api/types/DocPagesExtract404Response.d.mts +34 -0
- package/dist/esm/api/types/DocPagesExtract404Response.mjs +28 -0
- package/dist/esm/api/types/DocPagesExtractRequest.d.mts +1 -0
- package/dist/esm/api/types/DocPagesExtractRequest.mjs +2 -0
- package/dist/esm/api/types/DocPagesInsert200Response.d.mts +49 -0
- package/dist/esm/api/types/DocPagesInsert200Response.mjs +2 -0
- package/dist/esm/api/types/DocPagesInsert200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts +11 -0
- package/dist/esm/api/types/DocPagesInsert200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs +2 -0
- package/dist/esm/api/types/DocPagesInsert400Response.d.mts +34 -0
- package/dist/esm/api/types/DocPagesInsert400Response.mjs +28 -0
- package/dist/esm/api/types/DocPagesInsert404Response.d.mts +34 -0
- package/dist/esm/api/types/DocPagesInsert404Response.mjs +28 -0
- package/dist/esm/api/types/DocPagesInsertBlank200Response.d.mts +49 -0
- package/dist/esm/api/types/DocPagesInsertBlank200Response.mjs +2 -0
- package/dist/esm/api/types/DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts +11 -0
- package/dist/esm/api/types/DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs +2 -0
- package/dist/esm/api/types/DocPagesInsertBlank400Response.d.mts +34 -0
- package/dist/esm/api/types/DocPagesInsertBlank400Response.mjs +28 -0
- package/dist/esm/api/types/DocPagesInsertBlank404Response.d.mts +34 -0
- package/dist/esm/api/types/DocPagesInsertBlank404Response.mjs +28 -0
- package/dist/esm/api/types/DocPagesInsertBlankRequest.d.mts +1 -0
- package/dist/esm/api/types/DocPagesInsertBlankRequest.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +12 -0
- package/dist/esm/api/types/index.mjs +12 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +207 -0
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "3.0.0-next.
|
|
1
|
+
export declare const SDK_VERSION = "3.0.0-next.9";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "3.0.0-next.
|
|
1
|
+
export const SDK_VERSION = "3.0.0-next.9";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -2305,6 +2305,77 @@ await client.doc.pages.delete({
|
|
|
2305
2305
|
</dl>
|
|
2306
2306
|
|
|
2307
2307
|
|
|
2308
|
+
</dd>
|
|
2309
|
+
</dl>
|
|
2310
|
+
</details>
|
|
2311
|
+
|
|
2312
|
+
<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">extract</a>({ ...params }) -> core.BinaryResponse</code></summary>
|
|
2313
|
+
<dl>
|
|
2314
|
+
<dd>
|
|
2315
|
+
|
|
2316
|
+
#### 📝 Description
|
|
2317
|
+
|
|
2318
|
+
<dl>
|
|
2319
|
+
<dd>
|
|
2320
|
+
|
|
2321
|
+
<dl>
|
|
2322
|
+
<dd>
|
|
2323
|
+
|
|
2324
|
+
A read, not a mutation: the source document is untouched and no event is published. Body is `{"pageObjectNumbers": number[]}`; the response body is the new PDF.
|
|
2325
|
+
</dd>
|
|
2326
|
+
</dl>
|
|
2327
|
+
</dd>
|
|
2328
|
+
</dl>
|
|
2329
|
+
|
|
2330
|
+
#### 🔌 Usage
|
|
2331
|
+
|
|
2332
|
+
<dl>
|
|
2333
|
+
<dd>
|
|
2334
|
+
|
|
2335
|
+
<dl>
|
|
2336
|
+
<dd>
|
|
2337
|
+
|
|
2338
|
+
```typescript
|
|
2339
|
+
await client.doc.pages.extract({
|
|
2340
|
+
docId: "docId",
|
|
2341
|
+
layerName: "layerName",
|
|
2342
|
+
body: {
|
|
2343
|
+
"string": {
|
|
2344
|
+
"key": "value"
|
|
2345
|
+
}
|
|
2346
|
+
}
|
|
2347
|
+
});
|
|
2348
|
+
|
|
2349
|
+
```
|
|
2350
|
+
</dd>
|
|
2351
|
+
</dl>
|
|
2352
|
+
</dd>
|
|
2353
|
+
</dl>
|
|
2354
|
+
|
|
2355
|
+
#### ⚙️ Parameters
|
|
2356
|
+
|
|
2357
|
+
<dl>
|
|
2358
|
+
<dd>
|
|
2359
|
+
|
|
2360
|
+
<dl>
|
|
2361
|
+
<dd>
|
|
2362
|
+
|
|
2363
|
+
**request:** `CloudPDF.doc.ExtractPagesRequest`
|
|
2364
|
+
|
|
2365
|
+
</dd>
|
|
2366
|
+
</dl>
|
|
2367
|
+
|
|
2368
|
+
<dl>
|
|
2369
|
+
<dd>
|
|
2370
|
+
|
|
2371
|
+
**requestOptions:** `PagesClient.RequestOptions`
|
|
2372
|
+
|
|
2373
|
+
</dd>
|
|
2374
|
+
</dl>
|
|
2375
|
+
</dd>
|
|
2376
|
+
</dl>
|
|
2377
|
+
|
|
2378
|
+
|
|
2308
2379
|
</dd>
|
|
2309
2380
|
</dl>
|
|
2310
2381
|
</details>
|
|
@@ -2360,6 +2431,142 @@ await client.doc.pages.flatten({
|
|
|
2360
2431
|
</dl>
|
|
2361
2432
|
|
|
2362
2433
|
|
|
2434
|
+
</dd>
|
|
2435
|
+
</dl>
|
|
2436
|
+
</details>
|
|
2437
|
+
|
|
2438
|
+
<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">insert</a>({ ...params }) -> CloudPDF.DocPagesInsert200Response</code></summary>
|
|
2439
|
+
<dl>
|
|
2440
|
+
<dd>
|
|
2441
|
+
|
|
2442
|
+
#### 📝 Description
|
|
2443
|
+
|
|
2444
|
+
<dl>
|
|
2445
|
+
<dd>
|
|
2446
|
+
|
|
2447
|
+
<dl>
|
|
2448
|
+
<dd>
|
|
2449
|
+
|
|
2450
|
+
Multipart mutation envelope: a `body` field holding `{"destIndex"?: number}` (omitted → append) plus a `resource:source` file part carrying the standalone PDF whose pages are copied in. The inserted copies get fresh page object numbers, returned in insertion order.
|
|
2451
|
+
</dd>
|
|
2452
|
+
</dl>
|
|
2453
|
+
</dd>
|
|
2454
|
+
</dl>
|
|
2455
|
+
|
|
2456
|
+
#### 🔌 Usage
|
|
2457
|
+
|
|
2458
|
+
<dl>
|
|
2459
|
+
<dd>
|
|
2460
|
+
|
|
2461
|
+
<dl>
|
|
2462
|
+
<dd>
|
|
2463
|
+
|
|
2464
|
+
```typescript
|
|
2465
|
+
await client.doc.pages.insert({
|
|
2466
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
2467
|
+
docId: "docId",
|
|
2468
|
+
layerName: "layerName"
|
|
2469
|
+
});
|
|
2470
|
+
|
|
2471
|
+
```
|
|
2472
|
+
</dd>
|
|
2473
|
+
</dl>
|
|
2474
|
+
</dd>
|
|
2475
|
+
</dl>
|
|
2476
|
+
|
|
2477
|
+
#### ⚙️ Parameters
|
|
2478
|
+
|
|
2479
|
+
<dl>
|
|
2480
|
+
<dd>
|
|
2481
|
+
|
|
2482
|
+
<dl>
|
|
2483
|
+
<dd>
|
|
2484
|
+
|
|
2485
|
+
**request:** `CloudPDF.doc.InsertPagesRequest`
|
|
2486
|
+
|
|
2487
|
+
</dd>
|
|
2488
|
+
</dl>
|
|
2489
|
+
|
|
2490
|
+
<dl>
|
|
2491
|
+
<dd>
|
|
2492
|
+
|
|
2493
|
+
**requestOptions:** `PagesClient.RequestOptions`
|
|
2494
|
+
|
|
2495
|
+
</dd>
|
|
2496
|
+
</dl>
|
|
2497
|
+
</dd>
|
|
2498
|
+
</dl>
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
</dd>
|
|
2502
|
+
</dl>
|
|
2503
|
+
</details>
|
|
2504
|
+
|
|
2505
|
+
<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">insertBlank</a>({ ...params }) -> CloudPDF.DocPagesInsertBlank200Response</code></summary>
|
|
2506
|
+
<dl>
|
|
2507
|
+
<dd>
|
|
2508
|
+
|
|
2509
|
+
#### 📝 Description
|
|
2510
|
+
|
|
2511
|
+
<dl>
|
|
2512
|
+
<dd>
|
|
2513
|
+
|
|
2514
|
+
<dl>
|
|
2515
|
+
<dd>
|
|
2516
|
+
|
|
2517
|
+
Body is `{"size": {"width", "height"}, "count"?, "destIndex"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.
|
|
2518
|
+
</dd>
|
|
2519
|
+
</dl>
|
|
2520
|
+
</dd>
|
|
2521
|
+
</dl>
|
|
2522
|
+
|
|
2523
|
+
#### 🔌 Usage
|
|
2524
|
+
|
|
2525
|
+
<dl>
|
|
2526
|
+
<dd>
|
|
2527
|
+
|
|
2528
|
+
<dl>
|
|
2529
|
+
<dd>
|
|
2530
|
+
|
|
2531
|
+
```typescript
|
|
2532
|
+
await client.doc.pages.insertBlank({
|
|
2533
|
+
docId: "docId",
|
|
2534
|
+
layerName: "layerName",
|
|
2535
|
+
body: {
|
|
2536
|
+
"key": "value"
|
|
2537
|
+
}
|
|
2538
|
+
});
|
|
2539
|
+
|
|
2540
|
+
```
|
|
2541
|
+
</dd>
|
|
2542
|
+
</dl>
|
|
2543
|
+
</dd>
|
|
2544
|
+
</dl>
|
|
2545
|
+
|
|
2546
|
+
#### ⚙️ Parameters
|
|
2547
|
+
|
|
2548
|
+
<dl>
|
|
2549
|
+
<dd>
|
|
2550
|
+
|
|
2551
|
+
<dl>
|
|
2552
|
+
<dd>
|
|
2553
|
+
|
|
2554
|
+
**request:** `CloudPDF.doc.InsertBlankPagesRequest`
|
|
2555
|
+
|
|
2556
|
+
</dd>
|
|
2557
|
+
</dl>
|
|
2558
|
+
|
|
2559
|
+
<dl>
|
|
2560
|
+
<dd>
|
|
2561
|
+
|
|
2562
|
+
**requestOptions:** `PagesClient.RequestOptions`
|
|
2563
|
+
|
|
2564
|
+
</dd>
|
|
2565
|
+
</dl>
|
|
2566
|
+
</dd>
|
|
2567
|
+
</dl>
|
|
2568
|
+
|
|
2569
|
+
|
|
2363
2570
|
</dd>
|
|
2364
2571
|
</dl>
|
|
2365
2572
|
</details>
|