github.com/twilio/twilio-go@v1.20.1/rest/chat/v2/README.md (about) 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://chat.twilio.com* 31 32 Class | Method | HTTP request | Description 33 ------------ | ------------- | ------------- | ------------- 34 *CredentialsApi* | [**CreateCredential**](docs/CredentialsApi.md#createcredential) | **Post** /v2/Credentials | 35 *CredentialsApi* | [**DeleteCredential**](docs/CredentialsApi.md#deletecredential) | **Delete** /v2/Credentials/{Sid} | 36 *CredentialsApi* | [**FetchCredential**](docs/CredentialsApi.md#fetchcredential) | **Get** /v2/Credentials/{Sid} | 37 *CredentialsApi* | [**ListCredential**](docs/CredentialsApi.md#listcredential) | **Get** /v2/Credentials | 38 *CredentialsApi* | [**UpdateCredential**](docs/CredentialsApi.md#updatecredential) | **Post** /v2/Credentials/{Sid} | 39 *ServicesApi* | [**CreateService**](docs/ServicesApi.md#createservice) | **Post** /v2/Services | 40 *ServicesApi* | [**DeleteService**](docs/ServicesApi.md#deleteservice) | **Delete** /v2/Services/{Sid} | 41 *ServicesApi* | [**FetchService**](docs/ServicesApi.md#fetchservice) | **Get** /v2/Services/{Sid} | 42 *ServicesApi* | [**ListService**](docs/ServicesApi.md#listservice) | **Get** /v2/Services | 43 *ServicesApi* | [**UpdateService**](docs/ServicesApi.md#updateservice) | **Post** /v2/Services/{Sid} | 44 *ServicesBindingsApi* | [**DeleteBinding**](docs/ServicesBindingsApi.md#deletebinding) | **Delete** /v2/Services/{ServiceSid}/Bindings/{Sid} | 45 *ServicesBindingsApi* | [**FetchBinding**](docs/ServicesBindingsApi.md#fetchbinding) | **Get** /v2/Services/{ServiceSid}/Bindings/{Sid} | 46 *ServicesBindingsApi* | [**ListBinding**](docs/ServicesBindingsApi.md#listbinding) | **Get** /v2/Services/{ServiceSid}/Bindings | 47 *ServicesChannelsApi* | [**CreateChannel**](docs/ServicesChannelsApi.md#createchannel) | **Post** /v2/Services/{ServiceSid}/Channels | 48 *ServicesChannelsApi* | [**DeleteChannel**](docs/ServicesChannelsApi.md#deletechannel) | **Delete** /v2/Services/{ServiceSid}/Channels/{Sid} | 49 *ServicesChannelsApi* | [**FetchChannel**](docs/ServicesChannelsApi.md#fetchchannel) | **Get** /v2/Services/{ServiceSid}/Channels/{Sid} | 50 *ServicesChannelsApi* | [**ListChannel**](docs/ServicesChannelsApi.md#listchannel) | **Get** /v2/Services/{ServiceSid}/Channels | 51 *ServicesChannelsApi* | [**UpdateChannel**](docs/ServicesChannelsApi.md#updatechannel) | **Post** /v2/Services/{ServiceSid}/Channels/{Sid} | 52 *ServicesChannelsInvitesApi* | [**CreateInvite**](docs/ServicesChannelsInvitesApi.md#createinvite) | **Post** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites | 53 *ServicesChannelsInvitesApi* | [**DeleteInvite**](docs/ServicesChannelsInvitesApi.md#deleteinvite) | **Delete** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid} | 54 *ServicesChannelsInvitesApi* | [**FetchInvite**](docs/ServicesChannelsInvitesApi.md#fetchinvite) | **Get** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid} | 55 *ServicesChannelsInvitesApi* | [**ListInvite**](docs/ServicesChannelsInvitesApi.md#listinvite) | **Get** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites | 56 *ServicesChannelsMembersApi* | [**CreateMember**](docs/ServicesChannelsMembersApi.md#createmember) | **Post** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members | 57 *ServicesChannelsMembersApi* | [**DeleteMember**](docs/ServicesChannelsMembersApi.md#deletemember) | **Delete** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 58 *ServicesChannelsMembersApi* | [**FetchMember**](docs/ServicesChannelsMembersApi.md#fetchmember) | **Get** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 59 *ServicesChannelsMembersApi* | [**ListMember**](docs/ServicesChannelsMembersApi.md#listmember) | **Get** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members | 60 *ServicesChannelsMembersApi* | [**UpdateMember**](docs/ServicesChannelsMembersApi.md#updatemember) | **Post** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 61 *ServicesChannelsMessagesApi* | [**CreateMessage**](docs/ServicesChannelsMessagesApi.md#createmessage) | **Post** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages | 62 *ServicesChannelsMessagesApi* | [**DeleteMessage**](docs/ServicesChannelsMessagesApi.md#deletemessage) | **Delete** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid} | 63 *ServicesChannelsMessagesApi* | [**FetchMessage**](docs/ServicesChannelsMessagesApi.md#fetchmessage) | **Get** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid} | 64 *ServicesChannelsMessagesApi* | [**ListMessage**](docs/ServicesChannelsMessagesApi.md#listmessage) | **Get** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages | 65 *ServicesChannelsMessagesApi* | [**UpdateMessage**](docs/ServicesChannelsMessagesApi.md#updatemessage) | **Post** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid} | 66 *ServicesChannelsWebhooksApi* | [**CreateChannelWebhook**](docs/ServicesChannelsWebhooksApi.md#createchannelwebhook) | **Post** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks | 67 *ServicesChannelsWebhooksApi* | [**DeleteChannelWebhook**](docs/ServicesChannelsWebhooksApi.md#deletechannelwebhook) | **Delete** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid} | 68 *ServicesChannelsWebhooksApi* | [**FetchChannelWebhook**](docs/ServicesChannelsWebhooksApi.md#fetchchannelwebhook) | **Get** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid} | 69 *ServicesChannelsWebhooksApi* | [**ListChannelWebhook**](docs/ServicesChannelsWebhooksApi.md#listchannelwebhook) | **Get** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks | 70 *ServicesChannelsWebhooksApi* | [**UpdateChannelWebhook**](docs/ServicesChannelsWebhooksApi.md#updatechannelwebhook) | **Post** /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid} | 71 *ServicesRolesApi* | [**CreateRole**](docs/ServicesRolesApi.md#createrole) | **Post** /v2/Services/{ServiceSid}/Roles | 72 *ServicesRolesApi* | [**DeleteRole**](docs/ServicesRolesApi.md#deleterole) | **Delete** /v2/Services/{ServiceSid}/Roles/{Sid} | 73 *ServicesRolesApi* | [**FetchRole**](docs/ServicesRolesApi.md#fetchrole) | **Get** /v2/Services/{ServiceSid}/Roles/{Sid} | 74 *ServicesRolesApi* | [**ListRole**](docs/ServicesRolesApi.md#listrole) | **Get** /v2/Services/{ServiceSid}/Roles | 75 *ServicesRolesApi* | [**UpdateRole**](docs/ServicesRolesApi.md#updaterole) | **Post** /v2/Services/{ServiceSid}/Roles/{Sid} | 76 *ServicesUsersApi* | [**CreateUser**](docs/ServicesUsersApi.md#createuser) | **Post** /v2/Services/{ServiceSid}/Users | 77 *ServicesUsersApi* | [**DeleteUser**](docs/ServicesUsersApi.md#deleteuser) | **Delete** /v2/Services/{ServiceSid}/Users/{Sid} | 78 *ServicesUsersApi* | [**FetchUser**](docs/ServicesUsersApi.md#fetchuser) | **Get** /v2/Services/{ServiceSid}/Users/{Sid} | 79 *ServicesUsersApi* | [**ListUser**](docs/ServicesUsersApi.md#listuser) | **Get** /v2/Services/{ServiceSid}/Users | 80 *ServicesUsersApi* | [**UpdateUser**](docs/ServicesUsersApi.md#updateuser) | **Post** /v2/Services/{ServiceSid}/Users/{Sid} | 81 *ServicesUsersBindingsApi* | [**DeleteUserBinding**](docs/ServicesUsersBindingsApi.md#deleteuserbinding) | **Delete** /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid} | 82 *ServicesUsersBindingsApi* | [**FetchUserBinding**](docs/ServicesUsersBindingsApi.md#fetchuserbinding) | **Get** /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid} | 83 *ServicesUsersBindingsApi* | [**ListUserBinding**](docs/ServicesUsersBindingsApi.md#listuserbinding) | **Get** /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings | 84 *ServicesUsersChannelsApi* | [**DeleteUserChannel**](docs/ServicesUsersChannelsApi.md#deleteuserchannel) | **Delete** /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid} | 85 *ServicesUsersChannelsApi* | [**FetchUserChannel**](docs/ServicesUsersChannelsApi.md#fetchuserchannel) | **Get** /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid} | 86 *ServicesUsersChannelsApi* | [**ListUserChannel**](docs/ServicesUsersChannelsApi.md#listuserchannel) | **Get** /v2/Services/{ServiceSid}/Users/{UserSid}/Channels | 87 *ServicesUsersChannelsApi* | [**UpdateUserChannel**](docs/ServicesUsersChannelsApi.md#updateuserchannel) | **Post** /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid} | 88 89 90 ## Documentation For Models 91 92 - [ListUserResponse](docs/ListUserResponse.md) 93 - [ListChannelResponse](docs/ListChannelResponse.md) 94 - [ChatV2User](docs/ChatV2User.md) 95 - [ListInviteResponse](docs/ListInviteResponse.md) 96 - [ListBindingResponse](docs/ListBindingResponse.md) 97 - [ListMessageResponse](docs/ListMessageResponse.md) 98 - [ListServiceResponse](docs/ListServiceResponse.md) 99 - [ListChannelWebhookResponse](docs/ListChannelWebhookResponse.md) 100 - [ListMemberResponse](docs/ListMemberResponse.md) 101 - [ChatV2Message](docs/ChatV2Message.md) 102 - [ChatV2Credential](docs/ChatV2Credential.md) 103 - [ListUserChannelResponse](docs/ListUserChannelResponse.md) 104 - [ListCredentialResponse](docs/ListCredentialResponse.md) 105 - [ChatV2UserChannel](docs/ChatV2UserChannel.md) 106 - [ChatV2UserBinding](docs/ChatV2UserBinding.md) 107 - [ListUserBindingResponse](docs/ListUserBindingResponse.md) 108 - [ListRoleResponse](docs/ListRoleResponse.md) 109 - [ChatV2Member](docs/ChatV2Member.md) 110 - [ChatV2Invite](docs/ChatV2Invite.md) 111 - [ChatV2Channel](docs/ChatV2Channel.md) 112 - [ListBindingResponseMeta](docs/ListBindingResponseMeta.md) 113 - [ChatV2Role](docs/ChatV2Role.md) 114 - [ChatV2Service](docs/ChatV2Service.md) 115 - [ChatV2ChannelWebhook](docs/ChatV2ChannelWebhook.md) 116 - [ChatV2Binding](docs/ChatV2Binding.md) 117 118 119 ## Documentation For Authorization 120 121 122 123 ## accountSid_authToken 124 125 - **Type**: HTTP basic authentication 126 127 Example 128 129 ```golang 130 auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ 131 UserName: "username", 132 Password: "password", 133 }) 134 r, err := client.Service.Operation(auth, args) 135 ``` 136