Class: GroupDocsEditorCloud::EditApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_editor_cloud/api/edit_api.rb

Overview

GroupDocs.Editor Cloud API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ EditApi

Initializes new instance of EditApi

Parameters:



43
44
45
46
47
 
# File 'lib/groupdocs_editor_cloud/api/edit_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_editor_cloud/api/edit_api.rb', line 34

def config
  @config
end

Class Method Details

.from_config(config) ⇒ EditApi

Initializes new instance of EditApi

Parameters:

Returns:

  • (EditApi) —

    New instance of EditApi



63
64
65
 
# File 'lib/groupdocs_editor_cloud/api/edit_api.rb', line 63

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

.from_keys(app_sid, app_key) ⇒ EditApi

Initializes new instance of EditApi

Parameters:

  • Application (app_sid) —

    identifier (App SID)

  • Application (app_key) —

    private key (App Key)

Returns:

  • (EditApi) —

    New instance of EditApi



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

#load(request) ⇒ LoadResult

Load document for editing

Parameters:

  • request —

    load_request

Returns:



71
72
73
74
 
# File 'lib/groupdocs_editor_cloud/api/edit_api.rb', line 71

def load(request)
  data, _status_code, _headers = load_with_http_info(request)
  data
end

#load_with_http_info(request) ⇒ Array<(LoadResult, Fixnum, Hash)>

Load document for editing

LoadResult data, response status code and response headers

Parameters:

  • request —

    load_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_editor_cloud/api/edit_api.rb', line 81

def load_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? LoadRequest

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

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

#save(request) ⇒ DocumentResult

Save document after editing

Parameters:

  • request —

    save_request

Returns:



123
124
125
126
 
# File 'lib/groupdocs_editor_cloud/api/edit_api.rb', line 123

def save(request)
  data, _status_code, _headers = save_with_http_info(request)
  data
end

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

Save document after editing

DocumentResult data, response status code and response headers

Parameters:

  • request —

    save_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_editor_cloud/api/edit_api.rb', line 133

def save_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? SaveRequest

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

  # 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.save_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:
    EditApi#save\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end