github.com/twilio/twilio-go@v1.20.1/rest/insights/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://insights.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *ConferencesApi* | [**FetchConference**](docs/ConferencesApi.md#fetchconference) | **Get** /v1/Conferences/{ConferenceSid} | 
    35  *ConferencesApi* | [**ListConference**](docs/ConferencesApi.md#listconference) | **Get** /v1/Conferences | 
    36  *ConferencesParticipantsApi* | [**FetchConferenceParticipant**](docs/ConferencesParticipantsApi.md#fetchconferenceparticipant) | **Get** /v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid} | 
    37  *ConferencesParticipantsApi* | [**ListConferenceParticipant**](docs/ConferencesParticipantsApi.md#listconferenceparticipant) | **Get** /v1/Conferences/{ConferenceSid}/Participants | 
    38  *VideoRoomsApi* | [**FetchVideoRoomSummary**](docs/VideoRoomsApi.md#fetchvideoroomsummary) | **Get** /v1/Video/Rooms/{RoomSid} | 
    39  *VideoRoomsApi* | [**ListVideoRoomSummary**](docs/VideoRoomsApi.md#listvideoroomsummary) | **Get** /v1/Video/Rooms | 
    40  *VideoRoomsParticipantsApi* | [**FetchVideoParticipantSummary**](docs/VideoRoomsParticipantsApi.md#fetchvideoparticipantsummary) | **Get** /v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid} | 
    41  *VideoRoomsParticipantsApi* | [**ListVideoParticipantSummary**](docs/VideoRoomsParticipantsApi.md#listvideoparticipantsummary) | **Get** /v1/Video/Rooms/{RoomSid}/Participants | 
    42  *VoiceApi* | [**FetchCall**](docs/VoiceApi.md#fetchcall) | **Get** /v1/Voice/{Sid} | 
    43  *VoiceAnnotationApi* | [**FetchAnnotation**](docs/VoiceAnnotationApi.md#fetchannotation) | **Get** /v1/Voice/{CallSid}/Annotation | 
    44  *VoiceAnnotationApi* | [**UpdateAnnotation**](docs/VoiceAnnotationApi.md#updateannotation) | **Post** /v1/Voice/{CallSid}/Annotation | 
    45  *VoiceEventsApi* | [**ListEvent**](docs/VoiceEventsApi.md#listevent) | **Get** /v1/Voice/{CallSid}/Events | 
    46  *VoiceMetricsApi* | [**ListMetric**](docs/VoiceMetricsApi.md#listmetric) | **Get** /v1/Voice/{CallSid}/Metrics | 
    47  *VoiceSettingsApi* | [**FetchAccountSettings**](docs/VoiceSettingsApi.md#fetchaccountsettings) | **Get** /v1/Voice/Settings | 
    48  *VoiceSettingsApi* | [**UpdateAccountSettings**](docs/VoiceSettingsApi.md#updateaccountsettings) | **Post** /v1/Voice/Settings | 
    49  *VoiceSummariesApi* | [**ListCallSummaries**](docs/VoiceSummariesApi.md#listcallsummaries) | **Get** /v1/Voice/Summaries | 
    50  *VoiceSummaryApi* | [**FetchSummary**](docs/VoiceSummaryApi.md#fetchsummary) | **Get** /v1/Voice/{CallSid}/Summary | 
    51  
    52  
    53  ## Documentation For Models
    54  
    55   - [InsightsV1Conference](docs/InsightsV1Conference.md)
    56   - [InsightsV1Annotation](docs/InsightsV1Annotation.md)
    57   - [InsightsV1Metric](docs/InsightsV1Metric.md)
    58   - [ListConferenceResponse](docs/ListConferenceResponse.md)
    59   - [InsightsV1VideoRoomSummary](docs/InsightsV1VideoRoomSummary.md)
    60   - [InsightsV1AccountSettings](docs/InsightsV1AccountSettings.md)
    61   - [InsightsV1ConferenceParticipant](docs/InsightsV1ConferenceParticipant.md)
    62   - [InsightsV1VideoParticipantSummary](docs/InsightsV1VideoParticipantSummary.md)
    63   - [InsightsV1CallSummaries](docs/InsightsV1CallSummaries.md)
    64   - [ListVideoParticipantSummaryResponse](docs/ListVideoParticipantSummaryResponse.md)
    65   - [ListConferenceParticipantResponse](docs/ListConferenceParticipantResponse.md)
    66   - [ListVideoRoomSummaryResponse](docs/ListVideoRoomSummaryResponse.md)
    67   - [InsightsV1Call](docs/InsightsV1Call.md)
    68   - [ListCallSummariesResponseMeta](docs/ListCallSummariesResponseMeta.md)
    69   - [ListCallSummariesResponse](docs/ListCallSummariesResponse.md)
    70   - [ListEventResponse](docs/ListEventResponse.md)
    71   - [ListMetricResponse](docs/ListMetricResponse.md)
    72   - [InsightsV1Summary](docs/InsightsV1Summary.md)
    73   - [InsightsV1Event](docs/InsightsV1Event.md)
    74  
    75  
    76  ## Documentation For Authorization
    77  
    78  
    79  
    80  ## accountSid_authToken
    81  
    82  - **Type**: HTTP basic authentication
    83  
    84  Example
    85  
    86  ```golang
    87  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    88      UserName: "username",
    89      Password: "password",
    90  })
    91  r, err := client.Service.Operation(auth, args)
    92  ```
    93