Class: PlatformRest::PrivateFile

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_rest/private_file.rb

Overview

Class containing all the actions for the Private File Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PrivateFile

Returns a new instance of PrivateFile.



30
31
32
 
# File 'lib/platform_rest/private_file.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#delete(params = {}) ⇒ Object

Deletes a private file or directory, if a 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, privateFile.*, or privateFile.delete.

Parameters:

  • string applicationId - ID associated with the application

  • string privateFileId - ID associated with the private 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:

Errors:

Raises:

  • (ArgumentError) 


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/platform_rest/private_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("privateFileId is required") unless params.has_key?(:privateFileId)

  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]}/privateFiles/#{params[:privateFileId]}"

  @client.request(
    method: :delete,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get(params = {}) ⇒ Object

Retrieves information on a private 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, privateFile.*, or privateFile.get.

Parameters:

  • string applicationId - ID associated with the application

  • string privateFileId - ID associated with the private file

  • string urlTTL - Time in seconds that the private file url will be valid for. Only applies to private files of type ‘file’. If 0, no url will be returned.

  • 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:

Errors:

Raises:

  • (ArgumentError) 


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/platform_rest/private_file.rb', line 103

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("privateFileId is required") unless params.has_key?(:privateFileId)

  query_params[:urlTTL] = params[:urlTTL] if params.has_key?(:urlTTL)
  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]}/privateFiles/#{params[:privateFileId]}"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#move(params = {}) ⇒ Object

Move a private 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, privateFile.*, or privateFile.move.

Parameters:

  • string applicationId - ID associated with the application

  • string privateFileId - ID associated with the private file

  • undefined name - The new name of the private file or directory

  • undefined parentDirectory - The new parent directory for the private file or directory to move into.

  • string urlTTL - Time in seconds that the private file url will be valid for. Only applies to private files of type ‘file’. If 0, no url will be returned.

  • 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 private 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:

Raises:

  • (ArgumentError) 


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
 
# File 'lib/platform_rest/private_file.rb', line 153

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("privateFileId is required") unless params.has_key?(:privateFileId)

  query_params[:name] = params[:name] if params.has_key?(:name)
  query_params[:parentDirectory] = params[:parentDirectory] if params.has_key?(:parentDirectory)
  query_params[:urlTTL] = params[:urlTTL] if params.has_key?(:urlTTL)
  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]}/privateFiles/#{params[:privateFileId]}/move"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#patch(params = {}) ⇒ Object

Reupload a private 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, privateFile.*, or privateFile.patch.

Parameters:

  • string applicationId - ID associated with the application

  • string privateFileId - ID associated with the private file

  • hash updates - Updated information about the private 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:

Errors:

Raises:

  • (ArgumentError) 


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/platform_rest/private_file.rb', line 203

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("privateFileId is required") unless params.has_key?(:privateFileId)
  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]}/privateFiles/#{params[:privateFileId]}"

  @client.request(
    method: :patch,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end