aspose_pdf_cloud 19.1.0 → 19.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **code** | **Integer** | Response status code. |
8
8
  **status** | **String** | Response status. | [optional]
9
- **annotations** | [**RedactionAnnotations**](RedactionAnnotations.md) | Ink annotations object | [optional]
9
+ **annotations** | [**RedactionAnnotations**](RedactionAnnotations.md) | Redaction annotations object | [optional]
10
10
 
11
11
 
@@ -0,0 +1,22 @@
1
+ # AsposePdfCloud::ScreenAnnotation
2
+ Provides ScreenAnnotation.
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
8
+ **color** | [**Color**](Color.md) | Color of the annotation. | [optional]
9
+ **contents** | **String** | Get the annotation content. | [optional]
10
+ **modified** | **String** | The date and time when the annotation was last modified. | [optional]
11
+ **id** | **String** | Gets ID of the annotation. | [optional]
12
+ **flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
13
+ **name** | **String** | Gets Name of the annotation. | [optional]
14
+ **rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. | [optional]
15
+ **page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
16
+ **z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
17
+ **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
18
+ **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
19
+ **title** | **String** | Get the annotation title. | [optional]
20
+ **file_path** | **String** | Sets content file path. | [optional]
21
+
22
+
@@ -0,0 +1,11 @@
1
+ # AsposePdfCloud::ScreenAnnotationResponse
2
+ Represents response containing single screen annotation object
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **code** | **Integer** | Response status code. |
8
+ **status** | **String** | Response status. | [optional]
9
+ **annotation** | [**ScreenAnnotation**](ScreenAnnotation.md) | Screen annotation object | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # AsposePdfCloud::ScreenAnnotations
2
+ Object representing a list of screen annotations.
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
8
+ **list** | [**Array<ScreenAnnotation>**](ScreenAnnotation.md) | List of screen annotations. | [optional]
9
+
10
+
@@ -0,0 +1,11 @@
1
+ # AsposePdfCloud::ScreenAnnotationsResponse
2
+ Represents response containing multiple screen annotation objects
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **code** | **Integer** | Response status code. |
8
+ **status** | **String** | Response status. | [optional]
9
+ **annotations** | [**ScreenAnnotations**](ScreenAnnotations.md) | Screen annotations object | [optional]
10
+
11
+
@@ -0,0 +1,27 @@
1
+ # AsposePdfCloud::StampAnnotation
2
+ Provides StampAnnotation.
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
8
+ **color** | [**Color**](Color.md) | Color of the annotation. | [optional]
9
+ **contents** | **String** | Get the annotation content. | [optional]
10
+ **modified** | **String** | The date and time when the annotation was last modified. | [optional]
11
+ **id** | **String** | Gets ID of the annotation. | [optional]
12
+ **flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
13
+ **name** | **String** | Gets Name of the annotation. | [optional]
14
+ **rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. | [optional]
15
+ **page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
16
+ **z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
17
+ **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
18
+ **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
19
+ **creation_date** | **String** | The date and time when the annotation was created. | [optional]
20
+ **subject** | **String** | Get the annotation subject. | [optional]
21
+ **title** | **String** | Get the annotation title. | [optional]
22
+ **rich_text** | **String** | Get the annotation RichText. | [optional]
23
+ **icon** | [**StampIcon**](StampIcon.md) | Gets or sets icon for rubber stamp. | [optional]
24
+ **file_path** | **String** | Sets content file path. | [optional]
25
+ **has_image** | **BOOLEAN** | Gets is image exist. | [optional]
26
+
27
+
@@ -0,0 +1,11 @@
1
+ # AsposePdfCloud::StampAnnotationResponse
2
+ Represents response containing single stamp annotation object
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **code** | **Integer** | Response status code. |
8
+ **status** | **String** | Response status. | [optional]
9
+ **annotation** | [**StampAnnotation**](StampAnnotation.md) | Ink annotation object | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # AsposePdfCloud::StampAnnotations
2
+ Object representing a list of stamp annotations.
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
8
+ **list** | [**Array<StampAnnotation>**](StampAnnotation.md) | List of stamp annotations. | [optional]
9
+
10
+
@@ -0,0 +1,11 @@
1
+ # AsposePdfCloud::StampAnnotationsResponse
2
+ Represents response containing multiple stamp annotation objects
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **code** | **Integer** | Response status code. |
8
+ **status** | **String** | Response status. | [optional]
9
+ **annotations** | [**StampAnnotations**](StampAnnotations.md) | Stamp annotations object | [optional]
10
+
11
+
@@ -0,0 +1,23 @@
1
+ # AsposePdfCloud::StampIcon
2
+ Enumerates the icons to be used in displaying the annotation.
3
+
4
+ ## Enum
5
+ Name | Type | Value | Description
6
+ ------------ | ------------- | ------------- | -------------
7
+ **DRAFT** | **String** | 'Draft' | Draft stamp icon.
8
+ **APPROVED** | **String** | 'Approved' | Approved stamp icon.
9
+ **EXPERIMENTAL** | **String** | 'Experimental' | Experimental stamp icon.
10
+ **NOT_APPROVED** | **String** | 'NotApproved' | Stamp icon is not approved.
11
+ **AS_IS** | **String** | 'AsIs' | Stamp icon "as is".
12
+ **EXPIRED** | **String** | 'Expired' | Stamp icon is expired.
13
+ **NOT_FOR_PUBLIC_RELEASE** | **String** | 'NotForPublicRelease' | Not for public release.
14
+ **CONFIDENTIAL** | **String** | 'Confidential' | Confidential.
15
+ **FINAL** | **String** | 'Final' | Final stamp.
16
+ **SOLD** | **String** | 'Sold' | Sold stamp.
17
+ **DEPARTMENTAL** | **String** | 'Departmental' | Departamental.
18
+ **FOR_COMMENT** | **String** | 'ForComment' | For comment.
19
+ **FOR_PUBLIC_RELEASE** | **String** | 'ForPublicRelease' | For public release.
20
+ **TOP_SECRET** | **String** | 'TopSecret' | Top secret.
21
+
22
+
23
+
@@ -86,6 +86,7 @@ require_relative 'aspose_pdf_cloud/models/sound_encoding'
86
86
  require_relative 'aspose_pdf_cloud/models/sound_icon'
87
87
  require_relative 'aspose_pdf_cloud/models/split_result'
88
88
  require_relative 'aspose_pdf_cloud/models/stamp'
89
+ require_relative 'aspose_pdf_cloud/models/stamp_icon'
89
90
  require_relative 'aspose_pdf_cloud/models/stamp_type'
90
91
  require_relative 'aspose_pdf_cloud/models/text_horizontal_alignment'
91
92
  require_relative 'aspose_pdf_cloud/models/text_icon'
@@ -169,6 +170,9 @@ require_relative 'aspose_pdf_cloud/models/popup_annotations_response'
169
170
  require_relative 'aspose_pdf_cloud/models/redaction_annotation_response'
170
171
  require_relative 'aspose_pdf_cloud/models/redaction_annotations'
171
172
  require_relative 'aspose_pdf_cloud/models/redaction_annotations_response'
173
+ require_relative 'aspose_pdf_cloud/models/screen_annotation_response'
174
+ require_relative 'aspose_pdf_cloud/models/screen_annotations'
175
+ require_relative 'aspose_pdf_cloud/models/screen_annotations_response'
172
176
  require_relative 'aspose_pdf_cloud/models/signature_verify_response'
173
177
  require_relative 'aspose_pdf_cloud/models/sound_annotation_response'
174
178
  require_relative 'aspose_pdf_cloud/models/sound_annotations'
@@ -181,6 +185,9 @@ require_relative 'aspose_pdf_cloud/models/square_annotations_response'
181
185
  require_relative 'aspose_pdf_cloud/models/squiggly_annotation_response'
182
186
  require_relative 'aspose_pdf_cloud/models/squiggly_annotations'
183
187
  require_relative 'aspose_pdf_cloud/models/squiggly_annotations_response'
188
+ require_relative 'aspose_pdf_cloud/models/stamp_annotation_response'
189
+ require_relative 'aspose_pdf_cloud/models/stamp_annotations'
190
+ require_relative 'aspose_pdf_cloud/models/stamp_annotations_response'
184
191
  require_relative 'aspose_pdf_cloud/models/storage_exist_response'
185
192
  require_relative 'aspose_pdf_cloud/models/strike_out_annotation_response'
186
193
  require_relative 'aspose_pdf_cloud/models/strike_out_annotations'
@@ -199,6 +206,7 @@ require_relative 'aspose_pdf_cloud/models/markup_annotation'
199
206
  require_relative 'aspose_pdf_cloud/models/movie_annotation'
200
207
  require_relative 'aspose_pdf_cloud/models/popup_annotation'
201
208
  require_relative 'aspose_pdf_cloud/models/redaction_annotation'
209
+ require_relative 'aspose_pdf_cloud/models/screen_annotation'
202
210
  require_relative 'aspose_pdf_cloud/models/caret_annotation'
203
211
  require_relative 'aspose_pdf_cloud/models/common_figure_annotation'
204
212
  require_relative 'aspose_pdf_cloud/models/file_attachment_annotation'
