cloudpdf 3.0.0.alpha.1 → 3.0.0.alpha.6

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 (142) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/README.md +5 -5
  4. data/lib/CloudPDF/client.rb +5 -0
  5. data/lib/CloudPDF/documents/client.rb +71 -5
  6. data/lib/CloudPDF/documents/types/documents_import_from_request.rb +25 -0
  7. data/lib/CloudPDF/documents/types/documents_import_from_request_dedup_mode.rb +14 -0
  8. data/lib/CloudPDF/documents/types/documents_import_from_request_expected.rb +13 -0
  9. data/lib/CloudPDF/documents/types/documents_import_from_request_mode.rb +14 -0
  10. data/lib/CloudPDF/documents/types/documents_import_from_request_source.rb +17 -0
  11. data/lib/CloudPDF/documents/types/documents_import_from_request_source_connection.rb +15 -0
  12. data/lib/CloudPDF/documents/types/documents_import_from_request_source_url.rb +11 -0
  13. data/lib/CloudPDF/documents/types/documents_init_request.rb +2 -0
  14. data/lib/CloudPDF/documents/types/documents_init_request_upload_preference.rb +15 -0
  15. data/lib/CloudPDF/documents/types/upload_proxy_documents_request.rb +15 -0
  16. data/lib/CloudPDF/shares/client.rb +264 -0
  17. data/lib/CloudPDF/shares/types/delete_shares_request.rb +13 -0
  18. data/lib/CloudPDF/shares/types/get_shares_request.rb +13 -0
  19. data/lib/CloudPDF/shares/types/list_shares_request.rb +17 -0
  20. data/lib/CloudPDF/shares/types/shares_create_request.rb +25 -0
  21. data/lib/CloudPDF/shares/types/shares_exchange_request.rb +13 -0
  22. data/lib/CloudPDF/shares/types/shares_update_request.rb +25 -0
  23. data/lib/CloudPDF/tenants/client.rb +117 -0
  24. data/lib/CloudPDF/tenants/types/resume_tenants_request.rb +11 -0
  25. data/lib/CloudPDF/tenants/types/tenants_suspend_request.rb +13 -0
  26. data/lib/CloudPDF/tenants/types/usage_tenants_request.rb +13 -0
  27. data/lib/CloudPDF/types/doc_annotations_create400response_code.rb +1 -0
  28. data/lib/CloudPDF/types/doc_annotations_create404response_code.rb +1 -0
  29. data/lib/CloudPDF/types/doc_annotations_delete404response_code.rb +1 -0
  30. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_caret.rb +4 -0
  31. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_caret_unrotated_rect.rb +15 -0
  32. data/lib/CloudPDF/types/doc_annotations_list404response_code.rb +1 -0
  33. data/lib/CloudPDF/types/doc_annotations_update400response_code.rb +1 -0
  34. data/lib/CloudPDF/types/doc_annotations_update404response_code.rb +1 -0
  35. data/lib/CloudPDF/types/doc_download_response_code.rb +1 -0
  36. data/lib/CloudPDF/types/doc_forms_export_data_response_code.rb +1 -0
  37. data/lib/CloudPDF/types/doc_forms_get404response_code.rb +1 -0
  38. data/lib/CloudPDF/types/doc_forms_import_data400response_code.rb +1 -0
  39. data/lib/CloudPDF/types/doc_forms_import_data404response_code.rb +1 -0
  40. data/lib/CloudPDF/types/doc_forms_reset404response_code.rb +1 -0
  41. data/lib/CloudPDF/types/doc_forms_set_value400response_code.rb +1 -0
  42. data/lib/CloudPDF/types/doc_forms_set_value404response_code.rb +1 -0
  43. data/lib/CloudPDF/types/doc_head404response_code.rb +1 -0
  44. data/lib/CloudPDF/types/doc_manifest404response_code.rb +1 -0
  45. data/lib/CloudPDF/types/doc_metadata_get404response_code.rb +1 -0
  46. data/lib/CloudPDF/types/doc_pages_delete400response_code.rb +1 -0
  47. data/lib/CloudPDF/types/doc_pages_delete404response_code.rb +1 -0
  48. data/lib/CloudPDF/types/doc_pages_flatten400response_code.rb +1 -0
  49. data/lib/CloudPDF/types/doc_pages_flatten404response_code.rb +1 -0
  50. data/lib/CloudPDF/types/doc_pages_move400response_code.rb +1 -0
  51. data/lib/CloudPDF/types/doc_pages_move404response_code.rb +1 -0
  52. data/lib/CloudPDF/types/doc_pages_rotate400response_code.rb +1 -0
  53. data/lib/CloudPDF/types/doc_pages_rotate404response_code.rb +1 -0
  54. data/lib/CloudPDF/types/doc_redactions_apply400response_code.rb +1 -0
  55. data/lib/CloudPDF/types/doc_redactions_apply404response_code.rb +1 -0
  56. data/lib/CloudPDF/types/doc_render_response_code.rb +1 -0
  57. data/lib/CloudPDF/types/doc_text200response.rb +2 -0
  58. data/lib/CloudPDF/types/doc_text404response_code.rb +1 -0
  59. data/lib/CloudPDF/types/documents_import_from200response.rb +11 -0
  60. data/lib/CloudPDF/types/documents_import_from200response_document.rb +33 -0
  61. data/lib/CloudPDF/types/documents_import_from200response_document_state.rb +14 -0
  62. data/lib/CloudPDF/types/documents_import_from200response_document_thumbnail_state.rb +14 -0
  63. data/lib/CloudPDF/types/documents_import_from200response_tag.rb +13 -0
  64. data/lib/CloudPDF/types/documents_import_from202response.rb +11 -0
  65. data/lib/CloudPDF/types/documents_import_from202response_document.rb +33 -0
  66. data/lib/CloudPDF/types/documents_import_from202response_document_state.rb +14 -0
  67. data/lib/CloudPDF/types/documents_import_from202response_document_thumbnail_state.rb +14 -0
  68. data/lib/CloudPDF/types/documents_import_from202response_tag.rb +13 -0
  69. data/lib/CloudPDF/types/documents_import_from400response.rb +9 -0
  70. data/lib/CloudPDF/types/{documents_upload_direct400response_error.rb → documents_import_from400response_error.rb} +1 -1
  71. data/lib/CloudPDF/types/documents_import_from403response.rb +9 -0
  72. data/lib/CloudPDF/types/documents_import_from403response_error.rb +11 -0
  73. data/lib/CloudPDF/types/documents_import_from502response.rb +9 -0
  74. data/lib/CloudPDF/types/documents_import_from502response_error.rb +11 -0
  75. data/lib/CloudPDF/types/documents_init200response_created_upload.rb +1 -1
  76. data/lib/CloudPDF/types/{documents_init200response_created_upload_direct.rb → documents_init200response_created_upload_proxy.rb} +1 -1
  77. data/lib/CloudPDF/types/documents_init200response_resumed_upload.rb +1 -1
  78. data/lib/CloudPDF/types/{documents_init200response_resumed_upload_direct.rb → documents_init200response_resumed_upload_proxy.rb} +1 -1
  79. data/lib/CloudPDF/types/{documents_upload_direct200response.rb → documents_upload_proxy200response.rb} +1 -1
  80. data/lib/CloudPDF/types/documents_upload_proxy400response.rb +9 -0
  81. data/lib/CloudPDF/types/documents_upload_proxy400response_error.rb +11 -0
  82. data/lib/CloudPDF/types/documents_upload_proxy409response.rb +9 -0
  83. data/lib/CloudPDF/types/documents_upload_proxy409response_error.rb +11 -0
  84. data/lib/CloudPDF/types/engine_error_payload_code.rb +1 -0
  85. data/lib/CloudPDF/types/shares_create200response.rb +9 -0
  86. data/lib/CloudPDF/types/shares_create200response_share.rb +37 -0
  87. data/lib/CloudPDF/types/shares_create400response.rb +9 -0
  88. data/lib/CloudPDF/types/shares_create400response_error.rb +11 -0
  89. data/lib/CloudPDF/types/shares_create403response.rb +9 -0
  90. data/lib/CloudPDF/types/shares_create403response_error.rb +11 -0
  91. data/lib/CloudPDF/types/shares_create404response.rb +9 -0
  92. data/lib/CloudPDF/types/shares_create404response_error.rb +11 -0
  93. data/lib/CloudPDF/types/shares_delete_response.rb +9 -0
  94. data/lib/CloudPDF/types/shares_delete_response_error.rb +11 -0
  95. data/lib/CloudPDF/types/shares_exchange200response.rb +15 -0
  96. data/lib/CloudPDF/types/shares_exchange400response.rb +9 -0
  97. data/lib/CloudPDF/types/shares_exchange400response_error.rb +11 -0
  98. data/lib/CloudPDF/types/shares_exchange403response.rb +9 -0
  99. data/lib/CloudPDF/types/shares_exchange403response_error.rb +11 -0
  100. data/lib/CloudPDF/types/shares_exchange404response.rb +9 -0
  101. data/lib/CloudPDF/types/shares_exchange404response_error.rb +11 -0
  102. data/lib/CloudPDF/types/shares_exchange410response.rb +9 -0
  103. data/lib/CloudPDF/types/shares_exchange410response_error.rb +11 -0
  104. data/lib/CloudPDF/types/shares_exchange422response.rb +9 -0
  105. data/lib/CloudPDF/types/shares_exchange422response_error.rb +11 -0
  106. data/lib/CloudPDF/types/shares_get200response.rb +9 -0
  107. data/lib/CloudPDF/types/shares_get200response_share.rb +37 -0
  108. data/lib/CloudPDF/types/shares_get404response.rb +9 -0
  109. data/lib/CloudPDF/types/shares_get404response_error.rb +11 -0
  110. data/lib/CloudPDF/types/shares_list200response.rb +11 -0
  111. data/lib/CloudPDF/types/shares_list200response_shares_item.rb +37 -0
  112. data/lib/CloudPDF/types/shares_list400response.rb +9 -0
  113. data/lib/CloudPDF/types/shares_list400response_error.rb +11 -0
  114. data/lib/CloudPDF/types/shares_update200response.rb +9 -0
  115. data/lib/CloudPDF/types/shares_update200response_share.rb +37 -0
  116. data/lib/CloudPDF/types/shares_update400response.rb +9 -0
  117. data/lib/CloudPDF/types/shares_update400response_error.rb +11 -0
  118. data/lib/CloudPDF/types/shares_update404response.rb +9 -0
  119. data/lib/CloudPDF/types/shares_update404response_error.rb +11 -0
  120. data/lib/CloudPDF/types/tenants_create200response_tenant.rb +2 -0
  121. data/lib/CloudPDF/types/tenants_create200response_tenant_status.rb +12 -0
  122. data/lib/CloudPDF/types/tenants_get200response_tenant.rb +2 -0
  123. data/lib/CloudPDF/types/tenants_get200response_tenant_status.rb +12 -0
  124. data/lib/CloudPDF/types/tenants_list200response_tenants_item.rb +2 -0
  125. data/lib/CloudPDF/types/tenants_list200response_tenants_item_status.rb +12 -0
  126. data/lib/CloudPDF/types/tenants_resume_response.rb +9 -0
  127. data/lib/CloudPDF/types/tenants_resume_response_error.rb +11 -0
  128. data/lib/CloudPDF/types/tenants_suspend_response.rb +9 -0
  129. data/lib/CloudPDF/types/tenants_suspend_response_error.rb +11 -0
  130. data/lib/CloudPDF/types/tenants_usage200response.rb +15 -0
  131. data/lib/CloudPDF/types/tenants_usage200response_metrics.rb +13 -0
  132. data/lib/CloudPDF/types/tenants_usage400response.rb +9 -0
  133. data/lib/CloudPDF/types/tenants_usage400response_error.rb +11 -0
  134. data/lib/CloudPDF/types/tenants_usage404response.rb +9 -0
  135. data/lib/CloudPDF/types/tenants_usage404response_error.rb +11 -0
  136. data/lib/CloudPDF/types/tokens_issue_request_doc.rb +2 -0
  137. data/lib/CloudPDF/types/tokens_issue_request_tenant_scope_item_one.rb +1 -0
  138. data/lib/CloudPDF/version.rb +1 -1
  139. data/lib/cloudpdf.rb +91 -5
  140. data/reference.md +904 -24
  141. metadata +93 -7
  142. data/lib/CloudPDF/types/documents_upload_direct400response.rb +0 -9
