\AISlackBotsAPI

All URIs are relative to https://dashboard.quantcdn.io

Method	HTTP request	Description
CreateSlackBot	Post /api/v3/organizations/{organisation}/ai/slack-bots	Create Slack Bot
DeleteSlackBot	Delete /api/v3/organizations/{organisation}/ai/slack-bots/{botId}	Delete Slack Bot
GetSlackBot	Get /api/v3/organizations/{organisation}/ai/slack-bots/{botId}	Get Slack Bot
ListSlackBots	Get /api/v3/organizations/{organisation}/ai/slack-bots	List Slack Bots
SearchSlackWorkspaceChannels	Get /api/v3/organizations/{organisation}/ai/slack-bots/{botId}/workspace/channels	Search Slack Workspace Channels
SearchSlackWorkspaceUsers	Get /api/v3/organizations/{organisation}/ai/slack-bots/{botId}/workspace/users	Search Slack Workspace Users
UpdateSlackBot	Put /api/v3/organizations/{organisation}/ai/slack-bots/{botId}	Update Slack Bot

CreateSlackBot

CreateSlackBot201Response CreateSlackBot(ctx, organisation).CreateSlackBotRequest(createSlackBotRequest).Execute()

Create Slack Bot

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	createSlackBotRequest := *openapiclient.NewCreateSlackBotRequest("Name_example", "SetupType_example", "SystemPrompt_example", "ModelId_example") // CreateSlackBotRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISlackBotsAPI.CreateSlackBot(context.Background(), organisation).CreateSlackBotRequest(createSlackBotRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISlackBotsAPI.CreateSlackBot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateSlackBot`: CreateSlackBot201Response
	fmt.Fprintf(os.Stdout, "Response from `AISlackBotsAPI.CreateSlackBot`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateSlackBotRequest struct via the builder pattern

Name	Type	Description	Notes

createSlackBotRequest | CreateSlackBotRequest | |

Return type

CreateSlackBot201Response

Authorization

BearerAuth

HTTP request headers

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

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

DeleteSlackBot

DeleteSlackBot200Response DeleteSlackBot(ctx, organisation, botId).Execute()

Delete Slack Bot

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	botId := "botId_example" // string | The Slack bot ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISlackBotsAPI.DeleteSlackBot(context.Background(), organisation, botId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISlackBotsAPI.DeleteSlackBot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteSlackBot`: DeleteSlackBot200Response
	fmt.Fprintf(os.Stdout, "Response from `AISlackBotsAPI.DeleteSlackBot`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
botId	string	The Slack bot ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteSlackBotRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

DeleteSlackBot200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetSlackBot

GetSlackBot200Response GetSlackBot(ctx, organisation, botId).Execute()

Get Slack Bot

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	botId := "botId_example" // string | The Slack bot ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISlackBotsAPI.GetSlackBot(context.Background(), organisation, botId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISlackBotsAPI.GetSlackBot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSlackBot`: GetSlackBot200Response
	fmt.Fprintf(os.Stdout, "Response from `AISlackBotsAPI.GetSlackBot`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
botId	string	The Slack bot ID

Other Parameters

Other parameters are passed through a pointer to a apiGetSlackBotRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

GetSlackBot200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListSlackBots

ListSlackBots200Response ListSlackBots(ctx, organisation).Execute()

List Slack Bots

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISlackBotsAPI.ListSlackBots(context.Background(), organisation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISlackBotsAPI.ListSlackBots``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListSlackBots`: ListSlackBots200Response
	fmt.Fprintf(os.Stdout, "Response from `AISlackBotsAPI.ListSlackBots`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID

Other Parameters

Other parameters are passed through a pointer to a apiListSlackBotsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ListSlackBots200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

SearchSlackWorkspaceChannels

SearchSlackWorkspaceChannels200Response SearchSlackWorkspaceChannels(ctx, organisation, botId).Q(q).Execute()

Search Slack Workspace Channels

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	botId := "botId_example" // string | The Slack bot ID
	q := "q_example" // string | Search query to filter channels by name (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISlackBotsAPI.SearchSlackWorkspaceChannels(context.Background(), organisation, botId).Q(q).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISlackBotsAPI.SearchSlackWorkspaceChannels``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SearchSlackWorkspaceChannels`: SearchSlackWorkspaceChannels200Response
	fmt.Fprintf(os.Stdout, "Response from `AISlackBotsAPI.SearchSlackWorkspaceChannels`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
botId	string	The Slack bot ID

Other Parameters

Other parameters are passed through a pointer to a apiSearchSlackWorkspaceChannelsRequest struct via the builder pattern

Name	Type	Description	Notes

q | string | Search query to filter channels by name |

Return type

SearchSlackWorkspaceChannels200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

SearchSlackWorkspaceUsers

SearchSlackWorkspaceUsers200Response SearchSlackWorkspaceUsers(ctx, organisation, botId).Q(q).Execute()

Search Slack Workspace Users

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	botId := "botId_example" // string | The Slack bot ID
	q := "q_example" // string | Search query to filter users by name (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISlackBotsAPI.SearchSlackWorkspaceUsers(context.Background(), organisation, botId).Q(q).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISlackBotsAPI.SearchSlackWorkspaceUsers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SearchSlackWorkspaceUsers`: SearchSlackWorkspaceUsers200Response
	fmt.Fprintf(os.Stdout, "Response from `AISlackBotsAPI.SearchSlackWorkspaceUsers`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
botId	string	The Slack bot ID

Other Parameters

Other parameters are passed through a pointer to a apiSearchSlackWorkspaceUsersRequest struct via the builder pattern

Name	Type	Description	Notes

q | string | Search query to filter users by name |

Return type

SearchSlackWorkspaceUsers200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UpdateSlackBot

CreateSlackBot201Response UpdateSlackBot(ctx, organisation, botId).UpdateSlackBotRequest(updateSlackBotRequest).Execute()

Update Slack Bot

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	botId := "botId_example" // string | The Slack bot ID
	updateSlackBotRequest := *openapiclient.NewUpdateSlackBotRequest() // UpdateSlackBotRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISlackBotsAPI.UpdateSlackBot(context.Background(), organisation, botId).UpdateSlackBotRequest(updateSlackBotRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISlackBotsAPI.UpdateSlackBot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateSlackBot`: CreateSlackBot201Response
	fmt.Fprintf(os.Stdout, "Response from `AISlackBotsAPI.UpdateSlackBot`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
botId	string	The Slack bot ID

Other Parameters

Other parameters are passed through a pointer to a apiUpdateSlackBotRequest struct via the builder pattern

Name	Type	Description	Notes

updateSlackBotRequest | UpdateSlackBotRequest | |

Return type

CreateSlackBot201Response

Authorization

BearerAuth

HTTP request headers

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

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

FilesExpand file tree

AISlackBotsAPI.md

Latest commit

History

AISlackBotsAPI.md

File metadata and controls

\AISlackBotsAPI

CreateSlackBot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteSlackBot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetSlackBot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListSlackBots

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchSlackWorkspaceChannels

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchSlackWorkspaceUsers

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateSlackBot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers