Skip to content
This repository has been archived by the owner on Jul 24, 2023. It is now read-only.

Latest commit

 

History

History
1027 lines (687 loc) · 32.9 KB

IntegrationsAPI.md

File metadata and controls

1027 lines (687 loc) · 32.9 KB
Raw

IntegrationsAPI

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

Method HTTP request Description
deleteSlackConnection DELETE /api/2/integrations/slack/{id}
deleteTeamsConnection DELETE /api/2/integrations/teams/{id}
getAllSlackConnections GET /api/2/integrations/slack
getAllTeamsConnections GET /api/2/integrations/teams
getSlackChannels GET /api/2/integrations/slack/{id}/channels
getSlackConnection GET /api/2/integrations/slack/{id}
getSlackEmoji GET /api/2/integrations/slack/{id}/emoji
getSlackUsers GET /api/2/integrations/slack/{id}/users
getTeamsChannels GET /api/2/integrations/teams/{id}/channels
getTeamsConnection GET /api/2/integrations/teams/{id}
getTeamsUsers GET /api/2/integrations/teams/{id}/users
patchSlackConnection PATCH /api/2/integrations/slack/{id}
patchTeamsConnection PATCH /api/2/integrations/teams/{id}
sendSlackMessage POST /api/2/integrations/slack/{id}/message
sendTeamsMessage POST /api/2/integrations/teams/{id}/send-message
startSlackConnectionFlow GET /api/2/integrations/slack/connect
startSlackConnectionTokenRefreshFlow GET /api/2/integrations/slack/{id}/refresh-token
startTeamsConnectionFlow GET /api/2/integrations/teams/connect
startTeamsConnectionTokenRefreshFlow GET /api/2/integrations/teams/{id}/refresh-token
updateSlackConnection PUT /api/2/integrations/slack/{id}
updateTeamsConnection PUT /api/2/integrations/teams/{id}

deleteSlackConnection

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

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 Slack connection.

