github.com/twilio/twilio-go@v1.20.1/rest/video/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://video.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *CompositionHooksApi* | [**CreateCompositionHook**](docs/CompositionHooksApi.md#createcompositionhook) | **Post** /v1/CompositionHooks | 
    35  *CompositionHooksApi* | [**DeleteCompositionHook**](docs/CompositionHooksApi.md#deletecompositionhook) | **Delete** /v1/CompositionHooks/{Sid} | 
    36  *CompositionHooksApi* | [**FetchCompositionHook**](docs/CompositionHooksApi.md#fetchcompositionhook) | **Get** /v1/CompositionHooks/{Sid} | 
    37  *CompositionHooksApi* | [**ListCompositionHook**](docs/CompositionHooksApi.md#listcompositionhook) | **Get** /v1/CompositionHooks | 
    38  *CompositionHooksApi* | [**UpdateCompositionHook**](docs/CompositionHooksApi.md#updatecompositionhook) | **Post** /v1/CompositionHooks/{Sid} | 
    39  *CompositionSettingsDefaultApi* | [**CreateCompositionSettings**](docs/CompositionSettingsDefaultApi.md#createcompositionsettings) | **Post** /v1/CompositionSettings/Default | 
    40  *CompositionSettingsDefaultApi* | [**FetchCompositionSettings**](docs/CompositionSettingsDefaultApi.md#fetchcompositionsettings) | **Get** /v1/CompositionSettings/Default | 
    41  *CompositionsApi* | [**CreateComposition**](docs/CompositionsApi.md#createcomposition) | **Post** /v1/Compositions | 
    42  *CompositionsApi* | [**DeleteComposition**](docs/CompositionsApi.md#deletecomposition) | **Delete** /v1/Compositions/{Sid} | 
    43  *CompositionsApi* | [**FetchComposition**](docs/CompositionsApi.md#fetchcomposition) | **Get** /v1/Compositions/{Sid} | 
    44  *CompositionsApi* | [**ListComposition**](docs/CompositionsApi.md#listcomposition) | **Get** /v1/Compositions | 
    45  *RecordingSettingsDefaultApi* | [**CreateRecordingSettings**](docs/RecordingSettingsDefaultApi.md#createrecordingsettings) | **Post** /v1/RecordingSettings/Default | 
    46  *RecordingSettingsDefaultApi* | [**FetchRecordingSettings**](docs/RecordingSettingsDefaultApi.md#fetchrecordingsettings) | **Get** /v1/RecordingSettings/Default | 
    47  *RecordingsApi* | [**DeleteRecording**](docs/RecordingsApi.md#deleterecording) | **Delete** /v1/Recordings/{Sid} | 
    48  *RecordingsApi* | [**FetchRecording**](docs/RecordingsApi.md#fetchrecording) | **Get** /v1/Recordings/{Sid} | 
    49  *RecordingsApi* | [**ListRecording**](docs/RecordingsApi.md#listrecording) | **Get** /v1/Recordings | 
    50  *RoomsApi* | [**CreateRoom**](docs/RoomsApi.md#createroom) | **Post** /v1/Rooms | 
    51  *RoomsApi* | [**FetchRoom**](docs/RoomsApi.md#fetchroom) | **Get** /v1/Rooms/{Sid} | 
    52  *RoomsApi* | [**ListRoom**](docs/RoomsApi.md#listroom) | **Get** /v1/Rooms | 
    53  *RoomsApi* | [**UpdateRoom**](docs/RoomsApi.md#updateroom) | **Post** /v1/Rooms/{Sid} | 
    54  *RoomsParticipantsApi* | [**FetchRoomParticipant**](docs/RoomsParticipantsApi.md#fetchroomparticipant) | **Get** /v1/Rooms/{RoomSid}/Participants/{Sid} | 
    55  *RoomsParticipantsApi* | [**ListRoomParticipant**](docs/RoomsParticipantsApi.md#listroomparticipant) | **Get** /v1/Rooms/{RoomSid}/Participants | 
    56  *RoomsParticipantsApi* | [**UpdateRoomParticipant**](docs/RoomsParticipantsApi.md#updateroomparticipant) | **Post** /v1/Rooms/{RoomSid}/Participants/{Sid} | 
    57  *RoomsParticipantsAnonymizeApi* | [**UpdateRoomParticipantAnonymize**](docs/RoomsParticipantsAnonymizeApi.md#updateroomparticipantanonymize) | **Post** /v1/Rooms/{RoomSid}/Participants/{Sid}/Anonymize | 
    58  *RoomsParticipantsPublishedTracksApi* | [**FetchRoomParticipantPublishedTrack**](docs/RoomsParticipantsPublishedTracksApi.md#fetchroomparticipantpublishedtrack) | **Get** /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks/{Sid} | 
    59  *RoomsParticipantsPublishedTracksApi* | [**ListRoomParticipantPublishedTrack**](docs/RoomsParticipantsPublishedTracksApi.md#listroomparticipantpublishedtrack) | **Get** /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks | 
    60  *RoomsParticipantsSubscribeRulesApi* | [**FetchRoomParticipantSubscribeRule**](docs/RoomsParticipantsSubscribeRulesApi.md#fetchroomparticipantsubscriberule) | **Get** /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules | 
    61  *RoomsParticipantsSubscribeRulesApi* | [**UpdateRoomParticipantSubscribeRule**](docs/RoomsParticipantsSubscribeRulesApi.md#updateroomparticipantsubscriberule) | **Post** /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules | 
    62  *RoomsParticipantsSubscribedTracksApi* | [**FetchRoomParticipantSubscribedTrack**](docs/RoomsParticipantsSubscribedTracksApi.md#fetchroomparticipantsubscribedtrack) | **Get** /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks/{Sid} | 
    63  *RoomsParticipantsSubscribedTracksApi* | [**ListRoomParticipantSubscribedTrack**](docs/RoomsParticipantsSubscribedTracksApi.md#listroomparticipantsubscribedtrack) | **Get** /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks | 
    64  *RoomsRecordingRulesApi* | [**FetchRoomRecordingRule**](docs/RoomsRecordingRulesApi.md#fetchroomrecordingrule) | **Get** /v1/Rooms/{RoomSid}/RecordingRules | 
    65  *RoomsRecordingRulesApi* | [**UpdateRoomRecordingRule**](docs/RoomsRecordingRulesApi.md#updateroomrecordingrule) | **Post** /v1/Rooms/{RoomSid}/RecordingRules | 
    66  *RoomsRecordingsApi* | [**DeleteRoomRecording**](docs/RoomsRecordingsApi.md#deleteroomrecording) | **Delete** /v1/Rooms/{RoomSid}/Recordings/{Sid} | 
    67  *RoomsRecordingsApi* | [**FetchRoomRecording**](docs/RoomsRecordingsApi.md#fetchroomrecording) | **Get** /v1/Rooms/{RoomSid}/Recordings/{Sid} | 
    68  *RoomsRecordingsApi* | [**ListRoomRecording**](docs/RoomsRecordingsApi.md#listroomrecording) | **Get** /v1/Rooms/{RoomSid}/Recordings | 
    69  
    70  
    71  ## Documentation For Models
    72  
    73   - [ListRoomParticipantResponse](docs/ListRoomParticipantResponse.md)
    74   - [VideoV1RoomRecording](docs/VideoV1RoomRecording.md)
    75   - [ListRoomParticipantPublishedTrackResponse](docs/ListRoomParticipantPublishedTrackResponse.md)
    76   - [VideoV1Composition](docs/VideoV1Composition.md)
    77   - [ListRoomRecordingResponse](docs/ListRoomRecordingResponse.md)
    78   - [VideoV1RoomRecordingRule](docs/VideoV1RoomRecordingRule.md)
    79   - [VideoV1RoomParticipant](docs/VideoV1RoomParticipant.md)
    80   - [VideoV1RoomParticipantPublishedTrack](docs/VideoV1RoomParticipantPublishedTrack.md)
    81   - [VideoV1RoomRoomRecordingRuleRules](docs/VideoV1RoomRoomRecordingRuleRules.md)
    82   - [ListRecordingResponse](docs/ListRecordingResponse.md)
    83   - [VideoV1Recording](docs/VideoV1Recording.md)
    84   - [VideoV1RoomParticipantSubscribedTrack](docs/VideoV1RoomParticipantSubscribedTrack.md)
    85   - [ListRoomResponse](docs/ListRoomResponse.md)
    86   - [VideoV1CompositionSettings](docs/VideoV1CompositionSettings.md)
    87   - [VideoV1RoomParticipantSubscribeRule](docs/VideoV1RoomParticipantSubscribeRule.md)
    88   - [VideoV1CompositionHook](docs/VideoV1CompositionHook.md)
    89   - [ListCompositionResponse](docs/ListCompositionResponse.md)
    90   - [VideoV1Room](docs/VideoV1Room.md)
    91   - [ListCompositionHookResponse](docs/ListCompositionHookResponse.md)
    92   - [VideoV1RoomRoomParticipantRoomParticipantSubscribeRuleRules](docs/VideoV1RoomRoomParticipantRoomParticipantSubscribeRuleRules.md)
    93   - [ListCompositionResponseMeta](docs/ListCompositionResponseMeta.md)
    94   - [VideoV1RoomParticipantAnonymize](docs/VideoV1RoomParticipantAnonymize.md)
    95   - [ListRoomParticipantSubscribedTrackResponse](docs/ListRoomParticipantSubscribedTrackResponse.md)
    96   - [VideoV1RecordingSettings](docs/VideoV1RecordingSettings.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