@@ -210,6 +218,7 @@ require_relative 'aspose_pdf_cloud/models/poly_annotation'
210
218
  require_relative 'aspose_pdf_cloud/models/popup_annotation_with_parent'
211
219
  require_relative 'aspose_pdf_cloud/models/sound_annotation'
212
220
  require_relative 'aspose_pdf_cloud/models/squiggly_annotation'
221
+ require_relative 'aspose_pdf_cloud/models/stamp_annotation'
213
222
  require_relative 'aspose_pdf_cloud/models/strike_out_annotation'
214
223
  require_relative 'aspose_pdf_cloud/models/text_annotation'
215
224
  require_relative 'aspose_pdf_cloud/models/underline_annotation'
@@ -2698,6 +2698,78 @@ module AsposePdfCloud
2698
2698
  return data, status_code, headers
2699
2699
  end
2700
2700
 
2701
+ # Read document screen annotations.
2702
+ #
2703
+ # @param name The document name.
2704
+ # @param [Hash] opts the optional parameters
2705
+ # @option opts [String] :storage The document storage.
2706
+ # @option opts [String] :folder The document folder.
2707
+ # @return [ScreenAnnotationsResponse]
2708
+ def get_document_screen_annotations(name, opts = {})
2709
+ @api_client.request_token_if_needed
2710
+ data, _status_code, _headers = get_document_screen_annotations_with_http_info(name, opts)
2711
+ rescue ApiError => error
2712
+ if error.code == 401
2713
+ @api_client.refresh_token
2714
+ data, _status_code, _headers = get_document_screen_annotations_with_http_info(name, opts)
2715
+ else
2716
+ raise
2717
+ end
2718
+ return data
2719
+ end
2720
+
2721
+ # Read document screen annotations.
2722
+ #
2723
+ # @param name The document name.
2724
+ # @param [Hash] opts the optional parameters
2725
+ # @option opts [String] :storage The document storage.
2726
+ # @option opts [String] :folder The document folder.
2727
+ # @return [Array<(ScreenAnnotationsResponse, Fixnum, Hash)>] ScreenAnnotationsResponse data, response status code and response headers
2728
+ def get_document_screen_annotations_with_http_info(name, opts = {})
2729
+ if @api_client.config.debugging
2730
+ @api_client.config.logger.debug "Calling API: PdfApi.get_document_screen_annotations ..."
2731
+ end
2732
+ # verify the required parameter 'name' is set
2733
+ if @api_client.config.client_side_validation && name.nil?
2734
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_screen_annotations"
2735
+ end
2736
+ # resource path
2737
+ local_var_path = "/pdf/{name}/annotations/screen".sub('{' + 'name' + '}', name.to_s)
2738
+
2739
+ # query parameters
2740
+ query_params = {}
2741
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
2742
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
2743
+
2744
+ # header parameters
2745
+ header_params = {}
2746
+ # HTTP header 'Accept' (if needed)
2747
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2748
+ # HTTP header 'Content-Type'
2749
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2750
+
2751
+ # form parameters
2752
+ form_params = {}
2753
+ # Fix header in file
2754
+ post_body = nil
2755
+
2756
+ # http body (model)
2757
+ # Fix header in file
2758
+ # post_body = nil
2759
+ auth_names = []
2760
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2761
+ :header_params => header_params,
2762
+ :query_params => query_params,
2763
+ :form_params => form_params,
2764
+ :body => post_body,
2765
+ :auth_names => auth_names,
2766
+ :return_type => 'ScreenAnnotationsResponse')
2767
+ if @api_client.config.debugging
2768
+ @api_client.config.logger.debug "API called: PdfApi#get_document_screen_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2769
+ end
2770
+ return data, status_code, headers
2771
+ end
2772
+
2701
2773
  # Read document sound annotations.
2702
2774
  #
2703
2775
  # @param name The document name.
@@ -2914,6 +2986,78 @@ module AsposePdfCloud
2914
2986
  return data, status_code, headers
2915
2987
  end
2916
2988
 
2989
+ # Read document stamp annotations.
2990
+ #
2991
+ # @param name The document name.
2992
+ # @param [Hash] opts the optional parameters
2993
+ # @option opts [String] :storage The document storage.
2994
+ # @option opts [String] :folder The document folder.
2995
+ # @return [StampAnnotationsResponse]
2996
+ def get_document_stamp_annotations(name, opts = {})
2997
+ @api_client.request_token_if_needed
2998
+ data, _status_code, _headers = get_document_stamp_annotations_with_http_info(name, opts)
2999
+ rescue ApiError => error
3000
+ if error.code == 401
3001
+ @api_client.refresh_token
3002
+ data, _status_code, _headers = get_document_stamp_annotations_with_http_info(name, opts)
3003
+ else
3004
+ raise
3005
+ end
3006
+ return data
3007
+ end
3008
+
3009
+ # Read document stamp annotations.
3010
+ #
3011
+ # @param name The document name.
3012
+ # @param [Hash] opts the optional parameters
3013
+ # @option opts [String] :storage The document storage.
3014
+ # @option opts [String] :folder The document folder.
3015
+ # @return [Array<(StampAnnotationsResponse, Fixnum, Hash)>] StampAnnotationsResponse data, response status code and response headers
3016
+ def get_document_stamp_annotations_with_http_info(name, opts = {})
3017
+ if @api_client.config.debugging
3018
+ @api_client.config.logger.debug "Calling API: PdfApi.get_document_stamp_annotations ..."
3019
+ end
3020
+ # verify the required parameter 'name' is set
3021
+ if @api_client.config.client_side_validation && name.nil?
3022
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_stamp_annotations"
3023
+ end
3024
+ # resource path
3025
+ local_var_path = "/pdf/{name}/annotations/stamp".sub('{' + 'name' + '}', name.to_s)
3026
+
3027
+ # query parameters
3028
+ query_params = {}
3029
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
3030
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
3031
+
3032
+ # header parameters
3033
+ header_params = {}
3034
+ # HTTP header 'Accept' (if needed)
3035
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3036
+ # HTTP header 'Content-Type'
3037
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3038
+
3039
+ # form parameters
3040
+ form_params = {}
3041
+ # Fix header in file
3042
+ post_body = nil
3043
+
3044
+ # http body (model)
3045
+ # Fix header in file
3046
+ # post_body = nil
3047
+ auth_names = []
3048
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3049
+ :header_params => header_params,
3050
+ :query_params => query_params,
3051
+ :form_params => form_params,
3052
+ :body => post_body,
3053
+ :auth_names => auth_names,
3054
+ :return_type => 'StampAnnotationsResponse')
3055
+ if @api_client.config.debugging
3056
+ @api_client.config.logger.debug "API called: PdfApi#get_document_stamp_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3057
+ end
3058
+ return data, status_code, headers
3059
+ end
3060
+
2917
3061
  # Read document StrikeOut annotations.
2918
3062
  #
2919
3063
  # @param name The document name.
@@ -3553,7 +3697,7 @@ module AsposePdfCloud
3553
3697
  # header parameters
3554
3698
  header_params = {}
3555
3699
  # HTTP header 'Accept' (if needed)
3556
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3700
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
3557
3701
  # HTTP header 'Content-Type'
3558
3702
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3559
3703
 
@@ -3631,7 +3775,7 @@ module AsposePdfCloud
3631
3775
  # header parameters
3632
3776
  header_params = {}
3633
3777
  # HTTP header 'Accept' (if needed)
3634
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3778
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
3635
3779
  # HTTP header 'Content-Type'
3636
3780
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3637
3781
 
@@ -3959,7 +4103,7 @@ module AsposePdfCloud
3959
4103
  # header parameters
3960
4104
  header_params = {}
3961
4105
  # HTTP header 'Accept' (if needed)
3962
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4106
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
3963
4107
  # HTTP header 'Content-Type'
3964
4108
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3965
4109
 
@@ -4043,7 +4187,7 @@ module AsposePdfCloud
4043
4187
  # header parameters
4044
4188
  header_params = {}
4045
4189
  # HTTP header 'Accept' (if needed)
4046
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4190
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
4047
4191
  # HTTP header 'Content-Type'
4048
4192
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4049
4193
 
@@ -4127,7 +4271,7 @@ module AsposePdfCloud
4127
4271
  # header parameters
4128
4272
  header_params = {}
4129
4273
  # HTTP header 'Accept' (if needed)
4130
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4274
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
4131
4275
  # HTTP header 'Content-Type'
4132
4276
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4133
4277
 
@@ -4211,7 +4355,7 @@ module AsposePdfCloud
4211
4355
  # header parameters
4212
4356
  header_params = {}
4213
4357
  # HTTP header 'Accept' (if needed)
4214
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4358
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
4215
4359
  # HTTP header 'Content-Type'
4216
4360
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4217
4361
 
@@ -4295,7 +4439,7 @@ module AsposePdfCloud
4295
4439
  # header parameters
4296
4440
  header_params = {}
4297
4441
  # HTTP header 'Accept' (if needed)
4298
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4442
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
4299
4443
  # HTTP header 'Content-Type'
4300
4444
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4301
4445
 
@@ -5178,7 +5322,7 @@ module AsposePdfCloud
5178
5322
  # header parameters
5179
5323
  header_params = {}
5180
5324
  # HTTP header 'Accept' (if needed)
