Class: CloudmersiveConvertApiClient::SplitDocumentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-convert-api-client/api/split_document_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SplitDocumentApi

Returns a new instance of SplitDocumentApi.



19
20
21
 
# File 'lib/cloudmersive-convert-api-client/api/split_document_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-convert-api-client/api/split_document_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#split_document_pdf_by_page(input_file, opts = {}) ⇒ SplitPdfResult

Split a PDF file into separate PDF files, one per page Split an input PDF file into separate pages, comprised of one PDF file per page.

Parameters:

  • input_file —

    Input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :return_document_contents (BOOLEAN) —

    Set to true to directly return all of the document contents in the DocumentContents field; set to false to return contents as temporary URLs (more efficient for large operations). Default is false.

Returns:



29
30
31
32
 
# File 'lib/cloudmersive-convert-api-client/api/split_document_api.rb', line 29

def split_document_pdf_by_page(input_file, opts = {})
  data, _status_code, _headers = split_document_pdf_by_page_with_http_info(input_file, opts)
  return data
end

#split_document_pdf_by_page_with_http_info(input_file, opts = {}) ⇒ Array<(SplitPdfResult, Fixnum, Hash)>

Split a PDF file into separate PDF files, one per page Split an input PDF file into separate pages, comprised of one PDF file per page.

Parameters:

  • input_file —

    Input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :return_document_contents (BOOLEAN) —

    Set to true to directly return all of the document contents in the DocumentContents field; set to false to return contents as temporary URLs (more efficient for large operations). Default is false.

Returns:

  • (Array<(SplitPdfResult, Fixnum, Hash)>) —

    SplitPdfResult data, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cloudmersive-convert-api-client/api/split_document_api.rb', line 40

def split_document_pdf_by_page_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SplitDocumentApi.split_document_pdf_by_page ..."
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling SplitDocumentApi.split_document_pdf_by_page"
  end
  # resource path
  local_var_path = "/convert/split/pdf"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
  header_params[:'returnDocumentContents'] = opts[:'return_document_contents'] if !opts[:'return_document_contents'].nil?

  # form parameters
  form_params = {}
  form_params["inputFile"] = input_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SplitPdfResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SplitDocumentApi#split_document_pdf_by_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#split_document_xlsx(input_file, opts = {}) ⇒ SplitXlsxWorksheetResult

Split a single Excel XLSX into Separate Worksheets Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.

Parameters:

  • input_file —

    Input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/cloudmersive-convert-api-client/api/split_document_api.rb', line 87

def split_document_xlsx(input_file, opts = {})
  data, _status_code, _headers = split_document_xlsx_with_http_info(input_file, opts)
  return data
end

#split_document_xlsx_with_http_info(input_file, opts = {}) ⇒ Array<(SplitXlsxWorksheetResult, Fixnum, Hash)>

Split a single Excel XLSX into Separate Worksheets Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.

Parameters:

  • input_file —

    Input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SplitXlsxWorksheetResult, Fixnum, Hash)>) —

    SplitXlsxWorksheetResult data, response status code and response headers



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/cloudmersive-convert-api-client/api/split_document_api.rb', line 97

def split_document_xlsx_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SplitDocumentApi.split_document_xlsx ..."
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling SplitDocumentApi.split_document_xlsx"
  end
  # resource path
  local_var_path = "/convert/split/xlsx"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["inputFile"] = input_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SplitXlsxWorksheetResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SplitDocumentApi#split_document_xlsx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end