cloudpdf 3.0.0.alpha.15 → 3.0.0.alpha.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.fern/metadata.json +2 -2
- data/lib/CloudPDF/doc/annotations/client.rb +48 -0
- data/lib/CloudPDF/doc/{pages/types/delete_pages_request.rb → annotations/types/read_file_annotations_request.rb} +5 -5
- data/lib/CloudPDF/doc/attachments/client.rb +109 -0
- data/lib/CloudPDF/doc/{pages/types/insert_pages_request.rb → attachments/types/download_attachments_request.rb} +4 -4
- data/lib/CloudPDF/doc/{pages/types/rotate_pages_request.rb → attachments/types/list_attachments_request.rb} +2 -6
- data/lib/CloudPDF/doc/client.rb +70 -4
- data/lib/CloudPDF/doc/outline/client.rb +60 -0
- data/lib/CloudPDF/doc/{pages/types/insert_blank_pages_request.rb → outline/types/get_outline_request.rb} +2 -6
- data/lib/CloudPDF/doc/pages/client.rb +6 -274
- data/lib/CloudPDF/doc/types/doc_download_link_request.rb +17 -0
- data/lib/CloudPDF/documents/client.rb +5 -0
- data/lib/CloudPDF/documents/layers/client.rb +103 -0
- data/lib/CloudPDF/documents/layers/types/delete_layers_request.rb +17 -0
- data/lib/CloudPDF/documents/layers/types/list_layers_request.rb +21 -0
- data/lib/CloudPDF/shares/client.rb +56 -1
- data/lib/CloudPDF/shares/types/archive_shares_request.rb +13 -0
- data/lib/CloudPDF/shares/types/list_shares_request.rb +2 -0
- data/lib/CloudPDF/shares/types/shares_create_request.rb +8 -0
- data/lib/CloudPDF/shares/types/shares_create_request_layer_mode.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity.rb +17 -0
- data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_ask.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields.rb +19 -0
- data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_display_name.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_email.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_organization.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_organizational_unit.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_title.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_exchange_request.rb +6 -0
- data/lib/CloudPDF/shares/types/shares_exchange_request_visitor_identity.rb +19 -0
- data/lib/CloudPDF/shares/types/shares_update_request.rb +10 -0
- data/lib/CloudPDF/shares/types/shares_update_request_layer_mode.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity.rb +17 -0
- data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_ask.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields.rb +19 -0
- data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_display_name.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_email.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_organization.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_organizational_unit.rb +14 -0
- data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_title.rb +14 -0
- data/lib/CloudPDF/shares/visitors/client.rb +106 -0
- data/lib/CloudPDF/shares/visitors/types/delete_visitors_request.rb +17 -0
- data/lib/CloudPDF/shares/visitors/types/list_visitors_request.rb +19 -0
- data/lib/CloudPDF/types/admin_error_payload_error.rb +2 -0
- data/lib/CloudPDF/types/annotation_file_attachment.rb +1 -1
- data/lib/CloudPDF/types/attachment.rb +25 -0
- data/lib/CloudPDF/types/attachment_file_base.rb +13 -0
- data/lib/CloudPDF/types/{annotation_file_attachment_file.rb → attachment_file_info.rb} +1 -1
- data/lib/CloudPDF/types/attachment_list.rb +9 -0
- data/lib/CloudPDF/types/attachment_mutation_meta.rb +17 -0
- data/lib/CloudPDF/types/attachment_ref.rb +11 -0
- data/lib/CloudPDF/types/attachment_ref_kind.rb +11 -0
- data/lib/CloudPDF/types/cache_delta.rb +2 -0
- data/lib/CloudPDF/types/change_item.rb +28 -0
- data/lib/CloudPDF/types/change_item_attachments_create.rb +11 -0
- data/lib/CloudPDF/types/change_item_attachments_delete.rb +9 -0
- data/lib/CloudPDF/types/change_item_attachments_restore.rb +11 -0
- data/lib/CloudPDF/types/change_item_outline_create.rb +13 -0
- data/lib/CloudPDF/types/change_item_outline_delete.rb +9 -0
- data/lib/CloudPDF/types/change_item_outline_move.rb +11 -0
- data/lib/CloudPDF/types/change_item_outline_restore.rb +13 -0
- data/lib/CloudPDF/types/change_item_outline_update.rb +13 -0
- data/lib/CloudPDF/types/{doc_pages_reorder200response.rb → change_item_pages_delete.rb} +2 -2
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout.rb → change_item_pages_delete_layout.rb} +3 -3
- data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item.rb +11 -0
- data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item_target.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item_target_dangling.rb +7 -0
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout_named_pages_item_target_page.rb → change_item_pages_delete_layout_named_pages_item_target_page.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout_named_pages_item_target_template.rb → change_item_pages_delete_layout_named_pages_item_target_template.rb} +1 -1
- data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item.rb +27 -0
- data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item_boxes.rb +17 -0
- data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_boxes_art.rb → change_item_pages_delete_layout_pages_item_boxes_art.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_boxes_art.rb → change_item_pages_delete_layout_pages_item_boxes_bleed.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_boxes_art.rb → change_item_pages_delete_layout_pages_item_boxes_crop.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_boxes_trim.rb → change_item_pages_delete_layout_pages_item_boxes_media.rb} +1 -1
- data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item_boxes_trim.rb +15 -0
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_pdf_crop_box.rb → change_item_pages_delete_layout_pages_item_pdf_crop_box.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_size.rb → change_item_pages_delete_layout_pages_item_size.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_tab_order.rb → change_item_pages_delete_layout_pages_item_tab_order.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_insert200response.rb → change_item_pages_insert.rb} +2 -2
- data/lib/CloudPDF/types/{doc_pages_insert_blank200response.rb → change_item_pages_insert_blank.rb} +2 -2
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout.rb → change_item_pages_insert_blank_layout.rb} +3 -3
- data/lib/CloudPDF/types/change_item_pages_insert_blank_layout_named_pages_item.rb +11 -0
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_named_pages_item_target.rb → change_item_pages_insert_blank_layout_named_pages_item_target.rb} +4 -4
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_named_pages_item_target_dangling.rb → change_item_pages_insert_blank_layout_named_pages_item_target_dangling.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_named_pages_item_target_page.rb → change_item_pages_insert_blank_layout_named_pages_item_target_page.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_named_pages_item_target_template.rb → change_item_pages_insert_blank_layout_named_pages_item_target_template.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item.rb → change_item_pages_insert_blank_layout_pages_item.rb} +5 -5
- data/lib/CloudPDF/types/change_item_pages_insert_blank_layout_pages_item_boxes.rb +17 -0
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_boxes_crop.rb → change_item_pages_insert_blank_layout_pages_item_boxes_art.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_boxes_bleed.rb → change_item_pages_insert_blank_layout_pages_item_boxes_bleed.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_boxes_bleed.rb → change_item_pages_insert_blank_layout_pages_item_boxes_crop.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_boxes_media.rb → change_item_pages_insert_blank_layout_pages_item_boxes_media.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_boxes_media.rb → change_item_pages_insert_blank_layout_pages_item_boxes_trim.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_pdf_crop_box.rb → change_item_pages_insert_blank_layout_pages_item_pdf_crop_box.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_size.rb → change_item_pages_insert_blank_layout_pages_item_size.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_tab_order.rb → change_item_pages_insert_blank_layout_pages_item_tab_order.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout.rb → change_item_pages_insert_layout.rb} +3 -3
- data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item.rb +11 -0
- data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item_target.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item_target_dangling.rb +7 -0
- data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_named_pages_item_target_page.rb → change_item_pages_insert_layout_named_pages_item_target_page.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout_named_pages_item_target_template.rb → change_item_pages_insert_layout_named_pages_item_target_template.rb} +1 -1
- data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item.rb +27 -0
- data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_art.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_bleed.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_crop.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_media.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_trim.rb +15 -0
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_pdf_crop_box.rb → change_item_pages_insert_layout_pages_item_pdf_crop_box.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_size.rb → change_item_pages_insert_layout_pages_item_size.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_tab_order.rb → change_item_pages_insert_layout_pages_item_tab_order.rb} +1 -1
- data/lib/CloudPDF/types/change_item_pages_reorder.rb +13 -0
- data/lib/CloudPDF/types/{doc_pages_rotate200response_layout.rb → change_item_pages_reorder_layout.rb} +3 -3
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item.rb +11 -0
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item_target.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item_target_dangling.rb +7 -0
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout_named_pages_item_target_page.rb → change_item_pages_reorder_layout_named_pages_item_target_page.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_named_pages_item_target_template.rb → change_item_pages_reorder_layout_named_pages_item_target_template.rb} +1 -1
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item.rb +27 -0
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_art.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_bleed.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_crop.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_media.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_trim.rb +15 -0
- data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_pdf_crop_box.rb → change_item_pages_reorder_layout_pages_item_pdf_crop_box.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_size.rb → change_item_pages_reorder_layout_pages_item_size.rb} +1 -1
- data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_tab_order.rb → change_item_pages_reorder_layout_pages_item_tab_order.rb} +1 -1
- data/lib/CloudPDF/types/change_item_pages_restore.rb +13 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout.rb +13 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item.rb +11 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_dangling.rb +7 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_page.rb +9 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_template.rb +9 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item.rb +27 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_art.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_bleed.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_crop.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_media.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_trim.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_pdf_crop_box.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_size.rb +11 -0
- data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_tab_order.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_rotate.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout.rb +13 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item.rb +11 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_dangling.rb +7 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_page.rb +9 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_template.rb +9 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item.rb +27 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes.rb +17 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_art.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_bleed.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_crop.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_media.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_trim.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_pdf_crop_box.rb +15 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_size.rb +11 -0
- data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_tab_order.rb +15 -0
- data/lib/CloudPDF/types/change_item_skipped_op.rb +15 -0
- data/lib/CloudPDF/types/change_op.rb +22 -0
- data/lib/CloudPDF/types/change_op_attachments_create.rb +11 -0
- data/lib/CloudPDF/types/change_op_attachments_create_resources.rb +9 -0
- data/lib/CloudPDF/types/change_op_attachments_delete.rb +9 -0
- data/lib/CloudPDF/types/change_op_outline_create.rb +15 -0
- data/lib/CloudPDF/types/change_op_outline_delete.rb +11 -0
- data/lib/CloudPDF/types/change_op_outline_move.rb +13 -0
- data/lib/CloudPDF/types/change_op_outline_update.rb +13 -0
- data/lib/CloudPDF/types/change_op_pages_delete.rb +9 -0
- data/lib/CloudPDF/types/change_op_pages_insert.rb +11 -0
- data/lib/CloudPDF/types/change_op_pages_insert_blank.rb +13 -0
- data/lib/CloudPDF/types/change_op_pages_insert_blank_spec.rb +11 -0
- data/lib/CloudPDF/types/change_op_pages_insert_blank_spec_size.rb +11 -0
- data/lib/CloudPDF/types/change_op_pages_insert_resources.rb +9 -0
- data/lib/CloudPDF/types/change_op_pages_reorder.rb +11 -0
- data/lib/CloudPDF/types/change_op_pages_rotate.rb +11 -0
- data/lib/CloudPDF/types/doc_annotations_read_file400response.rb +23 -0
- data/lib/CloudPDF/types/doc_annotations_read_file404response.rb +23 -0
- data/lib/CloudPDF/types/doc_annotations_read_file413response.rb +23 -0
- data/lib/CloudPDF/types/doc_attachments_download400response.rb +23 -0
- data/lib/CloudPDF/types/doc_attachments_download404response.rb +23 -0
- data/lib/CloudPDF/types/doc_attachments_download413response.rb +23 -0
- data/lib/CloudPDF/types/{doc_pages_insert400response.rb → doc_attachments_list200response.rb} +2 -2
- data/lib/CloudPDF/types/doc_attachments_list404response.rb +23 -0
- data/lib/CloudPDF/types/doc_download_link200response.rb +11 -0
- data/lib/CloudPDF/types/{doc_pages_reorder400response.rb → doc_download_link404response.rb} +2 -2
- data/lib/CloudPDF/types/{doc_pages_reorder404response.rb → doc_download_link501response.rb} +2 -2
- data/lib/CloudPDF/types/doc_manifest200response.rb +2 -0
- data/lib/CloudPDF/types/doc_manifest200response_scopes.rb +2 -0
- data/lib/CloudPDF/types/doc_manifest200response_scopes_outline.rb +12 -0
- data/lib/CloudPDF/types/{doc_pages_insert_blank_request.rb → doc_outline_get200response.rb} +2 -2
- data/lib/CloudPDF/types/doc_outline_get404response.rb +23 -0
- data/lib/CloudPDF/types/document_outline.rb +11 -0
- data/lib/CloudPDF/types/documents_layers_delete403response.rb +23 -0
- data/lib/CloudPDF/types/documents_layers_delete404response.rb +23 -0
- data/lib/CloudPDF/types/documents_layers_delete409response.rb +23 -0
- data/lib/CloudPDF/types/documents_layers_list200response.rb +11 -0
- data/lib/CloudPDF/types/documents_layers_list200response_layers_item.rb +23 -0
- data/lib/CloudPDF/types/documents_layers_list400response.rb +23 -0
- data/lib/CloudPDF/types/documents_layers_list403response.rb +23 -0
- data/lib/CloudPDF/types/documents_layers_list404response.rb +23 -0
- data/lib/CloudPDF/types/engine_error_payload_code.rb +2 -0
- data/lib/CloudPDF/types/outline_item.rb +25 -0
- data/lib/CloudPDF/types/outline_item_draft.rb +17 -0
- data/lib/CloudPDF/types/outline_item_patch.rb +19 -0
- data/lib/CloudPDF/types/{doc_pages_insert_blank200response_layout_named_pages_item_target_template.rb → outline_item_ref.rb} +3 -1
- data/lib/CloudPDF/types/outline_item_ref_kind.rb +11 -0
- data/lib/CloudPDF/types/outline_mutation_meta.rb +17 -0
- data/lib/CloudPDF/types/outline_order.rb +11 -0
- data/lib/CloudPDF/types/outline_position.rb +13 -0
- data/lib/CloudPDF/types/outline_position_after.rb +11 -0
- data/lib/CloudPDF/types/outline_position_zero.rb +12 -0
- data/lib/CloudPDF/types/shares_archive200response.rb +9 -0
- data/lib/CloudPDF/types/shares_archive200response_share.rb +47 -0
- data/lib/CloudPDF/types/shares_archive200response_share_layer_mode.rb +12 -0
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_ask.rb +12 -0
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_display_name.rb +12 -0
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_email.rb +12 -0
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_organization.rb +12 -0
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_organizational_unit.rb +12 -0
- data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_title.rb +12 -0
- data/lib/CloudPDF/types/shares_archive404response.rb +23 -0
- data/lib/CloudPDF/types/shares_create200response_share.rb +11 -1
- data/lib/CloudPDF/types/shares_create200response_share_layer_mode.rb +12 -0
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_ask.rb +12 -0
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_display_name.rb +12 -0
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_email.rb +12 -0
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_organization.rb +12 -0
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_organizational_unit.rb +12 -0
- data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_title.rb +12 -0
- data/lib/CloudPDF/types/{doc_pages_rotate_request.rb → shares_delete404response.rb} +2 -2
- data/lib/CloudPDF/types/{shares_delete_response.rb → shares_delete409response.rb} +2 -2
- data/lib/CloudPDF/types/shares_exchange200response.rb +4 -0
- data/lib/CloudPDF/types/shares_exchange200response_layer_mode.rb +12 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor.rb +13 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request.rb +17 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields.rb +17 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_display_name.rb +12 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_email.rb +12 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_organization.rb +12 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_organizational_unit.rb +12 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_title.rb +12 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_invalid_item.rb +15 -0
- data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_missing_item.rb +15 -0
- data/lib/CloudPDF/types/shares_get200response_share.rb +11 -1
- data/lib/CloudPDF/types/shares_get200response_share_layer_mode.rb +12 -0
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_ask.rb +12 -0
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_display_name.rb +12 -0
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_email.rb +12 -0
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_organization.rb +12 -0
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_organizational_unit.rb +12 -0
- data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_title.rb +12 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item.rb +11 -1
- data/lib/CloudPDF/types/shares_list200response_shares_item_layer_mode.rb +12 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_ask.rb +12 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_display_name.rb +12 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_email.rb +12 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_organization.rb +12 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_organizational_unit.rb +12 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_title.rb +12 -0
- data/lib/CloudPDF/types/shares_update200response_share.rb +11 -1
- data/lib/CloudPDF/types/shares_update200response_share_layer_mode.rb +12 -0
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity.rb +15 -0
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_ask.rb +12 -0
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields.rb +17 -0
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_display_name.rb +12 -0
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_email.rb +12 -0
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_organization.rb +12 -0
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_organizational_unit.rb +12 -0
- data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_title.rb +12 -0
- data/lib/CloudPDF/types/{doc_pages_delete_request.rb → shares_update409response.rb} +2 -2
- data/lib/CloudPDF/types/{doc_pages_delete400response.rb → shares_visitors_delete_response.rb} +2 -2
- data/lib/CloudPDF/types/shares_visitors_list200response.rb +11 -0
- data/lib/CloudPDF/types/shares_visitors_list200response_visitors_item.rb +21 -0
- data/lib/CloudPDF/types/shares_visitors_list200response_visitors_item_answers.rb +17 -0
- data/lib/CloudPDF/types/shares_visitors_list200response_visitors_item_layer.rb +11 -0
- data/lib/CloudPDF/types/{doc_pages_delete404response.rb → shares_visitors_list400response.rb} +2 -2
- data/lib/CloudPDF/types/shares_visitors_list404response.rb +23 -0
- data/lib/CloudPDF/version.rb +1 -1
- data/lib/cloudpdf.rb +270 -108
- data/reference.md +853 -381
- metadata +269 -107
- data/lib/CloudPDF/doc/pages/types/doc_pages_reorder_request.rb +0 -23
- data/lib/CloudPDF/types/doc_pages_delete200response.rb +0 -11
- data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item.rb +0 -11
- data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item_target.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item_target_dangling.rb +0 -7
- data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item.rb +0 -27
- data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes_bleed.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes_media.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item.rb +0 -11
- data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item_target.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item_target_dangling.rb +0 -7
- data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item.rb +0 -27
- data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes_crop.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes_trim.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert404response.rb +0 -23
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout.rb +0 -13
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item.rb +0 -11
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target_dangling.rb +0 -7
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target_page.rb +0 -9
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item.rb +0 -27
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_art.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_bleed.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_crop.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_media.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_trim.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_pdf_crop_box.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_size.rb +0 -11
- data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_tab_order.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_insert_blank400response.rb +0 -23
- data/lib/CloudPDF/types/doc_pages_insert_blank404response.rb +0 -23
- data/lib/CloudPDF/types/doc_pages_reorder200response_layout_named_pages_item.rb +0 -11
- data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_art.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_crop.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_trim.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_rotate200response.rb +0 -11
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item.rb +0 -11
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item_target.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item_target_dangling.rb +0 -7
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item.rb +0 -27
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes.rb +0 -17
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_bleed.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_crop.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_media.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_trim.rb +0 -15
- data/lib/CloudPDF/types/doc_pages_rotate400response.rb +0 -23
- data/lib/CloudPDF/types/doc_pages_rotate404response.rb +0 -23
data/reference.md
CHANGED
|
@@ -109,7 +109,7 @@ client.doc.head(doc_id: "docId")
|
|
|
109
109
|
<dl>
|
|
110
110
|
<dd>
|
|
111
111
|
|
|
112
|
-
Each change stands on its own and names itself by `opId`: a refused change rolls back alone, and the answer lists every change in order, applied with its result or refused with its error. Asked again under its `opId`, a change gets the same answer, refusals included; a different change under an answered `opId` is refused (IdempotencyKeyReused). `{ opId, undoOf }` undoes an earlier change of the caller, here or in an earlier request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form structure `doc.forms.modify`, metadata `doc.metadata.modify`. Bytes (a stamp's drawing, an attached file, a signature's artwork) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
|
|
112
|
+
Each change stands on its own and names itself by `opId`: a refused change rolls back alone, and the answer lists every change in order, applied with its result or refused with its error. Asked again under its `opId`, a change gets the same answer, refusals included; a different change under an answered `opId` is refused (IdempotencyKeyReused). `{ opId, undoOf }` undoes an earlier change of the caller, here or in an earlier request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form structure `doc.forms.modify`, metadata `doc.metadata.modify`, outline `doc.outline.modify`, pages `doc.pages.assemble`, embedded files `doc.attachments.modify`. Bytes (a stamp's drawing, an attached file, a signature's artwork, a PDF whose pages come in) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
|
|
113
113
|
</dd>
|
|
114
114
|
</dl>
|
|
115
115
|
</dd>
|
|
@@ -252,6 +252,95 @@ client.doc.download(
|
|
|
252
252
|
</dl>
|
|
253
253
|
|
|
254
254
|
|
|
255
|
+
</dd>
|
|
256
|
+
</dl>
|
|
257
|
+
</details>
|
|
258
|
+
|
|
259
|
+
<details><summary><code>client.doc.<a href="/lib/CloudPDF/doc/client.rb">download_link</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocDownloadLink200Response</code></summary>
|
|
260
|
+
<dl>
|
|
261
|
+
<dd>
|
|
262
|
+
|
|
263
|
+
#### 📝 Description
|
|
264
|
+
|
|
265
|
+
<dl>
|
|
266
|
+
<dd>
|
|
267
|
+
|
|
268
|
+
<dl>
|
|
269
|
+
<dd>
|
|
270
|
+
|
|
271
|
+
The link opens the layer as it is when created: once the layer changes, it answers 404, so create it right before handing it over. It downloads that one file and nothing else, and a password-protected document is checked when the link is created. Deployments that verify tokens with their own keys (JWKS) mint links on their backend: a doc token with `layer_name`, a `download: { docVersion, mode: "incremental" }` claim and a short `exp`, passed as `link` on the versioned download URL.
|
|
272
|
+
</dd>
|
|
273
|
+
</dl>
|
|
274
|
+
</dd>
|
|
275
|
+
</dl>
|
|
276
|
+
|
|
277
|
+
#### 🔌 Usage
|
|
278
|
+
|
|
279
|
+
<dl>
|
|
280
|
+
<dd>
|
|
281
|
+
|
|
282
|
+
<dl>
|
|
283
|
+
<dd>
|
|
284
|
+
|
|
285
|
+
```ruby
|
|
286
|
+
client.doc.download_link(
|
|
287
|
+
doc_id: "docId",
|
|
288
|
+
layer_name: "layerName"
|
|
289
|
+
)
|
|
290
|
+
```
|
|
291
|
+
</dd>
|
|
292
|
+
</dl>
|
|
293
|
+
</dd>
|
|
294
|
+
</dl>
|
|
295
|
+
|
|
296
|
+
#### ⚙️ Parameters
|
|
297
|
+
|
|
298
|
+
<dl>
|
|
299
|
+
<dd>
|
|
300
|
+
|
|
301
|
+
<dl>
|
|
302
|
+
<dd>
|
|
303
|
+
|
|
304
|
+
**doc_id:** `String`
|
|
305
|
+
|
|
306
|
+
</dd>
|
|
307
|
+
</dl>
|
|
308
|
+
|
|
309
|
+
<dl>
|
|
310
|
+
<dd>
|
|
311
|
+
|
|
312
|
+
**layer_name:** `String`
|
|
313
|
+
|
|
314
|
+
</dd>
|
|
315
|
+
</dl>
|
|
316
|
+
|
|
317
|
+
<dl>
|
|
318
|
+
<dd>
|
|
319
|
+
|
|
320
|
+
**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.
|
|
321
|
+
|
|
322
|
+
</dd>
|
|
323
|
+
</dl>
|
|
324
|
+
|
|
325
|
+
<dl>
|
|
326
|
+
<dd>
|
|
327
|
+
|
|
328
|
+
**expires_in:** `Integer`
|
|
329
|
+
|
|
330
|
+
</dd>
|
|
331
|
+
</dl>
|
|
332
|
+
|
|
333
|
+
<dl>
|
|
334
|
+
<dd>
|
|
335
|
+
|
|
336
|
+
**request_options:** `CloudPDF::Doc::RequestOptions`
|
|
337
|
+
|
|
338
|
+
</dd>
|
|
339
|
+
</dl>
|
|
340
|
+
</dd>
|
|
341
|
+
</dl>
|
|
342
|
+
|
|
343
|
+
|
|
255
344
|
</dd>
|
|
256
345
|
</dl>
|
|
257
346
|
</details>
|
|
@@ -502,7 +591,7 @@ client.doc.text(
|
|
|
502
591
|
<dl>
|
|
503
592
|
<dd>
|
|
504
593
|
|
|
505
|
-
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).
|
|
594
|
+
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. A link that asks its visitors who they are on open returns 422 VisitorIdentityRequired until the required answers are given; `error.details` carries `fields` (what the link asks), `missing`, `invalid`, `purpose` and `privacyUrl`. A link 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 link. Mounted only when the deployment can sign (HS256 mode).
|
|
506
595
|
</dd>
|
|
507
596
|
</dl>
|
|
508
597
|
</dd>
|
|
@@ -548,6 +637,30 @@ client.shares.exchange(share_token: "shareToken")
|
|
|
548
637
|
<dl>
|
|
549
638
|
<dd>
|
|
550
639
|
|
|
640
|
+
**visitor_handle:** `String`
|
|
641
|
+
|
|
642
|
+
</dd>
|
|
643
|
+
</dl>
|
|
644
|
+
|
|
645
|
+
<dl>
|
|
646
|
+
<dd>
|
|
647
|
+
|
|
648
|
+
**restart:** `Internal::Types::Boolean`
|
|
649
|
+
|
|
650
|
+
</dd>
|
|
651
|
+
</dl>
|
|
652
|
+
|
|
653
|
+
<dl>
|
|
654
|
+
<dd>
|
|
655
|
+
|
|
656
|
+
**visitor_identity:** `CloudPDF::Shares::Types::SharesExchangeRequestVisitorIdentity`
|
|
657
|
+
|
|
658
|
+
</dd>
|
|
659
|
+
</dl>
|
|
660
|
+
|
|
661
|
+
<dl>
|
|
662
|
+
<dd>
|
|
663
|
+
|
|
551
664
|
**request_options:** `CloudPDF::Shares::RequestOptions`
|
|
552
665
|
|
|
553
666
|
</dd>
|
|
@@ -620,6 +733,14 @@ client.shares.list(tenant_id: "tenantId")
|
|
|
620
733
|
<dl>
|
|
621
734
|
<dd>
|
|
622
735
|
|
|
736
|
+
**archived:** `Internal::Types::Boolean`
|
|
737
|
+
|
|
738
|
+
</dd>
|
|
739
|
+
</dl>
|
|
740
|
+
|
|
741
|
+
<dl>
|
|
742
|
+
<dd>
|
|
743
|
+
|
|
623
744
|
**request_options:** `CloudPDF::Shares::RequestOptions`
|
|
624
745
|
|
|
625
746
|
</dd>
|
|
@@ -694,6 +815,14 @@ client.shares.create(
|
|
|
694
815
|
<dl>
|
|
695
816
|
<dd>
|
|
696
817
|
|
|
818
|
+
**layer_mode:** `CloudPDF::Shares::Types::SharesCreateRequestLayerMode`
|
|
819
|
+
|
|
820
|
+
</dd>
|
|
821
|
+
</dl>
|
|
822
|
+
|
|
823
|
+
<dl>
|
|
824
|
+
<dd>
|
|
825
|
+
|
|
697
826
|
**layer_name:** `String`
|
|
698
827
|
|
|
699
828
|
</dd>
|
|
@@ -702,6 +831,30 @@ client.shares.create(
|
|
|
702
831
|
<dl>
|
|
703
832
|
<dd>
|
|
704
833
|
|
|
834
|
+
**keep_visitor_layers:** `Internal::Types::Boolean`
|
|
835
|
+
|
|
836
|
+
</dd>
|
|
837
|
+
</dl>
|
|
838
|
+
|
|
839
|
+
<dl>
|
|
840
|
+
<dd>
|
|
841
|
+
|
|
842
|
+
**visitor_idle_seconds:** `Integer`
|
|
843
|
+
|
|
844
|
+
</dd>
|
|
845
|
+
</dl>
|
|
846
|
+
|
|
847
|
+
<dl>
|
|
848
|
+
<dd>
|
|
849
|
+
|
|
850
|
+
**visitor_identity:** `CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentity`
|
|
851
|
+
|
|
852
|
+
</dd>
|
|
853
|
+
</dl>
|
|
854
|
+
|
|
855
|
+
<dl>
|
|
856
|
+
<dd>
|
|
857
|
+
|
|
705
858
|
**scope:** `Internal::Types::Array[String]`
|
|
706
859
|
|
|
707
860
|
</dd>
|
|
@@ -919,6 +1072,46 @@ client.shares.update(
|
|
|
919
1072
|
<dl>
|
|
920
1073
|
<dd>
|
|
921
1074
|
|
|
1075
|
+
**layer_mode:** `CloudPDF::Shares::Types::SharesUpdateRequestLayerMode`
|
|
1076
|
+
|
|
1077
|
+
</dd>
|
|
1078
|
+
</dl>
|
|
1079
|
+
|
|
1080
|
+
<dl>
|
|
1081
|
+
<dd>
|
|
1082
|
+
|
|
1083
|
+
**layer_name:** `String`
|
|
1084
|
+
|
|
1085
|
+
</dd>
|
|
1086
|
+
</dl>
|
|
1087
|
+
|
|
1088
|
+
<dl>
|
|
1089
|
+
<dd>
|
|
1090
|
+
|
|
1091
|
+
**keep_visitor_layers:** `Internal::Types::Boolean`
|
|
1092
|
+
|
|
1093
|
+
</dd>
|
|
1094
|
+
</dl>
|
|
1095
|
+
|
|
1096
|
+
<dl>
|
|
1097
|
+
<dd>
|
|
1098
|
+
|
|
1099
|
+
**visitor_idle_seconds:** `Integer`
|
|
1100
|
+
|
|
1101
|
+
</dd>
|
|
1102
|
+
</dl>
|
|
1103
|
+
|
|
1104
|
+
<dl>
|
|
1105
|
+
<dd>
|
|
1106
|
+
|
|
1107
|
+
**visitor_identity:** `CloudPDF::Shares::Types::SharesUpdateRequestVisitorIdentity`
|
|
1108
|
+
|
|
1109
|
+
</dd>
|
|
1110
|
+
</dl>
|
|
1111
|
+
|
|
1112
|
+
<dl>
|
|
1113
|
+
<dd>
|
|
1114
|
+
|
|
922
1115
|
**scope:** `Internal::Types::Array[String]`
|
|
923
1116
|
|
|
924
1117
|
</dd>
|
|
@@ -975,6 +1168,79 @@ client.shares.update(
|
|
|
975
1168
|
</dl>
|
|
976
1169
|
|
|
977
1170
|
|
|
1171
|
+
</dd>
|
|
1172
|
+
</dl>
|
|
1173
|
+
</details>
|
|
1174
|
+
|
|
1175
|
+
<details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">archive</a>(tenant_id:, share_id:) -> CloudPDF::Types::SharesArchive200Response</code></summary>
|
|
1176
|
+
<dl>
|
|
1177
|
+
<dd>
|
|
1178
|
+
|
|
1179
|
+
#### 📝 Description
|
|
1180
|
+
|
|
1181
|
+
<dl>
|
|
1182
|
+
<dd>
|
|
1183
|
+
|
|
1184
|
+
<dl>
|
|
1185
|
+
<dd>
|
|
1186
|
+
|
|
1187
|
+
Archiving is final: an archived link never exchanges again, and to share again you create a new link. Pausing (`disabled`) is the reversible stop. An archived link no longer counts as using its shared layer, so that layer can be deleted.
|
|
1188
|
+
</dd>
|
|
1189
|
+
</dl>
|
|
1190
|
+
</dd>
|
|
1191
|
+
</dl>
|
|
1192
|
+
|
|
1193
|
+
#### 🔌 Usage
|
|
1194
|
+
|
|
1195
|
+
<dl>
|
|
1196
|
+
<dd>
|
|
1197
|
+
|
|
1198
|
+
<dl>
|
|
1199
|
+
<dd>
|
|
1200
|
+
|
|
1201
|
+
```ruby
|
|
1202
|
+
client.shares.archive(
|
|
1203
|
+
tenant_id: "tenantId",
|
|
1204
|
+
share_id: "shareId"
|
|
1205
|
+
)
|
|
1206
|
+
```
|
|
1207
|
+
</dd>
|
|
1208
|
+
</dl>
|
|
1209
|
+
</dd>
|
|
1210
|
+
</dl>
|
|
1211
|
+
|
|
1212
|
+
#### ⚙️ Parameters
|
|
1213
|
+
|
|
1214
|
+
<dl>
|
|
1215
|
+
<dd>
|
|
1216
|
+
|
|
1217
|
+
<dl>
|
|
1218
|
+
<dd>
|
|
1219
|
+
|
|
1220
|
+
**tenant_id:** `String`
|
|
1221
|
+
|
|
1222
|
+
</dd>
|
|
1223
|
+
</dl>
|
|
1224
|
+
|
|
1225
|
+
<dl>
|
|
1226
|
+
<dd>
|
|
1227
|
+
|
|
1228
|
+
**share_id:** `String`
|
|
1229
|
+
|
|
1230
|
+
</dd>
|
|
1231
|
+
</dl>
|
|
1232
|
+
|
|
1233
|
+
<dl>
|
|
1234
|
+
<dd>
|
|
1235
|
+
|
|
1236
|
+
**request_options:** `CloudPDF::Shares::RequestOptions`
|
|
1237
|
+
|
|
1238
|
+
</dd>
|
|
1239
|
+
</dl>
|
|
1240
|
+
</dd>
|
|
1241
|
+
</dl>
|
|
1242
|
+
|
|
1243
|
+
|
|
978
1244
|
</dd>
|
|
979
1245
|
</dl>
|
|
980
1246
|
</details>
|
|
@@ -2786,11 +3052,11 @@ client.doc.annotations.read_appearance(
|
|
|
2786
3052
|
</dl>
|
|
2787
3053
|
</details>
|
|
2788
3054
|
|
|
2789
|
-
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">
|
|
3055
|
+
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">read_file</a>(doc_id:, layer_name:, page_key:, annot_key:) -> String</code></summary>
|
|
2790
3056
|
<dl>
|
|
2791
3057
|
<dd>
|
|
2792
3058
|
|
|
2793
|
-
####
|
|
3059
|
+
#### 📝 Description
|
|
2794
3060
|
|
|
2795
3061
|
<dl>
|
|
2796
3062
|
<dd>
|
|
@@ -2798,16 +3064,26 @@ client.doc.annotations.read_appearance(
|
|
|
2798
3064
|
<dl>
|
|
2799
3065
|
<dd>
|
|
2800
3066
|
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
3067
|
+
A file that decodes past the server's limit is refused (PayloadTooLarge).
|
|
3068
|
+
</dd>
|
|
3069
|
+
</dl>
|
|
3070
|
+
</dd>
|
|
3071
|
+
</dl>
|
|
3072
|
+
|
|
3073
|
+
#### 🔌 Usage
|
|
3074
|
+
|
|
3075
|
+
<dl>
|
|
3076
|
+
<dd>
|
|
3077
|
+
|
|
3078
|
+
<dl>
|
|
3079
|
+
<dd>
|
|
3080
|
+
|
|
3081
|
+
```ruby
|
|
3082
|
+
client.doc.annotations.read_file(
|
|
3083
|
+
doc_id: "docId",
|
|
3084
|
+
layer_name: "layerName",
|
|
3085
|
+
page_key: "pageKey",
|
|
3086
|
+
annot_key: "annotKey"
|
|
2811
3087
|
)
|
|
2812
3088
|
```
|
|
2813
3089
|
</dd>
|
|
@@ -2847,7 +3123,7 @@ client.doc.annotations.export_appearance(
|
|
|
2847
3123
|
<dl>
|
|
2848
3124
|
<dd>
|
|
2849
3125
|
|
|
2850
|
-
**
|
|
3126
|
+
**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
|
|
2851
3127
|
|
|
2852
3128
|
</dd>
|
|
2853
3129
|
</dl>
|
|
@@ -2855,7 +3131,7 @@ client.doc.annotations.export_appearance(
|
|
|
2855
3131
|
<dl>
|
|
2856
3132
|
<dd>
|
|
2857
3133
|
|
|
2858
|
-
**
|
|
3134
|
+
**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.
|
|
2859
3135
|
|
|
2860
3136
|
</dd>
|
|
2861
3137
|
</dl>
|
|
@@ -2875,7 +3151,7 @@ client.doc.annotations.export_appearance(
|
|
|
2875
3151
|
</dl>
|
|
2876
3152
|
</details>
|
|
2877
3153
|
|
|
2878
|
-
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">
|
|
3154
|
+
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">export_appearance</a>(doc_id:, layer_name:, page_key:, request) -> String</code></summary>
|
|
2879
3155
|
<dl>
|
|
2880
3156
|
<dd>
|
|
2881
3157
|
|
|
@@ -2888,12 +3164,14 @@ client.doc.annotations.export_appearance(
|
|
|
2888
3164
|
<dd>
|
|
2889
3165
|
|
|
2890
3166
|
```ruby
|
|
2891
|
-
client.doc.annotations.
|
|
3167
|
+
client.doc.annotations.export_appearance(
|
|
2892
3168
|
doc_id: "docId",
|
|
2893
3169
|
layer_name: "layerName",
|
|
2894
3170
|
page_key: "pageKey",
|
|
2895
3171
|
request: {
|
|
2896
|
-
|
|
3172
|
+
string: {
|
|
3173
|
+
key: "value"
|
|
3174
|
+
}
|
|
2897
3175
|
}
|
|
2898
3176
|
)
|
|
2899
3177
|
```
|
|
@@ -2942,14 +3220,6 @@ client.doc.annotations.flatten(
|
|
|
2942
3220
|
<dl>
|
|
2943
3221
|
<dd>
|
|
2944
3222
|
|
|
2945
|
-
**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
|
|
2946
|
-
|
|
2947
|
-
</dd>
|
|
2948
|
-
</dl>
|
|
2949
|
-
|
|
2950
|
-
<dl>
|
|
2951
|
-
<dd>
|
|
2952
|
-
|
|
2953
3223
|
**request:** `Internal::Types::Hash[String, Object]`
|
|
2954
3224
|
|
|
2955
3225
|
</dd>
|
|
@@ -2970,7 +3240,7 @@ client.doc.annotations.flatten(
|
|
|
2970
3240
|
</dl>
|
|
2971
3241
|
</details>
|
|
2972
3242
|
|
|
2973
|
-
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">
|
|
3243
|
+
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">flatten</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsFlatten200Response</code></summary>
|
|
2974
3244
|
<dl>
|
|
2975
3245
|
<dd>
|
|
2976
3246
|
|
|
@@ -2983,12 +3253,13 @@ client.doc.annotations.flatten(
|
|
|
2983
3253
|
<dd>
|
|
2984
3254
|
|
|
2985
3255
|
```ruby
|
|
2986
|
-
client.doc.annotations.
|
|
3256
|
+
client.doc.annotations.flatten(
|
|
2987
3257
|
doc_id: "docId",
|
|
2988
3258
|
layer_name: "layerName",
|
|
2989
3259
|
page_key: "pageKey",
|
|
2990
|
-
|
|
2991
|
-
|
|
3260
|
+
request: {
|
|
3261
|
+
key: "value"
|
|
3262
|
+
}
|
|
2992
3263
|
)
|
|
2993
3264
|
```
|
|
2994
3265
|
</dd>
|
|
@@ -3044,15 +3315,7 @@ client.doc.annotations.reorder(
|
|
|
3044
3315
|
<dl>
|
|
3045
3316
|
<dd>
|
|
3046
3317
|
|
|
3047
|
-
**
|
|
3048
|
-
|
|
3049
|
-
</dd>
|
|
3050
|
-
</dl>
|
|
3051
|
-
|
|
3052
|
-
<dl>
|
|
3053
|
-
<dd>
|
|
3054
|
-
|
|
3055
|
-
**position:** `CloudPDF::Types::AnnotationPosition`
|
|
3318
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
3056
3319
|
|
|
3057
3320
|
</dd>
|
|
3058
3321
|
</dl>
|
|
@@ -3072,8 +3335,7 @@ client.doc.annotations.reorder(
|
|
|
3072
3335
|
</dl>
|
|
3073
3336
|
</details>
|
|
3074
3337
|
|
|
3075
|
-
|
|
3076
|
-
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocFormsList200Response</code></summary>
|
|
3338
|
+
<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">reorder</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsReorder200Response</code></summary>
|
|
3077
3339
|
<dl>
|
|
3078
3340
|
<dd>
|
|
3079
3341
|
|
|
@@ -3086,9 +3348,12 @@ client.doc.annotations.reorder(
|
|
|
3086
3348
|
<dd>
|
|
3087
3349
|
|
|
3088
3350
|
```ruby
|
|
3089
|
-
client.doc.
|
|
3351
|
+
client.doc.annotations.reorder(
|
|
3090
3352
|
doc_id: "docId",
|
|
3091
|
-
layer_name: "layerName"
|
|
3353
|
+
layer_name: "layerName",
|
|
3354
|
+
page_key: "pageKey",
|
|
3355
|
+
refs: [],
|
|
3356
|
+
position: "start"
|
|
3092
3357
|
)
|
|
3093
3358
|
```
|
|
3094
3359
|
</dd>
|
|
@@ -3120,6 +3385,14 @@ client.doc.forms.list(
|
|
|
3120
3385
|
<dl>
|
|
3121
3386
|
<dd>
|
|
3122
3387
|
|
|
3388
|
+
**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
|
|
3389
|
+
|
|
3390
|
+
</dd>
|
|
3391
|
+
</dl>
|
|
3392
|
+
|
|
3393
|
+
<dl>
|
|
3394
|
+
<dd>
|
|
3395
|
+
|
|
3123
3396
|
**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.
|
|
3124
3397
|
|
|
3125
3398
|
</dd>
|
|
@@ -3128,7 +3401,31 @@ client.doc.forms.list(
|
|
|
3128
3401
|
<dl>
|
|
3129
3402
|
<dd>
|
|
3130
3403
|
|
|
3131
|
-
**
|
|
3404
|
+
**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
|
|
3405
|
+
|
|
3406
|
+
</dd>
|
|
3407
|
+
</dl>
|
|
3408
|
+
|
|
3409
|
+
<dl>
|
|
3410
|
+
<dd>
|
|
3411
|
+
|
|
3412
|
+
**refs:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]`
|
|
3413
|
+
|
|
3414
|
+
</dd>
|
|
3415
|
+
</dl>
|
|
3416
|
+
|
|
3417
|
+
<dl>
|
|
3418
|
+
<dd>
|
|
3419
|
+
|
|
3420
|
+
**position:** `CloudPDF::Types::AnnotationPosition`
|
|
3421
|
+
|
|
3422
|
+
</dd>
|
|
3423
|
+
</dl>
|
|
3424
|
+
|
|
3425
|
+
<dl>
|
|
3426
|
+
<dd>
|
|
3427
|
+
|
|
3428
|
+
**request_options:** `CloudPDF::Doc::Annotations::RequestOptions`
|
|
3132
3429
|
|
|
3133
3430
|
</dd>
|
|
3134
3431
|
</dl>
|
|
@@ -3140,11 +3437,12 @@ client.doc.forms.list(
|
|
|
3140
3437
|
</dl>
|
|
3141
3438
|
</details>
|
|
3142
3439
|
|
|
3143
|
-
|
|
3440
|
+
## Doc Attachments
|
|
3441
|
+
<details><summary><code>client.doc.attachments.<a href="/lib/CloudPDF/doc/attachments/client.rb">download</a>(doc_id:, layer_name:, file_key:) -> String</code></summary>
|
|
3144
3442
|
<dl>
|
|
3145
3443
|
<dd>
|
|
3146
3444
|
|
|
3147
|
-
####
|
|
3445
|
+
#### 📝 Description
|
|
3148
3446
|
|
|
3149
3447
|
<dl>
|
|
3150
3448
|
<dd>
|
|
@@ -3152,20 +3450,13 @@ client.doc.forms.list(
|
|
|
3152
3450
|
<dl>
|
|
3153
3451
|
<dd>
|
|
3154
3452
|
|
|
3155
|
-
|
|
3156
|
-
client.doc.forms.reorder_calculations(
|
|
3157
|
-
doc_id: "docId",
|
|
3158
|
-
layer_name: "layerName",
|
|
3159
|
-
fields: [],
|
|
3160
|
-
position: "start"
|
|
3161
|
-
)
|
|
3162
|
-
```
|
|
3453
|
+
A file that decodes past the server's limit is refused (PayloadTooLarge).
|
|
3163
3454
|
</dd>
|
|
3164
3455
|
</dl>
|
|
3165
3456
|
</dd>
|
|
3166
3457
|
</dl>
|
|
3167
3458
|
|
|
3168
|
-
####
|
|
3459
|
+
#### 🔌 Usage
|
|
3169
3460
|
|
|
3170
3461
|
<dl>
|
|
3171
3462
|
<dd>
|
|
@@ -3173,23 +3464,27 @@ client.doc.forms.reorder_calculations(
|
|
|
3173
3464
|
<dl>
|
|
3174
3465
|
<dd>
|
|
3175
3466
|
|
|
3176
|
-
|
|
3177
|
-
|
|
3467
|
+
```ruby
|
|
3468
|
+
client.doc.attachments.download(
|
|
3469
|
+
doc_id: "docId",
|
|
3470
|
+
layer_name: "layerName",
|
|
3471
|
+
file_key: "fileKey"
|
|
3472
|
+
)
|
|
3473
|
+
```
|
|
3474
|
+
</dd>
|
|
3475
|
+
</dl>
|
|
3178
3476
|
</dd>
|
|
3179
3477
|
</dl>
|
|
3180
3478
|
|
|
3479
|
+
#### ⚙️ Parameters
|
|
3480
|
+
|
|
3181
3481
|
<dl>
|
|
3182
3482
|
<dd>
|
|
3183
3483
|
|
|
3184
|
-
**layer_name:** `String`
|
|
3185
|
-
|
|
3186
|
-
</dd>
|
|
3187
|
-
</dl>
|
|
3188
|
-
|
|
3189
3484
|
<dl>
|
|
3190
3485
|
<dd>
|
|
3191
3486
|
|
|
3192
|
-
**
|
|
3487
|
+
**doc_id:** `String`
|
|
3193
3488
|
|
|
3194
3489
|
</dd>
|
|
3195
3490
|
</dl>
|
|
@@ -3197,7 +3492,7 @@ client.doc.forms.reorder_calculations(
|
|
|
3197
3492
|
<dl>
|
|
3198
3493
|
<dd>
|
|
3199
3494
|
|
|
3200
|
-
**
|
|
3495
|
+
**layer_name:** `String`
|
|
3201
3496
|
|
|
3202
3497
|
</dd>
|
|
3203
3498
|
</dl>
|
|
@@ -3205,7 +3500,7 @@ client.doc.forms.reorder_calculations(
|
|
|
3205
3500
|
<dl>
|
|
3206
3501
|
<dd>
|
|
3207
3502
|
|
|
3208
|
-
**
|
|
3503
|
+
**file_key:** `String` — The embedded file's name-tree key (its `ref.key`), token-text encoded, as `fieldKey` is.
|
|
3209
3504
|
|
|
3210
3505
|
</dd>
|
|
3211
3506
|
</dl>
|
|
@@ -3213,7 +3508,7 @@ client.doc.forms.reorder_calculations(
|
|
|
3213
3508
|
<dl>
|
|
3214
3509
|
<dd>
|
|
3215
3510
|
|
|
3216
|
-
**
|
|
3511
|
+
**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.
|
|
3217
3512
|
|
|
3218
3513
|
</dd>
|
|
3219
3514
|
</dl>
|
|
@@ -3221,7 +3516,7 @@ client.doc.forms.reorder_calculations(
|
|
|
3221
3516
|
<dl>
|
|
3222
3517
|
<dd>
|
|
3223
3518
|
|
|
3224
|
-
**request_options:** `CloudPDF::Doc::
|
|
3519
|
+
**request_options:** `CloudPDF::Doc::Attachments::RequestOptions`
|
|
3225
3520
|
|
|
3226
3521
|
</dd>
|
|
3227
3522
|
</dl>
|
|
@@ -3233,11 +3528,11 @@ client.doc.forms.reorder_calculations(
|
|
|
3233
3528
|
</dl>
|
|
3234
3529
|
</details>
|
|
3235
3530
|
|
|
3236
|
-
<details><summary><code>client.doc.
|
|
3531
|
+
<details><summary><code>client.doc.attachments.<a href="/lib/CloudPDF/doc/attachments/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::AttachmentList</code></summary>
|
|
3237
3532
|
<dl>
|
|
3238
3533
|
<dd>
|
|
3239
3534
|
|
|
3240
|
-
####
|
|
3535
|
+
#### 📝 Description
|
|
3241
3536
|
|
|
3242
3537
|
<dl>
|
|
3243
3538
|
<dd>
|
|
@@ -3245,22 +3540,13 @@ client.doc.forms.reorder_calculations(
|
|
|
3245
3540
|
<dl>
|
|
3246
3541
|
<dd>
|
|
3247
3542
|
|
|
3248
|
-
|
|
3249
|
-
client.doc.forms.set_value(
|
|
3250
|
-
doc_id: "docId",
|
|
3251
|
-
layer_name: "layerName",
|
|
3252
|
-
field_key: "fieldKey",
|
|
3253
|
-
request: {
|
|
3254
|
-
key: "value"
|
|
3255
|
-
}
|
|
3256
|
-
)
|
|
3257
|
-
```
|
|
3543
|
+
A file-attachment annotation's file is listed with the annotation; read its bytes with `doc.annotations.readFile`.
|
|
3258
3544
|
</dd>
|
|
3259
3545
|
</dl>
|
|
3260
3546
|
</dd>
|
|
3261
3547
|
</dl>
|
|
3262
3548
|
|
|
3263
|
-
####
|
|
3549
|
+
#### 🔌 Usage
|
|
3264
3550
|
|
|
3265
3551
|
<dl>
|
|
3266
3552
|
<dd>
|
|
@@ -3268,31 +3554,26 @@ client.doc.forms.set_value(
|
|
|
3268
3554
|
<dl>
|
|
3269
3555
|
<dd>
|
|
3270
3556
|
|
|
3271
|
-
|
|
3272
|
-
|
|
3557
|
+
```ruby
|
|
3558
|
+
client.doc.attachments.list(
|
|
3559
|
+
doc_id: "docId",
|
|
3560
|
+
layer_name: "layerName"
|
|
3561
|
+
)
|
|
3562
|
+
```
|
|
3273
3563
|
</dd>
|
|
3274
3564
|
</dl>
|
|
3275
|
-
|
|
3276
|
-
<dl>
|
|
3277
|
-
<dd>
|
|
3278
|
-
|
|
3279
|
-
**layer_name:** `String`
|
|
3280
|
-
|
|
3281
3565
|
</dd>
|
|
3282
3566
|
</dl>
|
|
3283
3567
|
|
|
3568
|
+
#### ⚙️ Parameters
|
|
3569
|
+
|
|
3284
3570
|
<dl>
|
|
3285
3571
|
<dd>
|
|
3286
3572
|
|
|
3287
|
-
**field_key:** `String`
|
|
3288
|
-
|
|
3289
|
-
</dd>
|
|
3290
|
-
</dl>
|
|
3291
|
-
|
|
3292
3573
|
<dl>
|
|
3293
3574
|
<dd>
|
|
3294
3575
|
|
|
3295
|
-
**
|
|
3576
|
+
**doc_id:** `String`
|
|
3296
3577
|
|
|
3297
3578
|
</dd>
|
|
3298
3579
|
</dl>
|
|
@@ -3300,7 +3581,7 @@ client.doc.forms.set_value(
|
|
|
3300
3581
|
<dl>
|
|
3301
3582
|
<dd>
|
|
3302
3583
|
|
|
3303
|
-
**
|
|
3584
|
+
**layer_name:** `String`
|
|
3304
3585
|
|
|
3305
3586
|
</dd>
|
|
3306
3587
|
</dl>
|
|
@@ -3308,7 +3589,7 @@ client.doc.forms.set_value(
|
|
|
3308
3589
|
<dl>
|
|
3309
3590
|
<dd>
|
|
3310
3591
|
|
|
3311
|
-
**
|
|
3592
|
+
**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.
|
|
3312
3593
|
|
|
3313
3594
|
</dd>
|
|
3314
3595
|
</dl>
|
|
@@ -3316,7 +3597,7 @@ client.doc.forms.set_value(
|
|
|
3316
3597
|
<dl>
|
|
3317
3598
|
<dd>
|
|
3318
3599
|
|
|
3319
|
-
**request_options:** `CloudPDF::Doc::
|
|
3600
|
+
**request_options:** `CloudPDF::Doc::Attachments::RequestOptions`
|
|
3320
3601
|
|
|
3321
3602
|
</dd>
|
|
3322
3603
|
</dl>
|
|
@@ -3328,7 +3609,8 @@ client.doc.forms.set_value(
|
|
|
3328
3609
|
</dl>
|
|
3329
3610
|
</details>
|
|
3330
3611
|
|
|
3331
|
-
|
|
3612
|
+
## Doc Forms
|
|
3613
|
+
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocFormsList200Response</code></summary>
|
|
3332
3614
|
<dl>
|
|
3333
3615
|
<dd>
|
|
3334
3616
|
|
|
@@ -3341,7 +3623,7 @@ client.doc.forms.set_value(
|
|
|
3341
3623
|
<dd>
|
|
3342
3624
|
|
|
3343
3625
|
```ruby
|
|
3344
|
-
client.doc.forms.
|
|
3626
|
+
client.doc.forms.list(
|
|
3345
3627
|
doc_id: "docId",
|
|
3346
3628
|
layer_name: "layerName"
|
|
3347
3629
|
)
|
|
@@ -3383,22 +3665,6 @@ client.doc.forms.reset(
|
|
|
3383
3665
|
<dl>
|
|
3384
3666
|
<dd>
|
|
3385
3667
|
|
|
3386
|
-
**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
|
|
3387
|
-
|
|
3388
|
-
</dd>
|
|
3389
|
-
</dl>
|
|
3390
|
-
|
|
3391
|
-
<dl>
|
|
3392
|
-
<dd>
|
|
3393
|
-
|
|
3394
|
-
**refs:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]`
|
|
3395
|
-
|
|
3396
|
-
</dd>
|
|
3397
|
-
</dl>
|
|
3398
|
-
|
|
3399
|
-
<dl>
|
|
3400
|
-
<dd>
|
|
3401
|
-
|
|
3402
3668
|
**request_options:** `CloudPDF::Doc::Forms::RequestOptions`
|
|
3403
3669
|
|
|
3404
3670
|
</dd>
|
|
@@ -3411,7 +3677,7 @@ client.doc.forms.reset(
|
|
|
3411
3677
|
</dl>
|
|
3412
3678
|
</details>
|
|
3413
3679
|
|
|
3414
|
-
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">
|
|
3680
|
+
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reorder_calculations</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsReorderCalculations200Response</code></summary>
|
|
3415
3681
|
<dl>
|
|
3416
3682
|
<dd>
|
|
3417
3683
|
|
|
@@ -3424,11 +3690,11 @@ client.doc.forms.reset(
|
|
|
3424
3690
|
<dd>
|
|
3425
3691
|
|
|
3426
3692
|
```ruby
|
|
3427
|
-
client.doc.forms.
|
|
3693
|
+
client.doc.forms.reorder_calculations(
|
|
3428
3694
|
doc_id: "docId",
|
|
3429
3695
|
layer_name: "layerName",
|
|
3430
|
-
|
|
3431
|
-
|
|
3696
|
+
fields: [],
|
|
3697
|
+
position: "start"
|
|
3432
3698
|
)
|
|
3433
3699
|
```
|
|
3434
3700
|
</dd>
|
|
@@ -3460,7 +3726,7 @@ client.doc.forms.delete_widget(
|
|
|
3460
3726
|
<dl>
|
|
3461
3727
|
<dd>
|
|
3462
3728
|
|
|
3463
|
-
**
|
|
3729
|
+
**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.
|
|
3464
3730
|
|
|
3465
3731
|
</dd>
|
|
3466
3732
|
</dl>
|
|
@@ -3468,7 +3734,7 @@ client.doc.forms.delete_widget(
|
|
|
3468
3734
|
<dl>
|
|
3469
3735
|
<dd>
|
|
3470
3736
|
|
|
3471
|
-
**
|
|
3737
|
+
**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
|
|
3472
3738
|
|
|
3473
3739
|
</dd>
|
|
3474
3740
|
</dl>
|
|
@@ -3476,7 +3742,7 @@ client.doc.forms.delete_widget(
|
|
|
3476
3742
|
<dl>
|
|
3477
3743
|
<dd>
|
|
3478
3744
|
|
|
3479
|
-
**
|
|
3745
|
+
**fields:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]`
|
|
3480
3746
|
|
|
3481
3747
|
</dd>
|
|
3482
3748
|
</dl>
|
|
@@ -3484,7 +3750,7 @@ client.doc.forms.delete_widget(
|
|
|
3484
3750
|
<dl>
|
|
3485
3751
|
<dd>
|
|
3486
3752
|
|
|
3487
|
-
**
|
|
3753
|
+
**position:** `CloudPDF::Types::FieldPosition`
|
|
3488
3754
|
|
|
3489
3755
|
</dd>
|
|
3490
3756
|
</dl>
|
|
@@ -3504,7 +3770,7 @@ client.doc.forms.delete_widget(
|
|
|
3504
3770
|
</dl>
|
|
3505
3771
|
</details>
|
|
3506
3772
|
|
|
3507
|
-
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">
|
|
3773
|
+
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">set_value</a>(doc_id:, layer_name:, field_key:, request) -> CloudPDF::Types::DocFormsSetValue200Response</code></summary>
|
|
3508
3774
|
<dl>
|
|
3509
3775
|
<dd>
|
|
3510
3776
|
|
|
@@ -3517,12 +3783,13 @@ client.doc.forms.delete_widget(
|
|
|
3517
3783
|
<dd>
|
|
3518
3784
|
|
|
3519
3785
|
```ruby
|
|
3520
|
-
client.doc.forms.
|
|
3786
|
+
client.doc.forms.set_value(
|
|
3521
3787
|
doc_id: "docId",
|
|
3522
3788
|
layer_name: "layerName",
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
|
|
3789
|
+
field_key: "fieldKey",
|
|
3790
|
+
request: {
|
|
3791
|
+
key: "value"
|
|
3792
|
+
}
|
|
3526
3793
|
)
|
|
3527
3794
|
```
|
|
3528
3795
|
</dd>
|
|
@@ -3554,15 +3821,7 @@ client.doc.forms.update_widget(
|
|
|
3554
3821
|
<dl>
|
|
3555
3822
|
<dd>
|
|
3556
3823
|
|
|
3557
|
-
**
|
|
3558
|
-
|
|
3559
|
-
</dd>
|
|
3560
|
-
</dl>
|
|
3561
|
-
|
|
3562
|
-
<dl>
|
|
3563
|
-
<dd>
|
|
3564
|
-
|
|
3565
|
-
**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
|
|
3824
|
+
**field_key:** `String`
|
|
3566
3825
|
|
|
3567
3826
|
</dd>
|
|
3568
3827
|
</dl>
|
|
@@ -3586,7 +3845,7 @@ client.doc.forms.update_widget(
|
|
|
3586
3845
|
<dl>
|
|
3587
3846
|
<dd>
|
|
3588
3847
|
|
|
3589
|
-
**
|
|
3848
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
3590
3849
|
|
|
3591
3850
|
</dd>
|
|
3592
3851
|
</dl>
|
|
@@ -3606,7 +3865,7 @@ client.doc.forms.update_widget(
|
|
|
3606
3865
|
</dl>
|
|
3607
3866
|
</details>
|
|
3608
3867
|
|
|
3609
|
-
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">
|
|
3868
|
+
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reset</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsReset200Response</code></summary>
|
|
3610
3869
|
<dl>
|
|
3611
3870
|
<dd>
|
|
3612
3871
|
|
|
@@ -3619,12 +3878,9 @@ client.doc.forms.update_widget(
|
|
|
3619
3878
|
<dd>
|
|
3620
3879
|
|
|
3621
3880
|
```ruby
|
|
3622
|
-
client.doc.forms.
|
|
3881
|
+
client.doc.forms.reset(
|
|
3623
3882
|
doc_id: "docId",
|
|
3624
|
-
layer_name: "layerName"
|
|
3625
|
-
page_key: "pageKey",
|
|
3626
|
-
widgets: [],
|
|
3627
|
-
position: "start"
|
|
3883
|
+
layer_name: "layerName"
|
|
3628
3884
|
)
|
|
3629
3885
|
```
|
|
3630
3886
|
</dd>
|
|
@@ -3656,15 +3912,7 @@ client.doc.forms.reorder_widgets(
|
|
|
3656
3912
|
<dl>
|
|
3657
3913
|
<dd>
|
|
3658
3914
|
|
|
3659
|
-
**
|
|
3660
|
-
|
|
3661
|
-
</dd>
|
|
3662
|
-
</dl>
|
|
3663
|
-
|
|
3664
|
-
<dl>
|
|
3665
|
-
<dd>
|
|
3666
|
-
|
|
3667
|
-
**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.
|
|
3915
|
+
**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.
|
|
3668
3916
|
|
|
3669
3917
|
</dd>
|
|
3670
3918
|
</dl>
|
|
@@ -3680,15 +3928,7 @@ client.doc.forms.reorder_widgets(
|
|
|
3680
3928
|
<dl>
|
|
3681
3929
|
<dd>
|
|
3682
3930
|
|
|
3683
|
-
**
|
|
3684
|
-
|
|
3685
|
-
</dd>
|
|
3686
|
-
</dl>
|
|
3687
|
-
|
|
3688
|
-
<dl>
|
|
3689
|
-
<dd>
|
|
3690
|
-
|
|
3691
|
-
**position:** `CloudPDF::Types::AnnotationPosition`
|
|
3931
|
+
**refs:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]`
|
|
3692
3932
|
|
|
3693
3933
|
</dd>
|
|
3694
3934
|
</dl>
|
|
@@ -3708,8 +3948,7 @@ client.doc.forms.reorder_widgets(
|
|
|
3708
3948
|
</dl>
|
|
3709
3949
|
</details>
|
|
3710
3950
|
|
|
3711
|
-
|
|
3712
|
-
<details><summary><code>client.doc.metadata.<a href="/lib/CloudPDF/doc/metadata/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocumentMetadata</code></summary>
|
|
3951
|
+
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">delete_widget</a>(doc_id:, layer_name:, page_key:, annot_key:) -> CloudPDF::Types::DocFormsDeleteWidget200Response</code></summary>
|
|
3713
3952
|
<dl>
|
|
3714
3953
|
<dd>
|
|
3715
3954
|
|
|
@@ -3722,9 +3961,11 @@ client.doc.forms.reorder_widgets(
|
|
|
3722
3961
|
<dd>
|
|
3723
3962
|
|
|
3724
3963
|
```ruby
|
|
3725
|
-
client.doc.
|
|
3964
|
+
client.doc.forms.delete_widget(
|
|
3726
3965
|
doc_id: "docId",
|
|
3727
|
-
layer_name: "layerName"
|
|
3966
|
+
layer_name: "layerName",
|
|
3967
|
+
page_key: "pageKey",
|
|
3968
|
+
annot_key: "annotKey"
|
|
3728
3969
|
)
|
|
3729
3970
|
```
|
|
3730
3971
|
</dd>
|
|
@@ -3756,6 +3997,22 @@ client.doc.metadata.get(
|
|
|
3756
3997
|
<dl>
|
|
3757
3998
|
<dd>
|
|
3758
3999
|
|
|
4000
|
+
**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
|
|
4001
|
+
|
|
4002
|
+
</dd>
|
|
4003
|
+
</dl>
|
|
4004
|
+
|
|
4005
|
+
<dl>
|
|
4006
|
+
<dd>
|
|
4007
|
+
|
|
4008
|
+
**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
|
|
4009
|
+
|
|
4010
|
+
</dd>
|
|
4011
|
+
</dl>
|
|
4012
|
+
|
|
4013
|
+
<dl>
|
|
4014
|
+
<dd>
|
|
4015
|
+
|
|
3759
4016
|
**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.
|
|
3760
4017
|
|
|
3761
4018
|
</dd>
|
|
@@ -3764,7 +4021,15 @@ client.doc.metadata.get(
|
|
|
3764
4021
|
<dl>
|
|
3765
4022
|
<dd>
|
|
3766
4023
|
|
|
3767
|
-
**
|
|
4024
|
+
**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
|
|
4025
|
+
|
|
4026
|
+
</dd>
|
|
4027
|
+
</dl>
|
|
4028
|
+
|
|
4029
|
+
<dl>
|
|
4030
|
+
<dd>
|
|
4031
|
+
|
|
4032
|
+
**request_options:** `CloudPDF::Doc::Forms::RequestOptions`
|
|
3768
4033
|
|
|
3769
4034
|
</dd>
|
|
3770
4035
|
</dl>
|
|
@@ -3776,8 +4041,7 @@ client.doc.metadata.get(
|
|
|
3776
4041
|
</dl>
|
|
3777
4042
|
</details>
|
|
3778
4043
|
|
|
3779
|
-
|
|
3780
|
-
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_scale</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocPagesSetScale200Response</code></summary>
|
|
4044
|
+
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">update_widget</a>(doc_id:, layer_name:, page_key:, annot_key:, request) -> CloudPDF::Types::DocFormsUpdateWidget200Response</code></summary>
|
|
3781
4045
|
<dl>
|
|
3782
4046
|
<dd>
|
|
3783
4047
|
|
|
@@ -3790,10 +4054,12 @@ client.doc.metadata.get(
|
|
|
3790
4054
|
<dd>
|
|
3791
4055
|
|
|
3792
4056
|
```ruby
|
|
3793
|
-
client.doc.
|
|
4057
|
+
client.doc.forms.update_widget(
|
|
3794
4058
|
doc_id: "docId",
|
|
3795
4059
|
layer_name: "layerName",
|
|
3796
|
-
page_key: "pageKey"
|
|
4060
|
+
page_key: "pageKey",
|
|
4061
|
+
annot_key: "annotKey",
|
|
4062
|
+
patch: {}
|
|
3797
4063
|
)
|
|
3798
4064
|
```
|
|
3799
4065
|
</dd>
|
|
@@ -3833,6 +4099,14 @@ client.doc.pages.set_scale(
|
|
|
3833
4099
|
<dl>
|
|
3834
4100
|
<dd>
|
|
3835
4101
|
|
|
4102
|
+
**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
|
|
4103
|
+
|
|
4104
|
+
</dd>
|
|
4105
|
+
</dl>
|
|
4106
|
+
|
|
4107
|
+
<dl>
|
|
4108
|
+
<dd>
|
|
4109
|
+
|
|
3836
4110
|
**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.
|
|
3837
4111
|
|
|
3838
4112
|
</dd>
|
|
@@ -3849,7 +4123,7 @@ client.doc.pages.set_scale(
|
|
|
3849
4123
|
<dl>
|
|
3850
4124
|
<dd>
|
|
3851
4125
|
|
|
3852
|
-
**
|
|
4126
|
+
**patch:** `CloudPDF::Types::WidgetPatch`
|
|
3853
4127
|
|
|
3854
4128
|
</dd>
|
|
3855
4129
|
</dl>
|
|
@@ -3857,7 +4131,7 @@ client.doc.pages.set_scale(
|
|
|
3857
4131
|
<dl>
|
|
3858
4132
|
<dd>
|
|
3859
4133
|
|
|
3860
|
-
**request_options:** `CloudPDF::Doc::
|
|
4134
|
+
**request_options:** `CloudPDF::Doc::Forms::RequestOptions`
|
|
3861
4135
|
|
|
3862
4136
|
</dd>
|
|
3863
4137
|
</dl>
|
|
@@ -3869,7 +4143,7 @@ client.doc.pages.set_scale(
|
|
|
3869
4143
|
</dl>
|
|
3870
4144
|
</details>
|
|
3871
4145
|
|
|
3872
|
-
<details><summary><code>client.doc.
|
|
4146
|
+
<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reorder_widgets</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocFormsReorderWidgets200Response</code></summary>
|
|
3873
4147
|
<dl>
|
|
3874
4148
|
<dd>
|
|
3875
4149
|
|
|
@@ -3882,10 +4156,12 @@ client.doc.pages.set_scale(
|
|
|
3882
4156
|
<dd>
|
|
3883
4157
|
|
|
3884
4158
|
```ruby
|
|
3885
|
-
client.doc.
|
|
4159
|
+
client.doc.forms.reorder_widgets(
|
|
3886
4160
|
doc_id: "docId",
|
|
3887
4161
|
layer_name: "layerName",
|
|
3888
|
-
page_key: "pageKey"
|
|
4162
|
+
page_key: "pageKey",
|
|
4163
|
+
widgets: [],
|
|
4164
|
+
position: "start"
|
|
3889
4165
|
)
|
|
3890
4166
|
```
|
|
3891
4167
|
</dd>
|
|
@@ -3933,7 +4209,31 @@ client.doc.pages.viewports(
|
|
|
3933
4209
|
<dl>
|
|
3934
4210
|
<dd>
|
|
3935
4211
|
|
|
3936
|
-
**
|
|
4212
|
+
**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
|
|
4213
|
+
|
|
4214
|
+
</dd>
|
|
4215
|
+
</dl>
|
|
4216
|
+
|
|
4217
|
+
<dl>
|
|
4218
|
+
<dd>
|
|
4219
|
+
|
|
4220
|
+
**widgets:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]`
|
|
4221
|
+
|
|
4222
|
+
</dd>
|
|
4223
|
+
</dl>
|
|
4224
|
+
|
|
4225
|
+
<dl>
|
|
4226
|
+
<dd>
|
|
4227
|
+
|
|
4228
|
+
**position:** `CloudPDF::Types::AnnotationPosition`
|
|
4229
|
+
|
|
4230
|
+
</dd>
|
|
4231
|
+
</dl>
|
|
4232
|
+
|
|
4233
|
+
<dl>
|
|
4234
|
+
<dd>
|
|
4235
|
+
|
|
4236
|
+
**request_options:** `CloudPDF::Doc::Forms::RequestOptions`
|
|
3937
4237
|
|
|
3938
4238
|
</dd>
|
|
3939
4239
|
</dl>
|
|
@@ -3945,7 +4245,8 @@ client.doc.pages.viewports(
|
|
|
3945
4245
|
</dl>
|
|
3946
4246
|
</details>
|
|
3947
4247
|
|
|
3948
|
-
|
|
4248
|
+
## Doc Metadata
|
|
4249
|
+
<details><summary><code>client.doc.metadata.<a href="/lib/CloudPDF/doc/metadata/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocumentMetadata</code></summary>
|
|
3949
4250
|
<dl>
|
|
3950
4251
|
<dd>
|
|
3951
4252
|
|
|
@@ -3958,12 +4259,9 @@ client.doc.pages.viewports(
|
|
|
3958
4259
|
<dd>
|
|
3959
4260
|
|
|
3960
4261
|
```ruby
|
|
3961
|
-
client.doc.
|
|
4262
|
+
client.doc.metadata.get(
|
|
3962
4263
|
doc_id: "docId",
|
|
3963
|
-
layer_name: "layerName"
|
|
3964
|
-
request: {
|
|
3965
|
-
key: "value"
|
|
3966
|
-
}
|
|
4264
|
+
layer_name: "layerName"
|
|
3967
4265
|
)
|
|
3968
4266
|
```
|
|
3969
4267
|
</dd>
|
|
@@ -4003,23 +4301,7 @@ client.doc.pages.delete(
|
|
|
4003
4301
|
<dl>
|
|
4004
4302
|
<dd>
|
|
4005
4303
|
|
|
4006
|
-
**
|
|
4007
|
-
|
|
4008
|
-
</dd>
|
|
4009
|
-
</dl>
|
|
4010
|
-
|
|
4011
|
-
<dl>
|
|
4012
|
-
<dd>
|
|
4013
|
-
|
|
4014
|
-
**request:** `Internal::Types::Hash[String, Object]`
|
|
4015
|
-
|
|
4016
|
-
</dd>
|
|
4017
|
-
</dl>
|
|
4018
|
-
|
|
4019
|
-
<dl>
|
|
4020
|
-
<dd>
|
|
4021
|
-
|
|
4022
|
-
**request_options:** `CloudPDF::Doc::Pages::RequestOptions`
|
|
4304
|
+
**request_options:** `CloudPDF::Doc::Metadata::RequestOptions`
|
|
4023
4305
|
|
|
4024
4306
|
</dd>
|
|
4025
4307
|
</dl>
|
|
@@ -4031,24 +4313,11 @@ client.doc.pages.delete(
|
|
|
4031
4313
|
</dl>
|
|
4032
4314
|
</details>
|
|
4033
4315
|
|
|
4034
|
-
|
|
4035
|
-
<
|
|
4036
|
-
<dd>
|
|
4037
|
-
|
|
4038
|
-
#### 📝 Description
|
|
4039
|
-
|
|
4040
|
-
<dl>
|
|
4041
|
-
<dd>
|
|
4042
|
-
|
|
4316
|
+
## Doc Outline
|
|
4317
|
+
<details><summary><code>client.doc.outline.<a href="/lib/CloudPDF/doc/outline/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocumentOutline</code></summary>
|
|
4043
4318
|
<dl>
|
|
4044
4319
|
<dd>
|
|
4045
4320
|
|
|
4046
|
-
A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[]}`; the response body is the new PDF.
|
|
4047
|
-
</dd>
|
|
4048
|
-
</dl>
|
|
4049
|
-
</dd>
|
|
4050
|
-
</dl>
|
|
4051
|
-
|
|
4052
4321
|
#### 🔌 Usage
|
|
4053
4322
|
|
|
4054
4323
|
<dl>
|
|
@@ -4058,14 +4327,9 @@ A read, not a mutation: the source document is untouched and no event is publish
|
|
|
4058
4327
|
<dd>
|
|
4059
4328
|
|
|
4060
4329
|
```ruby
|
|
4061
|
-
client.doc.
|
|
4330
|
+
client.doc.outline.get(
|
|
4062
4331
|
doc_id: "docId",
|
|
4063
|
-
layer_name: "layerName"
|
|
4064
|
-
request: {
|
|
4065
|
-
string: {
|
|
4066
|
-
key: "value"
|
|
4067
|
-
}
|
|
4068
|
-
}
|
|
4332
|
+
layer_name: "layerName"
|
|
4069
4333
|
)
|
|
4070
4334
|
```
|
|
4071
4335
|
</dd>
|
|
@@ -4105,15 +4369,7 @@ client.doc.pages.extract(
|
|
|
4105
4369
|
<dl>
|
|
4106
4370
|
<dd>
|
|
4107
4371
|
|
|
4108
|
-
**
|
|
4109
|
-
|
|
4110
|
-
</dd>
|
|
4111
|
-
</dl>
|
|
4112
|
-
|
|
4113
|
-
<dl>
|
|
4114
|
-
<dd>
|
|
4115
|
-
|
|
4116
|
-
**request_options:** `CloudPDF::Doc::Pages::RequestOptions`
|
|
4372
|
+
**request_options:** `CloudPDF::Doc::Outline::RequestOptions`
|
|
4117
4373
|
|
|
4118
4374
|
</dd>
|
|
4119
4375
|
</dl>
|
|
@@ -4125,7 +4381,8 @@ client.doc.pages.extract(
|
|
|
4125
4381
|
</dl>
|
|
4126
4382
|
</details>
|
|
4127
4383
|
|
|
4128
|
-
|
|
4384
|
+
## Doc Pages
|
|
4385
|
+
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_scale</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocPagesSetScale200Response</code></summary>
|
|
4129
4386
|
<dl>
|
|
4130
4387
|
<dd>
|
|
4131
4388
|
|
|
@@ -4138,12 +4395,10 @@ client.doc.pages.extract(
|
|
|
4138
4395
|
<dd>
|
|
4139
4396
|
|
|
4140
4397
|
```ruby
|
|
4141
|
-
client.doc.pages.
|
|
4398
|
+
client.doc.pages.set_scale(
|
|
4142
4399
|
doc_id: "docId",
|
|
4143
4400
|
layer_name: "layerName",
|
|
4144
|
-
|
|
4145
|
-
key: "value"
|
|
4146
|
-
}
|
|
4401
|
+
page_key: "pageKey"
|
|
4147
4402
|
)
|
|
4148
4403
|
```
|
|
4149
4404
|
</dd>
|
|
@@ -4175,6 +4430,14 @@ client.doc.pages.flatten(
|
|
|
4175
4430
|
<dl>
|
|
4176
4431
|
<dd>
|
|
4177
4432
|
|
|
4433
|
+
**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
|
|
4434
|
+
|
|
4435
|
+
</dd>
|
|
4436
|
+
</dl>
|
|
4437
|
+
|
|
4438
|
+
<dl>
|
|
4439
|
+
<dd>
|
|
4440
|
+
|
|
4178
4441
|
**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.
|
|
4179
4442
|
|
|
4180
4443
|
</dd>
|
|
@@ -4191,7 +4454,7 @@ client.doc.pages.flatten(
|
|
|
4191
4454
|
<dl>
|
|
4192
4455
|
<dd>
|
|
4193
4456
|
|
|
4194
|
-
**
|
|
4457
|
+
**measure:** `CloudPDF::Doc::Pages::Types::DocPagesSetScaleRequestMeasure`
|
|
4195
4458
|
|
|
4196
4459
|
</dd>
|
|
4197
4460
|
</dl>
|
|
@@ -4211,24 +4474,10 @@ client.doc.pages.flatten(
|
|
|
4211
4474
|
</dl>
|
|
4212
4475
|
</details>
|
|
4213
4476
|
|
|
4214
|
-
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">
|
|
4215
|
-
<dl>
|
|
4216
|
-
<dd>
|
|
4217
|
-
|
|
4218
|
-
#### 📝 Description
|
|
4219
|
-
|
|
4220
|
-
<dl>
|
|
4221
|
-
<dd>
|
|
4222
|
-
|
|
4477
|
+
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">viewports</a>(doc_id:, layer_name:, page_key:) -> CloudPDF::Types::DocPagesViewports200Response</code></summary>
|
|
4223
4478
|
<dl>
|
|
4224
4479
|
<dd>
|
|
4225
4480
|
|
|
4226
|
-
Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source": "<key>"}}` (position omitted → the end), and the standalone PDF whose pages are copied in as the part `resource:<key>`. The inserted copies get fresh page object numbers, returned in insertion order.
|
|
4227
|
-
</dd>
|
|
4228
|
-
</dl>
|
|
4229
|
-
</dd>
|
|
4230
|
-
</dl>
|
|
4231
|
-
|
|
4232
4481
|
#### 🔌 Usage
|
|
4233
4482
|
|
|
4234
4483
|
<dl>
|
|
@@ -4238,9 +4487,10 @@ Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source
|
|
|
4238
4487
|
<dd>
|
|
4239
4488
|
|
|
4240
4489
|
```ruby
|
|
4241
|
-
client.doc.pages.
|
|
4490
|
+
client.doc.pages.viewports(
|
|
4242
4491
|
doc_id: "docId",
|
|
4243
|
-
layer_name: "layerName"
|
|
4492
|
+
layer_name: "layerName",
|
|
4493
|
+
page_key: "pageKey"
|
|
4244
4494
|
)
|
|
4245
4495
|
```
|
|
4246
4496
|
</dd>
|
|
@@ -4272,7 +4522,7 @@ client.doc.pages.insert(
|
|
|
4272
4522
|
<dl>
|
|
4273
4523
|
<dd>
|
|
4274
4524
|
|
|
4275
|
-
**
|
|
4525
|
+
**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
|
|
4276
4526
|
|
|
4277
4527
|
</dd>
|
|
4278
4528
|
</dl>
|
|
@@ -4280,7 +4530,7 @@ client.doc.pages.insert(
|
|
|
4280
4530
|
<dl>
|
|
4281
4531
|
<dd>
|
|
4282
4532
|
|
|
4283
|
-
**
|
|
4533
|
+
**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.
|
|
4284
4534
|
|
|
4285
4535
|
</dd>
|
|
4286
4536
|
</dl>
|
|
@@ -4300,7 +4550,7 @@ client.doc.pages.insert(
|
|
|
4300
4550
|
</dl>
|
|
4301
4551
|
</details>
|
|
4302
4552
|
|
|
4303
|
-
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">
|
|
4553
|
+
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">extract</a>(doc_id:, layer_name:, request) -> String</code></summary>
|
|
4304
4554
|
<dl>
|
|
4305
4555
|
<dd>
|
|
4306
4556
|
|
|
@@ -4312,7 +4562,7 @@ client.doc.pages.insert(
|
|
|
4312
4562
|
<dl>
|
|
4313
4563
|
<dd>
|
|
4314
4564
|
|
|
4315
|
-
Body is `{"
|
|
4565
|
+
A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[], "flatten"?: {"usage"?: "display" | "print"}, "includeAnnotations"?: boolean, "includeFormFields"?: boolean}`; the response body is the new PDF. With `flatten` the copy is the pages as they draw for `usage` (`"print"`: a print copy): the annotations and form fields painted in, nothing interactive left, layers in their state for the usage. A flattened copy takes `doc.download` or `doc.download.flattened`, and paints only what the caller may read; `includeAnnotations` and `includeFormFields` choose what it paints, and are refused without `flatten`.
|
|
4316
4566
|
</dd>
|
|
4317
4567
|
</dl>
|
|
4318
4568
|
</dd>
|
|
@@ -4327,11 +4577,13 @@ Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF p
|
|
|
4327
4577
|
<dd>
|
|
4328
4578
|
|
|
4329
4579
|
```ruby
|
|
4330
|
-
client.doc.pages.
|
|
4580
|
+
client.doc.pages.extract(
|
|
4331
4581
|
doc_id: "docId",
|
|
4332
4582
|
layer_name: "layerName",
|
|
4333
4583
|
request: {
|
|
4334
|
-
|
|
4584
|
+
string: {
|
|
4585
|
+
key: "value"
|
|
4586
|
+
}
|
|
4335
4587
|
}
|
|
4336
4588
|
)
|
|
4337
4589
|
```
|
|
@@ -4372,14 +4624,6 @@ client.doc.pages.insert_blank(
|
|
|
4372
4624
|
<dl>
|
|
4373
4625
|
<dd>
|
|
4374
4626
|
|
|
4375
|
-
**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
|
|
4376
|
-
|
|
4377
|
-
</dd>
|
|
4378
|
-
</dl>
|
|
4379
|
-
|
|
4380
|
-
<dl>
|
|
4381
|
-
<dd>
|
|
4382
|
-
|
|
4383
4627
|
**request:** `Internal::Types::Hash[String, Object]`
|
|
4384
4628
|
|
|
4385
4629
|
</dd>
|
|
@@ -4400,7 +4644,7 @@ client.doc.pages.insert_blank(
|
|
|
4400
4644
|
</dl>
|
|
4401
4645
|
</details>
|
|
4402
4646
|
|
|
4403
|
-
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">
|
|
4647
|
+
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">flatten</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesFlatten200Response</code></summary>
|
|
4404
4648
|
<dl>
|
|
4405
4649
|
<dd>
|
|
4406
4650
|
|
|
@@ -4413,7 +4657,7 @@ client.doc.pages.insert_blank(
|
|
|
4413
4657
|
<dd>
|
|
4414
4658
|
|
|
4415
4659
|
```ruby
|
|
4416
|
-
client.doc.pages.
|
|
4660
|
+
client.doc.pages.flatten(
|
|
4417
4661
|
doc_id: "docId",
|
|
4418
4662
|
layer_name: "layerName",
|
|
4419
4663
|
request: {
|
|
@@ -4486,7 +4730,7 @@ client.doc.pages.set_name(
|
|
|
4486
4730
|
</dl>
|
|
4487
4731
|
</details>
|
|
4488
4732
|
|
|
4489
|
-
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">
|
|
4733
|
+
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesSetName200Response</code></summary>
|
|
4490
4734
|
<dl>
|
|
4491
4735
|
<dd>
|
|
4492
4736
|
|
|
@@ -4499,7 +4743,7 @@ client.doc.pages.set_name(
|
|
|
4499
4743
|
<dd>
|
|
4500
4744
|
|
|
4501
4745
|
```ruby
|
|
4502
|
-
client.doc.pages.
|
|
4746
|
+
client.doc.pages.set_name(
|
|
4503
4747
|
doc_id: "docId",
|
|
4504
4748
|
layer_name: "layerName",
|
|
4505
4749
|
request: {
|
|
@@ -4572,7 +4816,7 @@ client.doc.pages.remove_name(
|
|
|
4572
4816
|
</dl>
|
|
4573
4817
|
</details>
|
|
4574
4818
|
|
|
4575
|
-
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">
|
|
4819
|
+
<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">remove_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRemoveName200Response</code></summary>
|
|
4576
4820
|
<dl>
|
|
4577
4821
|
<dd>
|
|
4578
4822
|
|
|
@@ -4585,14 +4829,12 @@ client.doc.pages.remove_name(
|
|
|
4585
4829
|
<dd>
|
|
4586
4830
|
|
|
4587
4831
|
```ruby
|
|
4588
|
-
client.doc.pages.
|
|
4832
|
+
client.doc.pages.remove_name(
|
|
4589
4833
|
doc_id: "docId",
|
|
4590
4834
|
layer_name: "layerName",
|
|
4591
|
-
|
|
4592
|
-
|
|
4593
|
-
|
|
4594
|
-
}],
|
|
4595
|
-
position: "start"
|
|
4835
|
+
request: {
|
|
4836
|
+
key: "value"
|
|
4837
|
+
}
|
|
4596
4838
|
)
|
|
4597
4839
|
```
|
|
4598
4840
|
</dd>
|
|
@@ -4640,15 +4882,7 @@ client.doc.pages.reorder(
|
|
|
4640
4882
|
<dl>
|
|
4641
4883
|
<dd>
|
|
4642
4884
|
|
|
4643
|
-
**
|
|
4644
|
-
|
|
4645
|
-
</dd>
|
|
4646
|
-
</dl>
|
|
4647
|
-
|
|
4648
|
-
<dl>
|
|
4649
|
-
<dd>
|
|
4650
|
-
|
|
4651
|
-
**position:** `CloudPDF::Types::PagePosition`
|
|
4885
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
4652
4886
|
|
|
4653
4887
|
</dd>
|
|
4654
4888
|
</dl>
|
|
@@ -4668,7 +4902,8 @@ client.doc.pages.reorder(
|
|
|
4668
4902
|
</dl>
|
|
4669
4903
|
</details>
|
|
4670
4904
|
|
|
4671
|
-
|
|
4905
|
+
## Doc Redactions
|
|
4906
|
+
<details><summary><code>client.doc.redactions.<a href="/lib/CloudPDF/doc/redactions/client.rb">apply</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocRedactionsApply200Response</code></summary>
|
|
4672
4907
|
<dl>
|
|
4673
4908
|
<dd>
|
|
4674
4909
|
|
|
@@ -4681,12 +4916,9 @@ client.doc.pages.reorder(
|
|
|
4681
4916
|
<dd>
|
|
4682
4917
|
|
|
4683
4918
|
```ruby
|
|
4684
|
-
client.doc.
|
|
4919
|
+
client.doc.redactions.apply(
|
|
4685
4920
|
doc_id: "docId",
|
|
4686
|
-
layer_name: "layerName"
|
|
4687
|
-
request: {
|
|
4688
|
-
key: "value"
|
|
4689
|
-
}
|
|
4921
|
+
layer_name: "layerName"
|
|
4690
4922
|
)
|
|
4691
4923
|
```
|
|
4692
4924
|
</dd>
|
|
@@ -4734,7 +4966,7 @@ client.doc.pages.rotate(
|
|
|
4734
4966
|
<dl>
|
|
4735
4967
|
<dd>
|
|
4736
4968
|
|
|
4737
|
-
**
|
|
4969
|
+
**pages:** `Internal::Types::Array[CloudPDF::Types::PageRef]`
|
|
4738
4970
|
|
|
4739
4971
|
</dd>
|
|
4740
4972
|
</dl>
|
|
@@ -4742,91 +4974,7 @@ client.doc.pages.rotate(
|
|
|
4742
4974
|
<dl>
|
|
4743
4975
|
<dd>
|
|
4744
4976
|
|
|
4745
|
-
**
|
|
4746
|
-
|
|
4747
|
-
</dd>
|
|
4748
|
-
</dl>
|
|
4749
|
-
</dd>
|
|
4750
|
-
</dl>
|
|
4751
|
-
|
|
4752
|
-
|
|
4753
|
-
</dd>
|
|
4754
|
-
</dl>
|
|
4755
|
-
</details>
|
|
4756
|
-
|
|
4757
|
-
## Doc Redactions
|
|
4758
|
-
<details><summary><code>client.doc.redactions.<a href="/lib/CloudPDF/doc/redactions/client.rb">apply</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocRedactionsApply200Response</code></summary>
|
|
4759
|
-
<dl>
|
|
4760
|
-
<dd>
|
|
4761
|
-
|
|
4762
|
-
#### 🔌 Usage
|
|
4763
|
-
|
|
4764
|
-
<dl>
|
|
4765
|
-
<dd>
|
|
4766
|
-
|
|
4767
|
-
<dl>
|
|
4768
|
-
<dd>
|
|
4769
|
-
|
|
4770
|
-
```ruby
|
|
4771
|
-
client.doc.redactions.apply(
|
|
4772
|
-
doc_id: "docId",
|
|
4773
|
-
layer_name: "layerName"
|
|
4774
|
-
)
|
|
4775
|
-
```
|
|
4776
|
-
</dd>
|
|
4777
|
-
</dl>
|
|
4778
|
-
</dd>
|
|
4779
|
-
</dl>
|
|
4780
|
-
|
|
4781
|
-
#### ⚙️ Parameters
|
|
4782
|
-
|
|
4783
|
-
<dl>
|
|
4784
|
-
<dd>
|
|
4785
|
-
|
|
4786
|
-
<dl>
|
|
4787
|
-
<dd>
|
|
4788
|
-
|
|
4789
|
-
**doc_id:** `String`
|
|
4790
|
-
|
|
4791
|
-
</dd>
|
|
4792
|
-
</dl>
|
|
4793
|
-
|
|
4794
|
-
<dl>
|
|
4795
|
-
<dd>
|
|
4796
|
-
|
|
4797
|
-
**layer_name:** `String`
|
|
4798
|
-
|
|
4799
|
-
</dd>
|
|
4800
|
-
</dl>
|
|
4801
|
-
|
|
4802
|
-
<dl>
|
|
4803
|
-
<dd>
|
|
4804
|
-
|
|
4805
|
-
**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.
|
|
4806
|
-
|
|
4807
|
-
</dd>
|
|
4808
|
-
</dl>
|
|
4809
|
-
|
|
4810
|
-
<dl>
|
|
4811
|
-
<dd>
|
|
4812
|
-
|
|
4813
|
-
**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
|
|
4814
|
-
|
|
4815
|
-
</dd>
|
|
4816
|
-
</dl>
|
|
4817
|
-
|
|
4818
|
-
<dl>
|
|
4819
|
-
<dd>
|
|
4820
|
-
|
|
4821
|
-
**pages:** `Internal::Types::Array[CloudPDF::Types::PageRef]`
|
|
4822
|
-
|
|
4823
|
-
</dd>
|
|
4824
|
-
</dl>
|
|
4825
|
-
|
|
4826
|
-
<dl>
|
|
4827
|
-
<dd>
|
|
4828
|
-
|
|
4829
|
-
**annotations:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]`
|
|
4977
|
+
**annotations:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]`
|
|
4830
4978
|
|
|
4831
4979
|
</dd>
|
|
4832
4980
|
</dl>
|
|
@@ -5960,3 +6108,327 @@ client.doc.metadata.custom.get(
|
|
|
5960
6108
|
</dl>
|
|
5961
6109
|
</details>
|
|
5962
6110
|
|
|
6111
|
+
## Documents Layers
|
|
6112
|
+
<details><summary><code>client.documents.layers.<a href="/lib/CloudPDF/documents/layers/client.rb">list</a>(tenant_id:, id:) -> CloudPDF::Types::DocumentsLayersList200Response</code></summary>
|
|
6113
|
+
<dl>
|
|
6114
|
+
<dd>
|
|
6115
|
+
|
|
6116
|
+
#### 🔌 Usage
|
|
6117
|
+
|
|
6118
|
+
<dl>
|
|
6119
|
+
<dd>
|
|
6120
|
+
|
|
6121
|
+
<dl>
|
|
6122
|
+
<dd>
|
|
6123
|
+
|
|
6124
|
+
```ruby
|
|
6125
|
+
client.documents.layers.list(
|
|
6126
|
+
tenant_id: "tenantId",
|
|
6127
|
+
id: "id"
|
|
6128
|
+
)
|
|
6129
|
+
```
|
|
6130
|
+
</dd>
|
|
6131
|
+
</dl>
|
|
6132
|
+
</dd>
|
|
6133
|
+
</dl>
|
|
6134
|
+
|
|
6135
|
+
#### ⚙️ Parameters
|
|
6136
|
+
|
|
6137
|
+
<dl>
|
|
6138
|
+
<dd>
|
|
6139
|
+
|
|
6140
|
+
<dl>
|
|
6141
|
+
<dd>
|
|
6142
|
+
|
|
6143
|
+
**tenant_id:** `String`
|
|
6144
|
+
|
|
6145
|
+
</dd>
|
|
6146
|
+
</dl>
|
|
6147
|
+
|
|
6148
|
+
<dl>
|
|
6149
|
+
<dd>
|
|
6150
|
+
|
|
6151
|
+
**id:** `String`
|
|
6152
|
+
|
|
6153
|
+
</dd>
|
|
6154
|
+
</dl>
|
|
6155
|
+
|
|
6156
|
+
<dl>
|
|
6157
|
+
<dd>
|
|
6158
|
+
|
|
6159
|
+
**limit:** `Integer`
|
|
6160
|
+
|
|
6161
|
+
</dd>
|
|
6162
|
+
</dl>
|
|
6163
|
+
|
|
6164
|
+
<dl>
|
|
6165
|
+
<dd>
|
|
6166
|
+
|
|
6167
|
+
**cursor:** `String`
|
|
6168
|
+
|
|
6169
|
+
</dd>
|
|
6170
|
+
</dl>
|
|
6171
|
+
|
|
6172
|
+
<dl>
|
|
6173
|
+
<dd>
|
|
6174
|
+
|
|
6175
|
+
**share_id:** `String`
|
|
6176
|
+
|
|
6177
|
+
</dd>
|
|
6178
|
+
</dl>
|
|
6179
|
+
|
|
6180
|
+
<dl>
|
|
6181
|
+
<dd>
|
|
6182
|
+
|
|
6183
|
+
**request_options:** `CloudPDF::Documents::Layers::RequestOptions`
|
|
6184
|
+
|
|
6185
|
+
</dd>
|
|
6186
|
+
</dl>
|
|
6187
|
+
</dd>
|
|
6188
|
+
</dl>
|
|
6189
|
+
|
|
6190
|
+
|
|
6191
|
+
</dd>
|
|
6192
|
+
</dl>
|
|
6193
|
+
</details>
|
|
6194
|
+
|
|
6195
|
+
<details><summary><code>client.documents.layers.<a href="/lib/CloudPDF/documents/layers/client.rb">delete</a>(tenant_id:, id:, layer_name:) -> </code></summary>
|
|
6196
|
+
<dl>
|
|
6197
|
+
<dd>
|
|
6198
|
+
|
|
6199
|
+
#### 🔌 Usage
|
|
6200
|
+
|
|
6201
|
+
<dl>
|
|
6202
|
+
<dd>
|
|
6203
|
+
|
|
6204
|
+
<dl>
|
|
6205
|
+
<dd>
|
|
6206
|
+
|
|
6207
|
+
```ruby
|
|
6208
|
+
client.documents.layers.delete(
|
|
6209
|
+
tenant_id: "tenantId",
|
|
6210
|
+
id: "id",
|
|
6211
|
+
layer_name: "layerName"
|
|
6212
|
+
)
|
|
6213
|
+
```
|
|
6214
|
+
</dd>
|
|
6215
|
+
</dl>
|
|
6216
|
+
</dd>
|
|
6217
|
+
</dl>
|
|
6218
|
+
|
|
6219
|
+
#### ⚙️ Parameters
|
|
6220
|
+
|
|
6221
|
+
<dl>
|
|
6222
|
+
<dd>
|
|
6223
|
+
|
|
6224
|
+
<dl>
|
|
6225
|
+
<dd>
|
|
6226
|
+
|
|
6227
|
+
**tenant_id:** `String`
|
|
6228
|
+
|
|
6229
|
+
</dd>
|
|
6230
|
+
</dl>
|
|
6231
|
+
|
|
6232
|
+
<dl>
|
|
6233
|
+
<dd>
|
|
6234
|
+
|
|
6235
|
+
**id:** `String`
|
|
6236
|
+
|
|
6237
|
+
</dd>
|
|
6238
|
+
</dl>
|
|
6239
|
+
|
|
6240
|
+
<dl>
|
|
6241
|
+
<dd>
|
|
6242
|
+
|
|
6243
|
+
**layer_name:** `String`
|
|
6244
|
+
|
|
6245
|
+
</dd>
|
|
6246
|
+
</dl>
|
|
6247
|
+
|
|
6248
|
+
<dl>
|
|
6249
|
+
<dd>
|
|
6250
|
+
|
|
6251
|
+
**request_options:** `CloudPDF::Documents::Layers::RequestOptions`
|
|
6252
|
+
|
|
6253
|
+
</dd>
|
|
6254
|
+
</dl>
|
|
6255
|
+
</dd>
|
|
6256
|
+
</dl>
|
|
6257
|
+
|
|
6258
|
+
|
|
6259
|
+
</dd>
|
|
6260
|
+
</dl>
|
|
6261
|
+
</details>
|
|
6262
|
+
|
|
6263
|
+
## Shares Visitors
|
|
6264
|
+
<details><summary><code>client.shares.visitors.<a href="/lib/CloudPDF/shares/visitors/client.rb">list</a>(tenant_id:, share_id:) -> CloudPDF::Types::SharesVisitorsList200Response</code></summary>
|
|
6265
|
+
<dl>
|
|
6266
|
+
<dd>
|
|
6267
|
+
|
|
6268
|
+
#### 📝 Description
|
|
6269
|
+
|
|
6270
|
+
<dl>
|
|
6271
|
+
<dd>
|
|
6272
|
+
|
|
6273
|
+
<dl>
|
|
6274
|
+
<dd>
|
|
6275
|
+
|
|
6276
|
+
An archived link's visitors are listed too.
|
|
6277
|
+
</dd>
|
|
6278
|
+
</dl>
|
|
6279
|
+
</dd>
|
|
6280
|
+
</dl>
|
|
6281
|
+
|
|
6282
|
+
#### 🔌 Usage
|
|
6283
|
+
|
|
6284
|
+
<dl>
|
|
6285
|
+
<dd>
|
|
6286
|
+
|
|
6287
|
+
<dl>
|
|
6288
|
+
<dd>
|
|
6289
|
+
|
|
6290
|
+
```ruby
|
|
6291
|
+
client.shares.visitors.list(
|
|
6292
|
+
tenant_id: "tenantId",
|
|
6293
|
+
share_id: "shareId"
|
|
6294
|
+
)
|
|
6295
|
+
```
|
|
6296
|
+
</dd>
|
|
6297
|
+
</dl>
|
|
6298
|
+
</dd>
|
|
6299
|
+
</dl>
|
|
6300
|
+
|
|
6301
|
+
#### ⚙️ Parameters
|
|
6302
|
+
|
|
6303
|
+
<dl>
|
|
6304
|
+
<dd>
|
|
6305
|
+
|
|
6306
|
+
<dl>
|
|
6307
|
+
<dd>
|
|
6308
|
+
|
|
6309
|
+
**tenant_id:** `String`
|
|
6310
|
+
|
|
6311
|
+
</dd>
|
|
6312
|
+
</dl>
|
|
6313
|
+
|
|
6314
|
+
<dl>
|
|
6315
|
+
<dd>
|
|
6316
|
+
|
|
6317
|
+
**share_id:** `String`
|
|
6318
|
+
|
|
6319
|
+
</dd>
|
|
6320
|
+
</dl>
|
|
6321
|
+
|
|
6322
|
+
<dl>
|
|
6323
|
+
<dd>
|
|
6324
|
+
|
|
6325
|
+
**limit:** `Integer`
|
|
6326
|
+
|
|
6327
|
+
</dd>
|
|
6328
|
+
</dl>
|
|
6329
|
+
|
|
6330
|
+
<dl>
|
|
6331
|
+
<dd>
|
|
6332
|
+
|
|
6333
|
+
**cursor:** `String`
|
|
6334
|
+
|
|
6335
|
+
</dd>
|
|
6336
|
+
</dl>
|
|
6337
|
+
|
|
6338
|
+
<dl>
|
|
6339
|
+
<dd>
|
|
6340
|
+
|
|
6341
|
+
**request_options:** `CloudPDF::Shares::Visitors::RequestOptions`
|
|
6342
|
+
|
|
6343
|
+
</dd>
|
|
6344
|
+
</dl>
|
|
6345
|
+
</dd>
|
|
6346
|
+
</dl>
|
|
6347
|
+
|
|
6348
|
+
|
|
6349
|
+
</dd>
|
|
6350
|
+
</dl>
|
|
6351
|
+
</details>
|
|
6352
|
+
|
|
6353
|
+
<details><summary><code>client.shares.visitors.<a href="/lib/CloudPDF/shares/visitors/client.rb">delete</a>(tenant_id:, share_id:, visitor_id:) -> </code></summary>
|
|
6354
|
+
<dl>
|
|
6355
|
+
<dd>
|
|
6356
|
+
|
|
6357
|
+
#### 📝 Description
|
|
6358
|
+
|
|
6359
|
+
<dl>
|
|
6360
|
+
<dd>
|
|
6361
|
+
|
|
6362
|
+
<dl>
|
|
6363
|
+
<dd>
|
|
6364
|
+
|
|
6365
|
+
Their handle brings them back as a new visitor, who is asked again. Deleting a visitor already deleted changes nothing.
|
|
6366
|
+
</dd>
|
|
6367
|
+
</dl>
|
|
6368
|
+
</dd>
|
|
6369
|
+
</dl>
|
|
6370
|
+
|
|
6371
|
+
#### 🔌 Usage
|
|
6372
|
+
|
|
6373
|
+
<dl>
|
|
6374
|
+
<dd>
|
|
6375
|
+
|
|
6376
|
+
<dl>
|
|
6377
|
+
<dd>
|
|
6378
|
+
|
|
6379
|
+
```ruby
|
|
6380
|
+
client.shares.visitors.delete(
|
|
6381
|
+
tenant_id: "tenantId",
|
|
6382
|
+
share_id: "shareId",
|
|
6383
|
+
visitor_id: "visitorId"
|
|
6384
|
+
)
|
|
6385
|
+
```
|
|
6386
|
+
</dd>
|
|
6387
|
+
</dl>
|
|
6388
|
+
</dd>
|
|
6389
|
+
</dl>
|
|
6390
|
+
|
|
6391
|
+
#### ⚙️ Parameters
|
|
6392
|
+
|
|
6393
|
+
<dl>
|
|
6394
|
+
<dd>
|
|
6395
|
+
|
|
6396
|
+
<dl>
|
|
6397
|
+
<dd>
|
|
6398
|
+
|
|
6399
|
+
**tenant_id:** `String`
|
|
6400
|
+
|
|
6401
|
+
</dd>
|
|
6402
|
+
</dl>
|
|
6403
|
+
|
|
6404
|
+
<dl>
|
|
6405
|
+
<dd>
|
|
6406
|
+
|
|
6407
|
+
**share_id:** `String`
|
|
6408
|
+
|
|
6409
|
+
</dd>
|
|
6410
|
+
</dl>
|
|
6411
|
+
|
|
6412
|
+
<dl>
|
|
6413
|
+
<dd>
|
|
6414
|
+
|
|
6415
|
+
**visitor_id:** `String`
|
|
6416
|
+
|
|
6417
|
+
</dd>
|
|
6418
|
+
</dl>
|
|
6419
|
+
|
|
6420
|
+
<dl>
|
|
6421
|
+
<dd>
|
|
6422
|
+
|
|
6423
|
+
**request_options:** `CloudPDF::Shares::Visitors::RequestOptions`
|
|
6424
|
+
|
|
6425
|
+
</dd>
|
|
6426
|
+
</dl>
|
|
6427
|
+
</dd>
|
|
6428
|
+
</dl>
|
|
6429
|
+
|
|
6430
|
+
|
|
6431
|
+
</dd>
|
|
6432
|
+
</dl>
|
|
6433
|
+
</details>
|
|
6434
|
+
|