5181
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5325
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5182
5326
  # HTTP header 'Content-Type'
5183
5327
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5184
5328
 
@@ -5496,7 +5640,7 @@ module AsposePdfCloud
5496
5640
  # header parameters
5497
5641
  header_params = {}
5498
5642
  # HTTP header 'Accept' (if needed)
5499
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5643
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5500
5644
  # HTTP header 'Content-Type'
5501
5645
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5502
5646
 
@@ -5580,7 +5724,7 @@ module AsposePdfCloud
5580
5724
  # header parameters
5581
5725
  header_params = {}
5582
5726
  # HTTP header 'Accept' (if needed)
5583
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5727
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5584
5728
  # HTTP header 'Content-Type'
5585
5729
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5586
5730
 
@@ -5664,7 +5808,7 @@ module AsposePdfCloud
5664
5808
  # header parameters
5665
5809
  header_params = {}
5666
5810
  # HTTP header 'Accept' (if needed)
5667
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5811
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5668
5812
  # HTTP header 'Content-Type'
5669
5813
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5670
5814
 
@@ -5748,7 +5892,7 @@ module AsposePdfCloud
5748
5892
  # header parameters
5749
5893
  header_params = {}
5750
5894
  # HTTP header 'Accept' (if needed)
5751
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5895
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5752
5896
  # HTTP header 'Content-Type'
5753
5897
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5754
5898
 
@@ -5832,7 +5976,7 @@ module AsposePdfCloud
5832
5976
  # header parameters
5833
5977
  header_params = {}
5834
5978
  # HTTP header 'Accept' (if needed)
5835
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5979
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5836
5980
  # HTTP header 'Content-Type'
5837
5981
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5838
5982
 
@@ -5916,7 +6060,7 @@ module AsposePdfCloud
5916
6060
  # header parameters
5917
6061
  header_params = {}
5918
6062
  # HTTP header 'Accept' (if needed)
5919
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6063
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5920
6064
  # HTTP header 'Content-Type'
5921
6065
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5922
6066
 
@@ -6884,6 +7028,84 @@ module AsposePdfCloud
6884
7028
  return data, status_code, headers
6885
7029
  end
6886
7030
 
7031
+ # Read document page screen annotations.
7032
+ #
7033
+ # @param name The document name.
7034
+ # @param page_number The page number.
7035
+ # @param [Hash] opts the optional parameters
7036
+ # @option opts [String] :storage The document storage.
7037
+ # @option opts [String] :folder The document folder.
7038
+ # @return [ScreenAnnotationsResponse]
7039
+ def get_page_screen_annotations(name, page_number, opts = {})
7040
+ @api_client.request_token_if_needed
7041
+ data, _status_code, _headers = get_page_screen_annotations_with_http_info(name, page_number, opts)
7042
+ rescue ApiError => error
7043
+ if error.code == 401
7044
+ @api_client.refresh_token
7045
+ data, _status_code, _headers = get_page_screen_annotations_with_http_info(name, page_number, opts)
7046
+ else
7047
+ raise
7048
+ end
7049
+ return data
7050
+ end
7051
+
7052
+ # Read document page screen annotations.
7053
+ #
7054
+ # @param name The document name.
7055
+ # @param page_number The page number.
7056
+ # @param [Hash] opts the optional parameters
7057
+ # @option opts [String] :storage The document storage.
7058
+ # @option opts [String] :folder The document folder.
7059
+ # @return [Array<(ScreenAnnotationsResponse, Fixnum, Hash)>] ScreenAnnotationsResponse data, response status code and response headers
7060
+ def get_page_screen_annotations_with_http_info(name, page_number, opts = {})
7061
+ if @api_client.config.debugging
7062
+ @api_client.config.logger.debug "Calling API: PdfApi.get_page_screen_annotations ..."
7063
+ end
7064
+ # verify the required parameter 'name' is set
7065
+ if @api_client.config.client_side_validation && name.nil?
7066
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_screen_annotations"
7067
+ end
7068
+ # verify the required parameter 'page_number' is set
7069
+ if @api_client.config.client_side_validation && page_number.nil?
7070
+ fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_screen_annotations"
7071
+ end
7072
+ # resource path
7073
+ local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/screen".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
7074
+
7075
+ # query parameters
7076
+ query_params = {}
7077
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
7078
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
7079
+
7080
+ # header parameters
7081
+ header_params = {}
7082
+ # HTTP header 'Accept' (if needed)
7083
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7084
+ # HTTP header 'Content-Type'
7085
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7086
+
7087
+ # form parameters
7088
+ form_params = {}
7089
+ # Fix header in file
7090
+ post_body = nil
7091
+
7092
+ # http body (model)
7093
+ # Fix header in file
7094
+ # post_body = nil
7095
+ auth_names = []
7096
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
7097
+ :header_params => header_params,
7098
+ :query_params => query_params,
7099
+ :form_params => form_params,
7100
+ :body => post_body,
7101
+ :auth_names => auth_names,
7102
+ :return_type => 'ScreenAnnotationsResponse')
7103
+ if @api_client.config.debugging
7104
+ @api_client.config.logger.debug "API called: PdfApi#get_page_screen_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7105
+ end
7106
+ return data, status_code, headers
7107
+ end
7108
+
6887
7109
  # Read document page sound annotations.
6888
7110
  #
6889
7111
  # @param name The document name.
@@ -7118,49 +7340,49 @@ module AsposePdfCloud
7118
7340
  return data, status_code, headers
7119
7341
  end
7120
7342
 
7121
- # Read document page StrikeOut annotations.
7343
+ # Read document page stamp annotations.
7122
7344
  #
7123
7345
  # @param name The document name.
7124
7346
  # @param page_number The page number.
7125
7347
  # @param [Hash] opts the optional parameters
7126
7348
  # @option opts [String] :storage The document storage.
7127
7349
  # @option opts [String] :folder The document folder.
7128
- # @return [StrikeOutAnnotationsResponse]
7129
- def get_page_strike_out_annotations(name, page_number, opts = {})
7350
+ # @return [StampAnnotationsResponse]
7351
+ def get_page_stamp_annotations(name, page_number, opts = {})
7130
7352
  @api_client.request_token_if_needed
7131
- data, _status_code, _headers = get_page_strike_out_annotations_with_http_info(name, page_number, opts)
7353
+ data, _status_code, _headers = get_page_stamp_annotations_with_http_info(name, page_number, opts)
7132
7354
  rescue ApiError => error
7133
7355
  if error.code == 401
7134
7356
  @api_client.refresh_token
7135
- data, _status_code, _headers = get_page_strike_out_annotations_with_http_info(name, page_number, opts)
7357
+ data, _status_code, _headers = get_page_stamp_annotations_with_http_info(name, page_number, opts)
7136
7358
  else
7137
7359
  raise
7138
7360
  end
7139
7361
  return data
7140
7362
  end
7141
7363
 
7142
- # Read document page StrikeOut annotations.
7364
+ # Read document page stamp annotations.
7143
7365
  #
7144
7366
  # @param name The document name.
7145
7367
  # @param page_number The page number.
7146
7368
  # @param [Hash] opts the optional parameters
7147
7369
  # @option opts [String] :storage The document storage.
7148
7370
  # @option opts [String] :folder The document folder.
7149
- # @return [Array<(StrikeOutAnnotationsResponse, Fixnum, Hash)>] StrikeOutAnnotationsResponse data, response status code and response headers
7150
- def get_page_strike_out_annotations_with_http_info(name, page_number, opts = {})
7371
+ # @return [Array<(StampAnnotationsResponse, Fixnum, Hash)>] StampAnnotationsResponse data, response status code and response headers
7372
+ def get_page_stamp_annotations_with_http_info(name, page_number, opts = {})
7151
7373
  if @api_client.config.debugging
7152
- @api_client.config.logger.debug "Calling API: PdfApi.get_page_strike_out_annotations ..."
7374
+ @api_client.config.logger.debug "Calling API: PdfApi.get_page_stamp_annotations ..."
7153
7375
  end
7154
7376
  # verify the required parameter 'name' is set
7155
7377
  if @api_client.config.client_side_validation && name.nil?
7156
- fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_strike_out_annotations"
7378
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_stamp_annotations"
7157
7379
  end
7158
7380
  # verify the required parameter 'page_number' is set
7159
7381
  if @api_client.config.client_side_validation && page_number.nil?
7160
- fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_strike_out_annotations"
7382
+ fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_stamp_annotations"
7161
7383
  end
7162
7384
  # resource path
7163
- local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/strikeout".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
7385
+ local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/stamp".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
7164
7386
 
7165
7387
  # query parameters
7166
7388
  query_params = {}
@@ -7189,53 +7411,131 @@ module AsposePdfCloud
7189
7411
  :form_params => form_params,
7190
7412
  :body => post_body,
7191
7413
  :auth_names => auth_names,
7192
- :return_type => 'StrikeOutAnnotationsResponse')
7414
+ :return_type => 'StampAnnotationsResponse')
7193
7415
  if @api_client.config.debugging
7194
- @api_client.config.logger.debug "API called: PdfApi#get_page_strike_out_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7416
+ @api_client.config.logger.debug "API called: PdfApi#get_page_stamp_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7195
7417
  end
7196
7418
  return data, status_code, headers
7197
7419
  end
