Class: CloudmersiveConvertApiClient::ConvertImageApi
- Inherits:
-
Object
- Object
- CloudmersiveConvertApiClient::ConvertImageApi
- Defined in:
- lib/cloudmersive-convert-api-client/api/convert_image_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#convert_image_get_image_info(input_file, opts = {}) ⇒ GetImageInfoResult
Get information about an image Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more.
-
#convert_image_get_image_info_with_http_info(input_file, opts = {}) ⇒ Array<(GetImageInfoResult, Fixnum, Hash)>
Get information about an image Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more.
-
#convert_image_image_format_convert(format1, format2, input_file, opts = {}) ⇒ String
Image format conversion Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.
-
#convert_image_image_format_convert_with_http_info(format1, format2, input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Image format conversion Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.
-
#convert_image_image_set_dpi(dpi, input_file, opts = {}) ⇒ String
Change image DPI Resize an image to have a different DPI.
-
#convert_image_image_set_dpi_with_http_info(dpi, input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Change image DPI Resize an image to have a different DPI.
-
#convert_image_multipage_image_format_convert(format1, format2, input_file, opts = {}) ⇒ MultipageImageFormatConversionResult
Multi-page image format conversion Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
-
#convert_image_multipage_image_format_convert_with_http_info(format1, format2, input_file, opts = {}) ⇒ Array<(MultipageImageFormatConversionResult, Fixnum, Hash)>
Multi-page image format conversion Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
-
#initialize(api_client = ApiClient.default) ⇒ ConvertImageApi
constructor
A new instance of ConvertImageApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ConvertImageApi
Returns a new instance of ConvertImageApi.
19 20 21 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_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/convert_image_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#convert_image_get_image_info(input_file, opts = {}) ⇒ GetImageInfoResult
Get information about an image Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more
27 28 29 30 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_api.rb', line 27 def convert_image_get_image_info(input_file, opts = {}) data, _status_code, _headers = convert_image_get_image_info_with_http_info(input_file, opts) data end |
#convert_image_get_image_info_with_http_info(input_file, opts = {}) ⇒ Array<(GetImageInfoResult, Fixnum, Hash)>
Get information about an image Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more
37 38 39 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 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_api.rb', line 37 def convert_image_get_image_info_with_http_info(input_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertImageApi.convert_image_get_image_info ...' 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 ConvertImageApi.convert_image_get_image_info" end # resource path local_var_path = '/convert/image/get-info' # 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 => 'GetImageInfoResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertImageApi#convert_image_get_image_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_image_image_format_convert(format1, format2, input_file, opts = {}) ⇒ String
Image format conversion Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.
84 85 86 87 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_api.rb', line 84 def convert_image_image_format_convert(format1, format2, input_file, opts = {}) data, _status_code, _headers = convert_image_image_format_convert_with_http_info(format1, format2, input_file, opts) data end |
#convert_image_image_format_convert_with_http_info(format1, format2, input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Image format conversion Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.
96 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 137 138 139 140 141 142 143 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_api.rb', line 96 def convert_image_image_format_convert_with_http_info(format1, format2, input_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertImageApi.convert_image_image_format_convert ...' end # verify the required parameter 'format1' is set if @api_client.config.client_side_validation && format1.nil? fail ArgumentError, "Missing the required parameter 'format1' when calling ConvertImageApi.convert_image_image_format_convert" end # verify the required parameter 'format2' is set if @api_client.config.client_side_validation && format2.nil? fail ArgumentError, "Missing the required parameter 'format2' when calling ConvertImageApi.convert_image_image_format_convert" 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 ConvertImageApi.convert_image_image_format_convert" end # resource path local_var_path = '/convert/image/{format1}/to/{format2}'.sub('{' + 'format1' + '}', format1.to_s).sub('{' + 'format2' + '}', format2.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # 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 => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertImageApi#convert_image_image_format_convert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_image_image_set_dpi(dpi, input_file, opts = {}) ⇒ String
Change image DPI Resize an image to have a different DPI
150 151 152 153 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_api.rb', line 150 def convert_image_image_set_dpi(dpi, input_file, opts = {}) data, _status_code, _headers = convert_image_image_set_dpi_with_http_info(dpi, input_file, opts) data end |
#convert_image_image_set_dpi_with_http_info(dpi, input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Change image DPI Resize an image to have a different DPI
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_api.rb', line 161 def convert_image_image_set_dpi_with_http_info(dpi, input_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertImageApi.convert_image_image_set_dpi ...' end # verify the required parameter 'dpi' is set if @api_client.config.client_side_validation && dpi.nil? fail ArgumentError, "Missing the required parameter 'dpi' when calling ConvertImageApi.convert_image_image_set_dpi" 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 ConvertImageApi.convert_image_image_set_dpi" end # resource path local_var_path = '/convert/image/set-dpi/{dpi}'.sub('{' + 'dpi' + '}', dpi.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # 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 => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertImageApi#convert_image_image_set_dpi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_image_multipage_image_format_convert(format1, format2, input_file, opts = {}) ⇒ MultipageImageFormatConversionResult
Multi-page image format conversion Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
212 213 214 215 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_api.rb', line 212 def convert_image_multipage_image_format_convert(format1, format2, input_file, opts = {}) data, _status_code, _headers = convert_image_multipage_image_format_convert_with_http_info(format1, format2, input_file, opts) data end |
#convert_image_multipage_image_format_convert_with_http_info(format1, format2, input_file, opts = {}) ⇒ Array<(MultipageImageFormatConversionResult, Fixnum, Hash)>
Multi-page image format conversion Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/cloudmersive-convert-api-client/api/convert_image_api.rb', line 224 def convert_image_multipage_image_format_convert_with_http_info(format1, format2, input_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertImageApi.convert_image_multipage_image_format_convert ...' end # verify the required parameter 'format1' is set if @api_client.config.client_side_validation && format1.nil? fail ArgumentError, "Missing the required parameter 'format1' when calling ConvertImageApi.convert_image_multipage_image_format_convert" end # verify the required parameter 'format2' is set if @api_client.config.client_side_validation && format2.nil? fail ArgumentError, "Missing the required parameter 'format2' when calling ConvertImageApi.convert_image_multipage_image_format_convert" 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 ConvertImageApi.convert_image_multipage_image_format_convert" end # resource path local_var_path = '/convert/image-multipage/{format1}/to/{format2}'.sub('{' + 'format1' + '}', format1.to_s).sub('{' + 'format2' + '}', format2.to_s) # 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 => 'MultipageImageFormatConversionResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertImageApi#convert_image_multipage_image_format_convert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |