|
| 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://knowledge.twilio.com* |
| 31 | + |
| 32 | +Class | Method | HTTP request | Description |
| 33 | +------------ | ------------- | ------------- | ------------- |
| 34 | +*KnowledgeApi* | [**CreateKnowledge**](docs/KnowledgeApi.md#createknowledge) | **Post** /v1/Knowledge | Create knowledge |
| 35 | +*KnowledgeApi* | [**DeleteKnowledge**](docs/KnowledgeApi.md#deleteknowledge) | **Delete** /v1/Knowledge/{id} | Delete knowledge |
| 36 | +*KnowledgeApi* | [**FetchKnowledge**](docs/KnowledgeApi.md#fetchknowledge) | **Get** /v1/Knowledge/{id} | Get knowledge |
| 37 | +*KnowledgeApi* | [**ListKnowledge**](docs/KnowledgeApi.md#listknowledge) | **Get** /v1/Knowledge | List all knowledge |
| 38 | +*KnowledgeApi* | [**UpdateKnowledge**](docs/KnowledgeApi.md#updateknowledge) | **Put** /v1/Knowledge/{id} | Update knowledge |
| 39 | +*KnowledgeChunksApi* | [**ListKnowledgeChunks**](docs/KnowledgeChunksApi.md#listknowledgechunks) | **Get** /v1/Knowledge/{id}/Chunks | List knowledge chunks |
| 40 | +*KnowledgeStatusApi* | [**FetchKnowledgeStatus**](docs/KnowledgeStatusApi.md#fetchknowledgestatus) | **Get** /v1/Knowledge/{id}/Status | Get knowledge status |
| 41 | + |
| 42 | + |
| 43 | +## Documentation For Models |
| 44 | + |
| 45 | + - [KnowledgeV1TagValue](docs/KnowledgeV1TagValue.md) |
| 46 | + - [ListKnowledgeResponseMeta](docs/ListKnowledgeResponseMeta.md) |
| 47 | + - [KnowledgeV1CreateKnowledgeRequest](docs/KnowledgeV1CreateKnowledgeRequest.md) |
| 48 | + - [KnowledgeV1UpdateKnowledgeRequest](docs/KnowledgeV1UpdateKnowledgeRequest.md) |
| 49 | + - [ListKnowledgeChunksResponse](docs/ListKnowledgeChunksResponse.md) |
| 50 | + - [ListKnowledgeResponse](docs/ListKnowledgeResponse.md) |
| 51 | + - [KnowledgeV1CreateTagRequest](docs/KnowledgeV1CreateTagRequest.md) |
| 52 | + - [KnowledgeV1KnowledgeChunkWithScore](docs/KnowledgeV1KnowledgeChunkWithScore.md) |
| 53 | + - [KnowledgeV1Tag](docs/KnowledgeV1Tag.md) |
| 54 | + - [KnowledgeV1CreatePolicyRequest](docs/KnowledgeV1CreatePolicyRequest.md) |
| 55 | + - [Tags1](docs/Tags1.md) |
| 56 | + - [KnowledgeV1UpdateTagRequest](docs/KnowledgeV1UpdateTagRequest.md) |
| 57 | + - [KnowledgeV1Knowledge](docs/KnowledgeV1Knowledge.md) |
| 58 | + - [KnowledgeV1CreateTagValueRequest](docs/KnowledgeV1CreateTagValueRequest.md) |
| 59 | + - [KnowledgeV1KnowledgeStatus](docs/KnowledgeV1KnowledgeStatus.md) |
| 60 | + - [KnowledgeV1UpdateTagValueRequest](docs/KnowledgeV1UpdateTagValueRequest.md) |
| 61 | + - [KnowledgeV1KnowledgeChunk](docs/KnowledgeV1KnowledgeChunk.md) |
| 62 | + - [ListKnowledgeResponseKnowledge](docs/ListKnowledgeResponseKnowledge.md) |
| 63 | + |
| 64 | + |
| 65 | +## Documentation For Authorization |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +## accountSid_authToken |
| 70 | + |
| 71 | +- **Type**: HTTP basic authentication |
| 72 | + |
| 73 | +Example |
| 74 | + |
| 75 | +```golang |
| 76 | +auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ |
| 77 | + UserName: "username", |
| 78 | + Password: "password", |
| 79 | +}) |
| 80 | +r, err := client.Service.Operation(auth, args) |
| 81 | +``` |
| 82 | + |
0 commit comments