7198
7420
 
7199
- # Read page text items.
7421
+ # Read document page StrikeOut annotations.
7200
7422
  #
7201
7423
  # @param name The document name.
7202
- # @param page_number Number of page (starting from 1).
7203
- # @param llx X-coordinate of lower - left corner.
7204
- # @param lly Y - coordinate of lower-left corner.
7205
- # @param urx X - coordinate of upper-right corner.
7206
- # @param ury Y - coordinate of upper-right corner.
7424
+ # @param page_number The page number.
7207
7425
  # @param [Hash] opts the optional parameters
7208
- # @option opts [Array<String>] :format List of formats for search.
7209
- # @option opts [String] :regex Formats are specified as a regular expression.
7210
- # @option opts [BOOLEAN] :split_rects Split result fragments (default is true).
7211
- # @option opts [String] :folder The document folder.
7212
7426
  # @option opts [String] :storage The document storage.
7213
- # @return [TextRectsResponse]
7214
- def get_page_text(name, page_number, llx, lly, urx, ury, opts = {})
7427
+ # @option opts [String] :folder The document folder.
7428
+ # @return [StrikeOutAnnotationsResponse]
7429
+ def get_page_strike_out_annotations(name, page_number, opts = {})
7215
7430
  @api_client.request_token_if_needed
7216
- data, _status_code, _headers = get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, opts)
7431
+ data, _status_code, _headers = get_page_strike_out_annotations_with_http_info(name, page_number, opts)
7217
7432
  rescue ApiError => error
7218
7433
  if error.code == 401
7219
7434
  @api_client.refresh_token
7220
- data, _status_code, _headers = get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, opts)
7435
+ data, _status_code, _headers = get_page_strike_out_annotations_with_http_info(name, page_number, opts)
7221
7436
  else
7222
7437
  raise
7223
7438
  end
7224
7439
  return data
7225
7440
  end
7226
7441
 
7227
- # Read page text items.
7442
+ # Read document page StrikeOut annotations.
7228
7443
  #
7229
7444
  # @param name The document name.
7230
- # @param page_number Number of page (starting from 1).
7231
- # @param llx X-coordinate of lower - left corner.
7232
- # @param lly Y - coordinate of lower-left corner.
7233
- # @param urx X - coordinate of upper-right corner.
7234
- # @param ury Y - coordinate of upper-right corner.
7445
+ # @param page_number The page number.
7235
7446
  # @param [Hash] opts the optional parameters
7236
- # @option opts [Array<String>] :format List of formats for search.
7237
- # @option opts [String] :regex Formats are specified as a regular expression.
7238
- # @option opts [BOOLEAN] :split_rects Split result fragments (default is true).
7447
+ # @option opts [String] :storage The document storage.
7448
+ # @option opts [String] :folder The document folder.
7449
+ # @return [Array<(StrikeOutAnnotationsResponse, Fixnum, Hash)>] StrikeOutAnnotationsResponse data, response status code and response headers
7450
+ def get_page_strike_out_annotations_with_http_info(name, page_number, opts = {})
7451
+ if @api_client.config.debugging
7452
+ @api_client.config.logger.debug "Calling API: PdfApi.get_page_strike_out_annotations ..."
7453
+ end
7454
+ # verify the required parameter 'name' is set
7455
+ if @api_client.config.client_side_validation && name.nil?
7456
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_strike_out_annotations"
7457
+ end
7458
+ # verify the required parameter 'page_number' is set
7459
+ if @api_client.config.client_side_validation && page_number.nil?
7460
+ fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_strike_out_annotations"
7461
+ end
7462
+ # resource path
7463
+ local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/strikeout".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
7464
+
7465
+ # query parameters
7466
+ query_params = {}
7467
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
7468
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
7469
+
7470
+ # header parameters
7471
+ header_params = {}
7472
+ # HTTP header 'Accept' (if needed)
7473
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7474
+ # HTTP header 'Content-Type'
7475
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7476
+
7477
+ # form parameters
7478
+ form_params = {}
7479
+ # Fix header in file
7480
+ post_body = nil
7481
+
7482
+ # http body (model)
7483
+ # Fix header in file
7484
+ # post_body = nil
7485
+ auth_names = []
7486
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
7487
+ :header_params => header_params,
7488
+ :query_params => query_params,
7489
+ :form_params => form_params,
7490
+ :body => post_body,
7491
+ :auth_names => auth_names,
7492
+ :return_type => 'StrikeOutAnnotationsResponse')
7493
+ if @api_client.config.debugging
7494
+ @api_client.config.logger.debug "API called: PdfApi#get_page_strike_out_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7495
+ end
7496
+ return data, status_code, headers
7497
+ end
7498
+
7499
+ # Read page text items.
7500
+ #
7501
+ # @param name The document name.
7502
+ # @param page_number Number of page (starting from 1).
7503
+ # @param llx X-coordinate of lower - left corner.
7504
+ # @param lly Y - coordinate of lower-left corner.
7505
+ # @param urx X - coordinate of upper-right corner.
7506
+ # @param ury Y - coordinate of upper-right corner.
7507
+ # @param [Hash] opts the optional parameters
7508
+ # @option opts [Array<String>] :format List of formats for search.
7509
+ # @option opts [String] :regex Formats are specified as a regular expression.
7510
+ # @option opts [BOOLEAN] :split_rects Split result fragments (default is true).
7511
+ # @option opts [String] :folder The document folder.
7512
+ # @option opts [String] :storage The document storage.
7513
+ # @return [TextRectsResponse]
7514
+ def get_page_text(name, page_number, llx, lly, urx, ury, opts = {})
7515
+ @api_client.request_token_if_needed
7516
+ data, _status_code, _headers = get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, opts)
7517
+ rescue ApiError => error
7518
+ if error.code == 401
7519
+ @api_client.refresh_token
7520
+ data, _status_code, _headers = get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, opts)
7521
+ else
7522
+ raise
7523
+ end
7524
+ return data
7525
+ end
7526
+
7527
+ # Read page text items.
7528
+ #
7529
+ # @param name The document name.
7530
+ # @param page_number Number of page (starting from 1).
7531
+ # @param llx X-coordinate of lower - left corner.
7532
+ # @param lly Y - coordinate of lower-left corner.
7533
+ # @param urx X - coordinate of upper-right corner.
7534
+ # @param ury Y - coordinate of upper-right corner.
7535
+ # @param [Hash] opts the optional parameters
7536
+ # @option opts [Array<String>] :format List of formats for search.
7537
+ # @option opts [String] :regex Formats are specified as a regular expression.
7538
+ # @option opts [BOOLEAN] :split_rects Split result fragments (default is true).
7239
7539
  # @option opts [String] :folder The document folder.
7240
7540
  # @option opts [String] :storage The document storage.
7241
7541
  # @return [Array<(TextRectsResponse, Fixnum, Hash)>] TextRectsResponse data, response status code and response headers
@@ -9042,6 +9342,84 @@ module AsposePdfCloud
9042
9342
  return data, status_code, headers
9043
9343
  end
9044
9344
 
9345
+ # Read document page screen annotation by ID.
9346
+ #
9347
+ # @param name The document name.
9348
+ # @param annotation_id The annotation ID.
9349
+ # @param [Hash] opts the optional parameters
9350
+ # @option opts [String] :storage The document storage.
9351
+ # @option opts [String] :folder The document folder.
9352
+ # @return [ScreenAnnotationResponse]
9353
+ def get_screen_annotation(name, annotation_id, opts = {})
9354
+ @api_client.request_token_if_needed
9355
+ data, _status_code, _headers = get_screen_annotation_with_http_info(name, annotation_id, opts)
9356
+ rescue ApiError => error
9357
+ if error.code == 401
9358
+ @api_client.refresh_token
9359
+ data, _status_code, _headers = get_screen_annotation_with_http_info(name, annotation_id, opts)
9360
+ else
9361
+ raise
9362
+ end
9363
+ return data
9364
+ end
9365
+
9366
+ # Read document page screen annotation by ID.
9367
+ #
9368
+ # @param name The document name.
9369
+ # @param annotation_id The annotation ID.
9370
+ # @param [Hash] opts the optional parameters
9371
+ # @option opts [String] :storage The document storage.
9372
+ # @option opts [String] :folder The document folder.
9373
+ # @return [Array<(ScreenAnnotationResponse, Fixnum, Hash)>] ScreenAnnotationResponse data, response status code and response headers
9374
+ def get_screen_annotation_with_http_info(name, annotation_id, opts = {})
9375
+ if @api_client.config.debugging
9376
+ @api_client.config.logger.debug "Calling API: PdfApi.get_screen_annotation ..."
9377
+ end
9378
+ # verify the required parameter 'name' is set
9379
+ if @api_client.config.client_side_validation && name.nil?
9380
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_screen_annotation"
9381
+ end
9382
+ # verify the required parameter 'annotation_id' is set
9383
+ if @api_client.config.client_side_validation && annotation_id.nil?
9384
+ fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_screen_annotation"
9385
+ end
9386
+ # resource path
9387
+ local_var_path = "/pdf/{name}/annotations/screen/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
9388
+
9389
+ # query parameters
9390
+ query_params = {}
9391
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
9392
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
9393
+
9394
+ # header parameters
9395
+ header_params = {}
9396
+ # HTTP header 'Accept' (if needed)
9397
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9398
+ # HTTP header 'Content-Type'
9399
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9400
+
9401
+ # form parameters
9402
+ form_params = {}
9403
+ # Fix header in file
9404
+ post_body = nil
9405
+
9406
+ # http body (model)
9407
+ # Fix header in file
9408
+ # post_body = nil
9409
+ auth_names = []
9410
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
9411
+ :header_params => header_params,
9412
+ :query_params => query_params,
9413
+ :form_params => form_params,
9414
+ :body => post_body,
9415
+ :auth_names => auth_names,
9416
+ :return_type => 'ScreenAnnotationResponse')
9417
+ if @api_client.config.debugging
9418
+ @api_client.config.logger.debug "API called: PdfApi#get_screen_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9419
+ end
9420
+ return data, status_code, headers
9421
+ end
9422
+
9045
9423
  # Read document page sound annotation by ID.
