Logo

View the Project on GitHub elements-storage/elements-sdk-swift

StorageAPI

All URIs are relative to https://elements.local

Method HTTP request Description
applyWorkspaceAffinity POST /api/2/workspaces/{id}/apply-affinity  
bookmarkWorkspace POST /api/2/workspaces/{id}/bookmark  
calculateDirectorySize POST /api/2/filesystem/calculate-directory-size  
checkInIntoWorkspace POST /api/2/workspaces/{id}/check-in  
checkOutOfWorkspace POST /api/2/workspaces/{id}/check-out  
copyFiles POST /api/2/filesystem/copy  
createFile POST /api/2/files  
createPathQuota POST /api/2/volumes/{id}/quotas/path/{relative_path}  
createProduction POST /api/2/productions  
createShare POST /api/2/shares  
createSnapshot POST /api/2/snapshots  
createTemplateFolder POST /api/2/private/create-template-folder  
createVolume POST /api/2/volumes  
createWorkspace POST /api/2/workspaces  
createWorkspacePermission POST /api/2/workspace-permissions  
deleteFile DELETE /api/2/files/{path}  
deleteFiles POST /api/2/filesystem/delete  
deletePathQuota DELETE /api/2/volumes/{id}/quotas/path/{relative_path}  
deleteProduction DELETE /api/2/productions/{id}  
deleteShare DELETE /api/2/shares/{id}  
deleteSnapshot DELETE /api/2/snapshots/{id}  
deleteWorkspace DELETE /api/2/workspaces/{id}  
deleteWorkspacePermission DELETE /api/2/workspace-permissions/{id}  
getAllDeletedWorkspaces GET /api/2/workspaces/deleted  
getAllProductions GET /api/2/productions  
getAllShares GET /api/2/shares  
getAllSnapshots GET /api/2/snapshots  
getAllVolumes GET /api/2/volumes  
getAllWorkspacePermissions GET /api/2/workspace-permissions  
getAllWorkspaces GET /api/2/workspaces  
getFile GET /api/2/files/{path}  
getGroupQuota GET /api/2/volumes/{id}/quotas/group/{group_id}  
getMyWorkspaces GET /api/2/workspaces/mine  
getPathQuota GET /api/2/volumes/{id}/quotas/path/{relative_path}  
getProduction GET /api/2/productions/{id}  
getRootDirectory GET /api/2/files  
getSambaDfreeString POST /api/2/private/dfree  
getShare GET /api/2/shares/{id}  
getSnapshot GET /api/2/snapshots/{id}  
getUserQuota GET /api/2/volumes/{id}/quotas/user/{user_id}  
getVolume GET /api/2/volumes/{id}  
getVolumeActiveConnections GET /api/2/volumes/{id}/connections  
getVolumeFileSizeDistribution GET /api/2/volumes/{id}/file-size-distribution  
getVolumeStats GET /api/2/volumes/{id}/stats  
getWorkspace GET /api/2/workspaces/{id}  
getWorkspacePermission GET /api/2/workspace-permissions/{id}  
moveFiles POST /api/2/filesystem/move  
moveWorkspace POST /api/2/workspaces/{id}/move  
moveWorkspaceToProduction POST /api/2/workspaces/{id}/move-to  
patchFile PATCH /api/2/files/{path}  
patchProduction PATCH /api/2/productions/{id}  
patchShare PATCH /api/2/shares/{id}  
patchSnapshot PATCH /api/2/snapshots/{id}  
patchVolume PATCH /api/2/volumes/{id}  
patchWorkspace PATCH /api/2/workspaces/{id}  
patchWorkspacePermission PATCH /api/2/workspace-permissions/{id}  
recordStorageTrace POST /api/2/filesystem/trace  
repairWorkspacePermissions POST /api/2/workspaces/{id}/repair-permissions  
shareToHomeWorkspace POST /api/2/share-to-home-workspace  
unbookmarkWorkspace DELETE /api/2/workspaces/{id}/bookmark  
unzipFile POST /api/2/filesystem/unzip  
updateGroupQuota PUT /api/2/volumes/{id}/quotas/group/{group_id}  
updatePathQuota PUT /api/2/volumes/{id}/quotas/path/{relative_path}  
updateProduction PUT /api/2/productions/{id}  
updateShare PUT /api/2/shares/{id}  
updateSnapshot PUT /api/2/snapshots/{id}  
updateUserQuota PUT /api/2/volumes/{id}/quotas/user/{user_id}  
updateVolume PUT /api/2/volumes/{id}  
updateWorkspace PUT /api/2/workspaces/{id}  
updateWorkspacePermission PUT /api/2/workspace-permissions/{id}  
zipFiles POST /api/2/filesystem/zip  

applyWorkspaceAffinity

    open class func applyWorkspaceAffinity( id: Int) -> Promise<Void>

Required permissions * User account permission: projects:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.

StorageAPI.applyWorkspaceAffinity(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bookmarkWorkspace

    open class func bookmarkWorkspace( id: Int) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.

StorageAPI.bookmarkWorkspace(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

calculateDirectorySize

    open class func calculateDirectorySize( pathInput: PathInput) -> Promise<FileSizeEndpointResponse>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let pathInput = PathInput(input: ["input_example"]) // PathInput | 

StorageAPI.calculateDirectorySize(pathInput: pathInput).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
pathInput PathInput    

Return type

FileSizeEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkInIntoWorkspace

    open class func checkInIntoWorkspace( id: Int,  workspaceCheckIn: WorkspaceCheckIn) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.
let workspaceCheckIn = WorkspaceCheckIn(mountpoint: "mountpoint_example", _protocol: "_protocol_example", address: "address_example") // WorkspaceCheckIn | 

StorageAPI.checkInIntoWorkspace(id: id, workspaceCheckIn: workspaceCheckIn).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  
workspaceCheckIn WorkspaceCheckIn    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkOutOfWorkspace

    open class func checkOutOfWorkspace( id: Int) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.

StorageAPI.checkOutOfWorkspace(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

copyFiles

    open class func copyFiles( fileCopyEndpointRequest: FileCopyEndpointRequest) -> Promise<TaskInfo>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let fileCopyEndpointRequest = FileCopyEndpointRequest(input: ["input_example"], destination: "destination_example", hardlink: false, sync: false, overwrite: "overwrite_example", folders: "folders_example") // FileCopyEndpointRequest | 

StorageAPI.copyFiles(fileCopyEndpointRequest: fileCopyEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
fileCopyEndpointRequest FileCopyEndpointRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createFile

    open class func createFile( fileUpdate: FileUpdate) -> Promise<FilesystemFile>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let fileUpdate = FileUpdate(name: "name_example", files: [BasicFile(path: "path_example", name: "name_example", size: 123, modificationTime: Date(), totalSize: 123, isDir: false, files: ["TODO"])], parent: "parent_example", mode: "mode_example", uid: 123, gid: 123, user: "user_example", group: "group_example", recursive: false, affinity: "affinity_example", modeSetuid: false, modeSetgid: false, modeSetvfx: false, modeUserRead: false, modeUserWrite: false, modeUserExecute: false, modeGroupRead: false, modeGroupWrite: false, modeGroupExecute: false, modeOthersRead: false, modeOthersWrite: false, modeOthersExecute: false) // FileUpdate | 

StorageAPI.createFile(fileUpdate: fileUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
fileUpdate FileUpdate    

Return type

FilesystemFile

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createPathQuota

    open class func createPathQuota( id: Int,  relativePath: String,  createPathQuotaRequest: CreatePathQuotaRequest) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let relativePath = "relativePath_example" // String | 
let createPathQuotaRequest = CreatePathQuotaRequest(forceDestroyContent: false) // CreatePathQuotaRequest | 

StorageAPI.createPathQuota(id: id, relativePath: relativePath, createPathQuotaRequest: createPathQuotaRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
relativePath String    
createPathQuotaRequest CreatePathQuotaRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createProduction

    open class func createProduction( productionUpdate: ProductionUpdate) -> Promise<Production>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let productionUpdate = ProductionUpdate(name: "name_example", obscureName: false, description: "description_example", longDescription: "longDescription_example", active: false, template: 123, defaultGroup: 123) // ProductionUpdate | 

StorageAPI.createProduction(productionUpdate: productionUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
productionUpdate ProductionUpdate    

Return type

Production

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createShare

    open class func createShare( shareUpdate: ShareUpdate) -> Promise<Share>

Required permissions * User account permission: shares:view (read) / shares:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let shareUpdate = ShareUpdate(sharingNfsPermissions: [NFSPermission(host: "host_example", readOnly: false, options: "options_example")], volume: VolumeReference(id: 123, path: "path_example", nodes: [123], displayName: "displayName_example", visualTag: "visualTag_example", isDefault: false, useForHomes: false, useForWorkspaces: false, type: "type_example", snmEnabled: false, snfsName: "snfsName_example", simulatedQuotas: false, fsProperties: FSProperties(needsSshConnection: false, supportsDirectoryQuotas: false, supportsSoftQuotas: false, supportsUserQuotas: false, supportsGroupQuotas: false, supportsXattrs: false, supportsSnapshots: false, creatingDirectoryQuotaDestroysContent: false, removingDirectoryQuotaDestroysContent: false), backend: Backend(name: "name_example", properties: BackendProperties(supportsSharingRwPermissionsPriority: false, supportsSharingAfp: false, supportsSharingSmbRequireLogon: false, supportsSharingSmbRecycleBin: false, supportsSharingSmbXattrs: false, supportsSharingSmbSymlinks: false, supportsSharingSmbCustomOptions: false, supportsSharingNfsPermissions: false)), status: VolumeStatus(online: false, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, snfs: VolumeSNFSStatus(stripeGroups: [SNFSStripeGroup(name: "name_example", statusTags: ["statusTags_example"], affinity: "affinity_example", sizeTotal: 123, sizeUsed: 123, sizeFree: 123)]), lizardfs: VolumeLizardFSStatus(master: StorageNodeMini(id: 123, name: "name_example", address: "address_example", type: 123), nodes: [LizardFSNode(node: nil, host: "host_example", online: false, version: "version_example", chunks: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, chunksForRemoval: 123, label: "label_example")], disks: [LizardFSDisk(node: nil, host: "host_example", mountpoint: "mountpoint_example", toDelete: false, damaged: false, scanning: false, errorChunk: 123, errorTimestamp: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, chunks: 123)]), beegfs: VolumeBeeGFSStatus(nodes: [BeeGFSNode(node: nil, host: "host_example", roles: ["roles_example"], addresses: ["addresses_example"])], targets: [BeeGFSTarget(node: nil, id: 123, host: "host_example", storagePool: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, online: false, consistent: false, errors: ["errors_example"])])), cloudAccount: 123, name: "name_example"), name: "name_example", path: "path_example", shareSmb: false, shareNfs: false, shareAfp: false, sharingReadOnly: false, sharingHidden: false, sharingRequireLogin: false, smbExtraConfig: "smbExtraConfig_example", afpExtraConfig: "afpExtraConfig_example", rwAccessGroup: 123, roAccessGroup: 123) // ShareUpdate | 

StorageAPI.createShare(shareUpdate: shareUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
shareUpdate ShareUpdate    

Return type

Share

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createSnapshot

    open class func createSnapshot( snapshotUpdate: SnapshotUpdate) -> Promise<Snapshot>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let snapshotUpdate = SnapshotUpdate(workspace: 123, name: "name_example") // SnapshotUpdate | 

StorageAPI.createSnapshot(snapshotUpdate: snapshotUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
snapshotUpdate SnapshotUpdate    

Return type

Snapshot

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createTemplateFolder

    open class func createTemplateFolder( createTemplateFolderEndpointRequest: CreateTemplateFolderEndpointRequest) -> Promise<Void>

Required permissions * User account permission: folder_templates:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let createTemplateFolderEndpointRequest = CreateTemplateFolderEndpointRequest(group: 123, template: "template_example", path: "path_example") // CreateTemplateFolderEndpointRequest | 

StorageAPI.createTemplateFolder(createTemplateFolderEndpointRequest: createTemplateFolderEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
createTemplateFolderEndpointRequest CreateTemplateFolderEndpointRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createVolume

    open class func createVolume( volumeUpdate: VolumeUpdate) -> Promise<Volume>

Required permissions * User account permission: None (read) / system:admin-access (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let volumeUpdate = VolumeUpdate(path: "path_example", nodes: [123], displayName: "displayName_example", visualTag: "visualTag_example", isDefault: false, useForHomes: false, useForWorkspaces: false, type: "type_example", snmEnabled: false, snfsName: "snfsName_example", simulatedQuotas: false, cloudAccount: 123) // VolumeUpdate | 

StorageAPI.createVolume(volumeUpdate: volumeUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
volumeUpdate VolumeUpdate    

Return type

Volume

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createWorkspace

    open class func createWorkspace( workspaceDetailUpdate: WorkspaceDetailUpdate) -> Promise<WorkspaceDetail>

Required permissions * User account permission: None (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let workspaceDetailUpdate = WorkspaceDetailUpdate(production: ProductionReference(id: 123, isSpecial: false, specialType: 123, totalSize: 123, name: "name_example", obscureName: false, description: "description_example", longDescription: "longDescription_example", active: false, template: 123, defaultGroup: 123), volume: "TODO", sharingNfsPermissions: [NFSPermission(host: "host_example", readOnly: false, options: "options_example")], quotaSizeHard: 123, quotaSizeSoft: 123, name: "name_example", description: "description_example", longDescription: "longDescription_example", isTemplate: false, active: false, macProtocol: "macProtocol_example", winProtocol: "winProtocol_example", winDrive: "winDrive_example", linuxProtocol: "linuxProtocol_example", linuxMountpoint: "linuxMountpoint_example", shareName: "shareName_example", shareNfs: false, shareAfp: false, sharingHidden: false, sharingRequireLogin: false, sharingReadOnly: false, sharingAllowExecute: false, enableQuota: false, affinity: "affinity_example", emulateAvid: false, emulateCapture: false, emulatePreopen: false, emulateNtfsStreams: false, emulateRecycleBin: false, emulateFruit: false, smbExtraConfig: "smbExtraConfig_example", afpExtraConfig: "afpExtraConfig_example", recycleBinExclude: "recycleBinExclude_example", isExternal: false, externalMacUrl: "externalMacUrl_example", externalWinUrl: "externalWinUrl_example", externalLinuxUrl: "externalLinuxUrl_example", allowSymlinks: false, rwPermissionPriority: false, template: 123) // WorkspaceDetailUpdate | 

StorageAPI.createWorkspace(workspaceDetailUpdate: workspaceDetailUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
workspaceDetailUpdate WorkspaceDetailUpdate    

Return type

WorkspaceDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createWorkspacePermission

    open class func createWorkspacePermission( workspacePermissionUpdate: WorkspacePermissionUpdate) -> Promise<WorkspacePermission>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let workspacePermissionUpdate = WorkspacePermissionUpdate(user: "TODO", group: "TODO", readOnly: false, workspace: 123) // WorkspacePermissionUpdate | 

StorageAPI.createWorkspacePermission(workspacePermissionUpdate: workspacePermissionUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
workspacePermissionUpdate WorkspacePermissionUpdate    

Return type

WorkspacePermission

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFile

    open class func deleteFile( path: String) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let path = "path_example" // String | 

StorageAPI.deleteFile(path: path).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
path String    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFiles

    open class func deleteFiles( fileDeleteEndpointRequest: FileDeleteEndpointRequest) -> Promise<TaskInfo>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let fileDeleteEndpointRequest = FileDeleteEndpointRequest(input: ["input_example"], sync: false) // FileDeleteEndpointRequest | 

StorageAPI.deleteFiles(fileDeleteEndpointRequest: fileDeleteEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
fileDeleteEndpointRequest FileDeleteEndpointRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePathQuota

    open class func deletePathQuota( id: Int,  relativePath: String) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let relativePath = "relativePath_example" // String | 

StorageAPI.deletePathQuota(id: id, relativePath: relativePath).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
relativePath String    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteProduction

    open class func deleteProduction( id: Int) -> Promise<Void>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this production.

StorageAPI.deleteProduction(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this production.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteShare

    open class func deleteShare( id: Int) -> Promise<Void>

Required permissions * User account permission: shares:view (read) / shares:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this share.

StorageAPI.deleteShare(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this share.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteSnapshot

    open class func deleteSnapshot( id: Int) -> Promise<Void>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this snapshot.

StorageAPI.deleteSnapshot(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this snapshot.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteWorkspace

    open class func deleteWorkspace( id: Int) -> Promise<Void>

Required permissions * User account permission: None (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.

StorageAPI.deleteWorkspace(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteWorkspacePermission

    open class func deleteWorkspacePermission( id: Int) -> Promise<Void>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace permission.

StorageAPI.deleteWorkspacePermission(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace permission.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllDeletedWorkspaces

    open class func getAllDeletedWorkspaces( isTemplate: String? = nil,  production: Double? = nil,  volume: Double? = nil,  homeFor: Double? = nil,  volumeType: String? = nil,  productionName: String? = nil,  productionActive: String? = nil,  name: String? = nil,  isExternal: String? = nil,  active: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[DeletedWorkspace]>

Required permissions * User account permission: projects:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let isTemplate = "isTemplate_example" // String | Filter the returned list by `is_template`. (optional)
let production = 987 // Double | Filter the returned list by `production`. (optional)
let volume = 987 // Double | Filter the returned list by `volume`. (optional)
let homeFor = 987 // Double | Filter the returned list by `home_for`. (optional)
let volumeType = "volumeType_example" // String | Filter the returned list by `volume__type`. (optional)
let productionName = "productionName_example" // String | Filter the returned list by `production__name`. (optional)
let productionActive = "productionActive_example" // String | Filter the returned list by `production__active`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let isExternal = "isExternal_example" // String | Filter the returned list by `is_external`. (optional)
let active = "active_example" // String | Filter the returned list by `active`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

StorageAPI.getAllDeletedWorkspaces(isTemplate: isTemplate, production: production, volume: volume, homeFor: homeFor, volumeType: volumeType, productionName: productionName, productionActive: productionActive, name: name, isExternal: isExternal, active: active, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
isTemplate String Filter the returned list by `is_template`. [optional]
production Double Filter the returned list by `production`. [optional]
volume Double Filter the returned list by `volume`. [optional]
homeFor Double Filter the returned list by `home_for`. [optional]
volumeType String Filter the returned list by `volume__type`. [optional]
productionName String Filter the returned list by `production__name`. [optional]
productionActive String Filter the returned list by `production__active`. [optional]
name String Filter the returned list by `name`. [optional]
isExternal String Filter the returned list by `is_external`. [optional]
active String Filter the returned list by `active`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[DeletedWorkspace]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllProductions

    open class func getAllProductions( active: String? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  copyTemplateContent: Bool? = nil,  includeTotalSize: Bool? = nil) -> Promise<[Production]>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let active = "active_example" // String | Filter the returned list by `active`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let copyTemplateContent = true // Bool |  (optional)
let includeTotalSize = true // Bool |  (optional)

StorageAPI.getAllProductions(active: active, name: name, ordering: ordering, limit: limit, offset: offset, copyTemplateContent: copyTemplateContent, includeTotalSize: includeTotalSize).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
active String Filter the returned list by `active`. [optional]
name String Filter the returned list by `name`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]
copyTemplateContent Bool   [optional]
includeTotalSize Bool   [optional]

Return type

[Production]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllShares

    open class func getAllShares( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[Share]>

Required permissions * User account permission: shares:view (read) / shares:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

StorageAPI.getAllShares(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[Share]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllSnapshots

    open class func getAllSnapshots( workspace: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[Snapshot]>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let workspace = 987 // Double | Filter the returned list by `workspace`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

StorageAPI.getAllSnapshots(workspace: workspace, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
workspace Double Filter the returned list by `workspace`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[Snapshot]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllVolumes

    open class func getAllVolumes( isDefault: String? = nil,  type: String? = nil,  useForHomes: String? = nil,  useForWorkspaces: String? = nil,  displayName: String? = nil,  visualTag: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  includeStatus: Bool? = nil) -> Promise<[Volume]>

Required permissions * User account permission: None (read) / system:admin-access (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let isDefault = "isDefault_example" // String | Filter the returned list by `is_default`. (optional)
let type = "type_example" // String | Filter the returned list by `type`. (optional)
let useForHomes = "useForHomes_example" // String | Filter the returned list by `use_for_homes`. (optional)
let useForWorkspaces = "useForWorkspaces_example" // String | Filter the returned list by `use_for_workspaces`. (optional)
let displayName = "displayName_example" // String | Filter the returned list by `display_name`. (optional)
let visualTag = "visualTag_example" // String | Filter the returned list by `visual_tag`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let includeStatus = true // Bool |  (optional)

StorageAPI.getAllVolumes(isDefault: isDefault, type: type, useForHomes: useForHomes, useForWorkspaces: useForWorkspaces, displayName: displayName, visualTag: visualTag, ordering: ordering, limit: limit, offset: offset, includeStatus: includeStatus).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
isDefault String Filter the returned list by `is_default`. [optional]
type String Filter the returned list by `type`. [optional]
useForHomes String Filter the returned list by `use_for_homes`. [optional]
useForWorkspaces String Filter the returned list by `use_for_workspaces`. [optional]
displayName String Filter the returned list by `display_name`. [optional]
visualTag String Filter the returned list by `visual_tag`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]
includeStatus Bool   [optional]

Return type

[Volume]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllWorkspacePermissions

    open class func getAllWorkspacePermissions( workspace: Double? = nil,  user: Double? = nil,  group: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[WorkspacePermission]>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let workspace = 987 // Double | Filter the returned list by `workspace`. (optional)
let user = 987 // Double | Filter the returned list by `user`. (optional)
let group = 987 // Double | Filter the returned list by `group`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

StorageAPI.getAllWorkspacePermissions(workspace: workspace, user: user, group: group, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
workspace Double Filter the returned list by `workspace`. [optional]
user Double Filter the returned list by `user`. [optional]
group Double Filter the returned list by `group`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[WorkspacePermission]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllWorkspaces

    open class func getAllWorkspaces( isTemplate: String? = nil,  production: Double? = nil,  volume: Double? = nil,  homeFor: Double? = nil,  volumeType: String? = nil,  productionName: String? = nil,  productionActive: String? = nil,  name: String? = nil,  isExternal: String? = nil,  active: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  resolveAccessFor: Int? = nil,  includeEndpoints: Bool? = nil,  includeQuotas: Bool? = nil) -> Promise<[Workspace]>

Required permissions * User account permission: None (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let isTemplate = "isTemplate_example" // String | Filter the returned list by `is_template`. (optional)
let production = 987 // Double | Filter the returned list by `production`. (optional)
let volume = 987 // Double | Filter the returned list by `volume`. (optional)
let homeFor = 987 // Double | Filter the returned list by `home_for`. (optional)
let volumeType = "volumeType_example" // String | Filter the returned list by `volume__type`. (optional)
let productionName = "productionName_example" // String | Filter the returned list by `production__name`. (optional)
let productionActive = "productionActive_example" // String | Filter the returned list by `production__active`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let isExternal = "isExternal_example" // String | Filter the returned list by `is_external`. (optional)
let active = "active_example" // String | Filter the returned list by `active`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let resolveAccessFor = 987 // Int |  (optional)
let includeEndpoints = true // Bool |  (optional)
let includeQuotas = true // Bool |  (optional)

StorageAPI.getAllWorkspaces(isTemplate: isTemplate, production: production, volume: volume, homeFor: homeFor, volumeType: volumeType, productionName: productionName, productionActive: productionActive, name: name, isExternal: isExternal, active: active, ordering: ordering, limit: limit, offset: offset, resolveAccessFor: resolveAccessFor, includeEndpoints: includeEndpoints, includeQuotas: includeQuotas).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
isTemplate String Filter the returned list by `is_template`. [optional]
production Double Filter the returned list by `production`. [optional]
volume Double Filter the returned list by `volume`. [optional]
homeFor Double Filter the returned list by `home_for`. [optional]
volumeType String Filter the returned list by `volume__type`. [optional]
productionName String Filter the returned list by `production__name`. [optional]
productionActive String Filter the returned list by `production__active`. [optional]
name String Filter the returned list by `name`. [optional]
isExternal String Filter the returned list by `is_external`. [optional]
active String Filter the returned list by `active`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]
resolveAccessFor Int   [optional]
includeEndpoints Bool   [optional]
includeQuotas Bool   [optional]

Return type

[Workspace]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFile

    open class func getFile( path: String,  maxDepth: Int? = nil,  bundle: Bool? = nil) -> Promise<FilesystemFile>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let path = "path_example" // String | 
let maxDepth = 987 // Int |  (optional)
let bundle = true // Bool |  (optional)

StorageAPI.getFile(path: path, maxDepth: maxDepth, bundle: bundle).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
path String    
maxDepth Int   [optional]
bundle Bool   [optional]

Return type

FilesystemFile

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupQuota

    open class func getGroupQuota( groupId: String,  id: Int) -> Promise<Quota>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let groupId = "groupId_example" // String | 
let id = 987 // Int | A unique integer value identifying this volume.

StorageAPI.getGroupQuota(groupId: groupId, id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
groupId String    
id Int A unique integer value identifying this volume.  

Return type

Quota

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMyWorkspaces

    open class func getMyWorkspaces( isTemplate: String? = nil,  production: Double? = nil,  volume: Double? = nil,  homeFor: Double? = nil,  volumeType: String? = nil,  productionName: String? = nil,  productionActive: String? = nil,  name: String? = nil,  isExternal: String? = nil,  active: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[Workspace]>

Required permissions * User account permission: None (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let isTemplate = "isTemplate_example" // String | Filter the returned list by `is_template`. (optional)
let production = 987 // Double | Filter the returned list by `production`. (optional)
let volume = 987 // Double | Filter the returned list by `volume`. (optional)
let homeFor = 987 // Double | Filter the returned list by `home_for`. (optional)
let volumeType = "volumeType_example" // String | Filter the returned list by `volume__type`. (optional)
let productionName = "productionName_example" // String | Filter the returned list by `production__name`. (optional)
let productionActive = "productionActive_example" // String | Filter the returned list by `production__active`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let isExternal = "isExternal_example" // String | Filter the returned list by `is_external`. (optional)
let active = "active_example" // String | Filter the returned list by `active`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

StorageAPI.getMyWorkspaces(isTemplate: isTemplate, production: production, volume: volume, homeFor: homeFor, volumeType: volumeType, productionName: productionName, productionActive: productionActive, name: name, isExternal: isExternal, active: active, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
isTemplate String Filter the returned list by `is_template`. [optional]
production Double Filter the returned list by `production`. [optional]
volume Double Filter the returned list by `volume`. [optional]
homeFor Double Filter the returned list by `home_for`. [optional]
volumeType String Filter the returned list by `volume__type`. [optional]
productionName String Filter the returned list by `production__name`. [optional]
productionActive String Filter the returned list by `production__active`. [optional]
name String Filter the returned list by `name`. [optional]
isExternal String Filter the returned list by `is_external`. [optional]
active String Filter the returned list by `active`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[Workspace]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPathQuota

    open class func getPathQuota( id: Int,  relativePath: String) -> Promise<Quota>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let relativePath = "relativePath_example" // String | 

StorageAPI.getPathQuota(id: id, relativePath: relativePath).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
relativePath String    

Return type

Quota

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProduction

    open class func getProduction( id: Int,  copyTemplateContent: Bool? = nil,  includeTotalSize: Bool? = nil) -> Promise<Production>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this production.
let copyTemplateContent = true // Bool |  (optional)
let includeTotalSize = true // Bool |  (optional)

StorageAPI.getProduction(id: id, copyTemplateContent: copyTemplateContent, includeTotalSize: includeTotalSize).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this production.  
copyTemplateContent Bool   [optional]
includeTotalSize Bool   [optional]

Return type

Production

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRootDirectory

    open class func getRootDirectory( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

StorageAPI.getRootDirectory(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSambaDfreeString

    open class func getSambaDfreeString() -> Promise<Void>

Required permissions * localhost only

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


StorageAPI.getSambaDfreeString().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getShare

    open class func getShare( id: Int) -> Promise<Share>

Required permissions * User account permission: shares:view (read) / shares:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this share.

StorageAPI.getShare(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this share.  

Return type

Share

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSnapshot

    open class func getSnapshot( id: Int) -> Promise<Snapshot>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this snapshot.

StorageAPI.getSnapshot(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this snapshot.  

Return type

Snapshot

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserQuota

    open class func getUserQuota( id: Int,  userId: String) -> Promise<Quota>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let userId = "userId_example" // String | 

StorageAPI.getUserQuota(id: id, userId: userId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
userId String    

Return type

Quota

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVolume

    open class func getVolume( id: Int,  includeStatus: Bool? = nil) -> Promise<Volume>

Required permissions * User account permission: None (read) / system:admin-access (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let includeStatus = true // Bool |  (optional)

StorageAPI.getVolume(id: id, includeStatus: includeStatus).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
includeStatus Bool   [optional]

Return type

Volume

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVolumeActiveConnections

    open class func getVolumeActiveConnections( id: Int) -> Promise<StorNextConnections>

Required permissions * User account permission: system:status:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.

StorageAPI.getVolumeActiveConnections(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  

Return type

StorNextConnections

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVolumeFileSizeDistribution

    open class func getVolumeFileSizeDistribution( id: Int) -> Promise<FileSizeDistribution>

Required permissions * User account permission: system:status:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.

StorageAPI.getVolumeFileSizeDistribution(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  

Return type

FileSizeDistribution

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVolumeStats

    open class func getVolumeStats( id: Int) -> Promise<VolumeStats>

Required permissions * User account permission: system:status:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.

StorageAPI.getVolumeStats(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  

Return type

VolumeStats

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWorkspace

    open class func getWorkspace( id: Int) -> Promise<WorkspaceDetail>

Required permissions * User account permission: None (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.

StorageAPI.getWorkspace(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  

Return type

WorkspaceDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWorkspacePermission

    open class func getWorkspacePermission( id: Int) -> Promise<WorkspacePermission>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace permission.

StorageAPI.getWorkspacePermission(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace permission.  

Return type

WorkspacePermission

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

moveFiles

    open class func moveFiles( fileMoveEndpointRequest: FileMoveEndpointRequest) -> Promise<TaskInfo>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let fileMoveEndpointRequest = FileMoveEndpointRequest(input: ["input_example"], destination: "destination_example", sync: false, overwrite: "overwrite_example") // FileMoveEndpointRequest | 

StorageAPI.moveFiles(fileMoveEndpointRequest: fileMoveEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
fileMoveEndpointRequest FileMoveEndpointRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

moveWorkspace

    open class func moveWorkspace( id: Int,  moveWorkspaceRequest: MoveWorkspaceRequest) -> Promise<TaskInfo>

Required permissions * User account permission: projects:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.
let moveWorkspaceRequest = MoveWorkspaceRequest(production: 123, volume: 123, directory: "directory_example") // MoveWorkspaceRequest | 

StorageAPI.moveWorkspace(id: id, moveWorkspaceRequest: moveWorkspaceRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  
moveWorkspaceRequest MoveWorkspaceRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

moveWorkspaceToProduction

    open class func moveWorkspaceToProduction( id: Int,  workspaceMoveToRequest: WorkspaceMoveToRequest) -> Promise<Void>

Required permissions * User account permission: projects:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.
let workspaceMoveToRequest = WorkspaceMoveToRequest(production: 123) // WorkspaceMoveToRequest | 

StorageAPI.moveWorkspaceToProduction(id: id, workspaceMoveToRequest: workspaceMoveToRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  
workspaceMoveToRequest WorkspaceMoveToRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchFile

    open class func patchFile( path: String,  filePartialUpdate: FilePartialUpdate,  maxDepth: Int? = nil,  bundle: Bool? = nil) -> Promise<FilesystemFile>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let path = "path_example" // String | 
let filePartialUpdate = FilePartialUpdate(name: "name_example", files: [BasicFile(path: "path_example", name: "name_example", size: 123, modificationTime: Date(), totalSize: 123, isDir: false, files: ["TODO"])], parent: "parent_example", mode: "mode_example", uid: 123, gid: 123, user: "user_example", group: "group_example", recursive: false, affinity: "affinity_example", modeSetuid: false, modeSetgid: false, modeSetvfx: false, modeUserRead: false, modeUserWrite: false, modeUserExecute: false, modeGroupRead: false, modeGroupWrite: false, modeGroupExecute: false, modeOthersRead: false, modeOthersWrite: false, modeOthersExecute: false) // FilePartialUpdate | 
let maxDepth = 987 // Int |  (optional)
let bundle = true // Bool |  (optional)

StorageAPI.patchFile(path: path, filePartialUpdate: filePartialUpdate, maxDepth: maxDepth, bundle: bundle).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
path String    
filePartialUpdate FilePartialUpdate    
maxDepth Int   [optional]
bundle Bool   [optional]

Return type

FilesystemFile

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchProduction

    open class func patchProduction( id: Int,  productionPartialUpdate: ProductionPartialUpdate) -> Promise<Production>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this production.
let productionPartialUpdate = ProductionPartialUpdate(name: "name_example", obscureName: false, description: "description_example", longDescription: "longDescription_example", active: false, template: 123, defaultGroup: 123) // ProductionPartialUpdate | 

StorageAPI.patchProduction(id: id, productionPartialUpdate: productionPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this production.  
productionPartialUpdate ProductionPartialUpdate    

Return type

Production

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchShare

    open class func patchShare( id: Int,  sharePartialUpdate: SharePartialUpdate) -> Promise<Share>

Required permissions * User account permission: shares:view (read) / shares:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this share.
let sharePartialUpdate = SharePartialUpdate(sharingNfsPermissions: [NFSPermission(host: "host_example", readOnly: false, options: "options_example")], volume: VolumeReference(id: 123, path: "path_example", nodes: [123], displayName: "displayName_example", visualTag: "visualTag_example", isDefault: false, useForHomes: false, useForWorkspaces: false, type: "type_example", snmEnabled: false, snfsName: "snfsName_example", simulatedQuotas: false, fsProperties: FSProperties(needsSshConnection: false, supportsDirectoryQuotas: false, supportsSoftQuotas: false, supportsUserQuotas: false, supportsGroupQuotas: false, supportsXattrs: false, supportsSnapshots: false, creatingDirectoryQuotaDestroysContent: false, removingDirectoryQuotaDestroysContent: false), backend: Backend(name: "name_example", properties: BackendProperties(supportsSharingRwPermissionsPriority: false, supportsSharingAfp: false, supportsSharingSmbRequireLogon: false, supportsSharingSmbRecycleBin: false, supportsSharingSmbXattrs: false, supportsSharingSmbSymlinks: false, supportsSharingSmbCustomOptions: false, supportsSharingNfsPermissions: false)), status: VolumeStatus(online: false, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, snfs: VolumeSNFSStatus(stripeGroups: [SNFSStripeGroup(name: "name_example", statusTags: ["statusTags_example"], affinity: "affinity_example", sizeTotal: 123, sizeUsed: 123, sizeFree: 123)]), lizardfs: VolumeLizardFSStatus(master: StorageNodeMini(id: 123, name: "name_example", address: "address_example", type: 123), nodes: [LizardFSNode(node: nil, host: "host_example", online: false, version: "version_example", chunks: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, chunksForRemoval: 123, label: "label_example")], disks: [LizardFSDisk(node: nil, host: "host_example", mountpoint: "mountpoint_example", toDelete: false, damaged: false, scanning: false, errorChunk: 123, errorTimestamp: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, chunks: 123)]), beegfs: VolumeBeeGFSStatus(nodes: [BeeGFSNode(node: nil, host: "host_example", roles: ["roles_example"], addresses: ["addresses_example"])], targets: [BeeGFSTarget(node: nil, id: 123, host: "host_example", storagePool: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, online: false, consistent: false, errors: ["errors_example"])])), cloudAccount: 123, name: "name_example"), name: "name_example", path: "path_example", shareSmb: false, shareNfs: false, shareAfp: false, sharingReadOnly: false, sharingHidden: false, sharingRequireLogin: false, smbExtraConfig: "smbExtraConfig_example", afpExtraConfig: "afpExtraConfig_example", rwAccessGroup: 123, roAccessGroup: 123) // SharePartialUpdate | 

StorageAPI.patchShare(id: id, sharePartialUpdate: sharePartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this share.  
sharePartialUpdate SharePartialUpdate    

Return type

Share

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchSnapshot

    open class func patchSnapshot( id: Int,  snapshotPartialUpdate: SnapshotPartialUpdate) -> Promise<Snapshot>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this snapshot.
let snapshotPartialUpdate = SnapshotPartialUpdate(workspace: 123, name: "name_example") // SnapshotPartialUpdate | 

StorageAPI.patchSnapshot(id: id, snapshotPartialUpdate: snapshotPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this snapshot.  
snapshotPartialUpdate SnapshotPartialUpdate    

Return type

Snapshot

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchVolume

    open class func patchVolume( id: Int,  volumePartialUpdate: VolumePartialUpdate) -> Promise<Volume>

Required permissions * User account permission: None (read) / system:admin-access (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let volumePartialUpdate = VolumePartialUpdate(path: "path_example", nodes: [123], displayName: "displayName_example", visualTag: "visualTag_example", isDefault: false, useForHomes: false, useForWorkspaces: false, type: "type_example", snmEnabled: false, snfsName: "snfsName_example", simulatedQuotas: false, cloudAccount: 123) // VolumePartialUpdate | 

StorageAPI.patchVolume(id: id, volumePartialUpdate: volumePartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
volumePartialUpdate VolumePartialUpdate    

Return type

Volume

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchWorkspace

    open class func patchWorkspace( id: Int,  workspaceDetailPartialUpdate: WorkspaceDetailPartialUpdate) -> Promise<WorkspaceDetail>

Required permissions * User account permission: None (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.
let workspaceDetailPartialUpdate = WorkspaceDetailPartialUpdate(production: ProductionReference(id: 123, isSpecial: false, specialType: 123, totalSize: 123, name: "name_example", obscureName: false, description: "description_example", longDescription: "longDescription_example", active: false, template: 123, defaultGroup: 123), volume: "TODO", sharingNfsPermissions: [NFSPermission(host: "host_example", readOnly: false, options: "options_example")], quotaSizeHard: 123, quotaSizeSoft: 123, name: "name_example", description: "description_example", longDescription: "longDescription_example", isTemplate: false, active: false, macProtocol: "macProtocol_example", winProtocol: "winProtocol_example", winDrive: "winDrive_example", linuxProtocol: "linuxProtocol_example", linuxMountpoint: "linuxMountpoint_example", shareName: "shareName_example", shareNfs: false, shareAfp: false, sharingHidden: false, sharingRequireLogin: false, sharingReadOnly: false, sharingAllowExecute: false, enableQuota: false, affinity: "affinity_example", emulateAvid: false, emulateCapture: false, emulatePreopen: false, emulateNtfsStreams: false, emulateRecycleBin: false, emulateFruit: false, smbExtraConfig: "smbExtraConfig_example", afpExtraConfig: "afpExtraConfig_example", recycleBinExclude: "recycleBinExclude_example", isExternal: false, externalMacUrl: "externalMacUrl_example", externalWinUrl: "externalWinUrl_example", externalLinuxUrl: "externalLinuxUrl_example", allowSymlinks: false, rwPermissionPriority: false, template: 123) // WorkspaceDetailPartialUpdate | 

StorageAPI.patchWorkspace(id: id, workspaceDetailPartialUpdate: workspaceDetailPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  
workspaceDetailPartialUpdate WorkspaceDetailPartialUpdate    

Return type

WorkspaceDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchWorkspacePermission

    open class func patchWorkspacePermission( id: Int,  workspacePermissionPartialUpdate: WorkspacePermissionPartialUpdate) -> Promise<WorkspacePermission>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace permission.
let workspacePermissionPartialUpdate = WorkspacePermissionPartialUpdate(user: "TODO", group: "TODO", readOnly: false, workspace: 123) // WorkspacePermissionPartialUpdate | 

StorageAPI.patchWorkspacePermission(id: id, workspacePermissionPartialUpdate: workspacePermissionPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace permission.  
workspacePermissionPartialUpdate WorkspacePermissionPartialUpdate    

Return type

WorkspacePermission

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recordStorageTrace

    open class func recordStorageTrace( filesystemTraceEndpointRequest: FilesystemTraceEndpointRequest) -> Promise<FilesystemTraceEndpointResponse>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let filesystemTraceEndpointRequest = FilesystemTraceEndpointRequest(duration: 123) // FilesystemTraceEndpointRequest | 

StorageAPI.recordStorageTrace(filesystemTraceEndpointRequest: filesystemTraceEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
filesystemTraceEndpointRequest FilesystemTraceEndpointRequest    

Return type

FilesystemTraceEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repairWorkspacePermissions

    open class func repairWorkspacePermissions( id: Int) -> Promise<TaskInfo>

Required permissions * User account permission: projects:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.

StorageAPI.repairWorkspacePermissions(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shareToHomeWorkspace

    open class func shareToHomeWorkspace( shareToHomeWorkspaceEndpointRequest: ShareToHomeWorkspaceEndpointRequest) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let shareToHomeWorkspaceEndpointRequest = ShareToHomeWorkspaceEndpointRequest(paths: ["paths_example"], bundles: [123], user: 123, name: "name_example") // ShareToHomeWorkspaceEndpointRequest | 

StorageAPI.shareToHomeWorkspace(shareToHomeWorkspaceEndpointRequest: shareToHomeWorkspaceEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
shareToHomeWorkspaceEndpointRequest ShareToHomeWorkspaceEndpointRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unbookmarkWorkspace

    open class func unbookmarkWorkspace( id: Int) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.

StorageAPI.unbookmarkWorkspace(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unzipFile

    open class func unzipFile( fileUnzipEndpointRequest: FileUnzipEndpointRequest) -> Promise<TaskInfo>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let fileUnzipEndpointRequest = FileUnzipEndpointRequest(input: "input_example", remove: false) // FileUnzipEndpointRequest | 

StorageAPI.unzipFile(fileUnzipEndpointRequest: fileUnzipEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
fileUnzipEndpointRequest FileUnzipEndpointRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateGroupQuota

    open class func updateGroupQuota( groupId: String,  id: Int,  updateQuotaRequest: UpdateQuotaRequest) -> Promise<Void>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let groupId = "groupId_example" // String | 
let id = 987 // Int | A unique integer value identifying this volume.
let updateQuotaRequest = UpdateQuotaRequest(soft: 123, hard: 123) // UpdateQuotaRequest | 

StorageAPI.updateGroupQuota(groupId: groupId, id: id, updateQuotaRequest: updateQuotaRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
groupId String    
id Int A unique integer value identifying this volume.  
updateQuotaRequest UpdateQuotaRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePathQuota

    open class func updatePathQuota( id: Int,  relativePath: String,  updateQuotaRequest: UpdateQuotaRequest) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let relativePath = "relativePath_example" // String | 
let updateQuotaRequest = UpdateQuotaRequest(soft: 123, hard: 123) // UpdateQuotaRequest | 

StorageAPI.updatePathQuota(id: id, relativePath: relativePath, updateQuotaRequest: updateQuotaRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
relativePath String    
updateQuotaRequest UpdateQuotaRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateProduction

    open class func updateProduction( id: Int,  productionUpdate: ProductionUpdate) -> Promise<Production>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this production.
let productionUpdate = ProductionUpdate(name: "name_example", obscureName: false, description: "description_example", longDescription: "longDescription_example", active: false, template: 123, defaultGroup: 123) // ProductionUpdate | 

StorageAPI.updateProduction(id: id, productionUpdate: productionUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this production.  
productionUpdate ProductionUpdate    

Return type

Production

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateShare

    open class func updateShare( id: Int,  shareUpdate: ShareUpdate) -> Promise<Share>

Required permissions * User account permission: shares:view (read) / shares:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this share.
let shareUpdate = ShareUpdate(sharingNfsPermissions: [NFSPermission(host: "host_example", readOnly: false, options: "options_example")], volume: VolumeReference(id: 123, path: "path_example", nodes: [123], displayName: "displayName_example", visualTag: "visualTag_example", isDefault: false, useForHomes: false, useForWorkspaces: false, type: "type_example", snmEnabled: false, snfsName: "snfsName_example", simulatedQuotas: false, fsProperties: FSProperties(needsSshConnection: false, supportsDirectoryQuotas: false, supportsSoftQuotas: false, supportsUserQuotas: false, supportsGroupQuotas: false, supportsXattrs: false, supportsSnapshots: false, creatingDirectoryQuotaDestroysContent: false, removingDirectoryQuotaDestroysContent: false), backend: Backend(name: "name_example", properties: BackendProperties(supportsSharingRwPermissionsPriority: false, supportsSharingAfp: false, supportsSharingSmbRequireLogon: false, supportsSharingSmbRecycleBin: false, supportsSharingSmbXattrs: false, supportsSharingSmbSymlinks: false, supportsSharingSmbCustomOptions: false, supportsSharingNfsPermissions: false)), status: VolumeStatus(online: false, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, snfs: VolumeSNFSStatus(stripeGroups: [SNFSStripeGroup(name: "name_example", statusTags: ["statusTags_example"], affinity: "affinity_example", sizeTotal: 123, sizeUsed: 123, sizeFree: 123)]), lizardfs: VolumeLizardFSStatus(master: StorageNodeMini(id: 123, name: "name_example", address: "address_example", type: 123), nodes: [LizardFSNode(node: nil, host: "host_example", online: false, version: "version_example", chunks: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, chunksForRemoval: 123, label: "label_example")], disks: [LizardFSDisk(node: nil, host: "host_example", mountpoint: "mountpoint_example", toDelete: false, damaged: false, scanning: false, errorChunk: 123, errorTimestamp: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, chunks: 123)]), beegfs: VolumeBeeGFSStatus(nodes: [BeeGFSNode(node: nil, host: "host_example", roles: ["roles_example"], addresses: ["addresses_example"])], targets: [BeeGFSTarget(node: nil, id: 123, host: "host_example", storagePool: 123, sizeTotal: 123, sizeUsed: 123, sizeFree: 123, online: false, consistent: false, errors: ["errors_example"])])), cloudAccount: 123, name: "name_example"), name: "name_example", path: "path_example", shareSmb: false, shareNfs: false, shareAfp: false, sharingReadOnly: false, sharingHidden: false, sharingRequireLogin: false, smbExtraConfig: "smbExtraConfig_example", afpExtraConfig: "afpExtraConfig_example", rwAccessGroup: 123, roAccessGroup: 123) // ShareUpdate | 

StorageAPI.updateShare(id: id, shareUpdate: shareUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this share.  
shareUpdate ShareUpdate    

Return type

Share

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateSnapshot

    open class func updateSnapshot( id: Int,  snapshotUpdate: SnapshotUpdate) -> Promise<Snapshot>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this snapshot.
let snapshotUpdate = SnapshotUpdate(workspace: 123, name: "name_example") // SnapshotUpdate | 

StorageAPI.updateSnapshot(id: id, snapshotUpdate: snapshotUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this snapshot.  
snapshotUpdate SnapshotUpdate    

Return type

Snapshot

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateUserQuota

    open class func updateUserQuota( id: Int,  userId: String,  updateQuotaRequest: UpdateQuotaRequest) -> Promise<Void>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let userId = "userId_example" // String | 
let updateQuotaRequest = UpdateQuotaRequest(soft: 123, hard: 123) // UpdateQuotaRequest | 

StorageAPI.updateUserQuota(id: id, userId: userId, updateQuotaRequest: updateQuotaRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
userId String    
updateQuotaRequest UpdateQuotaRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateVolume

    open class func updateVolume( id: Int,  volumeUpdate: VolumeUpdate) -> Promise<Volume>

Required permissions * User account permission: None (read) / system:admin-access (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this volume.
let volumeUpdate = VolumeUpdate(path: "path_example", nodes: [123], displayName: "displayName_example", visualTag: "visualTag_example", isDefault: false, useForHomes: false, useForWorkspaces: false, type: "type_example", snmEnabled: false, snfsName: "snfsName_example", simulatedQuotas: false, cloudAccount: 123) // VolumeUpdate | 

StorageAPI.updateVolume(id: id, volumeUpdate: volumeUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this volume.  
volumeUpdate VolumeUpdate    

Return type

Volume

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateWorkspace

    open class func updateWorkspace( id: Int,  workspaceDetailUpdate: WorkspaceDetailUpdate) -> Promise<WorkspaceDetail>

Required permissions * User account permission: None (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace.
let workspaceDetailUpdate = WorkspaceDetailUpdate(production: ProductionReference(id: 123, isSpecial: false, specialType: 123, totalSize: 123, name: "name_example", obscureName: false, description: "description_example", longDescription: "longDescription_example", active: false, template: 123, defaultGroup: 123), volume: "TODO", sharingNfsPermissions: [NFSPermission(host: "host_example", readOnly: false, options: "options_example")], quotaSizeHard: 123, quotaSizeSoft: 123, name: "name_example", description: "description_example", longDescription: "longDescription_example", isTemplate: false, active: false, macProtocol: "macProtocol_example", winProtocol: "winProtocol_example", winDrive: "winDrive_example", linuxProtocol: "linuxProtocol_example", linuxMountpoint: "linuxMountpoint_example", shareName: "shareName_example", shareNfs: false, shareAfp: false, sharingHidden: false, sharingRequireLogin: false, sharingReadOnly: false, sharingAllowExecute: false, enableQuota: false, affinity: "affinity_example", emulateAvid: false, emulateCapture: false, emulatePreopen: false, emulateNtfsStreams: false, emulateRecycleBin: false, emulateFruit: false, smbExtraConfig: "smbExtraConfig_example", afpExtraConfig: "afpExtraConfig_example", recycleBinExclude: "recycleBinExclude_example", isExternal: false, externalMacUrl: "externalMacUrl_example", externalWinUrl: "externalWinUrl_example", externalLinuxUrl: "externalLinuxUrl_example", allowSymlinks: false, rwPermissionPriority: false, template: 123) // WorkspaceDetailUpdate | 

StorageAPI.updateWorkspace(id: id, workspaceDetailUpdate: workspaceDetailUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace.  
workspaceDetailUpdate WorkspaceDetailUpdate    

Return type

WorkspaceDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateWorkspacePermission

    open class func updateWorkspacePermission( id: Int,  workspacePermissionUpdate: WorkspacePermissionUpdate) -> Promise<WorkspacePermission>

Required permissions * User account permission: projects:view (read) / projects:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this workspace permission.
let workspacePermissionUpdate = WorkspacePermissionUpdate(user: "TODO", group: "TODO", readOnly: false, workspace: 123) // WorkspacePermissionUpdate | 

StorageAPI.updateWorkspacePermission(id: id, workspacePermissionUpdate: workspacePermissionUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this workspace permission.  
workspacePermissionUpdate WorkspacePermissionUpdate    

Return type

WorkspacePermission

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

zipFiles

    open class func zipFiles( fileZipEndpointRequest: FileZipEndpointRequest) -> Promise<TaskInfo>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let fileZipEndpointRequest = FileZipEndpointRequest(input: ["input_example"], path: "path_example", name: "name_example") // FileZipEndpointRequest | 

StorageAPI.zipFiles(fileZipEndpointRequest: fileZipEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
fileZipEndpointRequest FileZipEndpointRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]