Logo

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

ClickAPI

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

Method HTTP request Description
abortClickUpload DELETE /api/2/click/uploads/{upload_id}  
continueClickUploadInBackground POST /api/2/click/uploads/{upload_id}/background  
createClickGallery POST /api/2/click/connections/{connection_id}/galleries  
createClickGalleryLink POST /api/2/click/connections/{connection_id}/gallery-links  
deleteClickGalleryLink DELETE /api/2/click/connections/{connection_id}/gallery-links/{id}  
getAllClickGalleries GET /api/2/click/connections/{connection_id}/galleries  
getAllClickGalleryLinks GET /api/2/click/connections/{connection_id}/gallery-links  
getClickGallery GET /api/2/click/connections/{connection_id}/galleries/{id}  
getClickGalleryLink GET /api/2/click/connections/{connection_id}/gallery-links/{id}  
patchClickGallery PATCH /api/2/click/connections/{connection_id}/galleries/{id}  
sendClickGalleryLinkEmail POST /api/2/click/connections/{connection_id}/gallery-links/{link_id}/send  
startClickUpload POST /api/2/click/uploads  
updateClickGallery PUT /api/2/click/connections/{connection_id}/galleries/{id}  

abortClickUpload

    open class func abortClickUpload( uploadId: String) -> Promise<Void>

Required permissions * User account permission: cloud: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 uploadId = "uploadId_example" // String | 

ClickAPI.abortClickUpload(uploadId: uploadId).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
uploadId 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]

continueClickUploadInBackground

    open class func continueClickUploadInBackground( uploadId: String,  clickBackgroundUploadEndpointRequest: ClickBackgroundUploadEndpointRequest) -> Promise<Void>

Required permissions * User account permission: cloud: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 uploadId = "uploadId_example" // String | 
let clickBackgroundUploadEndpointRequest = ClickBackgroundUploadEndpointRequest(gallery: 123, linksToSend: [123], notifyOnCompletion: false) // ClickBackgroundUploadEndpointRequest | 

ClickAPI.continueClickUploadInBackground(uploadId: uploadId, clickBackgroundUploadEndpointRequest: clickBackgroundUploadEndpointRequest).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
uploadId String    
clickBackgroundUploadEndpointRequest ClickBackgroundUploadEndpointRequest    

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]

createClickGallery

    open class func createClickGallery( connectionId: String,  clickGallery: ClickGallery) -> Promise<ClickGallery>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
let clickGallery = ClickGallery(id: 123, name: "name_example", description: "description_example", presignedLoginUrl: "presignedLoginUrl_example") // ClickGallery | 

ClickAPI.createClickGallery(connectionId: connectionId, clickGallery: clickGallery).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
connectionId String    
clickGallery ClickGallery    

Return type

ClickGallery

Authorization

Bearer

HTTP request headers

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

createClickGalleryLink

    open class func createClickGalleryLink( connectionId: String,  clickGalleryLink: ClickGalleryLink) -> Promise<ClickGalleryLink>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
let clickGalleryLink = ClickGalleryLink(id: 123, email: "email_example", expiresAt: Date(), galleryId: 123, notifyOnUse: false, viewsLeft: 123, elementsUser: ClickLinkUser(id: "id_example", username: "username_example", email: "email_example", displayName: "displayName_example"), secretKey: "secretKey_example") // ClickGalleryLink | 

ClickAPI.createClickGalleryLink(connectionId: connectionId, clickGalleryLink: clickGalleryLink).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
connectionId String    
clickGalleryLink ClickGalleryLink    

Return type

ClickGalleryLink

Authorization

Bearer

HTTP request headers

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

deleteClickGalleryLink

    open class func deleteClickGalleryLink( connectionId: String,  id: String) -> Promise<Void>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
let id = "id_example" // String | 

ClickAPI.deleteClickGalleryLink(connectionId: connectionId, 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
connectionId String    
id 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]

getAllClickGalleries

    open class func getAllClickGalleries( connectionId: String,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<InlineResponse200>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
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)

ClickAPI.getAllClickGalleries(connectionId: connectionId, 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
connectionId String    
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

InlineResponse200

Authorization

Bearer

HTTP request headers

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

getAllClickGalleryLinks

    open class func getAllClickGalleryLinks( connectionId: String,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<InlineResponse2001>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
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)

ClickAPI.getAllClickGalleryLinks(connectionId: connectionId, 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
connectionId String    
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

InlineResponse2001

Authorization

Bearer

HTTP request headers

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

getClickGallery

    open class func getClickGallery( connectionId: String,  id: String) -> Promise<ClickGallery>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
let id = "id_example" // String | 

ClickAPI.getClickGallery(connectionId: connectionId, 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
connectionId String    
id String    

Return type

ClickGallery

Authorization

Bearer

HTTP request headers

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

getClickGalleryLink

    open class func getClickGalleryLink( connectionId: String,  id: String) -> Promise<ClickGalleryLink>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
let id = "id_example" // String | 

ClickAPI.getClickGalleryLink(connectionId: connectionId, 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
connectionId String    
id String    

Return type

ClickGalleryLink

Authorization

Bearer

HTTP request headers

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

patchClickGallery

    open class func patchClickGallery( connectionId: String,  id: String,  clickGallery: ClickGallery) -> Promise<ClickGallery>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
let id = "id_example" // String | 
let clickGallery = ClickGallery(id: 123, name: "name_example", description: "description_example", presignedLoginUrl: "presignedLoginUrl_example") // ClickGallery | 

ClickAPI.patchClickGallery(connectionId: connectionId, id: id, clickGallery: clickGallery).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
connectionId String    
id String    
clickGallery ClickGallery    

Return type

ClickGallery

Authorization

Bearer

HTTP request headers

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

sendClickGalleryLinkEmail

    open class func sendClickGalleryLinkEmail( connectionId: String,  linkId: String) -> Promise<Void>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
let linkId = "linkId_example" // String | 

ClickAPI.sendClickGalleryLinkEmail(connectionId: connectionId, linkId: linkId).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
connectionId String    
linkId 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]

startClickUpload

    open class func startClickUpload( clickStartUploadEndpointRequest: ClickStartUploadEndpointRequest) -> Promise<TaskInfo>

Required permissions * User account permission: cloud: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 clickStartUploadEndpointRequest = ClickStartUploadEndpointRequest(connection: 123, assets: [123]) // ClickStartUploadEndpointRequest | 

ClickAPI.startClickUpload(clickStartUploadEndpointRequest: clickStartUploadEndpointRequest).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
clickStartUploadEndpointRequest ClickStartUploadEndpointRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

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

updateClickGallery

    open class func updateClickGallery( connectionId: String,  id: String,  addAssetsToClickGallery: AddAssetsToClickGallery) -> Promise<AddAssetsToClickGallery>

Required permissions * User account permission: cloud: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 connectionId = "connectionId_example" // String | 
let id = "id_example" // String | 
let addAssetsToClickGallery = AddAssetsToClickGallery(assets: ["assets_example"]) // AddAssetsToClickGallery | 

ClickAPI.updateClickGallery(connectionId: connectionId, id: id, addAssetsToClickGallery: addAssetsToClickGallery).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
connectionId String    
id String    
addAssetsToClickGallery AddAssetsToClickGallery    

Return type

AddAssetsToClickGallery

Authorization

Bearer

HTTP request headers

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