9046
9424
  #
9047
9425
  # @param name The document name.
@@ -9094,7 +9472,7 @@ module AsposePdfCloud
9094
9472
  # header parameters
9095
9473
  header_params = {}
9096
9474
  # HTTP header 'Accept' (if needed)
9097
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9475
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
9098
9476
  # HTTP header 'Content-Type'
9099
9477
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9100
9478
 
@@ -9172,7 +9550,7 @@ module AsposePdfCloud
9172
9550
  # header parameters
9173
9551
  header_params = {}
9174
9552
  # HTTP header 'Accept' (if needed)
9175
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9553
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
9176
9554
  # HTTP header 'Content-Type'
9177
9555
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9178
9556
 
@@ -9354,6 +9732,162 @@ module AsposePdfCloud
9354
9732
  return data, status_code, headers
9355
9733
  end
9356
9734
 
9735
+ # Read document page stamp annotation by ID.
9736
+ #
9737
+ # @param name The document name.
9738
+ # @param annotation_id The annotation ID.
9739
+ # @param [Hash] opts the optional parameters
9740
+ # @option opts [String] :storage The document storage.
9741
+ # @option opts [String] :folder The document folder.
9742
+ # @return [StampAnnotationResponse]
9743
+ def get_stamp_annotation(name, annotation_id, opts = {})
9744
+ @api_client.request_token_if_needed
9745
+ data, _status_code, _headers = get_stamp_annotation_with_http_info(name, annotation_id, opts)
9746
+ rescue ApiError => error
9747
+ if error.code == 401
9748
+ @api_client.refresh_token
9749
+ data, _status_code, _headers = get_stamp_annotation_with_http_info(name, annotation_id, opts)
9750
+ else
9751
+ raise
9752
+ end
9753
+ return data
9754
+ end
9755
+
9756
+ # Read document page stamp annotation by ID.
9757
+ #
9758
+ # @param name The document name.
9759
+ # @param annotation_id The annotation ID.
9760
+ # @param [Hash] opts the optional parameters
9761
+ # @option opts [String] :storage The document storage.
9762
+ # @option opts [String] :folder The document folder.
9763
+ # @return [Array<(StampAnnotationResponse, Fixnum, Hash)>] StampAnnotationResponse data, response status code and response headers
9764
+ def get_stamp_annotation_with_http_info(name, annotation_id, opts = {})
9765
+ if @api_client.config.debugging
9766
+ @api_client.config.logger.debug "Calling API: PdfApi.get_stamp_annotation ..."
9767
+ end
9768
+ # verify the required parameter 'name' is set
9769
+ if @api_client.config.client_side_validation && name.nil?
9770
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_stamp_annotation"
9771
+ end
9772
+ # verify the required parameter 'annotation_id' is set
9773
+ if @api_client.config.client_side_validation && annotation_id.nil?
9774
+ fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_stamp_annotation"
9775
+ end
9776
+ # resource path
9777
+ local_var_path = "/pdf/{name}/annotations/stamp/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
9778
+
9779
+ # query parameters
9780
+ query_params = {}
9781
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
9782
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
9783
+
9784
+ # header parameters
9785
+ header_params = {}
9786
+ # HTTP header 'Accept' (if needed)
9787
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9788
+ # HTTP header 'Content-Type'
9789
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9790
+
9791
+ # form parameters
9792
+ form_params = {}
9793
+ # Fix header in file
9794
+ post_body = nil
9795
+
9796
+ # http body (model)
9797
+ # Fix header in file
9798
+ # post_body = nil
9799
+ auth_names = []
9800
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
9801
+ :header_params => header_params,
9802
+ :query_params => query_params,
9803
+ :form_params => form_params,
9804
+ :body => post_body,
9805
+ :auth_names => auth_names,
9806
+ :return_type => 'StampAnnotationResponse')
9807
+ if @api_client.config.debugging
9808
+ @api_client.config.logger.debug "API called: PdfApi#get_stamp_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9809
+ end
9810
+ return data, status_code, headers
9811
+ end
9812
+
9813
+ # Read document page stamp annotation by ID.
9814
+ #
9815
+ # @param name The document name.
9816
+ # @param annotation_id The annotation ID.
9817
+ # @param [Hash] opts the optional parameters
9818
+ # @option opts [String] :storage The document storage.
9819
+ # @option opts [String] :folder The document folder.
9820
+ # @return [File]
9821
+ def get_stamp_annotation_data(name, annotation_id, opts = {})
9822
+ @api_client.request_token_if_needed
9823
+ data, _status_code, _headers = get_stamp_annotation_data_with_http_info(name, annotation_id, opts)
9824
+ rescue ApiError => error
9825
+ if error.code == 401
9826
+ @api_client.refresh_token
9827
+ data, _status_code, _headers = get_stamp_annotation_data_with_http_info(name, annotation_id, opts)
9828
+ else
9829
+ raise
9830
+ end
9831
+ return data
9832
+ end
9833
+
9834
+ # Read document page stamp annotation by ID.
9835
+ #
9836
+ # @param name The document name.
9837
+ # @param annotation_id The annotation ID.
9838
+ # @param [Hash] opts the optional parameters
9839
+ # @option opts [String] :storage The document storage.
9840
+ # @option opts [String] :folder The document folder.
9841
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
9842
+ def get_stamp_annotation_data_with_http_info(name, annotation_id, opts = {})
9843
+ if @api_client.config.debugging
9844
+ @api_client.config.logger.debug "Calling API: PdfApi.get_stamp_annotation_data ..."
9845
+ end
9846
+ # verify the required parameter 'name' is set
9847
+ if @api_client.config.client_side_validation && name.nil?
9848
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_stamp_annotation_data"
9849
+ end
9850
+ # verify the required parameter 'annotation_id' is set
9851
+ if @api_client.config.client_side_validation && annotation_id.nil?
9852
+ fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_stamp_annotation_data"
9853
+ end
9854
+ # resource path
9855
+ local_var_path = "/pdf/{name}/annotations/stamp/{annotationId}/data".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
9856
+
9857
+ # query parameters
9858
+ query_params = {}
9859
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
9860
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
9861
+
9862
+ # header parameters
9863
+ header_params = {}
9864
+ # HTTP header 'Accept' (if needed)
9865
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9866
+ # HTTP header 'Content-Type'
9867
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9868
+
9869
+ # form parameters
9870
+ form_params = {}
9871
+ # Fix header in file
9872
+ post_body = nil
9873
+
9874
+ # http body (model)
9875
+ # Fix header in file
9876
+ # post_body = nil
9877
+ auth_names = []
9878
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
9879
+ :header_params => header_params,
9880
+ :query_params => query_params,
9881
+ :form_params => form_params,
9882
+ :body => post_body,
9883
+ :auth_names => auth_names,
9884
+ :return_type => 'File')
9885
+ if @api_client.config.debugging
9886
+ @api_client.config.logger.debug "API called: PdfApi#get_stamp_annotation_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9887
+ end
9888
+ return data, status_code, headers
9889
+ end
9890
+
9357
9891
  # Read document page StrikeOut annotation by ID.
9358
9892
  #
9359
9893
  # @param name The document name.
@@ -12068,6 +12602,89 @@ module AsposePdfCloud
12068
12602
  return data, status_code, headers
12069
12603
  end
12070
12604
 
