cloudpdf 3.0.0.alpha.1 → 3.0.0.alpha.5
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/README.md +5 -5
- data/lib/CloudPDF/client.rb +5 -0
- data/lib/CloudPDF/documents/client.rb +23 -6
- data/lib/CloudPDF/documents/types/documents_init_request.rb +2 -0
- data/lib/CloudPDF/documents/types/documents_init_request_upload_preference.rb +15 -0
- data/lib/CloudPDF/documents/types/upload_proxy_documents_request.rb +15 -0
- data/lib/CloudPDF/shares/client.rb +264 -0
- data/lib/CloudPDF/shares/types/delete_shares_request.rb +13 -0
- data/lib/CloudPDF/shares/types/get_shares_request.rb +13 -0
- data/lib/CloudPDF/shares/types/list_shares_request.rb +17 -0
- data/lib/CloudPDF/shares/types/shares_create_request.rb +25 -0
- data/lib/CloudPDF/shares/types/shares_exchange_request.rb +13 -0
- data/lib/CloudPDF/shares/types/shares_update_request.rb +25 -0
- data/lib/CloudPDF/tenants/client.rb +117 -0
- data/lib/CloudPDF/tenants/types/resume_tenants_request.rb +11 -0
- data/lib/CloudPDF/tenants/types/tenants_suspend_request.rb +13 -0
- data/lib/CloudPDF/tenants/types/usage_tenants_request.rb +13 -0
- data/lib/CloudPDF/types/doc_annotations_create400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_annotations_create404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_annotations_delete404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_caret.rb +4 -0
- data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_caret_unrotated_rect.rb +15 -0
- data/lib/CloudPDF/types/doc_annotations_list404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_annotations_update400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_annotations_update404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_download_response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_forms_export_data_response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_forms_get404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_forms_import_data400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_forms_import_data404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_forms_reset404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_forms_set_value400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_forms_set_value404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_head404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_manifest404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_metadata_get404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_pages_delete400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_pages_delete404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_pages_flatten400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_pages_flatten404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_pages_move400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_pages_move404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_pages_rotate400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_pages_rotate404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_redactions_apply400response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_redactions_apply404response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_render_response_code.rb +1 -0
- data/lib/CloudPDF/types/doc_text200response.rb +2 -0
- data/lib/CloudPDF/types/doc_text404response_code.rb +1 -0
- data/lib/CloudPDF/types/documents_init200response_created_upload.rb +1 -1
- data/lib/CloudPDF/types/{documents_init200response_created_upload_direct.rb → documents_init200response_created_upload_proxy.rb} +1 -1
- data/lib/CloudPDF/types/documents_init200response_resumed_upload.rb +1 -1
- data/lib/CloudPDF/types/{documents_init200response_resumed_upload_direct.rb → documents_init200response_resumed_upload_proxy.rb} +1 -1
- data/lib/CloudPDF/types/{documents_upload_direct200response.rb → documents_upload_proxy200response.rb} +1 -1
- data/lib/CloudPDF/types/documents_upload_proxy400response.rb +9 -0
- data/lib/CloudPDF/types/{documents_upload_direct400response_error.rb → documents_upload_proxy400response_error.rb} +1 -1
- data/lib/CloudPDF/types/documents_upload_proxy409response.rb +9 -0
- data/lib/CloudPDF/types/documents_upload_proxy409response_error.rb +11 -0
- data/lib/CloudPDF/types/engine_error_payload_code.rb +1 -0
- data/lib/CloudPDF/types/shares_create200response.rb +9 -0
- data/lib/CloudPDF/types/shares_create200response_share.rb +37 -0
- data/lib/CloudPDF/types/shares_create400response.rb +9 -0
- data/lib/CloudPDF/types/shares_create400response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_create403response.rb +9 -0
- data/lib/CloudPDF/types/shares_create403response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_create404response.rb +9 -0
- data/lib/CloudPDF/types/shares_create404response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_delete_response.rb +9 -0
- data/lib/CloudPDF/types/shares_delete_response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_exchange200response.rb +15 -0
- data/lib/CloudPDF/types/shares_exchange400response.rb +9 -0
- data/lib/CloudPDF/types/shares_exchange400response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_exchange403response.rb +9 -0
- data/lib/CloudPDF/types/shares_exchange403response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_exchange404response.rb +9 -0
- data/lib/CloudPDF/types/shares_exchange404response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_exchange410response.rb +9 -0
- data/lib/CloudPDF/types/shares_exchange410response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_exchange422response.rb +9 -0
- data/lib/CloudPDF/types/shares_exchange422response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_get200response.rb +9 -0
- data/lib/CloudPDF/types/shares_get200response_share.rb +37 -0
- data/lib/CloudPDF/types/shares_get404response.rb +9 -0
- data/lib/CloudPDF/types/shares_get404response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_list200response.rb +11 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item.rb +37 -0
- data/lib/CloudPDF/types/shares_list400response.rb +9 -0
- data/lib/CloudPDF/types/shares_list400response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_update200response.rb +9 -0
- data/lib/CloudPDF/types/shares_update200response_share.rb +37 -0
- data/lib/CloudPDF/types/shares_update400response.rb +9 -0
- data/lib/CloudPDF/types/shares_update400response_error.rb +11 -0
- data/lib/CloudPDF/types/shares_update404response.rb +9 -0
- data/lib/CloudPDF/types/shares_update404response_error.rb +11 -0
- data/lib/CloudPDF/types/tenants_create200response_tenant.rb +2 -0
- data/lib/CloudPDF/types/tenants_create200response_tenant_status.rb +12 -0
- data/lib/CloudPDF/types/tenants_get200response_tenant.rb +2 -0
- data/lib/CloudPDF/types/tenants_get200response_tenant_status.rb +12 -0
- data/lib/CloudPDF/types/tenants_list200response_tenants_item.rb +2 -0
- data/lib/CloudPDF/types/tenants_list200response_tenants_item_status.rb +12 -0
- data/lib/CloudPDF/types/tenants_resume_response.rb +9 -0
- data/lib/CloudPDF/types/tenants_resume_response_error.rb +11 -0
- data/lib/CloudPDF/types/tenants_suspend_response.rb +9 -0
- data/lib/CloudPDF/types/tenants_suspend_response_error.rb +11 -0
- data/lib/CloudPDF/types/tenants_usage200response.rb +15 -0
- data/lib/CloudPDF/types/tenants_usage200response_metrics.rb +13 -0
- data/lib/CloudPDF/types/tenants_usage400response.rb +9 -0
- data/lib/CloudPDF/types/tenants_usage400response_error.rb +11 -0
- data/lib/CloudPDF/types/tenants_usage404response.rb +9 -0
- data/lib/CloudPDF/types/tenants_usage404response_error.rb +11 -0
- data/lib/CloudPDF/types/tokens_issue_request_doc.rb +2 -0
- data/lib/CloudPDF/types/tokens_issue_request_tenant_scope_item_one.rb +1 -0
- data/lib/CloudPDF/version.rb +1 -1
- data/lib/cloudpdf.rb +68 -5
- data/reference.md +762 -0
- metadata +70 -7
- 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>
|
|
@@ -616,6 +1106,194 @@ client.tenants.delete(tenant_id: "tenantId")
|
|
|
616
1106
|
</dl>
|
|
617
1107
|
|
|
618
1108
|
|
|
1109
|
+
</dd>
|
|
1110
|
+
</dl>
|
|
1111
|
+
</details>
|
|
1112
|
+
|
|
1113
|
+
<details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">resume</a>(tenant_id:) -> </code></summary>
|
|
1114
|
+
<dl>
|
|
1115
|
+
<dd>
|
|
1116
|
+
|
|
1117
|
+
#### 🔌 Usage
|
|
1118
|
+
|
|
1119
|
+
<dl>
|
|
1120
|
+
<dd>
|
|
1121
|
+
|
|
1122
|
+
<dl>
|
|
1123
|
+
<dd>
|
|
1124
|
+
|
|
1125
|
+
```ruby
|
|
1126
|
+
client.tenants.resume(tenant_id: "tenantId")
|
|
1127
|
+
```
|
|
1128
|
+
</dd>
|
|
1129
|
+
</dl>
|
|
1130
|
+
</dd>
|
|
1131
|
+
</dl>
|
|
1132
|
+
|
|
1133
|
+
#### ⚙️ Parameters
|
|
1134
|
+
|
|
1135
|
+
<dl>
|
|
1136
|
+
<dd>
|
|
1137
|
+
|
|
1138
|
+
<dl>
|
|
1139
|
+
<dd>
|
|
1140
|
+
|
|
1141
|
+
**tenant_id:** `String`
|
|
1142
|
+
|
|
1143
|
+
</dd>
|
|
1144
|
+
</dl>
|
|
1145
|
+
|
|
1146
|
+
<dl>
|
|
1147
|
+
<dd>
|
|
1148
|
+
|
|
1149
|
+
**request_options:** `CloudPDF::Tenants::RequestOptions`
|
|
1150
|
+
|
|
1151
|
+
</dd>
|
|
1152
|
+
</dl>
|
|
1153
|
+
</dd>
|
|
1154
|
+
</dl>
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
</dd>
|
|
1158
|
+
</dl>
|
|
1159
|
+
</details>
|
|
1160
|
+
|
|
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
|
+
|
|
1167
|
+
<dl>
|
|
1168
|
+
<dd>
|
|
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
|
+
|
|
1179
|
+
#### 🔌 Usage
|
|
1180
|
+
|
|
1181
|
+
<dl>
|
|
1182
|
+
<dd>
|
|
1183
|
+
|
|
1184
|
+
<dl>
|
|
1185
|
+
<dd>
|
|
1186
|
+
|
|
1187
|
+
```ruby
|
|
1188
|
+
client.tenants.suspend(tenant_id: "tenantId")
|
|
1189
|
+
```
|
|
1190
|
+
</dd>
|
|
1191
|
+
</dl>
|
|
1192
|
+
</dd>
|
|
1193
|
+
</dl>
|
|
1194
|
+
|
|
1195
|
+
#### ⚙️ Parameters
|
|
1196
|
+
|
|
1197
|
+
<dl>
|
|
1198
|
+
<dd>
|
|
1199
|
+
|
|
1200
|
+
<dl>
|
|
1201
|
+
<dd>
|
|
1202
|
+
|
|
1203
|
+
**tenant_id:** `String`
|
|
1204
|
+
|
|
1205
|
+
</dd>
|
|
1206
|
+
</dl>
|
|
1207
|
+
|
|
1208
|
+
<dl>
|
|
1209
|
+
<dd>
|
|
1210
|
+
|
|
1211
|
+
**reason:** `String`
|
|
1212
|
+
|
|
1213
|
+
</dd>
|
|
1214
|
+
</dl>
|
|
1215
|
+
|
|
1216
|
+
<dl>
|
|
1217
|
+
<dd>
|
|
1218
|
+
|
|
1219
|
+
**request_options:** `CloudPDF::Tenants::RequestOptions`
|
|
1220
|
+
|
|
1221
|
+
</dd>
|
|
1222
|
+
</dl>
|
|
1223
|
+
</dd>
|
|
1224
|
+
</dl>
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
</dd>
|
|
1228
|
+
</dl>
|
|
1229
|
+
</details>
|
|
1230
|
+
|
|
1231
|
+
<details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">usage</a>(tenant_id:) -> CloudPDF::Types::TenantsUsage200Response</code></summary>
|
|
1232
|
+
<dl>
|
|
1233
|
+
<dd>
|
|
1234
|
+
|
|
1235
|
+
#### 📝 Description
|
|
1236
|
+
|
|
1237
|
+
<dl>
|
|
1238
|
+
<dd>
|
|
1239
|
+
|
|
1240
|
+
<dl>
|
|
1241
|
+
<dd>
|
|
1242
|
+
|
|
1243
|
+
Facts only — no limits or billing state. Views count share exchanges plus authorized /v1/access grants, deduplicated across the two.
|
|
1244
|
+
</dd>
|
|
1245
|
+
</dl>
|
|
1246
|
+
</dd>
|
|
1247
|
+
</dl>
|
|
1248
|
+
|
|
1249
|
+
#### 🔌 Usage
|
|
1250
|
+
|
|
1251
|
+
<dl>
|
|
1252
|
+
<dd>
|
|
1253
|
+
|
|
1254
|
+
<dl>
|
|
1255
|
+
<dd>
|
|
1256
|
+
|
|
1257
|
+
```ruby
|
|
1258
|
+
client.tenants.usage(tenant_id: "tenantId")
|
|
1259
|
+
```
|
|
1260
|
+
</dd>
|
|
1261
|
+
</dl>
|
|
1262
|
+
</dd>
|
|
1263
|
+
</dl>
|
|
1264
|
+
|
|
1265
|
+
#### ⚙️ Parameters
|
|
1266
|
+
|
|
1267
|
+
<dl>
|
|
1268
|
+
<dd>
|
|
1269
|
+
|
|
1270
|
+
<dl>
|
|
1271
|
+
<dd>
|
|
1272
|
+
|
|
1273
|
+
**tenant_id:** `String`
|
|
1274
|
+
|
|
1275
|
+
</dd>
|
|
1276
|
+
</dl>
|
|
1277
|
+
|
|
1278
|
+
<dl>
|
|
1279
|
+
<dd>
|
|
1280
|
+
|
|
1281
|
+
**period:** `String`
|
|
1282
|
+
|
|
1283
|
+
</dd>
|
|
1284
|
+
</dl>
|
|
1285
|
+
|
|
1286
|
+
<dl>
|
|
1287
|
+
<dd>
|
|
1288
|
+
|
|
1289
|
+
**request_options:** `CloudPDF::Tenants::RequestOptions`
|
|
1290
|
+
|
|
1291
|
+
</dd>
|
|
1292
|
+
</dl>
|
|
1293
|
+
</dd>
|
|
1294
|
+
</dl>
|
|
1295
|
+
|
|
1296
|
+
|
|
619
1297
|
</dd>
|
|
620
1298
|
</dl>
|
|
621
1299
|
</details>
|
|
@@ -993,6 +1671,82 @@ 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
|
+
|
|
996
1750
|
</dd>
|
|
997
1751
|
</dl>
|
|
998
1752
|
</details>
|
|
@@ -1093,6 +1847,14 @@ client.documents.init(
|
|
|
1093
1847
|
<dl>
|
|
1094
1848
|
<dd>
|
|
1095
1849
|
|
|
1850
|
+
**upload_preference:** `CloudPDF::Documents::Types::DocumentsInitRequestUploadPreference`
|
|
1851
|
+
|
|
1852
|
+
</dd>
|
|
1853
|
+
</dl>
|
|
1854
|
+
|
|
1855
|
+
<dl>
|
|
1856
|
+
<dd>
|
|
1857
|
+
|
|
1096
1858
|
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
1097
1859
|
|
|
1098
1860
|
</dd>
|