|
| 1 | +# Go API client for openapi |
| 2 | + |
| 3 | +This is the public Twilio REST API. |
| 4 | + |
| 5 | +## Overview |
| 6 | +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specs located at [twilio/twilio-oai](https://github.com/twilio/twilio-oai/tree/main/spec). By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. |
| 7 | + |
| 8 | +- API version: 1.0.0 |
| 9 | +- Package version: 1.0.0 |
| 10 | +- Build package: com.twilio.oai.TwilioGoGenerator |
| 11 | +For more information, please visit [https://support.twilio.com](https://support.twilio.com) |
| 12 | + |
| 13 | +## Installation |
| 14 | + |
| 15 | +Install the following dependencies: |
| 16 | + |
| 17 | +```shell |
| 18 | +go get github.com/stretchr/testify/assert |
| 19 | +go get golang.org/x/net/context |
| 20 | +``` |
| 21 | + |
| 22 | +Put the package under your project folder and add the following in import: |
| 23 | + |
| 24 | +```golang |
| 25 | +import "./openapi" |
| 26 | +``` |
| 27 | + |
| 28 | +## Documentation for API Endpoints |
| 29 | + |
| 30 | +All URIs are relative to *https://assistants.twilio.com* |
| 31 | + |
| 32 | +Class | Method | HTTP request | Description |
| 33 | +------------ | ------------- | ------------- | ------------- |
| 34 | +*AssistantsApi* | [**CreateAssistant**](docs/AssistantsApi.md#createassistant) | **Post** /v1/Assistants | Create a new assistant |
| 35 | +*AssistantsApi* | [**DeleteAssistant**](docs/AssistantsApi.md#deleteassistant) | **Delete** /v1/Assistants/{id} | Delete an assistant by ID |
| 36 | +*AssistantsApi* | [**FetchAssistant**](docs/AssistantsApi.md#fetchassistant) | **Get** /v1/Assistants/{id} | Get an assistant by ID |
| 37 | +*AssistantsApi* | [**ListAssistant**](docs/AssistantsApi.md#listassistant) | **Get** /v1/Assistants | List all assistants |
| 38 | +*AssistantsApi* | [**UpdateAssistant**](docs/AssistantsApi.md#updateassistant) | **Put** /v1/Assistants/{id} | Update an assistant by ID |
| 39 | +*AssistantsFeedbacksApi* | [**CreateFeedback**](docs/AssistantsFeedbacksApi.md#createfeedback) | **Post** /v1/Assistants/{id}/Feedbacks | Create feedback |
| 40 | +*AssistantsFeedbacksApi* | [**ListFeedback**](docs/AssistantsFeedbacksApi.md#listfeedback) | **Get** /v1/Assistants/{id}/Feedbacks | List feedbacks |
| 41 | +*KnowledgeApi* | [**CreateKnowledge**](docs/KnowledgeApi.md#createknowledge) | **Post** /v1/Knowledge | Create knowledge |
| 42 | +*KnowledgeApi* | [**DeleteKnowledge**](docs/KnowledgeApi.md#deleteknowledge) | **Delete** /v1/Knowledge/{id} | Delete knowledge |
| 43 | +*KnowledgeApi* | [**FetchKnowledge**](docs/KnowledgeApi.md#fetchknowledge) | **Get** /v1/Knowledge/{id} | Get knowledge |
| 44 | +*KnowledgeApi* | [**ListKnowledge**](docs/KnowledgeApi.md#listknowledge) | **Get** /v1/Knowledge | List all knowledge |
| 45 | +*KnowledgeApi* | [**UpdateKnowledge**](docs/KnowledgeApi.md#updateknowledge) | **Put** /v1/Knowledge/{id} | Update knowledge |
| 46 | +*KnowledgeChunksApi* | [**ListKnowledgeChunks**](docs/KnowledgeChunksApi.md#listknowledgechunks) | **Get** /v1/Knowledge/{id}/Chunks | List knowledge chunks |
| 47 | +*PoliciesApi* | [**ListPolicies**](docs/PoliciesApi.md#listpolicies) | **Get** /v1/Policies | List policies |
| 48 | +*SessionsApi* | [**FetchSession**](docs/SessionsApi.md#fetchsession) | **Get** /v1/Sessions/{id} | Get a session by ID |
| 49 | +*SessionsApi* | [**ListSessions**](docs/SessionsApi.md#listsessions) | **Get** /v1/Sessions | List sessions |
| 50 | +*SessionsMessagesApi* | [**ListMessages**](docs/SessionsMessagesApi.md#listmessages) | **Get** /v1/Sessions/{sessionId}/Messages | List messages |
| 51 | +*ToolsApi* | [**CreateTool**](docs/ToolsApi.md#createtool) | **Post** /v1/Tools | Create tool |
| 52 | +*ToolsApi* | [**DeleteTool**](docs/ToolsApi.md#deletetool) | **Delete** /v1/Tools/{id} | Delete tool |
| 53 | +*ToolsApi* | [**ListTools**](docs/ToolsApi.md#listtools) | **Get** /v1/Tools | List tools |
| 54 | +*ToolsApi* | [**UpdateTool**](docs/ToolsApi.md#updatetool) | **Put** /v1/Tools/{id} | Update tool |
| 55 | + |
| 56 | + |
| 57 | +## Documentation For Models |
| 58 | + |
| 59 | + - [AssistantsV1CreateAssistantRequest](docs/AssistantsV1CreateAssistantRequest.md) |
| 60 | + - [AssistantsV1KnowledgeChunk](docs/AssistantsV1KnowledgeChunk.md) |
| 61 | + - [AssistantsV1AssistantSendMessageResponse](docs/AssistantsV1AssistantSendMessageResponse.md) |
| 62 | + - [AssistantsV1SearchKnowledgeRequest](docs/AssistantsV1SearchKnowledgeRequest.md) |
| 63 | + - [AssistantsV1CreatePolicyRequest](docs/AssistantsV1CreatePolicyRequest.md) |
| 64 | + - [AssistantsV1SegmentCredential](docs/AssistantsV1SegmentCredential.md) |
| 65 | + - [AssistantsV1CustomerAi](docs/AssistantsV1CustomerAi.md) |
| 66 | + - [AssistantsV1Knowledge](docs/AssistantsV1Knowledge.md) |
| 67 | + - [AssistantsV1Message](docs/AssistantsV1Message.md) |
| 68 | + - [ListToolsResponse](docs/ListToolsResponse.md) |
| 69 | + - [AssistantsV1UpdateToolRequest](docs/AssistantsV1UpdateToolRequest.md) |
| 70 | + - [ListFeedbacksResponse](docs/ListFeedbacksResponse.md) |
| 71 | + - [AssistantsV1CreateToolRequest](docs/AssistantsV1CreateToolRequest.md) |
| 72 | + - [ListAssistantResponse](docs/ListAssistantResponse.md) |
| 73 | + - [AssistantsV1AssistantSendMessageRequest](docs/AssistantsV1AssistantSendMessageRequest.md) |
| 74 | + - [AssistantsV1Session](docs/AssistantsV1Session.md) |
| 75 | + - [AssistantsV1Policy](docs/AssistantsV1Policy.md) |
| 76 | + - [AssistantsV1ToolWithPolicies](docs/AssistantsV1ToolWithPolicies.md) |
| 77 | + - [ListKnowledgeChunksResponse](docs/ListKnowledgeChunksResponse.md) |
| 78 | + - [AssistantsV1AssistantWithToolsAndKnowledge](docs/AssistantsV1AssistantWithToolsAndKnowledge.md) |
| 79 | + - [ListKnowledgeResponse](docs/ListKnowledgeResponse.md) |
| 80 | + - [AssistantsV1Tool](docs/AssistantsV1Tool.md) |
| 81 | + - [ListPoliciesResponse](docs/ListPoliciesResponse.md) |
| 82 | + - [ListSessionsResponse](docs/ListSessionsResponse.md) |
| 83 | + - [AssistantsV1Feedback](docs/AssistantsV1Feedback.md) |
| 84 | + - [AssistantsV1UpdateKnowledgeRequest](docs/AssistantsV1UpdateKnowledgeRequest.md) |
| 85 | + - [ListMessagesResponse](docs/ListMessagesResponse.md) |
| 86 | + - [AssistantsV1Assistant](docs/AssistantsV1Assistant.md) |
| 87 | + - [AssistantsV1CreateKnowledgeRequest](docs/AssistantsV1CreateKnowledgeRequest.md) |
| 88 | + - [AssistantsV1KnowledgeChunkWithScore](docs/AssistantsV1KnowledgeChunkWithScore.md) |
| 89 | + - [ListAssistantResponseMeta](docs/ListAssistantResponseMeta.md) |
| 90 | + - [AssistantsV1KnowledgeStatus](docs/AssistantsV1KnowledgeStatus.md) |
| 91 | + - [AssistantsV1UpdateAssistantRequest](docs/AssistantsV1UpdateAssistantRequest.md) |
| 92 | + - [AssistantsV1CreateFeedbackRequest](docs/AssistantsV1CreateFeedbackRequest.md) |
| 93 | + |
| 94 | + |
| 95 | +## Documentation For Authorization |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | +## accountSid_authToken |
| 100 | + |
| 101 | +- **Type**: HTTP basic authentication |
| 102 | + |
| 103 | +Example |
| 104 | + |
| 105 | +```golang |
| 106 | +auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ |
| 107 | + UserName: "username", |
| 108 | + Password: "password", |
| 109 | +}) |
| 110 | +r, err := client.Service.Operation(auth, args) |
| 111 | +``` |
| 112 | + |
0 commit comments