12605
+ # Add document page screen annotations.
12606
+ #
12607
+ # @param name The document name.
12608
+ # @param page_number The page number.
12609
+ # @param annotations The array of annotation.
12610
+ # @param [Hash] opts the optional parameters
12611
+ # @option opts [String] :storage The document storage.
12612
+ # @option opts [String] :folder The document folder.
12613
+ # @return [AsposeResponse]
12614
+ def post_page_screen_annotations(name, page_number, annotations, opts = {})
12615
+ @api_client.request_token_if_needed
12616
+ data, _status_code, _headers = post_page_screen_annotations_with_http_info(name, page_number, annotations, opts)
12617
+ rescue ApiError => error
12618
+ if error.code == 401
12619
+ @api_client.refresh_token
12620
+ data, _status_code, _headers = post_page_screen_annotations_with_http_info(name, page_number, annotations, opts)
12621
+ else
12622
+ raise
12623
+ end
12624
+ return data
12625
+ end
12626
+
12627
+ # Add document page screen annotations.
12628
+ #
12629
+ # @param name The document name.
12630
+ # @param page_number The page number.
12631
+ # @param annotations The array of annotation.
12632
+ # @param [Hash] opts the optional parameters
12633
+ # @option opts [String] :storage The document storage.
12634
+ # @option opts [String] :folder The document folder.
12635
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
12636
+ def post_page_screen_annotations_with_http_info(name, page_number, annotations, opts = {})
12637
+ if @api_client.config.debugging
12638
+ @api_client.config.logger.debug "Calling API: PdfApi.post_page_screen_annotations ..."
12639
+ end
12640
+ # verify the required parameter 'name' is set
12641
+ if @api_client.config.client_side_validation && name.nil?
12642
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_screen_annotations"
12643
+ end
12644
+ # verify the required parameter 'page_number' is set
12645
+ if @api_client.config.client_side_validation && page_number.nil?
12646
+ fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_screen_annotations"
12647
+ end
12648
+ # verify the required parameter 'annotations' is set
12649
+ if @api_client.config.client_side_validation && annotations.nil?
12650
+ fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_screen_annotations"
12651
+ end
12652
+ # resource path
12653
+ local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/screen".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
12654
+
12655
+ # query parameters
12656
+ query_params = {}
12657
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
12658
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
12659
+
12660
+ # header parameters
12661
+ header_params = {}
12662
+ # HTTP header 'Accept' (if needed)
12663
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12664
+ # HTTP header 'Content-Type'
12665
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
12666
+
12667
+ # form parameters
12668
+ form_params = {}
12669
+ # Fix header in file
12670
+ post_body = nil
12671
+
12672
+ # http body (model)
12673
+ post_body = @api_client.object_to_http_body(annotations)
12674
+ auth_names = []
12675
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
12676
+ :header_params => header_params,
12677
+ :query_params => query_params,
12678
+ :form_params => form_params,
12679
+ :body => post_body,
12680
+ :auth_names => auth_names,
12681
+ :return_type => 'AsposeResponse')
12682
+ if @api_client.config.debugging
12683
+ @api_client.config.logger.debug "API called: PdfApi#post_page_screen_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12684
+ end
12685
+ return data, status_code, headers
12686
+ end
12687
+
12071
12688
  # Add document page sound annotations.
12072
12689
  #
12073
12690
  # @param name The document name.
@@ -12317,6 +12934,89 @@ module AsposePdfCloud
12317
12934
  return data, status_code, headers
12318
12935
  end
12319
12936
 
12937
+ # Add document page stamp annotations.
12938
+ #
12939
+ # @param name The document name.
12940
+ # @param page_number The page number.
12941
+ # @param annotations The array of annotation.
12942
+ # @param [Hash] opts the optional parameters
12943
+ # @option opts [String] :storage The document storage.
12944
+ # @option opts [String] :folder The document folder.
12945
+ # @return [AsposeResponse]
12946
+ def post_page_stamp_annotations(name, page_number, annotations, opts = {})
12947
+ @api_client.request_token_if_needed
12948
+ data, _status_code, _headers = post_page_stamp_annotations_with_http_info(name, page_number, annotations, opts)
12949
+ rescue ApiError => error
12950
+ if error.code == 401
12951
+ @api_client.refresh_token
12952
+ data, _status_code, _headers = post_page_stamp_annotations_with_http_info(name, page_number, annotations, opts)
12953
+ else
12954
+ raise
12955
+ end
12956
+ return data
12957
+ end
12958
+
12959
+ # Add document page stamp annotations.
12960
+ #
12961
+ # @param name The document name.
12962
+ # @param page_number The page number.
12963
+ # @param annotations The array of annotation.
12964
+ # @param [Hash] opts the optional parameters
12965
+ # @option opts [String] :storage The document storage.
12966
+ # @option opts [String] :folder The document folder.
12967
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
12968
+ def post_page_stamp_annotations_with_http_info(name, page_number, annotations, opts = {})
12969
+ if @api_client.config.debugging
12970
+ @api_client.config.logger.debug "Calling API: PdfApi.post_page_stamp_annotations ..."
12971
+ end
12972
+ # verify the required parameter 'name' is set
12973
+ if @api_client.config.client_side_validation && name.nil?
12974
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_stamp_annotations"
12975
+ end
12976
+ # verify the required parameter 'page_number' is set
12977
+ if @api_client.config.client_side_validation && page_number.nil?
12978
+ fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_stamp_annotations"
12979
+ end
12980
+ # verify the required parameter 'annotations' is set
12981
+ if @api_client.config.client_side_validation && annotations.nil?
12982
+ fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_stamp_annotations"
12983
+ end
12984
+ # resource path
12985
+ local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/stamp".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
12986
+
12987
+ # query parameters
12988
+ query_params = {}
12989
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
12990
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
12991
+
12992
+ # header parameters
12993
+ header_params = {}
12994
+ # HTTP header 'Accept' (if needed)
12995
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12996
+ # HTTP header 'Content-Type'
12997
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
12998
+
12999
+ # form parameters
13000
+ form_params = {}
13001
+ # Fix header in file
13002
+ post_body = nil
13003
+
13004
+ # http body (model)
13005
+ post_body = @api_client.object_to_http_body(annotations)
13006
+ auth_names = []
13007
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
13008
+ :header_params => header_params,
13009
+ :query_params => query_params,
13010
+ :form_params => form_params,
13011
+ :body => post_body,
13012
+ :auth_names => auth_names,
13013
+ :return_type => 'AsposeResponse')
13014
+ if @api_client.config.debugging
13015
+ @api_client.config.logger.debug "API called: PdfApi#post_page_stamp_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13016
+ end
13017
+ return data, status_code, headers
13018
+ end
13019
+
12320
13020
  # Add document page StrikeOut annotations.
12321
13021
  #
12322
13022
  # @param name The document name.
@@ -13001,12 +13701,92 @@ module AsposePdfCloud
13001
13701
  fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_add_new_page"
13002
13702
  end
13003
13703
  # resource path
13004
- local_var_path = "/pdf/{name}/pages".sub('{' + 'name' + '}', name.to_s)
13704
+ local_var_path = "/pdf/{name}/pages".sub('{' + 'name' + '}', name.to_s)
13705
+
13706
+ # query parameters
13707
+ query_params = {}
13708
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
13709
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
13710
+
13711
+ # header parameters
13712
+ header_params = {}
13713
+ # HTTP header 'Accept' (if needed)
13714
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13715
+ # HTTP header 'Content-Type'
13716
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
13717
+
13718
+ # form parameters
13719
+ form_params = {}
13720
+ # Fix header in file
13721
+ post_body = nil
13722
+
13723
+ # http body (model)
13724
+ # Fix header in file
13725
+ # post_body = nil
13726
+ auth_names = []
13727
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
13728
+ :header_params => header_params,
13729
+ :query_params => query_params,
13730
+ :form_params => form_params,
13731
+ :body => post_body,
13732
+ :auth_names => auth_names,
13733
+ :return_type => 'DocumentPagesResponse')
13734
+ if @api_client.config.debugging
13735
+ @api_client.config.logger.debug "API called: PdfApi#put_add_new_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13736
+ end
13737
+ return data, status_code, headers
13738
+ end
13739
+
13740
+ # Add text to PDF document page.
13741
+ #
13742
+ # @param name The document name.
13743
+ # @param page_number Number of page (starting from 1).
13744
+ # @param [Hash] opts the optional parameters
13745
+ # @option opts [Paragraph] :paragraph Paragraph data.
13746
+ # @option opts [String] :folder Document folder.
13747
+ # @option opts [String] :storage The document storage.
13748
+ # @return [AsposeResponse]
13749
+ def put_add_text(name, page_number, opts = {})
13750
+ @api_client.request_token_if_needed
13751
+ data, _status_code, _headers = put_add_text_with_http_info(name, page_number, opts)
13752
+ rescue ApiError => error
13753
+ if error.code == 401
13754
+ @api_client.refresh_token
13755
+ data, _status_code, _headers = put_add_text_with_http_info(name, page_number, opts)
13756
+ else
13757
+ raise
13758
+ end
13759
+ return data
13760
+ end
13761
+
13762
+ # Add text to PDF document page.
13763
+ #
13764
+ # @param name The document name.
13765
+ # @param page_number Number of page (starting from 1).
13766
+ # @param [Hash] opts the optional parameters
13767
+ # @option opts [Paragraph] :paragraph Paragraph data.
13768
+ # @option opts [String] :folder Document folder.
13769
+ # @option opts [String] :storage The document storage.
13770
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
13771
+ def put_add_text_with_http_info(name, page_number, opts = {})
13772
+ if @api_client.config.debugging
13773
+ @api_client.config.logger.debug "Calling API: PdfApi.put_add_text ..."
13774
+ end
13775
+ # verify the required parameter 'name' is set
13776
+ if @api_client.config.client_side_validation && name.nil?
13777
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_add_text"
13778
+ end
13779
+ # verify the required parameter 'page_number' is set
13780
+ if @api_client.config.client_side_validation && page_number.nil?
13781
+ fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_add_text"
13782
+ end
13783
+ # resource path
13784
+ local_var_path = "/pdf/{name}/pages/{pageNumber}/text".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
13005
13785
 
13006
13786
  # query parameters
