Skip to content
Snippets Groups Projects
README.md 3.71 KiB
Newer Older
# Go API client for openapi

This is the public Twilio REST API.

## Overview
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.

- Package version: 1.0.0
- Build package: com.twilio.oai.TwilioGoGenerator
For more information, please visit [https://support.twilio.com](https://support.twilio.com)

## Installation

Install the following dependencies:

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```

Put the package under your project folder and add the following in import:

```golang
import "./openapi"
```

## Documentation for API Endpoints

All URIs are relative to *https://media.twilio.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*MediaProcessorsApi* | [**CreateMediaProcessor**](docs/MediaProcessorsApi.md#createmediaprocessor) | **Post** /v1/MediaProcessors | 
*MediaProcessorsApi* | [**FetchMediaProcessor**](docs/MediaProcessorsApi.md#fetchmediaprocessor) | **Get** /v1/MediaProcessors/{Sid} | 
*MediaProcessorsApi* | [**ListMediaProcessor**](docs/MediaProcessorsApi.md#listmediaprocessor) | **Get** /v1/MediaProcessors | 
*MediaProcessorsApi* | [**UpdateMediaProcessor**](docs/MediaProcessorsApi.md#updatemediaprocessor) | **Post** /v1/MediaProcessors/{Sid} | 
*MediaRecordingsApi* | [**DeleteMediaRecording**](docs/MediaRecordingsApi.md#deletemediarecording) | **Delete** /v1/MediaRecordings/{Sid} | 
*MediaRecordingsApi* | [**FetchMediaRecording**](docs/MediaRecordingsApi.md#fetchmediarecording) | **Get** /v1/MediaRecordings/{Sid} | 
*MediaRecordingsApi* | [**ListMediaRecording**](docs/MediaRecordingsApi.md#listmediarecording) | **Get** /v1/MediaRecordings | 
*PlayerStreamersApi* | [**CreatePlayerStreamer**](docs/PlayerStreamersApi.md#createplayerstreamer) | **Post** /v1/PlayerStreamers | 
*PlayerStreamersApi* | [**FetchPlayerStreamer**](docs/PlayerStreamersApi.md#fetchplayerstreamer) | **Get** /v1/PlayerStreamers/{Sid} | 
*PlayerStreamersApi* | [**ListPlayerStreamer**](docs/PlayerStreamersApi.md#listplayerstreamer) | **Get** /v1/PlayerStreamers | 
*PlayerStreamersApi* | [**UpdatePlayerStreamer**](docs/PlayerStreamersApi.md#updateplayerstreamer) | **Post** /v1/PlayerStreamers/{Sid} | 
*PlayerStreamersPlaybackGrantApi* | [**CreatePlayerStreamerPlaybackGrant**](docs/PlayerStreamersPlaybackGrantApi.md#createplayerstreamerplaybackgrant) | **Post** /v1/PlayerStreamers/{Sid}/PlaybackGrant | 
*PlayerStreamersPlaybackGrantApi* | [**FetchPlayerStreamerPlaybackGrant**](docs/PlayerStreamersPlaybackGrantApi.md#fetchplayerstreamerplaybackgrant) | **Get** /v1/PlayerStreamers/{Sid}/PlaybackGrant | 


## Documentation For Models

 - [MediaV1MediaProcessor](docs/MediaV1MediaProcessor.md)
 - [ListMediaProcessorResponseMeta](docs/ListMediaProcessorResponseMeta.md)
 - [MediaV1MediaRecording](docs/MediaV1MediaRecording.md)
 - [MediaV1PlayerStreamerPlaybackGrant](docs/MediaV1PlayerStreamerPlaybackGrant.md)
 - [ListPlayerStreamerResponse](docs/ListPlayerStreamerResponse.md)
 - [ListMediaRecordingResponse](docs/ListMediaRecordingResponse.md)
 - [ListMediaProcessorResponse](docs/ListMediaProcessorResponse.md)
 - [MediaV1PlayerStreamer](docs/MediaV1PlayerStreamer.md)


## Documentation For Authorization



## accountSid_authToken

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)
```