Class: GroupDocsPlatformCloud::StorageApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_platform_cloud/api/storage_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StorageApi

Returns a new instance of StorageApi.



19
20
21
 
# File 'lib/groupdocs_platform_cloud/api/storage_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/groupdocs_platform_cloud/api/storage_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#storage_get_disc_usage(opts = {}) ⇒ DiscUsageResponse

Check the disk usage of the current account. Parameters: storage - user’s storage name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)

Returns:



28
29
30
31
 
# File 'lib/groupdocs_platform_cloud/api/storage_api.rb', line 28

def storage_get_disc_usage(opts = {})
  data, _status_code, _headers = storage_get_disc_usage_with_http_info(opts)
  return data
end

#storage_get_disc_usage_with_http_info(opts = {}) ⇒ Array<(DiscUsageResponse, Fixnum, Hash)>

Check the disk usage of the current account. Parameters: storage - user&#39;s storage name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)

Returns:

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

    DiscUsageResponse data, response status code and response headers



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
 
# File 'lib/groupdocs_platform_cloud/api/storage_api.rb', line 38

def storage_get_disc_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StorageApi.storage_get_disc_usage ..."
  end
  # resource path
  local_var_path = "/storage/disc"

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # 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
  auth_names = []
  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,
    :auth_names => auth_names,
    :return_type => 'DiscUsageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageApi#storage_get_disc_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#storage_get_is_exist(path, opts = {}) ⇒ FileExistResponse

Check if a specific file or folder exists.Parameters: path - file or folder path e.g. /file.ext or /Folder1, versionID - file’s version, storage - user’s storage name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :version_id (String)
  • :storage (String)

Returns:



82
83
84
85
 
# File 'lib/groupdocs_platform_cloud/api/storage_api.rb', line 82

def storage_get_is_exist(path, opts = {})
  data, _status_code, _headers = storage_get_is_exist_with_http_info(path, opts)
  return data
end

#storage_get_is_exist_with_http_info(path, opts = {}) ⇒ Array<(FileExistResponse, Fixnum, Hash)>

Check if a specific file or folder exists.Parameters: path - file or folder path e.g. /file.ext or /Folder1, versionID - file&#39;s version, storage - user&#39;s storage name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :version_id (String)
  • :storage (String)

Returns:

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

    FileExistResponse data, response status code and response headers



94
95
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
 
# File 'lib/groupdocs_platform_cloud/api/storage_api.rb', line 94

def storage_get_is_exist_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StorageApi.storage_get_is_exist ..."
  end
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling StorageApi.storage_get_is_exist"
  end
  # resource path
  local_var_path = "/storage/exist/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'version_id'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # 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
  auth_names = []
  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,
    :auth_names => auth_names,
    :return_type => 'FileExistResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageApi#storage_get_is_exist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#storage_get_is_storage_exist(name, opts = {}) ⇒ StorageExistResponse

Check if storage exists.

Parameters:

  • name —

    Storage name

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

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/groupdocs_platform_cloud/api/storage_api.rb', line 141

def storage_get_is_storage_exist(name, opts = {})
  data, _status_code, _headers = storage_get_is_storage_exist_with_http_info(name, opts)
  return data
end

#storage_get_is_storage_exist_with_http_info(name, opts = {}) ⇒ Array<(StorageExistResponse, Fixnum, Hash)>

Check if storage exists.

Parameters:

  • name —

    Storage name

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

    the optional parameters

Returns:

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

    StorageExistResponse data, response status code and response headers



151
152
153
154
155
156
157
158
159
160
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
 
# File 'lib/groupdocs_platform_cloud/api/storage_api.rb', line 151

def storage_get_is_storage_exist_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StorageApi.storage_get_is_storage_exist ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling StorageApi.storage_get_is_storage_exist"
  end
  # resource path
  local_var_path = "/storage/{name}/exist".sub('{' + 'name' + '}', name.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'])
  # 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
  auth_names = []
  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,
    :auth_names => auth_names,
    :return_type => 'StorageExistResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageApi#storage_get_is_storage_exist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#storage_get_list_file_versions(path, opts = {}) ⇒ FileVersionsResponse

Get the file’s versions list. Parameters: path - file path e.g. /file.ext or /Folder1/file.ext, storage - user’s storage name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)

Returns:



197
198
199
200
 
# File 'lib/groupdocs_platform_cloud/api/storage_api.rb', line 197

def storage_get_list_file_versions(path, opts = {})
  data, _status_code, _headers = storage_get_list_file_versions_with_http_info(path, opts)
  return data
end

#storage_get_list_file_versions_with_http_info(path, opts = {}) ⇒ Array<(FileVersionsResponse, Fixnum, Hash)>

Get the file&#39;s versions list. Parameters: path - file path e.g. /file.ext or /Folder1/file.ext, storage - user&#39;s storage name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)

Returns:

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

    FileVersionsResponse data, response status code and response headers



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/groupdocs_platform_cloud/api/storage_api.rb', line 208

def storage_get_list_file_versions_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StorageApi.storage_get_list_file_versions ..."
  end
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling StorageApi.storage_get_list_file_versions"
  end
  # resource path
  local_var_path = "/storage/version/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # 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
  auth_names = []
  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,
    :auth_names => auth_names,
    :return_type => 'FileVersionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageApi#storage_get_list_file_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end