Class: GroupDocsMergerCloud::InfoApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_merger_cloud/api/info_api.rb

Overview

GroupDocs.Merger Cloud API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ InfoApi

Initializes new instance of InfoApi



43
44
45
46
47
 
# File 'lib/groupdocs_merger_cloud/api/info_api.rb', line 43

def initialize(config)
  @config = config
  @api_client = ApiClient.new(config)
  @access_token = nil
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



34
35
36
 
# File 'lib/groupdocs_merger_cloud/api/info_api.rb', line 34

def config
  @config
end

Class Method Details

.from_config(config) ⇒ InfoApi

Initializes new instance of InfoApi



63
64
65
 
# File 'lib/groupdocs_merger_cloud/api/info_api.rb', line 63

def self.from_config(config)
  return new(config)
end

.from_keys(app_sid, app_key) ⇒ InfoApi

Initializes new instance of InfoApi



54
55
56
57
 
# File 'lib/groupdocs_merger_cloud/api/info_api.rb', line 54

def self.from_keys(app_sid, app_key)
  config = Configuration.new(app_sid, app_key)
  return new(config)
end

Instance Method Details

#get_info(request) ⇒ InfoResult

Retrieve information about document pages: size, height, width etc.



71
72
73
74
 
# File 'lib/groupdocs_merger_cloud/api/info_api.rb', line 71

def get_info(request)
  data, _status_code, _headers = get_info_with_http_info(request)
  data
end

#get_info_with_http_info(request) ⇒ Array<(InfoResult, Fixnum, Hash)>

Retrieve information about document pages: size, height, width etc.

InfoResult data, response status code and response headers

Raises:

  • (ArgumentError) 


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/groupdocs_merger_cloud/api/info_api.rb', line 81

def get_info_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? GetInfoRequest

  @api_client.config.logger.debug 'Calling API: InfoApi.get_info ...' if @api_client.config.debugging
  # verify the required parameter 'file_info' is set

  raise ArgumentError, 'Missing the required parameter file_info when calling InfoApi.get_info' if @api_client.config.client_side_validation && request.file_info.nil?
  # resource path

  local_var_path = '/merger/info'

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(request.file_info)
  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,
                                                    access_token: get_access_token,
                                                    return_type: 'InfoResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    InfoApi#get_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#get_supported_file_formats ⇒ FormatsResult

List supported file formats



122
123
124
125
 
# File 'lib/groupdocs_merger_cloud/api/info_api.rb', line 122

def get_supported_file_formats()
  data, _status_code, _headers = get_supported_file_formats_with_http_info()
  data
end

#get_supported_file_formats_with_http_info ⇒ Array<(FormatsResult, Fixnum, Hash)>

FormatsResult data, response status code and response headers



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/groupdocs_merger_cloud/api/info_api.rb', line 132

def get_supported_file_formats_with_http_info()
  

  @api_client.config.logger.debug 'Calling API: InfoApi.get_supported_file_formats ...' if @api_client.config.debugging
  # resource path

  local_var_path = '/merger/formats'

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters

  form_params = {}

  # http body (model)

  post_body = nil
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    access_token: get_access_token,
                                                    return_type: 'FormatsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    InfoApi#get_supported_file_formats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end