aspose_pdf_cloud 19.6.0 → 19.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4620,10 +4620,226 @@ module AsposePdfCloud
4620
4620
  return data, status_code, headers
4621
4621
  end
4622
4622
 
4623
+ # Export fields from from PDF in storage to FDF file.
4624
+ #
4625
+ # @param name The document name.
4626
+ # @param [Hash] opts the optional parameters
4627
+ # @option opts [String] :storage The document storage.
4628
+ # @option opts [String] :folder The document folder.
4629
+ # @return [File]
4630
+ def get_export_fields_from_pdf_to_fdf_in_storage(name, opts = {})
4631
+ @api_client.request_token_if_needed
4632
+ data, _status_code, _headers = get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, opts)
4633
+ rescue ApiError => error
4634
+ if error.code == 401
4635
+ @api_client.request_token_if_needed
4636
+ data, _status_code, _headers = get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, opts)
4637
+ else
4638
+ raise
4639
+ end
4640
+ return data
4641
+ end
4642
+
4643
+ # Export fields from from PDF in storage to FDF file.
4644
+ #
4645
+ # @param name The document name.
4646
+ # @param [Hash] opts the optional parameters
4647
+ # @option opts [String] :storage The document storage.
4648
+ # @option opts [String] :folder The document folder.
4649
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
4650
+ def get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, opts = {})
4651
+ if @api_client.config.debugging
4652
+ @api_client.config.logger.debug "Calling API: PdfApi.get_export_fields_from_pdf_to_fdf_in_storage ..."
4653
+ end
4654
+ # verify the required parameter 'name' is set
4655
+ if @api_client.config.client_side_validation && name.nil?
4656
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_export_fields_from_pdf_to_fdf_in_storage"
4657
+ end
4658
+ # resource path
4659
+ local_var_path = "/pdf/{name}/export/fdf".sub('{' + 'name' + '}', name.to_s)
4660
+
4661
+ # query parameters
4662
+ query_params = {}
4663
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
4664
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
4665
+
4666
+ # header parameters
4667
+ header_params = {}
4668
+ # HTTP header 'Accept' (if needed)
4669
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
4670
+ # HTTP header 'Content-Type'
4671
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4672
+
4673
+ # form parameters
4674
+ form_params = {}
4675
+ # Fix header in file
4676
+ post_body = nil
4677
+
4678
+ # http body (model)
4679
+ # Fix header in file
4680
+ # post_body = nil
4681
+ auth_names = ['JWT']
4682
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4683
+ :header_params => header_params,
4684
+ :query_params => query_params,
4685
+ :form_params => form_params,
4686
+ :body => post_body,
4687
+ :auth_names => auth_names,
4688
+ :return_type => 'File')
4689
+ if @api_client.config.debugging
4690
+ @api_client.config.logger.debug "API called: PdfApi#get_export_fields_from_pdf_to_fdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4691
+ end
4692
+ return data, status_code, headers
4693
+ end
4694
+
4695
+ # Export fields from from PDF in storage to XFDF file.
4696
+ #
4697
+ # @param name The document name.
4698
+ # @param [Hash] opts the optional parameters
4699
+ # @option opts [String] :storage The document storage.
4700
+ # @option opts [String] :folder The document folder.
4701
+ # @return [File]
4702
+ def get_export_fields_from_pdf_to_xfdf_in_storage(name, opts = {})
4703
+ @api_client.request_token_if_needed
4704
+ data, _status_code, _headers = get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, opts)
4705
+ rescue ApiError => error
4706
+ if error.code == 401
4707
+ @api_client.request_token_if_needed
4708
+ data, _status_code, _headers = get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, opts)
4709
+ else
4710
+ raise
4711
+ end
4712
+ return data
4713
+ end
4714
+
4715
+ # Export fields from from PDF in storage to XFDF file.
4716
+ #
4717
+ # @param name The document name.
4718
+ # @param [Hash] opts the optional parameters
4719
+ # @option opts [String] :storage The document storage.
4720
+ # @option opts [String] :folder The document folder.
4721
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
4722
+ def get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, opts = {})
4723
+ if @api_client.config.debugging
4724
+ @api_client.config.logger.debug "Calling API: PdfApi.get_export_fields_from_pdf_to_xfdf_in_storage ..."
4725
+ end
4726
+ # verify the required parameter 'name' is set
4727
+ if @api_client.config.client_side_validation && name.nil?
4728
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_export_fields_from_pdf_to_xfdf_in_storage"
4729
+ end
4730
+ # resource path
4731
+ local_var_path = "/pdf/{name}/export/xfdf".sub('{' + 'name' + '}', name.to_s)
4732
+
4733
+ # query parameters
4734
+ query_params = {}
4735
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
4736
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
4737
+
4738
+ # header parameters
4739
+ header_params = {}
4740
+ # HTTP header 'Accept' (if needed)
4741
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
4742
+ # HTTP header 'Content-Type'
4743
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4744
+
4745
+ # form parameters
4746
+ form_params = {}
4747
+ # Fix header in file
4748
+ post_body = nil
4749
+
4750
+ # http body (model)
4751
+ # Fix header in file
4752
+ # post_body = nil
4753
+ auth_names = ['JWT']
4754
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4755
+ :header_params => header_params,
4756
+ :query_params => query_params,
4757
+ :form_params => form_params,
4758
+ :body => post_body,
4759
+ :auth_names => auth_names,
4760
+ :return_type => 'File')
4761
+ if @api_client.config.debugging
4762
+ @api_client.config.logger.debug "API called: PdfApi#get_export_fields_from_pdf_to_xfdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4763
+ end
4764
+ return data, status_code, headers
4765
+ end
4766
+
4767
+ # Export fields from from PDF in storage to XML file.
4768
+ #
4769
+ # @param name The document name.
4770
+ # @param [Hash] opts the optional parameters
4771
+ # @option opts [String] :storage The document storage.
4772
+ # @option opts [String] :folder The document folder.
4773
+ # @return [File]
4774
+ def get_export_fields_from_pdf_to_xml_in_storage(name, opts = {})
4775
+ @api_client.request_token_if_needed
4776
+ data, _status_code, _headers = get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, opts)
4777
+ rescue ApiError => error
4778
+ if error.code == 401
4779
+ @api_client.request_token_if_needed
4780
+ data, _status_code, _headers = get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, opts)
4781
+ else
4782
+ raise
4783
+ end
4784
+ return data
4785
+ end
4786
+
4787
+ # Export fields from from PDF in storage to XML file.
4788
+ #
4789
+ # @param name The document name.
4790
+ # @param [Hash] opts the optional parameters
4791
+ # @option opts [String] :storage The document storage.
4792
+ # @option opts [String] :folder The document folder.
4793
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
4794
+ def get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, opts = {})
4795
+ if @api_client.config.debugging
4796
+ @api_client.config.logger.debug "Calling API: PdfApi.get_export_fields_from_pdf_to_xml_in_storage ..."
4797
+ end
4798
+ # verify the required parameter 'name' is set
4799
+ if @api_client.config.client_side_validation && name.nil?
4800
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_export_fields_from_pdf_to_xml_in_storage"
4801
+ end
4802
+ # resource path
4803
+ local_var_path = "/pdf/{name}/export/xml".sub('{' + 'name' + '}', name.to_s)
4804
+
4805
+ # query parameters
4806
+ query_params = {}
4807
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
4808
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
4809
+
4810
+ # header parameters
4811
+ header_params = {}
4812
+ # HTTP header 'Accept' (if needed)
4813
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
4814
+ # HTTP header 'Content-Type'
4815
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4816
+
4817
+ # form parameters
4818
+ form_params = {}
4819
+ # Fix header in file
4820
+ post_body = nil
4821
+
4822
+ # http body (model)
4823
+ # Fix header in file
4824
+ # post_body = nil
4825
+ auth_names = ['JWT']
4826
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4827
+ :header_params => header_params,
4828
+ :query_params => query_params,
4829
+ :form_params => form_params,
4830
+ :body => post_body,
4831
+ :auth_names => auth_names,
4832
+ :return_type => 'File')
4833
+ if @api_client.config.debugging
4834
+ @api_client.config.logger.debug "API called: PdfApi#get_export_fields_from_pdf_to_xml_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4835
+ end
4836
+ return data, status_code, headers
4837
+ end
4838
+
4623
4839
  # Get document field by name.
4624
4840
  #
4625
4841
  # @param name The document name.
4626
- # @param field_name The field name/
4842
+ # @param field_name The field name (name should be encoded).
4627
4843
  # @param [Hash] opts the optional parameters
4628
4844
  # @option opts [String] :storage The document storage.
4629
4845
  # @option opts [String] :folder The document folder.
@@ -4644,7 +4860,7 @@ module AsposePdfCloud
4644
4860
  # Get document field by name.
4645
4861
  #
4646
4862
  # @param name The document name.
4647
- # @param field_name The field name/
4863
+ # @param field_name The field name (name should be encoded).
4648
4864
  # @param [Hash] opts the optional parameters
4649
4865
  # @option opts [String] :storage The document storage.
4650
4866
  # @option opts [String] :folder The document folder.
@@ -5595,23 +5811,264 @@ module AsposePdfCloud
5595
5811
  # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
5596
5812
  def get_image_extract_as_png_with_http_info(name, image_id, opts = {})
5597
5813
  if @api_client.config.debugging
5598
- @api_client.config.logger.debug "Calling API: PdfApi.get_image_extract_as_png ..."
5814
+ @api_client.config.logger.debug "Calling API: PdfApi.get_image_extract_as_png ..."
5815
+ end
5816
+ # verify the required parameter 'name' is set
5817
+ if @api_client.config.client_side_validation && name.nil?
5818
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_image_extract_as_png"
5819
+ end
5820
+ # verify the required parameter 'image_id' is set
5821
+ if @api_client.config.client_side_validation && image_id.nil?
5822
+ fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image_extract_as_png"
5823
+ end
5824
+ # resource path
5825
+ local_var_path = "/pdf/{name}/images/{imageId}/extract/png".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)
5826
+
5827
+ # query parameters
5828
+ query_params = {}
5829
+ query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
5830
+ query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
5831
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
5832
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
5833
+
5834
+ # header parameters
5835
+ header_params = {}
5836
+ # HTTP header 'Accept' (if needed)
5837
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5838
+ # HTTP header 'Content-Type'
5839
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5840
+
5841
+ # form parameters
5842
+ form_params = {}
5843
+ # Fix header in file
5844
+ post_body = nil
5845
+
5846
+ # http body (model)
5847
+ # Fix header in file
5848
+ # post_body = nil
5849
+ auth_names = ['JWT']
5850
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5851
+ :header_params => header_params,
5852
+ :query_params => query_params,
5853
+ :form_params => form_params,
5854
+ :body => post_body,
5855
+ :auth_names => auth_names,
5856
+ :return_type => 'File')
5857
+ if @api_client.config.debugging
5858
+ @api_client.config.logger.debug "API called: PdfApi#get_image_extract_as_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5859
+ end
5860
+ return data, status_code, headers
5861
+ end
5862
+
5863
+ # Extract document image in TIFF format
5864
+ #
5865
+ # @param name The document name.
5866
+ # @param image_id Image ID.
5867
+ # @param [Hash] opts the optional parameters
5868
+ # @option opts [Integer] :width The converted image width. (default to 0)
5869
+ # @option opts [Integer] :height The converted image height. (default to 0)
5870
+ # @option opts [String] :storage The document storage.
5871
+ # @option opts [String] :folder The document folder.
5872
+ # @return [File]
5873
+ def get_image_extract_as_tiff(name, image_id, opts = {})
5874
+ @api_client.request_token_if_needed
5875
+ data, _status_code, _headers = get_image_extract_as_tiff_with_http_info(name, image_id, opts)
5876
+ rescue ApiError => error
5877
+ if error.code == 401
5878
+ @api_client.request_token_if_needed
5879
+ data, _status_code, _headers = get_image_extract_as_tiff_with_http_info(name, image_id, opts)
5880
+ else
5881
+ raise
5882
+ end
5883
+ return data
5884
+ end
5885
+
5886
+ # Extract document image in TIFF format
5887
+ #
5888
+ # @param name The document name.
5889
+ # @param image_id Image ID.
5890
+ # @param [Hash] opts the optional parameters
5891
+ # @option opts [Integer] :width The converted image width.
5892
+ # @option opts [Integer] :height The converted image height.
5893
+ # @option opts [String] :storage The document storage.
5894
+ # @option opts [String] :folder The document folder.
5895
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
5896
+ def get_image_extract_as_tiff_with_http_info(name, image_id, opts = {})
5897
+ if @api_client.config.debugging
5898
+ @api_client.config.logger.debug "Calling API: PdfApi.get_image_extract_as_tiff ..."
5899
+ end
5900
+ # verify the required parameter 'name' is set
5901
+ if @api_client.config.client_side_validation && name.nil?
5902
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_image_extract_as_tiff"
5903
+ end
5904
+ # verify the required parameter 'image_id' is set
5905
+ if @api_client.config.client_side_validation && image_id.nil?
5906
+ fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image_extract_as_tiff"
5907
+ end
5908
+ # resource path
5909
+ local_var_path = "/pdf/{name}/images/{imageId}/extract/tiff".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)
5910
+
5911
+ # query parameters
5912
+ query_params = {}
5913
+ query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
5914
+ query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
5915
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
5916
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
5917
+
5918
+ # header parameters
5919
+ header_params = {}
5920
+ # HTTP header 'Accept' (if needed)
5921
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5922
+ # HTTP header 'Content-Type'
5923
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5924
+
5925
+ # form parameters
5926
+ form_params = {}
5927
+ # Fix header in file
5928
+ post_body = nil
5929
+
5930
+ # http body (model)
5931
+ # Fix header in file
5932
+ # post_body = nil
5933
+ auth_names = ['JWT']
5934
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5935
+ :header_params => header_params,
5936
+ :query_params => query_params,
5937
+ :form_params => form_params,
5938
+ :body => post_body,
5939
+ :auth_names => auth_names,
5940
+ :return_type => 'File')
5941
+ if @api_client.config.debugging
5942
+ @api_client.config.logger.debug "API called: PdfApi#get_image_extract_as_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5943
+ end
5944
+ return data, status_code, headers
5945
+ end
5946
+
5947
+ # Read document images.
5948
+ #
5949
+ # @param name The document name.
5950
+ # @param page_number The page number.
5951
+ # @param [Hash] opts the optional parameters
5952
+ # @option opts [String] :storage The document storage.
5953
+ # @option opts [String] :folder The document folder.
5954
+ # @return [ImagesResponse]
5955
+ def get_images(name, page_number, opts = {})
5956
+ @api_client.request_token_if_needed
5957
+ data, _status_code, _headers = get_images_with_http_info(name, page_number, opts)
5958
+ rescue ApiError => error
5959
+ if error.code == 401
5960
+ @api_client.request_token_if_needed
5961
+ data, _status_code, _headers = get_images_with_http_info(name, page_number, opts)
5962
+ else
5963
+ raise
5964
+ end
5965
+ return data
5966
+ end
5967
+
5968
+ # Read document images.
5969
+ #
5970
+ # @param name The document name.
5971
+ # @param page_number The page number.
5972
+ # @param [Hash] opts the optional parameters
5973
+ # @option opts [String] :storage The document storage.
5974
+ # @option opts [String] :folder The document folder.
5975
+ # @return [Array<(ImagesResponse, Fixnum, Hash)>] ImagesResponse data, response status code and response headers
5976
+ def get_images_with_http_info(name, page_number, opts = {})
5977
+ if @api_client.config.debugging
5978
+ @api_client.config.logger.debug "Calling API: PdfApi.get_images ..."
5979
+ end
5980
+ # verify the required parameter 'name' is set
5981
+ if @api_client.config.client_side_validation && name.nil?
5982
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_images"
5983
+ end
5984
+ # verify the required parameter 'page_number' is set
5985
+ if @api_client.config.client_side_validation && page_number.nil?
5986
+ fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_images"
5987
+ end
5988
+ # resource path
5989
+ local_var_path = "/pdf/{name}/pages/{pageNumber}/images".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
5990
+
5991
+ # query parameters
5992
+ query_params = {}
5993
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
5994
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
5995
+
5996
+ # header parameters
5997
+ header_params = {}
5998
+ # HTTP header 'Accept' (if needed)
5999
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6000
+ # HTTP header 'Content-Type'
6001
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6002
+
6003
+ # form parameters
6004
+ form_params = {}
6005
+ # Fix header in file
6006
+ post_body = nil
6007
+
6008
+ # http body (model)
6009
+ # Fix header in file
6010
+ # post_body = nil
6011
+ auth_names = ['JWT']
6012
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
6013
+ :header_params => header_params,
6014
+ :query_params => query_params,
6015
+ :form_params => form_params,
6016
+ :body => post_body,
6017
+ :auth_names => auth_names,
6018
+ :return_type => 'ImagesResponse')
6019
+ if @api_client.config.debugging
6020
+ @api_client.config.logger.debug "API called: PdfApi#get_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6021
+ end
6022
+ return data, status_code, headers
6023
+ end
6024
+
6025
+ # Update fields from FDF file in storage.
6026
+ #
6027
+ # @param name The document name.
6028
+ # @param fdf_file_path The Fdf file path.
6029
+ # @param [Hash] opts the optional parameters
6030
+ # @option opts [String] :storage The document storage.
6031
+ # @option opts [String] :folder The document folder.
6032
+ # @return [File]
6033
+ def get_import_fields_from_fdf_in_storage(name, fdf_file_path, opts = {})
6034
+ @api_client.request_token_if_needed
6035
+ data, _status_code, _headers = get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts)
6036
+ rescue ApiError => error
6037
+ if error.code == 401
6038
+ @api_client.request_token_if_needed
6039
+ data, _status_code, _headers = get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts)
6040
+ else
6041
+ raise
6042
+ end
6043
+ return data
6044
+ end
6045
+
6046
+ # Update fields from FDF file in storage.
6047
+ #
6048
+ # @param name The document name.
6049
+ # @param fdf_file_path The Fdf file path.
6050
+ # @param [Hash] opts the optional parameters
6051
+ # @option opts [String] :storage The document storage.
6052
+ # @option opts [String] :folder The document folder.
6053
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
6054
+ def get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts = {})
6055
+ if @api_client.config.debugging
6056
+ @api_client.config.logger.debug "Calling API: PdfApi.get_import_fields_from_fdf_in_storage ..."
5599
6057
  end
5600
6058
  # verify the required parameter 'name' is set
5601
6059
  if @api_client.config.client_side_validation && name.nil?
5602
- fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_image_extract_as_png"
6060
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_import_fields_from_fdf_in_storage"
5603
6061
  end
5604
- # verify the required parameter 'image_id' is set
5605
- if @api_client.config.client_side_validation && image_id.nil?
5606
- fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image_extract_as_png"
6062
+ # verify the required parameter 'fdf_file_path' is set
6063
+ if @api_client.config.client_side_validation && fdf_file_path.nil?
6064
+ fail ArgumentError, "Missing the required parameter 'fdf_file_path' when calling PdfApi.get_import_fields_from_fdf_in_storage"
5607
6065
  end
5608
6066
  # resource path
5609
- local_var_path = "/pdf/{name}/images/{imageId}/extract/png".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)
6067
+ local_var_path = "/pdf/{name}/import/fdf".sub('{' + 'name' + '}', name.to_s)
5610
6068
 
5611
6069
  # query parameters
5612
6070
  query_params = {}
5613
- query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
5614
- query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
6071
+ query_params[:'fdfFilePath'] = fdf_file_path
5615
6072
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
5616
6073
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
5617
6074
 
@@ -5639,63 +6096,58 @@ module AsposePdfCloud
5639
6096
  :auth_names => auth_names,
5640
6097
  :return_type => 'File')
5641
6098
  if @api_client.config.debugging
5642
- @api_client.config.logger.debug "API called: PdfApi#get_image_extract_as_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6099
+ @api_client.config.logger.debug "API called: PdfApi#get_import_fields_from_fdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5643
6100
  end
5644
6101
  return data, status_code, headers
5645
6102
  end
5646
6103
 
5647
- # Extract document image in TIFF format
6104
+ # Update fields from XFDF file in storage.
5648
6105
  #
5649
6106
  # @param name The document name.
5650
- # @param image_id Image ID.
6107
+ # @param xfdf_file_path The XFDF file path.
5651
6108
  # @param [Hash] opts the optional parameters
5652
- # @option opts [Integer] :width The converted image width. (default to 0)
5653
- # @option opts [Integer] :height The converted image height. (default to 0)
5654
6109
  # @option opts [String] :storage The document storage.
5655
6110
  # @option opts [String] :folder The document folder.
5656
6111
  # @return [File]
5657
- def get_image_extract_as_tiff(name, image_id, opts = {})
6112
+ def get_import_fields_from_xfdf_in_storage(name, xfdf_file_path, opts = {})
5658
6113
  @api_client.request_token_if_needed
5659
- data, _status_code, _headers = get_image_extract_as_tiff_with_http_info(name, image_id, opts)
6114
+ data, _status_code, _headers = get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts)
5660
6115
  rescue ApiError => error
5661
6116
  if error.code == 401
5662
6117
  @api_client.request_token_if_needed
5663
- data, _status_code, _headers = get_image_extract_as_tiff_with_http_info(name, image_id, opts)
6118
+ data, _status_code, _headers = get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts)
5664
6119
  else
5665
6120
  raise
5666
6121
  end
5667
6122
  return data
5668
6123
  end
5669
6124
 
5670
- # Extract document image in TIFF format
6125
+ # Update fields from XFDF file in storage.
5671
6126
  #
5672
6127
  # @param name The document name.
5673
- # @param image_id Image ID.
6128
+ # @param xfdf_file_path The XFDF file path.
5674
6129
  # @param [Hash] opts the optional parameters
5675
- # @option opts [Integer] :width The converted image width.
5676
- # @option opts [Integer] :height The converted image height.
5677
6130
  # @option opts [String] :storage The document storage.
5678
6131
  # @option opts [String] :folder The document folder.
5679
6132
  # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
5680
- def get_image_extract_as_tiff_with_http_info(name, image_id, opts = {})
6133
+ def get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts = {})
5681
6134
  if @api_client.config.debugging
5682
- @api_client.config.logger.debug "Calling API: PdfApi.get_image_extract_as_tiff ..."
6135
+ @api_client.config.logger.debug "Calling API: PdfApi.get_import_fields_from_xfdf_in_storage ..."
5683
6136
  end
5684
6137
  # verify the required parameter 'name' is set
5685
6138
  if @api_client.config.client_side_validation && name.nil?
5686
- fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_image_extract_as_tiff"
6139
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_import_fields_from_xfdf_in_storage"
5687
6140
  end
5688
- # verify the required parameter 'image_id' is set
5689
- if @api_client.config.client_side_validation && image_id.nil?
5690
- fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image_extract_as_tiff"
6141
+ # verify the required parameter 'xfdf_file_path' is set
6142
+ if @api_client.config.client_side_validation && xfdf_file_path.nil?
6143
+ fail ArgumentError, "Missing the required parameter 'xfdf_file_path' when calling PdfApi.get_import_fields_from_xfdf_in_storage"
5691
6144
  end
5692
6145
  # resource path
5693
- local_var_path = "/pdf/{name}/images/{imageId}/extract/tiff".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)
6146
+ local_var_path = "/pdf/{name}/import/xfdf".sub('{' + 'name' + '}', name.to_s)
5694
6147
 
5695
6148
  # query parameters
5696
6149
  query_params = {}
5697
- query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
5698
- query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
6150
+ query_params[:'xfdfFilePath'] = xfdf_file_path
5699
6151
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
5700
6152
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
5701
6153
 
@@ -5723,64 +6175,65 @@ module AsposePdfCloud
5723
6175
  :auth_names => auth_names,
5724
6176
  :return_type => 'File')
5725
6177
  if @api_client.config.debugging
5726
- @api_client.config.logger.debug "API called: PdfApi#get_image_extract_as_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6178
+ @api_client.config.logger.debug "API called: PdfApi#get_import_fields_from_xfdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5727
6179
  end
5728
6180
  return data, status_code, headers
5729
6181
  end
5730
6182
 
5731
- # Read document images.
6183
+ # Import from XML file (located on storage) to PDF format and return resulting file in response.
5732
6184
  #
5733
6185
  # @param name The document name.
5734
- # @param page_number The page number.
6186
+ # @param xml_file_path Full source filename (ex. /folder1/folder2/template.xml)
5735
6187
  # @param [Hash] opts the optional parameters
5736
6188
  # @option opts [String] :storage The document storage.
5737
6189
  # @option opts [String] :folder The document folder.
5738
- # @return [ImagesResponse]
5739
- def get_images(name, page_number, opts = {})
6190
+ # @return [File]
6191
+ def get_import_fields_from_xml_in_storage(name, xml_file_path, opts = {})
5740
6192
  @api_client.request_token_if_needed
5741
- data, _status_code, _headers = get_images_with_http_info(name, page_number, opts)
6193
+ data, _status_code, _headers = get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts)
5742
6194
  rescue ApiError => error
5743
6195
  if error.code == 401
5744
6196
  @api_client.request_token_if_needed
5745
- data, _status_code, _headers = get_images_with_http_info(name, page_number, opts)
6197
+ data, _status_code, _headers = get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts)
5746
6198
  else
5747
6199
  raise
5748
6200
  end
5749
6201
  return data
5750
6202
  end
5751
6203
 
5752
- # Read document images.
6204
+ # Import from XML file (located on storage) to PDF format and return resulting file in response.
5753
6205
  #
5754
6206
  # @param name The document name.
5755
- # @param page_number The page number.
6207
+ # @param xml_file_path Full source filename (ex. /folder1/folder2/template.xml)
5756
6208
  # @param [Hash] opts the optional parameters
5757
6209
  # @option opts [String] :storage The document storage.
5758
6210
  # @option opts [String] :folder The document folder.
5759
- # @return [Array<(ImagesResponse, Fixnum, Hash)>] ImagesResponse data, response status code and response headers
5760
- def get_images_with_http_info(name, page_number, opts = {})
6211
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
6212
+ def get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts = {})
5761
6213
  if @api_client.config.debugging
5762
- @api_client.config.logger.debug "Calling API: PdfApi.get_images ..."
6214
+ @api_client.config.logger.debug "Calling API: PdfApi.get_import_fields_from_xml_in_storage ..."
5763
6215
  end
5764
6216
  # verify the required parameter 'name' is set
5765
6217
  if @api_client.config.client_side_validation && name.nil?
5766
- fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_images"
6218
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_import_fields_from_xml_in_storage"
5767
6219
  end
5768
- # verify the required parameter 'page_number' is set
5769
- if @api_client.config.client_side_validation && page_number.nil?
5770
- fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_images"
6220
+ # verify the required parameter 'xml_file_path' is set
6221
+ if @api_client.config.client_side_validation && xml_file_path.nil?
6222
+ fail ArgumentError, "Missing the required parameter 'xml_file_path' when calling PdfApi.get_import_fields_from_xml_in_storage"
5771
6223
  end
