cloudmersive-convert-api-client 2.1.5 → 2.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cb95922682d9068e6b3b28cabf946e852763da4a89904fd6bd8e9a2cea210ee4
4
- data.tar.gz: edae5a220431bc469b3d35f234787882106eecc0d33fc62552773991d3636fe4
3
+ metadata.gz: ff9ffb546ea02d639338b712f6303c8d5be21843a39b66d6fd3c77f198fad29d
4
+ data.tar.gz: 33e8154c9155c9278a6aaddbe69bf2286681aa4d1b59180f7ed90bffbfa3e287
5
5
  SHA512:
6
- metadata.gz: 3847f8ccd6a550a909eb120b562e9ac2162f77142d6d2500bd6df0e016ad95c23f8ff346557e0ce9980984e4a90f2688c4ca853f80e50c4b5d32f22da22ec6cd
7
- data.tar.gz: 947a32dccef4aac96aed7a5fd28cc77539c3907685e0338c6bcdb3f791aa0188bceccb39bd327e19f11deeeab9c78fa3c4d84f317e67f3adc6e5ca78c3a8c16a
6
+ metadata.gz: 5d06f1431223769adf83181ab97d2dbbc0c6f045e37456dfebc1918a6ded4c201d2f24843e76e63c6e44fb0ed9f67eb4175f22927ee445f021be42e6281d4bee
7
+ data.tar.gz: 33a4556b551b8247e66cbc667cff26135ec095bf9e43f1485ebed6d5b3128befdb9fd317f29dc312b9804b8b05bd60935e58ca38f91986e38c25d52a97fdf848
data/README.md CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 2.1.5
10
+ - Package version: 2.1.6
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-convert-api-client-2.1.5.gem
26
+ gem install ./cloudmersive-convert-api-client-2.1.6.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.5.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.6.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-convert-api-client', '~> 2.1.5'
34
+ gem 'cloudmersive-convert-api-client', '~> 2.1.6'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -210,6 +210,7 @@ Class | Method | HTTP request | Description
210
210
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments_hierarchical**](docs/EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
211
211
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
212
212
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_images**](docs/EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
213
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_macro_information**](docs/EditDocumentApi.md#edit_document_docx_get_macro_information) | **POST** /convert/edit/docx/get-macros | Get macro information from a Word DOCX/DOCM document
213
214
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_metadata_properties**](docs/EditDocumentApi.md#edit_document_docx_get_metadata_properties) | **POST** /convert/edit/docx/get-metadata | Get all metadata properties in Word DOCX document
214
215
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_sections**](docs/EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
215
216
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_styles**](docs/EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
@@ -236,6 +237,7 @@ Class | Method | HTTP request | Description
236
237
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_row**](docs/EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
237
238
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
238
239
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_delete_slides**](docs/EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
240
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_get_macro_information**](docs/EditDocumentApi.md#edit_document_pptx_get_macro_information) | **POST** /convert/edit/pptx/get-macros | Get macro information from a PowerPoint PPTX/PPTM presentation document
239
241
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_replace**](docs/EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
240
242
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_append_row**](docs/EditDocumentApi.md#edit_document_xlsx_append_row) | **POST** /convert/edit/xlsx/append-row | Append row to a Excel XLSX spreadsheet, worksheet
241
243
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_clear_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
@@ -249,6 +251,7 @@ Class | Method | HTTP request | Description
249
251
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
250
252
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_columns**](docs/EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get columns from a Excel XLSX spreadsheet, worksheet
251
253
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_images**](docs/EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
254
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_macro_information**](docs/EditDocumentApi.md#edit_document_xlsx_get_macro_information) | **POST** /convert/edit/xlsx/get-macros | Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
252
255
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_rows_and_cells**](docs/EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Excel XLSX spreadsheet, worksheet
253
256
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_specific_row**](docs/EditDocumentApi.md#edit_document_xlsx_get_specific_row) | **POST** /convert/edit/xlsx/get-specific-row | Get a specific row from a Excel XLSX spreadsheet, worksheet by path
254
257
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_styles**](docs/EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
@@ -465,6 +468,7 @@ Class | Method | HTTP request | Description
465
468
  - [CloudmersiveConvertApiClient::GetDocxTablesResponse](docs/GetDocxTablesResponse.md)
466
469
  - [CloudmersiveConvertApiClient::GetFileTypeIconResult](docs/GetFileTypeIconResult.md)
467
470
  - [CloudmersiveConvertApiClient::GetImageInfoResult](docs/GetImageInfoResult.md)
471
+ - [CloudmersiveConvertApiClient::GetMacrosResponse](docs/GetMacrosResponse.md)
468
472
  - [CloudmersiveConvertApiClient::GetPdfAnnotationsResult](docs/GetPdfAnnotationsResult.md)
469
473
  - [CloudmersiveConvertApiClient::GetXlsxCellByIdentifierRequest](docs/GetXlsxCellByIdentifierRequest.md)
470
474
  - [CloudmersiveConvertApiClient::GetXlsxCellByIdentifierResponse](docs/GetXlsxCellByIdentifierResponse.md)
@@ -18,6 +18,7 @@ Method | HTTP request | Description
18
18
  [**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
19
19
  [**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
20
20
  [**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
21
+ [**edit_document_docx_get_macro_information**](EditDocumentApi.md#edit_document_docx_get_macro_information) | **POST** /convert/edit/docx/get-macros | Get macro information from a Word DOCX/DOCM document
21
22
  [**edit_document_docx_get_metadata_properties**](EditDocumentApi.md#edit_document_docx_get_metadata_properties) | **POST** /convert/edit/docx/get-metadata | Get all metadata properties in Word DOCX document
22
23
  [**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
23
24
  [**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
@@ -44,6 +45,7 @@ Method | HTTP request | Description
44
45
  [**edit_document_docx_update_table_row**](EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
45
46
  [**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
46
47
  [**edit_document_pptx_delete_slides**](EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
48
+ [**edit_document_pptx_get_macro_information**](EditDocumentApi.md#edit_document_pptx_get_macro_information) | **POST** /convert/edit/pptx/get-macros | Get macro information from a PowerPoint PPTX/PPTM presentation document
47
49
  [**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
48
50
  [**edit_document_xlsx_append_row**](EditDocumentApi.md#edit_document_xlsx_append_row) | **POST** /convert/edit/xlsx/append-row | Append row to a Excel XLSX spreadsheet, worksheet
49
51
  [**edit_document_xlsx_clear_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
@@ -57,6 +59,7 @@ Method | HTTP request | Description
57
59
  [**edit_document_xlsx_get_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
58
60
  [**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get columns from a Excel XLSX spreadsheet, worksheet
59
61
  [**edit_document_xlsx_get_images**](EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
62
+ [**edit_document_xlsx_get_macro_information**](EditDocumentApi.md#edit_document_xlsx_get_macro_information) | **POST** /convert/edit/xlsx/get-macros | Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
60
63
  [**edit_document_xlsx_get_rows_and_cells**](EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Excel XLSX spreadsheet, worksheet
61
64
  [**edit_document_xlsx_get_specific_row**](EditDocumentApi.md#edit_document_xlsx_get_specific_row) | **POST** /convert/edit/xlsx/get-specific-row | Get a specific row from a Excel XLSX spreadsheet, worksheet by path
62
65
  [**edit_document_xlsx_get_styles**](EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
@@ -823,6 +826,60 @@ Name | Type | Description | Notes
823
826
 
824
827
 
825
828
 
829
+ # **edit_document_docx_get_macro_information**
830
+ > GetMacrosResponse edit_document_docx_get_macro_information(input_file)
831
+
832
+ Get macro information from a Word DOCX/DOCM document
833
+
834
+ Returns information about the Macros (e.g. VBA) defined in the Word Document
835
+
836
+ ### Example
837
+ ```ruby
838
+ # load the gem
839
+ require 'cloudmersive-convert-api-client'
840
+ # setup authorization
841
+ CloudmersiveConvertApiClient.configure do |config|
842
+ # Configure API key authorization: Apikey
843
+ config.api_key['Apikey'] = 'YOUR API KEY'
844
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
845
+ #config.api_key_prefix['Apikey'] = 'Bearer'
846
+ end
847
+
848
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
849
+
850
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
851
+
852
+
853
+ begin
854
+ #Get macro information from a Word DOCX/DOCM document
855
+ result = api_instance.edit_document_docx_get_macro_information(input_file)
856
+ p result
857
+ rescue CloudmersiveConvertApiClient::ApiError => e
858
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_macro_information: #{e}"
859
+ end
860
+ ```
861
+
862
+ ### Parameters
863
+
864
+ Name | Type | Description | Notes
865
+ ------------- | ------------- | ------------- | -------------
866
+ **input_file** | **File**| Input file to perform the operation on. |
867
+
868
+ ### Return type
869
+
870
+ [**GetMacrosResponse**](GetMacrosResponse.md)
871
+
872
+ ### Authorization
873
+
874
+ [Apikey](../README.md#Apikey)
875
+
876
+ ### HTTP request headers
877
+
878
+ - **Content-Type**: multipart/form-data
879
+ - **Accept**: application/json, text/json, application/xml, text/xml
880
+
881
+
882
+
826
883
  # **edit_document_docx_get_metadata_properties**
827
884
  > GetDocxMetadataPropertiesResponse edit_document_docx_get_metadata_properties(input_file)
828
885
 
@@ -2227,6 +2284,60 @@ Name | Type | Description | Notes
2227
2284
 
2228
2285
 
2229
2286
 
2287
+ # **edit_document_pptx_get_macro_information**
2288
+ > GetMacrosResponse edit_document_pptx_get_macro_information(input_file)
2289
+
2290
+ Get macro information from a PowerPoint PPTX/PPTM presentation document
2291
+
2292
+ Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
2293
+
2294
+ ### Example
2295
+ ```ruby
2296
+ # load the gem
2297
+ require 'cloudmersive-convert-api-client'
2298
+ # setup authorization
2299
+ CloudmersiveConvertApiClient.configure do |config|
2300
+ # Configure API key authorization: Apikey
2301
+ config.api_key['Apikey'] = 'YOUR API KEY'
2302
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2303
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2304
+ end
2305
+
2306
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2307
+
2308
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2309
+
2310
+
2311
+ begin
2312
+ #Get macro information from a PowerPoint PPTX/PPTM presentation document
2313
+ result = api_instance.edit_document_pptx_get_macro_information(input_file)
2314
+ p result
2315
+ rescue CloudmersiveConvertApiClient::ApiError => e
2316
+ puts "Exception when calling EditDocumentApi->edit_document_pptx_get_macro_information: #{e}"
2317
+ end
2318
+ ```
2319
+
2320
+ ### Parameters
2321
+
2322
+ Name | Type | Description | Notes
2323
+ ------------- | ------------- | ------------- | -------------
2324
+ **input_file** | **File**| Input file to perform the operation on. |
2325
+
2326
+ ### Return type
2327
+
2328
+ [**GetMacrosResponse**](GetMacrosResponse.md)
2329
+
2330
+ ### Authorization
2331
+
2332
+ [Apikey](../README.md#Apikey)
2333
+
2334
+ ### HTTP request headers
2335
+
2336
+ - **Content-Type**: multipart/form-data
2337
+ - **Accept**: application/json, text/json, application/xml, text/xml
2338
+
2339
+
2340
+
2230
2341
  # **edit_document_pptx_replace**
2231
2342
  > String edit_document_pptx_replace(req_config)
2232
2343
 
@@ -2929,6 +3040,60 @@ Name | Type | Description | Notes
2929
3040
 
2930
3041
 
2931
3042
 
3043
+ # **edit_document_xlsx_get_macro_information**
3044
+ > GetMacrosResponse edit_document_xlsx_get_macro_information(input_file)
3045
+
3046
+ Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
3047
+
3048
+ Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
3049
+
3050
+ ### Example
3051
+ ```ruby
3052
+ # load the gem
3053
+ require 'cloudmersive-convert-api-client'
3054
+ # setup authorization
3055
+ CloudmersiveConvertApiClient.configure do |config|
3056
+ # Configure API key authorization: Apikey
3057
+ config.api_key['Apikey'] = 'YOUR API KEY'
3058
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3059
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3060
+ end
3061
+
3062
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
3063
+
3064
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3065
+
3066
+
3067
+ begin
3068
+ #Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
3069
+ result = api_instance.edit_document_xlsx_get_macro_information(input_file)
3070
+ p result
3071
+ rescue CloudmersiveConvertApiClient::ApiError => e
3072
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_macro_information: #{e}"
3073
+ end
3074
+ ```
3075
+
3076
+ ### Parameters
3077
+
3078
+ Name | Type | Description | Notes
3079
+ ------------- | ------------- | ------------- | -------------
3080
+ **input_file** | **File**| Input file to perform the operation on. |
3081
+
3082
+ ### Return type
3083
+
3084
+ [**GetMacrosResponse**](GetMacrosResponse.md)
3085
+
3086
+ ### Authorization
3087
+
3088
+ [Apikey](../README.md#Apikey)
3089
+
3090
+ ### HTTP request headers
3091
+
3092
+ - **Content-Type**: multipart/form-data
3093
+ - **Accept**: application/json, text/json, application/xml, text/xml
3094
+
3095
+
3096
+
2932
3097
  # **edit_document_xlsx_get_rows_and_cells**
2933
3098
  > GetXlsxRowsAndCellsResponse edit_document_xlsx_get_rows_and_cells(input)
2934
3099
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::GetMacrosResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **contains_vba_macros** | **BOOLEAN** | True if the document contains VBA macros, false otherwise | [optional]
8
+
9
+
@@ -130,6 +130,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_tables_request'
130
130
  require 'cloudmersive-convert-api-client/models/get_docx_tables_response'
131
131
  require 'cloudmersive-convert-api-client/models/get_file_type_icon_result'
132
132
  require 'cloudmersive-convert-api-client/models/get_image_info_result'
133
+ require 'cloudmersive-convert-api-client/models/get_macros_response'
133
134
  require 'cloudmersive-convert-api-client/models/get_pdf_annotations_result'
134
135
  require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request'
135
136
  require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_response'
@@ -779,6 +779,61 @@ module CloudmersiveConvertApiClient
779
779
  end
780
780
  return data, status_code, headers
781
781
  end
782
+ # Get macro information from a Word DOCX/DOCM document
783
+ # Returns information about the Macros (e.g. VBA) defined in the Word Document
784
+ # @param input_file Input file to perform the operation on.
785
+ # @param [Hash] opts the optional parameters
786
+ # @return [GetMacrosResponse]
787
+ def edit_document_docx_get_macro_information(input_file, opts = {})
788
+ data, _status_code, _headers = edit_document_docx_get_macro_information_with_http_info(input_file, opts)
789
+ data
790
+ end
791
+
792
+ # Get macro information from a Word DOCX/DOCM document
793
+ # Returns information about the Macros (e.g. VBA) defined in the Word Document
794
+ # @param input_file Input file to perform the operation on.
795
+ # @param [Hash] opts the optional parameters
796
+ # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
797
+ def edit_document_docx_get_macro_information_with_http_info(input_file, opts = {})
798
+ if @api_client.config.debugging
799
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_macro_information ...'
800
+ end
801
+ # verify the required parameter 'input_file' is set
802
+ if @api_client.config.client_side_validation && input_file.nil?
803
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_macro_information"
804
+ end
805
+ # resource path
806
+ local_var_path = '/convert/edit/docx/get-macros'
807
+
808
+ # query parameters
809
+ query_params = {}
810
+
811
+ # header parameters
812
+ header_params = {}
813
+ # HTTP header 'Accept' (if needed)
814
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
815
+ # HTTP header 'Content-Type'
816
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
817
+
818
+ # form parameters
819
+ form_params = {}
820
+ form_params['inputFile'] = input_file
821
+
822
+ # http body (model)
823
+ post_body = nil
824
+ auth_names = ['Apikey']
825
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
826
+ :header_params => header_params,
827
+ :query_params => query_params,
828
+ :form_params => form_params,
829
+ :body => post_body,
830
+ :auth_names => auth_names,
831
+ :return_type => 'GetMacrosResponse')
832
+ if @api_client.config.debugging
833
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
834
+ end
835
+ return data, status_code, headers
836
+ end
782
837
  # Get all metadata properties in Word DOCX document
783
838
  # Returns all the metadata properties in an Office Word Document (docx)
784
839
  # @param input_file Input file to perform the operation on.
@@ -2185,6 +2240,61 @@ module CloudmersiveConvertApiClient
2185
2240
  end
2186
2241
  return data, status_code, headers
2187
2242
  end
2243
+ # Get macro information from a PowerPoint PPTX/PPTM presentation document
2244
+ # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
2245
+ # @param input_file Input file to perform the operation on.
2246
+ # @param [Hash] opts the optional parameters
2247
+ # @return [GetMacrosResponse]
2248
+ def edit_document_pptx_get_macro_information(input_file, opts = {})
2249
+ data, _status_code, _headers = edit_document_pptx_get_macro_information_with_http_info(input_file, opts)
2250
+ data
2251
+ end
2252
+
2253
+ # Get macro information from a PowerPoint PPTX/PPTM presentation document
2254
+ # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
2255
+ # @param input_file Input file to perform the operation on.
2256
+ # @param [Hash] opts the optional parameters
2257
+ # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
2258
+ def edit_document_pptx_get_macro_information_with_http_info(input_file, opts = {})
2259
+ if @api_client.config.debugging
2260
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_get_macro_information ...'
2261
+ end
2262
+ # verify the required parameter 'input_file' is set
2263
+ if @api_client.config.client_side_validation && input_file.nil?
2264
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_pptx_get_macro_information"
2265
+ end
2266
+ # resource path
2267
+ local_var_path = '/convert/edit/pptx/get-macros'
2268
+
2269
+ # query parameters
2270
+ query_params = {}
2271
+
2272
+ # header parameters
2273
+ header_params = {}
2274
+ # HTTP header 'Accept' (if needed)
2275
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
2276
+ # HTTP header 'Content-Type'
2277
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
2278
+
2279
+ # form parameters
2280
+ form_params = {}
2281
+ form_params['inputFile'] = input_file
2282
+
2283
+ # http body (model)
2284
+ post_body = nil
2285
+ auth_names = ['Apikey']
2286
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2287
+ :header_params => header_params,
2288
+ :query_params => query_params,
2289
+ :form_params => form_params,
2290
+ :body => post_body,
2291
+ :auth_names => auth_names,
2292
+ :return_type => 'GetMacrosResponse')
2293
+ if @api_client.config.debugging
2294
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_pptx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2295
+ end
2296
+ return data, status_code, headers
2297
+ end
2188
2298
  # Replace string in PowerPoint PPTX presentation
2189
2299
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
2190
2300
  # @param req_config Replacement document configuration input
@@ -2887,6 +2997,61 @@ module CloudmersiveConvertApiClient
2887
2997
  end
2888
2998
  return data, status_code, headers
2889
2999
  end
3000
+ # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
3001
+ # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
3002
+ # @param input_file Input file to perform the operation on.
3003
+ # @param [Hash] opts the optional parameters
3004
+ # @return [GetMacrosResponse]
3005
+ def edit_document_xlsx_get_macro_information(input_file, opts = {})
3006
+ data, _status_code, _headers = edit_document_xlsx_get_macro_information_with_http_info(input_file, opts)
3007
+ data
3008
+ end
3009
+
3010
+ # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
3011
+ # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
3012
+ # @param input_file Input file to perform the operation on.
3013
+ # @param [Hash] opts the optional parameters
3014
+ # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
3015
+ def edit_document_xlsx_get_macro_information_with_http_info(input_file, opts = {})
3016
+ if @api_client.config.debugging
3017
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_macro_information ...'
3018
+ end
3019
+ # verify the required parameter 'input_file' is set
3020
+ if @api_client.config.client_side_validation && input_file.nil?
3021
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_xlsx_get_macro_information"
3022
+ end
3023
+ # resource path
3024
+ local_var_path = '/convert/edit/xlsx/get-macros'
3025
+
3026
+ # query parameters
3027
+ query_params = {}
3028
+
3029
+ # header parameters
3030
+ header_params = {}
3031
+ # HTTP header 'Accept' (if needed)
3032
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
3033
+ # HTTP header 'Content-Type'
3034
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
3035
+
3036
+ # form parameters
3037
+ form_params = {}
3038
+ form_params['inputFile'] = input_file
3039
+
3040
+ # http body (model)
3041
+ post_body = nil
3042
+ auth_names = ['Apikey']
3043
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3044
+ :header_params => header_params,
3045
+ :query_params => query_params,
3046
+ :form_params => form_params,
3047
+ :body => post_body,
3048
+ :auth_names => auth_names,
3049
+ :return_type => 'GetMacrosResponse')
3050
+ if @api_client.config.debugging
3051
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_xlsx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3052
+ end
3053
+ return data, status_code, headers
3054
+ end
2890
3055
  # Get rows and cells from a Excel XLSX spreadsheet, worksheet
2891
3056
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
2892
3057
  # @param input Document input request
@@ -0,0 +1,196 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveConvertApiClient
16
+ # Result of running a Get Macro Information command
17
+ class GetMacrosResponse
18
+ # True if successful, false otherwise
19
+ attr_accessor :successful
20
+
21
+ # True if the document contains VBA macros, false otherwise
22
+ attr_accessor :contains_vba_macros
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'successful' => :'Successful',
28
+ :'contains_vba_macros' => :'ContainsVbaMacros'
29
+ }
30
+ end
31
+
32
+ # Attribute type mapping.
33
+ def self.swagger_types
34
+ {
35
+ :'successful' => :'BOOLEAN',
36
+ :'contains_vba_macros' => :'BOOLEAN'
37
+ }
38
+ end
39
+
40
+ # Initializes the object
41
+ # @param [Hash] attributes Model attributes in the form of hash
42
+ def initialize(attributes = {})
43
+ return unless attributes.is_a?(Hash)
44
+
45
+ # convert string to symbol for hash key
46
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
47
+
48
+ if attributes.has_key?(:'Successful')
49
+ self.successful = attributes[:'Successful']
50
+ end
51
+
52
+ if attributes.has_key?(:'ContainsVbaMacros')
53
+ self.contains_vba_macros = attributes[:'ContainsVbaMacros']
54
+ end
55
+ end
56
+
57
+ # Show invalid properties with the reasons. Usually used together with valid?
58
+ # @return Array for valid properties with the reasons
59
+ def list_invalid_properties
60
+ invalid_properties = Array.new
61
+ invalid_properties
62
+ end
63
+
64
+ # Check to see if the all the properties in the model are valid
65
+ # @return true if the model is valid
66
+ def valid?
67
+ true
68
+ end
69
+
70
+ # Checks equality by comparing each attribute.
71
+ # @param [Object] Object to be compared
72
+ def ==(o)
73
+ return true if self.equal?(o)
74
+ self.class == o.class &&
75
+ successful == o.successful &&
76
+ contains_vba_macros == o.contains_vba_macros
77
+ end
78
+
79
+ # @see the `==` method
80
+ # @param [Object] Object to be compared
81
+ def eql?(o)
82
+ self == o
83
+ end
84
+
85
+ # Calculates hash code according to all attributes.
86
+ # @return [Fixnum] Hash code
87
+ def hash
88
+ [successful, contains_vba_macros].hash
89
+ end
90
+
91
+ # Builds the object from hash
92
+ # @param [Hash] attributes Model attributes in the form of hash
93
+ # @return [Object] Returns the model itself
94
+ def build_from_hash(attributes)
95
+ return nil unless attributes.is_a?(Hash)
96
+ self.class.swagger_types.each_pair do |key, type|
97
+ if type =~ /\AArray<(.*)>/i
98
+ # check to ensure the input is an array given that the attribute
99
+ # is documented as an array but the input is not
100
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
101
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
102
+ end
103
+ elsif !attributes[self.class.attribute_map[key]].nil?
104
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
105
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
106
+ end
107
+
108
+ self
109
+ end
110
+
111
+ # Deserializes the data based on type
112
+ # @param string type Data type
113
+ # @param string value Value to be deserialized
114
+ # @return [Object] Deserialized data
115
+ def _deserialize(type, value)
116
+ case type.to_sym
117
+ when :DateTime
118
+ DateTime.parse(value)
119
+ when :Date
120
+ Date.parse(value)
121
+ when :String
122
+ value.to_s
123
+ when :Integer
124
+ value.to_i
125
+ when :Float
126
+ value.to_f
127
+ when :BOOLEAN
128
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
129
+ true
130
+ else
131
+ false
132
+ end
133
+ when :Object
134
+ # generic object (usually a Hash), return directly
135
+ value
136
+ when /\AArray<(?<inner_type>.+)>\z/
137
+ inner_type = Regexp.last_match[:inner_type]
138
+ value.map { |v| _deserialize(inner_type, v) }
139
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
140
+ k_type = Regexp.last_match[:k_type]
141
+ v_type = Regexp.last_match[:v_type]
142
+ {}.tap do |hash|
143
+ value.each do |k, v|
144
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
145
+ end
146
+ end
147
+ else # model
148
+ temp_model = CloudmersiveConvertApiClient.const_get(type).new
149
+ temp_model.build_from_hash(value)
150
+ end
151
+ end
152
+
153
+ # Returns the string representation of the object
154
+ # @return [String] String presentation of the object
155
+ def to_s
156
+ to_hash.to_s
157
+ end
158
+
159
+ # to_body is an alias to to_hash (backward compatibility)
160
+ # @return [Hash] Returns the object in the form of hash
161
+ def to_body
162
+ to_hash
163
+ end
164
+
165
+ # Returns the object in the form of hash
166
+ # @return [Hash] Returns the object in the form of hash
167
+ def to_hash
168
+ hash = {}
169
+ self.class.attribute_map.each_pair do |attr, param|
170
+ value = self.send(attr)
171
+ next if value.nil?
172
+ hash[param] = _to_hash(value)
173
+ end
174
+ hash
175
+ end
176
+
177
+ # Outputs non-array value in the form of hash
178
+ # For object, use to_hash. Otherwise, just return the value
179
+ # @param [Object] value Any valid value
180
+ # @return [Hash] Returns the value in the form of hash
181
+ def _to_hash(value)
182
+ if value.is_a?(Array)
183
+ value.compact.map { |v| _to_hash(v) }
184
+ elsif value.is_a?(Hash)
185
+ {}.tap do |hash|
186
+ value.each { |k, v| hash[k] = _to_hash(v) }
187
+ end
188
+ elsif value.respond_to? :to_hash
189
+ value.to_hash
190
+ else
191
+ value
192
+ end
193
+ end
194
+
195
+ end
196
+ end
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
11
11
  =end
12
12
 
13
13
  module CloudmersiveConvertApiClient
14
- VERSION = '2.1.5'
14
+ VERSION = '2.1.6'
15
15
  end
@@ -200,6 +200,18 @@ describe 'EditDocumentApi' do
200
200
  end
201
201
  end
202
202
 
203
+ # unit tests for edit_document_docx_get_macro_information
204
+ # Get macro information from a Word DOCX/DOCM document
205
+ # Returns information about the Macros (e.g. VBA) defined in the Word Document
206
+ # @param input_file Input file to perform the operation on.
207
+ # @param [Hash] opts the optional parameters
208
+ # @return [GetMacrosResponse]
209
+ describe 'edit_document_docx_get_macro_information test' do
210
+ it 'should work' do
211
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
212
+ end
213
+ end
214
+
203
215
  # unit tests for edit_document_docx_get_metadata_properties
204
216
  # Get all metadata properties in Word DOCX document
205
217
  # Returns all the metadata properties in an Office Word Document (docx)
@@ -512,6 +524,18 @@ describe 'EditDocumentApi' do
512
524
  end
513
525
  end
514
526
 
527
+ # unit tests for edit_document_pptx_get_macro_information
528
+ # Get macro information from a PowerPoint PPTX/PPTM presentation document
529
+ # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
530
+ # @param input_file Input file to perform the operation on.
531
+ # @param [Hash] opts the optional parameters
532
+ # @return [GetMacrosResponse]
533
+ describe 'edit_document_pptx_get_macro_information test' do
534
+ it 'should work' do
535
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
536
+ end
537
+ end
538
+
515
539
  # unit tests for edit_document_pptx_replace
516
540
  # Replace string in PowerPoint PPTX presentation
517
541
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
@@ -668,6 +692,18 @@ describe 'EditDocumentApi' do
668
692
  end
669
693
  end
670
694
 
695
+ # unit tests for edit_document_xlsx_get_macro_information
696
+ # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
697
+ # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
698
+ # @param input_file Input file to perform the operation on.
699
+ # @param [Hash] opts the optional parameters
700
+ # @return [GetMacrosResponse]
701
+ describe 'edit_document_xlsx_get_macro_information test' do
702
+ it 'should work' do
703
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
704
+ end
705
+ end
706
+
671
707
  # unit tests for edit_document_xlsx_get_rows_and_cells
672
708
  # Get rows and cells from a Excel XLSX spreadsheet, worksheet
673
709
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveConvertApiClient::GetMacrosResponse
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'GetMacrosResponse' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::GetMacrosResponse.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of GetMacrosResponse' do
31
+ it 'should create an instance of GetMacrosResponse' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::GetMacrosResponse)
33
+ end
34
+ end
35
+ describe 'test attribute "successful"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ describe 'test attribute "contains_vba_macros"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cloudmersive-convert-api-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.5
4
+ version: 2.1.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cloudmersive
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-02-08 00:00:00.000000000 Z
11
+ date: 2021-02-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -325,6 +325,7 @@ files:
325
325
  - "./docs/GetDocxTablesResponse.md"
326
326
  - "./docs/GetFileTypeIconResult.md"
327
327
  - "./docs/GetImageInfoResult.md"
328
+ - "./docs/GetMacrosResponse.md"
328
329
  - "./docs/GetPdfAnnotationsResult.md"
329
330
  - "./docs/GetXlsxCellByIdentifierRequest.md"
330
331
  - "./docs/GetXlsxCellByIdentifierResponse.md"
@@ -599,6 +600,7 @@ files:
599
600
  - "./lib/cloudmersive-convert-api-client/models/get_docx_tables_response.rb"
600
601
  - "./lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb"
601
602
  - "./lib/cloudmersive-convert-api-client/models/get_image_info_result.rb"
603
+ - "./lib/cloudmersive-convert-api-client/models/get_macros_response.rb"
602
604
  - "./lib/cloudmersive-convert-api-client/models/get_pdf_annotations_result.rb"
603
605
  - "./lib/cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request.rb"
604
606
  - "./lib/cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_response.rb"
@@ -865,6 +867,7 @@ files:
865
867
  - "./spec/models/get_docx_tables_response_spec.rb"
866
868
  - "./spec/models/get_file_type_icon_result_spec.rb"
867
869
  - "./spec/models/get_image_info_result_spec.rb"
870
+ - "./spec/models/get_macros_response_spec.rb"
868
871
  - "./spec/models/get_pdf_annotations_result_spec.rb"
869
872
  - "./spec/models/get_xlsx_cell_by_identifier_request_spec.rb"
870
873
  - "./spec/models/get_xlsx_cell_by_identifier_response_spec.rb"