IntegrationsAPI.deleteSlackConnection(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 Slack connection.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

deleteTeamsConnection

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

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 Teams connection.

IntegrationsAPI.deleteTeamsConnection(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 Teams connection.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getAllSlackConnections

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

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 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)

IntegrationsAPI.getAllSlackConnections(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

[SlackConnection]

Authorization

Bearer

HTTP request headers

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

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

getAllTeamsConnections

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

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 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)

IntegrationsAPI.getAllTeamsConnections(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

[TeamsConnection]

Authorization

Bearer

HTTP request headers

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

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

getSlackChannels

    open class func getSlackChannels( id: Int) -> Promise<[SlackChannel]>

Required permissions * User account permission: tasks: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 Slack connection.

IntegrationsAPI.getSlackChannels(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 Slack connection.

Return type

[SlackChannel]

Authorization

Bearer

HTTP request headers

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

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

getSlackConnection

    open class func getSlackConnection( id: Int) -> Promise<SlackConnection>

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 Slack connection.

IntegrationsAPI.getSlackConnection(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 Slack connection.

Return type

SlackConnection

Authorization

Bearer

HTTP request headers

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

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

getSlackEmoji

    open class func getSlackEmoji( id: Int) -> Promise<[SlackEmoji]>

Required permissions * User account permission: tasks: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 Slack connection.

IntegrationsAPI.getSlackEmoji(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 Slack connection.

Return type

[SlackEmoji]

Authorization

Bearer

HTTP request headers

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

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

getSlackUsers

    open class func getSlackUsers( id: Int) -> Promise<[SlackUser]>

Required permissions * User account permission: tasks: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 Slack connection.

IntegrationsAPI.getSlackUsers(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 Slack connection.

Return type

[SlackUser]

Authorization

Bearer

HTTP request headers

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

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

getTeamsChannels

    open class func getTeamsChannels( id: Int) -> Promise<[TeamsRecipient]>

Required permissions * User account permission: tasks: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 Teams connection.

IntegrationsAPI.getTeamsChannels(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 Teams connection.

Return type

[TeamsRecipient]

Authorization

Bearer

HTTP request headers

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

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

getTeamsConnection

    open class func getTeamsConnection( id: Int) -> Promise<TeamsConnection>

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 Teams connection.

IntegrationsAPI.getTeamsConnection(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 Teams connection.

Return type

TeamsConnection

Authorization

Bearer

HTTP request headers

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

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

getTeamsUsers

    open class func getTeamsUsers( id: Int) -> Promise<[TeamsRecipient]>

Required permissions * User account permission: tasks: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 Teams connection.

IntegrationsAPI.getTeamsUsers(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 Teams connection.

Return type

[TeamsRecipient]

Authorization

Bearer

HTTP request headers

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

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

patchSlackConnection

    open class func patchSlackConnection( id: Int,  slackConnectionPartialUpdate: SlackConnectionPartialUpdate) -> Promise<SlackConnection>

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 Slack connection.
let slackConnectionPartialUpdate = SlackConnectionPartialUpdate(name: "name_example") // SlackConnectionPartialUpdate | 

IntegrationsAPI.patchSlackConnection(id: id, slackConnectionPartialUpdate: slackConnectionPartialUpdate).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 Slack connection.
slackConnectionPartialUpdate SlackConnectionPartialUpdate

Return type

SlackConnection

Authorization

Bearer

HTTP request headers

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

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

patchTeamsConnection

    open class func patchTeamsConnection( id: Int,  teamsConnectionPartialUpdate: TeamsConnectionPartialUpdate) -> Promise<TeamsConnection>

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 Teams connection.
let teamsConnectionPartialUpdate = TeamsConnectionPartialUpdate(name: "name_example") // TeamsConnectionPartialUpdate | 

IntegrationsAPI.patchTeamsConnection(id: id, teamsConnectionPartialUpdate: teamsConnectionPartialUpdate).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 Teams connection.
teamsConnectionPartialUpdate TeamsConnectionPartialUpdate

Return type

TeamsConnection

Authorization

Bearer

HTTP request headers

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

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

sendSlackMessage

    open class func sendSlackMessage( id: Int,  slackMessage: SlackMessage) -> Promise<Void>

Required permissions * User account permission: tasks: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 Slack connection.
let slackMessage = SlackMessage(recipient: "recipient_example", text: "text_example", username: "username_example", emoji: "emoji_example") // SlackMessage | 

IntegrationsAPI.sendSlackMessage(id: id, slackMessage: slackMessage).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 Slack connection.
slackMessage SlackMessage

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

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

sendTeamsMessage

    open class func sendTeamsMessage( id: Int,  teamsMessage: TeamsMessage) -> Promise<Void>

Required permissions * User account permission: tasks: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 Teams connection.
let teamsMessage = TeamsMessage(recipient: "recipient_example", text: "text_example") // TeamsMessage | 

IntegrationsAPI.sendTeamsMessage(id: id, teamsMessage: teamsMessage).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 Teams connection.
teamsMessage TeamsMessage

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

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

startSlackConnectionFlow

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

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 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)

IntegrationsAPI.startSlackConnectionFlow(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

  • Content-Type: Not defined
  • Accept: Not defined

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

startSlackConnectionTokenRefreshFlow

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

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 id = 987 // Int | A unique integer value identifying this Slack connection.

IntegrationsAPI.startSlackConnectionTokenRefreshFlow(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 Slack connection.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

startTeamsConnectionFlow

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

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 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 team = "team_example" // String |  (optional)

IntegrationsAPI.startTeamsConnectionFlow(ordering: ordering, limit: limit, offset: offset, team: team).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]
team String [optional]

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

startTeamsConnectionTokenRefreshFlow

    open class func startTeamsConnectionTokenRefreshFlow( id: Int,  team: String? = nil) -> Promise<Void>

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 id = 987 // Int | A unique integer value identifying this Teams connection.
let team = "team_example" // String |  (optional)

IntegrationsAPI.startTeamsConnectionTokenRefreshFlow(id: id, team: team).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 Teams connection.
team String [optional]

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

updateSlackConnection

    open class func updateSlackConnection( id: Int,  slackConnectionUpdate: SlackConnectionUpdate) -> Promise<SlackConnection>

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 Slack connection.
let slackConnectionUpdate = SlackConnectionUpdate(name: "name_example") // SlackConnectionUpdate | 

IntegrationsAPI.updateSlackConnection(id: id, slackConnectionUpdate: slackConnectionUpdate).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 Slack connection.
slackConnectionUpdate SlackConnectionUpdate

Return type

SlackConnection

Authorization

Bearer

HTTP request headers

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

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

updateTeamsConnection

    open class func updateTeamsConnection( id: Int,  teamsConnectionUpdate: TeamsConnectionUpdate) -> Promise<TeamsConnection>

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 Teams connection.
let teamsConnectionUpdate = TeamsConnectionUpdate(name: "name_example") // TeamsConnectionUpdate | 

IntegrationsAPI.updateTeamsConnection(id: id, teamsConnectionUpdate: teamsConnectionUpdate).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 Teams connection.
teamsConnectionUpdate TeamsConnectionUpdate

Return type

TeamsConnection

Authorization

Bearer

HTTP request headers

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

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