cloudpdf 3.0.0.alpha.17 → 3.0.0.alpha.19
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/client.rb +8 -3
- data/lib/CloudPDF/doc/signatures/client.rb +5 -4
- data/lib/CloudPDF/doc/versions/client.rb +27 -10
- data/lib/CloudPDF/doc/versions/types/analysis_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/download_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/list_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/revision_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/signature_contents_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/signature_digest_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/signatures_versions_request.rb +2 -0
- data/lib/CloudPDF/documents/client.rb +55 -0
- data/lib/CloudPDF/documents/layers/client.rb +2 -2
- data/lib/CloudPDF/documents/layers/types/list_layers_request.rb +1 -1
- data/lib/CloudPDF/documents/types/documents_import_from_request.rb +4 -0
- data/lib/CloudPDF/documents/types/documents_init_request.rb +4 -0
- data/lib/CloudPDF/documents/types/documents_update_request.rb +15 -0
- data/lib/CloudPDF/documents/types/list_documents_request.rb +8 -0
- data/lib/CloudPDF/documents/types/list_documents_request_order.rb +14 -0
- data/lib/CloudPDF/documents/types/list_documents_request_sort.rb +15 -0
- data/lib/CloudPDF/folders/client.rb +286 -0
- data/lib/CloudPDF/folders/types/delete_folders_request.rb +15 -0
- data/lib/CloudPDF/folders/types/folders_create_request.rb +15 -0
- data/lib/CloudPDF/folders/types/folders_move_into_request.rb +17 -0
- data/lib/CloudPDF/folders/types/folders_update_request.rb +15 -0
- data/lib/CloudPDF/{shares/types/archive_shares_request.rb → folders/types/get_folders_request.rb} +3 -3
- data/lib/CloudPDF/folders/types/list_folders_request.rb +17 -0
- data/lib/CloudPDF/{shares → grants}/client.rb +55 -55
- data/lib/CloudPDF/grants/types/archive_grants_request.rb +13 -0
- data/lib/CloudPDF/{shares/types/delete_shares_request.rb → grants/types/delete_grants_request.rb} +3 -3
- data/lib/CloudPDF/{shares/types/get_shares_request.rb → grants/types/get_grants_request.rb} +3 -3
- data/lib/CloudPDF/{shares/types/shares_create_request.rb → grants/types/grants_create_request.rb} +9 -5
- data/lib/CloudPDF/{shares/types/shares_create_request_layer_mode.rb → grants/types/grants_create_request_layer_mode.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity.rb → grants/types/grants_create_request_visitor_identity.rb} +4 -4
- data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_ask.rb → grants/types/grants_create_request_visitor_identity_ask.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields.rb → grants/types/grants_create_request_visitor_identity_fields.rb} +7 -7
- data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_display_name.rb → grants/types/grants_create_request_visitor_identity_fields_display_name.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_title.rb → grants/types/grants_create_request_visitor_identity_fields_email.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_organization.rb → grants/types/grants_create_request_visitor_identity_fields_organization.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_organizational_unit.rb → grants/types/grants_create_request_visitor_identity_fields_organizational_unit.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_email.rb → grants/types/grants_create_request_visitor_identity_fields_title.rb} +2 -2
- data/lib/CloudPDF/grants/types/grants_exchange_request.rb +19 -0
- data/lib/CloudPDF/{shares/types/shares_exchange_request_visitor_identity.rb → grants/types/grants_exchange_request_visitor_identity.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_update_request.rb → grants/types/grants_update_request.rb} +10 -6
- data/lib/CloudPDF/{shares/types/shares_update_request_layer_mode.rb → grants/types/grants_update_request_layer_mode.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity.rb → grants/types/grants_update_request_visitor_identity.rb} +4 -4
- data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_ask.rb → grants/types/grants_update_request_visitor_identity_ask.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields.rb → grants/types/grants_update_request_visitor_identity_fields.rb} +7 -7
- data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_display_name.rb → grants/types/grants_update_request_visitor_identity_fields_display_name.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_title.rb → grants/types/grants_update_request_visitor_identity_fields_email.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_organization.rb → grants/types/grants_update_request_visitor_identity_fields_organization.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_organizational_unit.rb → grants/types/grants_update_request_visitor_identity_fields_organizational_unit.rb} +2 -2
- data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_email.rb → grants/types/grants_update_request_visitor_identity_fields_title.rb} +2 -2
- data/lib/CloudPDF/{shares/types/list_shares_request.rb → grants/types/list_grants_request.rb} +2 -2
- data/lib/CloudPDF/{shares → grants}/visitors/client.rb +12 -12
- data/lib/CloudPDF/{shares → grants}/visitors/types/delete_visitors_request.rb +2 -2
- data/lib/CloudPDF/{shares → grants}/visitors/types/list_visitors_request.rb +2 -2
- data/lib/CloudPDF/tenants/client.rb +1 -1
- data/lib/CloudPDF/types/doc_versions_list200response.rb +1 -1
- data/lib/CloudPDF/types/documents_commit200response_document.rb +4 -0
- data/lib/CloudPDF/types/documents_get200response_document.rb +4 -0
- data/lib/CloudPDF/types/documents_import_from200response_document.rb +4 -0
- data/lib/CloudPDF/types/documents_import_from202response_document.rb +4 -0
- data/lib/CloudPDF/types/documents_init200response_created_document.rb +4 -0
- data/lib/CloudPDF/types/documents_init200response_deduped_document.rb +4 -0
- data/lib/CloudPDF/types/documents_init200response_resumed_document.rb +4 -0
- data/lib/CloudPDF/types/documents_layers_list200response_layers_item.rb +1 -1
- data/lib/CloudPDF/types/documents_list200response_documents_item.rb +4 -0
- data/lib/CloudPDF/types/documents_update200response.rb +9 -0
- data/lib/CloudPDF/types/documents_update200response_document.rb +37 -0
- data/lib/CloudPDF/types/documents_update200response_document_state.rb +14 -0
- data/lib/CloudPDF/types/documents_update200response_document_thumbnail_state.rb +14 -0
- data/lib/CloudPDF/types/documents_update400response.rb +23 -0
- data/lib/CloudPDF/types/documents_update403response.rb +23 -0
- data/lib/CloudPDF/types/documents_update404response.rb +23 -0
- data/lib/CloudPDF/types/engine_error_payload_code.rb +1 -2
- data/lib/CloudPDF/types/folders_create200response.rb +9 -0
- data/lib/CloudPDF/types/folders_create200response_folder.rb +21 -0
- data/lib/CloudPDF/types/{shares_archive404response.rb → folders_create400response.rb} +2 -2
- data/lib/CloudPDF/types/folders_create403response.rb +23 -0
- data/lib/CloudPDF/types/folders_create404response.rb +23 -0
- data/lib/CloudPDF/types/folders_create409response.rb +23 -0
- data/lib/CloudPDF/types/folders_delete403response.rb +23 -0
- data/lib/CloudPDF/types/folders_delete404response.rb +23 -0
- data/lib/CloudPDF/types/folders_delete409response.rb +23 -0
- data/lib/CloudPDF/types/folders_get200response.rb +11 -0
- data/lib/CloudPDF/types/folders_get200response_folder.rb +21 -0
- data/lib/CloudPDF/types/folders_get200response_path_item.rb +11 -0
- data/lib/CloudPDF/types/{shares_list400response.rb → folders_get403response.rb} +2 -2
- data/lib/CloudPDF/types/folders_get404response.rb +23 -0
- data/lib/CloudPDF/types/folders_list200response.rb +11 -0
- data/lib/CloudPDF/types/folders_list200response_folders_item.rb +21 -0
- data/lib/CloudPDF/types/folders_list400response.rb +23 -0
- data/lib/CloudPDF/types/folders_list403response.rb +23 -0
- data/lib/CloudPDF/types/folders_list404response.rb +23 -0
- data/lib/CloudPDF/types/folders_move_into400response.rb +23 -0
- data/lib/CloudPDF/types/folders_move_into403response.rb +23 -0
- data/lib/CloudPDF/types/folders_move_into404response.rb +23 -0
- data/lib/CloudPDF/types/folders_move_into409response.rb +23 -0
- data/lib/CloudPDF/types/folders_update200response.rb +9 -0
- data/lib/CloudPDF/types/folders_update200response_folder.rb +21 -0
- data/lib/CloudPDF/types/folders_update400response.rb +23 -0
- data/lib/CloudPDF/types/folders_update403response.rb +23 -0
- data/lib/CloudPDF/types/folders_update404response.rb +23 -0
- data/lib/CloudPDF/types/folders_update409response.rb +23 -0
- data/lib/CloudPDF/types/grants_archive200response.rb +9 -0
- data/lib/CloudPDF/types/{shares_archive200response_share.rb → grants_archive200response_grant.rb} +8 -4
- data/lib/CloudPDF/types/{shares_archive200response_share_layer_mode.rb → grants_archive200response_grant_layer_mode.rb} +1 -1
- data/lib/CloudPDF/types/grants_archive200response_grant_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_ask.rb → grants_archive200response_grant_visitor_identity_ask.rb} +1 -1
- data/lib/CloudPDF/types/grants_archive200response_grant_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_display_name.rb → grants_archive200response_grant_visitor_identity_fields_display_name.rb} +1 -1
- data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_email.rb → grants_archive200response_grant_visitor_identity_fields_email.rb} +1 -1
- data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_organization.rb → grants_archive200response_grant_visitor_identity_fields_organization.rb} +1 -1
- data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_organizational_unit.rb → grants_archive200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
- data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_title.rb → grants_archive200response_grant_visitor_identity_fields_title.rb} +1 -1
- data/lib/CloudPDF/types/grants_archive404response.rb +23 -0
- data/lib/CloudPDF/types/grants_create200response.rb +9 -0
- data/lib/CloudPDF/types/{shares_update200response_share.rb → grants_create200response_grant.rb} +8 -4
- data/lib/CloudPDF/types/{shares_create200response_share_layer_mode.rb → grants_create200response_grant_layer_mode.rb} +1 -1
- data/lib/CloudPDF/types/grants_create200response_grant_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_ask.rb → grants_create200response_grant_visitor_identity_ask.rb} +1 -1
- data/lib/CloudPDF/types/grants_create200response_grant_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_display_name.rb → grants_create200response_grant_visitor_identity_fields_display_name.rb} +1 -1
- data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_email.rb → grants_create200response_grant_visitor_identity_fields_email.rb} +1 -1
- data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_organization.rb → grants_create200response_grant_visitor_identity_fields_organization.rb} +1 -1
- data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_organizational_unit.rb → grants_create200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
- data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_title.rb → grants_create200response_grant_visitor_identity_fields_title.rb} +1 -1
- data/lib/CloudPDF/types/{shares_delete404response.rb → grants_create400response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_create400response.rb → grants_create403response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_create403response.rb → grants_create404response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_create404response.rb → grants_delete404response.rb} +2 -2
- data/lib/CloudPDF/types/grants_delete409response.rb +23 -0
- data/lib/CloudPDF/types/{shares_exchange200response.rb → grants_exchange200response.rb} +3 -3
- data/lib/CloudPDF/types/{shares_exchange200response_layer_mode.rb → grants_exchange200response_layer_mode.rb} +1 -1
- data/lib/CloudPDF/types/{shares_exchange200response_visitor.rb → grants_exchange200response_visitor.rb} +2 -2
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request.rb → grants_exchange200response_visitor_identity_request.rb} +4 -4
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields.rb → grants_exchange200response_visitor_identity_request_fields.rb} +6 -6
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_display_name.rb → grants_exchange200response_visitor_identity_request_fields_display_name.rb} +1 -1
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_email.rb → grants_exchange200response_visitor_identity_request_fields_email.rb} +1 -1
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_organization.rb → grants_exchange200response_visitor_identity_request_fields_organization.rb} +1 -1
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_organizational_unit.rb → grants_exchange200response_visitor_identity_request_fields_organizational_unit.rb} +1 -1
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_title.rb → grants_exchange200response_visitor_identity_request_fields_title.rb} +1 -1
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_invalid_item.rb → grants_exchange200response_visitor_identity_request_invalid_item.rb} +1 -1
- data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_missing_item.rb → grants_exchange200response_visitor_identity_request_missing_item.rb} +1 -1
- data/lib/CloudPDF/types/{shares_exchange400response.rb → grants_exchange400response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_exchange403response.rb → grants_exchange403response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_exchange404response.rb → grants_exchange404response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_exchange410response.rb → grants_exchange410response.rb} +2 -2
- data/lib/CloudPDF/types/grants_exchange422response.rb +23 -0
- data/lib/CloudPDF/types/grants_get200response.rb +9 -0
- data/lib/CloudPDF/types/{shares_get200response_share.rb → grants_get200response_grant.rb} +8 -4
- data/lib/CloudPDF/types/{shares_get200response_share_layer_mode.rb → grants_get200response_grant_layer_mode.rb} +1 -1
- data/lib/CloudPDF/types/grants_get200response_grant_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_ask.rb → grants_get200response_grant_visitor_identity_ask.rb} +1 -1
- data/lib/CloudPDF/types/grants_get200response_grant_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_display_name.rb → grants_get200response_grant_visitor_identity_fields_display_name.rb} +1 -1
- data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_email.rb → grants_get200response_grant_visitor_identity_fields_email.rb} +1 -1
- data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_organization.rb → grants_get200response_grant_visitor_identity_fields_organization.rb} +1 -1
- data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_organizational_unit.rb → grants_get200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
- data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_title.rb → grants_get200response_grant_visitor_identity_fields_title.rb} +1 -1
- data/lib/CloudPDF/types/{shares_get404response.rb → grants_get404response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_list200response.rb → grants_list200response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_list200response_shares_item.rb → grants_list200response_grants_item.rb} +8 -4
- data/lib/CloudPDF/types/grants_list200response_grants_item_layer_mode.rb +12 -0
- data/lib/CloudPDF/types/grants_list200response_grants_item_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_ask.rb → grants_list200response_grants_item_visitor_identity_ask.rb} +1 -1
- data/lib/CloudPDF/types/grants_list200response_grants_item_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_display_name.rb → grants_list200response_grants_item_visitor_identity_fields_display_name.rb} +1 -1
- data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_email.rb → grants_list200response_grants_item_visitor_identity_fields_email.rb} +1 -1
- data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_organization.rb → grants_list200response_grants_item_visitor_identity_fields_organization.rb} +1 -1
- data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_organizational_unit.rb → grants_list200response_grants_item_visitor_identity_fields_organizational_unit.rb} +1 -1
- data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_title.rb → grants_list200response_grants_item_visitor_identity_fields_title.rb} +1 -1
- data/lib/CloudPDF/types/grants_list400response.rb +23 -0
- data/lib/CloudPDF/types/grants_update200response.rb +9 -0
- data/lib/CloudPDF/types/{shares_create200response_share.rb → grants_update200response_grant.rb} +8 -4
- data/lib/CloudPDF/types/{shares_update200response_share_layer_mode.rb → grants_update200response_grant_layer_mode.rb} +1 -1
- data/lib/CloudPDF/types/grants_update200response_grant_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_ask.rb → grants_update200response_grant_visitor_identity_ask.rb} +1 -1
- data/lib/CloudPDF/types/grants_update200response_grant_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_display_name.rb → grants_update200response_grant_visitor_identity_fields_display_name.rb} +1 -1
- data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_email.rb → grants_update200response_grant_visitor_identity_fields_email.rb} +1 -1
- data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_organization.rb → grants_update200response_grant_visitor_identity_fields_organization.rb} +1 -1
- data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_organizational_unit.rb → grants_update200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
- data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_title.rb → grants_update200response_grant_visitor_identity_fields_title.rb} +1 -1
- data/lib/CloudPDF/types/grants_update400response.rb +23 -0
- data/lib/CloudPDF/types/grants_update404response.rb +23 -0
- data/lib/CloudPDF/types/grants_update409response.rb +23 -0
- data/lib/CloudPDF/types/{shares_visitors_delete_response.rb → grants_visitors_delete_response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_visitors_list200response.rb → grants_visitors_list200response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item.rb → grants_visitors_list200response_visitors_item.rb} +3 -3
- data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item_answers.rb → grants_visitors_list200response_visitors_item_answers.rb} +1 -1
- data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item_layer.rb → grants_visitors_list200response_visitors_item_layer.rb} +1 -1
- data/lib/CloudPDF/types/{shares_visitors_list400response.rb → grants_visitors_list400response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_visitors_list404response.rb → grants_visitors_list404response.rb} +2 -2
- data/lib/CloudPDF/types/{tokens_issue_request_doc_identity.rb → identity.rb} +1 -1
- data/lib/CloudPDF/types/tokens_issue_request_doc.rb +1 -1
- data/lib/CloudPDF/types/tokens_issue_request_tenant.rb +1 -1
- data/lib/CloudPDF/version.rb +1 -1
- data/lib/cloudpdf.rb +167 -124
- data/reference.md +905 -197
- metadata +169 -126
- data/lib/CloudPDF/shares/types/shares_exchange_request.rb +0 -19
- data/lib/CloudPDF/types/shares_archive200response.rb +0 -9
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity.rb +0 -15
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields.rb +0 -17
- data/lib/CloudPDF/types/shares_create200response.rb +0 -9
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity.rb +0 -15
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields.rb +0 -17
- data/lib/CloudPDF/types/shares_delete409response.rb +0 -23
- data/lib/CloudPDF/types/shares_exchange422response.rb +0 -23
- data/lib/CloudPDF/types/shares_get200response.rb +0 -9
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity.rb +0 -15
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields.rb +0 -17
- data/lib/CloudPDF/types/shares_list200response_shares_item_layer_mode.rb +0 -12
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity.rb +0 -15
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields.rb +0 -17
- data/lib/CloudPDF/types/shares_update200response.rb +0 -9
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity.rb +0 -15
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields.rb +0 -17
- data/lib/CloudPDF/types/shares_update400response.rb +0 -23
- data/lib/CloudPDF/types/shares_update404response.rb +0 -23
- data/lib/CloudPDF/types/shares_update409response.rb +0 -23
- data/lib/CloudPDF/types/tokens_issue_request_tenant_scope_item.rb +0 -13
- data/lib/CloudPDF/types/tokens_issue_request_tenant_scope_item_one.rb +0 -16
- data/lib/CloudPDF/types/tokens_issue_request_tenant_scope_item_zero.rb +0 -11
data/reference.md
CHANGED
|
@@ -578,8 +578,8 @@ client.doc.text(
|
|
|
578
578
|
</dl>
|
|
579
579
|
</details>
|
|
580
580
|
|
|
581
|
-
##
|
|
582
|
-
<details><summary><code>client.
|
|
581
|
+
## Grants
|
|
582
|
+
<details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">exchange</a>(request) -> CloudPDF::Types::GrantsExchange200Response</code></summary>
|
|
583
583
|
<dl>
|
|
584
584
|
<dd>
|
|
585
585
|
|
|
@@ -591,7 +591,7 @@ client.doc.text(
|
|
|
591
591
|
<dl>
|
|
592
592
|
<dd>
|
|
593
593
|
|
|
594
|
-
Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown,
|
|
594
|
+
Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, deleted, paused and archived grants are indistinguishable (404). Passphrase-protected grants return 422 GrantPassphraseRequired until `passphrase` is supplied. A grant that asks its visitors who they are on open returns 422 VisitorIdentityRequired until the required answers are given; `error.details` carries `fields` (what the grant asks), `missing`, `invalid`, `purpose` and `privacyUrl`. A grant that asks before the first change issues the session at once with `visitor.identityRequest`, and writes answer 403 VisitorIdentityRequired with the same details until the visitor exchanges again with their answers. Answers that can not be taken answer 422 on any grant. Mounted only when the deployment can sign (HS256 mode).
|
|
595
595
|
</dd>
|
|
596
596
|
</dl>
|
|
597
597
|
</dd>
|
|
@@ -606,7 +606,7 @@ Unauthenticated, but requires a browser Origin header, checked against the grant
|
|
|
606
606
|
<dd>
|
|
607
607
|
|
|
608
608
|
```ruby
|
|
609
|
-
client.
|
|
609
|
+
client.grants.exchange(grant: "grant")
|
|
610
610
|
```
|
|
611
611
|
</dd>
|
|
612
612
|
</dl>
|
|
@@ -621,7 +621,7 @@ client.shares.exchange(share_token: "shareToken")
|
|
|
621
621
|
<dl>
|
|
622
622
|
<dd>
|
|
623
623
|
|
|
624
|
-
**
|
|
624
|
+
**grant:** `String`
|
|
625
625
|
|
|
626
626
|
</dd>
|
|
627
627
|
</dl>
|
|
@@ -629,7 +629,7 @@ client.shares.exchange(share_token: "shareToken")
|
|
|
629
629
|
<dl>
|
|
630
630
|
<dd>
|
|
631
631
|
|
|
632
|
-
**
|
|
632
|
+
**passphrase:** `String`
|
|
633
633
|
|
|
634
634
|
</dd>
|
|
635
635
|
</dl>
|
|
@@ -653,7 +653,7 @@ client.shares.exchange(share_token: "shareToken")
|
|
|
653
653
|
<dl>
|
|
654
654
|
<dd>
|
|
655
655
|
|
|
656
|
-
**visitor_identity:** `CloudPDF::
|
|
656
|
+
**visitor_identity:** `CloudPDF::Grants::Types::GrantsExchangeRequestVisitorIdentity`
|
|
657
657
|
|
|
658
658
|
</dd>
|
|
659
659
|
</dl>
|
|
@@ -661,7 +661,7 @@ client.shares.exchange(share_token: "shareToken")
|
|
|
661
661
|
<dl>
|
|
662
662
|
<dd>
|
|
663
663
|
|
|
664
|
-
**request_options:** `CloudPDF::
|
|
664
|
+
**request_options:** `CloudPDF::Grants::RequestOptions`
|
|
665
665
|
|
|
666
666
|
</dd>
|
|
667
667
|
</dl>
|
|
@@ -673,7 +673,7 @@ client.shares.exchange(share_token: "shareToken")
|
|
|
673
673
|
</dl>
|
|
674
674
|
</details>
|
|
675
675
|
|
|
676
|
-
<details><summary><code>client.
|
|
676
|
+
<details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">list</a>(tenant_id:) -> CloudPDF::Types::GrantsList200Response</code></summary>
|
|
677
677
|
<dl>
|
|
678
678
|
<dd>
|
|
679
679
|
|
|
@@ -686,7 +686,7 @@ client.shares.exchange(share_token: "shareToken")
|
|
|
686
686
|
<dd>
|
|
687
687
|
|
|
688
688
|
```ruby
|
|
689
|
-
client.
|
|
689
|
+
client.grants.list(tenant_id: "tenantId")
|
|
690
690
|
```
|
|
691
691
|
</dd>
|
|
692
692
|
</dl>
|
|
@@ -741,7 +741,7 @@ client.shares.list(tenant_id: "tenantId")
|
|
|
741
741
|
<dl>
|
|
742
742
|
<dd>
|
|
743
743
|
|
|
744
|
-
**request_options:** `CloudPDF::
|
|
744
|
+
**request_options:** `CloudPDF::Grants::RequestOptions`
|
|
745
745
|
|
|
746
746
|
</dd>
|
|
747
747
|
</dl>
|
|
@@ -753,7 +753,7 @@ client.shares.list(tenant_id: "tenantId")
|
|
|
753
753
|
</dl>
|
|
754
754
|
</details>
|
|
755
755
|
|
|
756
|
-
<details><summary><code>client.
|
|
756
|
+
<details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">create</a>(tenant_id:, request) -> CloudPDF::Types::GrantsCreate200Response</code></summary>
|
|
757
757
|
<dl>
|
|
758
758
|
<dd>
|
|
759
759
|
|
|
@@ -765,7 +765,7 @@ client.shares.list(tenant_id: "tenantId")
|
|
|
765
765
|
<dl>
|
|
766
766
|
<dd>
|
|
767
767
|
|
|
768
|
-
The returned
|
|
768
|
+
The returned id is what a link page or an embed opens. Mounted only when the deployment can sign (HS256 mode) — exchange mints session JWTs, so grants exist only where minting does.
|
|
769
769
|
</dd>
|
|
770
770
|
</dl>
|
|
771
771
|
</dd>
|
|
@@ -780,7 +780,7 @@ The returned share id is the public share token. Mounted only when the deploymen
|
|
|
780
780
|
<dd>
|
|
781
781
|
|
|
782
782
|
```ruby
|
|
783
|
-
client.
|
|
783
|
+
client.grants.create(
|
|
784
784
|
tenant_id: "tenantId",
|
|
785
785
|
doc_id: "docId",
|
|
786
786
|
scope: ["scope"]
|
|
@@ -815,7 +815,15 @@ client.shares.create(
|
|
|
815
815
|
<dl>
|
|
816
816
|
<dd>
|
|
817
817
|
|
|
818
|
-
**
|
|
818
|
+
**name:** `String`
|
|
819
|
+
|
|
820
|
+
</dd>
|
|
821
|
+
</dl>
|
|
822
|
+
|
|
823
|
+
<dl>
|
|
824
|
+
<dd>
|
|
825
|
+
|
|
826
|
+
**layer_mode:** `CloudPDF::Grants::Types::GrantsCreateRequestLayerMode`
|
|
819
827
|
|
|
820
828
|
</dd>
|
|
821
829
|
</dl>
|
|
@@ -847,7 +855,15 @@ client.shares.create(
|
|
|
847
855
|
<dl>
|
|
848
856
|
<dd>
|
|
849
857
|
|
|
850
|
-
**visitor_identity:** `CloudPDF::
|
|
858
|
+
**visitor_identity:** `CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentity`
|
|
859
|
+
|
|
860
|
+
</dd>
|
|
861
|
+
</dl>
|
|
862
|
+
|
|
863
|
+
<dl>
|
|
864
|
+
<dd>
|
|
865
|
+
|
|
866
|
+
**identity:** `CloudPDF::Types::Identity`
|
|
851
867
|
|
|
852
868
|
</dd>
|
|
853
869
|
</dl>
|
|
@@ -871,7 +887,7 @@ client.shares.create(
|
|
|
871
887
|
<dl>
|
|
872
888
|
<dd>
|
|
873
889
|
|
|
874
|
-
**
|
|
890
|
+
**passphrase:** `String`
|
|
875
891
|
|
|
876
892
|
</dd>
|
|
877
893
|
</dl>
|
|
@@ -895,7 +911,7 @@ client.shares.create(
|
|
|
895
911
|
<dl>
|
|
896
912
|
<dd>
|
|
897
913
|
|
|
898
|
-
**request_options:** `CloudPDF::
|
|
914
|
+
**request_options:** `CloudPDF::Grants::RequestOptions`
|
|
899
915
|
|
|
900
916
|
</dd>
|
|
901
917
|
</dl>
|
|
@@ -907,7 +923,7 @@ client.shares.create(
|
|
|
907
923
|
</dl>
|
|
908
924
|
</details>
|
|
909
925
|
|
|
910
|
-
<details><summary><code>client.
|
|
926
|
+
<details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">get</a>(tenant_id:, grant_id:) -> CloudPDF::Types::GrantsGet200Response</code></summary>
|
|
911
927
|
<dl>
|
|
912
928
|
<dd>
|
|
913
929
|
|
|
@@ -920,9 +936,9 @@ client.shares.create(
|
|
|
920
936
|
<dd>
|
|
921
937
|
|
|
922
938
|
```ruby
|
|
923
|
-
client.
|
|
939
|
+
client.grants.get(
|
|
924
940
|
tenant_id: "tenantId",
|
|
925
|
-
|
|
941
|
+
grant_id: "grantId"
|
|
926
942
|
)
|
|
927
943
|
```
|
|
928
944
|
</dd>
|
|
@@ -946,7 +962,7 @@ client.shares.get(
|
|
|
946
962
|
<dl>
|
|
947
963
|
<dd>
|
|
948
964
|
|
|
949
|
-
**
|
|
965
|
+
**grant_id:** `String`
|
|
950
966
|
|
|
951
967
|
</dd>
|
|
952
968
|
</dl>
|
|
@@ -954,7 +970,7 @@ client.shares.get(
|
|
|
954
970
|
<dl>
|
|
955
971
|
<dd>
|
|
956
972
|
|
|
957
|
-
**request_options:** `CloudPDF::
|
|
973
|
+
**request_options:** `CloudPDF::Grants::RequestOptions`
|
|
958
974
|
|
|
959
975
|
</dd>
|
|
960
976
|
</dl>
|
|
@@ -966,7 +982,7 @@ client.shares.get(
|
|
|
966
982
|
</dl>
|
|
967
983
|
</details>
|
|
968
984
|
|
|
969
|
-
<details><summary><code>client.
|
|
985
|
+
<details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">delete</a>(tenant_id:, grant_id:) -> </code></summary>
|
|
970
986
|
<dl>
|
|
971
987
|
<dd>
|
|
972
988
|
|
|
@@ -979,9 +995,9 @@ client.shares.get(
|
|
|
979
995
|
<dd>
|
|
980
996
|
|
|
981
997
|
```ruby
|
|
982
|
-
client.
|
|
998
|
+
client.grants.delete(
|
|
983
999
|
tenant_id: "tenantId",
|
|
984
|
-
|
|
1000
|
+
grant_id: "grantId"
|
|
985
1001
|
)
|
|
986
1002
|
```
|
|
987
1003
|
</dd>
|
|
@@ -1005,7 +1021,7 @@ client.shares.delete(
|
|
|
1005
1021
|
<dl>
|
|
1006
1022
|
<dd>
|
|
1007
1023
|
|
|
1008
|
-
**
|
|
1024
|
+
**grant_id:** `String`
|
|
1009
1025
|
|
|
1010
1026
|
</dd>
|
|
1011
1027
|
</dl>
|
|
@@ -1013,7 +1029,7 @@ client.shares.delete(
|
|
|
1013
1029
|
<dl>
|
|
1014
1030
|
<dd>
|
|
1015
1031
|
|
|
1016
|
-
**request_options:** `CloudPDF::
|
|
1032
|
+
**request_options:** `CloudPDF::Grants::RequestOptions`
|
|
1017
1033
|
|
|
1018
1034
|
</dd>
|
|
1019
1035
|
</dl>
|
|
@@ -1025,7 +1041,7 @@ client.shares.delete(
|
|
|
1025
1041
|
</dl>
|
|
1026
1042
|
</details>
|
|
1027
1043
|
|
|
1028
|
-
<details><summary><code>client.
|
|
1044
|
+
<details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">update</a>(tenant_id:, grant_id:, request) -> CloudPDF::Types::GrantsUpdate200Response</code></summary>
|
|
1029
1045
|
<dl>
|
|
1030
1046
|
<dd>
|
|
1031
1047
|
|
|
@@ -1038,9 +1054,9 @@ client.shares.delete(
|
|
|
1038
1054
|
<dd>
|
|
1039
1055
|
|
|
1040
1056
|
```ruby
|
|
1041
|
-
client.
|
|
1057
|
+
client.grants.update(
|
|
1042
1058
|
tenant_id: "tenantId",
|
|
1043
|
-
|
|
1059
|
+
grant_id: "grantId"
|
|
1044
1060
|
)
|
|
1045
1061
|
```
|
|
1046
1062
|
</dd>
|
|
@@ -1064,7 +1080,15 @@ client.shares.update(
|
|
|
1064
1080
|
<dl>
|
|
1065
1081
|
<dd>
|
|
1066
1082
|
|
|
1067
|
-
**
|
|
1083
|
+
**grant_id:** `String`
|
|
1084
|
+
|
|
1085
|
+
</dd>
|
|
1086
|
+
</dl>
|
|
1087
|
+
|
|
1088
|
+
<dl>
|
|
1089
|
+
<dd>
|
|
1090
|
+
|
|
1091
|
+
**name:** `String`
|
|
1068
1092
|
|
|
1069
1093
|
</dd>
|
|
1070
1094
|
</dl>
|
|
@@ -1072,7 +1096,7 @@ client.shares.update(
|
|
|
1072
1096
|
<dl>
|
|
1073
1097
|
<dd>
|
|
1074
1098
|
|
|
1075
|
-
**layer_mode:** `CloudPDF::
|
|
1099
|
+
**layer_mode:** `CloudPDF::Grants::Types::GrantsUpdateRequestLayerMode`
|
|
1076
1100
|
|
|
1077
1101
|
</dd>
|
|
1078
1102
|
</dl>
|
|
@@ -1104,7 +1128,15 @@ client.shares.update(
|
|
|
1104
1128
|
<dl>
|
|
1105
1129
|
<dd>
|
|
1106
1130
|
|
|
1107
|
-
**visitor_identity:** `CloudPDF::
|
|
1131
|
+
**visitor_identity:** `CloudPDF::Grants::Types::GrantsUpdateRequestVisitorIdentity`
|
|
1132
|
+
|
|
1133
|
+
</dd>
|
|
1134
|
+
</dl>
|
|
1135
|
+
|
|
1136
|
+
<dl>
|
|
1137
|
+
<dd>
|
|
1138
|
+
|
|
1139
|
+
**identity:** `CloudPDF::Types::Identity`
|
|
1108
1140
|
|
|
1109
1141
|
</dd>
|
|
1110
1142
|
</dl>
|
|
@@ -1128,7 +1160,7 @@ client.shares.update(
|
|
|
1128
1160
|
<dl>
|
|
1129
1161
|
<dd>
|
|
1130
1162
|
|
|
1131
|
-
**
|
|
1163
|
+
**passphrase:** `String`
|
|
1132
1164
|
|
|
1133
1165
|
</dd>
|
|
1134
1166
|
</dl>
|
|
@@ -1160,7 +1192,7 @@ client.shares.update(
|
|
|
1160
1192
|
<dl>
|
|
1161
1193
|
<dd>
|
|
1162
1194
|
|
|
1163
|
-
**request_options:** `CloudPDF::
|
|
1195
|
+
**request_options:** `CloudPDF::Grants::RequestOptions`
|
|
1164
1196
|
|
|
1165
1197
|
</dd>
|
|
1166
1198
|
</dl>
|
|
@@ -1172,7 +1204,7 @@ client.shares.update(
|
|
|
1172
1204
|
</dl>
|
|
1173
1205
|
</details>
|
|
1174
1206
|
|
|
1175
|
-
<details><summary><code>client.
|
|
1207
|
+
<details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">archive</a>(tenant_id:, grant_id:) -> CloudPDF::Types::GrantsArchive200Response</code></summary>
|
|
1176
1208
|
<dl>
|
|
1177
1209
|
<dd>
|
|
1178
1210
|
|
|
@@ -1184,7 +1216,7 @@ client.shares.update(
|
|
|
1184
1216
|
<dl>
|
|
1185
1217
|
<dd>
|
|
1186
1218
|
|
|
1187
|
-
Archiving is final: an archived
|
|
1219
|
+
Archiving is final: an archived grant never exchanges again, and to give access again you create a new grant. Pausing (`disabled`) is the reversible stop. An archived grant no longer counts as using its shared layer, so that layer can be deleted.
|
|
1188
1220
|
</dd>
|
|
1189
1221
|
</dl>
|
|
1190
1222
|
</dd>
|
|
@@ -1199,9 +1231,9 @@ Archiving is final: an archived link never exchanges again, and to share again y
|
|
|
1199
1231
|
<dd>
|
|
1200
1232
|
|
|
1201
1233
|
```ruby
|
|
1202
|
-
client.
|
|
1234
|
+
client.grants.archive(
|
|
1203
1235
|
tenant_id: "tenantId",
|
|
1204
|
-
|
|
1236
|
+
grant_id: "grantId"
|
|
1205
1237
|
)
|
|
1206
1238
|
```
|
|
1207
1239
|
</dd>
|
|
@@ -1225,7 +1257,7 @@ client.shares.archive(
|
|
|
1225
1257
|
<dl>
|
|
1226
1258
|
<dd>
|
|
1227
1259
|
|
|
1228
|
-
**
|
|
1260
|
+
**grant_id:** `String`
|
|
1229
1261
|
|
|
1230
1262
|
</dd>
|
|
1231
1263
|
</dl>
|
|
@@ -1233,7 +1265,7 @@ client.shares.archive(
|
|
|
1233
1265
|
<dl>
|
|
1234
1266
|
<dd>
|
|
1235
1267
|
|
|
1236
|
-
**request_options:** `CloudPDF::
|
|
1268
|
+
**request_options:** `CloudPDF::Grants::RequestOptions`
|
|
1237
1269
|
|
|
1238
1270
|
</dd>
|
|
1239
1271
|
</dl>
|
|
@@ -1598,7 +1630,7 @@ client.tenants.suspend(tenant_id: "tenantId")
|
|
|
1598
1630
|
<dl>
|
|
1599
1631
|
<dd>
|
|
1600
1632
|
|
|
1601
|
-
Facts only — no limits or billing state. Views count
|
|
1633
|
+
Facts only — no limits or billing state. Views count grant exchanges plus authorized /v1/access requests, deduplicated across the two.
|
|
1602
1634
|
</dd>
|
|
1603
1635
|
</dl>
|
|
1604
1636
|
</dd>
|
|
@@ -1709,7 +1741,39 @@ client.documents.list(tenant_id: "tenantId")
|
|
|
1709
1741
|
<dl>
|
|
1710
1742
|
<dd>
|
|
1711
1743
|
|
|
1712
|
-
**state:** `CloudPDF::Documents::Types::ListDocumentsRequestState`
|
|
1744
|
+
**state:** `CloudPDF::Documents::Types::ListDocumentsRequestState` — Only documents in this state. Without it, every state except deleting.
|
|
1745
|
+
|
|
1746
|
+
</dd>
|
|
1747
|
+
</dl>
|
|
1748
|
+
|
|
1749
|
+
<dl>
|
|
1750
|
+
<dd>
|
|
1751
|
+
|
|
1752
|
+
**q:** `String` — Only documents whose name contains this text, ignoring case.
|
|
1753
|
+
|
|
1754
|
+
</dd>
|
|
1755
|
+
</dl>
|
|
1756
|
+
|
|
1757
|
+
<dl>
|
|
1758
|
+
<dd>
|
|
1759
|
+
|
|
1760
|
+
**folder_id:** `String` — Only documents directly in this folder (root: the top level). Without it, documents in every folder.
|
|
1761
|
+
|
|
1762
|
+
</dd>
|
|
1763
|
+
</dl>
|
|
1764
|
+
|
|
1765
|
+
<dl>
|
|
1766
|
+
<dd>
|
|
1767
|
+
|
|
1768
|
+
**sort:** `CloudPDF::Documents::Types::ListDocumentsRequestSort` — createdAt (default), name (ignoring case), or size (stored bytes; 0 while pending).
|
|
1769
|
+
|
|
1770
|
+
</dd>
|
|
1771
|
+
</dl>
|
|
1772
|
+
|
|
1773
|
+
<dl>
|
|
1774
|
+
<dd>
|
|
1775
|
+
|
|
1776
|
+
**order:** `CloudPDF::Documents::Types::ListDocumentsRequestOrder` — Defaults to the reading order of the sort: A to Z for name, newest and largest first otherwise.
|
|
1713
1777
|
|
|
1714
1778
|
</dd>
|
|
1715
1779
|
</dl>
|
|
@@ -1786,40 +1850,650 @@ client.documents.get(
|
|
|
1786
1850
|
|
|
1787
1851
|
</dd>
|
|
1788
1852
|
</dl>
|
|
1789
|
-
</details>
|
|
1853
|
+
</details>
|
|
1854
|
+
|
|
1855
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">delete</a>(tenant_id:, id:) -> </code></summary>
|
|
1856
|
+
<dl>
|
|
1857
|
+
<dd>
|
|
1858
|
+
|
|
1859
|
+
#### 🔌 Usage
|
|
1860
|
+
|
|
1861
|
+
<dl>
|
|
1862
|
+
<dd>
|
|
1863
|
+
|
|
1864
|
+
<dl>
|
|
1865
|
+
<dd>
|
|
1866
|
+
|
|
1867
|
+
```ruby
|
|
1868
|
+
client.documents.delete(
|
|
1869
|
+
tenant_id: "tenantId",
|
|
1870
|
+
id: "id"
|
|
1871
|
+
)
|
|
1872
|
+
```
|
|
1873
|
+
</dd>
|
|
1874
|
+
</dl>
|
|
1875
|
+
</dd>
|
|
1876
|
+
</dl>
|
|
1877
|
+
|
|
1878
|
+
#### ⚙️ Parameters
|
|
1879
|
+
|
|
1880
|
+
<dl>
|
|
1881
|
+
<dd>
|
|
1882
|
+
|
|
1883
|
+
<dl>
|
|
1884
|
+
<dd>
|
|
1885
|
+
|
|
1886
|
+
**tenant_id:** `String`
|
|
1887
|
+
|
|
1888
|
+
</dd>
|
|
1889
|
+
</dl>
|
|
1890
|
+
|
|
1891
|
+
<dl>
|
|
1892
|
+
<dd>
|
|
1893
|
+
|
|
1894
|
+
**id:** `String`
|
|
1895
|
+
|
|
1896
|
+
</dd>
|
|
1897
|
+
</dl>
|
|
1898
|
+
|
|
1899
|
+
<dl>
|
|
1900
|
+
<dd>
|
|
1901
|
+
|
|
1902
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
1903
|
+
|
|
1904
|
+
</dd>
|
|
1905
|
+
</dl>
|
|
1906
|
+
</dd>
|
|
1907
|
+
</dl>
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
</dd>
|
|
1911
|
+
</dl>
|
|
1912
|
+
</details>
|
|
1913
|
+
|
|
1914
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">update</a>(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsUpdate200Response</code></summary>
|
|
1915
|
+
<dl>
|
|
1916
|
+
<dd>
|
|
1917
|
+
|
|
1918
|
+
#### 📝 Description
|
|
1919
|
+
|
|
1920
|
+
<dl>
|
|
1921
|
+
<dd>
|
|
1922
|
+
|
|
1923
|
+
<dl>
|
|
1924
|
+
<dd>
|
|
1925
|
+
|
|
1926
|
+
A document that is being deleted answers 404.
|
|
1927
|
+
</dd>
|
|
1928
|
+
</dl>
|
|
1929
|
+
</dd>
|
|
1930
|
+
</dl>
|
|
1931
|
+
|
|
1932
|
+
#### 🔌 Usage
|
|
1933
|
+
|
|
1934
|
+
<dl>
|
|
1935
|
+
<dd>
|
|
1936
|
+
|
|
1937
|
+
<dl>
|
|
1938
|
+
<dd>
|
|
1939
|
+
|
|
1940
|
+
```ruby
|
|
1941
|
+
client.documents.update(
|
|
1942
|
+
tenant_id: "tenantId",
|
|
1943
|
+
id: "id",
|
|
1944
|
+
name: "name"
|
|
1945
|
+
)
|
|
1946
|
+
```
|
|
1947
|
+
</dd>
|
|
1948
|
+
</dl>
|
|
1949
|
+
</dd>
|
|
1950
|
+
</dl>
|
|
1951
|
+
|
|
1952
|
+
#### ⚙️ Parameters
|
|
1953
|
+
|
|
1954
|
+
<dl>
|
|
1955
|
+
<dd>
|
|
1956
|
+
|
|
1957
|
+
<dl>
|
|
1958
|
+
<dd>
|
|
1959
|
+
|
|
1960
|
+
**tenant_id:** `String`
|
|
1961
|
+
|
|
1962
|
+
</dd>
|
|
1963
|
+
</dl>
|
|
1964
|
+
|
|
1965
|
+
<dl>
|
|
1966
|
+
<dd>
|
|
1967
|
+
|
|
1968
|
+
**id:** `String`
|
|
1969
|
+
|
|
1970
|
+
</dd>
|
|
1971
|
+
</dl>
|
|
1972
|
+
|
|
1973
|
+
<dl>
|
|
1974
|
+
<dd>
|
|
1975
|
+
|
|
1976
|
+
**name:** `String` — What people call the document: shown in dashboards, searched and sorted by. 1 to 255 characters, no control characters, no leading or trailing whitespace. Names need not be unique.
|
|
1977
|
+
|
|
1978
|
+
</dd>
|
|
1979
|
+
</dl>
|
|
1980
|
+
|
|
1981
|
+
<dl>
|
|
1982
|
+
<dd>
|
|
1983
|
+
|
|
1984
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
1985
|
+
|
|
1986
|
+
</dd>
|
|
1987
|
+
</dl>
|
|
1988
|
+
</dd>
|
|
1989
|
+
</dl>
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
</dd>
|
|
1993
|
+
</dl>
|
|
1994
|
+
</details>
|
|
1995
|
+
|
|
1996
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">commit</a>(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsCommit200Response</code></summary>
|
|
1997
|
+
<dl>
|
|
1998
|
+
<dd>
|
|
1999
|
+
|
|
2000
|
+
#### 🔌 Usage
|
|
2001
|
+
|
|
2002
|
+
<dl>
|
|
2003
|
+
<dd>
|
|
2004
|
+
|
|
2005
|
+
<dl>
|
|
2006
|
+
<dd>
|
|
2007
|
+
|
|
2008
|
+
```ruby
|
|
2009
|
+
client.documents.commit(
|
|
2010
|
+
tenant_id: "tenantId",
|
|
2011
|
+
id: "id",
|
|
2012
|
+
sha256: "sha256"
|
|
2013
|
+
)
|
|
2014
|
+
```
|
|
2015
|
+
</dd>
|
|
2016
|
+
</dl>
|
|
2017
|
+
</dd>
|
|
2018
|
+
</dl>
|
|
2019
|
+
|
|
2020
|
+
#### ⚙️ Parameters
|
|
2021
|
+
|
|
2022
|
+
<dl>
|
|
2023
|
+
<dd>
|
|
2024
|
+
|
|
2025
|
+
<dl>
|
|
2026
|
+
<dd>
|
|
2027
|
+
|
|
2028
|
+
**tenant_id:** `String`
|
|
2029
|
+
|
|
2030
|
+
</dd>
|
|
2031
|
+
</dl>
|
|
2032
|
+
|
|
2033
|
+
<dl>
|
|
2034
|
+
<dd>
|
|
2035
|
+
|
|
2036
|
+
**id:** `String`
|
|
2037
|
+
|
|
2038
|
+
</dd>
|
|
2039
|
+
</dl>
|
|
2040
|
+
|
|
2041
|
+
<dl>
|
|
2042
|
+
<dd>
|
|
2043
|
+
|
|
2044
|
+
**sha256:** `String`
|
|
2045
|
+
|
|
2046
|
+
</dd>
|
|
2047
|
+
</dl>
|
|
2048
|
+
|
|
2049
|
+
<dl>
|
|
2050
|
+
<dd>
|
|
2051
|
+
|
|
2052
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2053
|
+
|
|
2054
|
+
</dd>
|
|
2055
|
+
</dl>
|
|
2056
|
+
</dd>
|
|
2057
|
+
</dl>
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
</dd>
|
|
2061
|
+
</dl>
|
|
2062
|
+
</details>
|
|
2063
|
+
|
|
2064
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">download</a>(tenant_id:, id:) -> String</code></summary>
|
|
2065
|
+
<dl>
|
|
2066
|
+
<dd>
|
|
2067
|
+
|
|
2068
|
+
#### 🔌 Usage
|
|
2069
|
+
|
|
2070
|
+
<dl>
|
|
2071
|
+
<dd>
|
|
2072
|
+
|
|
2073
|
+
<dl>
|
|
2074
|
+
<dd>
|
|
2075
|
+
|
|
2076
|
+
```ruby
|
|
2077
|
+
client.documents.download(
|
|
2078
|
+
tenant_id: "tenantId",
|
|
2079
|
+
id: "id"
|
|
2080
|
+
)
|
|
2081
|
+
```
|
|
2082
|
+
</dd>
|
|
2083
|
+
</dl>
|
|
2084
|
+
</dd>
|
|
2085
|
+
</dl>
|
|
2086
|
+
|
|
2087
|
+
#### ⚙️ Parameters
|
|
2088
|
+
|
|
2089
|
+
<dl>
|
|
2090
|
+
<dd>
|
|
2091
|
+
|
|
2092
|
+
<dl>
|
|
2093
|
+
<dd>
|
|
2094
|
+
|
|
2095
|
+
**tenant_id:** `String`
|
|
2096
|
+
|
|
2097
|
+
</dd>
|
|
2098
|
+
</dl>
|
|
2099
|
+
|
|
2100
|
+
<dl>
|
|
2101
|
+
<dd>
|
|
2102
|
+
|
|
2103
|
+
**id:** `String`
|
|
2104
|
+
|
|
2105
|
+
</dd>
|
|
2106
|
+
</dl>
|
|
2107
|
+
|
|
2108
|
+
<dl>
|
|
2109
|
+
<dd>
|
|
2110
|
+
|
|
2111
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2112
|
+
|
|
2113
|
+
</dd>
|
|
2114
|
+
</dl>
|
|
2115
|
+
</dd>
|
|
2116
|
+
</dl>
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
</dd>
|
|
2120
|
+
</dl>
|
|
2121
|
+
</details>
|
|
2122
|
+
|
|
2123
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">thumbnail</a>(tenant_id:, id:) -> String</code></summary>
|
|
2124
|
+
<dl>
|
|
2125
|
+
<dd>
|
|
2126
|
+
|
|
2127
|
+
#### 🔌 Usage
|
|
2128
|
+
|
|
2129
|
+
<dl>
|
|
2130
|
+
<dd>
|
|
2131
|
+
|
|
2132
|
+
<dl>
|
|
2133
|
+
<dd>
|
|
2134
|
+
|
|
2135
|
+
```ruby
|
|
2136
|
+
client.documents.thumbnail(
|
|
2137
|
+
tenant_id: "tenantId",
|
|
2138
|
+
id: "id"
|
|
2139
|
+
)
|
|
2140
|
+
```
|
|
2141
|
+
</dd>
|
|
2142
|
+
</dl>
|
|
2143
|
+
</dd>
|
|
2144
|
+
</dl>
|
|
2145
|
+
|
|
2146
|
+
#### ⚙️ Parameters
|
|
2147
|
+
|
|
2148
|
+
<dl>
|
|
2149
|
+
<dd>
|
|
2150
|
+
|
|
2151
|
+
<dl>
|
|
2152
|
+
<dd>
|
|
2153
|
+
|
|
2154
|
+
**tenant_id:** `String`
|
|
2155
|
+
|
|
2156
|
+
</dd>
|
|
2157
|
+
</dl>
|
|
2158
|
+
|
|
2159
|
+
<dl>
|
|
2160
|
+
<dd>
|
|
2161
|
+
|
|
2162
|
+
**id:** `String`
|
|
2163
|
+
|
|
2164
|
+
</dd>
|
|
2165
|
+
</dl>
|
|
2166
|
+
|
|
2167
|
+
<dl>
|
|
2168
|
+
<dd>
|
|
2169
|
+
|
|
2170
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2171
|
+
|
|
2172
|
+
</dd>
|
|
2173
|
+
</dl>
|
|
2174
|
+
</dd>
|
|
2175
|
+
</dl>
|
|
2176
|
+
|
|
2177
|
+
|
|
2178
|
+
</dd>
|
|
2179
|
+
</dl>
|
|
2180
|
+
</details>
|
|
2181
|
+
|
|
2182
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">upload_proxy</a>(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsUploadProxy200Response</code></summary>
|
|
2183
|
+
<dl>
|
|
2184
|
+
<dd>
|
|
2185
|
+
|
|
2186
|
+
#### 📝 Description
|
|
2187
|
+
|
|
2188
|
+
<dl>
|
|
2189
|
+
<dd>
|
|
2190
|
+
|
|
2191
|
+
<dl>
|
|
2192
|
+
<dd>
|
|
2193
|
+
|
|
2194
|
+
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.
|
|
2195
|
+
</dd>
|
|
2196
|
+
</dl>
|
|
2197
|
+
</dd>
|
|
2198
|
+
</dl>
|
|
2199
|
+
|
|
2200
|
+
#### 🔌 Usage
|
|
2201
|
+
|
|
2202
|
+
<dl>
|
|
2203
|
+
<dd>
|
|
2204
|
+
|
|
2205
|
+
<dl>
|
|
2206
|
+
<dd>
|
|
2207
|
+
|
|
2208
|
+
```ruby
|
|
2209
|
+
File.open("document.pdf", "rb") do |file|
|
|
2210
|
+
client.documents.upload_proxy(
|
|
2211
|
+
tenant_id: "tenantId",
|
|
2212
|
+
id: "id",
|
|
2213
|
+
file: file
|
|
2214
|
+
)
|
|
2215
|
+
end
|
|
2216
|
+
```
|
|
2217
|
+
</dd>
|
|
2218
|
+
</dl>
|
|
2219
|
+
</dd>
|
|
2220
|
+
</dl>
|
|
2221
|
+
|
|
2222
|
+
#### ⚙️ Parameters
|
|
2223
|
+
|
|
2224
|
+
<dl>
|
|
2225
|
+
<dd>
|
|
2226
|
+
|
|
2227
|
+
<dl>
|
|
2228
|
+
<dd>
|
|
2229
|
+
|
|
2230
|
+
**tenant_id:** `String`
|
|
2231
|
+
|
|
2232
|
+
</dd>
|
|
2233
|
+
</dl>
|
|
2234
|
+
|
|
2235
|
+
<dl>
|
|
2236
|
+
<dd>
|
|
2237
|
+
|
|
2238
|
+
**id:** `String`
|
|
2239
|
+
|
|
2240
|
+
</dd>
|
|
2241
|
+
</dl>
|
|
2242
|
+
|
|
2243
|
+
<dl>
|
|
2244
|
+
<dd>
|
|
2245
|
+
|
|
2246
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2247
|
+
|
|
2248
|
+
</dd>
|
|
2249
|
+
</dl>
|
|
2250
|
+
</dd>
|
|
2251
|
+
</dl>
|
|
2252
|
+
|
|
2253
|
+
|
|
2254
|
+
</dd>
|
|
2255
|
+
</dl>
|
|
2256
|
+
</details>
|
|
2257
|
+
|
|
2258
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">import_from</a>(tenant_id:, request) -> CloudPDF::Types::DocumentsImportFrom200Response</code></summary>
|
|
2259
|
+
<dl>
|
|
2260
|
+
<dd>
|
|
2261
|
+
|
|
2262
|
+
#### 📝 Description
|
|
2263
|
+
|
|
2264
|
+
<dl>
|
|
2265
|
+
<dd>
|
|
2266
|
+
|
|
2267
|
+
<dl>
|
|
2268
|
+
<dd>
|
|
2269
|
+
|
|
2270
|
+
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).
|
|
2271
|
+
</dd>
|
|
2272
|
+
</dl>
|
|
2273
|
+
</dd>
|
|
2274
|
+
</dl>
|
|
2275
|
+
|
|
2276
|
+
#### 🔌 Usage
|
|
2277
|
+
|
|
2278
|
+
<dl>
|
|
2279
|
+
<dd>
|
|
2280
|
+
|
|
2281
|
+
<dl>
|
|
2282
|
+
<dd>
|
|
2283
|
+
|
|
2284
|
+
```ruby
|
|
2285
|
+
client.documents.import_from(tenant_id: "tenantId")
|
|
2286
|
+
```
|
|
2287
|
+
</dd>
|
|
2288
|
+
</dl>
|
|
2289
|
+
</dd>
|
|
2290
|
+
</dl>
|
|
2291
|
+
|
|
2292
|
+
#### ⚙️ Parameters
|
|
2293
|
+
|
|
2294
|
+
<dl>
|
|
2295
|
+
<dd>
|
|
2296
|
+
|
|
2297
|
+
<dl>
|
|
2298
|
+
<dd>
|
|
2299
|
+
|
|
2300
|
+
**tenant_id:** `String`
|
|
2301
|
+
|
|
2302
|
+
</dd>
|
|
2303
|
+
</dl>
|
|
2304
|
+
|
|
2305
|
+
<dl>
|
|
2306
|
+
<dd>
|
|
2307
|
+
|
|
2308
|
+
**source:** `CloudPDF::Documents::Types::DocumentsImportFromRequestSource` — Where CloudPDF pulls the bytes from. The two shapes differ in who supplies the authority to read, not in which storage vendor holds the file.
|
|
2309
|
+
|
|
2310
|
+
</dd>
|
|
2311
|
+
</dl>
|
|
2312
|
+
|
|
2313
|
+
<dl>
|
|
2314
|
+
<dd>
|
|
2315
|
+
|
|
2316
|
+
**expected:** `CloudPDF::Documents::Types::DocumentsImportFromRequestExpected` — Integrity pins, enforced when present. When absent, the server-observed values become authoritative.
|
|
2317
|
+
|
|
2318
|
+
</dd>
|
|
2319
|
+
</dl>
|
|
2320
|
+
|
|
2321
|
+
<dl>
|
|
2322
|
+
<dd>
|
|
2323
|
+
|
|
2324
|
+
**name:** `String` — What people call the document: shown in dashboards, searched and sorted by. 1 to 255 characters, no control characters, no leading or trailing whitespace. Names need not be unique.
|
|
2325
|
+
|
|
2326
|
+
</dd>
|
|
2327
|
+
</dl>
|
|
2328
|
+
|
|
2329
|
+
<dl>
|
|
2330
|
+
<dd>
|
|
2331
|
+
|
|
2332
|
+
**folder_id:** `String` — A folder id, or root for the top level.
|
|
2333
|
+
|
|
2334
|
+
</dd>
|
|
2335
|
+
</dl>
|
|
2336
|
+
|
|
2337
|
+
<dl>
|
|
2338
|
+
<dd>
|
|
2339
|
+
|
|
2340
|
+
**metadata:** `Internal::Types::Hash[String, Object]`
|
|
2341
|
+
|
|
2342
|
+
</dd>
|
|
2343
|
+
</dl>
|
|
2344
|
+
|
|
2345
|
+
<dl>
|
|
2346
|
+
<dd>
|
|
2347
|
+
|
|
2348
|
+
**idempotency_key:** `String` — Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.
|
|
2349
|
+
|
|
2350
|
+
</dd>
|
|
2351
|
+
</dl>
|
|
2352
|
+
|
|
2353
|
+
<dl>
|
|
2354
|
+
<dd>
|
|
2355
|
+
|
|
2356
|
+
**dedup_mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
|
|
2357
|
+
|
|
2358
|
+
</dd>
|
|
2359
|
+
</dl>
|
|
2360
|
+
|
|
2361
|
+
<dl>
|
|
2362
|
+
<dd>
|
|
2363
|
+
|
|
2364
|
+
**doc_id:** `String`
|
|
2365
|
+
|
|
2366
|
+
</dd>
|
|
2367
|
+
</dl>
|
|
2368
|
+
|
|
2369
|
+
<dl>
|
|
2370
|
+
<dd>
|
|
2371
|
+
|
|
2372
|
+
**mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestMode` — sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.
|
|
2373
|
+
|
|
2374
|
+
</dd>
|
|
2375
|
+
</dl>
|
|
2376
|
+
|
|
2377
|
+
<dl>
|
|
2378
|
+
<dd>
|
|
2379
|
+
|
|
2380
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2381
|
+
|
|
2382
|
+
</dd>
|
|
2383
|
+
</dl>
|
|
2384
|
+
</dd>
|
|
2385
|
+
</dl>
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
</dd>
|
|
2389
|
+
</dl>
|
|
2390
|
+
</details>
|
|
2391
|
+
|
|
2392
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">init</a>(tenant_id:, request) -> CloudPDF::Types::DocumentsInit200Response</code></summary>
|
|
2393
|
+
<dl>
|
|
2394
|
+
<dd>
|
|
2395
|
+
|
|
2396
|
+
#### 🔌 Usage
|
|
2397
|
+
|
|
2398
|
+
<dl>
|
|
2399
|
+
<dd>
|
|
2400
|
+
|
|
2401
|
+
<dl>
|
|
2402
|
+
<dd>
|
|
2403
|
+
|
|
2404
|
+
```ruby
|
|
2405
|
+
client.documents.init(
|
|
2406
|
+
tenant_id: "tenantId",
|
|
2407
|
+
content_length: 1.1,
|
|
2408
|
+
content_sha256: "contentSha256"
|
|
2409
|
+
)
|
|
2410
|
+
```
|
|
2411
|
+
</dd>
|
|
2412
|
+
</dl>
|
|
2413
|
+
</dd>
|
|
2414
|
+
</dl>
|
|
2415
|
+
|
|
2416
|
+
#### ⚙️ Parameters
|
|
2417
|
+
|
|
2418
|
+
<dl>
|
|
2419
|
+
<dd>
|
|
2420
|
+
|
|
2421
|
+
<dl>
|
|
2422
|
+
<dd>
|
|
2423
|
+
|
|
2424
|
+
**tenant_id:** `String`
|
|
2425
|
+
|
|
2426
|
+
</dd>
|
|
2427
|
+
</dl>
|
|
2428
|
+
|
|
2429
|
+
<dl>
|
|
2430
|
+
<dd>
|
|
2431
|
+
|
|
2432
|
+
**content_length:** `Integer`
|
|
2433
|
+
|
|
2434
|
+
</dd>
|
|
2435
|
+
</dl>
|
|
2436
|
+
|
|
2437
|
+
<dl>
|
|
2438
|
+
<dd>
|
|
2439
|
+
|
|
2440
|
+
**content_sha256:** `String`
|
|
2441
|
+
|
|
2442
|
+
</dd>
|
|
2443
|
+
</dl>
|
|
2444
|
+
|
|
2445
|
+
<dl>
|
|
2446
|
+
<dd>
|
|
2447
|
+
|
|
2448
|
+
**name:** `String` — What people call the document: shown in dashboards, searched and sorted by. 1 to 255 characters, no control characters, no leading or trailing whitespace. Names need not be unique.
|
|
2449
|
+
|
|
2450
|
+
</dd>
|
|
2451
|
+
</dl>
|
|
2452
|
+
|
|
2453
|
+
<dl>
|
|
2454
|
+
<dd>
|
|
2455
|
+
|
|
2456
|
+
**folder_id:** `String` — A folder id, or root for the top level.
|
|
2457
|
+
|
|
2458
|
+
</dd>
|
|
2459
|
+
</dl>
|
|
1790
2460
|
|
|
1791
|
-
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">delete</a>(tenant_id:, id:) -> </code></summary>
|
|
1792
2461
|
<dl>
|
|
1793
2462
|
<dd>
|
|
1794
2463
|
|
|
1795
|
-
|
|
2464
|
+
**metadata:** `Internal::Types::Hash[String, Object]`
|
|
2465
|
+
|
|
2466
|
+
</dd>
|
|
2467
|
+
</dl>
|
|
1796
2468
|
|
|
1797
2469
|
<dl>
|
|
1798
2470
|
<dd>
|
|
1799
2471
|
|
|
2472
|
+
**idempotency_key:** `String`
|
|
2473
|
+
|
|
2474
|
+
</dd>
|
|
2475
|
+
</dl>
|
|
2476
|
+
|
|
1800
2477
|
<dl>
|
|
1801
2478
|
<dd>
|
|
1802
2479
|
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
tenant_id: "tenantId",
|
|
1806
|
-
id: "id"
|
|
1807
|
-
)
|
|
1808
|
-
```
|
|
1809
|
-
</dd>
|
|
1810
|
-
</dl>
|
|
2480
|
+
**dedup_mode:** `CloudPDF::Documents::Types::DocumentsInitRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
|
|
2481
|
+
|
|
1811
2482
|
</dd>
|
|
1812
2483
|
</dl>
|
|
1813
2484
|
|
|
1814
|
-
#### ⚙️ Parameters
|
|
1815
|
-
|
|
1816
2485
|
<dl>
|
|
1817
2486
|
<dd>
|
|
1818
2487
|
|
|
2488
|
+
**doc_id:** `String`
|
|
2489
|
+
|
|
2490
|
+
</dd>
|
|
2491
|
+
</dl>
|
|
2492
|
+
|
|
1819
2493
|
<dl>
|
|
1820
2494
|
<dd>
|
|
1821
2495
|
|
|
1822
|
-
**
|
|
2496
|
+
**upload_ttl_sec:** `Integer`
|
|
1823
2497
|
|
|
1824
2498
|
</dd>
|
|
1825
2499
|
</dl>
|
|
@@ -1827,7 +2501,7 @@ client.documents.delete(
|
|
|
1827
2501
|
<dl>
|
|
1828
2502
|
<dd>
|
|
1829
2503
|
|
|
1830
|
-
**
|
|
2504
|
+
**upload_preference:** `CloudPDF::Documents::Types::DocumentsInitRequestUploadPreference`
|
|
1831
2505
|
|
|
1832
2506
|
</dd>
|
|
1833
2507
|
</dl>
|
|
@@ -1847,7 +2521,8 @@ client.documents.delete(
|
|
|
1847
2521
|
</dl>
|
|
1848
2522
|
</details>
|
|
1849
2523
|
|
|
1850
|
-
|
|
2524
|
+
## Folders
|
|
2525
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">list</a>(tenant_id:) -> CloudPDF::Types::FoldersList200Response</code></summary>
|
|
1851
2526
|
<dl>
|
|
1852
2527
|
<dd>
|
|
1853
2528
|
|
|
@@ -1860,11 +2535,7 @@ client.documents.delete(
|
|
|
1860
2535
|
<dd>
|
|
1861
2536
|
|
|
1862
2537
|
```ruby
|
|
1863
|
-
client.
|
|
1864
|
-
tenant_id: "tenantId",
|
|
1865
|
-
id: "id",
|
|
1866
|
-
sha256: "sha256"
|
|
1867
|
-
)
|
|
2538
|
+
client.folders.list(tenant_id: "tenantId")
|
|
1868
2539
|
```
|
|
1869
2540
|
</dd>
|
|
1870
2541
|
</dl>
|
|
@@ -1887,7 +2558,7 @@ client.documents.commit(
|
|
|
1887
2558
|
<dl>
|
|
1888
2559
|
<dd>
|
|
1889
2560
|
|
|
1890
|
-
**
|
|
2561
|
+
**limit:** `Integer`
|
|
1891
2562
|
|
|
1892
2563
|
</dd>
|
|
1893
2564
|
</dl>
|
|
@@ -1895,7 +2566,7 @@ client.documents.commit(
|
|
|
1895
2566
|
<dl>
|
|
1896
2567
|
<dd>
|
|
1897
2568
|
|
|
1898
|
-
**
|
|
2569
|
+
**cursor:** `String`
|
|
1899
2570
|
|
|
1900
2571
|
</dd>
|
|
1901
2572
|
</dl>
|
|
@@ -1903,7 +2574,15 @@ client.documents.commit(
|
|
|
1903
2574
|
<dl>
|
|
1904
2575
|
<dd>
|
|
1905
2576
|
|
|
1906
|
-
**
|
|
2577
|
+
**parent_id:** `String` — Only the folders directly in this folder (root: the top level). Without it, every folder.
|
|
2578
|
+
|
|
2579
|
+
</dd>
|
|
2580
|
+
</dl>
|
|
2581
|
+
|
|
2582
|
+
<dl>
|
|
2583
|
+
<dd>
|
|
2584
|
+
|
|
2585
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
1907
2586
|
|
|
1908
2587
|
</dd>
|
|
1909
2588
|
</dl>
|
|
@@ -1915,10 +2594,24 @@ client.documents.commit(
|
|
|
1915
2594
|
</dl>
|
|
1916
2595
|
</details>
|
|
1917
2596
|
|
|
1918
|
-
<details><summary><code>client.
|
|
2597
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">create</a>(tenant_id:, request) -> CloudPDF::Types::FoldersCreate200Response</code></summary>
|
|
2598
|
+
<dl>
|
|
2599
|
+
<dd>
|
|
2600
|
+
|
|
2601
|
+
#### 📝 Description
|
|
2602
|
+
|
|
1919
2603
|
<dl>
|
|
1920
2604
|
<dd>
|
|
1921
2605
|
|
|
2606
|
+
<dl>
|
|
2607
|
+
<dd>
|
|
2608
|
+
|
|
2609
|
+
409 Conflict carries `details.reason`: `name-taken` (a sibling has the name, ignoring case; `details.name`) or `too-deep` (folders nest at most 100 levels; `details.maxDepth`). 404 when the parent folder does not exist.
|
|
2610
|
+
</dd>
|
|
2611
|
+
</dl>
|
|
2612
|
+
</dd>
|
|
2613
|
+
</dl>
|
|
2614
|
+
|
|
1922
2615
|
#### 🔌 Usage
|
|
1923
2616
|
|
|
1924
2617
|
<dl>
|
|
@@ -1928,9 +2621,9 @@ client.documents.commit(
|
|
|
1928
2621
|
<dd>
|
|
1929
2622
|
|
|
1930
2623
|
```ruby
|
|
1931
|
-
client.
|
|
2624
|
+
client.folders.create(
|
|
1932
2625
|
tenant_id: "tenantId",
|
|
1933
|
-
|
|
2626
|
+
name: "name"
|
|
1934
2627
|
)
|
|
1935
2628
|
```
|
|
1936
2629
|
</dd>
|
|
@@ -1954,7 +2647,7 @@ client.documents.download(
|
|
|
1954
2647
|
<dl>
|
|
1955
2648
|
<dd>
|
|
1956
2649
|
|
|
1957
|
-
**
|
|
2650
|
+
**name:** `String` — What people call the folder: 1 to 255 characters, no control characters, no leading or trailing whitespace, and unique among the folder's siblings, ignoring case.
|
|
1958
2651
|
|
|
1959
2652
|
</dd>
|
|
1960
2653
|
</dl>
|
|
@@ -1962,7 +2655,15 @@ client.documents.download(
|
|
|
1962
2655
|
<dl>
|
|
1963
2656
|
<dd>
|
|
1964
2657
|
|
|
1965
|
-
**
|
|
2658
|
+
**parent_id:** `String` — A folder id, or root for the top level.
|
|
2659
|
+
|
|
2660
|
+
</dd>
|
|
2661
|
+
</dl>
|
|
2662
|
+
|
|
2663
|
+
<dl>
|
|
2664
|
+
<dd>
|
|
2665
|
+
|
|
2666
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
1966
2667
|
|
|
1967
2668
|
</dd>
|
|
1968
2669
|
</dl>
|
|
@@ -1974,7 +2675,7 @@ client.documents.download(
|
|
|
1974
2675
|
</dl>
|
|
1975
2676
|
</details>
|
|
1976
2677
|
|
|
1977
|
-
<details><summary><code>client.
|
|
2678
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">get</a>(tenant_id:, folder_id:) -> CloudPDF::Types::FoldersGet200Response</code></summary>
|
|
1978
2679
|
<dl>
|
|
1979
2680
|
<dd>
|
|
1980
2681
|
|
|
@@ -1987,9 +2688,9 @@ client.documents.download(
|
|
|
1987
2688
|
<dd>
|
|
1988
2689
|
|
|
1989
2690
|
```ruby
|
|
1990
|
-
client.
|
|
2691
|
+
client.folders.get(
|
|
1991
2692
|
tenant_id: "tenantId",
|
|
1992
|
-
|
|
2693
|
+
folder_id: "folderId"
|
|
1993
2694
|
)
|
|
1994
2695
|
```
|
|
1995
2696
|
</dd>
|
|
@@ -2013,7 +2714,7 @@ client.documents.thumbnail(
|
|
|
2013
2714
|
<dl>
|
|
2014
2715
|
<dd>
|
|
2015
2716
|
|
|
2016
|
-
**
|
|
2717
|
+
**folder_id:** `String`
|
|
2017
2718
|
|
|
2018
2719
|
</dd>
|
|
2019
2720
|
</dl>
|
|
@@ -2021,7 +2722,7 @@ client.documents.thumbnail(
|
|
|
2021
2722
|
<dl>
|
|
2022
2723
|
<dd>
|
|
2023
2724
|
|
|
2024
|
-
**request_options:** `CloudPDF::
|
|
2725
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
2025
2726
|
|
|
2026
2727
|
</dd>
|
|
2027
2728
|
</dl>
|
|
@@ -2033,7 +2734,7 @@ client.documents.thumbnail(
|
|
|
2033
2734
|
</dl>
|
|
2034
2735
|
</details>
|
|
2035
2736
|
|
|
2036
|
-
<details><summary><code>client.
|
|
2737
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">delete</a>(tenant_id:, folder_id:) -> </code></summary>
|
|
2037
2738
|
<dl>
|
|
2038
2739
|
<dd>
|
|
2039
2740
|
|
|
@@ -2045,7 +2746,7 @@ client.documents.thumbnail(
|
|
|
2045
2746
|
<dl>
|
|
2046
2747
|
<dd>
|
|
2047
2748
|
|
|
2048
|
-
|
|
2749
|
+
Without recursive, a folder with anything inside is refused: 409 Conflict with `details.reason` `not-empty` and what it holds, counted over every level below, in `details.folders` and `details.documents`. With recursive=true, the folder and every folder under it go at once, and every document in them stops opening, leaves every list and stops answering its grants at once; their stored files and grants are removed in the background. Uploads into those folders that have not committed cannot commit.
|
|
2049
2750
|
</dd>
|
|
2050
2751
|
</dl>
|
|
2051
2752
|
</dd>
|
|
@@ -2060,13 +2761,10 @@ This bounded origin-mediated fallback must only be used after documents.init ret
|
|
|
2060
2761
|
<dd>
|
|
2061
2762
|
|
|
2062
2763
|
```ruby
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
file: file
|
|
2068
|
-
)
|
|
2069
|
-
end
|
|
2764
|
+
client.folders.delete(
|
|
2765
|
+
tenant_id: "tenantId",
|
|
2766
|
+
folder_id: "folderId"
|
|
2767
|
+
)
|
|
2070
2768
|
```
|
|
2071
2769
|
</dd>
|
|
2072
2770
|
</dl>
|
|
@@ -2089,7 +2787,7 @@ end
|
|
|
2089
2787
|
<dl>
|
|
2090
2788
|
<dd>
|
|
2091
2789
|
|
|
2092
|
-
**
|
|
2790
|
+
**folder_id:** `String`
|
|
2093
2791
|
|
|
2094
2792
|
</dd>
|
|
2095
2793
|
</dl>
|
|
@@ -2097,7 +2795,15 @@ end
|
|
|
2097
2795
|
<dl>
|
|
2098
2796
|
<dd>
|
|
2099
2797
|
|
|
2100
|
-
**
|
|
2798
|
+
**recursive:** `Internal::Types::Boolean` — true deletes everything in the folder too. Never the default.
|
|
2799
|
+
|
|
2800
|
+
</dd>
|
|
2801
|
+
</dl>
|
|
2802
|
+
|
|
2803
|
+
<dl>
|
|
2804
|
+
<dd>
|
|
2805
|
+
|
|
2806
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
2101
2807
|
|
|
2102
2808
|
</dd>
|
|
2103
2809
|
</dl>
|
|
@@ -2109,7 +2815,7 @@ end
|
|
|
2109
2815
|
</dl>
|
|
2110
2816
|
</details>
|
|
2111
2817
|
|
|
2112
|
-
<details><summary><code>client.
|
|
2818
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">update</a>(tenant_id:, folder_id:, request) -> CloudPDF::Types::FoldersUpdate200Response</code></summary>
|
|
2113
2819
|
<dl>
|
|
2114
2820
|
<dd>
|
|
2115
2821
|
|
|
@@ -2121,7 +2827,7 @@ end
|
|
|
2121
2827
|
<dl>
|
|
2122
2828
|
<dd>
|
|
2123
2829
|
|
|
2124
|
-
|
|
2830
|
+
409 Conflict with `details.reason` `name-taken` when a sibling has the name, ignoring case.
|
|
2125
2831
|
</dd>
|
|
2126
2832
|
</dl>
|
|
2127
2833
|
</dd>
|
|
@@ -2136,7 +2842,11 @@ Default mode is synchronous and bounded: the response returns only after the tra
|
|
|
2136
2842
|
<dd>
|
|
2137
2843
|
|
|
2138
2844
|
```ruby
|
|
2139
|
-
client.
|
|
2845
|
+
client.folders.update(
|
|
2846
|
+
tenant_id: "tenantId",
|
|
2847
|
+
folder_id: "folderId",
|
|
2848
|
+
name: "name"
|
|
2849
|
+
)
|
|
2140
2850
|
```
|
|
2141
2851
|
</dd>
|
|
2142
2852
|
</dl>
|
|
@@ -2159,7 +2869,7 @@ client.documents.import_from(tenant_id: "tenantId")
|
|
|
2159
2869
|
<dl>
|
|
2160
2870
|
<dd>
|
|
2161
2871
|
|
|
2162
|
-
**
|
|
2872
|
+
**folder_id:** `String`
|
|
2163
2873
|
|
|
2164
2874
|
</dd>
|
|
2165
2875
|
</dl>
|
|
@@ -2167,7 +2877,7 @@ client.documents.import_from(tenant_id: "tenantId")
|
|
|
2167
2877
|
<dl>
|
|
2168
2878
|
<dd>
|
|
2169
2879
|
|
|
2170
|
-
**
|
|
2880
|
+
**name:** `String` — What people call the folder: 1 to 255 characters, no control characters, no leading or trailing whitespace, and unique among the folder's siblings, ignoring case.
|
|
2171
2881
|
|
|
2172
2882
|
</dd>
|
|
2173
2883
|
</dl>
|
|
@@ -2175,61 +2885,35 @@ client.documents.import_from(tenant_id: "tenantId")
|
|
|
2175
2885
|
<dl>
|
|
2176
2886
|
<dd>
|
|
2177
2887
|
|
|
2178
|
-
**
|
|
2888
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
2179
2889
|
|
|
2180
2890
|
</dd>
|
|
2181
2891
|
</dl>
|
|
2182
|
-
|
|
2183
|
-
<dl>
|
|
2184
|
-
<dd>
|
|
2185
|
-
|
|
2186
|
-
**idempotency_key:** `String` — Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.
|
|
2187
|
-
|
|
2188
2892
|
</dd>
|
|
2189
2893
|
</dl>
|
|
2190
2894
|
|
|
2191
|
-
<dl>
|
|
2192
|
-
<dd>
|
|
2193
2895
|
|
|
2194
|
-
**dedup_mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
|
|
2195
|
-
|
|
2196
2896
|
</dd>
|
|
2197
2897
|
</dl>
|
|
2898
|
+
</details>
|
|
2198
2899
|
|
|
2900
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">move_into</a>(tenant_id:, folder_id:, request) -> </code></summary>
|
|
2199
2901
|
<dl>
|
|
2200
2902
|
<dd>
|
|
2201
2903
|
|
|
2202
|
-
|
|
2203
|
-
|
|
2204
|
-
</dd>
|
|
2205
|
-
</dl>
|
|
2904
|
+
#### 📝 Description
|
|
2206
2905
|
|
|
2207
2906
|
<dl>
|
|
2208
2907
|
<dd>
|
|
2209
2908
|
|
|
2210
|
-
**mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestMode` — sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.
|
|
2211
|
-
|
|
2212
|
-
</dd>
|
|
2213
|
-
</dl>
|
|
2214
|
-
|
|
2215
2909
|
<dl>
|
|
2216
2910
|
<dd>
|
|
2217
2911
|
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
</dd>
|
|
2221
|
-
</dl>
|
|
2912
|
+
Up to 1,000 ids in total. A folder moves with everything in it. 404 NotFound names the ids that do not exist or are being deleted in `details.documentIds` and `details.folderIds`. 409 Conflict carries `details.reason`: `cycle` (the destination is a moved folder or inside one; `details.folderId`), `too-deep` (the move would nest folders deeper than 100 levels; `details.maxDepth`) or `name-taken` (a moved folder's name is taken in the destination, ignoring case; `details.name`).
|
|
2222
2913
|
</dd>
|
|
2223
2914
|
</dl>
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
2915
|
</dd>
|
|
2227
2916
|
</dl>
|
|
2228
|
-
</details>
|
|
2229
|
-
|
|
2230
|
-
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">init</a>(tenant_id:, request) -> CloudPDF::Types::DocumentsInit200Response</code></summary>
|
|
2231
|
-
<dl>
|
|
2232
|
-
<dd>
|
|
2233
2917
|
|
|
2234
2918
|
#### 🔌 Usage
|
|
2235
2919
|
|
|
@@ -2240,10 +2924,9 @@ client.documents.import_from(tenant_id: "tenantId")
|
|
|
2240
2924
|
<dd>
|
|
2241
2925
|
|
|
2242
2926
|
```ruby
|
|
2243
|
-
client.
|
|
2927
|
+
client.folders.move_into(
|
|
2244
2928
|
tenant_id: "tenantId",
|
|
2245
|
-
|
|
2246
|
-
content_sha256: "contentSha256"
|
|
2929
|
+
folder_id: "folderId"
|
|
2247
2930
|
)
|
|
2248
2931
|
```
|
|
2249
2932
|
</dd>
|
|
@@ -2267,47 +2950,7 @@ client.documents.init(
|
|
|
2267
2950
|
<dl>
|
|
2268
2951
|
<dd>
|
|
2269
2952
|
|
|
2270
|
-
**
|
|
2271
|
-
|
|
2272
|
-
</dd>
|
|
2273
|
-
</dl>
|
|
2274
|
-
|
|
2275
|
-
<dl>
|
|
2276
|
-
<dd>
|
|
2277
|
-
|
|
2278
|
-
**content_sha256:** `String`
|
|
2279
|
-
|
|
2280
|
-
</dd>
|
|
2281
|
-
</dl>
|
|
2282
|
-
|
|
2283
|
-
<dl>
|
|
2284
|
-
<dd>
|
|
2285
|
-
|
|
2286
|
-
**metadata:** `Internal::Types::Hash[String, Object]`
|
|
2287
|
-
|
|
2288
|
-
</dd>
|
|
2289
|
-
</dl>
|
|
2290
|
-
|
|
2291
|
-
<dl>
|
|
2292
|
-
<dd>
|
|
2293
|
-
|
|
2294
|
-
**idempotency_key:** `String`
|
|
2295
|
-
|
|
2296
|
-
</dd>
|
|
2297
|
-
</dl>
|
|
2298
|
-
|
|
2299
|
-
<dl>
|
|
2300
|
-
<dd>
|
|
2301
|
-
|
|
2302
|
-
**dedup_mode:** `CloudPDF::Documents::Types::DocumentsInitRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
|
|
2303
|
-
|
|
2304
|
-
</dd>
|
|
2305
|
-
</dl>
|
|
2306
|
-
|
|
2307
|
-
<dl>
|
|
2308
|
-
<dd>
|
|
2309
|
-
|
|
2310
|
-
**doc_id:** `String`
|
|
2953
|
+
**folder_id:** `String` — A folder id, or root for the top level.
|
|
2311
2954
|
|
|
2312
2955
|
</dd>
|
|
2313
2956
|
</dl>
|
|
@@ -2315,7 +2958,7 @@ client.documents.init(
|
|
|
2315
2958
|
<dl>
|
|
2316
2959
|
<dd>
|
|
2317
2960
|
|
|
2318
|
-
**
|
|
2961
|
+
**document_ids:** `Internal::Types::Array[String]`
|
|
2319
2962
|
|
|
2320
2963
|
</dd>
|
|
2321
2964
|
</dl>
|
|
@@ -2323,7 +2966,7 @@ client.documents.init(
|
|
|
2323
2966
|
<dl>
|
|
2324
2967
|
<dd>
|
|
2325
2968
|
|
|
2326
|
-
**
|
|
2969
|
+
**folder_ids:** `Internal::Types::Array[String]`
|
|
2327
2970
|
|
|
2328
2971
|
</dd>
|
|
2329
2972
|
</dl>
|
|
@@ -2331,7 +2974,7 @@ client.documents.init(
|
|
|
2331
2974
|
<dl>
|
|
2332
2975
|
<dd>
|
|
2333
2976
|
|
|
2334
|
-
**request_options:** `CloudPDF::
|
|
2977
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
2335
2978
|
|
|
2336
2979
|
</dd>
|
|
2337
2980
|
</dl>
|
|
@@ -5164,7 +5807,7 @@ client.doc.signatures.cancel(
|
|
|
5164
5807
|
<dl>
|
|
5165
5808
|
<dd>
|
|
5166
5809
|
|
|
5167
|
-
`cms` is the detached CMS over the prepared digest, base64. `expectedVersion` must be what prepare returned. Idempotent by signing id: the same CMS again answers `already-completed`.
|
|
5810
|
+
`cms` is the detached CMS over the prepared digest, base64. `expectedVersion` must be what prepare returned. Idempotent by signing id: the same CMS again answers `already-completed`. The new version is the layer's own: only this layer moves to it, and the document and every other layer stay as they were. Refetch the manifest after a completion.
|
|
5168
5811
|
</dd>
|
|
5169
5812
|
</dl>
|
|
5170
5813
|
</dd>
|
|
@@ -5380,7 +6023,7 @@ client.doc.signatures.analysis(
|
|
|
5380
6023
|
<dl>
|
|
5381
6024
|
<dd>
|
|
5382
6025
|
|
|
5383
|
-
Multipart: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock), naming the appearance PDF it may carry as `resources: { appearance: '<key>' }`, and that PDF as the part `resource:<key>`. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is cancelled, or expires (15 minutes).
|
|
6026
|
+
Multipart: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock), naming the appearance PDF it may carry as `resources: { appearance: '<key>' }`, and that PDF as the part `resource:<key>`. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is cancelled, or expires (15 minutes). The signature is made over the layer's own base: the upload, or the version its last signature made.
|
|
5384
6027
|
</dd>
|
|
5385
6028
|
</dl>
|
|
5386
6029
|
</dd>
|
|
@@ -5450,7 +6093,7 @@ client.doc.signatures.prepare(
|
|
|
5450
6093
|
</details>
|
|
5451
6094
|
|
|
5452
6095
|
## Doc Versions
|
|
5453
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">list</a>(doc_id:) -> CloudPDF::Types::DocVersionsList200Response</code></summary>
|
|
6096
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocVersionsList200Response</code></summary>
|
|
5454
6097
|
<dl>
|
|
5455
6098
|
<dd>
|
|
5456
6099
|
|
|
@@ -5462,7 +6105,7 @@ client.doc.signatures.prepare(
|
|
|
5462
6105
|
<dl>
|
|
5463
6106
|
<dd>
|
|
5464
6107
|
|
|
5465
|
-
Every completed signature
|
|
6108
|
+
Every completed signature makes a new version of its layer; another layer's versions are never listed. Never cached: the list grows.
|
|
5466
6109
|
</dd>
|
|
5467
6110
|
</dl>
|
|
5468
6111
|
</dd>
|
|
@@ -5477,7 +6120,10 @@ Every completed signature publishes a new version. Never cached: the list grows.
|
|
|
5477
6120
|
<dd>
|
|
5478
6121
|
|
|
5479
6122
|
```ruby
|
|
5480
|
-
client.doc.versions.list(
|
|
6123
|
+
client.doc.versions.list(
|
|
6124
|
+
doc_id: "docId",
|
|
6125
|
+
layer_name: "layerName"
|
|
6126
|
+
)
|
|
5481
6127
|
```
|
|
5482
6128
|
</dd>
|
|
5483
6129
|
</dl>
|
|
@@ -5500,6 +6146,14 @@ client.doc.versions.list(doc_id: "docId")
|
|
|
5500
6146
|
<dl>
|
|
5501
6147
|
<dd>
|
|
5502
6148
|
|
|
6149
|
+
**layer_name:** `String`
|
|
6150
|
+
|
|
6151
|
+
</dd>
|
|
6152
|
+
</dl>
|
|
6153
|
+
|
|
6154
|
+
<dl>
|
|
6155
|
+
<dd>
|
|
6156
|
+
|
|
5503
6157
|
**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.
|
|
5504
6158
|
|
|
5505
6159
|
</dd>
|
|
@@ -5520,7 +6174,7 @@ client.doc.versions.list(doc_id: "docId")
|
|
|
5520
6174
|
</dl>
|
|
5521
6175
|
</details>
|
|
5522
6176
|
|
|
5523
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">analysis</a>(doc_id:, sha:) -> CloudPDF::Types::DocVersionsAnalysis200Response</code></summary>
|
|
6177
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">analysis</a>(doc_id:, layer_name:, sha:) -> CloudPDF::Types::DocVersionsAnalysis200Response</code></summary>
|
|
5524
6178
|
<dl>
|
|
5525
6179
|
<dd>
|
|
5526
6180
|
|
|
@@ -5532,7 +6186,7 @@ client.doc.versions.list(doc_id: "docId")
|
|
|
5532
6186
|
<dl>
|
|
5533
6187
|
<dd>
|
|
5534
6188
|
|
|
5535
|
-
Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults to the last. The same answer for every
|
|
6189
|
+
Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults to the last. The same answer for every caller.
|
|
5536
6190
|
</dd>
|
|
5537
6191
|
</dl>
|
|
5538
6192
|
</dd>
|
|
@@ -5549,6 +6203,7 @@ Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults
|
|
|
5549
6203
|
```ruby
|
|
5550
6204
|
client.doc.versions.analysis(
|
|
5551
6205
|
doc_id: "docId",
|
|
6206
|
+
layer_name: "layerName",
|
|
5552
6207
|
sha: "sha"
|
|
5553
6208
|
)
|
|
5554
6209
|
```
|
|
@@ -5573,6 +6228,14 @@ client.doc.versions.analysis(
|
|
|
5573
6228
|
<dl>
|
|
5574
6229
|
<dd>
|
|
5575
6230
|
|
|
6231
|
+
**layer_name:** `String`
|
|
6232
|
+
|
|
6233
|
+
</dd>
|
|
6234
|
+
</dl>
|
|
6235
|
+
|
|
6236
|
+
<dl>
|
|
6237
|
+
<dd>
|
|
6238
|
+
|
|
5576
6239
|
**sha:** `String`
|
|
5577
6240
|
|
|
5578
6241
|
</dd>
|
|
@@ -5641,7 +6304,7 @@ client.doc.versions.analysis(
|
|
|
5641
6304
|
</dl>
|
|
5642
6305
|
</details>
|
|
5643
6306
|
|
|
5644
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">download</a>(doc_id:, sha:) -> String</code></summary>
|
|
6307
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">download</a>(doc_id:, layer_name:, sha:) -> String</code></summary>
|
|
5645
6308
|
<dl>
|
|
5646
6309
|
<dd>
|
|
5647
6310
|
|
|
@@ -5656,6 +6319,7 @@ client.doc.versions.analysis(
|
|
|
5656
6319
|
```ruby
|
|
5657
6320
|
client.doc.versions.download(
|
|
5658
6321
|
doc_id: "docId",
|
|
6322
|
+
layer_name: "layerName",
|
|
5659
6323
|
sha: "sha"
|
|
5660
6324
|
)
|
|
5661
6325
|
```
|
|
@@ -5680,6 +6344,14 @@ client.doc.versions.download(
|
|
|
5680
6344
|
<dl>
|
|
5681
6345
|
<dd>
|
|
5682
6346
|
|
|
6347
|
+
**layer_name:** `String`
|
|
6348
|
+
|
|
6349
|
+
</dd>
|
|
6350
|
+
</dl>
|
|
6351
|
+
|
|
6352
|
+
<dl>
|
|
6353
|
+
<dd>
|
|
6354
|
+
|
|
5683
6355
|
**sha:** `String`
|
|
5684
6356
|
|
|
5685
6357
|
</dd>
|
|
@@ -5708,7 +6380,7 @@ client.doc.versions.download(
|
|
|
5708
6380
|
</dl>
|
|
5709
6381
|
</details>
|
|
5710
6382
|
|
|
5711
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">revision</a>(doc_id:, sha:, index:) -> String</code></summary>
|
|
6383
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">revision</a>(doc_id:, layer_name:, sha:, index:) -> String</code></summary>
|
|
5712
6384
|
<dl>
|
|
5713
6385
|
<dd>
|
|
5714
6386
|
|
|
@@ -5723,6 +6395,7 @@ client.doc.versions.download(
|
|
|
5723
6395
|
```ruby
|
|
5724
6396
|
client.doc.versions.revision(
|
|
5725
6397
|
doc_id: "docId",
|
|
6398
|
+
layer_name: "layerName",
|
|
5726
6399
|
sha: "sha",
|
|
5727
6400
|
index: 1
|
|
5728
6401
|
)
|
|
@@ -5748,6 +6421,14 @@ client.doc.versions.revision(
|
|
|
5748
6421
|
<dl>
|
|
5749
6422
|
<dd>
|
|
5750
6423
|
|
|
6424
|
+
**layer_name:** `String`
|
|
6425
|
+
|
|
6426
|
+
</dd>
|
|
6427
|
+
</dl>
|
|
6428
|
+
|
|
6429
|
+
<dl>
|
|
6430
|
+
<dd>
|
|
6431
|
+
|
|
5751
6432
|
**sha:** `String`
|
|
5752
6433
|
|
|
5753
6434
|
</dd>
|
|
@@ -5784,7 +6465,7 @@ client.doc.versions.revision(
|
|
|
5784
6465
|
</dl>
|
|
5785
6466
|
</details>
|
|
5786
6467
|
|
|
5787
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signatures</a>(doc_id:, sha:) -> CloudPDF::Types::DocVersionsSignatures200Response</code></summary>
|
|
6468
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signatures</a>(doc_id:, layer_name:, sha:) -> CloudPDF::Types::DocVersionsSignatures200Response</code></summary>
|
|
5788
6469
|
<dl>
|
|
5789
6470
|
<dd>
|
|
5790
6471
|
|
|
@@ -5799,6 +6480,7 @@ client.doc.versions.revision(
|
|
|
5799
6480
|
```ruby
|
|
5800
6481
|
client.doc.versions.signatures(
|
|
5801
6482
|
doc_id: "docId",
|
|
6483
|
+
layer_name: "layerName",
|
|
5802
6484
|
sha: "sha"
|
|
5803
6485
|
)
|
|
5804
6486
|
```
|
|
@@ -5823,6 +6505,14 @@ client.doc.versions.signatures(
|
|
|
5823
6505
|
<dl>
|
|
5824
6506
|
<dd>
|
|
5825
6507
|
|
|
6508
|
+
**layer_name:** `String`
|
|
6509
|
+
|
|
6510
|
+
</dd>
|
|
6511
|
+
</dl>
|
|
6512
|
+
|
|
6513
|
+
<dl>
|
|
6514
|
+
<dd>
|
|
6515
|
+
|
|
5826
6516
|
**sha:** `String`
|
|
5827
6517
|
|
|
5828
6518
|
</dd>
|
|
@@ -5851,7 +6541,7 @@ client.doc.versions.signatures(
|
|
|
5851
6541
|
</dl>
|
|
5852
6542
|
</details>
|
|
5853
6543
|
|
|
5854
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_contents</a>(doc_id:, sha:, field_key:) -> String</code></summary>
|
|
6544
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_contents</a>(doc_id:, layer_name:, sha:, field_key:) -> String</code></summary>
|
|
5855
6545
|
<dl>
|
|
5856
6546
|
<dd>
|
|
5857
6547
|
|
|
@@ -5880,6 +6570,7 @@ client.doc.versions.signatures(
|
|
|
5880
6570
|
```ruby
|
|
5881
6571
|
client.doc.versions.signature_contents(
|
|
5882
6572
|
doc_id: "docId",
|
|
6573
|
+
layer_name: "layerName",
|
|
5883
6574
|
sha: "sha",
|
|
5884
6575
|
field_key: "fieldKey"
|
|
5885
6576
|
)
|
|
@@ -5905,6 +6596,14 @@ client.doc.versions.signature_contents(
|
|
|
5905
6596
|
<dl>
|
|
5906
6597
|
<dd>
|
|
5907
6598
|
|
|
6599
|
+
**layer_name:** `String`
|
|
6600
|
+
|
|
6601
|
+
</dd>
|
|
6602
|
+
</dl>
|
|
6603
|
+
|
|
6604
|
+
<dl>
|
|
6605
|
+
<dd>
|
|
6606
|
+
|
|
5908
6607
|
**sha:** `String`
|
|
5909
6608
|
|
|
5910
6609
|
</dd>
|
|
@@ -5941,7 +6640,7 @@ client.doc.versions.signature_contents(
|
|
|
5941
6640
|
</dl>
|
|
5942
6641
|
</details>
|
|
5943
6642
|
|
|
5944
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_digest</a>(doc_id:, sha:, field_key:, algorithm:) -> String</code></summary>
|
|
6643
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_digest</a>(doc_id:, layer_name:, sha:, field_key:, algorithm:) -> String</code></summary>
|
|
5945
6644
|
<dl>
|
|
5946
6645
|
<dd>
|
|
5947
6646
|
|
|
@@ -5970,6 +6669,7 @@ What a CMS verifier compares its message digest to.
|
|
|
5970
6669
|
```ruby
|
|
5971
6670
|
client.doc.versions.signature_digest(
|
|
5972
6671
|
doc_id: "docId",
|
|
6672
|
+
layer_name: "layerName",
|
|
5973
6673
|
sha: "sha",
|
|
5974
6674
|
field_key: "fieldKey",
|
|
5975
6675
|
algorithm: "sha1"
|
|
@@ -5996,6 +6696,14 @@ client.doc.versions.signature_digest(
|
|
|
5996
6696
|
<dl>
|
|
5997
6697
|
<dd>
|
|
5998
6698
|
|
|
6699
|
+
**layer_name:** `String`
|
|
6700
|
+
|
|
6701
|
+
</dd>
|
|
6702
|
+
</dl>
|
|
6703
|
+
|
|
6704
|
+
<dl>
|
|
6705
|
+
<dd>
|
|
6706
|
+
|
|
5999
6707
|
**sha:** `String`
|
|
6000
6708
|
|
|
6001
6709
|
</dd>
|
|
@@ -6172,7 +6880,7 @@ client.documents.layers.list(
|
|
|
6172
6880
|
<dl>
|
|
6173
6881
|
<dd>
|
|
6174
6882
|
|
|
6175
|
-
**
|
|
6883
|
+
**grant_id:** `String`
|
|
6176
6884
|
|
|
6177
6885
|
</dd>
|
|
6178
6886
|
</dl>
|
|
@@ -6260,8 +6968,8 @@ client.documents.layers.delete(
|
|
|
6260
6968
|
</dl>
|
|
6261
6969
|
</details>
|
|
6262
6970
|
|
|
6263
|
-
##
|
|
6264
|
-
<details><summary><code>client.
|
|
6971
|
+
## Grants Visitors
|
|
6972
|
+
<details><summary><code>client.grants.visitors.<a href="/lib/CloudPDF/grants/visitors/client.rb">list</a>(tenant_id:, grant_id:) -> CloudPDF::Types::GrantsVisitorsList200Response</code></summary>
|
|
6265
6973
|
<dl>
|
|
6266
6974
|
<dd>
|
|
6267
6975
|
|
|
@@ -6273,7 +6981,7 @@ client.documents.layers.delete(
|
|
|
6273
6981
|
<dl>
|
|
6274
6982
|
<dd>
|
|
6275
6983
|
|
|
6276
|
-
An archived
|
|
6984
|
+
An archived grant's visitors are listed too.
|
|
6277
6985
|
</dd>
|
|
6278
6986
|
</dl>
|
|
6279
6987
|
</dd>
|
|
@@ -6288,9 +6996,9 @@ An archived link's visitors are listed too.
|
|
|
6288
6996
|
<dd>
|
|
6289
6997
|
|
|
6290
6998
|
```ruby
|
|
6291
|
-
client.
|
|
6999
|
+
client.grants.visitors.list(
|
|
6292
7000
|
tenant_id: "tenantId",
|
|
6293
|
-
|
|
7001
|
+
grant_id: "grantId"
|
|
6294
7002
|
)
|
|
6295
7003
|
```
|
|
6296
7004
|
</dd>
|
|
@@ -6314,7 +7022,7 @@ client.shares.visitors.list(
|
|
|
6314
7022
|
<dl>
|
|
6315
7023
|
<dd>
|
|
6316
7024
|
|
|
6317
|
-
**
|
|
7025
|
+
**grant_id:** `String`
|
|
6318
7026
|
|
|
6319
7027
|
</dd>
|
|
6320
7028
|
</dl>
|
|
@@ -6338,7 +7046,7 @@ client.shares.visitors.list(
|
|
|
6338
7046
|
<dl>
|
|
6339
7047
|
<dd>
|
|
6340
7048
|
|
|
6341
|
-
**request_options:** `CloudPDF::
|
|
7049
|
+
**request_options:** `CloudPDF::Grants::Visitors::RequestOptions`
|
|
6342
7050
|
|
|
6343
7051
|
</dd>
|
|
6344
7052
|
</dl>
|
|
@@ -6350,7 +7058,7 @@ client.shares.visitors.list(
|
|
|
6350
7058
|
</dl>
|
|
6351
7059
|
</details>
|
|
6352
7060
|
|
|
6353
|
-
<details><summary><code>client.
|
|
7061
|
+
<details><summary><code>client.grants.visitors.<a href="/lib/CloudPDF/grants/visitors/client.rb">delete</a>(tenant_id:, grant_id:, visitor_id:) -> </code></summary>
|
|
6354
7062
|
<dl>
|
|
6355
7063
|
<dd>
|
|
6356
7064
|
|
|
@@ -6377,9 +7085,9 @@ Their handle brings them back as a new visitor, who is asked again. Deleting a v
|
|
|
6377
7085
|
<dd>
|
|
6378
7086
|
|
|
6379
7087
|
```ruby
|
|
6380
|
-
client.
|
|
7088
|
+
client.grants.visitors.delete(
|
|
6381
7089
|
tenant_id: "tenantId",
|
|
6382
|
-
|
|
7090
|
+
grant_id: "grantId",
|
|
6383
7091
|
visitor_id: "visitorId"
|
|
6384
7092
|
)
|
|
6385
7093
|
```
|
|
@@ -6404,7 +7112,7 @@ client.shares.visitors.delete(
|
|
|
6404
7112
|
<dl>
|
|
6405
7113
|
<dd>
|
|
6406
7114
|
|
|
6407
|
-
**
|
|
7115
|
+
**grant_id:** `String`
|
|
6408
7116
|
|
|
6409
7117
|
</dd>
|
|
6410
7118
|
</dl>
|
|
@@ -6420,7 +7128,7 @@ client.shares.visitors.delete(
|
|
|
6420
7128
|
<dl>
|
|
6421
7129
|
<dd>
|
|
6422
7130
|
|
|
6423
|
-
**request_options:** `CloudPDF::
|
|
7131
|
+
**request_options:** `CloudPDF::Grants::Visitors::RequestOptions`
|
|
6424
7132
|
|
|
6425
7133
|
</dd>
|
|
6426
7134
|
</dl>
|