aspose_pdf_cloud 23.8.0 → 23.10.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2b4a251cc79f46c619988bdf83e4c6d80c5cef35f02936bbe2b0e2ab294d65a1
4
- data.tar.gz: d04cdbd86931df55898fb5b49070415e2744c760a67e0475e9309ac64ff65ba8
3
+ metadata.gz: 5710c7846e8fac23698b27eb350e966b1b5cee5c9ea0e8551124684f5f094813
4
+ data.tar.gz: bd9dc4f6502df0200ee90d4402851626e44c61ff84f842a2c4afc476b69f7599
5
5
  SHA512:
6
- metadata.gz: c90ae8624324707d450507aa311da1cd44ce36dfae253b89e4bc7de2d3de6340b21e0bfbf6856a793f45ddfbd0a42c3b1a3d5eb62ee6bd6b2b45dfb9f727ae93
7
- data.tar.gz: 91baacd9b060748e66bf94e24e0732877fea5b70e55b81cadb6162a81a2732058b1e5393d6983cb462a21ec01ab8908c4265d1b20425e0b466841443de5ddf96
6
+ metadata.gz: a768377c206d7a0c59720ef80ea72d8739fa002ea43608a5162d2fcf615bcbf5707ef9077f37a8e78d519e9791b5a519bc5eebb5722b296ad702d2ca2a3331cd
7
+ data.tar.gz: e9bf259c0294f0bf0b28c25d357c27ab0780d986ab18103c717bb98d732296a9b5d5cbb2bca9265cdd3dbe16c325d783b2571c0f9f2d9f8676739fc46635b0cf
data/README.md CHANGED
@@ -29,16 +29,23 @@ XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text
29
29
  ## Read PDF Formats
30
30
  MHT, PCL, PS, XSLFO, MD
31
31
 
32
- ## Enhancements in Version 23.8
33
- - Support to split password protected PDF documents.
34
- - Support to convert password Protected PDF to Xlsx.
35
- - Support to convert password Protected PDF to Excel.
36
- - Replace a single image using multiple Image Ids.
32
+ ## Enhancements in Version 23.10
33
+ - Support of reading common info of password protected PDF in GetDocument API.
34
+ - Support stamp password protected document using DeleteDocumentStamps API method.
35
+ - Support stamp password protected document using DeleteStamp API method.
36
+ - Support stamp password protected document using PostDocumentPageNumberStamps API method.
37
+ - Support stamp password protected document using PostPageImageStamps API method.
38
+ - Support stamp password protected document using PostPageTextStamps API method.
39
+ - Support stamp password protected document using GetPageStamps API method.
40
+ - Support stamp password protected document using GetDocumentStamps API method.
41
+ - Support stamp password protected document using PostPagePdfPageStamps API method.
42
+ - Support stamp password protected document using DeletePageStamps API method.
43
+ - Develop a method to add an attachment file to a PDF document.
37
44
  - A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.
38
45
 
39
- ## Bugs fixed in Version 23.8
40
- - The putMergeDocuments API method in Node.js Throws Gateway Error.
41
- - Text Replacement Changes the Background.
46
+ ## Bugs fixed in Version 23.10
47
+ - Aspose.PDF Cloud PostFlattenDocument API Issue.
48
+ - The GetPages API throws timeout error for PDF files larger than 10 Mb.
42
49
 
43
50
  ## Installation
44
51
 
@@ -53,15 +60,15 @@ gem build aspose_pdf_cloud.gemspec
53
60
  Then either install the gem locally:
54
61
 
55
62
  ```shell
56
- gem install ./aspose_pdf_cloud-23.8.0.gem
63
+ gem install ./aspose_pdf_cloud-23.10.0.gem
57
64
  ```
58
- (for development, run `gem install --dev ./aspose_pdf_cloud-23.8.0.gem` to install the development dependencies)
65
+ (for development, run `gem install --dev ./aspose_pdf_cloud-23.10.0.gem` to install the development dependencies)
59
66
 
60
67
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
61
68
 
62
69
  Finally add this to the Gemfile:
63
70
 
64
- gem 'aspose_pdf_cloud', '~> 23.8.0'
71
+ gem 'aspose_pdf_cloud', '~> 23.10.0'
65
72
 
66
73
  ### Install from Git
67
74
 
@@ -0,0 +1,12 @@
1
+ # AsposePdfCloud::AttachmentInfo
2
+ Attachment Info.
3
+
4
+ ## Properties
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **path** | **String** | Attachment file path. |
8
+ **description** | **String** | Attachment file description. | [optional]
9
+ **name** | **String** | Attachment file name. | [optional]
10
+ **mime_type** | **String** | Attachment file MIME type. | [optional]
11
+
12
+
data/docs/Page.md CHANGED
@@ -6,7 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
8
8
  **id** | **Integer** | Page's id. |
9
- **images** | [**Images**](Images.md) | Page's images | [optional]
10
9
  **rectangle** | [**Rectangle**](Rectangle.md) | Page's rectangle | [optional]
11
10
 
12
11
 
