Class: GroupDocsMergerCloud::DocumentApi

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

Overview

GroupDocs.Merger Cloud API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ DocumentApi

Initializes new instance of DocumentApi

Parameters:



43
44
45
46
47
 
# File 'lib/groupdocs_merger_cloud/api/document_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/document_api.rb', line 34

def config
  @config
end

Class Method Details

.from_config(config) ⇒ DocumentApi

Initializes new instance of DocumentApi

Parameters:

Returns:



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

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

.from_keys(app_sid, app_key) ⇒ DocumentApi

Initializes new instance of DocumentApi

Parameters:

  • Application (app_sid) —

    identifier (App SID)

  • Application (app_key) —

    private key (App Key)

Returns:



54
55
56
57
 
# File 'lib/groupdocs_merger_cloud/api/document_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

#import(request) ⇒ DocumentResult

Import attachments into pdf document

Parameters:

  • request —

    import_request

Returns:



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

def import(request)
  data, _status_code, _headers = import_with_http_info(request)
  data
end

#import_with_http_info(request) ⇒ Array<(DocumentResult, Fixnum, Hash)>

Import attachments into pdf document

DocumentResult data, response status code and response headers

Parameters:

  • request —

    import_request

Returns:

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/document_api.rb', line 81

def import_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? ImportRequest

  @api_client.config.logger.debug 'Calling API: DocumentApi.import ...' if @api_client.config.debugging
  # verify the required parameter 'options' is set
  raise ArgumentError, 'Missing the required parameter options when calling DocumentApi.import' if @api_client.config.client_side_validation && request.options.nil?
  # resource path
  local_var_path = '/merger/import'

  # 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.options)
  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: 'DocumentResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    DocumentApi#import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#join(request) ⇒ DocumentResult

Join multiple documents into one document

Parameters:

  • request —

    join_request

Returns:



123
124
125
126
 
# File 'lib/groupdocs_merger_cloud/api/document_api.rb', line 123

def join(request)
  data, _status_code, _headers = join_with_http_info(request)
  data
end

#join_with_http_info(request) ⇒ Array<(DocumentResult, Fixnum, Hash)>

Join multiple documents into one document

DocumentResult data, response status code and response headers

Parameters:

  • request —

    join_request

Returns:

Raises:

  • (ArgumentError) 


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
167
168
169
 
# File 'lib/groupdocs_merger_cloud/api/document_api.rb', line 133

def join_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? JoinRequest

  @api_client.config.logger.debug 'Calling API: DocumentApi.join ...' if @api_client.config.debugging
  # verify the required parameter 'options' is set
  raise ArgumentError, 'Missing the required parameter options when calling DocumentApi.join' if @api_client.config.client_side_validation && request.options.nil?
  # resource path
  local_var_path = '/merger/join'

  # 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.options)
  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: 'DocumentResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    DocumentApi#join\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#preview(request) ⇒ MultiDocumentResult

Generate document pages preview

Parameters:

  • request —

    preview_request

Returns:



175
176
177
178
 
# File 'lib/groupdocs_merger_cloud/api/document_api.rb', line 175

def preview(request)
  data, _status_code, _headers = preview_with_http_info(request)
  data
end

#preview_with_http_info(request) ⇒ Array<(MultiDocumentResult, Fixnum, Hash)>

Generate document pages preview

MultiDocumentResult data, response status code and response headers

Parameters:

  • request —

    preview_request

Returns:

Raises:

  • (ArgumentError) 


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/groupdocs_merger_cloud/api/document_api.rb', line 185

def preview_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? PreviewRequest

  @api_client.config.logger.debug 'Calling API: DocumentApi.preview ...' if @api_client.config.debugging
  # verify the required parameter 'options' is set
  raise ArgumentError, 'Missing the required parameter options when calling DocumentApi.preview' if @api_client.config.client_side_validation && request.options.nil?
  # resource path
  local_var_path = '/merger/preview'

  # 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.options)
  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: 'MultiDocumentResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    DocumentApi#preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#split(request) ⇒ MultiDocumentResult

Split single document to multiple documents

Parameters:

  • request —

    split_request

Returns:



227
228
229
230
 
# File 'lib/groupdocs_merger_cloud/api/document_api.rb', line 227

def split(request)
  data, _status_code, _headers = split_with_http_info(request)
  data
end

#split_with_http_info(request) ⇒ Array<(MultiDocumentResult, Fixnum, Hash)>

Split single document to multiple documents

MultiDocumentResult data, response status code and response headers

Parameters:

  • request —

    split_request

Returns:

Raises:

  • (ArgumentError) 


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
272
273
 
# File 'lib/groupdocs_merger_cloud/api/document_api.rb', line 237

def split_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? SplitRequest

  @api_client.config.logger.debug 'Calling API: DocumentApi.split ...' if @api_client.config.debugging
  # verify the required parameter 'options' is set
  raise ArgumentError, 'Missing the required parameter options when calling DocumentApi.split' if @api_client.config.client_side_validation && request.options.nil?
  # resource path
  local_var_path = '/merger/split'

  # 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.options)
  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: 'MultiDocumentResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    DocumentApi#split\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end