5772
6224
  # resource path
5773
- local_var_path = "/pdf/{name}/pages/{pageNumber}/images".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
6225
+ local_var_path = "/pdf/{name}/import/xml".sub('{' + 'name' + '}', name.to_s)
5774
6226
 
5775
6227
  # query parameters
5776
6228
  query_params = {}
6229
+ query_params[:'xmlFilePath'] = xml_file_path
5777
6230
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
5778
6231
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
5779
6232
 
5780
6233
  # header parameters
5781
6234
  header_params = {}
5782
6235
  # HTTP header 'Accept' (if needed)
5783
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6236
+ header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
5784
6237
  # HTTP header 'Content-Type'
5785
6238
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5786
6239
 
@@ -5799,9 +6252,9 @@ module AsposePdfCloud
5799
6252
  :form_params => form_params,
5800
6253
  :body => post_body,
5801
6254
  :auth_names => auth_names,
5802
- :return_type => 'ImagesResponse')
6255
+ :return_type => 'File')
5803
6256
  if @api_client.config.debugging
5804
- @api_client.config.logger.debug "API called: PdfApi#get_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6257
+ @api_client.config.logger.debug "API called: PdfApi#get_import_fields_from_xml_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5805
6258
  end
5806
6259
  return data, status_code, headers
5807
6260
  end
@@ -13542,45 +13995,271 @@ module AsposePdfCloud
13542
13995
  # @option opts [String] :storage The document storage.
13543
13996
  # @option opts [String] :folder The document folder.
13544
13997
  # @return [AsposeResponse]
13545
- def post_flatten_document(name, opts = {})
13998
+ def post_flatten_document(name, opts = {})
13999
+ @api_client.request_token_if_needed
14000
+ data, _status_code, _headers = post_flatten_document_with_http_info(name, opts)
14001
+ rescue ApiError => error
14002
+ if error.code == 401
14003
+ @api_client.request_token_if_needed
14004
+ data, _status_code, _headers = post_flatten_document_with_http_info(name, opts)
14005
+ else
14006
+ raise
14007
+ end
14008
+ return data
14009
+ end
14010
+
14011
+ # Flatten the document.
14012
+ #
14013
+ # @param name The document name.
14014
+ # @param [Hash] opts the optional parameters
14015
+ # @option opts [BOOLEAN] :update_appearances If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance..
14016
+ # @option opts [BOOLEAN] :call_events If set, formatting and other JavaScript events will be called.
14017
+ # @option opts [BOOLEAN] :hide_buttons If set, buttons will be removed from flattened document.
14018
+ # @option opts [String] :storage The document storage.
14019
+ # @option opts [String] :folder The document folder.
14020
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
14021
+ def post_flatten_document_with_http_info(name, opts = {})
14022
+ if @api_client.config.debugging
14023
+ @api_client.config.logger.debug "Calling API: PdfApi.post_flatten_document ..."
14024
+ end
14025
+ # verify the required parameter 'name' is set
14026
+ if @api_client.config.client_side_validation && name.nil?
14027
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_flatten_document"
14028
+ end
14029
+ # resource path
14030
+ local_var_path = "/pdf/{name}/flatten".sub('{' + 'name' + '}', name.to_s)
14031
+
14032
+ # query parameters
14033
+ query_params = {}
14034
+ query_params[:'updateAppearances'] = opts[:'update_appearances'] if !opts[:'update_appearances'].nil?
14035
+ query_params[:'callEvents'] = opts[:'call_events'] if !opts[:'call_events'].nil?
14036
+ query_params[:'hideButtons'] = opts[:'hide_buttons'] if !opts[:'hide_buttons'].nil?
14037
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
14038
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
14039
+
14040
+ # header parameters
14041
+ header_params = {}
14042
+ # HTTP header 'Accept' (if needed)
14043
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14044
+ # HTTP header 'Content-Type'
14045
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
14046
+
14047
+ # form parameters
14048
+ form_params = {}
14049
+ # Fix header in file
14050
+ post_body = nil
14051
+
14052
+ # http body (model)
14053
+ # Fix header in file
14054
+ # post_body = nil
14055
+ auth_names = ['JWT']
14056
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
14057
+ :header_params => header_params,
14058
+ :query_params => query_params,
14059
+ :form_params => form_params,
14060
+ :body => post_body,
14061
+ :auth_names => auth_names,
14062
+ :return_type => 'AsposeResponse')
14063
+ if @api_client.config.debugging
14064
+ @api_client.config.logger.debug "API called: PdfApi#post_flatten_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14065
+ end
14066
+ return data, status_code, headers
14067
+ end
14068
+
14069
+ # Update fields from FDF file in request.
14070
+ #
14071
+ # @param name The document name.
14072
+ # @param [Hash] opts the optional parameters
14073
+ # @option opts [String] :storage The document storage.
14074
+ # @option opts [String] :folder The document folder.
14075
+ # @option opts [File] :fdf_data Fdf file.
14076
+ # @return [AsposeResponse]
14077
+ def post_import_fields_from_fdf(name, opts = {})
14078
+ @api_client.request_token_if_needed
14079
+ data, _status_code, _headers = post_import_fields_from_fdf_with_http_info(name, opts)
14080
+ rescue ApiError => error
14081
+ if error.code == 401
14082
+ @api_client.request_token_if_needed
14083
+ data, _status_code, _headers = post_import_fields_from_fdf_with_http_info(name, opts)
14084
+ else
14085
+ raise
14086
+ end
14087
+ return data
14088
+ end
14089
+
14090
+ # Update fields from FDF file in request.
14091
+ #
14092
+ # @param name The document name.
14093
+ # @param [Hash] opts the optional parameters
14094
+ # @option opts [String] :storage The document storage.
14095
+ # @option opts [String] :folder The document folder.
14096
+ # @option opts [File] :fdf_data Fdf file.
14097
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
14098
+ def post_import_fields_from_fdf_with_http_info(name, opts = {})
14099
+ if @api_client.config.debugging
14100
+ @api_client.config.logger.debug "Calling API: PdfApi.post_import_fields_from_fdf ..."
14101
+ end
14102
+ # verify the required parameter 'name' is set
14103
+ if @api_client.config.client_side_validation && name.nil?
14104
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_import_fields_from_fdf"
14105
+ end
14106
+ # resource path
14107
+ local_var_path = "/pdf/{name}/import/fdf".sub('{' + 'name' + '}', name.to_s)
14108
+
14109
+ # query parameters
14110
+ query_params = {}
14111
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
14112
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
14113
+
14114
+ # header parameters
14115
+ header_params = {}
14116
+ # HTTP header 'Accept' (if needed)
14117
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14118
+ # HTTP header 'Content-Type'
14119
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
14120
+
14121
+ # form parameters
14122
+ form_params = {}
14123
+ # Fix header in file
14124
+ post_body = nil
14125
+ post_body = opts[:'fdf_data'] if !opts[:'fdf_data'].nil?
14126
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
14127
+
14128
+ # http body (model)
14129
+ # Fix header in file
14130
+ # post_body = nil
14131
+ auth_names = ['JWT']
14132
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
14133
+ :header_params => header_params,
14134
+ :query_params => query_params,
14135
+ :form_params => form_params,
14136
+ :body => post_body,
14137
+ :auth_names => auth_names,
14138
+ :return_type => 'AsposeResponse')
14139
+ if @api_client.config.debugging
14140
+ @api_client.config.logger.debug "API called: PdfApi#post_import_fields_from_fdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14141
+ end
14142
+ return data, status_code, headers
14143
+ end
14144
+
14145
+ # Update fields from XFDF file in request.
14146
+ #
14147
+ # @param name The document name.
14148
+ # @param [Hash] opts the optional parameters
14149
+ # @option opts [String] :storage The document storage.
14150
+ # @option opts [String] :folder The document folder.
14151
+ # @option opts [File] :xfdf_data Xfdf file.
14152
+ # @return [AsposeResponse]
14153
+ def post_import_fields_from_xfdf(name, opts = {})
14154
+ @api_client.request_token_if_needed
14155
+ data, _status_code, _headers = post_import_fields_from_xfdf_with_http_info(name, opts)
14156
+ rescue ApiError => error
14157
+ if error.code == 401
14158
+ @api_client.request_token_if_needed
14159
+ data, _status_code, _headers = post_import_fields_from_xfdf_with_http_info(name, opts)
14160
+ else
14161
+ raise
14162
+ end
14163
+ return data
14164
+ end
14165
+
14166
+ # Update fields from XFDF file in request.
14167
+ #
14168
+ # @param name The document name.
14169
+ # @param [Hash] opts the optional parameters
14170
+ # @option opts [String] :storage The document storage.
14171
+ # @option opts [String] :folder The document folder.
14172
+ # @option opts [File] :xfdf_data Xfdf file.
14173
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
14174
+ def post_import_fields_from_xfdf_with_http_info(name, opts = {})
14175
+ if @api_client.config.debugging
14176
+ @api_client.config.logger.debug "Calling API: PdfApi.post_import_fields_from_xfdf ..."
14177
+ end
14178
+ # verify the required parameter 'name' is set
14179
+ if @api_client.config.client_side_validation && name.nil?
14180
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_import_fields_from_xfdf"
14181
+ end
14182
+ # resource path
14183
+ local_var_path = "/pdf/{name}/import/xfdf".sub('{' + 'name' + '}', name.to_s)
14184
+
14185
+ # query parameters
14186
+ query_params = {}
14187
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
14188
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
14189
+
14190
+ # header parameters
14191
+ header_params = {}
14192
+ # HTTP header 'Accept' (if needed)
14193
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14194
+ # HTTP header 'Content-Type'
14195
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
14196
+
14197
+ # form parameters
14198
+ form_params = {}
14199
+ # Fix header in file
14200
+ post_body = nil
14201
+ post_body = opts[:'xfdf_data'] if !opts[:'xfdf_data'].nil?
14202
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
14203
+
14204
+ # http body (model)
14205
+ # Fix header in file
14206
+ # post_body = nil
14207
+ auth_names = ['JWT']
14208
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
14209
+ :header_params => header_params,
14210
+ :query_params => query_params,
14211
+ :form_params => form_params,
14212
+ :body => post_body,
14213
+ :auth_names => auth_names,
14214
+ :return_type => 'AsposeResponse')
14215
+ if @api_client.config.debugging
14216
+ @api_client.config.logger.debug "API called: PdfApi#post_import_fields_from_xfdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14217
+ end
14218
+ return data, status_code, headers
14219
+ end
14220
+
14221
+ # Update fields from XML file in request.
14222
+ #
14223
+ # @param name The document name.
14224
+ # @param [Hash] opts the optional parameters
14225
+ # @option opts [String] :storage The document storage.
14226
+ # @option opts [String] :folder The document folder.
14227
+ # @option opts [File] :xml_data Xml file.
14228
+ # @return [AsposeResponse]
14229
+ def post_import_fields_from_xml(name, opts = {})
13546
14230
  @api_client.request_token_if_needed
