cloudpdf 3.0.0.alpha.11 → 3.0.0.alpha.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.
- checksums.yaml +4 -4
- data/.fern/metadata.json +2 -2
- data/lib/CloudPDF/doc/annotations/client.rb +106 -0
- data/lib/CloudPDF/doc/annotations/types/export_appearance_annotations_request.rb +21 -0
- data/lib/CloudPDF/doc/annotations/types/flatten_annotations_request.rb +21 -0
- data/lib/CloudPDF/doc/pages/client.rb +102 -0
- data/lib/CloudPDF/doc/pages/types/remove_name_pages_request.rb +19 -0
- data/lib/CloudPDF/doc/pages/types/set_name_pages_request.rb +19 -0
- data/lib/CloudPDF/types/doc_annotations_export_appearance400response.rb +15 -0
- data/lib/CloudPDF/types/doc_annotations_export_appearance400response_code.rb +29 -0
- data/lib/CloudPDF/types/doc_annotations_export_appearance400response_name.rb +11 -0
- data/lib/CloudPDF/types/doc_annotations_export_appearance404response.rb +15 -0
- data/lib/CloudPDF/types/doc_annotations_export_appearance404response_code.rb +29 -0
- data/lib/CloudPDF/types/doc_annotations_export_appearance404response_name.rb +11 -0
- data/lib/CloudPDF/types/doc_annotations_export_appearance_request.rb +23 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response.rb +9 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta.rb +11 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item.rb +13 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_revision.rb +13 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state.rb +15 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_known.rb +9 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown.rb +7 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta.rb +15 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item.rb +11 -0
- data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item_cache.rb +11 -0
- data/lib/CloudPDF/types/doc_annotations_flatten400response.rb +15 -0
- data/lib/CloudPDF/types/doc_annotations_flatten400response_code.rb +29 -0
- data/lib/CloudPDF/types/doc_annotations_flatten400response_name.rb +11 -0
- data/lib/CloudPDF/types/doc_annotations_flatten404response.rb +15 -0
- data/lib/CloudPDF/types/doc_annotations_flatten404response_code.rb +29 -0
- data/lib/CloudPDF/types/doc_annotations_flatten404response_name.rb +11 -0
- data/lib/CloudPDF/types/doc_annotations_flatten_request.rb +23 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response.rb +9 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item.rb +13 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_revision.rb +13 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state.rb +15 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_known.rb +9 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb +7 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta.rb +15 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item_cache.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_remove_name400response.rb +15 -0
- data/lib/CloudPDF/types/doc_pages_remove_name400response_code.rb +29 -0
- data/lib/CloudPDF/types/doc_pages_remove_name400response_name.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_remove_name404response.rb +15 -0
- data/lib/CloudPDF/types/doc_pages_remove_name404response_code.rb +29 -0
- data/lib/CloudPDF/types/doc_pages_remove_name404response_name.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_remove_name_request.rb +23 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response.rb +9 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item.rb +13 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_revision.rb +13 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state.rb +15 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_known.rb +9 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb +7 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta.rb +15 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item_cache.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_set_name400response.rb +15 -0
- data/lib/CloudPDF/types/doc_pages_set_name400response_code.rb +29 -0
- data/lib/CloudPDF/types/doc_pages_set_name400response_name.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_set_name404response.rb +15 -0
- data/lib/CloudPDF/types/doc_pages_set_name404response_code.rb +29 -0
- data/lib/CloudPDF/types/doc_pages_set_name404response_name.rb +11 -0
- data/lib/CloudPDF/types/doc_pages_set_name_request.rb +23 -0
- data/lib/CloudPDF/version.rb +1 -1
- data/lib/cloudpdf.rb +62 -0
- data/reference.md +332 -0
- metadata +64 -2
data/lib/cloudpdf.rb
CHANGED
|
@@ -1177,6 +1177,30 @@ require_relative "CloudPDF/types/doc_annotations_delete200response"
|
|
|
1177
1177
|
require_relative "CloudPDF/types/doc_annotations_delete404response_name"
|
|
1178
1178
|
require_relative "CloudPDF/types/doc_annotations_delete404response_code"
|
|
1179
1179
|
require_relative "CloudPDF/types/doc_annotations_delete404response"
|
|
1180
|
+
require_relative "CloudPDF/types/doc_annotations_flatten_request"
|
|
1181
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_revision"
|
|
1182
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown"
|
|
1183
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_known"
|
|
1184
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state"
|
|
1185
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item"
|
|
1186
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item_cache"
|
|
1187
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item"
|
|
1188
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta"
|
|
1189
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response_meta"
|
|
1190
|
+
require_relative "CloudPDF/types/doc_annotations_flatten200response"
|
|
1191
|
+
require_relative "CloudPDF/types/doc_annotations_flatten400response_name"
|
|
1192
|
+
require_relative "CloudPDF/types/doc_annotations_flatten400response_code"
|
|
1193
|
+
require_relative "CloudPDF/types/doc_annotations_flatten400response"
|
|
1194
|
+
require_relative "CloudPDF/types/doc_annotations_flatten404response_name"
|
|
1195
|
+
require_relative "CloudPDF/types/doc_annotations_flatten404response_code"
|
|
1196
|
+
require_relative "CloudPDF/types/doc_annotations_flatten404response"
|
|
1197
|
+
require_relative "CloudPDF/types/doc_annotations_export_appearance_request"
|
|
1198
|
+
require_relative "CloudPDF/types/doc_annotations_export_appearance400response_name"
|
|
1199
|
+
require_relative "CloudPDF/types/doc_annotations_export_appearance400response_code"
|
|
1200
|
+
require_relative "CloudPDF/types/doc_annotations_export_appearance400response"
|
|
1201
|
+
require_relative "CloudPDF/types/doc_annotations_export_appearance404response_name"
|
|
1202
|
+
require_relative "CloudPDF/types/doc_annotations_export_appearance404response_code"
|
|
1203
|
+
require_relative "CloudPDF/types/doc_annotations_export_appearance404response"
|
|
1180
1204
|
require_relative "CloudPDF/types/doc_forms_get200response_form_kind"
|
|
1181
1205
|
require_relative "CloudPDF/types/doc_forms_get200response_fields_item_text_ref_object_number"
|
|
1182
1206
|
require_relative "CloudPDF/types/doc_forms_get200response_fields_item_text_ref_fqn"
|
|
@@ -1425,6 +1449,40 @@ require_relative "CloudPDF/types/doc_pages_delete400response"
|
|
|
1425
1449
|
require_relative "CloudPDF/types/doc_pages_delete404response_name"
|
|
1426
1450
|
require_relative "CloudPDF/types/doc_pages_delete404response_code"
|
|
1427
1451
|
require_relative "CloudPDF/types/doc_pages_delete404response"
|
|
1452
|
+
require_relative "CloudPDF/types/doc_pages_set_name_request"
|
|
1453
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_revision"
|
|
1454
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_unknown"
|
|
1455
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_known"
|
|
1456
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state"
|
|
1457
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item"
|
|
1458
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item_cache"
|
|
1459
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item"
|
|
1460
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta_cache_delta"
|
|
1461
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response_meta"
|
|
1462
|
+
require_relative "CloudPDF/types/doc_pages_set_name200response"
|
|
1463
|
+
require_relative "CloudPDF/types/doc_pages_set_name400response_name"
|
|
1464
|
+
require_relative "CloudPDF/types/doc_pages_set_name400response_code"
|
|
1465
|
+
require_relative "CloudPDF/types/doc_pages_set_name400response"
|
|
1466
|
+
require_relative "CloudPDF/types/doc_pages_set_name404response_name"
|
|
1467
|
+
require_relative "CloudPDF/types/doc_pages_set_name404response_code"
|
|
1468
|
+
require_relative "CloudPDF/types/doc_pages_set_name404response"
|
|
1469
|
+
require_relative "CloudPDF/types/doc_pages_remove_name_request"
|
|
1470
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_revision"
|
|
1471
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_unknown"
|
|
1472
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_known"
|
|
1473
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state"
|
|
1474
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item"
|
|
1475
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item_cache"
|
|
1476
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item"
|
|
1477
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta"
|
|
1478
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response_meta"
|
|
1479
|
+
require_relative "CloudPDF/types/doc_pages_remove_name200response"
|
|
1480
|
+
require_relative "CloudPDF/types/doc_pages_remove_name400response_name"
|
|
1481
|
+
require_relative "CloudPDF/types/doc_pages_remove_name400response_code"
|
|
1482
|
+
require_relative "CloudPDF/types/doc_pages_remove_name400response"
|
|
1483
|
+
require_relative "CloudPDF/types/doc_pages_remove_name404response_name"
|
|
1484
|
+
require_relative "CloudPDF/types/doc_pages_remove_name404response_code"
|
|
1485
|
+
require_relative "CloudPDF/types/doc_pages_remove_name404response"
|
|
1428
1486
|
require_relative "CloudPDF/types/doc_pages_flatten_request"
|
|
1429
1487
|
require_relative "CloudPDF/types/doc_pages_flatten200response_meta_affected_pages_item_revision"
|
|
1430
1488
|
require_relative "CloudPDF/types/doc_pages_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown"
|
|
@@ -1544,6 +1602,8 @@ require_relative "CloudPDF/doc/annotations/types/list_annotations_request"
|
|
|
1544
1602
|
require_relative "CloudPDF/doc/annotations/types/create_annotations_request"
|
|
1545
1603
|
require_relative "CloudPDF/doc/annotations/types/delete_annotations_request"
|
|
1546
1604
|
require_relative "CloudPDF/doc/annotations/types/update_annotations_request"
|
|
1605
|
+
require_relative "CloudPDF/doc/annotations/types/export_appearance_annotations_request"
|
|
1606
|
+
require_relative "CloudPDF/doc/annotations/types/flatten_annotations_request"
|
|
1547
1607
|
require_relative "CloudPDF/doc/forms/client"
|
|
1548
1608
|
require_relative "CloudPDF/doc/forms/types/get_forms_request"
|
|
1549
1609
|
require_relative "CloudPDF/doc/forms/types/export_data_forms_request"
|
|
@@ -1559,6 +1619,8 @@ require_relative "CloudPDF/doc/pages/types/flatten_pages_request"
|
|
|
1559
1619
|
require_relative "CloudPDF/doc/pages/types/insert_pages_request"
|
|
1560
1620
|
require_relative "CloudPDF/doc/pages/types/insert_blank_pages_request"
|
|
1561
1621
|
require_relative "CloudPDF/doc/pages/types/move_pages_request"
|
|
1622
|
+
require_relative "CloudPDF/doc/pages/types/set_name_pages_request"
|
|
1623
|
+
require_relative "CloudPDF/doc/pages/types/remove_name_pages_request"
|
|
1562
1624
|
require_relative "CloudPDF/doc/pages/types/rotate_pages_request"
|
|
1563
1625
|
require_relative "CloudPDF/doc/redactions/client"
|
|
1564
1626
|
require_relative "CloudPDF/doc/redactions/types/apply_redactions_request"
|
data/reference.md
CHANGED
|
@@ -2581,6 +2581,182 @@ client.doc.annotations.update(
|
|
|
2581
2581
|
</dl>
|
|
2582
2582
|
|
|
2583
2583
|
|
|
2584
|
+
</dd>
|
|
2585
|
+
</dl>
|
|
2586
|
+
</details>
|
|
2587
|
+
|
|
2588
|
+
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">export_appearance</a>(doc_id:, layer_name:, pon:, request) -> String</code></summary>
|
|
2589
|
+
<dl>
|
|
2590
|
+
<dd>
|
|
2591
|
+
|
|
2592
|
+
#### 🔌 Usage
|
|
2593
|
+
|
|
2594
|
+
<dl>
|
|
2595
|
+
<dd>
|
|
2596
|
+
|
|
2597
|
+
<dl>
|
|
2598
|
+
<dd>
|
|
2599
|
+
|
|
2600
|
+
```ruby
|
|
2601
|
+
client.doc.annotations.export_appearance(
|
|
2602
|
+
doc_id: "docId",
|
|
2603
|
+
layer_name: "layerName",
|
|
2604
|
+
pon: 1,
|
|
2605
|
+
request: {
|
|
2606
|
+
string: {
|
|
2607
|
+
key: "value"
|
|
2608
|
+
}
|
|
2609
|
+
}
|
|
2610
|
+
)
|
|
2611
|
+
```
|
|
2612
|
+
</dd>
|
|
2613
|
+
</dl>
|
|
2614
|
+
</dd>
|
|
2615
|
+
</dl>
|
|
2616
|
+
|
|
2617
|
+
#### ⚙️ Parameters
|
|
2618
|
+
|
|
2619
|
+
<dl>
|
|
2620
|
+
<dd>
|
|
2621
|
+
|
|
2622
|
+
<dl>
|
|
2623
|
+
<dd>
|
|
2624
|
+
|
|
2625
|
+
**doc_id:** `String`
|
|
2626
|
+
|
|
2627
|
+
</dd>
|
|
2628
|
+
</dl>
|
|
2629
|
+
|
|
2630
|
+
<dl>
|
|
2631
|
+
<dd>
|
|
2632
|
+
|
|
2633
|
+
**layer_name:** `String`
|
|
2634
|
+
|
|
2635
|
+
</dd>
|
|
2636
|
+
</dl>
|
|
2637
|
+
|
|
2638
|
+
<dl>
|
|
2639
|
+
<dd>
|
|
2640
|
+
|
|
2641
|
+
**pon:** `Integer`
|
|
2642
|
+
|
|
2643
|
+
</dd>
|
|
2644
|
+
</dl>
|
|
2645
|
+
|
|
2646
|
+
<dl>
|
|
2647
|
+
<dd>
|
|
2648
|
+
|
|
2649
|
+
**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
|
|
2650
|
+
|
|
2651
|
+
</dd>
|
|
2652
|
+
</dl>
|
|
2653
|
+
|
|
2654
|
+
<dl>
|
|
2655
|
+
<dd>
|
|
2656
|
+
|
|
2657
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
2658
|
+
|
|
2659
|
+
</dd>
|
|
2660
|
+
</dl>
|
|
2661
|
+
|
|
2662
|
+
<dl>
|
|
2663
|
+
<dd>
|
|
2664
|
+
|
|
2665
|
+
**request_options:** `CloudPDF::Doc::Annotations::RequestOptions`
|
|
2666
|
+
|
|
2667
|
+
</dd>
|
|
2668
|
+
</dl>
|
|
2669
|
+
</dd>
|
|
2670
|
+
</dl>
|
|
2671
|
+
|
|
2672
|
+
|
|
2673
|
+
</dd>
|
|
2674
|
+
</dl>
|
|
2675
|
+
</details>
|
|
2676
|
+
|
|
2677
|
+
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">flatten</a>(doc_id:, layer_name:, pon:, request) -> CloudPDF::Types::DocAnnotationsFlatten200Response</code></summary>
|
|
2678
|
+
<dl>
|
|
2679
|
+
<dd>
|
|
2680
|
+
|
|
2681
|
+
#### 🔌 Usage
|
|
2682
|
+
|
|
2683
|
+
<dl>
|
|
2684
|
+
<dd>
|
|
2685
|
+
|
|
2686
|
+
<dl>
|
|
2687
|
+
<dd>
|
|
2688
|
+
|
|
2689
|
+
```ruby
|
|
2690
|
+
client.doc.annotations.flatten(
|
|
2691
|
+
doc_id: "docId",
|
|
2692
|
+
layer_name: "layerName",
|
|
2693
|
+
pon: 1,
|
|
2694
|
+
request: {
|
|
2695
|
+
key: "value"
|
|
2696
|
+
}
|
|
2697
|
+
)
|
|
2698
|
+
```
|
|
2699
|
+
</dd>
|
|
2700
|
+
</dl>
|
|
2701
|
+
</dd>
|
|
2702
|
+
</dl>
|
|
2703
|
+
|
|
2704
|
+
#### ⚙️ Parameters
|
|
2705
|
+
|
|
2706
|
+
<dl>
|
|
2707
|
+
<dd>
|
|
2708
|
+
|
|
2709
|
+
<dl>
|
|
2710
|
+
<dd>
|
|
2711
|
+
|
|
2712
|
+
**doc_id:** `String`
|
|
2713
|
+
|
|
2714
|
+
</dd>
|
|
2715
|
+
</dl>
|
|
2716
|
+
|
|
2717
|
+
<dl>
|
|
2718
|
+
<dd>
|
|
2719
|
+
|
|
2720
|
+
**layer_name:** `String`
|
|
2721
|
+
|
|
2722
|
+
</dd>
|
|
2723
|
+
</dl>
|
|
2724
|
+
|
|
2725
|
+
<dl>
|
|
2726
|
+
<dd>
|
|
2727
|
+
|
|
2728
|
+
**pon:** `Integer`
|
|
2729
|
+
|
|
2730
|
+
</dd>
|
|
2731
|
+
</dl>
|
|
2732
|
+
|
|
2733
|
+
<dl>
|
|
2734
|
+
<dd>
|
|
2735
|
+
|
|
2736
|
+
**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
|
|
2737
|
+
|
|
2738
|
+
</dd>
|
|
2739
|
+
</dl>
|
|
2740
|
+
|
|
2741
|
+
<dl>
|
|
2742
|
+
<dd>
|
|
2743
|
+
|
|
2744
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
2745
|
+
|
|
2746
|
+
</dd>
|
|
2747
|
+
</dl>
|
|
2748
|
+
|
|
2749
|
+
<dl>
|
|
2750
|
+
<dd>
|
|
2751
|
+
|
|
2752
|
+
**request_options:** `CloudPDF::Doc::Annotations::RequestOptions`
|
|
2753
|
+
|
|
2754
|
+
</dd>
|
|
2755
|
+
</dl>
|
|
2756
|
+
</dd>
|
|
2757
|
+
</dl>
|
|
2758
|
+
|
|
2759
|
+
|
|
2584
2760
|
</dd>
|
|
2585
2761
|
</dl>
|
|
2586
2762
|
</details>
|
|
@@ -3535,6 +3711,162 @@ client.doc.pages.move(
|
|
|
3535
3711
|
</dl>
|
|
3536
3712
|
|
|
3537
3713
|
|
|
3714
|
+
</dd>
|
|
3715
|
+
</dl>
|
|
3716
|
+
</details>
|
|
3717
|
+
|
|
3718
|
+
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesSetName200Response</code></summary>
|
|
3719
|
+
<dl>
|
|
3720
|
+
<dd>
|
|
3721
|
+
|
|
3722
|
+
#### 🔌 Usage
|
|
3723
|
+
|
|
3724
|
+
<dl>
|
|
3725
|
+
<dd>
|
|
3726
|
+
|
|
3727
|
+
<dl>
|
|
3728
|
+
<dd>
|
|
3729
|
+
|
|
3730
|
+
```ruby
|
|
3731
|
+
client.doc.pages.set_name(
|
|
3732
|
+
doc_id: "docId",
|
|
3733
|
+
layer_name: "layerName",
|
|
3734
|
+
request: {
|
|
3735
|
+
key: "value"
|
|
3736
|
+
}
|
|
3737
|
+
)
|
|
3738
|
+
```
|
|
3739
|
+
</dd>
|
|
3740
|
+
</dl>
|
|
3741
|
+
</dd>
|
|
3742
|
+
</dl>
|
|
3743
|
+
|
|
3744
|
+
#### ⚙️ Parameters
|
|
3745
|
+
|
|
3746
|
+
<dl>
|
|
3747
|
+
<dd>
|
|
3748
|
+
|
|
3749
|
+
<dl>
|
|
3750
|
+
<dd>
|
|
3751
|
+
|
|
3752
|
+
**doc_id:** `String`
|
|
3753
|
+
|
|
3754
|
+
</dd>
|
|
3755
|
+
</dl>
|
|
3756
|
+
|
|
3757
|
+
<dl>
|
|
3758
|
+
<dd>
|
|
3759
|
+
|
|
3760
|
+
**layer_name:** `String`
|
|
3761
|
+
|
|
3762
|
+
</dd>
|
|
3763
|
+
</dl>
|
|
3764
|
+
|
|
3765
|
+
<dl>
|
|
3766
|
+
<dd>
|
|
3767
|
+
|
|
3768
|
+
**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
|
|
3769
|
+
|
|
3770
|
+
</dd>
|
|
3771
|
+
</dl>
|
|
3772
|
+
|
|
3773
|
+
<dl>
|
|
3774
|
+
<dd>
|
|
3775
|
+
|
|
3776
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
3777
|
+
|
|
3778
|
+
</dd>
|
|
3779
|
+
</dl>
|
|
3780
|
+
|
|
3781
|
+
<dl>
|
|
3782
|
+
<dd>
|
|
3783
|
+
|
|
3784
|
+
**request_options:** `CloudPDF::Doc::Pages::RequestOptions`
|
|
3785
|
+
|
|
3786
|
+
</dd>
|
|
3787
|
+
</dl>
|
|
3788
|
+
</dd>
|
|
3789
|
+
</dl>
|
|
3790
|
+
|
|
3791
|
+
|
|
3792
|
+
</dd>
|
|
3793
|
+
</dl>
|
|
3794
|
+
</details>
|
|
3795
|
+
|
|
3796
|
+
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">remove_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRemoveName200Response</code></summary>
|
|
3797
|
+
<dl>
|
|
3798
|
+
<dd>
|
|
3799
|
+
|
|
3800
|
+
#### 🔌 Usage
|
|
3801
|
+
|
|
3802
|
+
<dl>
|
|
3803
|
+
<dd>
|
|
3804
|
+
|
|
3805
|
+
<dl>
|
|
3806
|
+
<dd>
|
|
3807
|
+
|
|
3808
|
+
```ruby
|
|
3809
|
+
client.doc.pages.remove_name(
|
|
3810
|
+
doc_id: "docId",
|
|
3811
|
+
layer_name: "layerName",
|
|
3812
|
+
request: {
|
|
3813
|
+
key: "value"
|
|
3814
|
+
}
|
|
3815
|
+
)
|
|
3816
|
+
```
|
|
3817
|
+
</dd>
|
|
3818
|
+
</dl>
|
|
3819
|
+
</dd>
|
|
3820
|
+
</dl>
|
|
3821
|
+
|
|
3822
|
+
#### ⚙️ Parameters
|
|
3823
|
+
|
|
3824
|
+
<dl>
|
|
3825
|
+
<dd>
|
|
3826
|
+
|
|
3827
|
+
<dl>
|
|
3828
|
+
<dd>
|
|
3829
|
+
|
|
3830
|
+
**doc_id:** `String`
|
|
3831
|
+
|
|
3832
|
+
</dd>
|
|
3833
|
+
</dl>
|
|
3834
|
+
|
|
3835
|
+
<dl>
|
|
3836
|
+
<dd>
|
|
3837
|
+
|
|
3838
|
+
**layer_name:** `String`
|
|
3839
|
+
|
|
3840
|
+
</dd>
|
|
3841
|
+
</dl>
|
|
3842
|
+
|
|
3843
|
+
<dl>
|
|
3844
|
+
<dd>
|
|
3845
|
+
|
|
3846
|
+
**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
|
|
3847
|
+
|
|
3848
|
+
</dd>
|
|
3849
|
+
</dl>
|
|
3850
|
+
|
|
3851
|
+
<dl>
|
|
3852
|
+
<dd>
|
|
3853
|
+
|
|
3854
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
3855
|
+
|
|
3856
|
+
</dd>
|
|
3857
|
+
</dl>
|
|
3858
|
+
|
|
3859
|
+
<dl>
|
|
3860
|
+
<dd>
|
|
3861
|
+
|
|
3862
|
+
**request_options:** `CloudPDF::Doc::Pages::RequestOptions`
|
|
3863
|
+
|
|
3864
|
+
</dd>
|
|
3865
|
+
</dl>
|
|
3866
|
+
</dd>
|
|
3867
|
+
</dl>
|
|
3868
|
+
|
|
3869
|
+
|
|
3538
3870
|
</dd>
|
|
3539
3871
|
</dl>
|
|
3540
3872
|
</details>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: cloudpdf
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0.0.alpha.
|
|
4
|
+
version: 3.0.0.alpha.12
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- CloudPDF
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-09-
|
|
11
|
+
date: 2026-09-10 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: A typed Ruby client for deployment, tenant, and document operations in
|
|
14
14
|
the CloudPDF API.
|
|
@@ -30,6 +30,8 @@ files:
|
|
|
30
30
|
- lib/CloudPDF/doc/annotations/client.rb
|
|
31
31
|
- lib/CloudPDF/doc/annotations/types/create_annotations_request.rb
|
|
32
32
|
- lib/CloudPDF/doc/annotations/types/delete_annotations_request.rb
|
|
33
|
+
- lib/CloudPDF/doc/annotations/types/export_appearance_annotations_request.rb
|
|
34
|
+
- lib/CloudPDF/doc/annotations/types/flatten_annotations_request.rb
|
|
33
35
|
- lib/CloudPDF/doc/annotations/types/list_all_annotations_request.rb
|
|
34
36
|
- lib/CloudPDF/doc/annotations/types/list_annotations_request.rb
|
|
35
37
|
- lib/CloudPDF/doc/annotations/types/update_annotations_request.rb
|
|
@@ -50,7 +52,9 @@ files:
|
|
|
50
52
|
- lib/CloudPDF/doc/pages/types/insert_blank_pages_request.rb
|
|
51
53
|
- lib/CloudPDF/doc/pages/types/insert_pages_request.rb
|
|
52
54
|
- lib/CloudPDF/doc/pages/types/move_pages_request.rb
|
|
55
|
+
- lib/CloudPDF/doc/pages/types/remove_name_pages_request.rb
|
|
53
56
|
- lib/CloudPDF/doc/pages/types/rotate_pages_request.rb
|
|
57
|
+
- lib/CloudPDF/doc/pages/types/set_name_pages_request.rb
|
|
54
58
|
- lib/CloudPDF/doc/redactions/client.rb
|
|
55
59
|
- lib/CloudPDF/doc/redactions/types/apply_redactions_request.rb
|
|
56
60
|
- lib/CloudPDF/doc/types/download_doc_request.rb
|
|
@@ -159,6 +163,30 @@ files:
|
|
|
159
163
|
- lib/CloudPDF/types/doc_annotations_delete404response.rb
|
|
160
164
|
- lib/CloudPDF/types/doc_annotations_delete404response_code.rb
|
|
161
165
|
- lib/CloudPDF/types/doc_annotations_delete404response_name.rb
|
|
166
|
+
- lib/CloudPDF/types/doc_annotations_export_appearance400response.rb
|
|
167
|
+
- lib/CloudPDF/types/doc_annotations_export_appearance400response_code.rb
|
|
168
|
+
- lib/CloudPDF/types/doc_annotations_export_appearance400response_name.rb
|
|
169
|
+
- lib/CloudPDF/types/doc_annotations_export_appearance404response.rb
|
|
170
|
+
- lib/CloudPDF/types/doc_annotations_export_appearance404response_code.rb
|
|
171
|
+
- lib/CloudPDF/types/doc_annotations_export_appearance404response_name.rb
|
|
172
|
+
- lib/CloudPDF/types/doc_annotations_export_appearance_request.rb
|
|
173
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response.rb
|
|
174
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta.rb
|
|
175
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item.rb
|
|
176
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_revision.rb
|
|
177
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state.rb
|
|
178
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_known.rb
|
|
179
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown.rb
|
|
180
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta.rb
|
|
181
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item.rb
|
|
182
|
+
- lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item_cache.rb
|
|
183
|
+
- lib/CloudPDF/types/doc_annotations_flatten400response.rb
|
|
184
|
+
- lib/CloudPDF/types/doc_annotations_flatten400response_code.rb
|
|
185
|
+
- lib/CloudPDF/types/doc_annotations_flatten400response_name.rb
|
|
186
|
+
- lib/CloudPDF/types/doc_annotations_flatten404response.rb
|
|
187
|
+
- lib/CloudPDF/types/doc_annotations_flatten404response_code.rb
|
|
188
|
+
- lib/CloudPDF/types/doc_annotations_flatten404response_name.rb
|
|
189
|
+
- lib/CloudPDF/types/doc_annotations_flatten_request.rb
|
|
162
190
|
- lib/CloudPDF/types/doc_annotations_list200response.rb
|
|
163
191
|
- lib/CloudPDF/types/doc_annotations_list200response_annotations_item.rb
|
|
164
192
|
- lib/CloudPDF/types/doc_annotations_list200response_annotations_item_caret.rb
|
|
@@ -1341,6 +1369,23 @@ files:
|
|
|
1341
1369
|
- lib/CloudPDF/types/doc_pages_move404response_code.rb
|
|
1342
1370
|
- lib/CloudPDF/types/doc_pages_move404response_name.rb
|
|
1343
1371
|
- lib/CloudPDF/types/doc_pages_move_request.rb
|
|
1372
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response.rb
|
|
1373
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta.rb
|
|
1374
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item.rb
|
|
1375
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_revision.rb
|
|
1376
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state.rb
|
|
1377
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_known.rb
|
|
1378
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb
|
|
1379
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta.rb
|
|
1380
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item.rb
|
|
1381
|
+
- lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item_cache.rb
|
|
1382
|
+
- lib/CloudPDF/types/doc_pages_remove_name400response.rb
|
|
1383
|
+
- lib/CloudPDF/types/doc_pages_remove_name400response_code.rb
|
|
1384
|
+
- lib/CloudPDF/types/doc_pages_remove_name400response_name.rb
|
|
1385
|
+
- lib/CloudPDF/types/doc_pages_remove_name404response.rb
|
|
1386
|
+
- lib/CloudPDF/types/doc_pages_remove_name404response_code.rb
|
|
1387
|
+
- lib/CloudPDF/types/doc_pages_remove_name404response_name.rb
|
|
1388
|
+
- lib/CloudPDF/types/doc_pages_remove_name_request.rb
|
|
1344
1389
|
- lib/CloudPDF/types/doc_pages_rotate200response.rb
|
|
1345
1390
|
- lib/CloudPDF/types/doc_pages_rotate200response_meta.rb
|
|
1346
1391
|
- lib/CloudPDF/types/doc_pages_rotate200response_meta_affected_pages_item.rb
|
|
@@ -1358,6 +1403,23 @@ files:
|
|
|
1358
1403
|
- lib/CloudPDF/types/doc_pages_rotate404response_code.rb
|
|
1359
1404
|
- lib/CloudPDF/types/doc_pages_rotate404response_name.rb
|
|
1360
1405
|
- lib/CloudPDF/types/doc_pages_rotate_request.rb
|
|
1406
|
+
- lib/CloudPDF/types/doc_pages_set_name200response.rb
|
|
1407
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta.rb
|
|
1408
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item.rb
|
|
1409
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_revision.rb
|
|
1410
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state.rb
|
|
1411
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_known.rb
|
|
1412
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb
|
|
1413
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta.rb
|
|
1414
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item.rb
|
|
1415
|
+
- lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item_cache.rb
|
|
1416
|
+
- lib/CloudPDF/types/doc_pages_set_name400response.rb
|
|
1417
|
+
- lib/CloudPDF/types/doc_pages_set_name400response_code.rb
|
|
1418
|
+
- lib/CloudPDF/types/doc_pages_set_name400response_name.rb
|
|
1419
|
+
- lib/CloudPDF/types/doc_pages_set_name404response.rb
|
|
1420
|
+
- lib/CloudPDF/types/doc_pages_set_name404response_code.rb
|
|
1421
|
+
- lib/CloudPDF/types/doc_pages_set_name404response_name.rb
|
|
1422
|
+
- lib/CloudPDF/types/doc_pages_set_name_request.rb
|
|
1361
1423
|
- lib/CloudPDF/types/doc_redactions_apply200response.rb
|
|
1362
1424
|
- lib/CloudPDF/types/doc_redactions_apply200response_meta.rb
|
|
1363
1425
|
- lib/CloudPDF/types/doc_redactions_apply200response_meta_affected_pages_item.rb
|