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

Latest commit

 

History

History
1628 lines (1225 loc) · 50.5 KB

IntegrationsApi.md

File metadata and controls

1628 lines (1225 loc) · 50.5 KB

ElementsSDK.Api.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

void DeleteSlackConnection (int id)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteSlackConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.

            try
            {
                apiInstance.DeleteSlackConnection(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.DeleteSlackConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 No body -

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

DeleteTeamsConnection

void DeleteTeamsConnection (int id)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteTeamsConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Teams connection.

            try
            {
                apiInstance.DeleteTeamsConnection(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.DeleteTeamsConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 No body -

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

GetAllSlackConnections

List<SlackConnection> GetAllSlackConnections (string ordering = null, int? limit = null, int? offset = null)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllSlackConnectionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<SlackConnection> result = apiInstance.GetAllSlackConnections(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetAllSlackConnections: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

List<SlackConnection>

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

GetAllTeamsConnections

List<TeamsConnection> GetAllTeamsConnections (string ordering = null, int? limit = null, int? offset = null)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllTeamsConnectionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<TeamsConnection> result = apiInstance.GetAllTeamsConnections(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetAllTeamsConnections: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

List<TeamsConnection>

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

GetSlackChannels

List<SlackChannel> GetSlackChannels (int id)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetSlackChannelsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.

            try
            {
                List<SlackChannel> result = apiInstance.GetSlackChannels(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetSlackChannels: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Slack connection.

Return type

List<SlackChannel>

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

GetSlackConnection

SlackConnection GetSlackConnection (int id)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetSlackConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.

            try
            {
                SlackConnection result = apiInstance.GetSlackConnection(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetSlackConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 -

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

GetSlackEmoji

List<SlackEmoji> GetSlackEmoji (int id)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetSlackEmojiExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.

            try
            {
                List<SlackEmoji> result = apiInstance.GetSlackEmoji(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetSlackEmoji: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Slack connection.

Return type

List<SlackEmoji>

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

GetSlackUsers

List<SlackUser> GetSlackUsers (int id)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetSlackUsersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.

            try
            {
                List<SlackUser> result = apiInstance.GetSlackUsers(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetSlackUsers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Slack connection.

Return type

List<SlackUser>

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

GetTeamsChannels

List<TeamsRecipient> GetTeamsChannels (int id)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetTeamsChannelsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Teams connection.

            try
            {
                List<TeamsRecipient> result = apiInstance.GetTeamsChannels(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetTeamsChannels: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Teams connection.

Return type

List<TeamsRecipient>

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

GetTeamsConnection

TeamsConnection GetTeamsConnection (int id)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetTeamsConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Teams connection.

            try
            {
                TeamsConnection result = apiInstance.GetTeamsConnection(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetTeamsConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 -

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

GetTeamsUsers

List<TeamsRecipient> GetTeamsUsers (int id)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetTeamsUsersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Teams connection.

            try
            {
                List<TeamsRecipient> result = apiInstance.GetTeamsUsers(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.GetTeamsUsers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Teams connection.

Return type

List<TeamsRecipient>

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

PatchSlackConnection

SlackConnection PatchSlackConnection (int id, SlackConnectionPartialUpdate slackConnectionPartialUpdate)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchSlackConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.
            var slackConnectionPartialUpdate = new SlackConnectionPartialUpdate(); // SlackConnectionPartialUpdate | 

            try
            {
                SlackConnection result = apiInstance.PatchSlackConnection(id, slackConnectionPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.PatchSlackConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 -

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

PatchTeamsConnection

TeamsConnection PatchTeamsConnection (int id, TeamsConnectionPartialUpdate teamsConnectionPartialUpdate)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchTeamsConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Teams connection.
            var teamsConnectionPartialUpdate = new TeamsConnectionPartialUpdate(); // TeamsConnectionPartialUpdate | 

            try
            {
                TeamsConnection result = apiInstance.PatchTeamsConnection(id, teamsConnectionPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.PatchTeamsConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 -

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

SendSlackMessage

void SendSlackMessage (int id, SlackMessage slackMessage)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SendSlackMessageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.
            var slackMessage = new SlackMessage(); // SlackMessage | 

            try
            {
                apiInstance.SendSlackMessage(id, slackMessage);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.SendSlackMessage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 No body -

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

SendTeamsMessage

void SendTeamsMessage (int id, TeamsMessage teamsMessage)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SendTeamsMessageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Teams connection.
            var teamsMessage = new TeamsMessage(); // TeamsMessage | 

            try
            {
                apiInstance.SendTeamsMessage(id, teamsMessage);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.SendTeamsMessage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 No body -

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

StartSlackConnectionFlow

void StartSlackConnectionFlow (string ordering = null, int? limit = null, int? offset = null)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartSlackConnectionFlowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                apiInstance.StartSlackConnectionFlow(ordering, limit, offset);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.StartSlackConnectionFlow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 No body -

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

StartSlackConnectionTokenRefreshFlow

void StartSlackConnectionTokenRefreshFlow (int id)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartSlackConnectionTokenRefreshFlowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.

            try
            {
                apiInstance.StartSlackConnectionTokenRefreshFlow(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.StartSlackConnectionTokenRefreshFlow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
200 No body -

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

StartTeamsConnectionFlow

void StartTeamsConnectionFlow (string ordering = null, int? limit = null, int? offset = null, string team = null)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartTeamsConnectionFlowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var team = team_example;  // string |  (optional) 

            try
            {
                apiInstance.StartTeamsConnectionFlow(ordering, limit, offset, team);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.StartTeamsConnectionFlow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
301 Redirects to setup page -

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

StartTeamsConnectionTokenRefreshFlow

void StartTeamsConnectionTokenRefreshFlow (int id, string team = null)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartTeamsConnectionTokenRefreshFlowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Teams connection.
            var team = team_example;  // string |  (optional) 

            try
            {
                apiInstance.StartTeamsConnectionTokenRefreshFlow(id, team);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.StartTeamsConnectionTokenRefreshFlow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

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

HTTP response details

Status code Description Response headers
301 Redirects to setup page -

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

UpdateSlackConnection

SlackConnection UpdateSlackConnection (int id, SlackConnection slackConnection)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateSlackConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Slack connection.
            var slackConnection = new SlackConnection(); // SlackConnection | 

            try
            {
                SlackConnection result = apiInstance.UpdateSlackConnection(id, slackConnection);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.UpdateSlackConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Slack connection.
slackConnection SlackConnection

Return type

SlackConnection

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

UpdateTeamsConnection

TeamsConnection UpdateTeamsConnection (int id, TeamsConnection teamsConnection)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateTeamsConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new IntegrationsApi(config);
            var id = 56;  // int | A unique integer value identifying this Teams connection.
            var teamsConnection = new TeamsConnection(); // TeamsConnection | 

            try
            {
                TeamsConnection result = apiInstance.UpdateTeamsConnection(id, teamsConnection);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IntegrationsApi.UpdateTeamsConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Teams connection.
teamsConnection TeamsConnection

Return type

TeamsConnection

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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