13547
- data, _status_code, _headers = post_flatten_document_with_http_info(name, opts)
14231
+ data, _status_code, _headers = post_import_fields_from_xml_with_http_info(name, opts)
13548
14232
  rescue ApiError => error
13549
14233
  if error.code == 401
13550
14234
  @api_client.request_token_if_needed
13551
- data, _status_code, _headers = post_flatten_document_with_http_info(name, opts)
14235
+ data, _status_code, _headers = post_import_fields_from_xml_with_http_info(name, opts)
13552
14236
  else
13553
14237
  raise
13554
14238
  end
13555
14239
  return data
13556
14240
  end
13557
14241
 
13558
- # Flatten the document.
14242
+ # Update fields from XML file in request.
13559
14243
  #
13560
14244
  # @param name The document name.
13561
14245
  # @param [Hash] opts the optional parameters
13562
- # @option opts [BOOLEAN] :update_appearances If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance..
13563
- # @option opts [BOOLEAN] :call_events If set, formatting and other JavaScript events will be called.
13564
- # @option opts [BOOLEAN] :hide_buttons If set, buttons will be removed from flattened document.
13565
14246
  # @option opts [String] :storage The document storage.
13566
14247
  # @option opts [String] :folder The document folder.
14248
+ # @option opts [File] :xml_data Xml file.
13567
14249
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
13568
- def post_flatten_document_with_http_info(name, opts = {})
14250
+ def post_import_fields_from_xml_with_http_info(name, opts = {})
13569
14251
  if @api_client.config.debugging
13570
- @api_client.config.logger.debug "Calling API: PdfApi.post_flatten_document ..."
14252
+ @api_client.config.logger.debug "Calling API: PdfApi.post_import_fields_from_xml ..."
13571
14253
  end
13572
14254
  # verify the required parameter 'name' is set
13573
14255
  if @api_client.config.client_side_validation && name.nil?
13574
- fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_flatten_document"
14256
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_import_fields_from_xml"
13575
14257
  end
13576
14258
  # resource path
13577
- local_var_path = "/pdf/{name}/flatten".sub('{' + 'name' + '}', name.to_s)
14259
+ local_var_path = "/pdf/{name}/import/xml".sub('{' + 'name' + '}', name.to_s)
13578
14260
 
13579
14261
  # query parameters
13580
14262
  query_params = {}
13581
- query_params[:'updateAppearances'] = opts[:'update_appearances'] if !opts[:'update_appearances'].nil?
13582
- query_params[:'callEvents'] = opts[:'call_events'] if !opts[:'call_events'].nil?
13583
- query_params[:'hideButtons'] = opts[:'hide_buttons'] if !opts[:'hide_buttons'].nil?
13584
14263
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
13585
14264
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
13586
14265
 
@@ -13589,12 +14268,14 @@ module AsposePdfCloud
13589
14268
  # HTTP header 'Accept' (if needed)
13590
14269
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13591
14270
  # HTTP header 'Content-Type'
13592
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
14271
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
13593
14272
 
13594
14273
  # form parameters
13595
14274
  form_params = {}
13596
14275
  # Fix header in file
13597
14276
  post_body = nil
14277
+ post_body = opts[:'xml_data'] if !opts[:'xml_data'].nil?
14278
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
13598
14279
 
13599
14280
  # http body (model)
13600
14281
  # Fix header in file
@@ -13608,7 +14289,7 @@ module AsposePdfCloud
13608
14289
  :auth_names => auth_names,
13609
14290
  :return_type => 'AsposeResponse')
13610
14291
  if @api_client.config.debugging
13611
- @api_client.config.logger.debug "API called: PdfApi#post_flatten_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14292
+ @api_client.config.logger.debug "API called: PdfApi#post_import_fields_from_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13612
14293
  end
13613
14294
  return data, status_code, headers
13614
14295
  end
@@ -17045,68 +17726,305 @@ module AsposePdfCloud
17045
17726
  return data
17046
17727
  end
17047
17728
 
