aspose_pdf_cloud 18.11.0 → 19.1.0
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/LICENSE +1 -1
- data/README.md +66 -6
- data/aspose_pdf_cloud.gemspec +1 -1
- data/docs/Annotation.md +3 -2
- data/docs/AnnotationFlags.md +14 -14
- data/docs/AnnotationInfo.md +3 -2
- data/docs/AnnotationState.md +11 -11
- data/docs/AnnotationType.md +31 -31
- data/docs/AnnotationsInfo.md +3 -3
- data/docs/AnnotationsInfoResponse.md +3 -3
- data/docs/AntialiasingProcessingType.md +5 -5
- data/docs/AppendDocument.md +1 -1
- data/docs/AsposeResponse.md +1 -1
- data/docs/Attachment.md +1 -1
- data/docs/AttachmentResponse.md +3 -3
- data/docs/Attachments.md +3 -3
- data/docs/AttachmentsResponse.md +3 -3
- data/docs/CapStyle.md +5 -5
- data/docs/CaptionPosition.md +6 -6
- data/docs/CaretAnnotation.md +4 -4
- data/docs/CaretAnnotationResponse.md +3 -3
- data/docs/CaretAnnotations.md +3 -3
- data/docs/CaretAnnotationsResponse.md +3 -3
- data/docs/CaretSymbol.md +5 -5
- data/docs/CircleAnnotation.md +4 -4
- data/docs/CircleAnnotationResponse.md +3 -3
- data/docs/CircleAnnotations.md +3 -3
- data/docs/CircleAnnotationsResponse.md +3 -3
- data/docs/Color.md +5 -5
- data/docs/ColorDepth.md +7 -7
- data/docs/CommonFigureAnnotation.md +4 -3
- data/docs/CompressionType.md +8 -8
- data/docs/DiscUsage.md +10 -0
- data/docs/DiscUsageResponse.md +11 -0
- data/docs/DocFormat.md +5 -5
- data/docs/DocRecognitionMode.md +5 -5
- data/docs/Document.md +1 -1
- data/docs/DocumentPageResponse.md +3 -3
- data/docs/DocumentPagesResponse.md +3 -3
- data/docs/DocumentPrivilege.md +1 -1
- data/docs/DocumentProperties.md +3 -3
- data/docs/DocumentPropertiesResponse.md +3 -3
- data/docs/DocumentProperty.md +4 -4
- data/docs/DocumentPropertyResponse.md +3 -3
- data/docs/DocumentResponse.md +4 -4
- data/docs/EpubRecognitionMode.md +6 -6
- data/docs/Field.md +2 -2
- data/docs/FieldResponse.md +3 -3
- data/docs/FieldType.md +7 -7
- data/docs/Fields.md +3 -3
- data/docs/FieldsResponse.md +3 -3
- data/docs/File.md +1 -1
- data/docs/FileAttachmentAnnotation.md +29 -0
- data/docs/FileAttachmentAnnotationResponse.md +11 -0
- data/docs/FileAttachmentAnnotations.md +10 -0
- data/docs/FileAttachmentAnnotationsResponse.md +11 -0
- data/docs/FileExist.md +10 -0
- data/docs/FileExistResponse.md +11 -0
- data/docs/FileIcon.md +13 -0
- data/docs/FileVersion.md +15 -0
- data/docs/FileVersionsResponse.md +11 -0
- data/docs/FilesResponse.md +1 -1
- data/docs/FontEncodingRules.md +5 -5
- data/docs/FontSavingModes.md +7 -7
- data/docs/FontStyles.md +7 -7
- data/docs/FreeTextAnnotation.md +3 -2
- data/docs/FreeTextAnnotationResponse.md +3 -3
- data/docs/FreeTextAnnotations.md +3 -3
- data/docs/FreeTextAnnotationsResponse.md +3 -3
- data/docs/FreeTextIntent.md +6 -6
- data/docs/HighlightAnnotation.md +3 -3
- data/docs/HighlightAnnotationResponse.md +3 -3
- data/docs/HighlightAnnotations.md +3 -3
- data/docs/HighlightAnnotationsResponse.md +3 -3
- data/docs/HorizontalAlignment.md +8 -8
- data/docs/HtmlDocumentType.md +5 -5
- data/docs/HtmlMarkupGenerationModes.md +5 -5
- data/docs/Image.md +2 -2
- data/docs/ImageResponse.md +3 -3
- data/docs/ImageSrcType.md +5 -5
- data/docs/ImageTemplate.md +1 -1
- data/docs/ImageTemplatesRequest.md +1 -1
- data/docs/Images.md +3 -3
- data/docs/ImagesResponse.md +3 -3
- data/docs/InkAnnotation.md +3 -3
- data/docs/InkAnnotationResponse.md +3 -3
- data/docs/InkAnnotations.md +3 -3
- data/docs/InkAnnotationsResponse.md +3 -3
- data/docs/Justification.md +7 -7
- data/docs/LettersPositioningMethods.md +5 -5
- data/docs/LineAnnotation.md +3 -3
- data/docs/LineAnnotationResponse.md +3 -3
- data/docs/LineAnnotations.md +3 -3
- data/docs/LineAnnotationsResponse.md +3 -3
- data/docs/LineEnding.md +13 -13
- data/docs/LineIntent.md +6 -6
- data/docs/LineSpacing.md +6 -6
- data/docs/Link.md +1 -1
- data/docs/LinkActionType.md +9 -9
- data/docs/LinkAnnotation.md +2 -2
- data/docs/LinkAnnotationResponse.md +3 -3
- data/docs/LinkAnnotations.md +3 -3
- data/docs/LinkAnnotationsResponse.md +3 -3
- data/docs/LinkElement.md +1 -1
- data/docs/LinkHighlightingMode.md +9 -9
- data/docs/MarginInfo.md +1 -1
- data/docs/MarkupAnnotation.md +3 -2
- data/docs/MergeDocuments.md +1 -1
- data/docs/MovieAnnotation.md +23 -0
- data/docs/MovieAnnotationResponse.md +11 -0
- data/docs/MovieAnnotations.md +10 -0
- data/docs/MovieAnnotationsResponse.md +11 -0
- data/docs/OptimizeOptions.md +1 -1
- data/docs/Page.md +3 -3
- data/docs/PageWordCount.md +1 -1
- data/docs/Pages.md +3 -3
- data/docs/Paragraph.md +14 -14
- data/docs/PartsEmbeddingModes.md +6 -6
- data/docs/PdfAType.md +5 -5
- data/docs/PdfApi.md +909 -28
- data/docs/Point.md +1 -1
- data/docs/PolyAnnotation.md +4 -3
- data/docs/PolyIntent.md +7 -7
- data/docs/PolyLineAnnotation.md +4 -4
- data/docs/PolyLineAnnotationResponse.md +3 -3
- data/docs/PolyLineAnnotations.md +3 -3
- data/docs/PolyLineAnnotationsResponse.md +3 -3
- data/docs/PolygonAnnotation.md +4 -4
- data/docs/PolygonAnnotationResponse.md +3 -3
- data/docs/PolygonAnnotations.md +3 -3
- data/docs/PolygonAnnotationsResponse.md +3 -3
- data/docs/PopupAnnotation.md +3 -3
- data/docs/PopupAnnotationResponse.md +3 -3
- data/docs/PopupAnnotationWithParent.md +3 -3
- data/docs/PopupAnnotations.md +3 -3
- data/docs/PopupAnnotationsResponse.md +3 -3
- data/docs/RasterImagesSavingModes.md +6 -6
- data/docs/Rectangle.md +12 -0
- data/docs/RedactionAnnotation.md +26 -0
- data/docs/RedactionAnnotationResponse.md +11 -0
- data/docs/RedactionAnnotations.md +10 -0
- data/docs/RedactionAnnotationsResponse.md +11 -0
- data/docs/Rotation.md +7 -7
- data/docs/Segment.md +4 -4
- data/docs/ShapeType.md +6 -6
- data/docs/Signature.md +3 -3
- data/docs/SignatureType.md +7 -7
- data/docs/SignatureVerifyResponse.md +3 -3
- data/docs/SoundAnnotation.md +30 -0
- data/docs/SoundAnnotationResponse.md +11 -0
- data/docs/SoundAnnotations.md +10 -0
- data/docs/SoundAnnotationsResponse.md +11 -0
- data/docs/SoundEncoding.md +13 -0
- data/docs/SoundIcon.md +11 -0
- data/docs/SplitResult.md +1 -1
- data/docs/SplitResultDocument.md +1 -1
- data/docs/SplitResultResponse.md +3 -3
- data/docs/SquareAnnotation.md +4 -4
- data/docs/SquareAnnotationResponse.md +3 -3
- data/docs/SquareAnnotations.md +3 -3
- data/docs/SquareAnnotationsResponse.md +3 -3
- data/docs/SquigglyAnnotation.md +3 -3
- data/docs/SquigglyAnnotationResponse.md +3 -3
- data/docs/SquigglyAnnotations.md +3 -3
- data/docs/SquigglyAnnotationsResponse.md +3 -3
- data/docs/Stamp.md +1 -1
- data/docs/StampType.md +7 -7
- data/docs/StorageExistResponse.md +11 -0
- data/docs/StrikeOutAnnotation.md +3 -3
- data/docs/StrikeOutAnnotationResponse.md +3 -3
- data/docs/StrikeOutAnnotations.md +3 -3
- data/docs/StrikeOutAnnotationsResponse.md +3 -3
- data/docs/TextAnnotation.md +3 -3
- data/docs/TextAnnotationResponse.md +3 -3
- data/docs/TextAnnotations.md +3 -3
- data/docs/TextAnnotationsResponse.md +3 -3
- data/docs/TextHorizontalAlignment.md +10 -10
- data/docs/TextIcon.md +14 -14
- data/docs/TextLine.md +2 -2
- data/docs/TextRect.md +5 -5
- data/docs/TextRects.md +3 -3
- data/docs/TextRectsResponse.md +3 -3
- data/docs/TextReplace.md +2 -2
- data/docs/TextReplaceListRequest.md +3 -3
- data/docs/TextReplaceResponse.md +3 -3
- data/docs/TextState.md +1 -1
- data/docs/TextStyle.md +1 -1
- data/docs/UnderlineAnnotation.md +3 -3
- data/docs/UnderlineAnnotationResponse.md +3 -3
- data/docs/UnderlineAnnotations.md +3 -3
- data/docs/UnderlineAnnotationsResponse.md +3 -3
- data/docs/VerticalAlignment.md +7 -7
- data/docs/WordCount.md +1 -1
- data/docs/WordCountResponse.md +1 -1
- data/docs/WrapMode.md +7 -7
- data/lib/aspose_pdf_cloud.rb +28 -2
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +4613 -1980
- data/lib/aspose_pdf_cloud/api_client.rb +1 -1
- data/lib/aspose_pdf_cloud/api_error.rb +1 -1
- data/lib/aspose_pdf_cloud/configuration.rb +1 -1
- data/lib/aspose_pdf_cloud/models/annotation.rb +13 -3
- data/lib/aspose_pdf_cloud/models/annotation_flags.rb +1 -1
- data/lib/aspose_pdf_cloud/models/annotation_info.rb +13 -3
- data/lib/aspose_pdf_cloud/models/annotation_state.rb +1 -1
- data/lib/aspose_pdf_cloud/models/annotation_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/annotations_info.rb +3 -2
- data/lib/aspose_pdf_cloud/models/annotations_info_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/antialiasing_processing_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/append_document.rb +1 -1
- data/lib/aspose_pdf_cloud/models/aspose_response.rb +1 -1
- data/lib/aspose_pdf_cloud/models/attachment.rb +1 -1
- data/lib/aspose_pdf_cloud/models/attachment_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/attachments.rb +3 -2
- data/lib/aspose_pdf_cloud/models/attachments_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/cap_style.rb +1 -1
- data/lib/aspose_pdf_cloud/models/caption_position.rb +1 -1
- data/lib/aspose_pdf_cloud/models/caret_annotation.rb +14 -14
- data/lib/aspose_pdf_cloud/models/caret_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/caret_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/caret_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/caret_symbol.rb +1 -1
- data/lib/aspose_pdf_cloud/models/circle_annotation.rb +16 -16
- data/lib/aspose_pdf_cloud/models/circle_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/circle_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/circle_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/color.rb +5 -1
- data/lib/aspose_pdf_cloud/models/color_depth.rb +1 -1
- data/lib/aspose_pdf_cloud/models/common_figure_annotation.rb +14 -4
- data/lib/aspose_pdf_cloud/models/compression_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/disc_usage.rb +219 -0
- data/lib/aspose_pdf_cloud/models/disc_usage_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/doc_format.rb +1 -1
- data/lib/aspose_pdf_cloud/models/doc_recognition_mode.rb +1 -1
- data/lib/aspose_pdf_cloud/models/document.rb +1 -1
- data/lib/aspose_pdf_cloud/models/document_page_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/document_pages_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/document_privilege.rb +1 -1
- data/lib/aspose_pdf_cloud/models/document_properties.rb +3 -2
- data/lib/aspose_pdf_cloud/models/document_properties_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/document_property.rb +4 -1
- data/lib/aspose_pdf_cloud/models/document_property_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/document_response.rb +4 -2
- data/lib/aspose_pdf_cloud/models/epub_recognition_mode.rb +1 -1
- data/lib/aspose_pdf_cloud/models/field.rb +2 -2
- data/lib/aspose_pdf_cloud/models/field_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/field_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/fields.rb +3 -2
- data/lib/aspose_pdf_cloud/models/fields_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/file.rb +1 -1
- data/lib/aspose_pdf_cloud/models/file_attachment_annotation.rb +405 -0
- data/lib/aspose_pdf_cloud/models/file_attachment_annotation_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/file_attachment_annotations.rb +215 -0
- data/lib/aspose_pdf_cloud/models/file_attachment_annotations_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/file_exist.rb +219 -0
- data/lib/aspose_pdf_cloud/models/file_exist_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/file_icon.rb +46 -0
- data/lib/aspose_pdf_cloud/models/file_version.rb +264 -0
- data/lib/aspose_pdf_cloud/models/file_versions_response.rb +227 -0
- data/lib/aspose_pdf_cloud/models/files_response.rb +1 -1
- data/lib/aspose_pdf_cloud/models/font_encoding_rules.rb +1 -1
- data/lib/aspose_pdf_cloud/models/font_saving_modes.rb +1 -1
- data/lib/aspose_pdf_cloud/models/font_styles.rb +1 -1
- data/lib/aspose_pdf_cloud/models/free_text_annotation.rb +13 -3
- data/lib/aspose_pdf_cloud/models/free_text_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/free_text_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/free_text_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/free_text_intent.rb +1 -1
- data/lib/aspose_pdf_cloud/models/highlight_annotation.rb +13 -13
- data/lib/aspose_pdf_cloud/models/highlight_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/highlight_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/highlight_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/horizontal_alignment.rb +1 -1
- data/lib/aspose_pdf_cloud/models/html_document_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/html_markup_generation_modes.rb +1 -1
- data/lib/aspose_pdf_cloud/models/image.rb +2 -2
- data/lib/aspose_pdf_cloud/models/image_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/image_src_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/image_template.rb +1 -1
- data/lib/aspose_pdf_cloud/models/image_templates_request.rb +1 -1
- data/lib/aspose_pdf_cloud/models/images.rb +3 -2
- data/lib/aspose_pdf_cloud/models/images_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/ink_annotation.rb +13 -13
- data/lib/aspose_pdf_cloud/models/ink_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/ink_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/ink_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/justification.rb +1 -1
- data/lib/aspose_pdf_cloud/models/letters_positioning_methods.rb +1 -1
- data/lib/aspose_pdf_cloud/models/line_annotation.rb +13 -13
- data/lib/aspose_pdf_cloud/models/line_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/line_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/line_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/line_ending.rb +1 -1
- data/lib/aspose_pdf_cloud/models/line_intent.rb +1 -1
- data/lib/aspose_pdf_cloud/models/line_spacing.rb +1 -1
- data/lib/aspose_pdf_cloud/models/link.rb +1 -1
- data/lib/aspose_pdf_cloud/models/link_action_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/link_annotation.rb +2 -2
- data/lib/aspose_pdf_cloud/models/link_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/link_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/link_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/link_element.rb +1 -1
- data/lib/aspose_pdf_cloud/models/link_highlighting_mode.rb +1 -1
- data/lib/aspose_pdf_cloud/models/margin_info.rb +1 -1
- data/lib/aspose_pdf_cloud/models/markup_annotation.rb +13 -3
- data/lib/aspose_pdf_cloud/models/merge_documents.rb +1 -1
- data/lib/aspose_pdf_cloud/models/movie_annotation.rb +345 -0
- data/lib/aspose_pdf_cloud/models/movie_annotation_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/movie_annotations.rb +215 -0
- data/lib/aspose_pdf_cloud/models/movie_annotations_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/optimize_options.rb +1 -1
- data/lib/aspose_pdf_cloud/models/page.rb +4 -2
- data/lib/aspose_pdf_cloud/models/page_word_count.rb +1 -1
- data/lib/aspose_pdf_cloud/models/pages.rb +3 -2
- data/lib/aspose_pdf_cloud/models/paragraph.rb +15 -3
- data/lib/aspose_pdf_cloud/models/parts_embedding_modes.rb +1 -1
- data/lib/aspose_pdf_cloud/models/pdf_a_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/point.rb +1 -1
- data/lib/aspose_pdf_cloud/models/poly_annotation.rb +14 -4
- data/lib/aspose_pdf_cloud/models/poly_intent.rb +1 -1
- data/lib/aspose_pdf_cloud/models/poly_line_annotation.rb +17 -17
- data/lib/aspose_pdf_cloud/models/poly_line_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/poly_line_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/poly_line_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/polygon_annotation.rb +17 -17
- data/lib/aspose_pdf_cloud/models/polygon_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/polygon_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/polygon_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/popup_annotation.rb +13 -13
- data/lib/aspose_pdf_cloud/models/popup_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/popup_annotation_with_parent.rb +13 -13
- data/lib/aspose_pdf_cloud/models/popup_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/popup_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/raster_images_saving_modes.rb +1 -1
- data/lib/aspose_pdf_cloud/models/{rectangle_pdf.rb → rectangle.rb} +6 -2
- data/lib/aspose_pdf_cloud/models/redaction_annotation.rb +377 -0
- data/lib/aspose_pdf_cloud/models/redaction_annotation_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/redaction_annotations.rb +215 -0
- data/lib/aspose_pdf_cloud/models/redaction_annotations_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/rotation.rb +1 -1
- data/lib/aspose_pdf_cloud/models/segment.rb +4 -2
- data/lib/aspose_pdf_cloud/models/shape_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/signature.rb +3 -3
- data/lib/aspose_pdf_cloud/models/signature_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/signature_verify_response.rb +3 -3
- data/lib/aspose_pdf_cloud/models/sound_annotation.rb +415 -0
- data/lib/aspose_pdf_cloud/models/sound_annotation_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/sound_annotations.rb +215 -0
- data/lib/aspose_pdf_cloud/models/sound_annotations_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/sound_encoding.rb +46 -0
- data/lib/aspose_pdf_cloud/models/sound_icon.rb +44 -0
- data/lib/aspose_pdf_cloud/models/split_result.rb +1 -1
- data/lib/aspose_pdf_cloud/models/split_result_document.rb +1 -1
- data/lib/aspose_pdf_cloud/models/split_result_response.rb +3 -3
- data/lib/aspose_pdf_cloud/models/square_annotation.rb +16 -16
- data/lib/aspose_pdf_cloud/models/square_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/square_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/square_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/squiggly_annotation.rb +13 -13
- data/lib/aspose_pdf_cloud/models/squiggly_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/squiggly_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/squiggly_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/stamp.rb +1 -1
- data/lib/aspose_pdf_cloud/models/stamp_type.rb +1 -1
- data/lib/aspose_pdf_cloud/models/storage_exist_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/strike_out_annotation.rb +13 -13
- data/lib/aspose_pdf_cloud/models/strike_out_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/strike_out_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/strike_out_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/text_annotation.rb +13 -13
- data/lib/aspose_pdf_cloud/models/text_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/text_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/text_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/text_horizontal_alignment.rb +1 -1
- data/lib/aspose_pdf_cloud/models/text_icon.rb +1 -1
- data/lib/aspose_pdf_cloud/models/text_line.rb +2 -2
- data/lib/aspose_pdf_cloud/models/text_rect.rb +6 -3
- data/lib/aspose_pdf_cloud/models/text_rects.rb +3 -2
- data/lib/aspose_pdf_cloud/models/text_rects_response.rb +10 -9
- data/lib/aspose_pdf_cloud/models/text_replace.rb +2 -2
- data/lib/aspose_pdf_cloud/models/text_replace_list_request.rb +3 -1
- data/lib/aspose_pdf_cloud/models/text_replace_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/text_state.rb +1 -1
- data/lib/aspose_pdf_cloud/models/text_style.rb +1 -1
- data/lib/aspose_pdf_cloud/models/underline_annotation.rb +13 -13
- data/lib/aspose_pdf_cloud/models/underline_annotation_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/underline_annotations.rb +3 -2
- data/lib/aspose_pdf_cloud/models/underline_annotations_response.rb +3 -2
- data/lib/aspose_pdf_cloud/models/vertical_alignment.rb +1 -1
- data/lib/aspose_pdf_cloud/models/word_count.rb +1 -1
- data/lib/aspose_pdf_cloud/models/word_count_response.rb +1 -1
- data/lib/aspose_pdf_cloud/models/wrap_mode.rb +1 -1
- data/lib/aspose_pdf_cloud/version.rb +2 -2
- data/test/pdf_tests.rb +595 -41
- data/test_data/PdfWithAnnotations.pdf +0 -0
- data/test_data/PdfWithAnnotations1.pdf +0 -0
- metadata +57 -4
- data/docs/RectanglePdf.md +0 -12
data/docs/PdfApi.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# AsposePdfCloud::PdfApi
|
|
1
|
+
# AsposePdfCloud::PdfApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.aspose.cloud/v2.0*
|
|
4
4
|
|
|
@@ -8,6 +8,8 @@ Method | HTTP request | Description
|
|
|
8
8
|
[**delete_document_annotations**](PdfApi.md#delete_document_annotations) | **DELETE** /pdf/\{name}/annotations | Delete all annotations from the document
|
|
9
9
|
[**delete_document_link_annotations**](PdfApi.md#delete_document_link_annotations) | **DELETE** /pdf/\{name}/links | Delete all link annotations from the document
|
|
10
10
|
[**delete_field**](PdfApi.md#delete_field) | **DELETE** /pdf/\{name}/fields/\{fieldName} | Delete document field by name.
|
|
11
|
+
[**delete_file**](PdfApi.md#delete_file) | **DELETE** /storage/file | Remove a specific file
|
|
12
|
+
[**delete_folder**](PdfApi.md#delete_folder) | **DELETE** /storage/folder | Remove a specific folder
|
|
11
13
|
[**delete_image**](PdfApi.md#delete_image) | **DELETE** /pdf/\{name}/images/\{imageId} | Delete image from document page.
|
|
12
14
|
[**delete_link_annotation**](PdfApi.md#delete_link_annotation) | **DELETE** /pdf/\{name}/links/\{linkId} | Delete document page link annotation by ID
|
|
13
15
|
[**delete_page**](PdfApi.md#delete_page) | **DELETE** /pdf/\{name}/pages/\{pageNumber} | Delete document page by its number.
|
|
@@ -17,6 +19,7 @@ Method | HTTP request | Description
|
|
|
17
19
|
[**delete_property**](PdfApi.md#delete_property) | **DELETE** /pdf/\{name}/documentproperties/\{propertyName} | Delete document property.
|
|
18
20
|
[**get_caret_annotation**](PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
|
|
19
21
|
[**get_circle_annotation**](PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID.
|
|
22
|
+
[**get_disc_usage**](PdfApi.md#get_disc_usage) | **GET** /storage/disc | Check the disk usage of the current account
|
|
20
23
|
[**get_document**](PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
|
|
21
24
|
[**get_document_annotations**](PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
|
|
22
25
|
[**get_document_attachment_by_index**](PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index.
|
|
@@ -24,16 +27,20 @@ Method | HTTP request | Description
|
|
|
24
27
|
[**get_document_bookmarks**](PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks | Read document bookmark/bookmarks (including children).
|
|
25
28
|
[**get_document_caret_annotations**](PdfApi.md#get_document_caret_annotations) | **GET** /pdf/\{name}/annotations/caret | Read document caret annotations.
|
|
26
29
|
[**get_document_circle_annotations**](PdfApi.md#get_document_circle_annotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations.
|
|
30
|
+
[**get_document_file_attachment_annotations**](PdfApi.md#get_document_file_attachment_annotations) | **GET** /pdf/\{name}/annotations/fileattachment | Read document FileAttachment annotations.
|
|
27
31
|
[**get_document_free_text_annotations**](PdfApi.md#get_document_free_text_annotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations.
|
|
28
32
|
[**get_document_highlight_annotations**](PdfApi.md#get_document_highlight_annotations) | **GET** /pdf/\{name}/annotations/highlight | Read document highlight annotations.
|
|
29
33
|
[**get_document_ink_annotations**](PdfApi.md#get_document_ink_annotations) | **GET** /pdf/\{name}/annotations/ink | Read document ink annotations.
|
|
30
34
|
[**get_document_line_annotations**](PdfApi.md#get_document_line_annotations) | **GET** /pdf/\{name}/annotations/line | Read document line annotations.
|
|
35
|
+
[**get_document_movie_annotations**](PdfApi.md#get_document_movie_annotations) | **GET** /pdf/\{name}/annotations/movie | Read document movie annotations.
|
|
31
36
|
[**get_document_poly_line_annotations**](PdfApi.md#get_document_poly_line_annotations) | **GET** /pdf/\{name}/annotations/polyline | Read document polyline annotations.
|
|
32
37
|
[**get_document_polygon_annotations**](PdfApi.md#get_document_polygon_annotations) | **GET** /pdf/\{name}/annotations/polygon | Read document polygon annotations.
|
|
33
38
|
[**get_document_popup_annotations**](PdfApi.md#get_document_popup_annotations) | **GET** /pdf/\{name}/annotations/popup | Read document popup annotations.
|
|
34
39
|
[**get_document_popup_annotations_by_parent**](PdfApi.md#get_document_popup_annotations_by_parent) | **GET** /pdf/\{name}/annotations/\{annotationId}/popup | Read document popup annotations by parent id.
|
|
35
40
|
[**get_document_properties**](PdfApi.md#get_document_properties) | **GET** /pdf/\{name}/documentproperties | Read document properties.
|
|
36
41
|
[**get_document_property**](PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name.
|
|
42
|
+
[**get_document_redaction_annotations**](PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations.
|
|
43
|
+
[**get_document_sound_annotations**](PdfApi.md#get_document_sound_annotations) | **GET** /pdf/\{name}/annotations/sound | Read document sound annotations.
|
|
37
44
|
[**get_document_square_annotations**](PdfApi.md#get_document_square_annotations) | **GET** /pdf/\{name}/annotations/square | Read document square annotations.
|
|
38
45
|
[**get_document_squiggly_annotations**](PdfApi.md#get_document_squiggly_annotations) | **GET** /pdf/\{name}/annotations/squiggly | Read document squiggly annotations.
|
|
39
46
|
[**get_document_strike_out_annotations**](PdfApi.md#get_document_strike_out_annotations) | **GET** /pdf/\{name}/annotations/strikeout | Read document StrikeOut annotations.
|
|
@@ -44,6 +51,8 @@ Method | HTTP request | Description
|
|
|
44
51
|
[**get_epub_in_storage_to_pdf**](PdfApi.md#get_epub_in_storage_to_pdf) | **GET** /pdf/create/epub | Convert EPUB file (located on storage) to PDF format and return resulting file in response.
|
|
45
52
|
[**get_field**](PdfApi.md#get_field) | **GET** /pdf/\{name}/fields/\{fieldName} | Get document field by name.
|
|
46
53
|
[**get_fields**](PdfApi.md#get_fields) | **GET** /pdf/\{name}/fields | Get document fields.
|
|
54
|
+
[**get_file_attachment_annotation**](PdfApi.md#get_file_attachment_annotation) | **GET** /pdf/\{name}/annotations/fileattachment/\{annotationId} | Read document page FileAttachment annotation by ID.
|
|
55
|
+
[**get_file_attachment_annotation_data**](PdfApi.md#get_file_attachment_annotation_data) | **GET** /pdf/\{name}/annotations/fileattachment/\{annotationId}/data | Read document page FileAttachment annotation by ID.
|
|
47
56
|
[**get_free_text_annotation**](PdfApi.md#get_free_text_annotation) | **GET** /pdf/\{name}/annotations/freetext/\{annotationId} | Read document page free text annotation by ID.
|
|
48
57
|
[**get_highlight_annotation**](PdfApi.md#get_highlight_annotation) | **GET** /pdf/\{name}/annotations/highlight/\{annotationId} | Read document page highlight annotation by ID.
|
|
49
58
|
[**get_html_in_storage_to_pdf**](PdfApi.md#get_html_in_storage_to_pdf) | **GET** /pdf/create/html | Convert HTML file (located on storage) to PDF format and return resulting file in response.
|
|
@@ -54,11 +63,15 @@ Method | HTTP request | Description
|
|
|
54
63
|
[**get_image_extract_as_tiff**](PdfApi.md#get_image_extract_as_tiff) | **GET** /pdf/\{name}/images/\{imageId}/extract/tiff | Extract document image in TIFF format
|
|
55
64
|
[**get_images**](PdfApi.md#get_images) | **GET** /pdf/\{name}/pages/\{pageNumber}/images | Read document images.
|
|
56
65
|
[**get_ink_annotation**](PdfApi.md#get_ink_annotation) | **GET** /pdf/\{name}/annotations/ink/\{annotationId} | Read document page ink annotation by ID.
|
|
66
|
+
[**get_is_exist**](PdfApi.md#get_is_exist) | **GET** /storage/exist | Check if a specific file or folder exists
|
|
67
|
+
[**get_is_storage_exist**](PdfApi.md#get_is_storage_exist) | **GET** /storage/\{name}/exist | Check if storage exists
|
|
57
68
|
[**get_la_te_x_in_storage_to_pdf**](PdfApi.md#get_la_te_x_in_storage_to_pdf) | **GET** /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
|
|
58
69
|
[**get_line_annotation**](PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID.
|
|
59
70
|
[**get_link_annotation**](PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID.
|
|
71
|
+
[**get_list_file_versions**](PdfApi.md#get_list_file_versions) | **GET** /storage/version | Get the file's versions list
|
|
60
72
|
[**get_list_files**](PdfApi.md#get_list_files) | **GET** /storage/folder | Get the file listing of a specific folder
|
|
61
73
|
[**get_mht_in_storage_to_pdf**](PdfApi.md#get_mht_in_storage_to_pdf) | **GET** /pdf/create/mht | Convert MHT file (located on storage) to PDF format and return resulting file in response.
|
|
74
|
+
[**get_movie_annotation**](PdfApi.md#get_movie_annotation) | **GET** /pdf/\{name}/annotations/movie/\{annotationId} | Read document page movie annotation by ID.
|
|
62
75
|
[**get_page**](PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info.
|
|
63
76
|
[**get_page_annotations**](PdfApi.md#get_page_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
|
|
64
77
|
[**get_page_caret_annotations**](PdfApi.md#get_page_caret_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Read document page caret annotations.
|
|
@@ -69,15 +82,19 @@ Method | HTTP request | Description
|
|
|
69
82
|
[**get_page_convert_to_jpeg**](PdfApi.md#get_page_convert_to_jpeg) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/jpeg | Convert document page to Jpeg image and return resulting file in response.
|
|
70
83
|
[**get_page_convert_to_png**](PdfApi.md#get_page_convert_to_png) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/png | Convert document page to Png image and return resulting file in response.
|
|
71
84
|
[**get_page_convert_to_tiff**](PdfApi.md#get_page_convert_to_tiff) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/tiff | Convert document page to Tiff image and return resulting file in response.
|
|
85
|
+
[**get_page_file_attachment_annotations**](PdfApi.md#get_page_file_attachment_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/fileattachment | Read document page FileAttachment annotations.
|
|
72
86
|
[**get_page_free_text_annotations**](PdfApi.md#get_page_free_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Read document page free text annotations.
|
|
73
87
|
[**get_page_highlight_annotations**](PdfApi.md#get_page_highlight_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/highlight | Read document page highlight annotations.
|
|
74
88
|
[**get_page_ink_annotations**](PdfApi.md#get_page_ink_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/ink | Read document page ink annotations.
|
|
75
89
|
[**get_page_line_annotations**](PdfApi.md#get_page_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Read document page line annotations.
|
|
76
90
|
[**get_page_link_annotation**](PdfApi.md#get_page_link_annotation) | **GET** /pdf/\{name}/pages/\{pageNumber}/links/\{linkId} | Read document page link annotation by ID.
|
|
77
91
|
[**get_page_link_annotations**](PdfApi.md#get_page_link_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/links | Read document page link annotations.
|
|
92
|
+
[**get_page_movie_annotations**](PdfApi.md#get_page_movie_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/movie | Read document page movie annotations.
|
|
78
93
|
[**get_page_poly_line_annotations**](PdfApi.md#get_page_poly_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Read document page polyline annotations.
|
|
79
94
|
[**get_page_polygon_annotations**](PdfApi.md#get_page_polygon_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Read document page polygon annotations.
|
|
80
95
|
[**get_page_popup_annotations**](PdfApi.md#get_page_popup_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/popup | Read document page popup annotations.
|
|
96
|
+
[**get_page_redaction_annotations**](PdfApi.md#get_page_redaction_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Read document page redaction annotations.
|
|
97
|
+
[**get_page_sound_annotations**](PdfApi.md#get_page_sound_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Read document page sound annotations.
|
|
81
98
|
[**get_page_square_annotations**](PdfApi.md#get_page_square_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Read document page square annotations.
|
|
82
99
|
[**get_page_squiggly_annotations**](PdfApi.md#get_page_squiggly_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Read document page squiggly annotations.
|
|
83
100
|
[**get_page_strike_out_annotations**](PdfApi.md#get_page_strike_out_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Read document page StrikeOut annotations.
|
|
@@ -102,6 +119,9 @@ Method | HTTP request | Description
|
|
|
102
119
|
[**get_polygon_annotation**](PdfApi.md#get_polygon_annotation) | **GET** /pdf/\{name}/annotations/polygon/\{annotationId} | Read document page polygon annotation by ID.
|
|
103
120
|
[**get_popup_annotation**](PdfApi.md#get_popup_annotation) | **GET** /pdf/\{name}/annotations/popup/\{annotationId} | Read document page popup annotation by ID.
|
|
104
121
|
[**get_ps_in_storage_to_pdf**](PdfApi.md#get_ps_in_storage_to_pdf) | **GET** /pdf/create/ps | Convert PS file (located on storage) to PDF format and return resulting file in response.
|
|
122
|
+
[**get_redaction_annotation**](PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID.
|
|
123
|
+
[**get_sound_annotation**](PdfApi.md#get_sound_annotation) | **GET** /pdf/\{name}/annotations/sound/\{annotationId} | Read document page sound annotation by ID.
|
|
124
|
+
[**get_sound_annotation_data**](PdfApi.md#get_sound_annotation_data) | **GET** /pdf/\{name}/annotations/sound/\{annotationId}/data | Read document page sound annotation by ID.
|
|
105
125
|
[**get_square_annotation**](PdfApi.md#get_square_annotation) | **GET** /pdf/\{name}/annotations/square/\{annotationId} | Read document page square annotation by ID.
|
|
106
126
|
[**get_squiggly_annotation**](PdfApi.md#get_squiggly_annotation) | **GET** /pdf/\{name}/annotations/squiggly/\{annotationId} | Read document page squiggly annotation by ID.
|
|
107
127
|
[**get_strike_out_annotation**](PdfApi.md#get_strike_out_annotation) | **GET** /pdf/\{name}/annotations/strikeout/\{annotationId} | Read document page StrikeOut annotation by ID.
|
|
@@ -119,18 +139,25 @@ Method | HTTP request | Description
|
|
|
119
139
|
[**post_append_document**](PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one.
|
|
120
140
|
[**post_create_field**](PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field.
|
|
121
141
|
[**post_document_text_replace**](PdfApi.md#post_document_text_replace) | **POST** /pdf/\{name}/text/replace | Document's replace text method.
|
|
142
|
+
[**post_flatten_document**](PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Flatten the document.
|
|
122
143
|
[**post_insert_image**](PdfApi.md#post_insert_image) | **POST** /pdf/\{name}/pages/\{pageNumber}/images | Insert image to document page.
|
|
144
|
+
[**post_move_file**](PdfApi.md#post_move_file) | **POST** /storage/file | Move a specific file
|
|
145
|
+
[**post_move_folder**](PdfApi.md#post_move_folder) | **POST** /storage/folder | Move a specific folder
|
|
123
146
|
[**post_move_page**](PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
|
|
124
147
|
[**post_optimize_document**](PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document.
|
|
125
148
|
[**post_page_caret_annotations**](PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
|
|
126
149
|
[**post_page_circle_annotations**](PdfApi.md#post_page_circle_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Add document page circle annotations.
|
|
150
|
+
[**post_page_file_attachment_annotations**](PdfApi.md#post_page_file_attachment_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/fileattachment | Add document page FileAttachment annotations.
|
|
127
151
|
[**post_page_free_text_annotations**](PdfApi.md#post_page_free_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Add document page free text annotations.
|
|
128
152
|
[**post_page_highlight_annotations**](PdfApi.md#post_page_highlight_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/highlight | Add document page highlight annotations.
|
|
129
153
|
[**post_page_ink_annotations**](PdfApi.md#post_page_ink_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/ink | Add document page ink annotations.
|
|
130
154
|
[**post_page_line_annotations**](PdfApi.md#post_page_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Add document page line annotations.
|
|
131
155
|
[**post_page_link_annotations**](PdfApi.md#post_page_link_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/links | Add document page link annotations.
|
|
156
|
+
[**post_page_movie_annotations**](PdfApi.md#post_page_movie_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/movie | Add document page movie annotations.
|
|
132
157
|
[**post_page_poly_line_annotations**](PdfApi.md#post_page_poly_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Add document page polyline annotations.
|
|
133
158
|
[**post_page_polygon_annotations**](PdfApi.md#post_page_polygon_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Add document page polygon annotations.
|
|
159
|
+
[**post_page_redaction_annotations**](PdfApi.md#post_page_redaction_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Add document page redaction annotations.
|
|
160
|
+
[**post_page_sound_annotations**](PdfApi.md#post_page_sound_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Add document page sound annotations.
|
|
134
161
|
[**post_page_square_annotations**](PdfApi.md#post_page_square_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Add document page square annotations.
|
|
135
162
|
[**post_page_squiggly_annotations**](PdfApi.md#post_page_squiggly_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Add document page squiggly annotations.
|
|
136
163
|
[**post_page_strike_out_annotations**](PdfApi.md#post_page_strike_out_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Add document page StrikeOut annotations.
|
|
@@ -147,8 +174,11 @@ Method | HTTP request | Description
|
|
|
147
174
|
[**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
|
|
148
175
|
[**put_create**](PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file
|
|
149
176
|
[**put_create_document**](PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
|
|
177
|
+
[**put_create_folder**](PdfApi.md#put_create_folder) | **PUT** /storage/folder | Create the folder
|
|
150
178
|
[**put_epub_in_storage_to_pdf**](PdfApi.md#put_epub_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/epub | Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
|
|
151
179
|
[**put_fields_flatten**](PdfApi.md#put_fields_flatten) | **PUT** /pdf/\{name}/fields/flatten | Flatten form fields in document.
|
|
180
|
+
[**put_file_attachment_annotation**](PdfApi.md#put_file_attachment_annotation) | **PUT** /pdf/\{name}/annotations/fileattachment/\{annotationId} | Replace document FileAttachment annotation
|
|
181
|
+
[**put_file_attachment_annotation_data_extract**](PdfApi.md#put_file_attachment_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/fileattachment/\{annotationId}/data/extract | Extract document FileAttachment annotation content to storage
|
|
152
182
|
[**put_free_text_annotation**](PdfApi.md#put_free_text_annotation) | **PUT** /pdf/\{name}/annotations/freetext/\{annotationId} | Replace document free text annotation
|
|
153
183
|
[**put_highlight_annotation**](PdfApi.md#put_highlight_annotation) | **PUT** /pdf/\{name}/annotations/highlight/\{annotationId} | Replace document highlight annotation
|
|
154
184
|
[**put_html_in_storage_to_pdf**](PdfApi.md#put_html_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/html | Convert HTML file (located on storage) to PDF format and upload resulting file to storage.
|
|
@@ -167,6 +197,7 @@ Method | HTTP request | Description
|
|
|
167
197
|
[**put_link_annotation**](PdfApi.md#put_link_annotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations
|
|
168
198
|
[**put_merge_documents**](PdfApi.md#put_merge_documents) | **PUT** /pdf/\{name}/merge | Merge a list of documents.
|
|
169
199
|
[**put_mht_in_storage_to_pdf**](PdfApi.md#put_mht_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/mht | Convert MHT file (located on storage) to PDF format and upload resulting file to storage.
|
|
200
|
+
[**put_movie_annotation**](PdfApi.md#put_movie_annotation) | **PUT** /pdf/\{name}/annotations/movie/\{annotationId} | Replace document movie annotation
|
|
170
201
|
[**put_page_add_stamp**](PdfApi.md#put_page_add_stamp) | **PUT** /pdf/\{name}/pages/\{pageNumber}/stamp | Add page stamp.
|
|
171
202
|
[**put_page_convert_to_bmp**](PdfApi.md#put_page_convert_to_bmp) | **PUT** /pdf/\{name}/pages/\{pageNumber}/convert/bmp | Convert document page to bmp image and upload resulting file to storage.
|
|
172
203
|
[**put_page_convert_to_emf**](PdfApi.md#put_page_convert_to_emf) | **PUT** /pdf/\{name}/pages/\{pageNumber}/convert/emf | Convert document page to emf image and upload resulting file to storage.
|
|
@@ -204,9 +235,12 @@ Method | HTTP request | Description
|
|
|
204
235
|
[**put_popup_annotation**](PdfApi.md#put_popup_annotation) | **PUT** /pdf/\{name}/annotations/popup/\{annotationId} | Replace document popup annotation
|
|
205
236
|
[**put_privileges**](PdfApi.md#put_privileges) | **PUT** /pdf/\{name}/privileges | Update privilege document.
|
|
206
237
|
[**put_ps_in_storage_to_pdf**](PdfApi.md#put_ps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/ps | Convert PS file (located on storage) to PDF format and upload resulting file to storage.
|
|
238
|
+
[**put_redaction_annotation**](PdfApi.md#put_redaction_annotation) | **PUT** /pdf/\{name}/annotations/redaction/\{annotationId} | Replace document redaction annotation
|
|
207
239
|
[**put_replace_image**](PdfApi.md#put_replace_image) | **PUT** /pdf/\{name}/images/\{imageId} | Replace document image.
|
|
208
240
|
[**put_searchable_document**](PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document.
|
|
209
241
|
[**put_set_property**](PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property.
|
|
242
|
+
[**put_sound_annotation**](PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation
|
|
243
|
+
[**put_sound_annotation_data_extract**](PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage
|
|
210
244
|
[**put_square_annotation**](PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation
|
|
211
245
|
[**put_squiggly_annotation**](PdfApi.md#put_squiggly_annotation) | **PUT** /pdf/\{name}/annotations/squiggly/\{annotationId} | Replace document squiggly annotation
|
|
212
246
|
[**put_strike_out_annotation**](PdfApi.md#put_strike_out_annotation) | **PUT** /pdf/\{name}/annotations/strikeout/\{annotationId} | Replace document StrikeOut annotation
|
|
@@ -321,6 +355,54 @@ Name | Type | Description | Notes
|
|
|
321
355
|
|
|
322
356
|
|
|
323
357
|
|
|
358
|
+
# **delete_file**
|
|
359
|
+
> AsposeResponse delete_file(path, opts)
|
|
360
|
+
|
|
361
|
+
Remove a specific file
|
|
362
|
+
|
|
363
|
+
### Parameters
|
|
364
|
+
|
|
365
|
+
Name | Type | Description | Notes
|
|
366
|
+
------------- | ------------- | ------------- | -------------
|
|
367
|
+
**path** | **String**| Path of the file including file name and extension e.g. /Folder1/file.ext |
|
|
368
|
+
**version_id** | **String**| File's version | [optional]
|
|
369
|
+
**storage** | **String**| User's storage name | [optional]
|
|
370
|
+
|
|
371
|
+
### Return type
|
|
372
|
+
|
|
373
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
374
|
+
|
|
375
|
+
### HTTP request headers
|
|
376
|
+
|
|
377
|
+
- **Content-Type**: application/json
|
|
378
|
+
- **Accept**: application/json
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
# **delete_folder**
|
|
383
|
+
> AsposeResponse delete_folder(path, opts)
|
|
384
|
+
|
|
385
|
+
Remove a specific folder
|
|
386
|
+
|
|
387
|
+
### Parameters
|
|
388
|
+
|
|
389
|
+
Name | Type | Description | Notes
|
|
390
|
+
------------- | ------------- | ------------- | -------------
|
|
391
|
+
**path** | **String**| Folder path e.g. /Folder1 |
|
|
392
|
+
**storage** | **String**| User's storage name | [optional]
|
|
393
|
+
**recursive** | **BOOLEAN**| Remove recursivelly inner folder/files. If false and folder contains data than exception is raised. | [optional] [default to false]
|
|
394
|
+
|
|
395
|
+
### Return type
|
|
396
|
+
|
|
397
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
398
|
+
|
|
399
|
+
### HTTP request headers
|
|
400
|
+
|
|
401
|
+
- **Content-Type**: application/json
|
|
402
|
+
- **Accept**: application/json
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
324
406
|
# **delete_image**
|
|
325
407
|
> AsposeResponse delete_image(name, image_id, opts)
|
|
326
408
|
|
|
@@ -545,6 +627,28 @@ Name | Type | Description | Notes
|
|
|
545
627
|
|
|
546
628
|
|
|
547
629
|
|
|
630
|
+
# **get_disc_usage**
|
|
631
|
+
> DiscUsageResponse get_disc_usage(opts)
|
|
632
|
+
|
|
633
|
+
Check the disk usage of the current account
|
|
634
|
+
|
|
635
|
+
### Parameters
|
|
636
|
+
|
|
637
|
+
Name | Type | Description | Notes
|
|
638
|
+
------------- | ------------- | ------------- | -------------
|
|
639
|
+
**storage** | **String**| User's storage name | [optional]
|
|
640
|
+
|
|
641
|
+
### Return type
|
|
642
|
+
|
|
643
|
+
[**DiscUsageResponse**](DiscUsageResponse.md)
|
|
644
|
+
|
|
645
|
+
### HTTP request headers
|
|
646
|
+
|
|
647
|
+
- **Content-Type**: application/json
|
|
648
|
+
- **Accept**: application/json
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
548
652
|
# **get_document**
|
|
549
653
|
> DocumentResponse get_document(name, opts)
|
|
550
654
|
|
|
@@ -715,6 +819,30 @@ Name | Type | Description | Notes
|
|
|
715
819
|
|
|
716
820
|
|
|
717
821
|
|
|
822
|
+
# **get_document_file_attachment_annotations**
|
|
823
|
+
> FileAttachmentAnnotationsResponse get_document_file_attachment_annotations(name, opts)
|
|
824
|
+
|
|
825
|
+
Read document FileAttachment annotations.
|
|
826
|
+
|
|
827
|
+
### Parameters
|
|
828
|
+
|
|
829
|
+
Name | Type | Description | Notes
|
|
830
|
+
------------- | ------------- | ------------- | -------------
|
|
831
|
+
**name** | **String**| The document name. |
|
|
832
|
+
**storage** | **String**| The document storage. | [optional]
|
|
833
|
+
**folder** | **String**| The document folder. | [optional]
|
|
834
|
+
|
|
835
|
+
### Return type
|
|
836
|
+
|
|
837
|
+
[**FileAttachmentAnnotationsResponse**](FileAttachmentAnnotationsResponse.md)
|
|
838
|
+
|
|
839
|
+
### HTTP request headers
|
|
840
|
+
|
|
841
|
+
- **Content-Type**: application/json
|
|
842
|
+
- **Accept**: application/json
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
718
846
|
# **get_document_free_text_annotations**
|
|
719
847
|
> FreeTextAnnotationsResponse get_document_free_text_annotations(name, opts)
|
|
720
848
|
|
|
@@ -811,6 +939,30 @@ Name | Type | Description | Notes
|
|
|
811
939
|
|
|
812
940
|
|
|
813
941
|
|
|
942
|
+
# **get_document_movie_annotations**
|
|
943
|
+
> MovieAnnotationsResponse get_document_movie_annotations(name, opts)
|
|
944
|
+
|
|
945
|
+
Read document movie annotations.
|
|
946
|
+
|
|
947
|
+
### Parameters
|
|
948
|
+
|
|
949
|
+
Name | Type | Description | Notes
|
|
950
|
+
------------- | ------------- | ------------- | -------------
|
|
951
|
+
**name** | **String**| The document name. |
|
|
952
|
+
**storage** | **String**| The document storage. | [optional]
|
|
953
|
+
**folder** | **String**| The document folder. | [optional]
|
|
954
|
+
|
|
955
|
+
### Return type
|
|
956
|
+
|
|
957
|
+
[**MovieAnnotationsResponse**](MovieAnnotationsResponse.md)
|
|
958
|
+
|
|
959
|
+
### HTTP request headers
|
|
960
|
+
|
|
961
|
+
- **Content-Type**: application/json
|
|
962
|
+
- **Accept**: application/json
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
814
966
|
# **get_document_poly_line_annotations**
|
|
815
967
|
> PolyLineAnnotationsResponse get_document_poly_line_annotations(name, opts)
|
|
816
968
|
|
|
@@ -957,6 +1109,54 @@ Name | Type | Description | Notes
|
|
|
957
1109
|
|
|
958
1110
|
|
|
959
1111
|
|
|
1112
|
+
# **get_document_redaction_annotations**
|
|
1113
|
+
> RedactionAnnotationsResponse get_document_redaction_annotations(name, opts)
|
|
1114
|
+
|
|
1115
|
+
Read document redaction annotations.
|
|
1116
|
+
|
|
1117
|
+
### Parameters
|
|
1118
|
+
|
|
1119
|
+
Name | Type | Description | Notes
|
|
1120
|
+
------------- | ------------- | ------------- | -------------
|
|
1121
|
+
**name** | **String**| The document name. |
|
|
1122
|
+
**storage** | **String**| The document storage. | [optional]
|
|
1123
|
+
**folder** | **String**| The document folder. | [optional]
|
|
1124
|
+
|
|
1125
|
+
### Return type
|
|
1126
|
+
|
|
1127
|
+
[**RedactionAnnotationsResponse**](RedactionAnnotationsResponse.md)
|
|
1128
|
+
|
|
1129
|
+
### HTTP request headers
|
|
1130
|
+
|
|
1131
|
+
- **Content-Type**: application/json
|
|
1132
|
+
- **Accept**: application/json
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
# **get_document_sound_annotations**
|
|
1137
|
+
> SoundAnnotationsResponse get_document_sound_annotations(name, opts)
|
|
1138
|
+
|
|
1139
|
+
Read document sound annotations.
|
|
1140
|
+
|
|
1141
|
+
### Parameters
|
|
1142
|
+
|
|
1143
|
+
Name | Type | Description | Notes
|
|
1144
|
+
------------- | ------------- | ------------- | -------------
|
|
1145
|
+
**name** | **String**| The document name. |
|
|
1146
|
+
**storage** | **String**| The document storage. | [optional]
|
|
1147
|
+
**folder** | **String**| The document folder. | [optional]
|
|
1148
|
+
|
|
1149
|
+
### Return type
|
|
1150
|
+
|
|
1151
|
+
[**SoundAnnotationsResponse**](SoundAnnotationsResponse.md)
|
|
1152
|
+
|
|
1153
|
+
### HTTP request headers
|
|
1154
|
+
|
|
1155
|
+
- **Content-Type**: application/json
|
|
1156
|
+
- **Accept**: application/json
|
|
1157
|
+
|
|
1158
|
+
|
|
1159
|
+
|
|
960
1160
|
# **get_document_square_annotations**
|
|
961
1161
|
> SquareAnnotationsResponse get_document_square_annotations(name, opts)
|
|
962
1162
|
|
|
@@ -1198,6 +1398,56 @@ Name | Type | Description | Notes
|
|
|
1198
1398
|
|
|
1199
1399
|
|
|
1200
1400
|
|
|
1401
|
+
# **get_file_attachment_annotation**
|
|
1402
|
+
> FileAttachmentAnnotationResponse get_file_attachment_annotation(name, annotation_id, opts)
|
|
1403
|
+
|
|
1404
|
+
Read document page FileAttachment annotation by ID.
|
|
1405
|
+
|
|
1406
|
+
### Parameters
|
|
1407
|
+
|
|
1408
|
+
Name | Type | Description | Notes
|
|
1409
|
+
------------- | ------------- | ------------- | -------------
|
|
1410
|
+
**name** | **String**| The document name. |
|
|
1411
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
1412
|
+
**storage** | **String**| The document storage. | [optional]
|
|
1413
|
+
**folder** | **String**| The document folder. | [optional]
|
|
1414
|
+
|
|
1415
|
+
### Return type
|
|
1416
|
+
|
|
1417
|
+
[**FileAttachmentAnnotationResponse**](FileAttachmentAnnotationResponse.md)
|
|
1418
|
+
|
|
1419
|
+
### HTTP request headers
|
|
1420
|
+
|
|
1421
|
+
- **Content-Type**: application/json
|
|
1422
|
+
- **Accept**: application/json
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
# **get_file_attachment_annotation_data**
|
|
1427
|
+
> File get_file_attachment_annotation_data(name, annotation_id, opts)
|
|
1428
|
+
|
|
1429
|
+
Read document page FileAttachment annotation by ID.
|
|
1430
|
+
|
|
1431
|
+
### Parameters
|
|
1432
|
+
|
|
1433
|
+
Name | Type | Description | Notes
|
|
1434
|
+
------------- | ------------- | ------------- | -------------
|
|
1435
|
+
**name** | **String**| The document name. |
|
|
1436
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
1437
|
+
**storage** | **String**| The document storage. | [optional]
|
|
1438
|
+
**folder** | **String**| The document folder. | [optional]
|
|
1439
|
+
|
|
1440
|
+
### Return type
|
|
1441
|
+
|
|
1442
|
+
**File**
|
|
1443
|
+
|
|
1444
|
+
### HTTP request headers
|
|
1445
|
+
|
|
1446
|
+
- **Content-Type**: application/json
|
|
1447
|
+
- **Accept**: application/json
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1201
1451
|
# **get_free_text_annotation**
|
|
1202
1452
|
> FreeTextAnnotationResponse get_free_text_annotation(name, annotation_id, opts)
|
|
1203
1453
|
|
|
@@ -1462,6 +1712,52 @@ Name | Type | Description | Notes
|
|
|
1462
1712
|
|
|
1463
1713
|
|
|
1464
1714
|
|
|
1715
|
+
# **get_is_exist**
|
|
1716
|
+
> FileExistResponse get_is_exist(path, opts)
|
|
1717
|
+
|
|
1718
|
+
Check if a specific file or folder exists
|
|
1719
|
+
|
|
1720
|
+
### Parameters
|
|
1721
|
+
|
|
1722
|
+
Name | Type | Description | Notes
|
|
1723
|
+
------------- | ------------- | ------------- | -------------
|
|
1724
|
+
**path** | **String**| File or folder path e.g. /file.ext or /Folder1 |
|
|
1725
|
+
**version_id** | **String**| File's version | [optional]
|
|
1726
|
+
**storage** | **String**| User's storage name | [optional]
|
|
1727
|
+
|
|
1728
|
+
### Return type
|
|
1729
|
+
|
|
1730
|
+
[**FileExistResponse**](FileExistResponse.md)
|
|
1731
|
+
|
|
1732
|
+
### HTTP request headers
|
|
1733
|
+
|
|
1734
|
+
- **Content-Type**: application/json
|
|
1735
|
+
- **Accept**: application/json
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
# **get_is_storage_exist**
|
|
1740
|
+
> StorageExistResponse get_is_storage_exist(name)
|
|
1741
|
+
|
|
1742
|
+
Check if storage exists
|
|
1743
|
+
|
|
1744
|
+
### Parameters
|
|
1745
|
+
|
|
1746
|
+
Name | Type | Description | Notes
|
|
1747
|
+
------------- | ------------- | ------------- | -------------
|
|
1748
|
+
**name** | **String**| Storage name |
|
|
1749
|
+
|
|
1750
|
+
### Return type
|
|
1751
|
+
|
|
1752
|
+
[**StorageExistResponse**](StorageExistResponse.md)
|
|
1753
|
+
|
|
1754
|
+
### HTTP request headers
|
|
1755
|
+
|
|
1756
|
+
- **Content-Type**: application/json
|
|
1757
|
+
- **Accept**: application/json
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
|
|
1465
1761
|
# **get_la_te_x_in_storage_to_pdf**
|
|
1466
1762
|
> File get_la_te_x_in_storage_to_pdf(src_path, opts)
|
|
1467
1763
|
|
|
@@ -1535,6 +1831,29 @@ Name | Type | Description | Notes
|
|
|
1535
1831
|
|
|
1536
1832
|
|
|
1537
1833
|
|
|
1834
|
+
# **get_list_file_versions**
|
|
1835
|
+
> FileVersionsResponse get_list_file_versions(path, opts)
|
|
1836
|
+
|
|
1837
|
+
Get the file's versions list
|
|
1838
|
+
|
|
1839
|
+
### Parameters
|
|
1840
|
+
|
|
1841
|
+
Name | Type | Description | Notes
|
|
1842
|
+
------------- | ------------- | ------------- | -------------
|
|
1843
|
+
**path** | **String**| File path e.g. /file.ext or /Folder1/file.ext |
|
|
1844
|
+
**storage** | **String**| User's storage name | [optional]
|
|
1845
|
+
|
|
1846
|
+
### Return type
|
|
1847
|
+
|
|
1848
|
+
[**FileVersionsResponse**](FileVersionsResponse.md)
|
|
1849
|
+
|
|
1850
|
+
### HTTP request headers
|
|
1851
|
+
|
|
1852
|
+
- **Content-Type**: application/json
|
|
1853
|
+
- **Accept**: application/json
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
|
|
1538
1857
|
# **get_list_files**
|
|
1539
1858
|
> FilesResponse get_list_files(opts)
|
|
1540
1859
|
|
|
@@ -1581,6 +1900,31 @@ Name | Type | Description | Notes
|
|
|
1581
1900
|
|
|
1582
1901
|
|
|
1583
1902
|
|
|
1903
|
+
# **get_movie_annotation**
|
|
1904
|
+
> MovieAnnotationResponse get_movie_annotation(name, annotation_id, opts)
|
|
1905
|
+
|
|
1906
|
+
Read document page movie annotation by ID.
|
|
1907
|
+
|
|
1908
|
+
### Parameters
|
|
1909
|
+
|
|
1910
|
+
Name | Type | Description | Notes
|
|
1911
|
+
------------- | ------------- | ------------- | -------------
|
|
1912
|
+
**name** | **String**| The document name. |
|
|
1913
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
1914
|
+
**storage** | **String**| The document storage. | [optional]
|
|
1915
|
+
**folder** | **String**| The document folder. | [optional]
|
|
1916
|
+
|
|
1917
|
+
### Return type
|
|
1918
|
+
|
|
1919
|
+
[**MovieAnnotationResponse**](MovieAnnotationResponse.md)
|
|
1920
|
+
|
|
1921
|
+
### HTTP request headers
|
|
1922
|
+
|
|
1923
|
+
- **Content-Type**: application/json
|
|
1924
|
+
- **Accept**: application/json
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
|
|
1584
1928
|
# **get_page**
|
|
1585
1929
|
> DocumentPageResponse get_page(name, page_number, opts)
|
|
1586
1930
|
|
|
@@ -1843,6 +2187,31 @@ Name | Type | Description | Notes
|
|
|
1843
2187
|
|
|
1844
2188
|
|
|
1845
2189
|
|
|
2190
|
+
# **get_page_file_attachment_annotations**
|
|
2191
|
+
> FileAttachmentAnnotationsResponse get_page_file_attachment_annotations(name, page_number, opts)
|
|
2192
|
+
|
|
2193
|
+
Read document page FileAttachment annotations.
|
|
2194
|
+
|
|
2195
|
+
### Parameters
|
|
2196
|
+
|
|
2197
|
+
Name | Type | Description | Notes
|
|
2198
|
+
------------- | ------------- | ------------- | -------------
|
|
2199
|
+
**name** | **String**| The document name. |
|
|
2200
|
+
**page_number** | **Integer**| The page number. |
|
|
2201
|
+
**storage** | **String**| The document storage. | [optional]
|
|
2202
|
+
**folder** | **String**| The document folder. | [optional]
|
|
2203
|
+
|
|
2204
|
+
### Return type
|
|
2205
|
+
|
|
2206
|
+
[**FileAttachmentAnnotationsResponse**](FileAttachmentAnnotationsResponse.md)
|
|
2207
|
+
|
|
2208
|
+
### HTTP request headers
|
|
2209
|
+
|
|
2210
|
+
- **Content-Type**: application/json
|
|
2211
|
+
- **Accept**: application/json
|
|
2212
|
+
|
|
2213
|
+
|
|
2214
|
+
|
|
1846
2215
|
# **get_page_free_text_annotations**
|
|
1847
2216
|
> FreeTextAnnotationsResponse get_page_free_text_annotations(name, page_number, opts)
|
|
1848
2217
|
|
|
@@ -1994,6 +2363,31 @@ Name | Type | Description | Notes
|
|
|
1994
2363
|
|
|
1995
2364
|
|
|
1996
2365
|
|
|
2366
|
+
# **get_page_movie_annotations**
|
|
2367
|
+
> MovieAnnotationsResponse get_page_movie_annotations(name, page_number, opts)
|
|
2368
|
+
|
|
2369
|
+
Read document page movie annotations.
|
|
2370
|
+
|
|
2371
|
+
### Parameters
|
|
2372
|
+
|
|
2373
|
+
Name | Type | Description | Notes
|
|
2374
|
+
------------- | ------------- | ------------- | -------------
|
|
2375
|
+
**name** | **String**| The document name. |
|
|
2376
|
+
**page_number** | **Integer**| The page number. |
|
|
2377
|
+
**storage** | **String**| The document storage. | [optional]
|
|
2378
|
+
**folder** | **String**| The document folder. | [optional]
|
|
2379
|
+
|
|
2380
|
+
### Return type
|
|
2381
|
+
|
|
2382
|
+
[**MovieAnnotationsResponse**](MovieAnnotationsResponse.md)
|
|
2383
|
+
|
|
2384
|
+
### HTTP request headers
|
|
2385
|
+
|
|
2386
|
+
- **Content-Type**: application/json
|
|
2387
|
+
- **Accept**: application/json
|
|
2388
|
+
|
|
2389
|
+
|
|
2390
|
+
|
|
1997
2391
|
# **get_page_poly_line_annotations**
|
|
1998
2392
|
> PolyLineAnnotationsResponse get_page_poly_line_annotations(name, page_number, opts)
|
|
1999
2393
|
|
|
@@ -2069,6 +2463,56 @@ Name | Type | Description | Notes
|
|
|
2069
2463
|
|
|
2070
2464
|
|
|
2071
2465
|
|
|
2466
|
+
# **get_page_redaction_annotations**
|
|
2467
|
+
> RedactionAnnotationsResponse get_page_redaction_annotations(name, page_number, opts)
|
|
2468
|
+
|
|
2469
|
+
Read document page redaction annotations.
|
|
2470
|
+
|
|
2471
|
+
### Parameters
|
|
2472
|
+
|
|
2473
|
+
Name | Type | Description | Notes
|
|
2474
|
+
------------- | ------------- | ------------- | -------------
|
|
2475
|
+
**name** | **String**| The document name. |
|
|
2476
|
+
**page_number** | **Integer**| The page number. |
|
|
2477
|
+
**storage** | **String**| The document storage. | [optional]
|
|
2478
|
+
**folder** | **String**| The document folder. | [optional]
|
|
2479
|
+
|
|
2480
|
+
### Return type
|
|
2481
|
+
|
|
2482
|
+
[**RedactionAnnotationsResponse**](RedactionAnnotationsResponse.md)
|
|
2483
|
+
|
|
2484
|
+
### HTTP request headers
|
|
2485
|
+
|
|
2486
|
+
- **Content-Type**: application/json
|
|
2487
|
+
- **Accept**: application/json
|
|
2488
|
+
|
|
2489
|
+
|
|
2490
|
+
|
|
2491
|
+
# **get_page_sound_annotations**
|
|
2492
|
+
> SoundAnnotationsResponse get_page_sound_annotations(name, page_number, opts)
|
|
2493
|
+
|
|
2494
|
+
Read document page sound annotations.
|
|
2495
|
+
|
|
2496
|
+
### Parameters
|
|
2497
|
+
|
|
2498
|
+
Name | Type | Description | Notes
|
|
2499
|
+
------------- | ------------- | ------------- | -------------
|
|
2500
|
+
**name** | **String**| The document name. |
|
|
2501
|
+
**page_number** | **Integer**| The page number. |
|
|
2502
|
+
**storage** | **String**| The document storage. | [optional]
|
|
2503
|
+
**folder** | **String**| The document folder. | [optional]
|
|
2504
|
+
|
|
2505
|
+
### Return type
|
|
2506
|
+
|
|
2507
|
+
[**SoundAnnotationsResponse**](SoundAnnotationsResponse.md)
|
|
2508
|
+
|
|
2509
|
+
### HTTP request headers
|
|
2510
|
+
|
|
2511
|
+
- **Content-Type**: application/json
|
|
2512
|
+
- **Accept**: application/json
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
|
|
2072
2516
|
# **get_page_square_annotations**
|
|
2073
2517
|
> SquareAnnotationsResponse get_page_square_annotations(name, page_number, opts)
|
|
2074
2518
|
|
|
@@ -2155,10 +2599,10 @@ Name | Type | Description | Notes
|
|
|
2155
2599
|
------------- | ------------- | ------------- | -------------
|
|
2156
2600
|
**name** | **String**| The document name. |
|
|
2157
2601
|
**page_number** | **Integer**| Number of page (starting from 1). |
|
|
2158
|
-
**llx** | **Float**|
|
|
2159
|
-
**lly** | **Float**|
|
|
2160
|
-
**urx** | **Float**|
|
|
2161
|
-
**ury** | **Float**|
|
|
2602
|
+
**llx** | **Float**| X-coordinate of lower - left corner. |
|
|
2603
|
+
**lly** | **Float**| Y - coordinate of lower-left corner. |
|
|
2604
|
+
**urx** | **Float**| X - coordinate of upper-right corner. |
|
|
2605
|
+
**ury** | **Float**| Y - coordinate of upper-right corner. |
|
|
2162
2606
|
**format** | **Array<String>**| List of formats for search. | [optional]
|
|
2163
2607
|
**regex** | **String**| Formats are specified as a regular expression. | [optional]
|
|
2164
2608
|
**split_rects** | **BOOLEAN**| Split result fragments (default is true). | [optional]
|
|
@@ -2315,7 +2759,7 @@ Converts PDF document (located on storage) to EPUB format and returns resulting
|
|
|
2315
2759
|
Name | Type | Description | Notes
|
|
2316
2760
|
------------- | ------------- | ------------- | -------------
|
|
2317
2761
|
**name** | **String**| The document name. |
|
|
2318
|
-
**content_recognition_mode** | **String**|
|
|
2762
|
+
**content_recognition_mode** | **String**| Property tunes conversion for this or that desirable method of recognition of content. | [optional]
|
|
2319
2763
|
**folder** | **String**| The document folder. | [optional]
|
|
2320
2764
|
**storage** | **String**| The document storage. | [optional]
|
|
2321
2765
|
|
|
@@ -2720,6 +3164,81 @@ Name | Type | Description | Notes
|
|
|
2720
3164
|
|
|
2721
3165
|
|
|
2722
3166
|
|
|
3167
|
+
# **get_redaction_annotation**
|
|
3168
|
+
> RedactionAnnotationResponse get_redaction_annotation(name, annotation_id, opts)
|
|
3169
|
+
|
|
3170
|
+
Read document page redaction annotation by ID.
|
|
3171
|
+
|
|
3172
|
+
### Parameters
|
|
3173
|
+
|
|
3174
|
+
Name | Type | Description | Notes
|
|
3175
|
+
------------- | ------------- | ------------- | -------------
|
|
3176
|
+
**name** | **String**| The document name. |
|
|
3177
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
3178
|
+
**storage** | **String**| The document storage. | [optional]
|
|
3179
|
+
**folder** | **String**| The document folder. | [optional]
|
|
3180
|
+
|
|
3181
|
+
### Return type
|
|
3182
|
+
|
|
3183
|
+
[**RedactionAnnotationResponse**](RedactionAnnotationResponse.md)
|
|
3184
|
+
|
|
3185
|
+
### HTTP request headers
|
|
3186
|
+
|
|
3187
|
+
- **Content-Type**: application/json
|
|
3188
|
+
- **Accept**: application/json
|
|
3189
|
+
|
|
3190
|
+
|
|
3191
|
+
|
|
3192
|
+
# **get_sound_annotation**
|
|
3193
|
+
> SoundAnnotationResponse get_sound_annotation(name, annotation_id, opts)
|
|
3194
|
+
|
|
3195
|
+
Read document page sound annotation by ID.
|
|
3196
|
+
|
|
3197
|
+
### Parameters
|
|
3198
|
+
|
|
3199
|
+
Name | Type | Description | Notes
|
|
3200
|
+
------------- | ------------- | ------------- | -------------
|
|
3201
|
+
**name** | **String**| The document name. |
|
|
3202
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
3203
|
+
**storage** | **String**| The document storage. | [optional]
|
|
3204
|
+
**folder** | **String**| The document folder. | [optional]
|
|
3205
|
+
|
|
3206
|
+
### Return type
|
|
3207
|
+
|
|
3208
|
+
[**SoundAnnotationResponse**](SoundAnnotationResponse.md)
|
|
3209
|
+
|
|
3210
|
+
### HTTP request headers
|
|
3211
|
+
|
|
3212
|
+
- **Content-Type**: application/json
|
|
3213
|
+
- **Accept**: application/json
|
|
3214
|
+
|
|
3215
|
+
|
|
3216
|
+
|
|
3217
|
+
# **get_sound_annotation_data**
|
|
3218
|
+
> File get_sound_annotation_data(name, annotation_id, opts)
|
|
3219
|
+
|
|
3220
|
+
Read document page sound annotation by ID.
|
|
3221
|
+
|
|
3222
|
+
### Parameters
|
|
3223
|
+
|
|
3224
|
+
Name | Type | Description | Notes
|
|
3225
|
+
------------- | ------------- | ------------- | -------------
|
|
3226
|
+
**name** | **String**| The document name. |
|
|
3227
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
3228
|
+
**storage** | **String**| The document storage. | [optional]
|
|
3229
|
+
**folder** | **String**| The document folder. | [optional]
|
|
3230
|
+
|
|
3231
|
+
### Return type
|
|
3232
|
+
|
|
3233
|
+
**File**
|
|
3234
|
+
|
|
3235
|
+
### HTTP request headers
|
|
3236
|
+
|
|
3237
|
+
- **Content-Type**: application/json
|
|
3238
|
+
- **Accept**: application/json
|
|
3239
|
+
|
|
3240
|
+
|
|
3241
|
+
|
|
2723
3242
|
# **get_square_annotation**
|
|
2724
3243
|
> SquareAnnotationResponse get_square_annotation(name, annotation_id, opts)
|
|
2725
3244
|
|
|
@@ -2836,10 +3355,10 @@ Read document text.
|
|
|
2836
3355
|
Name | Type | Description | Notes
|
|
2837
3356
|
------------- | ------------- | ------------- | -------------
|
|
2838
3357
|
**name** | **String**| The document name. |
|
|
2839
|
-
**llx** | **Float**|
|
|
2840
|
-
**lly** | **Float**|
|
|
2841
|
-
**urx** | **Float**|
|
|
2842
|
-
**ury** | **Float**|
|
|
3358
|
+
**llx** | **Float**| X-coordinate of lower - left corner. |
|
|
3359
|
+
**lly** | **Float**| Y - coordinate of lower-left corner. |
|
|
3360
|
+
**urx** | **Float**| X - coordinate of upper-right corner. |
|
|
3361
|
+
**ury** | **Float**| Y - coordinate of upper-right corner. |
|
|
2843
3362
|
**format** | **Array<String>**| List of formats for search. | [optional]
|
|
2844
3363
|
**regex** | **String**| Formats are specified as a regular expression. | [optional]
|
|
2845
3364
|
**split_rects** | **BOOLEAN**| Split result fragments (default is true). | [optional]
|
|
@@ -3150,34 +3669,112 @@ Name | Type | Description | Notes
|
|
|
3150
3669
|
|
|
3151
3670
|
### Return type
|
|
3152
3671
|
|
|
3153
|
-
[**TextReplaceResponse**](TextReplaceResponse.md)
|
|
3672
|
+
[**TextReplaceResponse**](TextReplaceResponse.md)
|
|
3673
|
+
|
|
3674
|
+
### HTTP request headers
|
|
3675
|
+
|
|
3676
|
+
- **Content-Type**: application/json
|
|
3677
|
+
- **Accept**: application/json
|
|
3678
|
+
|
|
3679
|
+
|
|
3680
|
+
|
|
3681
|
+
# **post_flatten_document**
|
|
3682
|
+
> AsposeResponse post_flatten_document(name, opts)
|
|
3683
|
+
|
|
3684
|
+
Flatten the document.
|
|
3685
|
+
|
|
3686
|
+
### Parameters
|
|
3687
|
+
|
|
3688
|
+
Name | Type | Description | Notes
|
|
3689
|
+
------------- | ------------- | ------------- | -------------
|
|
3690
|
+
**name** | **String**| The document name. |
|
|
3691
|
+
**update_appearances** | **BOOLEAN**| If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance.. | [optional]
|
|
3692
|
+
**call_events** | **BOOLEAN**| If set, formatting and other JavaScript events will be called. | [optional]
|
|
3693
|
+
**hide_buttons** | **BOOLEAN**| If set, buttons will be removed from flattened document. | [optional]
|
|
3694
|
+
**storage** | **String**| The document storage. | [optional]
|
|
3695
|
+
**folder** | **String**| The document folder. | [optional]
|
|
3696
|
+
|
|
3697
|
+
### Return type
|
|
3698
|
+
|
|
3699
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
3700
|
+
|
|
3701
|
+
### HTTP request headers
|
|
3702
|
+
|
|
3703
|
+
- **Content-Type**: application/json
|
|
3704
|
+
- **Accept**: application/json
|
|
3705
|
+
|
|
3706
|
+
|
|
3707
|
+
|
|
3708
|
+
# **post_insert_image**
|
|
3709
|
+
> AsposeResponse post_insert_image(name, page_number, llx, lly, urx, ury, opts)
|
|
3710
|
+
|
|
3711
|
+
Insert image to document page.
|
|
3712
|
+
|
|
3713
|
+
### Parameters
|
|
3714
|
+
|
|
3715
|
+
Name | Type | Description | Notes
|
|
3716
|
+
------------- | ------------- | ------------- | -------------
|
|
3717
|
+
**name** | **String**| The document name. |
|
|
3718
|
+
**page_number** | **Integer**| The page number. |
|
|
3719
|
+
**llx** | **Float**| Coordinate lower left X. |
|
|
3720
|
+
**lly** | **Float**| Coordinate lower left Y. |
|
|
3721
|
+
**urx** | **Float**| Coordinate upper right X. |
|
|
3722
|
+
**ury** | **Float**| Coordinate upper right Y. |
|
|
3723
|
+
**image_file_path** | **String**| Path to image file if specified. Request content is used otherwise. | [optional]
|
|
3724
|
+
**storage** | **String**| The document storage. | [optional]
|
|
3725
|
+
**folder** | **String**| The document folder. | [optional]
|
|
3726
|
+
**image** | **File**| Image file. | [optional]
|
|
3727
|
+
|
|
3728
|
+
### Return type
|
|
3729
|
+
|
|
3730
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
3731
|
+
|
|
3732
|
+
### HTTP request headers
|
|
3733
|
+
|
|
3734
|
+
- **Content-Type**: multipart/form-data
|
|
3735
|
+
- **Accept**: application/json
|
|
3736
|
+
|
|
3737
|
+
|
|
3738
|
+
|
|
3739
|
+
# **post_move_file**
|
|
3740
|
+
> AsposeResponse post_move_file(src, dest, opts)
|
|
3741
|
+
|
|
3742
|
+
Move a specific file
|
|
3743
|
+
|
|
3744
|
+
### Parameters
|
|
3745
|
+
|
|
3746
|
+
Name | Type | Description | Notes
|
|
3747
|
+
------------- | ------------- | ------------- | -------------
|
|
3748
|
+
**src** | **String**| Source file path e.g. /fileSource.ext |
|
|
3749
|
+
**dest** | **String**| Destination file path e.g. /fileDestination.ext |
|
|
3750
|
+
**version_id** | **String**| Source file's version, | [optional]
|
|
3751
|
+
**storage** | **String**| User's source storage name | [optional]
|
|
3752
|
+
**dest_storage** | **String**| User's destination storage name | [optional]
|
|
3753
|
+
|
|
3754
|
+
### Return type
|
|
3755
|
+
|
|
3756
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
3154
3757
|
|
|
3155
3758
|
### HTTP request headers
|
|
3156
3759
|
|
|
3157
|
-
- **Content-Type**:
|
|
3760
|
+
- **Content-Type**: multipart/form-data
|
|
3158
3761
|
- **Accept**: application/json
|
|
3159
3762
|
|
|
3160
3763
|
|
|
3161
3764
|
|
|
3162
|
-
# **
|
|
3163
|
-
> AsposeResponse
|
|
3765
|
+
# **post_move_folder**
|
|
3766
|
+
> AsposeResponse post_move_folder(src, dest, opts)
|
|
3164
3767
|
|
|
3165
|
-
|
|
3768
|
+
Move a specific folder
|
|
3166
3769
|
|
|
3167
3770
|
### Parameters
|
|
3168
3771
|
|
|
3169
3772
|
Name | Type | Description | Notes
|
|
3170
3773
|
------------- | ------------- | ------------- | -------------
|
|
3171
|
-
**
|
|
3172
|
-
**
|
|
3173
|
-
**
|
|
3174
|
-
**
|
|
3175
|
-
**urx** | **Float**| Coordinate upper right X. |
|
|
3176
|
-
**ury** | **Float**| Coordinate upper right Y. |
|
|
3177
|
-
**image_file_path** | **String**| Path to image file if specified. Request content is used otherwise. | [optional]
|
|
3178
|
-
**storage** | **String**| The document storage. | [optional]
|
|
3179
|
-
**folder** | **String**| The document folder. | [optional]
|
|
3180
|
-
**image** | **File**| Image file. | [optional]
|
|
3774
|
+
**src** | **String**| Source folder path e.g. /Folder1 |
|
|
3775
|
+
**dest** | **String**| Destination folder path e.g. /Folder2 |
|
|
3776
|
+
**storage** | **String**| User's source storage name | [optional]
|
|
3777
|
+
**dest_storage** | **String**| User's destination storage name | [optional]
|
|
3181
3778
|
|
|
3182
3779
|
### Return type
|
|
3183
3780
|
|
|
@@ -3185,7 +3782,7 @@ Name | Type | Description | Notes
|
|
|
3185
3782
|
|
|
3186
3783
|
### HTTP request headers
|
|
3187
3784
|
|
|
3188
|
-
- **Content-Type**:
|
|
3785
|
+
- **Content-Type**: application/json
|
|
3189
3786
|
- **Accept**: application/json
|
|
3190
3787
|
|
|
3191
3788
|
|
|
@@ -3293,6 +3890,32 @@ Name | Type | Description | Notes
|
|
|
3293
3890
|
|
|
3294
3891
|
|
|
3295
3892
|
|
|
3893
|
+
# **post_page_file_attachment_annotations**
|
|
3894
|
+
> AsposeResponse post_page_file_attachment_annotations(name, page_number, annotations, opts)
|
|
3895
|
+
|
|
3896
|
+
Add document page FileAttachment annotations.
|
|
3897
|
+
|
|
3898
|
+
### Parameters
|
|
3899
|
+
|
|
3900
|
+
Name | Type | Description | Notes
|
|
3901
|
+
------------- | ------------- | ------------- | -------------
|
|
3902
|
+
**name** | **String**| The document name. |
|
|
3903
|
+
**page_number** | **Integer**| The page number. |
|
|
3904
|
+
**annotations** | [**Array<FileAttachmentAnnotation>**](FileAttachmentAnnotation.md)| Annotation. |
|
|
3905
|
+
**storage** | **String**| The document storage. | [optional]
|
|
3906
|
+
**folder** | **String**| The document folder. | [optional]
|
|
3907
|
+
|
|
3908
|
+
### Return type
|
|
3909
|
+
|
|
3910
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
3911
|
+
|
|
3912
|
+
### HTTP request headers
|
|
3913
|
+
|
|
3914
|
+
- **Content-Type**: application/json
|
|
3915
|
+
- **Accept**: application/json
|
|
3916
|
+
|
|
3917
|
+
|
|
3918
|
+
|
|
3296
3919
|
# **post_page_free_text_annotations**
|
|
3297
3920
|
> AsposeResponse post_page_free_text_annotations(name, page_number, annotations, opts)
|
|
3298
3921
|
|
|
@@ -3423,6 +4046,32 @@ Name | Type | Description | Notes
|
|
|
3423
4046
|
|
|
3424
4047
|
|
|
3425
4048
|
|
|
4049
|
+
# **post_page_movie_annotations**
|
|
4050
|
+
> AsposeResponse post_page_movie_annotations(name, page_number, annotations, opts)
|
|
4051
|
+
|
|
4052
|
+
Add document page movie annotations.
|
|
4053
|
+
|
|
4054
|
+
### Parameters
|
|
4055
|
+
|
|
4056
|
+
Name | Type | Description | Notes
|
|
4057
|
+
------------- | ------------- | ------------- | -------------
|
|
4058
|
+
**name** | **String**| The document name. |
|
|
4059
|
+
**page_number** | **Integer**| The page number. |
|
|
4060
|
+
**annotations** | [**Array<MovieAnnotation>**](MovieAnnotation.md)| The array of annotation. |
|
|
4061
|
+
**storage** | **String**| The document storage. | [optional]
|
|
4062
|
+
**folder** | **String**| The document folder. | [optional]
|
|
4063
|
+
|
|
4064
|
+
### Return type
|
|
4065
|
+
|
|
4066
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
4067
|
+
|
|
4068
|
+
### HTTP request headers
|
|
4069
|
+
|
|
4070
|
+
- **Content-Type**: application/json
|
|
4071
|
+
- **Accept**: application/json
|
|
4072
|
+
|
|
4073
|
+
|
|
4074
|
+
|
|
3426
4075
|
# **post_page_poly_line_annotations**
|
|
3427
4076
|
> AsposeResponse post_page_poly_line_annotations(name, page_number, annotations, opts)
|
|
3428
4077
|
|
|
@@ -3475,6 +4124,58 @@ Name | Type | Description | Notes
|
|
|
3475
4124
|
|
|
3476
4125
|
|
|
3477
4126
|
|
|
4127
|
+
# **post_page_redaction_annotations**
|
|
4128
|
+
> AsposeResponse post_page_redaction_annotations(name, page_number, annotations, opts)
|
|
4129
|
+
|
|
4130
|
+
Add document page redaction annotations.
|
|
4131
|
+
|
|
4132
|
+
### Parameters
|
|
4133
|
+
|
|
4134
|
+
Name | Type | Description | Notes
|
|
4135
|
+
------------- | ------------- | ------------- | -------------
|
|
4136
|
+
**name** | **String**| The document name. |
|
|
4137
|
+
**page_number** | **Integer**| The page number. |
|
|
4138
|
+
**annotations** | [**Array<RedactionAnnotation>**](RedactionAnnotation.md)| The array of annotation. |
|
|
4139
|
+
**storage** | **String**| The document storage. | [optional]
|
|
4140
|
+
**folder** | **String**| The document folder. | [optional]
|
|
4141
|
+
|
|
4142
|
+
### Return type
|
|
4143
|
+
|
|
4144
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
4145
|
+
|
|
4146
|
+
### HTTP request headers
|
|
4147
|
+
|
|
4148
|
+
- **Content-Type**: application/json
|
|
4149
|
+
- **Accept**: application/json
|
|
4150
|
+
|
|
4151
|
+
|
|
4152
|
+
|
|
4153
|
+
# **post_page_sound_annotations**
|
|
4154
|
+
> AsposeResponse post_page_sound_annotations(name, page_number, annotations, opts)
|
|
4155
|
+
|
|
4156
|
+
Add document page sound annotations.
|
|
4157
|
+
|
|
4158
|
+
### Parameters
|
|
4159
|
+
|
|
4160
|
+
Name | Type | Description | Notes
|
|
4161
|
+
------------- | ------------- | ------------- | -------------
|
|
4162
|
+
**name** | **String**| The document name. |
|
|
4163
|
+
**page_number** | **Integer**| The page number. |
|
|
4164
|
+
**annotations** | [**Array<SoundAnnotation>**](SoundAnnotation.md)| The array of annotation. |
|
|
4165
|
+
**storage** | **String**| The document storage. | [optional]
|
|
4166
|
+
**folder** | **String**| The document folder. | [optional]
|
|
4167
|
+
|
|
4168
|
+
### Return type
|
|
4169
|
+
|
|
4170
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
4171
|
+
|
|
4172
|
+
### HTTP request headers
|
|
4173
|
+
|
|
4174
|
+
- **Content-Type**: application/json
|
|
4175
|
+
- **Accept**: application/json
|
|
4176
|
+
|
|
4177
|
+
|
|
4178
|
+
|
|
3478
4179
|
# **post_page_square_annotations**
|
|
3479
4180
|
> AsposeResponse post_page_square_annotations(name, page_number, annotations, opts)
|
|
3480
4181
|
|
|
@@ -3886,6 +4587,30 @@ Name | Type | Description | Notes
|
|
|
3886
4587
|
|
|
3887
4588
|
|
|
3888
4589
|
|
|
4590
|
+
# **put_create_folder**
|
|
4591
|
+
> AsposeResponse put_create_folder(path, opts)
|
|
4592
|
+
|
|
4593
|
+
Create the folder
|
|
4594
|
+
|
|
4595
|
+
### Parameters
|
|
4596
|
+
|
|
4597
|
+
Name | Type | Description | Notes
|
|
4598
|
+
------------- | ------------- | ------------- | -------------
|
|
4599
|
+
**path** | **String**| Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively |
|
|
4600
|
+
**storage** | **String**| User's source storage name | [optional]
|
|
4601
|
+
**dest_storage** | **String**| User's destination storage name | [optional]
|
|
4602
|
+
|
|
4603
|
+
### Return type
|
|
4604
|
+
|
|
4605
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
4606
|
+
|
|
4607
|
+
### HTTP request headers
|
|
4608
|
+
|
|
4609
|
+
- **Content-Type**: application/json
|
|
4610
|
+
- **Accept**: application/json
|
|
4611
|
+
|
|
4612
|
+
|
|
4613
|
+
|
|
3889
4614
|
# **put_epub_in_storage_to_pdf**
|
|
3890
4615
|
> AsposeResponse put_epub_in_storage_to_pdf(name, src_path, opts)
|
|
3891
4616
|
|
|
@@ -3935,6 +4660,58 @@ Name | Type | Description | Notes
|
|
|
3935
4660
|
|
|
3936
4661
|
|
|
3937
4662
|
|
|
4663
|
+
# **put_file_attachment_annotation**
|
|
4664
|
+
> FileAttachmentAnnotationResponse put_file_attachment_annotation(name, annotation_id, annotation, opts)
|
|
4665
|
+
|
|
4666
|
+
Replace document FileAttachment annotation
|
|
4667
|
+
|
|
4668
|
+
### Parameters
|
|
4669
|
+
|
|
4670
|
+
Name | Type | Description | Notes
|
|
4671
|
+
------------- | ------------- | ------------- | -------------
|
|
4672
|
+
**name** | **String**| The document name. |
|
|
4673
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
4674
|
+
**annotation** | [**FileAttachmentAnnotation**](FileAttachmentAnnotation.md)| Annotation. |
|
|
4675
|
+
**storage** | **String**| The document storage. | [optional]
|
|
4676
|
+
**folder** | **String**| The document folder. | [optional]
|
|
4677
|
+
|
|
4678
|
+
### Return type
|
|
4679
|
+
|
|
4680
|
+
[**FileAttachmentAnnotationResponse**](FileAttachmentAnnotationResponse.md)
|
|
4681
|
+
|
|
4682
|
+
### HTTP request headers
|
|
4683
|
+
|
|
4684
|
+
- **Content-Type**: application/json
|
|
4685
|
+
- **Accept**: application/json
|
|
4686
|
+
|
|
4687
|
+
|
|
4688
|
+
|
|
4689
|
+
# **put_file_attachment_annotation_data_extract**
|
|
4690
|
+
> AsposeResponse put_file_attachment_annotation_data_extract(name, annotation_id, opts)
|
|
4691
|
+
|
|
4692
|
+
Extract document FileAttachment annotation content to storage
|
|
4693
|
+
|
|
4694
|
+
### Parameters
|
|
4695
|
+
|
|
4696
|
+
Name | Type | Description | Notes
|
|
4697
|
+
------------- | ------------- | ------------- | -------------
|
|
4698
|
+
**name** | **String**| The document name. |
|
|
4699
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
4700
|
+
**out_folder** | **String**| The output folder. | [optional]
|
|
4701
|
+
**storage** | **String**| The document storage. | [optional]
|
|
4702
|
+
**folder** | **String**| The document folder. | [optional]
|
|
4703
|
+
|
|
4704
|
+
### Return type
|
|
4705
|
+
|
|
4706
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
4707
|
+
|
|
4708
|
+
### HTTP request headers
|
|
4709
|
+
|
|
4710
|
+
- **Content-Type**: application/json
|
|
4711
|
+
- **Accept**: application/json
|
|
4712
|
+
|
|
4713
|
+
|
|
4714
|
+
|
|
3938
4715
|
# **put_free_text_annotation**
|
|
3939
4716
|
> FreeTextAnnotationResponse put_free_text_annotation(name, annotation_id, annotation, opts)
|
|
3940
4717
|
|
|
@@ -4422,6 +5199,32 @@ Name | Type | Description | Notes
|
|
|
4422
5199
|
|
|
4423
5200
|
|
|
4424
5201
|
|
|
5202
|
+
# **put_movie_annotation**
|
|
5203
|
+
> MovieAnnotationResponse put_movie_annotation(name, annotation_id, annotation, opts)
|
|
5204
|
+
|
|
5205
|
+
Replace document movie annotation
|
|
5206
|
+
|
|
5207
|
+
### Parameters
|
|
5208
|
+
|
|
5209
|
+
Name | Type | Description | Notes
|
|
5210
|
+
------------- | ------------- | ------------- | -------------
|
|
5211
|
+
**name** | **String**| The document name. |
|
|
5212
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
5213
|
+
**annotation** | [**MovieAnnotation**](MovieAnnotation.md)| Annotation. |
|
|
5214
|
+
**storage** | **String**| The document storage. | [optional]
|
|
5215
|
+
**folder** | **String**| The document folder. | [optional]
|
|
5216
|
+
|
|
5217
|
+
### Return type
|
|
5218
|
+
|
|
5219
|
+
[**MovieAnnotationResponse**](MovieAnnotationResponse.md)
|
|
5220
|
+
|
|
5221
|
+
### HTTP request headers
|
|
5222
|
+
|
|
5223
|
+
- **Content-Type**: application/json
|
|
5224
|
+
- **Accept**: application/json
|
|
5225
|
+
|
|
5226
|
+
|
|
5227
|
+
|
|
4425
5228
|
# **put_page_add_stamp**
|
|
4426
5229
|
> AsposeResponse put_page_add_stamp(name, page_number, stamp, opts)
|
|
4427
5230
|
|
|
@@ -4683,7 +5486,7 @@ Converts PDF document (in request content) to EPUB format and uploads resulting
|
|
|
4683
5486
|
Name | Type | Description | Notes
|
|
4684
5487
|
------------- | ------------- | ------------- | -------------
|
|
4685
5488
|
**out_path** | **String**| Full resulting filename (ex. /folder1/folder2/result.epub) |
|
|
4686
|
-
**content_recognition_mode** | **String**|
|
|
5489
|
+
**content_recognition_mode** | **String**| Property tunes conversion for this or that desirable method of recognition of content. | [optional]
|
|
4687
5490
|
**storage** | **String**| The document storage. | [optional]
|
|
4688
5491
|
**file** | **File**| A file to be converted. | [optional]
|
|
4689
5492
|
|
|
@@ -5033,7 +5836,7 @@ Name | Type | Description | Notes
|
|
|
5033
5836
|
------------- | ------------- | ------------- | -------------
|
|
5034
5837
|
**name** | **String**| The document name. |
|
|
5035
5838
|
**out_path** | **String**| Full resulting filename (ex. /folder1/folder2/result.epub) |
|
|
5036
|
-
**content_recognition_mode** | **String**|
|
|
5839
|
+
**content_recognition_mode** | **String**| Property tunes conversion for this or that desirable method of recognition of content. | [optional]
|
|
5037
5840
|
**folder** | **String**| The document folder. | [optional]
|
|
5038
5841
|
**storage** | **String**| The document storage. | [optional]
|
|
5039
5842
|
|
|
@@ -5477,6 +6280,32 @@ Name | Type | Description | Notes
|
|
|
5477
6280
|
|
|
5478
6281
|
|
|
5479
6282
|
|
|
6283
|
+
# **put_redaction_annotation**
|
|
6284
|
+
> RedactionAnnotationResponse put_redaction_annotation(name, annotation_id, annotation, opts)
|
|
6285
|
+
|
|
6286
|
+
Replace document redaction annotation
|
|
6287
|
+
|
|
6288
|
+
### Parameters
|
|
6289
|
+
|
|
6290
|
+
Name | Type | Description | Notes
|
|
6291
|
+
------------- | ------------- | ------------- | -------------
|
|
6292
|
+
**name** | **String**| The document name. |
|
|
6293
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
6294
|
+
**annotation** | [**RedactionAnnotation**](RedactionAnnotation.md)| Annotation. |
|
|
6295
|
+
**storage** | **String**| The document storage. | [optional]
|
|
6296
|
+
**folder** | **String**| The document folder. | [optional]
|
|
6297
|
+
|
|
6298
|
+
### Return type
|
|
6299
|
+
|
|
6300
|
+
[**RedactionAnnotationResponse**](RedactionAnnotationResponse.md)
|
|
6301
|
+
|
|
6302
|
+
### HTTP request headers
|
|
6303
|
+
|
|
6304
|
+
- **Content-Type**: application/json
|
|
6305
|
+
- **Accept**: application/json
|
|
6306
|
+
|
|
6307
|
+
|
|
6308
|
+
|
|
5480
6309
|
# **put_replace_image**
|
|
5481
6310
|
> ImageResponse put_replace_image(name, image_id, opts)
|
|
5482
6311
|
|
|
@@ -5555,6 +6384,58 @@ Name | Type | Description | Notes
|
|
|
5555
6384
|
|
|
5556
6385
|
|
|
5557
6386
|
|
|
6387
|
+
# **put_sound_annotation**
|
|
6388
|
+
> SoundAnnotationResponse put_sound_annotation(name, annotation_id, annotation, opts)
|
|
6389
|
+
|
|
6390
|
+
Replace document sound annotation
|
|
6391
|
+
|
|
6392
|
+
### Parameters
|
|
6393
|
+
|
|
6394
|
+
Name | Type | Description | Notes
|
|
6395
|
+
------------- | ------------- | ------------- | -------------
|
|
6396
|
+
**name** | **String**| The document name. |
|
|
6397
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
6398
|
+
**annotation** | [**SoundAnnotation**](SoundAnnotation.md)| Annotation. |
|
|
6399
|
+
**storage** | **String**| The document storage. | [optional]
|
|
6400
|
+
**folder** | **String**| The document folder. | [optional]
|
|
6401
|
+
|
|
6402
|
+
### Return type
|
|
6403
|
+
|
|
6404
|
+
[**SoundAnnotationResponse**](SoundAnnotationResponse.md)
|
|
6405
|
+
|
|
6406
|
+
### HTTP request headers
|
|
6407
|
+
|
|
6408
|
+
- **Content-Type**: application/json
|
|
6409
|
+
- **Accept**: application/json
|
|
6410
|
+
|
|
6411
|
+
|
|
6412
|
+
|
|
6413
|
+
# **put_sound_annotation_data_extract**
|
|
6414
|
+
> AsposeResponse put_sound_annotation_data_extract(name, annotation_id, out_file_path, opts)
|
|
6415
|
+
|
|
6416
|
+
Extract document sound annotation content to storage
|
|
6417
|
+
|
|
6418
|
+
### Parameters
|
|
6419
|
+
|
|
6420
|
+
Name | Type | Description | Notes
|
|
6421
|
+
------------- | ------------- | ------------- | -------------
|
|
6422
|
+
**name** | **String**| The document name. |
|
|
6423
|
+
**annotation_id** | **String**| The annotation ID. |
|
|
6424
|
+
**out_file_path** | **String**| The output file path. |
|
|
6425
|
+
**storage** | **String**| The document storage. | [optional]
|
|
6426
|
+
**folder** | **String**| The document folder. | [optional]
|
|
6427
|
+
|
|
6428
|
+
### Return type
|
|
6429
|
+
|
|
6430
|
+
[**AsposeResponse**](AsposeResponse.md)
|
|
6431
|
+
|
|
6432
|
+
### HTTP request headers
|
|
6433
|
+
|
|
6434
|
+
- **Content-Type**: application/json
|
|
6435
|
+
- **Accept**: application/json
|
|
6436
|
+
|
|
6437
|
+
|
|
6438
|
+
|
|
5558
6439
|
# **put_square_annotation**
|
|
5559
6440
|
> SquareAnnotationResponse put_square_annotation(name, annotation_id, annotation, opts)
|
|
5560
6441
|
|