13007
13787
  query_params = {}
13008
- query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
13009
13788
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
13789
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
13010
13790
 
13011
13791
  # header parameters
13012
13792
  header_params = {}
@@ -13021,8 +13801,7 @@ module AsposePdfCloud
13021
13801
  post_body = nil
13022
13802
 
13023
13803
  # http body (model)
13024
- # Fix header in file
13025
- # post_body = nil
13804
+ post_body = @api_client.object_to_http_body(opts[:'paragraph'])
13026
13805
  auth_names = []
13027
13806
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
13028
13807
  :header_params => header_params,
@@ -13030,63 +13809,64 @@ module AsposePdfCloud
13030
13809
  :form_params => form_params,
13031
13810
  :body => post_body,
13032
13811
  :auth_names => auth_names,
13033
- :return_type => 'DocumentPagesResponse')
13812
+ :return_type => 'AsposeResponse')
13034
13813
  if @api_client.config.debugging
13035
- @api_client.config.logger.debug "API called: PdfApi#put_add_new_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13814
+ @api_client.config.logger.debug "API called: PdfApi#put_add_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13036
13815
  end
13037
13816
  return data, status_code, headers
13038
13817
  end
13039
13818
 
13040
- # Add text to PDF document page.
13819
+ # Flattens the annotations of the specified types
13041
13820
  #
13042
13821
  # @param name The document name.
13043
- # @param page_number Number of page (starting from 1).
13044
13822
  # @param [Hash] opts the optional parameters
13045
- # @option opts [Paragraph] :paragraph Paragraph data.
13046
- # @option opts [String] :folder Document folder.
13823
+ # @option opts [Integer] :start_page The start page number.
13824
+ # @option opts [Integer] :end_page The end page number.
13825
+ # @option opts [Array<AnnotationType>] :annotation_types Array of annotation types.
13047
13826
  # @option opts [String] :storage The document storage.
13827
+ # @option opts [String] :folder The document folder.
13048
13828
  # @return [AsposeResponse]
13049
- def put_add_text(name, page_number, opts = {})
13829
+ def put_annotations_flatten(name, opts = {})
13050
13830
  @api_client.request_token_if_needed
13051
- data, _status_code, _headers = put_add_text_with_http_info(name, page_number, opts)
13831
+ data, _status_code, _headers = put_annotations_flatten_with_http_info(name, opts)
13052
13832
  rescue ApiError => error
13053
13833
  if error.code == 401
13054
13834
  @api_client.refresh_token
13055
- data, _status_code, _headers = put_add_text_with_http_info(name, page_number, opts)
13835
+ data, _status_code, _headers = put_annotations_flatten_with_http_info(name, opts)
13056
13836
  else
13057
13837
  raise
13058
13838
  end
13059
13839
  return data
13060
13840
  end
13061
13841
 
13062
- # Add text to PDF document page.
13842
+ # Flattens the annotations of the specified types
13063
13843
  #
13064
13844
  # @param name The document name.
13065
- # @param page_number Number of page (starting from 1).
13066
13845
  # @param [Hash] opts the optional parameters
13067
- # @option opts [Paragraph] :paragraph Paragraph data.
13068
- # @option opts [String] :folder Document folder.
13846
+ # @option opts [Integer] :start_page The start page number.
13847
+ # @option opts [Integer] :end_page The end page number.
13848
+ # @option opts [Array<AnnotationType>] :annotation_types Array of annotation types.
13069
13849
  # @option opts [String] :storage The document storage.
13850
+ # @option opts [String] :folder The document folder.
13070
13851
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
13071
- def put_add_text_with_http_info(name, page_number, opts = {})
13852
+ def put_annotations_flatten_with_http_info(name, opts = {})
13072
13853
  if @api_client.config.debugging
13073
- @api_client.config.logger.debug "Calling API: PdfApi.put_add_text ..."
13854
+ @api_client.config.logger.debug "Calling API: PdfApi.put_annotations_flatten ..."
13074
13855
  end
13075
13856
  # verify the required parameter 'name' is set
13076
13857
  if @api_client.config.client_side_validation && name.nil?
13077
- fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_add_text"
13078
- end
13079
- # verify the required parameter 'page_number' is set
13080
- if @api_client.config.client_side_validation && page_number.nil?
13081
- fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_add_text"
13858
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_annotations_flatten"
13082
13859
  end
13083
13860
  # resource path
13084
- local_var_path = "/pdf/{name}/pages/{pageNumber}/text".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
13861
+ local_var_path = "/pdf/{name}/annotations/flatten".sub('{' + 'name' + '}', name.to_s)
13085
13862
 
13086
13863
  # query parameters
13087
13864
  query_params = {}
13088
- query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
13865
+ query_params[:'startPage'] = opts[:'start_page'] if !opts[:'start_page'].nil?
13866
+ query_params[:'endPage'] = opts[:'end_page'] if !opts[:'end_page'].nil?
13867
+ query_params[:'annotationTypes'] = @api_client.build_collection_param(opts[:'annotation_types'], :multi) if !opts[:'annotation_types'].nil?
13089
13868
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
13869
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
13090
13870
 
13091
13871
  # header parameters
13092
13872
  header_params = {}
@@ -13101,7 +13881,8 @@ module AsposePdfCloud
13101
13881
  post_body = nil
13102
13882
 
13103
13883
  # http body (model)
13104
- post_body = @api_client.object_to_http_body(opts[:'paragraph'])
13884
+ # Fix header in file
13885
+ # post_body = nil
13105
13886
  auth_names = []
13106
13887
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
13107
13888
  :header_params => header_params,
@@ -13111,7 +13892,7 @@ module AsposePdfCloud
13111
13892
  :auth_names => auth_names,
13112
13893
  :return_type => 'AsposeResponse')
13113
13894
  if @api_client.config.debugging
13114
- @api_client.config.logger.debug "API called: PdfApi#put_add_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13895
+ @api_client.config.logger.debug "API called: PdfApi#put_annotations_flatten\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13115
13896
  end
13116
13897
  return data, status_code, headers
13117
13898
  end
@@ -15201,7 +15982,7 @@ module AsposePdfCloud
15201
15982
  # @option opts [MergeDocuments] :merge_documents with a list of documents.
15202
15983
  # @option opts [String] :storage Resulting document storage.
15203
15984
  # @option opts [String] :folder Resulting document folder.
15204
- # @return [File]
15985
+ # @return [DocumentResponse]
15205
15986
  def put_merge_documents(name, opts = {})
15206
15987
  @api_client.request_token_if_needed
15207
15988
  data, _status_code, _headers = put_merge_documents_with_http_info(name, opts)
@@ -15222,7 +16003,7 @@ module AsposePdfCloud
15222
16003
  # @option opts [MergeDocuments] :merge_documents with a list of documents.
15223
16004
  # @option opts [String] :storage Resulting document storage.
15224
16005
  # @option opts [String] :folder Resulting document folder.
15225
- # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
16006
+ # @return [Array<(DocumentResponse, Fixnum, Hash)>] DocumentResponse data, response status code and response headers
15226
16007
  def put_merge_documents_with_http_info(name, opts = {})
15227
16008
  if @api_client.config.debugging
15228
16009
  @api_client.config.logger.debug "Calling API: PdfApi.put_merge_documents ..."
@@ -15260,7 +16041,7 @@ module AsposePdfCloud
15260
16041
  :form_params => form_params,
15261
16042
  :body => post_body,
15262
16043
  :auth_names => auth_names,
15263
- :return_type => 'File')
16044
+ :return_type => 'DocumentResponse')
15264
16045
  if @api_client.config.debugging
15265
16046
  @api_client.config.logger.debug "API called: PdfApi#put_merge_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
15266
16047
  end
@@ -18910,6 +19691,89 @@ module AsposePdfCloud
18910
19691
  return data, status_code, headers
18911
19692
  end
18912
19693
 