data/reference.md CHANGED
@@ -393,6 +393,496 @@ client.doc.text(
393
393
  </dl>
394
394
 
395
395
 
396
+ </dd>
397
+ </dl>
398
+ </details>
399
+
400
+ ## Shares
401
+ <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">exchange</a>(request) -> CloudPDF::Types::SharesExchange200Response</code></summary>
402
+ <dl>
403
+ <dd>
404
+
405
+ #### 📝 Description
406
+
407
+ <dl>
408
+ <dd>
409
+
410
+ <dl>
411
+ <dd>
412
+
413
+ Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, revoked, and disabled tokens are indistinguishable (404). Passphrase-protected grants return 422 SharePasswordRequired until `password` is supplied. Mounted only when the deployment can sign (HS256 mode).
414
+ </dd>
415
+ </dl>
416
+ </dd>
417
+ </dl>
418
+
419
+ #### 🔌 Usage
420
+
421
+ <dl>
422
+ <dd>
423
+
424
+ <dl>
425
+ <dd>
426
+
427
+ ```ruby
428
+ client.shares.exchange(share_token: "shareToken")
429
+ ```
430
+ </dd>
431
+ </dl>
432
+ </dd>
433
+ </dl>
434
+
435
+ #### ⚙️ Parameters
436
+
437
+ <dl>
438
+ <dd>
439
+
440
+ <dl>
441
+ <dd>
442
+
443
+ **share_token:** `String`
444
+
445
+ </dd>
446
+ </dl>
447
+
448
+ <dl>
449
+ <dd>
450
+
451
+ **password:** `String`
452
+
453
+ </dd>
454
+ </dl>
455
+
456
+ <dl>
457
+ <dd>
458
+
459
+ **request_options:** `CloudPDF::Shares::RequestOptions`
460
+
461
+ </dd>
462
+ </dl>
463
+ </dd>
464
+ </dl>
465
+
466
+
467
+ </dd>
468
+ </dl>
469
+ </details>
470
+
471
+ <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">list</a>(tenant_id:) -> CloudPDF::Types::SharesList200Response</code></summary>
472
+ <dl>
473
+ <dd>
474
+
475
+ #### 🔌 Usage
476
+
477
+ <dl>
478
+ <dd>
479
+
480
+ <dl>
481
+ <dd>
482
+
483
+ ```ruby
484
+ client.shares.list(tenant_id: "tenantId")
485
+ ```
486
+ </dd>
487
+ </dl>
488
+ </dd>
489
+ </dl>
490
+
491
+ #### ⚙️ Parameters
492
+
493
+ <dl>
494
+ <dd>
495
+
496
+ <dl>
497
+ <dd>
498
+
499
+ **tenant_id:** `String`
500
+
501
+ </dd>
502
+ </dl>
503
+
504
+ <dl>
505
+ <dd>
506
+
507
+ **limit:** `Integer`
508
+
509
+ </dd>
510
+ </dl>
511
+
512
+ <dl>
513
+ <dd>
514
+
515
+ **cursor:** `String`
516
+
517
+ </dd>
518
+ </dl>
519
+
520
+ <dl>
521
+ <dd>
522
+
523
+ **doc_id:** `String`
524
+
525
+ </dd>
526
+ </dl>
527
+
528
+ <dl>
529
+ <dd>
530
+
531
+ **request_options:** `CloudPDF::Shares::RequestOptions`
532
+
533
+ </dd>
534
+ </dl>
535
+ </dd>
536
+ </dl>
537
+
538
+
539
+ </dd>
540
+ </dl>
541
+ </details>
542
+
543
+ <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">create</a>(tenant_id:, request) -> CloudPDF::Types::SharesCreate200Response</code></summary>
544
+ <dl>
545
+ <dd>
546
+
547
+ #### 📝 Description
548
+
549
+ <dl>
550
+ <dd>
551
+
552
+ <dl>
553
+ <dd>
554
+
555
+ The returned share id IS the public share token. Mounted only when the deployment can sign (HS256 mode) — exchange mints session JWTs, so grants exist only where minting does.
556
+ </dd>
557
+ </dl>
558
+ </dd>
559
+ </dl>
560
+
561
+ #### 🔌 Usage
562
+
563
+ <dl>
564
+ <dd>
565
+
566
+ <dl>
567
+ <dd>
568
+
569
+ ```ruby
570
+ client.shares.create(
571
+ tenant_id: "tenantId",
572
+ doc_id: "docId",
573
+ scope: ["scope"]
574
+ )
575
+ ```
576
+ </dd>
577
+ </dl>
578
+ </dd>
579
+ </dl>
580
+
581
+ #### ⚙️ Parameters
582
+
583
+ <dl>
584
+ <dd>
585
+
586
+ <dl>
587
+ <dd>
588
+
589
+ **tenant_id:** `String`
590
+
591
+ </dd>
592
+ </dl>
593
+
594
+ <dl>
595
+ <dd>
596
+
597
+ **doc_id:** `String`
598
+
599
+ </dd>
600
+ </dl>
601
+
602
+ <dl>
603
+ <dd>
604
+
605
+ **layer_name:** `String`
606
+
607
+ </dd>
608
+ </dl>
609
+
610
+ <dl>
611
+ <dd>
612
+
613
+ **scope:** `Internal::Types::Array[String]`
614
+
615
+ </dd>
616
+ </dl>
617
+
618
+ <dl>
619
+ <dd>
620
+
621
+ **origins:** `Internal::Types::Array[String]`
622
+
623
+ </dd>
624
+ </dl>
625
+
626
+ <dl>
627
+ <dd>
628
+
629
+ **password:** `String`
630
+
631
+ </dd>
632
+ </dl>
633
+
634
+ <dl>
635
+ <dd>
636
+
637
+ **session_ttl_seconds:** `Integer`
638
+
639
+ </dd>
640
+ </dl>
641
+
642
+ <dl>
643
+ <dd>
644
+
645
+ **expires_at:** `Integer`
646
+
647
+ </dd>
648
+ </dl>
649
+
650
+ <dl>
651
+ <dd>
652
+
653
+ **request_options:** `CloudPDF::Shares::RequestOptions`
654
+
655
+ </dd>
656
+ </dl>
657
+ </dd>
658
+ </dl>
659
+
660
+
661
+ </dd>
662
+ </dl>
663
+ </details>
664
+
665
+ <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">get</a>(tenant_id:, share_id:) -> CloudPDF::Types::SharesGet200Response</code></summary>
666
+ <dl>
667
+ <dd>
668
+
669
+ #### 🔌 Usage
670
+
671
+ <dl>
672
+ <dd>
673
+
674
+ <dl>
675
+ <dd>
676
+
677
+ ```ruby
678
+ client.shares.get(
679
+ tenant_id: "tenantId",
680
+ share_id: "shareId"
681
+ )
682
+ ```
683
+ </dd>
684
+ </dl>
685
+ </dd>
686
+ </dl>
687
+
688
+ #### ⚙️ Parameters
689
+
690
+ <dl>
691
+ <dd>
692
+
693
+ <dl>
694
+ <dd>
695
+
696
+ **tenant_id:** `String`
697
+
698
+ </dd>
699
+ </dl>
700
+
701
+ <dl>
702
+ <dd>
703
+
704
+ **share_id:** `String`
705
+
706
+ </dd>
707
+ </dl>
708
+
709
+ <dl>
710
+ <dd>
711
+
712
+ **request_options:** `CloudPDF::Shares::RequestOptions`
713
+
714
+ </dd>
715
+ </dl>
716
+ </dd>
717
+ </dl>
718
+
719
+
720
+ </dd>
721
+ </dl>
722
+ </details>
723
+
724
+ <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">delete</a>(tenant_id:, share_id:) -> </code></summary>
725
+ <dl>
726
+ <dd>
727
+
728
+ #### 🔌 Usage
729
+
730
+ <dl>
731
+ <dd>
732
+
733
+ <dl>
734
+ <dd>
735
+
736
+ ```ruby
737
+ client.shares.delete(
738
+ tenant_id: "tenantId",
739
+ share_id: "shareId"
740
+ )
741
+ ```
742
+ </dd>
743
+ </dl>
744
+ </dd>
745
+ </dl>
746
+
747
+ #### ⚙️ Parameters
748
+
749
+ <dl>
750
+ <dd>
751
+
752
+ <dl>
753
+ <dd>
754
+
755
+ **tenant_id:** `String`
756
+
757
+ </dd>
758
+ </dl>
759
+
760
+ <dl>
761
+ <dd>
762
+
763
+ **share_id:** `String`
764
+
765
+ </dd>
766
+ </dl>
767
+
768
+ <dl>
769
+ <dd>
770
+
771
+ **request_options:** `CloudPDF::Shares::RequestOptions`
772
+
773
+ </dd>
774
+ </dl>
775
+ </dd>
776
+ </dl>
777
+
778
+
779
+ </dd>
780
+ </dl>
781
+ </details>
782
+
783
+ <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">update</a>(tenant_id:, share_id:, request) -> CloudPDF::Types::SharesUpdate200Response</code></summary>
784
+ <dl>
785
+ <dd>
786
+
787
+ #### 🔌 Usage
788
+
789
+ <dl>
790
+ <dd>
791
+
792
+ <dl>
793
+ <dd>
794
+
795
+ ```ruby
796
+ client.shares.update(
797
+ tenant_id: "tenantId",
798
+ share_id: "shareId"
799
+ )
800
+ ```
801
+ </dd>
802
+ </dl>
803
+ </dd>
804
+ </dl>
805
+
806
+ #### ⚙️ Parameters
807
+
808
+ <dl>
809
+ <dd>
810
+
811
+ <dl>
812
+ <dd>
813
+
814
+ **tenant_id:** `String`
815
+
816
+ </dd>
817
+ </dl>
818
+
819
+ <dl>
820
+ <dd>
821
+
822
+ **share_id:** `String`
823
+
824
+ </dd>
825
+ </dl>
826
+
827
+ <dl>
828
+ <dd>
829
+
830
+ **scope:** `Internal::Types::Array[String]`
831
+
832
+ </dd>
833
+ </dl>
834
+
835
+ <dl>
836
+ <dd>
837
+
838
+ **origins:** `Internal::Types::Array[String]`
839
+
840
+ </dd>
841
+ </dl>
842
+
843
+ <dl>
844
+ <dd>
845
+
846
+ **password:** `String`
847
+
848
+ </dd>
849
+ </dl>
850
+
851
+ <dl>
852
+ <dd>
853
+
854
+ **session_ttl_seconds:** `Integer`
855
+
856
+ </dd>
857
+ </dl>
858
+
859
+ <dl>
860
+ <dd>
861
+
862
+ **disabled:** `Internal::Types::Boolean`
863
+
864
+ </dd>
865
+ </dl>
866
+
867
+ <dl>
868
+ <dd>
869
+
870
+ **expires_at:** `Integer`
871
+
872
+ </dd>
873
+ </dl>
874
+
875
+ <dl>
876
+ <dd>
877
+
878
+ **request_options:** `CloudPDF::Shares::RequestOptions`
879
+
880
+ </dd>
881
+ </dl>
882
+ </dd>
883
+ </dl>
884
+
885
+
396
886
  </dd>
397
887
  </dl>
398
888
  </details>
@@ -402,7 +892,167 @@ client.doc.text(
402
892
  <dl>
403
893
  <dd>
404
894
 
405
- #### 🔌 Usage
895
+ #### 🔌 Usage
896
+
897
+ <dl>
898
+ <dd>
899
+
900
+ <dl>
901
+ <dd>
902
+
903
+ ```ruby
904
+ client.tenants.list
905
+ ```
906
+ </dd>
907
+ </dl>
908
+ </dd>
909
+ </dl>
910
+
911
+ #### ⚙️ Parameters
912
+
913
+ <dl>
914
+ <dd>
915
+
916
+ <dl>
917
+ <dd>
918
+
919
+ **limit:** `Integer`
920
+
921
+ </dd>
922
+ </dl>
923
+
924
+ <dl>
925
+ <dd>
926
+
927
+ **cursor:** `String`
928
+
929
+ </dd>
930
+ </dl>
931
+
932
+ <dl>
933
+ <dd>
934
+
935
+ **request_options:** `CloudPDF::Tenants::RequestOptions`
936
+
937
+ </dd>
938
+ </dl>
939
+ </dd>
940
+ </dl>
941
+
942
+
943
+ </dd>
944
+ </dl>
945
+ </details>
946
+
947
+ <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">create</a>(request) -> CloudPDF::Types::TenantsCreate200Response</code></summary>
948
+ <dl>
949
+ <dd>
950
+
951
+ #### 🔌 Usage
952
+
953
+ <dl>
954
+ <dd>
955
+
956
+ <dl>
957
+ <dd>
958
+
959
+ ```ruby
960
+ client.tenants.create(id: "id")
961
+ ```
962
+ </dd>
963
+ </dl>
964
+ </dd>
965
+ </dl>
966
+
967
+ #### ⚙️ Parameters
968
+
969
+ <dl>
970
+ <dd>
971
+
972
+ <dl>
973
+ <dd>
974
+
975
+ **id:** `String`
976
+
977
+ </dd>
978
+ </dl>
979
+
980
+ <dl>
981
+ <dd>
982
+
983
+ **name:** `String`
984
+
985
+ </dd>
986
+ </dl>
987
+
988
+ <dl>
989
+ <dd>
990
+
991
+ **request_options:** `CloudPDF::Tenants::RequestOptions`
992
+
993
+ </dd>
994
+ </dl>
995
+ </dd>
996
+ </dl>
997
+
998
+
999
+ </dd>
1000
+ </dl>
1001
+ </details>
1002
+
1003
+ <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">get</a>(tenant_id:) -> CloudPDF::Types::TenantsGet200Response</code></summary>
1004
+ <dl>
1005
+ <dd>
1006
+
1007
+ #### 🔌 Usage
1008
+
1009
+ <dl>
1010
+ <dd>
1011
+
1012
+ <dl>
1013
+ <dd>
1014
+
1015
+ ```ruby
1016
+ client.tenants.get(tenant_id: "tenantId")
1017
+ ```
1018
+ </dd>
1019
+ </dl>
1020
+ </dd>
1021
+ </dl>
1022
+
1023
+ #### ⚙️ Parameters
1024
+
1025
+ <dl>
1026
+ <dd>
1027
+
1028
+ <dl>
1029
+ <dd>
1030
+
1031
+ **tenant_id:** `String`
1032
+
1033
+ </dd>
1034
+ </dl>
1035
+
1036
+ <dl>
1037
+ <dd>
1038
+
1039
+ **request_options:** `CloudPDF::Tenants::RequestOptions`
1040
+
1041
+ </dd>
1042
+ </dl>
1043
+ </dd>
1044
+ </dl>
1045
+
1046
+
1047
+ </dd>
1048
+ </dl>
1049
+ </details>
1050
+
1051
+ <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">delete</a>(tenant_id:) -> </code></summary>
1052
+ <dl>
1053
+ <dd>
1054
+
1055
+ #### 📝 Description
406
1056
 
407
1057
  <dl>
408
1058
  <dd>
@@ -410,15 +1060,13 @@ client.doc.text(
410
1060
  <dl>
411
1061
  <dd>
412
1062
 
413
- ```ruby
414
- client.tenants.list
415
- ```
1063
+ Destroys the tenant and everything in its namespace — documents, layers, stored bytes, audit history. Irreversible.
416
1064
  </dd>
417
1065
  </dl>
418
1066
  </dd>
419
1067
  </dl>
420
1068
 
421
- #### ⚙️ Parameters
1069
+ #### 🔌 Usage
422
1070
 
423
1071
  <dl>
424
1072
  <dd>
@@ -426,15 +1074,23 @@ client.tenants.list
426
1074
  <dl>
427
1075
  <dd>
428
1076
 
429
- **limit:** `Integer`
430
-
1077
+ ```ruby
1078
+ client.tenants.delete(tenant_id: "tenantId")
1079
+ ```
1080
+ </dd>
1081
+ </dl>
431
1082
  </dd>
432
1083
  </dl>
433
1084
 
1085
+ #### ⚙️ Parameters
1086
+
434
1087
  <dl>
435
1088
  <dd>
436
1089
 
437
- **cursor:** `String`
1090
+ <dl>
1091
+ <dd>
1092
+
1093
+ **tenant_id:** `String`
438
1094
 
439
1095
  </dd>
440
1096
  </dl>
@@ -454,7 +1110,7 @@ client.tenants.list
454
1110
  </dl>
455
1111
  </details>
456
1112
 
457
- <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">create</a>(request) -> CloudPDF::Types::TenantsCreate200Response</code></summary>
1113
+ <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">resume</a>(tenant_id:) -> </code></summary>
458
1114
  <dl>
459
1115
  <dd>
460
1116
 
@@ -467,7 +1123,7 @@ client.tenants.list
467
1123
  <dd>
468
1124
 
469
1125
  ```ruby
470
- client.tenants.create(id: "id")
1126
+ client.tenants.resume(tenant_id: "tenantId")
471
1127
  ```
472
1128
  </dd>
473
1129
  </dl>
@@ -482,15 +1138,7 @@ client.tenants.create(id: "id")
482
1138
  <dl>
483
1139
  <dd>
484
1140
 
485
- **id:** `String`
486
-
487
- </dd>
488
- </dl>
489
-
490
- <dl>
491
- <dd>
492
-
493
- **name:** `String`
1141
+ **tenant_id:** `String`
494
1142
 
495
1143
  </dd>
496
1144
  </dl>
@@ -510,10 +1158,24 @@ client.tenants.create(id: "id")
510
1158
  </dl>
511
1159
  </details>
512
1160
 
513
- <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">get</a>(tenant_id:) -> CloudPDF::Types::TenantsGet200Response</code></summary>
1161
+ <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">suspend</a>(tenant_id:, request) -> </code></summary>
1162
+ <dl>
1163
+ <dd>
1164
+
1165
+ #### 📝 Description
1166
+
514
1167
  <dl>
515
1168
  <dd>
516
1169
 
1170
+ <dl>
1171
+ <dd>
1172
+
1173
+ Instantly reversible with resume. The API token is exempt, so a suspended tenant can still be inspected, exported, resumed, or deleted.
1174
+ </dd>
1175
+ </dl>
1176
+ </dd>
1177
+ </dl>
1178
+
517
1179
  #### 🔌 Usage
518
1180
 
519
1181
  <dl>
@@ -523,7 +1185,7 @@ client.tenants.create(id: "id")
523
1185
  <dd>
524
1186
 
525
1187
  ```ruby
526
- client.tenants.get(tenant_id: "tenantId")
1188
+ client.tenants.suspend(tenant_id: "tenantId")
527
1189
  ```
528
1190
  </dd>
529
1191
  </dl>
@@ -546,6 +1208,14 @@ client.tenants.get(tenant_id: "tenantId")
546
1208
  <dl>
547
1209
  <dd>
548
1210
 
1211
+ **reason:** `String`
1212
+
1213
+ </dd>
1214
+ </dl>
1215
+
1216
+ <dl>
1217
+ <dd>
1218
+
549
1219
  **request_options:** `CloudPDF::Tenants::RequestOptions`
550
1220
 
551
1221
  </dd>
@@ -558,7 +1228,7 @@ client.tenants.get(tenant_id: "tenantId")
558
1228
  </dl>
559
1229
  </details>
560
1230
 
561
- <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">delete</a>(tenant_id:) -> </code></summary>
1231
+ <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">usage</a>(tenant_id:) -> CloudPDF::Types::TenantsUsage200Response</code></summary>
562
1232
  <dl>
563
1233
  <dd>
564
1234
 
@@ -570,7 +1240,7 @@ client.tenants.get(tenant_id: "tenantId")
570
1240
  <dl>
571
1241
  <dd>
572
1242
 
573
- Destroys the tenant and everything in its namespace — documents, layers, stored bytes, audit history. Irreversible.
1243
+ Facts only — no limits or billing state. Views count share exchanges plus authorized /v1/access grants, deduplicated across the two.
574
1244
  </dd>
575
1245
  </dl>
576
1246
  </dd>
@@ -585,7 +1255,7 @@ Destroys the tenant and everything in its namespace — documents, layers, store
585
1255
  <dd>
586
1256
 
587
1257
  ```ruby
588
- client.tenants.delete(tenant_id: "tenantId")
1258
+ client.tenants.usage(tenant_id: "tenantId")
589
1259
  ```
590
1260
  </dd>
591
1261
  </dl>
@@ -608,6 +1278,14 @@ client.tenants.delete(tenant_id: "tenantId")
608
1278
  <dl>
609
1279
  <dd>
610
1280
 
1281
+ **period:** `String`
1282
+
1283
+ </dd>
1284
+ </dl>
1285
+
1286
+ <dl>
1287
+ <dd>
1288
+
611
1289
  **request_options:** `CloudPDF::Tenants::RequestOptions`
612
1290
 
613
1291
  </dd>
@@ -993,6 +1671,200 @@ client.documents.thumbnail(
993
1671
  </dl>
994
1672
 
995
1673
 
1674
+ </dd>
1675
+ </dl>
1676
+ </details>
1677
+
1678
+ <details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">upload_proxy</a>(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsUploadProxy200Response</code></summary>
1679
+ <dl>
1680
+ <dd>
1681
+
1682
+ #### 📝 Description
1683
+
1684
+ <dl>
1685
+ <dd>
1686
+
1687
+ <dl>
1688
+ <dd>
1689
+
1690
+ This bounded origin-mediated fallback must only be used after documents.init returns upload.kind=proxy. Auto mode prefers a presigned object-store PUT whenever available.
1691
+ </dd>
1692
+ </dl>
1693
+ </dd>
1694
+ </dl>
1695
+
1696
+ #### 🔌 Usage
1697
+
1698
+ <dl>
1699
+ <dd>
1700
+
1701
+ <dl>
1702
+ <dd>
1703
+
1704
+ ```ruby
1705
+ File.open("document.pdf", "rb") do |file|
1706
+ client.documents.upload_proxy(
1707
+ tenant_id: "tenantId",
1708
+ id: "id",
1709
+ file: file
1710
+ )
1711
+ end
1712
+ ```
1713
+ </dd>
1714
+ </dl>
1715
+ </dd>
1716
+ </dl>
1717
+
1718
+ #### ⚙️ Parameters
1719
+
1720
+ <dl>
1721
+ <dd>
1722
+
1723
+ <dl>
1724
+ <dd>
1725
+
1726
+ **tenant_id:** `String`
1727
+
1728
+ </dd>
1729
+ </dl>
1730
+
1731
+ <dl>
1732
+ <dd>
1733
+
1734
+ **id:** `String`
1735
+
1736
+ </dd>
1737
+ </dl>
1738
+
1739
+ <dl>
1740
+ <dd>
1741
+
1742
+ **request_options:** `CloudPDF::Documents::RequestOptions`
1743
+
1744
+ </dd>
1745
+ </dl>
1746
+ </dd>
1747
+ </dl>
1748
+
1749
+
1750
+ </dd>
1751
+ </dl>
1752
+ </details>
1753
+
1754
+ <details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">import_from</a>(tenant_id:, request) -> CloudPDF::Types::DocumentsImportFrom200Response</code></summary>
1755
+ <dl>
1756
+ <dd>
1757
+
1758
+ #### 📝 Description
1759
+
1760
+ <dl>
1761
+ <dd>
1762
+
1763
+ <dl>
1764
+ <dd>
1765
+
1766
+ Default mode is synchronous and bounded: the response returns only after the transfer verified and committed (or failed). mode=async (connection sources only) answers 202 immediately and an in-process worker performs the transfer with leased, fenced retries; poll the document until ready/failed. The deployment import policy gates scheme, network range, and size; sources must declare a length. CloudPDF copies and owns the bytes — the source is never referenced in place. A 502 marks a retryable upstream failure: retry with the same idempotencyKey to resume the same document. URL sources are capabilities and never echoed back. Connection sources name operator-registered storage (bucket/prefix scope, allowed credential classes, and tenant bindings are deployment configuration); `revision` is provider-interpreted (S3 VersionId, GCS generation, Azure version id).
1767
+ </dd>
1768
+ </dl>
1769
+ </dd>
1770
+ </dl>
1771
+
1772
+ #### 🔌 Usage
1773
+
1774
+ <dl>
1775
+ <dd>
1776
+
1777
+ <dl>
1778
+ <dd>
1779
+
1780
+ ```ruby
1781
+ client.documents.import_from(tenant_id: "tenantId")
1782
+ ```
1783
+ </dd>
1784
+ </dl>
1785
+ </dd>
1786
+ </dl>
1787
+
1788
+ #### ⚙️ Parameters
1789
+
1790
+ <dl>
1791
+ <dd>
1792
+
1793
+ <dl>
1794
+ <dd>
1795
+
1796
+ **tenant_id:** `String`
1797
+
1798
+ </dd>
1799
+ </dl>
1800
+
1801
+ <dl>
1802
+ <dd>
1803
+
1804
+ **source:** `CloudPDF::Documents::Types::DocumentsImportFromRequestSource`
1805
+
1806
+ </dd>
1807
+ </dl>
1808
+
1809
+ <dl>
1810
+ <dd>
1811
+
1812
+ **expected:** `CloudPDF::Documents::Types::DocumentsImportFromRequestExpected`
1813
+
1814
+ </dd>
1815
+ </dl>
1816
+
1817
+ <dl>
1818
+ <dd>
1819
+
1820
+ **metadata:** `Internal::Types::Hash[String, Object]`
1821
+
1822
+ </dd>
1823
+ </dl>
1824
+
1825
+ <dl>
1826
+ <dd>
1827
+
1828
+ **idempotency_key:** `String`
1829
+
1830
+ </dd>
1831
+ </dl>
1832
+
1833
+ <dl>
1834
+ <dd>
1835
+
1836
+ **dedup_mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestDedupMode`
1837
+
1838
+ </dd>
1839
+ </dl>
1840
+
1841
+ <dl>
1842
+ <dd>
1843
+
1844
+ **doc_id:** `String`
1845
+
1846
+ </dd>
1847
+ </dl>
1848
+
1849
+ <dl>
1850
+ <dd>
1851
+
1852
+ **mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestMode`
1853
+
1854
+ </dd>
1855
+ </dl>
1856
+
1857
+ <dl>
1858
+ <dd>
1859
+
1860
+ **request_options:** `CloudPDF::Documents::RequestOptions`
1861
+
1862
+ </dd>
1863
+ </dl>
1864
+ </dd>
1865
+ </dl>
1866
+
1867
+
996
1868
  </dd>
997
1869
  </dl>
998
1870
  </details>
@@ -1093,6 +1965,14 @@ client.documents.init(
1093
1965
  <dl>
1094
1966
  <dd>
1095
1967
 
1968
+ **upload_preference:** `CloudPDF::Documents::Types::DocumentsInitRequestUploadPreference`
1969
+
1970
+ </dd>
1971
+ </dl>
1972
+
1973
+ <dl>
1974
+ <dd>
1975
+
1096
1976
  **request_options:** `CloudPDF::Documents::RequestOptions`
1097
1977
 
1098
1978
  </dd>