17048
- # Encrypt document from content.
17729
+ # Encrypt document from content.
17730
+ #
17731
+ # @param out_path Full resulting filename (ex. /folder1/folder2/result.doc)
17732
+ # @param user_password User password (encrypted Base64).
17733
+ # @param owner_password Owner password (encrypted Base64).
17734
+ # @param crypto_algorithm Cryptographic algorithm, see CryptoAlgorithm for details.
17735
+ # @param [Hash] opts the optional parameters
17736
+ # @option opts [Array<PermissionsFlags>] :permissions_flags Array of document permissions, see PermissionsFlags for details.
17737
+ # @option opts [BOOLEAN] :use_pdf20 Support for revision 6 (Extension 8).
17738
+ # @option opts [String] :storage The document storage.
17739
+ # @option opts [File] :file A file to be encrypted.
17740
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
17741
+ def put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, opts = {})
17742
+ if @api_client.config.debugging
17743
+ @api_client.config.logger.debug "Calling API: PdfApi.put_encrypt_document ..."
17744
+ end
17745
+ # verify the required parameter 'out_path' is set
17746
+ if @api_client.config.client_side_validation && out_path.nil?
17747
+ fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.put_encrypt_document"
17748
+ end
17749
+ # verify the required parameter 'user_password' is set
17750
+ if @api_client.config.client_side_validation && user_password.nil?
17751
+ fail ArgumentError, "Missing the required parameter 'user_password' when calling PdfApi.put_encrypt_document"
17752
+ end
17753
+ # verify the required parameter 'owner_password' is set
17754
+ if @api_client.config.client_side_validation && owner_password.nil?
17755
+ fail ArgumentError, "Missing the required parameter 'owner_password' when calling PdfApi.put_encrypt_document"
17756
+ end
17757
+ # verify the required parameter 'crypto_algorithm' is set
17758
+ if @api_client.config.client_side_validation && crypto_algorithm.nil?
17759
+ fail ArgumentError, "Missing the required parameter 'crypto_algorithm' when calling PdfApi.put_encrypt_document"
17760
+ end
17761
+ # verify enum value
17762
+ if @api_client.config.client_side_validation && !['RC4x40', 'RC4x128', 'AESx128', 'AESx256'].include?(crypto_algorithm)
17763
+ fail ArgumentError, "invalid value for 'crypto_algorithm', must be one of RC4x40, RC4x128, AESx128, AESx256"
17764
+ end
17765
+ # resource path
17766
+ local_var_path = "/pdf/encrypt"
17767
+
17768
+ # query parameters
17769
+ query_params = {}
17770
+ query_params[:'outPath'] = out_path
17771
+ query_params[:'userPassword'] = user_password
17772
+ query_params[:'ownerPassword'] = owner_password
17773
+ query_params[:'cryptoAlgorithm'] = crypto_algorithm
17774
+ query_params[:'permissionsFlags'] = @api_client.build_collection_param(opts[:'permissions_flags'], :multi) if !opts[:'permissions_flags'].nil?
17775
+ query_params[:'usePdf20'] = opts[:'use_pdf20'] if !opts[:'use_pdf20'].nil?
17776
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
17777
+
17778
+ # header parameters
17779
+ header_params = {}
17780
+ # HTTP header 'Accept' (if needed)
17781
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17782
+ # HTTP header 'Content-Type'
17783
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
17784
+
17785
+ # form parameters
17786
+ form_params = {}
17787
+ # Fix header in file
17788
+ post_body = nil
17789
+ post_body = opts[:'file'] if !opts[:'file'].nil?
17790
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
17791
+
17792
+ # http body (model)
17793
+ # Fix header in file
17794
+ # post_body = nil
17795
+ auth_names = ['JWT']
17796
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
17797
+ :header_params => header_params,
17798
+ :query_params => query_params,
17799
+ :form_params => form_params,
17800
+ :body => post_body,
17801
+ :auth_names => auth_names,
17802
+ :return_type => 'AsposeResponse')
17803
+ if @api_client.config.debugging
17804
+ @api_client.config.logger.debug "API called: PdfApi#put_encrypt_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17805
+ end
17806
+ return data, status_code, headers
17807
+ end
17808
+
17809
+ # Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
17810
+ #
17811
+ # @param name The document name.
17812
+ # @param src_path Full source filename (ex. /folder1/folder2/template.epub)
17813
+ # @param [Hash] opts the optional parameters
17814
+ # @option opts [String] :storage The document storage.
17815
+ # @option opts [String] :dst_folder The destination document folder.
17816
+ # @return [AsposeResponse]
17817
+ def put_epub_in_storage_to_pdf(name, src_path, opts = {})
17818
+ @api_client.request_token_if_needed
17819
+ data, _status_code, _headers = put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts)
17820
+ rescue ApiError => error
17821
+ if error.code == 401
17822
+ @api_client.request_token_if_needed
17823
+ data, _status_code, _headers = put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts)
17824
+ else
17825
+ raise
17826
+ end
17827
+ return data
17828
+ end
17829
+
17830
+ # Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
17831
+ #
17832
+ # @param name The document name.
17833
+ # @param src_path Full source filename (ex. /folder1/folder2/template.epub)
17834
+ # @param [Hash] opts the optional parameters
17835
+ # @option opts [String] :storage The document storage.
17836
+ # @option opts [String] :dst_folder The destination document folder.
17837
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
17838
+ def put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
17839
+ if @api_client.config.debugging
17840
+ @api_client.config.logger.debug "Calling API: PdfApi.put_epub_in_storage_to_pdf ..."
17841
+ end
17842
+ # verify the required parameter 'name' is set
17843
+ if @api_client.config.client_side_validation && name.nil?
17844
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_epub_in_storage_to_pdf"
17845
+ end
17846
+ # verify the required parameter 'src_path' is set
17847
+ if @api_client.config.client_side_validation && src_path.nil?
17848
+ fail ArgumentError, "Missing the required parameter 'src_path' when calling PdfApi.put_epub_in_storage_to_pdf"
17849
+ end
17850
+ # resource path
17851
+ local_var_path = "/pdf/{name}/create/epub".sub('{' + 'name' + '}', name.to_s)
17852
+
17853
+ # query parameters
17854
+ query_params = {}
17855
+ query_params[:'srcPath'] = src_path
17856
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
17857
+ query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
17858
+
17859
+ # header parameters
17860
+ header_params = {}
17861
+ # HTTP header 'Accept' (if needed)
17862
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17863
+ # HTTP header 'Content-Type'
17864
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
17865
+
17866
+ # form parameters
17867
+ form_params = {}
17868
+ # Fix header in file
17869
+ post_body = nil
17870
+
17871
+ # http body (model)
17872
+ # Fix header in file
17873
+ # post_body = nil
17874
+ auth_names = ['JWT']
17875
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
17876
+ :header_params => header_params,
17877
+ :query_params => query_params,
17878
+ :form_params => form_params,
17879
+ :body => post_body,
17880
+ :auth_names => auth_names,
17881
+ :return_type => 'AsposeResponse')
17882
+ if @api_client.config.debugging
17883
+ @api_client.config.logger.debug "API called: PdfApi#put_epub_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17884
+ end
17885
+ return data, status_code, headers
17886
+ end
17887
+
17888
+ # Export fields from from PDF in storage to FDF file in storage.
17889
+ #
17890
+ # @param name The document name.
17891
+ # @param fdf_output_file_path The output Fdf file path.
17892
+ # @param [Hash] opts the optional parameters
17893
+ # @option opts [String] :storage The document storage.
17894
+ # @option opts [String] :folder The document folder.
17895
+ # @return [AsposeResponse]
17896
+ def put_export_fields_from_pdf_to_fdf_in_storage(name, fdf_output_file_path, opts = {})
17897
+ @api_client.request_token_if_needed
17898
+ data, _status_code, _headers = put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, opts)
17899
+ rescue ApiError => error
17900
+ if error.code == 401
17901
+ @api_client.request_token_if_needed
17902
+ data, _status_code, _headers = put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, opts)
17903
+ else
17904
+ raise
17905
+ end
17906
+ return data
17907
+ end
17908
+
17909
+ # Export fields from from PDF in storage to FDF file in storage.
17910
+ #
17911
+ # @param name The document name.
17912
+ # @param fdf_output_file_path The output Fdf file path.
17913
+ # @param [Hash] opts the optional parameters
17914
+ # @option opts [String] :storage The document storage.
17915
+ # @option opts [String] :folder The document folder.
17916
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
17917
+ def put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, opts = {})
17918
+ if @api_client.config.debugging
17919
+ @api_client.config.logger.debug "Calling API: PdfApi.put_export_fields_from_pdf_to_fdf_in_storage ..."
17920
+ end
17921
+ # verify the required parameter 'name' is set
17922
+ if @api_client.config.client_side_validation && name.nil?
17923
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_export_fields_from_pdf_to_fdf_in_storage"
17924
+ end
17925
+ # verify the required parameter 'fdf_output_file_path' is set
17926
+ if @api_client.config.client_side_validation && fdf_output_file_path.nil?
17927
+ fail ArgumentError, "Missing the required parameter 'fdf_output_file_path' when calling PdfApi.put_export_fields_from_pdf_to_fdf_in_storage"
17928
+ end
17929
+ # resource path
17930
+ local_var_path = "/pdf/{name}/export/fdf".sub('{' + 'name' + '}', name.to_s)
17931
+
17932
+ # query parameters
17933
+ query_params = {}
17934
+ query_params[:'fdfOutputFilePath'] = fdf_output_file_path
17935
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
17936
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
17937
+
17938
+ # header parameters
17939
+ header_params = {}
17940
+ # HTTP header 'Accept' (if needed)
17941
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17942
+ # HTTP header 'Content-Type'
17943
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
17944
+
17945
+ # form parameters
17946
+ form_params = {}
17947
+ # Fix header in file
17948
+ post_body = nil
17949
+
17950
+ # http body (model)
17951
+ # Fix header in file
17952
+ # post_body = nil
17953
+ auth_names = ['JWT']
17954
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
17955
+ :header_params => header_params,
17956
+ :query_params => query_params,
17957
+ :form_params => form_params,
17958
+ :body => post_body,
17959
+ :auth_names => auth_names,
17960
+ :return_type => 'AsposeResponse')
17961
+ if @api_client.config.debugging
17962
+ @api_client.config.logger.debug "API called: PdfApi#put_export_fields_from_pdf_to_fdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17963
+ end
17964
+ return data, status_code, headers
17965
+ end
17966
+
17967
+ # Export fields from from PDF in storage to XFDF file in storage.
17968
+ #
17969
+ # @param name The document name.
17970
+ # @param xfdf_output_file_path The output xfdf file path.
17971
+ # @param [Hash] opts the optional parameters
17972
+ # @option opts [String] :storage The document storage.
17973
+ # @option opts [String] :folder The document folder.
17974
+ # @return [AsposeResponse]
17975
+ def put_export_fields_from_pdf_to_xfdf_in_storage(name, xfdf_output_file_path, opts = {})
17976
+ @api_client.request_token_if_needed
17977
+ data, _status_code, _headers = put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, opts)
17978
+ rescue ApiError => error
17979
+ if error.code == 401
17980
+ @api_client.request_token_if_needed
17981
+ data, _status_code, _headers = put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, opts)
17982
+ else
17983
+ raise
17984
+ end
17985
+ return data
17986
+ end
17987
+
17988
+ # Export fields from from PDF in storage to XFDF file in storage.
17049
17989
  #
17050
- # @param out_path Full resulting filename (ex. /folder1/folder2/result.doc)
17051
- # @param user_password User password (encrypted Base64).
17052
- # @param owner_password Owner password (encrypted Base64).
17053
- # @param crypto_algorithm Cryptographic algorithm, see CryptoAlgorithm for details.
17990
+ # @param name The document name.
17991
+ # @param xfdf_output_file_path The output xfdf file path.
17054
17992
  # @param [Hash] opts the optional parameters
17055
- # @option opts [Array<PermissionsFlags>] :permissions_flags Array of document permissions, see PermissionsFlags for details.
17056
- # @option opts [BOOLEAN] :use_pdf20 Support for revision 6 (Extension 8).
17057
17993
  # @option opts [String] :storage The document storage.
17058
- # @option opts [File] :file A file to be encrypted.
17994
+ # @option opts [String] :folder The document folder.
17059
17995
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
17060
- def put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, opts = {})
17996
+ def put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, opts = {})
17061
17997
  if @api_client.config.debugging
