Class: CloudsmithApi::FilesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/api/files_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FilesApi

Returns a new instance of FilesApi.



19
20
21
 
# File 'lib/cloudsmith-api/api/files_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/cloudsmith-api/api/files_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#files_abort(owner, repo, identifier, opts = {}) ⇒ nil

Abort a multipart file upload. Abort a multipart file upload.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 30

def files_abort(owner, repo, identifier, opts = {})
  files_abort_with_http_info(owner, repo, identifier, opts)
  nil
end

#files_abort_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Abort a multipart file upload. Abort a multipart file upload.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 43

def files_abort_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_abort ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling FilesApi.files_abort"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling FilesApi.files_abort"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling FilesApi.files_abort"
  end
  # resource path
  local_var_path = '/files/{owner}/{repo}/{identifier}/abort/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.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 = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_abort\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#files_complete(owner, repo, identifier, opts = {}) ⇒ PackageFileUpload

Complete a multipart file upload. Complete a multipart file upload.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



97
98
99
100
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 97

def files_complete(owner, repo, identifier, opts = {})
  data, _status_code, _headers = files_complete_with_http_info(owner, repo, identifier, opts)
  data
end

#files_complete_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(PackageFileUpload, Fixnum, Hash)>

Complete a multipart file upload. Complete a multipart file upload.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    PackageFileUpload data, response status code and response headers



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
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 110

def files_complete_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_complete ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling FilesApi.files_complete"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling FilesApi.files_complete"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling FilesApi.files_complete"
  end
  # resource path
  local_var_path = '/files/{owner}/{repo}/{identifier}/complete/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.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 = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'PackageFileUpload')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#files_create(owner, repo, opts = {}) ⇒ PackageFileUpload

Request URL(s) to upload new package file upload(s) to. Request URL(s) to upload new package file upload(s) to.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



164
165
166
167
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 164

def files_create(owner, repo, opts = {})
  data, _status_code, _headers = files_create_with_http_info(owner, repo, opts)
  data
end

#files_create_with_http_info(owner, repo, opts = {}) ⇒ Array<(PackageFileUpload, Fixnum, Hash)>

Request URL(s) to upload new package file upload(s) to. Request URL(s) to upload new package file upload(s) to.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PackageFileUpload data, response status code and response headers



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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 176

def files_create_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_create ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling FilesApi.files_create"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling FilesApi.files_create"
  end
  # resource path
  local_var_path = '/files/{owner}/{repo}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.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 = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'PackageFileUpload')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#files_info(owner, repo, identifier, filename, opts = {}) ⇒ PackageFilePartsUpload

Get upload information to perform a multipart file upload. Get upload information to perform a multipart file upload.

Parameters:

  • owner
  • repo
  • identifier
  • filename —

    The filename of the file being uploaded

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

    the optional parameters

Options Hash (opts):

  • :part_number (Integer) —

    The part number to be uploaded next

Returns:



228
229
230
231
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 228

def files_info(owner, repo, identifier, filename, opts = {})
  data, _status_code, _headers = files_info_with_http_info(owner, repo, identifier, filename, opts)
  data
end

#files_info_with_http_info(owner, repo, identifier, filename, opts = {}) ⇒ Array<(PackageFilePartsUpload, Fixnum, Hash)>

Get upload information to perform a multipart file upload. Get upload information to perform a multipart file upload.

Parameters:

  • owner
  • repo
  • identifier
  • filename —

    The filename of the file being uploaded

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

    the optional parameters

Options Hash (opts):

  • :part_number (Integer) —

    The part number to be uploaded next

Returns:

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

    PackageFilePartsUpload data, response status code and response headers



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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 242

def files_info_with_http_info(owner, repo, identifier, filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_info ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling FilesApi.files_info"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling FilesApi.files_info"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling FilesApi.files_info"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling FilesApi.files_info"
  end
  # resource path
  local_var_path = '/files/{owner}/{repo}/{identifier}/info/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'filename'] = filename
  query_params[:'part_number'] = opts[:'part_number'] if !opts[:'part_number'].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 = ['apikey', 'basic']
  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 => 'PackageFilePartsUpload')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#files_validate(owner, repo, opts = {}) ⇒ nil

Validate parameters used for create. Validate parameters used for create.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


302
303
304
305
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 302

def files_validate(owner, repo, opts = {})
  files_validate_with_http_info(owner, repo, opts)
  nil
end

#files_validate_with_http_info(owner, repo, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Validate parameters used for create. Validate parameters used for create.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/cloudsmith-api/api/files_api.rb', line 314

def files_validate_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_validate ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling FilesApi.files_validate"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling FilesApi.files_validate"
  end
  # resource path
  local_var_path = '/files/{owner}/{repo}/validate/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.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 = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_validate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end