Class: BrickFTP::RESTfulAPI::CompleteUpload

Inherits:

Object

• Object
• BrickFTP::RESTfulAPI::CompleteUpload

Includes:

Command

Defined in:

lib/brick_ftp/restful_api/complete_upload.rb

Overview

Completing an upload

Params

PARAMETER	TYPE	DESCRIPTION
ref	string	Unique identifier to reference this file upload. This identifier is needed for subsequent requests to the REST API to complete the upload or request more upload URLs.

See Also:

• Completing an upload

Defined Under Namespace

Classes: Params

Instance Method Summary

• #call(path, params) ⇒ BrickFTP::Types::File

  After uploading the file to the file storage environment, the REST API needs to be notified that the upload was completed.

Methods included from Command

included, #initialize

Instance Method Details

#call(path, params) ⇒ BrickFTP::Types::File

After uploading the file to the file storage environment, the REST API needs to be notified that the upload was completed.

This is done by sending another POST request to /files/PATH_AND_FILENAME.EXT with parameter action set to end and parameter ref set to the reference ID returned at the start of the upload.

Parameters:

• path (String) —

  Full path of the file or folder. Maximum of 550 characters.

• params (BrickFTP::RESTfulAPI::CompleteUpload::Params) —

  parameters

Returns:

• (BrickFTP::Types::File) —

  File object

Raises:

• (BrickFTP::RESTfulAPI::Error) —

  exception

# File 'lib/brick_ftp/restful_api/complete_upload.rb', line 39

def call(path, params)
  res = client.post("/api/rest/v1/files/#{ERB::Util.url_encode(path)}", params.to_h.compact.merge(action: 'end'))

  BrickFTP::Types::File.new(**res.symbolize_keys)
end