19694
+ # Replace document screen annotation
19695
+ #
19696
+ # @param name The document name.
19697
+ # @param annotation_id The annotation ID.
19698
+ # @param annotation Annotation.
19699
+ # @param [Hash] opts the optional parameters
19700
+ # @option opts [String] :storage The document storage.
19701
+ # @option opts [String] :folder The document folder.
19702
+ # @return [ScreenAnnotationResponse]
19703
+ def put_screen_annotation(name, annotation_id, annotation, opts = {})
19704
+ @api_client.request_token_if_needed
19705
+ data, _status_code, _headers = put_screen_annotation_with_http_info(name, annotation_id, annotation, opts)
19706
+ rescue ApiError => error
19707
+ if error.code == 401
19708
+ @api_client.refresh_token
19709
+ data, _status_code, _headers = put_screen_annotation_with_http_info(name, annotation_id, annotation, opts)
19710
+ else
19711
+ raise
19712
+ end
19713
+ return data
19714
+ end
19715
+
19716
+ # Replace document screen annotation
19717
+ #
19718
+ # @param name The document name.
19719
+ # @param annotation_id The annotation ID.
19720
+ # @param annotation Annotation.
19721
+ # @param [Hash] opts the optional parameters
19722
+ # @option opts [String] :storage The document storage.
19723
+ # @option opts [String] :folder The document folder.
19724
+ # @return [Array<(ScreenAnnotationResponse, Fixnum, Hash)>] ScreenAnnotationResponse data, response status code and response headers
19725
+ def put_screen_annotation_with_http_info(name, annotation_id, annotation, opts = {})
19726
+ if @api_client.config.debugging
19727
+ @api_client.config.logger.debug "Calling API: PdfApi.put_screen_annotation ..."
19728
+ end
19729
+ # verify the required parameter 'name' is set
19730
+ if @api_client.config.client_side_validation && name.nil?
19731
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_screen_annotation"
19732
+ end
19733
+ # verify the required parameter 'annotation_id' is set
19734
+ if @api_client.config.client_side_validation && annotation_id.nil?
19735
+ fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_screen_annotation"
19736
+ end
19737
+ # verify the required parameter 'annotation' is set
19738
+ if @api_client.config.client_side_validation && annotation.nil?
19739
+ fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_screen_annotation"
19740
+ end
19741
+ # resource path
19742
+ local_var_path = "/pdf/{name}/annotations/screen/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
19743
+
19744
+ # query parameters
19745
+ query_params = {}
19746
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
19747
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
19748
+
19749
+ # header parameters
19750
+ header_params = {}
19751
+ # HTTP header 'Accept' (if needed)
19752
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19753
+ # HTTP header 'Content-Type'
19754
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
19755
+
19756
+ # form parameters
19757
+ form_params = {}
19758
+ # Fix header in file
19759
+ post_body = nil
19760
+
19761
+ # http body (model)
19762
+ post_body = @api_client.object_to_http_body(annotation)
19763
+ auth_names = []
19764
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
19765
+ :header_params => header_params,
19766
+ :query_params => query_params,
19767
+ :form_params => form_params,
19768
+ :body => post_body,
19769
+ :auth_names => auth_names,
19770
+ :return_type => 'ScreenAnnotationResponse')
19771
+ if @api_client.config.debugging
19772
+ @api_client.config.logger.debug "API called: PdfApi#put_screen_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19773
+ end
19774
+ return data, status_code, headers
19775
+ end
19776
+
18913
19777
  # Create searchable PDF document. Generate OCR layer for images in input PDF document.
18914
19778
  #
18915
19779
  # @param name The document name.
@@ -19404,6 +20268,174 @@ module AsposePdfCloud
19404
20268
  return data, status_code, headers
19405
20269
  end
19406
20270
 
20271
+ # Replace document stamp annotation
20272
+ #
20273
+ # @param name The document name.
20274
+ # @param annotation_id The annotation ID.
20275
+ # @param annotation Annotation.
20276
+ # @param [Hash] opts the optional parameters
20277
+ # @option opts [String] :storage The document storage.
20278
+ # @option opts [String] :folder The document folder.
20279
+ # @return [StampAnnotationResponse]
20280
+ def put_stamp_annotation(name, annotation_id, annotation, opts = {})
20281
+ @api_client.request_token_if_needed
20282
+ data, _status_code, _headers = put_stamp_annotation_with_http_info(name, annotation_id, annotation, opts)
20283
+ rescue ApiError => error
20284
+ if error.code == 401
20285
+ @api_client.refresh_token
20286
+ data, _status_code, _headers = put_stamp_annotation_with_http_info(name, annotation_id, annotation, opts)
20287
+ else
20288
+ raise
20289
+ end
20290
+ return data
20291
+ end
20292
+
20293
+ # Replace document stamp annotation
20294
+ #
20295
+ # @param name The document name.
20296
+ # @param annotation_id The annotation ID.
20297
+ # @param annotation Annotation.
20298
+ # @param [Hash] opts the optional parameters
20299
+ # @option opts [String] :storage The document storage.
20300
+ # @option opts [String] :folder The document folder.
20301
+ # @return [Array<(StampAnnotationResponse, Fixnum, Hash)>] StampAnnotationResponse data, response status code and response headers
20302
+ def put_stamp_annotation_with_http_info(name, annotation_id, annotation, opts = {})
20303
+ if @api_client.config.debugging
20304
+ @api_client.config.logger.debug "Calling API: PdfApi.put_stamp_annotation ..."
20305
+ end
20306
+ # verify the required parameter 'name' is set
20307
+ if @api_client.config.client_side_validation && name.nil?
20308
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_stamp_annotation"
20309
+ end
20310
+ # verify the required parameter 'annotation_id' is set
20311
+ if @api_client.config.client_side_validation && annotation_id.nil?
20312
+ fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_stamp_annotation"
20313
+ end
20314
+ # verify the required parameter 'annotation' is set
20315
+ if @api_client.config.client_side_validation && annotation.nil?
20316
+ fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_stamp_annotation"
20317
+ end
20318
+ # resource path
20319
+ local_var_path = "/pdf/{name}/annotations/stamp/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
20320
+
20321
+ # query parameters
20322
+ query_params = {}
20323
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
20324
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
20325
+
20326
+ # header parameters
20327
+ header_params = {}
20328
+ # HTTP header 'Accept' (if needed)
20329
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
20330
+ # HTTP header 'Content-Type'
20331
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
20332
+
20333
+ # form parameters
20334
+ form_params = {}
20335
+ # Fix header in file
20336
+ post_body = nil
20337
+
20338
+ # http body (model)
20339
+ post_body = @api_client.object_to_http_body(annotation)
20340
+ auth_names = []
20341
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
20342
+ :header_params => header_params,
20343
+ :query_params => query_params,
20344
+ :form_params => form_params,
20345
+ :body => post_body,
20346
+ :auth_names => auth_names,
20347
+ :return_type => 'StampAnnotationResponse')
20348
+ if @api_client.config.debugging
20349
+ @api_client.config.logger.debug "API called: PdfApi#put_stamp_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
20350
+ end
20351
+ return data, status_code, headers
20352
+ end
20353
+
20354
+ # Extract document stamp annotation content to storage
20355
+ #
20356
+ # @param name The document name.
20357
+ # @param annotation_id The annotation ID.
20358
+ # @param out_file_path The output file path.
20359
+ # @param [Hash] opts the optional parameters
20360
+ # @option opts [String] :storage The document storage.
20361
+ # @option opts [String] :folder The document folder.
20362
+ # @return [AsposeResponse]
20363
+ def put_stamp_annotation_data_extract(name, annotation_id, out_file_path, opts = {})
20364
+ @api_client.request_token_if_needed
20365
+ data, _status_code, _headers = put_stamp_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts)
20366
+ rescue ApiError => error
20367
+ if error.code == 401
20368
+ @api_client.refresh_token
20369
+ data, _status_code, _headers = put_stamp_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts)
20370
+ else
20371
+ raise
20372
+ end
20373
+ return data
20374
+ end
20375
+
20376
+ # Extract document stamp annotation content to storage
20377
+ #
20378
+ # @param name The document name.
20379
+ # @param annotation_id The annotation ID.
20380
+ # @param out_file_path The output file path.
20381
+ # @param [Hash] opts the optional parameters
20382
+ # @option opts [String] :storage The document storage.
20383
+ # @option opts [String] :folder The document folder.
20384
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
20385
+ def put_stamp_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts = {})
20386
+ if @api_client.config.debugging
20387
+ @api_client.config.logger.debug "Calling API: PdfApi.put_stamp_annotation_data_extract ..."
20388
+ end
20389
+ # verify the required parameter 'name' is set
20390
+ if @api_client.config.client_side_validation && name.nil?
20391
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_stamp_annotation_data_extract"
20392
+ end
20393
+ # verify the required parameter 'annotation_id' is set
20394
+ if @api_client.config.client_side_validation && annotation_id.nil?
20395
+ fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_stamp_annotation_data_extract"
20396
+ end
20397
+ # verify the required parameter 'out_file_path' is set
20398
+ if @api_client.config.client_side_validation && out_file_path.nil?
20399
+ fail ArgumentError, "Missing the required parameter 'out_file_path' when calling PdfApi.put_stamp_annotation_data_extract"
20400
+ end
20401
+ # resource path
20402
+ local_var_path = "/pdf/{name}/annotations/stamp/{annotationId}/data/extract".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
20403
+
20404
+ # query parameters
20405
+ query_params = {}
20406
+ query_params[:'outFilePath'] = out_file_path
20407
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
20408
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
20409
+
20410
+ # header parameters
20411
+ header_params = {}
20412
+ # HTTP header 'Accept' (if needed)
20413
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
20414
+ # HTTP header 'Content-Type'
20415
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
20416
+
20417
+ # form parameters
20418
+ form_params = {}
20419
+ # Fix header in file
20420
+ post_body = nil
20421
+
20422
+ # http body (model)
20423
+ # Fix header in file
20424
+ # post_body = nil
20425
+ auth_names = []
20426
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
20427
+ :header_params => header_params,
20428
+ :query_params => query_params,
20429
+ :form_params => form_params,
20430
+ :body => post_body,
20431
+ :auth_names => auth_names,
20432
+ :return_type => 'AsposeResponse')
20433
+ if @api_client.config.debugging
20434
+ @api_client.config.logger.debug "API called: PdfApi#put_stamp_annotation_data_extract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
20435
+ end
20436
+ return data, status_code, headers
20437
+ end
20438
+
19407
20439
  # Replace document StrikeOut annotation
19408
20440
  #
19409
20441
  # @param name The document name.