data/docs/PdfApi.md CHANGED
@@ -191,6 +191,7 @@ Method | HTTP request | Description
191
191
  [**move_file**](PdfApi.md#move_file) | **PUT** /pdf/storage/file/move/\{srcPath} | Move file
192
192
  [**move_folder**](PdfApi.md#move_folder) | **PUT** /pdf/storage/folder/move/\{srcPath} | Move folder
193
193
  [**object_exists**](PdfApi.md#object_exists) | **GET** /pdf/storage/exist/\{path} | Check if file or folder exists
194
+ [**post_add_document_attachment**](PdfApi.md#post_add_document_attachment) | **POST** /pdf/\{name}/attachments | Adds a file attachment to the PDF document.
194
195
  [**post_append_document**](PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one.
195
196
  [**post_bookmark**](PdfApi.md#post_bookmark) | **POST** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Add document bookmarks.
196
197
  [**post_change_password_document_in_storage**](PdfApi.md#post_change_password_document_in_storage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
@@ -575,6 +576,7 @@ Name | Type | Description | Notes
575
576
  **name** | **String**| The document name. |
576
577
  **storage** | **String**| The document storage. | [optional]
577
578
  **folder** | **String**| The document folder. | [optional]
579
+ **password** | **String**| Base64 encoded password. | [optional]
578
580
 
579
581
  ### Return type
580
582
 
@@ -822,6 +824,7 @@ Name | Type | Description | Notes
822
824
  **page_number** | **Integer**| The page number. |
823
825
  **storage** | **String**| The document storage. | [optional]
824
826
  **folder** | **String**| The document folder. | [optional]
827
+ **password** | **String**| Base64 encoded password. | [optional]
825
828
 
826
829
  ### Return type
827
830
 
@@ -921,6 +924,7 @@ Name | Type | Description | Notes
921
924
  **stamp_id** | **String**| The stamp ID. |
922
925
  **storage** | **String**| The document storage. | [optional]
923
926
  **folder** | **String**| The document folder. | [optional]
927
+ **password** | **String**| Base64 encoded password. | [optional]
924
928
 
925
929
  ### Return type
926
930
 
@@ -1166,6 +1170,7 @@ Name | Type | Description | Notes
1166
1170
  **name** | **String**| The document name. |
1167
1171
  **storage** | **String**| The document storage. | [optional]
1168
1172
  **folder** | **String**| The document folder. | [optional]
1173
+ **password** | **String**| Base64 encoded password. | [optional]
1169
1174
 
1170
1175
  ### Return type
1171
1176
 
@@ -3627,6 +3632,7 @@ Name | Type | Description | Notes
3627
3632
  **page_number** | **Integer**| The page number. |
3628
3633
  **storage** | **String**| The document storage. | [optional]
3629
3634
  **folder** | **String**| The document folder. | [optional]
3635
+ **password** | **String**| Base64 encoded password. | [optional]
3630
3636
 
3631
3637
  ### Return type
3632
3638
 
@@ -4015,6 +4021,7 @@ Name | Type | Description | Notes
4015
4021
  **type** | **String**| Type of PdfA format. |
4016
4022
  **folder** | **String**| The document folder. | [optional]
4017
4023
  **storage** | **String**| The document storage. | [optional]
4024
+ **password** | **String**| The password (Base64). | [optional]
4018
4025
 
4019
4026
  ### Return type
4020
4027
 
@@ -5079,6 +5086,31 @@ Name | Type | Description | Notes
5079
5086
 
5080
5087
 
5081
5088
 
5089
+ # **post_add_document_attachment**
5090
+ > AttachmentsResponse post_add_document_attachment(name, attachment_info, opts)
5091
+
5092
+ Adds a file attachment to the PDF document.
5093
+
5094
+ ### Parameters
5095
+
5096
+ Name | Type | Description | Notes
5097
+ ------------- | ------------- | ------------- | -------------
5098
+ **name** | **String**| The document name. |
5099
+ **attachment_info** | [**AttachmentInfo**](AttachmentInfo.md)| AttachmentInfoAttachmentInfo instance. |
5100
+ **storage** | **String**| The document storage. | [optional]
5101
+ **folder** | **String**| The document folder. | [optional]
5102
+
5103
+ ### Return type
5104
+
5105
+ [**AttachmentsResponse**](AttachmentsResponse.md)
5106
+
5107
+ ### HTTP request headers
5108
+
5109
+ - **Content-Type**: application/json
5110
+ - **Accept**: application/json
5111
+
5112
+
5113
+
5082
5114
  # **post_append_document**
5083
5115
  > DocumentResponse post_append_document(name, append_file, opts)
5084
5116
 
@@ -5354,6 +5386,7 @@ Name | Type | Description | Notes
5354
5386
  **end_page_number** | **Integer**| The end page number. | [optional]
5355
5387
  **storage** | **String**| The document storage. | [optional]
5356
5388
  **folder** | **String**| The document folder. | [optional]
5389
+ **password** | **String**| Base64 encoded password. | [optional]
5357
5390
 
5358
5391
  ### Return type
5359
5392
 
@@ -5904,6 +5937,7 @@ Name | Type | Description | Notes
5904
5937
  **stamps** | [**Array<ImageStamp>**](ImageStamp.md)| The array of stamp. |
5905
5938
  **storage** | **String**| The document storage. | [optional]
5906
5939
  **folder** | **String**| The document folder. | [optional]
5940
+ **password** | **String**| Base64 encoded password. | [optional]
5907
5941
 
5908
5942
  ### Return type
5909
5943
 
@@ -6034,6 +6068,7 @@ Name | Type | Description | Notes
6034
6068
  **stamps** | [**Array<PdfPageStamp>**](PdfPageStamp.md)| The array of stamp. |
6035
6069
  **storage** | **String**| The document storage. | [optional]
6036
6070
  **folder** | **String**| The document folder. | [optional]
6071
+ **password** | **String**| Base64 encoded password. | [optional]
6037
6072
 
6038
6073
  ### Return type
6039
6074
 
@@ -6373,6 +6408,7 @@ Name | Type | Description | Notes
6373
6408
  **stamps** | [**Array<TextStamp>**](TextStamp.md)| The array of stamp. |
6374
6409
  **storage** | **String**| The document storage. | [optional]
6375
6410
  **folder** | **String**| The document folder. | [optional]
6411
+ **password** | **String**| Base64 encoded password. | [optional]
6376
6412
 
6377
6413
  ### Return type
6378
6414
 
@@ -8143,6 +8179,7 @@ Name | Type | Description | Notes
8143
8179
  **out_path** | **String**| Full resulting filename (ex. /folder1/folder2/result.pdf) |
8144
8180
  **type** | **String**| Type of PdfA format. |
8145
8181
  **storage** | **String**| The document storage. | [optional]
8182
+ **password** | **String**| The password (Base64). | [optional]
8146
8183
  **file** | **File**| A file to be converted. | [optional]
8147
8184
 
8148
8185
  ### Return type
@@ -8530,6 +8567,7 @@ Name | Type | Description | Notes
8530
8567
  **type** | **String**| Type of PdfA format. |
8531
8568
  **folder** | **String**| The document folder. | [optional]
8532
8569
  **storage** | **String**| The document storage. | [optional]
8570
+ **password** | **String**| The password (Base64). | [optional]
8533
8571
 
8534
8572
  ### Return type
8535
8573
 
@@ -637,6 +637,7 @@ module AsposePdfCloud
637
637
  # @param [Hash] opts the optional parameters
638
638
  # @option opts [String] :storage The document storage.
639
639
  # @option opts [String] :folder The document folder.
640
+ # @option opts [String] :password Base64 encoded password.
640
641
  # @return [AsposeResponse]
641
642
  def delete_document_stamps(name, opts = {})
642
643
  @api_client.request_token_if_needed
@@ -657,6 +658,7 @@ module AsposePdfCloud
657
658
  # @param [Hash] opts the optional parameters
658
659
  # @option opts [String] :storage The document storage.
659
660
  # @option opts [String] :folder The document folder.
661
+ # @option opts [String] :password Base64 encoded password.
660
662
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
661
663
  def delete_document_stamps_with_http_info(name, opts = {})
662
664
  if @api_client.config.debugging
@@ -673,6 +675,7 @@ module AsposePdfCloud
673
675
  query_params = {}
674
676
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
675
677
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
678
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
676
679
 
677
680
  # header parameters
678
681
  header_params = {}
@@ -1392,6 +1395,7 @@ module AsposePdfCloud
1392
1395
  # @param [Hash] opts the optional parameters
1393
1396
  # @option opts [String] :storage The document storage.
1394
1397
  # @option opts [String] :folder The document folder.
1398
+ # @option opts [String] :password Base64 encoded password.
1395
1399
  # @return [AsposeResponse]
1396
1400
  def delete_page_stamps(name, page_number, opts = {})
1397
1401
  @api_client.request_token_if_needed
@@ -1413,6 +1417,7 @@ module AsposePdfCloud
1413
1417
  # @param [Hash] opts the optional parameters
1414
1418
  # @option opts [String] :storage The document storage.
1415
1419
  # @option opts [String] :folder The document folder.
1420
+ # @option opts [String] :password Base64 encoded password.
1416
1421
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
1417
1422
  def delete_page_stamps_with_http_info(name, page_number, opts = {})
1418
1423
  if @api_client.config.debugging
@@ -1433,6 +1438,7 @@ module AsposePdfCloud
1433
1438
  query_params = {}
1434
1439
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
1435
1440
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
1441
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
1436
1442
 
1437
1443
  # header parameters
1438
1444
  header_params = {}
@@ -1698,6 +1704,7 @@ module AsposePdfCloud
1698
1704
  # @param [Hash] opts the optional parameters
1699
1705
  # @option opts [String] :storage The document storage.
1700
1706
  # @option opts [String] :folder The document folder.
1707
+ # @option opts [String] :password Base64 encoded password.
1701
1708
  # @return [AsposeResponse]
1702
1709
  def delete_stamp(name, stamp_id, opts = {})
1703
1710
  @api_client.request_token_if_needed
@@ -1719,6 +1726,7 @@ module AsposePdfCloud
1719
1726
  # @param [Hash] opts the optional parameters
1720
1727
  # @option opts [String] :storage The document storage.
1721
1728
  # @option opts [String] :folder The document folder.
1729
+ # @option opts [String] :password Base64 encoded password.
1722
1730
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
1723
1731
  def delete_stamp_with_http_info(name, stamp_id, opts = {})
1724
1732
  if @api_client.config.debugging
@@ -1739,6 +1747,7 @@ module AsposePdfCloud
1739
1747
  query_params = {}
1740
1748
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
1741
1749
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
1750
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
1742
1751
 
1743
1752
  # header parameters
1744
1753
  header_params = {}
@@ -2456,6 +2465,7 @@ module AsposePdfCloud
2456
2465
  # @param [Hash] opts the optional parameters
2457
2466
  # @option opts [String] :storage The document storage.
2458
2467
  # @option opts [String] :folder The document folder.
2468
+ # @option opts [String] :password Base64 encoded password.
2459
2469
  # @return [DocumentResponse]
2460
2470
  def get_document(name, opts = {})
2461
2471
  @api_client.request_token_if_needed
@@ -2476,6 +2486,7 @@ module AsposePdfCloud
2476
2486
  # @param [Hash] opts the optional parameters
2477
2487
  # @option opts [String] :storage The document storage.
2478
2488
  # @option opts [String] :folder The document folder.
2489
+ # @option opts [String] :password Base64 encoded password.
2479
2490
  # @return [Array<(DocumentResponse, Fixnum, Hash)>] DocumentResponse data, response status code and response headers
2480
2491
  def get_document_with_http_info(name, opts = {})
2481
2492
  if @api_client.config.debugging
@@ -2492,6 +2503,7 @@ module AsposePdfCloud
2492
2503
  query_params = {}
2493
2504
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
2494
2505
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
2506
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
2495
2507
 
2496
2508
  # header parameters
2497
2509
  header_params = {}
@@ -10012,6 +10024,7 @@ module AsposePdfCloud
10012
10024
  # @param [Hash] opts the optional parameters
10013
10025
  # @option opts [String] :storage The document storage.
10014
10026
  # @option opts [String] :folder The document folder.
10027
+ # @option opts [String] :password Base64 encoded password.
10015
10028
  # @return [StampsInfoResponse]
10016
10029
  def get_page_stamps(name, page_number, opts = {})
10017
10030
  @api_client.request_token_if_needed
@@ -10033,6 +10046,7 @@ module AsposePdfCloud
10033
10046
  # @param [Hash] opts the optional parameters
10034
10047
  # @option opts [String] :storage The document storage.
10035
10048
  # @option opts [String] :folder The document folder.
10049
+ # @option opts [String] :password Base64 encoded password.
10036
10050
  # @return [Array<(StampsInfoResponse, Fixnum, Hash)>] StampsInfoResponse data, response status code and response headers
10037
10051
  def get_page_stamps_with_http_info(name, page_number, opts = {})
10038
10052
  if @api_client.config.debugging
@@ -10053,6 +10067,7 @@ module AsposePdfCloud
10053
10067
  query_params = {}
10054
10068
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
10055
10069
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
10070
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
10056
10071
 
10057
10072
  # header parameters
10058
10073
  header_params = {}
@@ -11248,6 +11263,7 @@ module AsposePdfCloud
11248
11263
  # @param [Hash] opts the optional parameters
11249
11264
  # @option opts [String] :folder The document folder.
11250
11265
  # @option opts [String] :storage The document storage.
11266
+ # @option opts [String] :password The password (Base64).
11251
11267
  # @return [File]
11252
11268
  def get_pdf_in_storage_to_pdf_a(name, type, opts = {})
11253
11269
  @api_client.request_token_if_needed
@@ -11269,6 +11285,7 @@ module AsposePdfCloud
11269
11285
  # @param [Hash] opts the optional parameters
11270
11286
  # @option opts [String] :folder The document folder.
11271
11287
  # @option opts [String] :storage The document storage.
11288
+ # @option opts [String] :password The password (Base64).
11272
11289
  # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
11273
11290
  def get_pdf_in_storage_to_pdf_a_with_http_info(name, type, opts = {})
11274
11291
  if @api_client.config.debugging
@@ -11294,6 +11311,7 @@ module AsposePdfCloud
11294
11311
  query_params[:'type'] = type
11295
11312
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
11296
11313
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
11314
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
11297
11315
 
11298
11316
  # header parameters
11299
11317
  header_params = {}
@@ -14579,6 +14597,83 @@ module AsposePdfCloud
14579
14597
  return data, status_code, headers
14580
14598
  end
14581
14599
 
14600
+ # Adds a file attachment to the PDF document.
14601
+ #
14602
+ # @param name The document name.
14603
+ # @param attachment_info AttachmentInfoAttachmentInfo instance.
14604
+ # @param [Hash] opts the optional parameters
14605
+ # @option opts [String] :storage The document storage.
14606
+ # @option opts [String] :folder The document folder.
14607
+ # @return [AttachmentsResponse]
14608
+ def post_add_document_attachment(name, attachment_info, opts = {})
14609
+ @api_client.request_token_if_needed
14610
+ data, _status_code, _headers = post_add_document_attachment_with_http_info(name, attachment_info, opts)
14611
+ rescue ApiError => error
14612
+ if error.code == 401
14613
+ @api_client.request_token_if_needed
14614
+ data, _status_code, _headers = post_add_document_attachment_with_http_info(name, attachment_info, opts)
14615
+ else
14616
+ raise
14617
+ end
14618
+ return data
14619
+ end
14620
+
14621
+ # Adds a file attachment to the PDF document.
14622
+ #
14623
+ # @param name The document name.
14624
+ # @param attachment_info AttachmentInfoAttachmentInfo instance.
14625
+ # @param [Hash] opts the optional parameters
14626
+ # @option opts [String] :storage The document storage.
14627
+ # @option opts [String] :folder The document folder.
14628
+ # @return [Array<(AttachmentsResponse, Fixnum, Hash)>] AttachmentsResponse data, response status code and response headers
14629
+ def post_add_document_attachment_with_http_info(name, attachment_info, opts = {})
14630
+ if @api_client.config.debugging
14631
+ @api_client.config.logger.debug "Calling API: PdfApi.post_add_document_attachment ..."
14632
+ end
14633
+ # verify the required parameter 'name' is set
14634
+ if @api_client.config.client_side_validation && name.nil?
14635
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_add_document_attachment"
14636
+ end
14637
+ # verify the required parameter 'attachment_info' is set
14638
+ if @api_client.config.client_side_validation && attachment_info.nil?
14639
+ fail ArgumentError, "Missing the required parameter 'attachment_info' when calling PdfApi.post_add_document_attachment"
14640
+ end
14641
+ # resource path
14642
+ local_var_path = "/pdf/{name}/attachments".sub('{' + 'name' + '}', name.to_s)
14643
+
14644
+ # query parameters
14645
+ query_params = {}
14646
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
14647
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
14648
+
14649
+ # header parameters
14650
+ header_params = {}
14651
+ # HTTP header 'Accept' (if needed)
14652
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14653
+ # HTTP header 'Content-Type'
14654
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
14655
+
14656
+ # form parameters
14657
+ form_params = {}
14658
+ # Fix header in file
14659
+ post_body = nil
14660
+
14661
+ # http body (model)
14662
+ post_body = @api_client.object_to_http_body(attachment_info)
14663
+ auth_names = ['JWT']
14664
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
14665
+ :header_params => header_params,
14666
+ :query_params => query_params,
14667
+ :form_params => form_params,
14668
+ :body => post_body,
14669
+ :auth_names => auth_names,
14670
+ :return_type => 'AttachmentsResponse')
14671
+ if @api_client.config.debugging
14672
+ @api_client.config.logger.debug "API called: PdfApi#post_add_document_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14673
+ end
14674
+ return data, status_code, headers
14675
+ end
14676
+
14582
14677
  # Append document to existing one.
14583
14678
  #
14584
14679
  # @param name The original document name.
@@ -15409,6 +15504,7 @@ module AsposePdfCloud
15409
15504
  # @option opts [Integer] :end_page_number The end page number.
15410
15505
  # @option opts [String] :storage The document storage.
15411
15506
  # @option opts [String] :folder The document folder.
15507
+ # @option opts [String] :password Base64 encoded password.
15412
15508
  # @return [AsposeResponse]
15413
15509
  def post_document_page_number_stamps(name, stamp, opts = {})
15414
15510
  @api_client.request_token_if_needed
@@ -15432,6 +15528,7 @@ module AsposePdfCloud
15432
15528
  # @option opts [Integer] :end_page_number The end page number.
15433
15529
  # @option opts [String] :storage The document storage.
15434
15530
  # @option opts [String] :folder The document folder.
15531
+ # @option opts [String] :password Base64 encoded password.
15435
15532
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
15436
15533
  def post_document_page_number_stamps_with_http_info(name, stamp, opts = {})
15437
15534
  if @api_client.config.debugging
@@ -15454,6 +15551,7 @@ module AsposePdfCloud
15454
15551
  query_params[:'endPageNumber'] = opts[:'end_page_number'] if !opts[:'end_page_number'].nil?
15455
15552
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
15456
15553
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
15554
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
15457
15555
 
15458
15556
  # header parameters
15459
15557
  header_params = {}
@@ -17180,6 +17278,7 @@ module AsposePdfCloud
17180
17278
  # @param [Hash] opts the optional parameters
17181
17279
  # @option opts [String] :storage The document storage.
17182
17280
  # @option opts [String] :folder The document folder.
17281
+ # @option opts [String] :password Base64 encoded password.
17183
17282
  # @return [AsposeResponse]
17184
17283
  def post_page_image_stamps(name, page_number, stamps, opts = {})
17185
17284
  @api_client.request_token_if_needed
@@ -17202,6 +17301,7 @@ module AsposePdfCloud
17202
17301
  # @param [Hash] opts the optional parameters
17203
17302
  # @option opts [String] :storage The document storage.
17204
17303
  # @option opts [String] :folder The document folder.
17304
+ # @option opts [String] :password Base64 encoded password.
17205
17305
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
17206
17306
  def post_page_image_stamps_with_http_info(name, page_number, stamps, opts = {})
17207
17307
  if @api_client.config.debugging
@@ -17226,6 +17326,7 @@ module AsposePdfCloud
17226
17326
  query_params = {}
17227
17327
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
17228
17328
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
17329
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
17229
17330
 
17230
17331
  # header parameters
17231
17332
  header_params = {}
@@ -17595,6 +17696,7 @@ module AsposePdfCloud
17595
17696
  # @param [Hash] opts the optional parameters
17596
17697
  # @option opts [String] :storage The document storage.
17597
17698
  # @option opts [String] :folder The document folder.
17699
+ # @option opts [String] :password Base64 encoded password.
17598
17700
  # @return [AsposeResponse]
17599
17701
  def post_page_pdf_page_stamps(name, page_number, stamps, opts = {})
17600
17702
  @api_client.request_token_if_needed
@@ -17617,6 +17719,7 @@ module AsposePdfCloud
17617
17719
  # @param [Hash] opts the optional parameters
17618
17720
  # @option opts [String] :storage The document storage.
17619
17721
  # @option opts [String] :folder The document folder.
17722
+ # @option opts [String] :password Base64 encoded password.
17620
17723
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
17621
17724
  def post_page_pdf_page_stamps_with_http_info(name, page_number, stamps, opts = {})
17622
17725
  if @api_client.config.debugging
@@ -17641,6 +17744,7 @@ module AsposePdfCloud
17641
17744
  query_params = {}
17642
17745
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
17643
17746
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
17747
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
17644
17748
 
17645
17749
  # header parameters
17646
17750
  header_params = {}
@@ -18677,6 +18781,7 @@ module AsposePdfCloud
18677
18781
  # @param [Hash] opts the optional parameters
18678
18782
  # @option opts [String] :storage The document storage.
18679
18783
  # @option opts [String] :folder The document folder.
18784
+ # @option opts [String] :password Base64 encoded password.
18680
18785
  # @return [AsposeResponse]
18681
18786
  def post_page_text_stamps(name, page_number, stamps, opts = {})
18682
18787
  @api_client.request_token_if_needed
@@ -18699,6 +18804,7 @@ module AsposePdfCloud
18699
18804
  # @param [Hash] opts the optional parameters
18700
18805
  # @option opts [String] :storage The document storage.
18701
18806
  # @option opts [String] :folder The document folder.
18807
+ # @option opts [String] :password Base64 encoded password.
18702
18808
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
18703
18809
  def post_page_text_stamps_with_http_info(name, page_number, stamps, opts = {})
18704
18810
  if @api_client.config.debugging
@@ -18723,6 +18829,7 @@ module AsposePdfCloud
18723
18829
  query_params = {}
18724
18830
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
18725
18831
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
18832
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
18726
18833
 
18727
18834
  # header parameters
18728
18835
  header_params = {}
@@ -24301,6 +24408,7 @@ module AsposePdfCloud
24301
24408
  # @param type Type of PdfA format.
24302
24409
  # @param [Hash] opts the optional parameters
24303
24410
  # @option opts [String] :storage The document storage.
24411
+ # @option opts [String] :password The password (Base64).
24304
24412
  # @option opts [File] :file A file to be converted.
24305
24413
  # @return [AsposeResponse]
24306
24414
  def put_pdf_in_request_to_pdf_a(out_path, type, opts = {})
@@ -24322,6 +24430,7 @@ module AsposePdfCloud
24322
24430
  # @param type Type of PdfA format.
24323
24431
  # @param [Hash] opts the optional parameters
24324
24432
  # @option opts [String] :storage The document storage.
24433
+ # @option opts [String] :password The password (Base64).
24325
24434
  # @option opts [File] :file A file to be converted.
24326
24435
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
24327
24436
  def put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, opts = {})
@@ -24348,6 +24457,7 @@ module AsposePdfCloud
24348
24457
  query_params[:'outPath'] = out_path
24349
24458
  query_params[:'type'] = type
24350
24459
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
24460
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
24351
24461
 
24352
24462
  # header parameters
24353
24463
  header_params = {}
@@ -25545,6 +25655,7 @@ module AsposePdfCloud
25545
25655
  # @param [Hash] opts the optional parameters
25546
25656
  # @option opts [String] :folder The document folder.
25547
25657
  # @option opts [String] :storage The document storage.
25658
+ # @option opts [String] :password The password (Base64).
25548
25659
  # @return [AsposeResponse]
25549
25660
  def put_pdf_in_storage_to_pdf_a(name, out_path, type, opts = {})
25550
25661
  @api_client.request_token_if_needed
@@ -25567,6 +25678,7 @@ module AsposePdfCloud
25567
25678
  # @param [Hash] opts the optional parameters
25568
25679
  # @option opts [String] :folder The document folder.
25569
25680
  # @option opts [String] :storage The document storage.
25681
+ # @option opts [String] :password The password (Base64).
25570
25682
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
25571
25683
  def put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, opts = {})
25572
25684
  if @api_client.config.debugging
@@ -25597,6 +25709,7 @@ module AsposePdfCloud
25597
25709
  query_params[:'type'] = type
25598
25710
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
25599
25711
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
25712
+ query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
25600
25713
 
25601
25714
  # header parameters
25602
25715
  header_params = {}
@@ -0,0 +1,253 @@
1
+ =begin
2
+ --------------------------------------------------------------------------------------------------------------------
3
+ Copyright (c) 2023 Aspose.PDF Cloud
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ of this software and associated documentation files (the "Software"), to deal
6
+ in the Software without restriction, including without limitation the rights
7
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the Software is
9
+ furnished to do so, subject to the following conditions:
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
15
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
17
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
18
+ SOFTWARE.
19
+ --------------------------------------------------------------------------------------------------------------------
20
+ =end
21
+
22
+ require 'date'
23
+ require 'time'
24
+
25
+ module AsposePdfCloud
26
+ # Attachment Info.
27
+ class AttachmentInfo
28
+ # Attachment file path.
29
+ attr_accessor :path
30
+
31
+ # Attachment file description.
32
+ attr_accessor :description
33
+
34
+ # Attachment file name.
35
+ attr_accessor :name
36
+
37
+ # Attachment file MIME type.
38
+ attr_accessor :mime_type
39
+
40
+
41
+ # Attribute mapping from ruby-style variable name to JSON key.
42
+ def self.attribute_map
43
+ {
44
+ :'path' => :'Path',
45
+ :'description' => :'Description',
46
+ :'name' => :'Name',
47
+ :'mime_type' => :'MimeType'
48
+ }
49
+ end
50
+
51
+ # Attribute type mapping.
52
+ def self.swagger_types
53
+ {
54
+ :'path' => :'String',
55
+ :'description' => :'String',
56
+ :'name' => :'String',
57
+ :'mime_type' => :'String'
58
+ }
59
+ end
60
+
61
+ # Initializes the object
62
+ # @param [Hash] attributes Model attributes in the form of hash
63
+ def initialize(attributes = {})
64
+ return unless attributes.is_a?(Hash)
65
+
66
+ # convert string to symbol for hash key
67
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
68
+
69
+ if attributes.has_key?(:'Path')
70
+ self.path = attributes[:'Path']
71
+ end
72
+
73
+ if attributes.has_key?(:'Description')
74
+ self.description = attributes[:'Description']
75
+ end
76
+
77
+ if attributes.has_key?(:'Name')
78
+ self.name = attributes[:'Name']
79
+ end
80
+
81
+ if attributes.has_key?(:'MimeType')
82
+ self.mime_type = attributes[:'MimeType']
83
+ end
84
+
85
+ end
86
+
87
+ # Show invalid properties with the reasons. Usually used together with valid?
88
+ # @return Array for valid properies with the reasons
89
+ def list_invalid_properties
90
+ invalid_properties = Array.new
91
+ if @path.nil?
92
+ invalid_properties.push("invalid value for 'path', path cannot be nil.")
93
+ end
94
+
95
+ if @path.to_s.length < 1
96
+ invalid_properties.push("invalid value for 'path', the character length must be great than or equal to 1.")
97
+ end
98
+
99
+ return invalid_properties
100
+ end
101
+
102
+ # Check to see if the all the properties in the model are valid
103
+ # @return true if the model is valid
104
+ def valid?
105
+ return false if @path.nil?
106
+ return false if @path.to_s.length < 1
107
+ return true
108
+ end
109
+
110
+ # Custom attribute writer method with validation
111
+ # @param [Object] path Value to be assigned
112
+ def path=(path)
113
+ if path.nil?
114
+ fail ArgumentError, "path cannot be nil"
115
+ end
116
+
117
+ if path.to_s.length < 1
118
+ fail ArgumentError, "invalid value for 'path', the character length must be great than or equal to 1."
119
+ end
120
+
121
+ @path = path
122
+ end
123
+
124
+ # Checks equality by comparing each attribute.
125
+ # @param [Object] Object to be compared
126
+ def ==(o)
127
+ return true if self.equal?(o)
128
+ self.class == o.class &&
129
+ path == o.path &&
130
+ description == o.description &&
131
+ name == o.name &&
132
+ mime_type == o.mime_type
133
+ end
134
+
135
+ # @see the `==` method
136
+ # @param [Object] Object to be compared
137
+ def eql?(o)
138
+ self == o
139
+ end
140
+
141
+ # Calculates hash code according to all attributes.
142
+ # @return [Fixnum] Hash code
143
+ def hash
144
+ [path, description, name, mime_type].hash
145
+ end
146
+
147
+ # Builds the object from hash
148
+ # @param [Hash] attributes Model attributes in the form of hash
149
+ # @return [Object] Returns the model itself
150
+ def build_from_hash(attributes)
151
+ return nil unless attributes.is_a?(Hash)
152
+ self.class.swagger_types.each_pair do |key, type|
153
+ if type =~ /\AArray<(.*)>/i
154
+ # check to ensure the input is an array given that the the attribute
155
+ # is documented as an array but the input is not
156
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
157
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
158
+ end
159
+ elsif !attributes[self.class.attribute_map[key]].nil?
160
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
161
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
162
+ end
163
+
164
+ self
165
+ end
166
+
167
+ # Deserializes the data based on type
168
+ # @param string type Data type
169
+ # @param string value Value to be deserialized
170
+ # @return [Object] Deserialized data
171
+ def _deserialize(type, value)
172
+ case type.to_sym
173
+ when :DateTime
174
+ DateTime.parse(value)
175
+ when :Date
176
+ Date.parse(value)
177
+ when :String
178
+ value.to_s
179
+ when :Integer
180
+ value.to_i
181
+ when :Float
182
+ value.to_f
183
+ when :BOOLEAN
184
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
185
+ true
186
+ else
187
+ false
188
+ end
189
+ when :Object
190
+ # generic object (usually a Hash), return directly
191
+ value
192
+ when /\AArray<(?<inner_type>.+)>\z/
193
+ inner_type = Regexp.last_match[:inner_type]
194
+ value.map { |v| _deserialize(inner_type, v) }
195
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
196
+ k_type = Regexp.last_match[:k_type]
197
+ v_type = Regexp.last_match[:v_type]
198
+ {}.tap do |hash|
199
+ value.each do |k, v|
200
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
201
+ end
202
+ end
203
+ else # model
204
+ temp_model = AsposePdfCloud.const_get(type).new
205
+ temp_model.build_from_hash(value)
206
+ end
207
+ end
208
+
209
+ # Returns the string representation of the object
210
+ # @return [String] String presentation of the object
211
+ def to_s
212
+ to_hash.to_s
213
+ end
214
+
215
+ # to_body is an alias to to_hash (backward compatibility)
216
+ # @return [Hash] Returns the object in the form of hash
217
+ def to_body
218
+ to_hash
219
+ end
220
+
221
+ # Returns the object in the form of hash
222
+ # @return [Hash] Returns the object in the form of hash
223
+ def to_hash
224
+ hash = {}
225
+ self.class.attribute_map.each_pair do |attr, param|
226
+ value = self.send(attr)
227
+ next if value.nil?
228
+ hash[param] = _to_hash(value)
229
+ end
230
+ hash
231
+ end
232
+
233
+ # Outputs non-array value in the form of hash
234
+ # For object, use to_hash. Otherwise, just return the value
235
+ # @param [Object] value Any valid value
236
+ # @return [Hash] Returns the value in the form of hash
237
+ def _to_hash(value)
238
+ if value.is_a?(Array)
239
+ value.compact.map{ |v| _to_hash(v) }
240
+ elsif value.is_a?(Hash)
241
+ {}.tap do |hash|
242
+ value.each { |k, v| hash[k] = _to_hash(v) }
243
+ end
244
+ elsif value.respond_to? :to_hash
245
+ value.to_hash
246
+ else
247
+ value
248
+ end
249
+ end
250
+
251
+ end
252
+
253
+ end
@@ -31,9 +31,6 @@ module AsposePdfCloud
31
31
  # Page's id.
32
32
  attr_accessor :id
33
33
 
34
- # Page's images
35
- attr_accessor :images
36
-
37
34
  # Page's rectangle
38
35
  attr_accessor :rectangle
39
36
 
@@ -43,7 +40,6 @@ module AsposePdfCloud
43
40
  {
44
41
  :'links' => :'Links',
45
42
  :'id' => :'Id',
46
- :'images' => :'Images',
47
43
  :'rectangle' => :'Rectangle'
48
44
  }
49
45
  end
@@ -53,7 +49,6 @@ module AsposePdfCloud
53
49
  {
54
50
  :'links' => :'Array<Link>',
55
51
  :'id' => :'Integer',
56
- :'images' => :'Images',
57
52
  :'rectangle' => :'Rectangle'
58
53
  }
59
54
  end
@@ -76,10 +71,6 @@ module AsposePdfCloud
76
71
  self.id = attributes[:'Id']
77
72
  end
78
73
 
79
- if attributes.has_key?(:'Images')
80
- self.images = attributes[:'Images']
81
- end
82
-
83
74
  if attributes.has_key?(:'Rectangle')
84
75
  self.rectangle = attributes[:'Rectangle']
85
76
  end
@@ -111,7 +102,6 @@ module AsposePdfCloud
111
102
  self.class == o.class &&
112
103
  links == o.links &&
113
104
  id == o.id &&
114
- images == o.images &&
115
105
  rectangle == o.rectangle
116
106
  end
117
107
 
@@ -124,7 +114,7 @@ module AsposePdfCloud
124
114
  # Calculates hash code according to all attributes.
125
115
  # @return [Fixnum] Hash code
126
116
  def hash
127
- [links, id, images, rectangle].hash
117
+ [links, id, rectangle].hash
128
118
  end
129
119
 
130
120
  # Builds the object from hash
@@ -20,5 +20,5 @@ SOFTWARE.
20
20
  =end
21
21
 
22
22
  module AsposePdfCloud
23
- VERSION = "23.8.0"
23
+ VERSION = "23.10.0"
24
24
  end
@@ -31,6 +31,7 @@ require_relative 'aspose_pdf_cloud/models/annotation_state'
31
31
  require_relative 'aspose_pdf_cloud/models/annotation_type'
32
32
  require_relative 'aspose_pdf_cloud/models/antialiasing_processing_type'
33
33
  require_relative 'aspose_pdf_cloud/models/aspose_response'
34
+ require_relative 'aspose_pdf_cloud/models/attachment_info'
34
35
  require_relative 'aspose_pdf_cloud/models/border'
35
36
  require_relative 'aspose_pdf_cloud/models/border_corner_style'
36
37
  require_relative 'aspose_pdf_cloud/models/border_effect'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aspose_pdf_cloud
3
3
  version: !ruby/object:Gem::Version
4
- version: 23.8.0
4
+ version: 23.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Aspose PDF Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-08-25 00:00:00.000000000 Z
11
+ date: 2023-10-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: json
@@ -192,6 +192,7 @@ files:
192
192
  - docs/AntialiasingProcessingType.md
193
193
  - docs/AsposeResponse.md
194
194
  - docs/Attachment.md
195
+ - docs/AttachmentInfo.md
195
196
  - docs/AttachmentResponse.md
196
197
  - docs/Attachments.md
197
198
  - docs/AttachmentsResponse.md
@@ -482,6 +483,7 @@ files:
482
483
  - lib/aspose_pdf_cloud/models/antialiasing_processing_type.rb
483
484
  - lib/aspose_pdf_cloud/models/aspose_response.rb
484
485
  - lib/aspose_pdf_cloud/models/attachment.rb
486
+ - lib/aspose_pdf_cloud/models/attachment_info.rb
485
487
  - lib/aspose_pdf_cloud/models/attachment_response.rb
486
488
  - lib/aspose_pdf_cloud/models/attachments.rb
487
489
  - lib/aspose_pdf_cloud/models/attachments_response.rb