github.com/twilio/twilio-go@v1.20.1/rest/chat/v1/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** /v1/Credentials | 
    35  *CredentialsApi* | [**DeleteCredential**](docs/CredentialsApi.md#deletecredential) | **Delete** /v1/Credentials/{Sid} | 
    36  *CredentialsApi* | [**FetchCredential**](docs/CredentialsApi.md#fetchcredential) | **Get** /v1/Credentials/{Sid} | 
    37  *CredentialsApi* | [**ListCredential**](docs/CredentialsApi.md#listcredential) | **Get** /v1/Credentials | 
    38  *CredentialsApi* | [**UpdateCredential**](docs/CredentialsApi.md#updatecredential) | **Post** /v1/Credentials/{Sid} | 
    39  *ServicesApi* | [**CreateService**](docs/ServicesApi.md#createservice) | **Post** /v1/Services | 
    40  *ServicesApi* | [**DeleteService**](docs/ServicesApi.md#deleteservice) | **Delete** /v1/Services/{Sid} | 
    41  *ServicesApi* | [**FetchService**](docs/ServicesApi.md#fetchservice) | **Get** /v1/Services/{Sid} | 
    42  *ServicesApi* | [**ListService**](docs/ServicesApi.md#listservice) | **Get** /v1/Services | 
    43  *ServicesApi* | [**UpdateService**](docs/ServicesApi.md#updateservice) | **Post** /v1/Services/{Sid} | 
    44  *ServicesChannelsApi* | [**CreateChannel**](docs/ServicesChannelsApi.md#createchannel) | **Post** /v1/Services/{ServiceSid}/Channels | 
    45  *ServicesChannelsApi* | [**DeleteChannel**](docs/ServicesChannelsApi.md#deletechannel) | **Delete** /v1/Services/{ServiceSid}/Channels/{Sid} | 
    46  *ServicesChannelsApi* | [**FetchChannel**](docs/ServicesChannelsApi.md#fetchchannel) | **Get** /v1/Services/{ServiceSid}/Channels/{Sid} | 
    47  *ServicesChannelsApi* | [**ListChannel**](docs/ServicesChannelsApi.md#listchannel) | **Get** /v1/Services/{ServiceSid}/Channels | 
    48  *ServicesChannelsApi* | [**UpdateChannel**](docs/ServicesChannelsApi.md#updatechannel) | **Post** /v1/Services/{ServiceSid}/Channels/{Sid} | 
    49  *ServicesChannelsInvitesApi* | [**CreateInvite**](docs/ServicesChannelsInvitesApi.md#createinvite) | **Post** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites | 
    50  *ServicesChannelsInvitesApi* | [**DeleteInvite**](docs/ServicesChannelsInvitesApi.md#deleteinvite) | **Delete** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid} | 
    51  *ServicesChannelsInvitesApi* | [**FetchInvite**](docs/ServicesChannelsInvitesApi.md#fetchinvite) | **Get** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid} | 
    52  *ServicesChannelsInvitesApi* | [**ListInvite**](docs/ServicesChannelsInvitesApi.md#listinvite) | **Get** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites | 
    53  *ServicesChannelsMembersApi* | [**CreateMember**](docs/ServicesChannelsMembersApi.md#createmember) | **Post** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members | 
    54  *ServicesChannelsMembersApi* | [**DeleteMember**](docs/ServicesChannelsMembersApi.md#deletemember) | **Delete** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 
    55  *ServicesChannelsMembersApi* | [**FetchMember**](docs/ServicesChannelsMembersApi.md#fetchmember) | **Get** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 
    56  *ServicesChannelsMembersApi* | [**ListMember**](docs/ServicesChannelsMembersApi.md#listmember) | **Get** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members | 
    57  *ServicesChannelsMembersApi* | [**UpdateMember**](docs/ServicesChannelsMembersApi.md#updatemember) | **Post** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 
    58  *ServicesChannelsMessagesApi* | [**CreateMessage**](docs/ServicesChannelsMessagesApi.md#createmessage) | **Post** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages | 
    59  *ServicesChannelsMessagesApi* | [**DeleteMessage**](docs/ServicesChannelsMessagesApi.md#deletemessage) | **Delete** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid} | 
    60  *ServicesChannelsMessagesApi* | [**FetchMessage**](docs/ServicesChannelsMessagesApi.md#fetchmessage) | **Get** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid} | 
    61  *ServicesChannelsMessagesApi* | [**ListMessage**](docs/ServicesChannelsMessagesApi.md#listmessage) | **Get** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages | 
    62  *ServicesChannelsMessagesApi* | [**UpdateMessage**](docs/ServicesChannelsMessagesApi.md#updatemessage) | **Post** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid} | 
    63  *ServicesRolesApi* | [**CreateRole**](docs/ServicesRolesApi.md#createrole) | **Post** /v1/Services/{ServiceSid}/Roles | 
    64  *ServicesRolesApi* | [**DeleteRole**](docs/ServicesRolesApi.md#deleterole) | **Delete** /v1/Services/{ServiceSid}/Roles/{Sid} | 
    65  *ServicesRolesApi* | [**FetchRole**](docs/ServicesRolesApi.md#fetchrole) | **Get** /v1/Services/{ServiceSid}/Roles/{Sid} | 
    66  *ServicesRolesApi* | [**ListRole**](docs/ServicesRolesApi.md#listrole) | **Get** /v1/Services/{ServiceSid}/Roles | 
    67  *ServicesRolesApi* | [**UpdateRole**](docs/ServicesRolesApi.md#updaterole) | **Post** /v1/Services/{ServiceSid}/Roles/{Sid} | 
    68  *ServicesUsersApi* | [**CreateUser**](docs/ServicesUsersApi.md#createuser) | **Post** /v1/Services/{ServiceSid}/Users | 
    69  *ServicesUsersApi* | [**DeleteUser**](docs/ServicesUsersApi.md#deleteuser) | **Delete** /v1/Services/{ServiceSid}/Users/{Sid} | 
    70  *ServicesUsersApi* | [**FetchUser**](docs/ServicesUsersApi.md#fetchuser) | **Get** /v1/Services/{ServiceSid}/Users/{Sid} | 
    71  *ServicesUsersApi* | [**ListUser**](docs/ServicesUsersApi.md#listuser) | **Get** /v1/Services/{ServiceSid}/Users | 
    72  *ServicesUsersApi* | [**UpdateUser**](docs/ServicesUsersApi.md#updateuser) | **Post** /v1/Services/{ServiceSid}/Users/{Sid} | 
    73  *ServicesUsersChannelsApi* | [**ListUserChannel**](docs/ServicesUsersChannelsApi.md#listuserchannel) | **Get** /v1/Services/{ServiceSid}/Users/{UserSid}/Channels | 
    74  
    75  
    76  ## Documentation For Models
    77  
    78   - [ChatV1Member](docs/ChatV1Member.md)
    79   - [ChatV1Invite](docs/ChatV1Invite.md)
    80   - [ListUserResponse](docs/ListUserResponse.md)
    81   - [ListChannelResponse](docs/ListChannelResponse.md)
    82   - [ChatV1Service](docs/ChatV1Service.md)
    83   - [ChatV1Message](docs/ChatV1Message.md)
    84   - [ChatV1User](docs/ChatV1User.md)
    85   - [ListInviteResponse](docs/ListInviteResponse.md)
    86   - [ListMessageResponse](docs/ListMessageResponse.md)
    87   - [ChatV1Role](docs/ChatV1Role.md)
    88   - [ChatV1Credential](docs/ChatV1Credential.md)
    89   - [ChatV1Channel](docs/ChatV1Channel.md)
    90   - [ListServiceResponse](docs/ListServiceResponse.md)
    91   - [ListMemberResponse](docs/ListMemberResponse.md)
    92   - [ChatV1UserChannel](docs/ChatV1UserChannel.md)
    93   - [ListUserChannelResponse](docs/ListUserChannelResponse.md)
    94   - [ListCredentialResponse](docs/ListCredentialResponse.md)
    95   - [ListChannelResponseMeta](docs/ListChannelResponseMeta.md)
    96   - [ListRoleResponse](docs/ListRoleResponse.md)
    97  
    98  
    99  ## Documentation For Authorization
   100  
   101  
   102  
   103  ## accountSid_authToken
   104  
   105  - **Type**: HTTP basic authentication
   106  
   107  Example
   108  
   109  ```golang
   110  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   111      UserName: "username",
   112      Password: "password",
   113  })
   114  r, err := client.Service.Operation(auth, args)
   115  ```
   116