View the Project on GitHub elements-storage/elements-sdk-swift
All URIs are relative to https://elements.local
Method | HTTP request | Description |
---|---|---|
callGet | GET /api/2/private/bootstrap | |
deleteStoredImage | DELETE /api/2/image/{name} | |
deleteVeritoneTDO | DELETE /api/2/veritone/connections/{id}/tdo/{tdo_id} | |
exportNonProxiedAssets | GET /api/2/private/export/non-proxied/{root_id} | |
exportNonProxiedAssetsForPath | GET /api/2/private/export/non-proxied/{root_id}/{path} | |
exportUpdates | GET /api/2/private/export/updates/{root_id} | |
getAllVeritoneConnections | GET /api/2/veritone/connections | |
getAllVeritoneMetadata | GET /api/2/veritone/metadata | |
getClientSideURL | POST /api/2/private/client-side-url | |
getHelpPage | GET /api/2/help/{id} | |
getLocale | GET /api/2/private/locale/{lang} | |
getProxyFSSize | GET /api/2/private/media/proxyfs-size | |
getStoredImage | GET /api/2/image/{name} | |
getVeritoneConnection | GET /api/2/veritone/connections/{id} | |
getVeritoneEngines | GET /api/2/veritone/connections/{id}/engines | |
getVeritoneJobs | GET /api/2/veritone/connections/{id}/jobs | |
getVeritoneMetadata | GET /api/2/veritone/metadata/{id} | |
installLicense | POST /api/2/license/install | |
languageServerRequest | POST /api/2/language-server/{language} | |
locateFile | POST /api/2/private/locate | |
locateProxies | POST /api/2/panel/locate-proxies | |
uploadStoredImage | POST /api/2/private/images/upload | |
uploadToVeritone | POST /api/2/veritone/connections/{id}/upload |
open class func callGet() -> Promise<BootstrapData>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
PrivateAPI.callGet().then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
This endpoint does not need any parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func deleteStoredImage( name: String) -> Promise<Void>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let name = "name_example" // String |
PrivateAPI.deleteStoredImage(name: name).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
name | String |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func deleteVeritoneTDO( id: Int, tdoId: String) -> Promise<Void>
media:access
// 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 Veritone connection.
let tdoId = "tdoId_example" // String |
PrivateAPI.deleteVeritoneTDO(id: id, tdoId: tdoId).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Veritone connection. | |
tdoId | String |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func exportNonProxiedAssets( rootId: String) -> Promise<Void>
media:access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let rootId = "rootId_example" // String |
PrivateAPI.exportNonProxiedAssets(rootId: rootId).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
rootId | String |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func exportNonProxiedAssetsForPath( path: String, rootId: String) -> Promise<Void>
media:access
// 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 rootId = "rootId_example" // String |
PrivateAPI.exportNonProxiedAssetsForPath(path: path, rootId: rootId).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
path | String | ||
rootId | String |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func exportUpdates( rootId: String) -> Promise<Void>
media:access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let rootId = "rootId_example" // String |
PrivateAPI.exportUpdates(rootId: rootId).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
rootId | String |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getAllVeritoneConnections( ordering: String? = nil, limit: Int? = nil, offset: Int? = nil) -> Promise<[VeritoneConnection]>
media:access
// 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)
PrivateAPI.getAllVeritoneConnections(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
}
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getAllVeritoneMetadata( asset: Double? = nil, isParsed: String? = nil, ordering: String? = nil, limit: Int? = nil, offset: Int? = nil) -> Promise<[VeritoneMetadata]>
media:access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let asset = 987 // Double | Filter the returned list by `asset`. (optional)
let isParsed = "isParsed_example" // String | Filter the returned list by `is_parsed`. (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)
PrivateAPI.getAllVeritoneMetadata(asset: asset, isParsed: isParsed, 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
}
Name | Type | Description | Notes |
---|---|---|---|
asset | Double | Filter the returned list by `asset`. | [optional] |
isParsed | String | Filter the returned list by `is_parsed`. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getClientSideURL( clientSidePathEndpointRequest: ClientSidePathEndpointRequest) -> Promise<ClientSidePathEndpointResponse>
client:access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let clientSidePathEndpointRequest = ClientSidePathEndpointRequest(serverSidePath: "serverSidePath_example", platform: "platform_example") // ClientSidePathEndpointRequest |
PrivateAPI.getClientSideURL(clientSidePathEndpointRequest: clientSidePathEndpointRequest).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
clientSidePathEndpointRequest | ClientSidePathEndpointRequest |
ClientSidePathEndpointResponse
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getHelpPage( id: String) -> Promise<HelpEndpointResponse>
// 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 = "id_example" // String |
PrivateAPI.getHelpPage(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
}
Name | Type | Description | Notes |
---|---|---|---|
id | String |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getLocale( lang: String) -> Promise<LocaleEndpointResponse>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let lang = "lang_example" // String |
PrivateAPI.getLocale(lang: lang).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
lang | String |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getProxyFSSize() -> Promise<ProxyFSSizeEndpointResponse>
media:access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
PrivateAPI.getProxyFSSize().then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
This endpoint does not need any parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getStoredImage( name: String) -> Promise<Void>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let name = "name_example" // String |
PrivateAPI.getStoredImage(name: name).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
name | String |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getVeritoneConnection( id: Int) -> Promise<VeritoneConnection>
media:access
// 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 Veritone connection.
PrivateAPI.getVeritoneConnection(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
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Veritone connection. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getVeritoneEngines( id: Int) -> Promise<VeritoneEngineList>
media:access
// 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 Veritone connection.
PrivateAPI.getVeritoneEngines(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
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Veritone connection. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getVeritoneJobs( id: Int, offset: Int? = nil, limit: Int? = nil) -> Promise<VeritoneJobList>
media:access
// 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 Veritone connection.
let offset = 987 // Int | (optional)
let limit = 987 // Int | (optional)
PrivateAPI.getVeritoneJobs(id: id, offset: offset, limit: limit).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Veritone connection. | |
offset | Int | [optional] | |
limit | Int | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getVeritoneMetadata( id: Int) -> Promise<VeritoneMetadata>
media:access
// 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 Veritone metadata.
PrivateAPI.getVeritoneMetadata(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
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Veritone metadata. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func installLicense( installLicenseEndpointRequest: InstallLicenseEndpointRequest) -> Promise<Void>
system:admin-access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let installLicenseEndpointRequest = InstallLicenseEndpointRequest(license: "license_example", signature: "signature_example") // InstallLicenseEndpointRequest |
PrivateAPI.installLicense(installLicenseEndpointRequest: installLicenseEndpointRequest).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
installLicenseEndpointRequest | InstallLicenseEndpointRequest |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func languageServerRequest( language: String) -> Promise<[String: AnyCodable]>
system:admin-access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let language = "language_example" // String |
PrivateAPI.languageServerRequest(language: language).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
language | String |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func locateFile( locateEndpointRequest: LocateEndpointRequest) -> Promise<LocateResult>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let locateEndpointRequest = LocateEndpointRequest(path: "path_example", asset: 123) // LocateEndpointRequest |
PrivateAPI.locateFile(locateEndpointRequest: locateEndpointRequest).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
locateEndpointRequest | LocateEndpointRequest |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func locateProxies( locateProxiesEndpointRequest: LocateProxiesEndpointRequest) -> Promise<[LocateProxiesEndpointResponse]>
media:access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let locateProxiesEndpointRequest = LocateProxiesEndpointRequest(paths: ["paths_example"]) // LocateProxiesEndpointRequest |
PrivateAPI.locateProxies(locateProxiesEndpointRequest: locateProxiesEndpointRequest).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
locateProxiesEndpointRequest | LocateProxiesEndpointRequest |
[LocateProxiesEndpointResponse]
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func uploadStoredImage( uploadImageEndpointRequest: UploadImageEndpointRequest) -> Promise<Void>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let uploadImageEndpointRequest = UploadImageEndpointRequest(name: "name_example", data: "data_example") // UploadImageEndpointRequest |
PrivateAPI.uploadStoredImage(uploadImageEndpointRequest: uploadImageEndpointRequest).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
uploadImageEndpointRequest | UploadImageEndpointRequest |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func uploadToVeritone( id: Int, veritoneUploadRequest: VeritoneUploadRequest) -> Promise<Void>
media:access
// 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 Veritone connection.
let veritoneUploadRequest = VeritoneUploadRequest(root: 123, file: 123, bundle: 123) // VeritoneUploadRequest |
PrivateAPI.uploadToVeritone(id: id, veritoneUploadRequest: veritoneUploadRequest).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Veritone connection. | |
veritoneUploadRequest | VeritoneUploadRequest |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]