-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathbetav2file.go
More file actions
641 lines (603 loc) · 26.7 KB
/
betav2file.go
File metadata and controls
641 lines (603 loc) · 26.7 KB
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package imagekit
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"mime/multipart"
"net/http"
"slices"
"strings"
"github.com/imagekit-developer/imagekit-go/v2/internal/apiform"
"github.com/imagekit-developer/imagekit-go/v2/internal/apijson"
"github.com/imagekit-developer/imagekit-go/v2/internal/requestconfig"
"github.com/imagekit-developer/imagekit-go/v2/option"
"github.com/imagekit-developer/imagekit-go/v2/packages/param"
"github.com/imagekit-developer/imagekit-go/v2/packages/respjson"
"github.com/imagekit-developer/imagekit-go/v2/shared"
"github.com/imagekit-developer/imagekit-go/v2/shared/constant"
)
// BetaV2FileService contains methods and other services that help with interacting
// with the ImageKit 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 [NewBetaV2FileService] method instead.
type BetaV2FileService struct {
Options []option.RequestOption
}
// NewBetaV2FileService 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 NewBetaV2FileService(opts ...option.RequestOption) (r BetaV2FileService) {
r = BetaV2FileService{}
r.Options = opts
return
}
// The V2 API enhances security by verifying the entire payload using JWT. This API
// is in beta.
//
// ImageKit.io allows you to upload files directly from both the server and client
// sides. For server-side uploads, private API key authentication is used. For
// client-side uploads, generate a one-time `token` from your secure backend using
// private API.
// [Learn more](/docs/api-reference/upload-file/upload-file-v2#how-to-implement-secure-client-side-file-upload)
// about how to implement secure client-side file upload.
//
// **File size limit** \
// On the free plan, the maximum upload file sizes are 25MB for images, audio, and raw
// files, and 100MB for videos. On the Lite paid plan, these limits increase to 40MB
// for images, audio, and raw files and 300MB for videos, whereas on the Pro paid plan,
// these limits increase to 50MB for images, audio, and raw files and 2GB for videos.
// These limits can be further increased with enterprise plans.
//
// **Version limit** \
// A file can have a maximum of 100 versions.
//
// **Demo applications**
//
// - A full-fledged
// [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader),
// supporting file selections from local storage, URL, Dropbox, Google Drive,
// Instagram, and more.
// - [Quick start guides](/docs/quick-start-guides) for various frameworks and
// technologies.
func (r *BetaV2FileService) Upload(ctx context.Context, body BetaV2FileUploadParams, opts ...option.RequestOption) (res *BetaV2FileUploadResponse, err error) {
opts = slices.Concat(r.Options, opts)
opts = append([]option.RequestOption{option.WithBaseURL("https://upload.imagekit.io/")}, opts...)
path := "api/v2/files/upload"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Object containing details of a successful upload.
type BetaV2FileUploadResponse struct {
// An array of tags assigned to the uploaded file by auto tagging.
AITags []shared.AITag `json:"AITags" api:"nullable"`
// The audio codec used in the video (only for video).
AudioCodec string `json:"audioCodec"`
// The bit rate of the video in kbps (only for video).
BitRate int64 `json:"bitRate"`
// Value of custom coordinates associated with the image in the format
// `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`.
// Send `customCoordinates` in `responseFields` in API request to get the value of
// this field.
CustomCoordinates string `json:"customCoordinates" api:"nullable"`
// A key-value data associated with the asset. Use `responseField` in API request
// to get `customMetadata` in the upload API response. Before setting any custom
// metadata on an asset, you have to create the field using custom metadata fields
// API. Send `customMetadata` in `responseFields` in API request to get the value
// of this field.
CustomMetadata shared.CustomMetadata `json:"customMetadata"`
// Optional text to describe the contents of the file. Can be set by the user or
// the ai-auto-description extension.
Description string `json:"description"`
// The duration of the video in seconds (only for video).
Duration int64 `json:"duration"`
// Consolidated embedded metadata associated with the file. It includes exif, iptc,
// and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get
// embeddedMetadata in the upload API response.
EmbeddedMetadata shared.EmbeddedMetadata `json:"embeddedMetadata"`
// Extension names with their processing status at the time of completion of the
// request. It could have one of the following status values:
//
// `success`: The extension has been successfully applied. `failed`: The extension
// has failed and will not be retried. `pending`: The extension will finish
// processing in some time. On completion, the final status (success / failed) will
// be sent to the `webhookUrl` provided.
//
// If no extension was requested, then this parameter is not returned.
ExtensionStatus BetaV2FileUploadResponseExtensionStatus `json:"extensionStatus"`
// Unique fileId. Store this fileld in your database, as this will be used to
// perform update action on this file.
FileID string `json:"fileId"`
// The relative path of the file in the media library e.g.
// `/marketing-assets/new-banner.jpg`.
FilePath string `json:"filePath"`
// Type of the uploaded file. Possible values are `image`, `non-image`.
FileType string `json:"fileType"`
// Height of the image in pixels (Only for images)
Height float64 `json:"height"`
// Is the file marked as private. It can be either `true` or `false`. Send
// `isPrivateFile` in `responseFields` in API request to get the value of this
// field.
IsPrivateFile bool `json:"isPrivateFile"`
// Is the file published or in draft state. It can be either `true` or `false`.
// Send `isPublished` in `responseFields` in API request to get the value of this
// field.
IsPublished bool `json:"isPublished"`
// Legacy metadata. Send `metadata` in `responseFields` in API request to get
// metadata in the upload API response.
Metadata Metadata `json:"metadata"`
// Name of the asset.
Name string `json:"name"`
// This field is included in the response only if the Path policy feature is
// available in the plan. It contains schema definitions for the custom metadata
// fields selected for the specified file path. Field selection can only be done
// when the Path policy feature is enabled.
//
// Keys are the names of the custom metadata fields; the value object has details
// about the custom metadata schema.
SelectedFieldsSchema shared.SelectedFieldsSchema `json:"selectedFieldsSchema"`
// Size of the image file in Bytes.
Size float64 `json:"size"`
// The array of tags associated with the asset. If no tags are set, it will be
// `null`. Send `tags` in `responseFields` in API request to get the value of this
// field.
Tags []string `json:"tags" api:"nullable"`
// In the case of an image, a small thumbnail URL.
ThumbnailURL string `json:"thumbnailUrl"`
// A publicly accessible URL of the file.
URL string `json:"url"`
// An object containing the file or file version's `id` (versionId) and `name`.
VersionInfo shared.VersionInfo `json:"versionInfo"`
// The video codec used in the video (only for video).
VideoCodec string `json:"videoCodec"`
// Width of the image in pixels (Only for Images)
Width float64 `json:"width"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
AITags respjson.Field
AudioCodec respjson.Field
BitRate respjson.Field
CustomCoordinates respjson.Field
CustomMetadata respjson.Field
Description respjson.Field
Duration respjson.Field
EmbeddedMetadata respjson.Field
ExtensionStatus respjson.Field
FileID respjson.Field
FilePath respjson.Field
FileType respjson.Field
Height respjson.Field
IsPrivateFile respjson.Field
IsPublished respjson.Field
Metadata respjson.Field
Name respjson.Field
SelectedFieldsSchema respjson.Field
Size respjson.Field
Tags respjson.Field
ThumbnailURL respjson.Field
URL respjson.Field
VersionInfo respjson.Field
VideoCodec respjson.Field
Width respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r BetaV2FileUploadResponse) RawJSON() string { return r.JSON.raw }
func (r *BetaV2FileUploadResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Extension names with their processing status at the time of completion of the
// request. It could have one of the following status values:
//
// `success`: The extension has been successfully applied. `failed`: The extension
// has failed and will not be retried. `pending`: The extension will finish
// processing in some time. On completion, the final status (success / failed) will
// be sent to the `webhookUrl` provided.
//
// If no extension was requested, then this parameter is not returned.
type BetaV2FileUploadResponseExtensionStatus struct {
// Any of "success", "pending", "failed".
AIAutoDescription string `json:"ai-auto-description"`
// Any of "success", "pending", "failed".
AITasks string `json:"ai-tasks"`
// Any of "success", "pending", "failed".
AwsAutoTagging string `json:"aws-auto-tagging"`
// Any of "success", "pending", "failed".
GoogleAutoTagging string `json:"google-auto-tagging"`
// Any of "success", "pending", "failed".
RemoveBg string `json:"remove-bg"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
AIAutoDescription respjson.Field
AITasks respjson.Field
AwsAutoTagging respjson.Field
GoogleAutoTagging respjson.Field
RemoveBg respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r BetaV2FileUploadResponseExtensionStatus) RawJSON() string { return r.JSON.raw }
func (r *BetaV2FileUploadResponseExtensionStatus) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type BetaV2FileUploadParams struct {
// File is the upload payload. It MUST be a non-nil io.Reader (e.g., *os.File,
// *bytes.Reader, *bytes.Buffer, *strings.Reader, or any stream).
File io.Reader `json:"file,omitzero,required" format:"binary"`
// The name with which the file has to be uploaded.
FileName string `json:"fileName" api:"required"`
// This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses
// it to authenticate and check that the upload request parameters have not been
// tampered with after the token has been generated. Learn how to create the token
// on the page below. This field is only required for authentication when uploading
// a file from the client side.
//
// **Note**: Sending a JWT that has been used in the past will result in a
// validation error. Even if your previous request resulted in an error, you should
// always send a new token.
//
// **⚠️Warning**: JWT must be generated on the server-side because it is generated
// using your account's private API key. This field is required for authentication
// when uploading a file from the client-side.
Token param.Opt[string] `json:"token,omitzero"`
// Server-side checks to run on the asset. Read more about
// [Upload API checks](/docs/api-reference/upload-file/upload-file-v2#upload-api-checks).
Checks param.Opt[string] `json:"checks,omitzero"`
// Define an important area in the image. This is only relevant for image type
// files.
//
// - To be passed as a string with the x and y coordinates of the top-left corner,
// and width and height of the area of interest in the format `x,y,width,height`.
// For example - `10,10,100,100`
// - Can be used with fo-customtransformation.
// - If this field is not specified and the file is overwritten, then
// customCoordinates will be removed.
CustomCoordinates param.Opt[string] `json:"customCoordinates,omitzero"`
// Optional text to describe the contents of the file.
Description param.Opt[string] `json:"description,omitzero"`
// The folder path in which the image has to be uploaded. If the folder(s) didn't
// exist before, a new folder(s) is created. Using multiple `/` creates a nested
// folder.
Folder param.Opt[string] `json:"folder,omitzero"`
// Whether to mark the file as private or not.
//
// If `true`, the file is marked as private and is accessible only using named
// transformation or signed URL.
IsPrivateFile param.Opt[bool] `json:"isPrivateFile,omitzero"`
// Whether to upload file as published or not.
//
// If `false`, the file is marked as unpublished, which restricts access to the
// file only via the media library. Files in draft or unpublished state can only be
// publicly accessed after being published.
//
// The option to upload in draft state is only available in custom enterprise
// pricing plans.
IsPublished param.Opt[bool] `json:"isPublished,omitzero"`
// If set to `true` and a file already exists at the exact location, its AITags
// will be removed. Set `overwriteAITags` to `false` to preserve AITags.
OverwriteAITags param.Opt[bool] `json:"overwriteAITags,omitzero"`
// If the request does not have `customMetadata`, and a file already exists at the
// exact location, existing customMetadata will be removed.
OverwriteCustomMetadata param.Opt[bool] `json:"overwriteCustomMetadata,omitzero"`
// If `false` and `useUniqueFileName` is also `false`, and a file already exists at
// the exact location, upload API will return an error immediately.
OverwriteFile param.Opt[bool] `json:"overwriteFile,omitzero"`
// If the request does not have `tags`, and a file already exists at the exact
// location, existing tags will be removed.
OverwriteTags param.Opt[bool] `json:"overwriteTags,omitzero"`
// Whether to use a unique filename for this file or not.
//
// If `true`, ImageKit.io will add a unique suffix to the filename parameter to get
// a unique filename.
//
// If `false`, then the image is uploaded with the provided filename parameter, and
// any existing file with the same name is replaced.
UseUniqueFileName param.Opt[bool] `json:"useUniqueFileName,omitzero"`
// The final status of extensions after they have completed execution will be
// delivered to this endpoint as a POST request.
// [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure)
// about the webhook payload structure.
WebhookURL param.Opt[string] `json:"webhookUrl,omitzero" format:"uri"`
// JSON key-value pairs to associate with the asset. Create the custom metadata
// fields before setting these values.
CustomMetadata map[string]any `json:"customMetadata,omitzero"`
// Array of extensions to be applied to the asset. Each extension can be configured
// with specific parameters based on the extension type.
Extensions shared.ExtensionsParam `json:"extensions,omitzero"`
// Array of response field keys to include in the API response body.
//
// Any of "tags", "customCoordinates", "isPrivateFile", "embeddedMetadata",
// "isPublished", "customMetadata", "metadata", "selectedFieldsSchema".
ResponseFields []string `json:"responseFields,omitzero"`
// Set the tags while uploading the file. Provide an array of tag strings (e.g.
// `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not
// exceed 500, and the `%` character is not allowed. If this field is not specified
// and the file is overwritten, the existing tags will be removed.
Tags []string `json:"tags,omitzero"`
// Configure pre-processing (`pre`) and post-processing (`post`) transformations.
//
// - `pre` — applied before the file is uploaded to the Media Library.
// Useful for reducing file size or applying basic optimizations upfront (e.g.,
// resize, compress).
//
// - `post` — applied immediately after upload.
// Ideal for generating transformed versions (like video encodes or thumbnails)
// in advance, so they're ready for delivery without delay.
//
// You can mix and match any combination of post-processing types.
Transformation BetaV2FileUploadParamsTransformation `json:"transformation,omitzero"`
paramObj
}
func (r BetaV2FileUploadParams) MarshalMultipart() (data []byte, contentType string, err error) {
buf := bytes.NewBuffer(nil)
writer := multipart.NewWriter(buf)
// Convert tags array to comma-separated string
if len(r.Tags) > 0 {
tagsStr := strings.Join(r.Tags, ",")
err = writer.WriteField("tags", tagsStr)
if err != nil {
writer.Close()
return nil, "", err
}
}
// Convert responseFields array to comma-separated string
if len(r.ResponseFields) > 0 {
responseFieldsStr := strings.Join(r.ResponseFields, ",")
err = writer.WriteField("responseFields", responseFieldsStr)
if err != nil {
writer.Close()
return nil, "", err
}
}
// Convert extensions array to JSON string
if len(r.Extensions) > 0 {
extensionsJSON, jsonErr := json.Marshal(r.Extensions)
if jsonErr != nil {
writer.Close()
return nil, "", fmt.Errorf("failed to marshal extensions: %w", jsonErr)
}
err = writer.WriteField("extensions", string(extensionsJSON))
if err != nil {
writer.Close()
return nil, "", err
}
}
// Convert customMetadata object to JSON string
if len(r.CustomMetadata) > 0 {
customMetadataJSON, jsonErr := json.Marshal(r.CustomMetadata)
if jsonErr != nil {
writer.Close()
return nil, "", fmt.Errorf("failed to marshal customMetadata: %w", jsonErr)
}
err = writer.WriteField("customMetadata", string(customMetadataJSON))
if err != nil {
writer.Close()
return nil, "", err
}
}
// Convert transformation object to JSON string
// Check if transformation has any non-zero values
hasTransformation := false
if r.Transformation.Pre.Valid() || len(r.Transformation.Post) > 0 {
hasTransformation = true
}
if hasTransformation {
transformationJSON, jsonErr := json.Marshal(r.Transformation)
if jsonErr != nil {
writer.Close()
return nil, "", fmt.Errorf("failed to marshal transformation: %w", jsonErr)
}
err = writer.WriteField("transformation", string(transformationJSON))
if err != nil {
writer.Close()
return nil, "", err
}
}
// Create a copy of the params without the fields we've already handled to avoid double marshaling
rCopy := r
rCopy.Tags = nil
rCopy.ResponseFields = nil
rCopy.Extensions = nil
rCopy.CustomMetadata = nil
// Reset transformation to empty
rCopy.Transformation = BetaV2FileUploadParamsTransformation{}
err = apiform.MarshalRoot(rCopy, writer)
if err == nil {
err = apiform.WriteExtras(writer, r.ExtraFields())
}
if err != nil {
writer.Close()
return nil, "", err
}
err = writer.Close()
if err != nil {
return nil, "", err
}
return buf.Bytes(), writer.FormDataContentType(), nil
}
// Configure pre-processing (`pre`) and post-processing (`post`) transformations.
//
// - `pre` — applied before the file is uploaded to the Media Library.
// Useful for reducing file size or applying basic optimizations upfront (e.g.,
// resize, compress).
//
// - `post` — applied immediately after upload.
// Ideal for generating transformed versions (like video encodes or thumbnails)
// in advance, so they're ready for delivery without delay.
//
// You can mix and match any combination of post-processing types.
type BetaV2FileUploadParamsTransformation struct {
// Transformation string to apply before uploading the file to the Media Library.
// Useful for optimizing files at ingestion.
Pre param.Opt[string] `json:"pre,omitzero"`
// List of transformations to apply _after_ the file is uploaded.
// Each item must match one of the following types: `transformation`,
// `gif-to-video`, `thumbnail`, `abs`.
Post []BetaV2FileUploadParamsTransformationPostUnion `json:"post,omitzero"`
paramObj
}
func (r BetaV2FileUploadParamsTransformation) MarshalJSON() (data []byte, err error) {
type shadow BetaV2FileUploadParamsTransformation
return param.MarshalObject(r, (*shadow)(&r))
}
func (r *BetaV2FileUploadParamsTransformation) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Only one field can be non-zero.
//
// Use [param.IsOmitted] to confirm if a field is set.
type BetaV2FileUploadParamsTransformationPostUnion struct {
OfTransformation *BetaV2FileUploadParamsTransformationPostTransformation `json:",omitzero,inline"`
OfGifToVideo *BetaV2FileUploadParamsTransformationPostGifToVideo `json:",omitzero,inline"`
OfThumbnail *BetaV2FileUploadParamsTransformationPostThumbnail `json:",omitzero,inline"`
OfAbs *BetaV2FileUploadParamsTransformationPostAbs `json:",omitzero,inline"`
paramUnion
}
func (u BetaV2FileUploadParamsTransformationPostUnion) MarshalJSON() ([]byte, error) {
return param.MarshalUnion(u, u.OfTransformation, u.OfGifToVideo, u.OfThumbnail, u.OfAbs)
}
func (u *BetaV2FileUploadParamsTransformationPostUnion) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, u)
}
func (u *BetaV2FileUploadParamsTransformationPostUnion) asAny() any {
if !param.IsOmitted(u.OfTransformation) {
return u.OfTransformation
} else if !param.IsOmitted(u.OfGifToVideo) {
return u.OfGifToVideo
} else if !param.IsOmitted(u.OfThumbnail) {
return u.OfThumbnail
} else if !param.IsOmitted(u.OfAbs) {
return u.OfAbs
}
return nil
}
// Returns a pointer to the underlying variant's property, if present.
func (u BetaV2FileUploadParamsTransformationPostUnion) GetProtocol() *string {
if vt := u.OfAbs; vt != nil {
return &vt.Protocol
}
return nil
}
// Returns a pointer to the underlying variant's property, if present.
func (u BetaV2FileUploadParamsTransformationPostUnion) GetType() *string {
if vt := u.OfTransformation; vt != nil {
return (*string)(&vt.Type)
} else if vt := u.OfGifToVideo; vt != nil {
return (*string)(&vt.Type)
} else if vt := u.OfThumbnail; vt != nil {
return (*string)(&vt.Type)
} else if vt := u.OfAbs; vt != nil {
return (*string)(&vt.Type)
}
return nil
}
// Returns a pointer to the underlying variant's property, if present.
func (u BetaV2FileUploadParamsTransformationPostUnion) GetValue() *string {
if vt := u.OfTransformation; vt != nil {
return (*string)(&vt.Value)
} else if vt := u.OfGifToVideo; vt != nil && vt.Value.Valid() {
return &vt.Value.Value
} else if vt := u.OfThumbnail; vt != nil && vt.Value.Valid() {
return &vt.Value.Value
} else if vt := u.OfAbs; vt != nil {
return (*string)(&vt.Value)
}
return nil
}
func init() {
apijson.RegisterUnion[BetaV2FileUploadParamsTransformationPostUnion](
"type",
apijson.Discriminator[BetaV2FileUploadParamsTransformationPostTransformation]("transformation"),
apijson.Discriminator[BetaV2FileUploadParamsTransformationPostGifToVideo]("gif-to-video"),
apijson.Discriminator[BetaV2FileUploadParamsTransformationPostThumbnail]("thumbnail"),
apijson.Discriminator[BetaV2FileUploadParamsTransformationPostAbs]("abs"),
)
}
func init() {
apijson.RegisterFieldValidator[BetaV2FileUploadParamsTransformationPostAbs](
"protocol", "hls", "dash",
)
}
// The properties Type, Value are required.
type BetaV2FileUploadParamsTransformationPostTransformation struct {
// Transformation string (e.g. `w-200,h-200`).
// Same syntax as ImageKit URL-based transformations.
Value string `json:"value" api:"required"`
// Transformation type.
//
// This field can be elided, and will marshal its zero value as "transformation".
Type constant.Transformation `json:"type" default:"transformation"`
paramObj
}
func (r BetaV2FileUploadParamsTransformationPostTransformation) MarshalJSON() (data []byte, err error) {
type shadow BetaV2FileUploadParamsTransformationPostTransformation
return param.MarshalObject(r, (*shadow)(&r))
}
func (r *BetaV2FileUploadParamsTransformationPostTransformation) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// The property Type is required.
type BetaV2FileUploadParamsTransformationPostGifToVideo struct {
// Optional transformation string to apply to the output video.
// **Example**: `q-80`
Value param.Opt[string] `json:"value,omitzero"`
// Converts an animated GIF into an MP4.
//
// This field can be elided, and will marshal its zero value as "gif-to-video".
Type constant.GifToVideo `json:"type" default:"gif-to-video"`
paramObj
}
func (r BetaV2FileUploadParamsTransformationPostGifToVideo) MarshalJSON() (data []byte, err error) {
type shadow BetaV2FileUploadParamsTransformationPostGifToVideo
return param.MarshalObject(r, (*shadow)(&r))
}
func (r *BetaV2FileUploadParamsTransformationPostGifToVideo) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// The property Type is required.
type BetaV2FileUploadParamsTransformationPostThumbnail struct {
// Optional transformation string.
// **Example**: `w-150,h-150`
Value param.Opt[string] `json:"value,omitzero"`
// Generates a thumbnail image.
//
// This field can be elided, and will marshal its zero value as "thumbnail".
Type constant.Thumbnail `json:"type" default:"thumbnail"`
paramObj
}
func (r BetaV2FileUploadParamsTransformationPostThumbnail) MarshalJSON() (data []byte, err error) {
type shadow BetaV2FileUploadParamsTransformationPostThumbnail
return param.MarshalObject(r, (*shadow)(&r))
}
func (r *BetaV2FileUploadParamsTransformationPostThumbnail) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// The properties Protocol, Type, Value are required.
type BetaV2FileUploadParamsTransformationPostAbs struct {
// Streaming protocol to use (`hls` or `dash`).
//
// Any of "hls", "dash".
Protocol string `json:"protocol,omitzero" api:"required"`
// List of different representations you want to create separated by an underscore.
Value string `json:"value" api:"required"`
// Adaptive Bitrate Streaming (ABS) setup.
//
// This field can be elided, and will marshal its zero value as "abs".
Type constant.Abs `json:"type" default:"abs"`
paramObj
}
func (r BetaV2FileUploadParamsTransformationPostAbs) MarshalJSON() (data []byte, err error) {
type shadow BetaV2FileUploadParamsTransformationPostAbs
return param.MarshalObject(r, (*shadow)(&r))
}
func (r *BetaV2FileUploadParamsTransformationPostAbs) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}