17062
- @api_client.config.logger.debug "Calling API: PdfApi.put_encrypt_document ..."
17063
- end
17064
- # verify the required parameter 'out_path' is set
17065
- if @api_client.config.client_side_validation && out_path.nil?
17066
- fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.put_encrypt_document"
17998
+ @api_client.config.logger.debug "Calling API: PdfApi.put_export_fields_from_pdf_to_xfdf_in_storage ..."
17067
17999
  end
17068
- # verify the required parameter 'user_password' is set
17069
- if @api_client.config.client_side_validation && user_password.nil?
17070
- fail ArgumentError, "Missing the required parameter 'user_password' when calling PdfApi.put_encrypt_document"
17071
- end
17072
- # verify the required parameter 'owner_password' is set
17073
- if @api_client.config.client_side_validation && owner_password.nil?
17074
- fail ArgumentError, "Missing the required parameter 'owner_password' when calling PdfApi.put_encrypt_document"
17075
- end
17076
- # verify the required parameter 'crypto_algorithm' is set
17077
- if @api_client.config.client_side_validation && crypto_algorithm.nil?
17078
- fail ArgumentError, "Missing the required parameter 'crypto_algorithm' when calling PdfApi.put_encrypt_document"
18000
+ # verify the required parameter 'name' is set
18001
+ if @api_client.config.client_side_validation && name.nil?
18002
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_export_fields_from_pdf_to_xfdf_in_storage"
17079
18003
  end
17080
- # verify enum value
17081
- if @api_client.config.client_side_validation && !['RC4x40', 'RC4x128', 'AESx128', 'AESx256'].include?(crypto_algorithm)
17082
- fail ArgumentError, "invalid value for 'crypto_algorithm', must be one of RC4x40, RC4x128, AESx128, AESx256"
18004
+ # verify the required parameter 'xfdf_output_file_path' is set
18005
+ if @api_client.config.client_side_validation && xfdf_output_file_path.nil?
18006
+ fail ArgumentError, "Missing the required parameter 'xfdf_output_file_path' when calling PdfApi.put_export_fields_from_pdf_to_xfdf_in_storage"
17083
18007
  end
17084
18008
  # resource path
17085
- local_var_path = "/pdf/encrypt"
18009
+ local_var_path = "/pdf/{name}/export/xfdf".sub('{' + 'name' + '}', name.to_s)
17086
18010
 
17087
18011
  # query parameters
17088
18012
  query_params = {}
17089
- query_params[:'outPath'] = out_path
17090
- query_params[:'userPassword'] = user_password
17091
- query_params[:'ownerPassword'] = owner_password
17092
- query_params[:'cryptoAlgorithm'] = crypto_algorithm
17093
- query_params[:'permissionsFlags'] = @api_client.build_collection_param(opts[:'permissions_flags'], :multi) if !opts[:'permissions_flags'].nil?
17094
- query_params[:'usePdf20'] = opts[:'use_pdf20'] if !opts[:'use_pdf20'].nil?
18013
+ query_params[:'xfdfOutputFilePath'] = xfdf_output_file_path
17095
18014
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
18015
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
17096
18016
 
17097
18017
  # header parameters
17098
18018
  header_params = {}
17099
18019
  # HTTP header 'Accept' (if needed)
17100
18020
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17101
18021
  # HTTP header 'Content-Type'
17102
- header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
18022
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
17103
18023
 
17104
18024
  # form parameters
17105
18025
  form_params = {}
17106
18026
  # Fix header in file
17107
18027
  post_body = nil
17108
- post_body = opts[:'file'] if !opts[:'file'].nil?
17109
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
17110
18028
 
17111
18029
  # http body (model)
17112
18030
  # Fix header in file
@@ -17120,60 +18038,60 @@ module AsposePdfCloud
17120
18038
  :auth_names => auth_names,
17121
18039
  :return_type => 'AsposeResponse')
17122
18040
  if @api_client.config.debugging
17123
- @api_client.config.logger.debug "API called: PdfApi#put_encrypt_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18041
+ @api_client.config.logger.debug "API called: PdfApi#put_export_fields_from_pdf_to_xfdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17124
18042
  end
17125
18043
  return data, status_code, headers
17126
18044
  end
17127
18045
 
17128
- # Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
18046
+ # Export fields from from PDF in storage to XML file in storage.
17129
18047
  #
17130
18048
  # @param name The document name.
17131
- # @param src_path Full source filename (ex. /folder1/folder2/template.epub)
18049
+ # @param xml_output_file_path The output xml file path.
17132
18050
  # @param [Hash] opts the optional parameters
17133
18051
  # @option opts [String] :storage The document storage.
17134
- # @option opts [String] :dst_folder The destination document folder.
18052
+ # @option opts [String] :folder The document folder.
17135
18053
  # @return [AsposeResponse]
17136
- def put_epub_in_storage_to_pdf(name, src_path, opts = {})
18054
+ def put_export_fields_from_pdf_to_xml_in_storage(name, xml_output_file_path, opts = {})
17137
18055
  @api_client.request_token_if_needed
17138
- data, _status_code, _headers = put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts)
18056
+ data, _status_code, _headers = put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, opts)
17139
18057
  rescue ApiError => error
17140
18058
  if error.code == 401
17141
18059
  @api_client.request_token_if_needed
17142
- data, _status_code, _headers = put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts)
18060
+ data, _status_code, _headers = put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, opts)
17143
18061
  else
17144
18062
  raise
17145
18063
  end
17146
18064
  return data
17147
18065
  end
17148
18066
 
17149
- # Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
18067
+ # Export fields from from PDF in storage to XML file in storage.
17150
18068
  #
17151
18069
  # @param name The document name.
17152
- # @param src_path Full source filename (ex. /folder1/folder2/template.epub)
18070
+ # @param xml_output_file_path The output xml file path.
17153
18071
  # @param [Hash] opts the optional parameters
17154
18072
  # @option opts [String] :storage The document storage.
17155
- # @option opts [String] :dst_folder The destination document folder.
18073
+ # @option opts [String] :folder The document folder.
17156
18074
  # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
17157
- def put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
18075
+ def put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, opts = {})
17158
18076
  if @api_client.config.debugging
17159
- @api_client.config.logger.debug "Calling API: PdfApi.put_epub_in_storage_to_pdf ..."
18077
+ @api_client.config.logger.debug "Calling API: PdfApi.put_export_fields_from_pdf_to_xml_in_storage ..."
17160
18078
  end
17161
18079
  # verify the required parameter 'name' is set
17162
18080
  if @api_client.config.client_side_validation && name.nil?
17163
- fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_epub_in_storage_to_pdf"
18081
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_export_fields_from_pdf_to_xml_in_storage"
17164
18082
  end
17165
- # verify the required parameter 'src_path' is set
17166
- if @api_client.config.client_side_validation && src_path.nil?
17167
- fail ArgumentError, "Missing the required parameter 'src_path' when calling PdfApi.put_epub_in_storage_to_pdf"
18083
+ # verify the required parameter 'xml_output_file_path' is set
18084
+ if @api_client.config.client_side_validation && xml_output_file_path.nil?
18085
+ fail ArgumentError, "Missing the required parameter 'xml_output_file_path' when calling PdfApi.put_export_fields_from_pdf_to_xml_in_storage"
17168
18086
  end
17169
18087
  # resource path
17170
- local_var_path = "/pdf/{name}/create/epub".sub('{' + 'name' + '}', name.to_s)
18088
+ local_var_path = "/pdf/{name}/export/xml".sub('{' + 'name' + '}', name.to_s)
17171
18089
 
17172
18090
  # query parameters
17173
18091
  query_params = {}
17174
- query_params[:'srcPath'] = src_path
18092
+ query_params[:'xmlOutputFilePath'] = xml_output_file_path
17175
18093
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
17176
- query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
18094
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
17177
18095
 
17178
18096
  # header parameters
17179
18097
  header_params = {}
@@ -17199,7 +18117,7 @@ module AsposePdfCloud
17199
18117
  :auth_names => auth_names,
17200
18118
  :return_type => 'AsposeResponse')
17201
18119
  if @api_client.config.debugging
17202
- @api_client.config.logger.debug "API called: PdfApi#put_epub_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18120
+ @api_client.config.logger.debug "API called: PdfApi#put_export_fields_from_pdf_to_xml_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17203
18121
  end
17204
18122
  return data, status_code, headers
17205
18123
  end
@@ -18482,6 +19400,243 @@ module AsposePdfCloud
18482
19400
  return data, status_code, headers
18483
19401
  end
18484
19402
 
