Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK README - api.video-go-client] The documentation repo becomes independent :) #187

Merged
merged 1 commit into from
Nov 21, 2023
Merged

[SDK README - api.video-go-client] The documentation repo becomes independent :) #187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 58 additions & 41 deletions sdks/api-clients/apivideo-go-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@
---
title: "Go API client"
slug: "go-api-client"
hidden: false
metadata:
description: "The official Go client for api.video. [api.video](https://api.video) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app."
title: Go API client
meta:
description: The official Go API client for api.video. [api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
---
<!--
THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!
IF YOU NEED TO CHANGE THIS FILE, CREATE A PR IN THE SOURCE REPOSITORY.
-->

Go API Client
==============
# api.video Go API client

# Getting started
[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

## Installation
## Project description

api.video's Go client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

## Getting started

### Installation
```bash
go get github.com/apivideo/api.video-go-client
```


## Code sample
### Code sample

For a more advanced usage you can checkout the rest of the documentation in the [docs directory](https://github.com/apivideo/api.video-go-client/tree/main/docs/)
For a more advanced usage you can checkout the rest of the documentation in the [docs directory](https://github.com/apivideo/api.video-go-client/blob/main/docs)

```golang
package main
Expand Down Expand Up @@ -88,40 +95,40 @@ func main() {
}
```

# Documentation
## Documentation

## API Endpoints
### API Endpoints

All URIs are relative to *https://ws.api.video*


### Analytics
#### Analytics


#### Retrieve an instance of the Analytics API:
##### Retrieve an instance of the Analytics API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
analyticsApi := client.Analytics
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
[**GetLiveStreamsPlays**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Analytics.md#GetLiveStreamsPlays) | **Get** /analytics/live-streams/plays | Get play events for live stream
[**GetVideosPlays**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Analytics.md#GetVideosPlays) | **Get** /analytics/videos/plays | Get play events for video


### Captions
#### Captions


#### Retrieve an instance of the Captions API:
##### Retrieve an instance of the Captions API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
captionsApi := client.Captions
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -132,16 +139,16 @@ Method | HTTP request | Description
[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Captions.md#List) | **Get** /videos/{videoId}/captions | List video captions


### Chapters
#### Chapters


#### Retrieve an instance of the Chapters API:
##### Retrieve an instance of the Chapters API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
chaptersApi := client.Chapters
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -151,16 +158,16 @@ Method | HTTP request | Description
[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Chapters.md#List) | **Get** /videos/{videoId}/chapters | List video chapters


### LiveStreams
#### LiveStreams


#### Retrieve an instance of the LiveStreams API:
##### Retrieve an instance of the LiveStreams API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
liveStreamsApi := client.LiveStreams
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -173,16 +180,16 @@ Method | HTTP request | Description
[**DeleteThumbnail**](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreams.md#DeleteThumbnail) | **Delete** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail


### PlayerThemes
#### PlayerThemes


#### Retrieve an instance of the PlayerThemes API:
##### Retrieve an instance of the PlayerThemes API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
playerThemesApi := client.PlayerThemes
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -195,16 +202,16 @@ Method | HTTP request | Description
[**DeleteLogo**](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemes.md#DeleteLogo) | **Delete** /players/{playerId}/logo | Delete logo


### UploadTokens
#### UploadTokens


#### Retrieve an instance of the UploadTokens API:
##### Retrieve an instance of the UploadTokens API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
uploadTokensApi := client.UploadTokens
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -214,16 +221,16 @@ Method | HTTP request | Description
[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokens.md#List) | **Get** /upload-tokens | List all active upload tokens


### Videos
#### Videos


#### Retrieve an instance of the Videos API:
##### Retrieve an instance of the Videos API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
videosApi := client.Videos
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -239,16 +246,16 @@ Method | HTTP request | Description
[**GetStatus**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#GetStatus) | **Get** /videos/{videoId}/status | Retrieve video status and details


### Watermarks
#### Watermarks


#### Retrieve an instance of the Watermarks API:
##### Retrieve an instance of the Watermarks API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
watermarksApi := client.Watermarks
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -257,16 +264,16 @@ Method | HTTP request | Description
[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Watermarks.md#List) | **Get** /watermarks | List all watermarks


### Webhooks
#### Webhooks


#### Retrieve an instance of the Webhooks API:
##### Retrieve an instance of the Webhooks API:
```golang
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
webhooksApi := client.Webhooks
```

#### Endpoints
##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -278,7 +285,7 @@ Method | HTTP request | Description



## Models
### Models

- [AccessToken](https://github.com/apivideo/api.video-go-client/blob/main/docs/AccessToken.md)
- [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-go-client/blob/main/docs/AdditionalBadRequestErrors.md)
Expand Down Expand Up @@ -353,3 +360,13 @@ Method | HTTP request | Description
- [WebhooksListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/WebhooksListResponse.md)



## Have you gotten use from this API client?

Please take a moment to leave a star on the client ⭐

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!

## Contribution

Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository.