Skip to content

Latest commit

 

History

History
226 lines (154 loc) · 8.01 KB

UploadTokensAPI.md

File metadata and controls

226 lines (154 loc) · 8.01 KB

UploadTokensAPI

All URIs are relative to https://ws.api.video

Method HTTP request Description
createToken POST /upload-tokens Generate an upload token
getToken GET /upload-tokens/{uploadToken} Retrieve upload token
deleteToken DELETE /upload-tokens/{uploadToken} Delete an upload token
list GET /upload-tokens List all active upload tokens

createToken

    open class func createToken(tokenCreationPayload: TokenCreationPayload, completion: @escaping (_ data: UploadToken?, _ error: Error?) -> Void)
    open class func createToken(tokenCreationPayload: TokenCreationPayload, completion: @escaping (_ result: Swift.Result<Response<UploadToken>, ErrorResponse>) -> Void)

Generate an upload token

Generates an upload token that can be used to replace the API Key. More information can be found here

Example

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

let tokenCreationPayload = TokenCreationPayload(ttl: 123) // TokenCreationPayload | 

// Generate an upload token
UploadTokensAPI.createToken(tokenCreationPayload: tokenCreationPayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
tokenCreationPayload TokenCreationPayload

Return type

UploadToken

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

getToken

    open class func getToken(uploadToken: String, completion: @escaping (_ data: UploadToken?, _ error: Error?) -> Void)
    open class func getToken(uploadToken: String, completion: @escaping (_ result: Swift.Result<Response<UploadToken>, ErrorResponse>) -> Void)

Retrieve upload token

Retrieve details about a specific upload token by id.

Example

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

let uploadToken = "uploadToken_example" // String | The unique identifier for the token you want information about.

// Retrieve upload token
UploadTokensAPI.getToken(uploadToken: uploadToken) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uploadToken String The unique identifier for the token you want information about.

Return type

UploadToken

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

deleteToken

    open class func deleteToken(uploadToken: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)
    open class func deleteToken(uploadToken: String, completion: @escaping (_ result: Swift.Result<Response<Void>, ErrorResponse>) -> Void)

Delete an upload token

Delete an existing upload token. This is especially useful for tokens you may have created that do not expire.

Example

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

let uploadToken = "uploadToken_example" // String | The unique identifier for the upload token you want to delete. Deleting a token will make it so the token can no longer be used for authentication.

// Delete an upload token
UploadTokensAPI.deleteToken(uploadToken: uploadToken) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uploadToken String The unique identifier for the upload token you want to delete. Deleting a token will make it so the token can no longer be used for authentication.

Return type

Void (empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

list

    open class func list(sortBy: SortBy_list? = nil, sortOrder: SortOrder_list? = nil, currentPage: Int? = nil, pageSize: Int? = nil, completion: @escaping (_ data: TokenListResponse?, _ error: Error?) -> Void)
    open class func list(sortBy: SortBy_list? = nil, sortOrder: SortOrder_list? = nil, currentPage: Int? = nil, pageSize: Int? = nil, completion: @escaping (_ result: Swift.Result<Response<TokenListResponse>, ErrorResponse>) -> Void)

List all active upload tokens

Retrieve a list of all currently active delegated tokens.

Example

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

let sortBy = "sortBy_example" // String | Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ATOM UTC format. (optional)
let sortOrder = "sortOrder_example" // String | Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. (optional)
let currentPage = 987 // Int | Choose the number of search results to return per page. Minimum value: 1 (optional) (default to 1)
let pageSize = 987 // Int | Results per page. Allowed values 1-100, default is 25. (optional) (default to 25)

// List all active upload tokens
UploadTokensAPI.list(sortBy: sortBy, sortOrder: sortOrder, currentPage: currentPage, pageSize: pageSize) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
sortBy String Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ATOM UTC format. [optional]
sortOrder String Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. [optional]
currentPage Int Choose the number of search results to return per page. Minimum value: 1 [optional] [default to 1]
pageSize Int Results per page. Allowed values 1-100, default is 25. [optional] [default to 25]

Return type

TokenListResponse

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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