19403
+ # Update fields from FDF file in storage.
19404
+ #
19405
+ # @param name The document name.
19406
+ # @param fdf_file_path The Fdf file path.
19407
+ # @param [Hash] opts the optional parameters
19408
+ # @option opts [String] :storage The document storage.
19409
+ # @option opts [String] :folder The document folder.
19410
+ # @return [AsposeResponse]
19411
+ def put_import_fields_from_fdf_in_storage(name, fdf_file_path, opts = {})
19412
+ @api_client.request_token_if_needed
19413
+ data, _status_code, _headers = put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts)
19414
+ rescue ApiError => error
19415
+ if error.code == 401
19416
+ @api_client.request_token_if_needed
19417
+ data, _status_code, _headers = put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts)
19418
+ else
19419
+ raise
19420
+ end
19421
+ return data
19422
+ end
19423
+
19424
+ # Update fields from FDF file in storage.
19425
+ #
19426
+ # @param name The document name.
19427
+ # @param fdf_file_path The Fdf file path.
19428
+ # @param [Hash] opts the optional parameters
19429
+ # @option opts [String] :storage The document storage.
19430
+ # @option opts [String] :folder The document folder.
19431
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
19432
+ def put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts = {})
19433
+ if @api_client.config.debugging
19434
+ @api_client.config.logger.debug "Calling API: PdfApi.put_import_fields_from_fdf_in_storage ..."
19435
+ end
19436
+ # verify the required parameter 'name' is set
19437
+ if @api_client.config.client_side_validation && name.nil?
19438
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_import_fields_from_fdf_in_storage"
19439
+ end
19440
+ # verify the required parameter 'fdf_file_path' is set
19441
+ if @api_client.config.client_side_validation && fdf_file_path.nil?
19442
+ fail ArgumentError, "Missing the required parameter 'fdf_file_path' when calling PdfApi.put_import_fields_from_fdf_in_storage"
19443
+ end
19444
+ # resource path
19445
+ local_var_path = "/pdf/{name}/import/fdf".sub('{' + 'name' + '}', name.to_s)
19446
+
19447
+ # query parameters
19448
+ query_params = {}
19449
+ query_params[:'fdfFilePath'] = fdf_file_path
19450
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
19451
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
19452
+
19453
+ # header parameters
19454
+ header_params = {}
19455
+ # HTTP header 'Accept' (if needed)
19456
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19457
+ # HTTP header 'Content-Type'
19458
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
19459
+
19460
+ # form parameters
19461
+ form_params = {}
19462
+ # Fix header in file
19463
+ post_body = nil
19464
+
19465
+ # http body (model)
19466
+ # Fix header in file
19467
+ # post_body = nil
19468
+ auth_names = ['JWT']
19469
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
19470
+ :header_params => header_params,
19471
+ :query_params => query_params,
19472
+ :form_params => form_params,
19473
+ :body => post_body,
19474
+ :auth_names => auth_names,
19475
+ :return_type => 'AsposeResponse')
19476
+ if @api_client.config.debugging
19477
+ @api_client.config.logger.debug "API called: PdfApi#put_import_fields_from_fdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19478
+ end
19479
+ return data, status_code, headers
19480
+ end
19481
+
19482
+ # Update fields from XFDF file in storage.
19483
+ #
19484
+ # @param name The document name.
19485
+ # @param xfdf_file_path The XFDF file path.
19486
+ # @param [Hash] opts the optional parameters
19487
+ # @option opts [String] :storage The document storage.
19488
+ # @option opts [String] :folder The document folder.
19489
+ # @return [AsposeResponse]
19490
+ def put_import_fields_from_xfdf_in_storage(name, xfdf_file_path, opts = {})
19491
+ @api_client.request_token_if_needed
19492
+ data, _status_code, _headers = put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts)
19493
+ rescue ApiError => error
19494
+ if error.code == 401
19495
+ @api_client.request_token_if_needed
19496
+ data, _status_code, _headers = put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts)
19497
+ else
19498
+ raise
19499
+ end
19500
+ return data
19501
+ end
19502
+
19503
+ # Update fields from XFDF file in storage.
19504
+ #
19505
+ # @param name The document name.
19506
+ # @param xfdf_file_path The XFDF file path.
19507
+ # @param [Hash] opts the optional parameters
19508
+ # @option opts [String] :storage The document storage.
19509
+ # @option opts [String] :folder The document folder.
19510
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
19511
+ def put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts = {})
19512
+ if @api_client.config.debugging
19513
+ @api_client.config.logger.debug "Calling API: PdfApi.put_import_fields_from_xfdf_in_storage ..."
19514
+ end
19515
+ # verify the required parameter 'name' is set
19516
+ if @api_client.config.client_side_validation && name.nil?
19517
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_import_fields_from_xfdf_in_storage"
19518
+ end
19519
+ # verify the required parameter 'xfdf_file_path' is set
19520
+ if @api_client.config.client_side_validation && xfdf_file_path.nil?
19521
+ fail ArgumentError, "Missing the required parameter 'xfdf_file_path' when calling PdfApi.put_import_fields_from_xfdf_in_storage"
19522
+ end
19523
+ # resource path
19524
+ local_var_path = "/pdf/{name}/import/xfdf".sub('{' + 'name' + '}', name.to_s)
19525
+
19526
+ # query parameters
19527
+ query_params = {}
19528
+ query_params[:'xfdfFilePath'] = xfdf_file_path
19529
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
19530
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
19531
+
19532
+ # header parameters
19533
+ header_params = {}
19534
+ # HTTP header 'Accept' (if needed)
19535
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19536
+ # HTTP header 'Content-Type'
19537
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
19538
+
19539
+ # form parameters
19540
+ form_params = {}
19541
+ # Fix header in file
19542
+ post_body = nil
19543
+
19544
+ # http body (model)
19545
+ # Fix header in file
19546
+ # post_body = nil
19547
+ auth_names = ['JWT']
19548
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
19549
+ :header_params => header_params,
19550
+ :query_params => query_params,
19551
+ :form_params => form_params,
19552
+ :body => post_body,
19553
+ :auth_names => auth_names,
19554
+ :return_type => 'AsposeResponse')
19555
+ if @api_client.config.debugging
19556
+ @api_client.config.logger.debug "API called: PdfApi#put_import_fields_from_xfdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19557
+ end
19558
+ return data, status_code, headers
19559
+ end
19560
+
19561
+ # Update fields from XML file in storage.
19562
+ #
19563
+ # @param name The document name.
19564
+ # @param xml_file_path Full source filename (ex. /folder1/folder2/template.xml)
19565
+ # @param [Hash] opts the optional parameters
19566
+ # @option opts [String] :storage The document storage.
19567
+ # @option opts [String] :folder The document folder.
19568
+ # @return [AsposeResponse]
19569
+ def put_import_fields_from_xml_in_storage(name, xml_file_path, opts = {})
19570
+ @api_client.request_token_if_needed
19571
+ data, _status_code, _headers = put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts)
19572
+ rescue ApiError => error
19573
+ if error.code == 401
19574
+ @api_client.request_token_if_needed
19575
+ data, _status_code, _headers = put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts)
19576
+ else
19577
+ raise
19578
+ end
19579
+ return data
19580
+ end
19581
+
19582
+ # Update fields from XML file in storage.
19583
+ #
19584
+ # @param name The document name.
19585
+ # @param xml_file_path Full source filename (ex. /folder1/folder2/template.xml)
19586
+ # @param [Hash] opts the optional parameters
19587
+ # @option opts [String] :storage The document storage.
19588
+ # @option opts [String] :folder The document folder.
19589
+ # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
19590
+ def put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts = {})
19591
+ if @api_client.config.debugging
19592
+ @api_client.config.logger.debug "Calling API: PdfApi.put_import_fields_from_xml_in_storage ..."
19593
+ end
19594
+ # verify the required parameter 'name' is set
19595
+ if @api_client.config.client_side_validation && name.nil?
19596
+ fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_import_fields_from_xml_in_storage"
19597
+ end
19598
+ # verify the required parameter 'xml_file_path' is set
19599
+ if @api_client.config.client_side_validation && xml_file_path.nil?
19600
+ fail ArgumentError, "Missing the required parameter 'xml_file_path' when calling PdfApi.put_import_fields_from_xml_in_storage"
19601
+ end
19602
+ # resource path
19603
+ local_var_path = "/pdf/{name}/import/xml".sub('{' + 'name' + '}', name.to_s)
19604
+
19605
+ # query parameters
19606
+ query_params = {}
19607
+ query_params[:'xmlFilePath'] = xml_file_path
19608
+ query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
19609
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
19610
+
19611
+ # header parameters
19612
+ header_params = {}
19613
+ # HTTP header 'Accept' (if needed)
19614
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19615
+ # HTTP header 'Content-Type'
19616
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
19617
+
19618
+ # form parameters
19619
+ form_params = {}
19620
+ # Fix header in file
19621
+ post_body = nil
19622
+
19623
+ # http body (model)
19624
+ # Fix header in file
19625
+ # post_body = nil
19626
+ auth_names = ['JWT']
19627
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
19628
+ :header_params => header_params,
19629
+ :query_params => query_params,
19630
+ :form_params => form_params,
19631
+ :body => post_body,
19632
+ :auth_names => auth_names,
19633
+ :return_type => 'AsposeResponse')
19634
+ if @api_client.config.debugging
19635
+ @api_client.config.logger.debug "API called: PdfApi#put_import_fields_from_xml_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19636
+ end
19637
+ return data, status_code, headers
19638
+ end
19639
+
18485
19640
  # Replace document ink annotation
18486
19641
  #
18487
19642
  # @param name The document name.