-
Notifications
You must be signed in to change notification settings - Fork 542
/
captionlanguage.go
225 lines (192 loc) · 7.59 KB
/
captionlanguage.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package stream
import (
"context"
"fmt"
"net/http"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
"github.com/cloudflare/cloudflare-go/v2/shared"
)
// CaptionLanguageService contains methods and other services that help with
// interacting with the cloudflare API. Note, unlike clients, this service does not
// read variables from the environment automatically. You should not instantiate
// this service directly, and instead use the [NewCaptionLanguageService] method
// instead.
type CaptionLanguageService struct {
Options []option.RequestOption
Vtt *CaptionLanguageVttService
}
// NewCaptionLanguageService generates a new service that applies the given options
// to each request. These options are applied after the parent client's options (if
// there is one), and before any request-specific options.
func NewCaptionLanguageService(opts ...option.RequestOption) (r *CaptionLanguageService) {
r = &CaptionLanguageService{}
r.Options = opts
r.Vtt = NewCaptionLanguageVttService(opts...)
return
}
// Uploads the caption or subtitle file to the endpoint for a specific BCP47
// language. One caption or subtitle file per language is allowed.
func (r *CaptionLanguageService) Update(ctx context.Context, identifier string, language string, params CaptionLanguageUpdateParams, opts ...option.RequestOption) (res *Caption, err error) {
opts = append(r.Options[:], opts...)
var env CaptionLanguageUpdateResponseEnvelope
path := fmt.Sprintf("accounts/%s/stream/%s/captions/%s", params.AccountID, identifier, language)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPut, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Removes the captions or subtitles from a video.
func (r *CaptionLanguageService) Delete(ctx context.Context, identifier string, language string, body CaptionLanguageDeleteParams, opts ...option.RequestOption) (res *string, err error) {
opts = append(r.Options[:], opts...)
var env CaptionLanguageDeleteResponseEnvelope
path := fmt.Sprintf("accounts/%s/stream/%s/captions/%s", body.AccountID, identifier, language)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodDelete, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Lists the captions or subtitles for provided language.
func (r *CaptionLanguageService) Get(ctx context.Context, identifier string, language string, query CaptionLanguageGetParams, opts ...option.RequestOption) (res *Caption, err error) {
opts = append(r.Options[:], opts...)
var env CaptionLanguageGetResponseEnvelope
path := fmt.Sprintf("accounts/%s/stream/%s/captions/%s", query.AccountID, identifier, language)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type CaptionLanguageUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The WebVTT file containing the caption or subtitle content.
File param.Field[string] `json:"file,required"`
}
func (r CaptionLanguageUpdateParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type CaptionLanguageUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success CaptionLanguageUpdateResponseEnvelopeSuccess `json:"success,required"`
Result Caption `json:"result"`
JSON captionLanguageUpdateResponseEnvelopeJSON `json:"-"`
}
// captionLanguageUpdateResponseEnvelopeJSON contains the JSON metadata for the
// struct [CaptionLanguageUpdateResponseEnvelope]
type captionLanguageUpdateResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *CaptionLanguageUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r captionLanguageUpdateResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type CaptionLanguageUpdateResponseEnvelopeSuccess bool
const (
CaptionLanguageUpdateResponseEnvelopeSuccessTrue CaptionLanguageUpdateResponseEnvelopeSuccess = true
)
func (r CaptionLanguageUpdateResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case CaptionLanguageUpdateResponseEnvelopeSuccessTrue:
return true
}
return false
}
type CaptionLanguageDeleteParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
}
type CaptionLanguageDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success CaptionLanguageDeleteResponseEnvelopeSuccess `json:"success,required"`
Result string `json:"result"`
JSON captionLanguageDeleteResponseEnvelopeJSON `json:"-"`
}
// captionLanguageDeleteResponseEnvelopeJSON contains the JSON metadata for the
// struct [CaptionLanguageDeleteResponseEnvelope]
type captionLanguageDeleteResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *CaptionLanguageDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r captionLanguageDeleteResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type CaptionLanguageDeleteResponseEnvelopeSuccess bool
const (
CaptionLanguageDeleteResponseEnvelopeSuccessTrue CaptionLanguageDeleteResponseEnvelopeSuccess = true
)
func (r CaptionLanguageDeleteResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case CaptionLanguageDeleteResponseEnvelopeSuccessTrue:
return true
}
return false
}
type CaptionLanguageGetParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
}
type CaptionLanguageGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success CaptionLanguageGetResponseEnvelopeSuccess `json:"success,required"`
Result Caption `json:"result"`
JSON captionLanguageGetResponseEnvelopeJSON `json:"-"`
}
// captionLanguageGetResponseEnvelopeJSON contains the JSON metadata for the struct
// [CaptionLanguageGetResponseEnvelope]
type captionLanguageGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *CaptionLanguageGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r captionLanguageGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type CaptionLanguageGetResponseEnvelopeSuccess bool
const (
CaptionLanguageGetResponseEnvelopeSuccessTrue CaptionLanguageGetResponseEnvelopeSuccess = true
)
func (r CaptionLanguageGetResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case CaptionLanguageGetResponseEnvelopeSuccessTrue:
return true
}
return false
}