class LosantRest::File
Class containing all the actions for the File
Resource
Public Class Methods
# File lib/losant_rest/file.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes a file or directory, if directory all the contents that directory will also be removed.
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.delete.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} fileId - ID associated with the file
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
200 - If file was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if file was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/file.rb, line 56 def delete(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("fileId is required") unless params.has_key?(:fileId) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/applications/#{params[:applicationId]}/file/#{params[:fileId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on a file
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, file.*, or file.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} fileId - ID associated with the file
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
200 - file information (api.losant.com/#/definitions/file)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if file was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/file.rb, line 102 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("fileId is required") unless params.has_key?(:fileId) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/applications/#{params[:applicationId]}/file/#{params[:fileId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Move a file or the entire contents of a directory
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.move.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} fileId - ID associated with the file
-
{undefined} name - The new name of the file or directory
-
{undefined} parentDirectory - The new parent directory for the file or directory to move into.
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
201 - Returns a new file or directory that was created by the move, if a directory a job will kick off to move all the directories children. (api.losant.com/#/definitions/file)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if file was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/file.rb, line 150 def move(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("fileId is required") unless params.has_key?(:fileId) query_params[:name] = params[:name] if params.has_key?(:name) query_params[:parentDirectory] = params[:parentDirectory] if params.has_key?(:parentDirectory) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/applications/#{params[:applicationId]}/file/#{params[:fileId]}/move" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end
Reupload a file
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.patch.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} fileId - ID associated with the file
-
{hash} updates - Reupload a file (api.losant.com/#/definitions/filePatch)
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
201 - Successfully updated file and returned a post url to respond with (api.losant.com/#/definitions/fileUploadPostResponse)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if file was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/file.rb, line 199 def patch(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("fileId is required") unless params.has_key?(:fileId) raise ArgumentError.new("updates is required") unless params.has_key?(:updates) body = params[:updates] if params.has_key?(:updates) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/applications/#{params[:applicationId]}/file/#{params[:fileId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end