-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypes.py
More file actions
1129 lines (829 loc) · 35.4 KB
/
Copy pathtypes.py
File metadata and controls
1129 lines (829 loc) · 35.4 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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Type definitions for Stack0 CDN API
"""
from __future__ import annotations
from datetime import datetime
from typing import Any, Literal
from pydantic import BaseModel, ConfigDict, Field
# Asset types
AssetStatus = Literal["pending", "processing", "ready", "failed", "deleted"]
AssetType = Literal["image", "video", "audio", "document", "other"]
class Asset(BaseModel):
"""CDN asset"""
model_config = ConfigDict(populate_by_name=True)
id: str
filename: str
original_filename: str = Field(alias="originalFilename")
mime_type: str = Field(alias="mimeType")
size: int
type: AssetType
s3_key: str = Field(alias="s3Key")
cdn_url: str = Field(alias="cdnUrl")
width: int | None = None
height: int | None = None
duration: float | None = None
status: AssetStatus
folder: str | None = None
tags: list[str] | None = None
metadata: dict[str, Any] | None = None
alt: str | None = None
created_at: datetime = Field(alias="createdAt")
updated_at: datetime | None = Field(default=None, alias="updatedAt")
# Image watermark types
ImageWatermarkPosition = Literal[
"top-left", "top-center", "top-right",
"center-left", "center", "center-right",
"bottom-left", "bottom-center", "bottom-right"
]
ImageWatermarkSizingMode = Literal["absolute", "relative"]
class ImageWatermarkConfig(BaseModel):
"""Configuration for applying a watermark to an uploaded image"""
model_config = ConfigDict(populate_by_name=True)
asset_id: str | None = Field(default=None, alias="assetId")
url: str | None = None
position: ImageWatermarkPosition | None = None
offset_x: int | None = Field(default=None, alias="offsetX")
offset_y: int | None = Field(default=None, alias="offsetY")
sizing_mode: ImageWatermarkSizingMode | None = Field(default=None, alias="sizingMode")
width: int | None = None
height: int | None = None
opacity: int | None = None
rotation: int | None = None
tile: bool | None = None
tile_spacing: int | None = Field(default=None, alias="tileSpacing")
border_radius: int | None = Field(default=None, alias="borderRadius")
class UploadUrlRequest(BaseModel):
"""Request to get upload URL"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
filename: str
mime_type: str = Field(alias="mimeType")
size: int
folder: str | None = None
metadata: dict[str, Any] | None = None
watermark: ImageWatermarkConfig | None = None
class UploadUrlResponse(BaseModel):
"""Response with upload URL"""
model_config = ConfigDict(populate_by_name=True)
upload_url: str = Field(alias="uploadUrl")
asset_id: str = Field(alias="assetId")
cdn_url: str = Field(alias="cdnUrl")
expires_at: datetime = Field(alias="expiresAt")
class UpdateAssetRequest(BaseModel):
"""Request to update asset"""
model_config = ConfigDict(populate_by_name=True)
id: str
filename: str | None = None
folder: str | None = None
tags: list[str] | None = None
alt: str | None = None
metadata: dict[str, Any] | None = None
class DeleteAssetsResponse(BaseModel):
"""Response from deleting multiple assets"""
model_config = ConfigDict(populate_by_name=True)
success: bool
deleted_count: int = Field(alias="deletedCount")
class ListAssetsRequest(BaseModel):
"""Request to list assets"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
folder: str | None = None
type: AssetType | None = None
status: AssetStatus | None = None
search: str | None = None
tags: list[str] | None = None
sort_by: Literal["createdAt", "filename", "size", "type"] | None = Field(default=None, alias="sortBy")
sort_order: Literal["asc", "desc"] | None = Field(default=None, alias="sortOrder")
limit: int | None = None
offset: int | None = None
class ListAssetsResponse(BaseModel):
"""Response from listing assets"""
model_config = ConfigDict(populate_by_name=True)
assets: list[Asset]
total: int
has_more: bool = Field(alias="hasMore")
class MoveAssetsRequest(BaseModel):
"""Request to move assets"""
model_config = ConfigDict(populate_by_name=True)
asset_ids: list[str] = Field(alias="assetIds")
folder: str | None
class MoveAssetsResponse(BaseModel):
"""Response from moving assets"""
model_config = ConfigDict(populate_by_name=True)
success: bool
moved_count: int = Field(alias="movedCount")
class TransformOptions(BaseModel):
"""Image transformation options"""
model_config = ConfigDict(populate_by_name=True)
width: int | None = None
height: int | None = None
fit: Literal["cover", "contain", "fill", "inside", "outside"] | None = None
format: Literal["webp", "jpeg", "png", "avif", "auto"] | None = None
quality: int | None = None
crop: Literal["attention", "entropy", "center", "top", "bottom", "left", "right"] | None = None
crop_x: int | None = Field(default=None, alias="cropX")
crop_y: int | None = Field(default=None, alias="cropY")
crop_width: int | None = Field(default=None, alias="cropWidth")
crop_height: int | None = Field(default=None, alias="cropHeight")
blur: float | None = None
sharpen: float | None = None
brightness: int | None = None
saturation: int | None = None
grayscale: bool | None = None
rotate: int | None = None
flip: bool | None = None
flop: bool | None = None
# Folder types
class FolderTreeNode(BaseModel):
"""Folder tree node"""
model_config = ConfigDict(populate_by_name=True)
id: str
name: str
path: str
asset_count: int = Field(alias="assetCount")
children: list[FolderTreeNode]
class Folder(BaseModel):
"""Folder"""
model_config = ConfigDict(populate_by_name=True)
id: str
name: str
path: str
parent_id: str | None = Field(default=None, alias="parentId")
asset_count: int = Field(alias="assetCount")
total_size: int = Field(alias="totalSize")
created_at: datetime = Field(alias="createdAt")
updated_at: datetime | None = Field(default=None, alias="updatedAt")
class GetFolderTreeRequest(BaseModel):
"""Request to get folder tree"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
max_depth: int | None = Field(default=None, alias="maxDepth")
class CreateFolderRequest(BaseModel):
"""Request to create folder"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
name: str
parent_id: str | None = Field(default=None, alias="parentId")
class UpdateFolderRequest(BaseModel):
"""Request to update folder"""
model_config = ConfigDict(populate_by_name=True)
id: str
name: str | None = None
class ListFoldersRequest(BaseModel):
"""Request to list folders"""
model_config = ConfigDict(populate_by_name=True)
parent_id: str | None = Field(default=None, alias="parentId")
limit: int | None = None
offset: int | None = None
search: str | None = None
class FolderListItem(BaseModel):
"""Folder list item"""
model_config = ConfigDict(populate_by_name=True)
id: str
name: str
path: str
parent_id: str | None = Field(default=None, alias="parentId")
asset_count: int = Field(alias="assetCount")
total_size: int = Field(alias="totalSize")
created_at: datetime = Field(alias="createdAt")
class ListFoldersResponse(BaseModel):
"""Response from listing folders"""
model_config = ConfigDict(populate_by_name=True)
folders: list[FolderListItem]
total: int
has_more: bool = Field(alias="hasMore")
class MoveFolderRequest(BaseModel):
"""Request to move folder"""
model_config = ConfigDict(populate_by_name=True)
id: str
new_parent_id: str | None = Field(alias="newParentId")
class MoveFolderResponse(BaseModel):
"""Response from moving folder"""
model_config = ConfigDict(populate_by_name=True)
success: bool
# Video transcoding types
VideoQuality = Literal["360p", "480p", "720p", "1080p", "1440p", "2160p"]
VideoCodec = Literal["h264", "h265"]
VideoOutputFormat = Literal["hls", "mp4"]
TranscodingStatus = Literal["pending", "queued", "processing", "completed", "failed", "cancelled"]
class VideoVariant(BaseModel):
"""Video variant configuration"""
model_config = ConfigDict(populate_by_name=True)
quality: VideoQuality
codec: VideoCodec | None = None
bitrate: int | None = None
class WatermarkOptions(BaseModel):
"""Video watermark options"""
model_config = ConfigDict(populate_by_name=True)
type: Literal["image", "text"]
image_asset_id: str | None = Field(default=None, alias="imageAssetId")
text: str | None = None
position: Literal["top-left", "top-right", "bottom-left", "bottom-right", "center"]
opacity: float | None = None
class TrimOptions(BaseModel):
"""Video trim options"""
model_config = ConfigDict(populate_by_name=True)
start: float
end: float
class TranscodeVideoRequest(BaseModel):
"""Request to transcode video"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
asset_id: str = Field(alias="assetId")
output_format: VideoOutputFormat = Field(alias="outputFormat")
variants: list[VideoVariant]
watermark: WatermarkOptions | None = None
trim: TrimOptions | None = None
webhook_url: str | None = Field(default=None, alias="webhookUrl")
class TranscodeJob(BaseModel):
"""Transcode job"""
model_config = ConfigDict(populate_by_name=True)
id: str
asset_id: str = Field(alias="assetId")
status: TranscodingStatus
output_format: VideoOutputFormat = Field(alias="outputFormat")
variants: list[VideoVariant]
progress: int | None = None
error: str | None = None
media_convert_job_id: str | None = Field(default=None, alias="mediaConvertJobId")
created_at: datetime = Field(alias="createdAt")
started_at: datetime | None = Field(default=None, alias="startedAt")
completed_at: datetime | None = Field(default=None, alias="completedAt")
class ListJobsRequest(BaseModel):
"""Request to list transcode jobs"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
asset_id: str | None = Field(default=None, alias="assetId")
status: TranscodingStatus | None = None
limit: int | None = None
offset: int | None = None
class ListJobsResponse(BaseModel):
"""Response from listing transcode jobs"""
model_config = ConfigDict(populate_by_name=True)
jobs: list[TranscodeJob]
total: int
has_more: bool = Field(alias="hasMore")
class Mp4Url(BaseModel):
"""MP4 URL with quality"""
model_config = ConfigDict(populate_by_name=True)
quality: VideoQuality
url: str
class VideoThumbnailInfo(BaseModel):
"""Video thumbnail info"""
model_config = ConfigDict(populate_by_name=True)
url: str
timestamp: float
width: int
height: int
class StreamingUrls(BaseModel):
"""Streaming URLs"""
model_config = ConfigDict(populate_by_name=True)
hls_url: str | None = Field(default=None, alias="hlsUrl")
mp4_urls: list[Mp4Url] = Field(alias="mp4Urls")
thumbnails: list[VideoThumbnailInfo]
class ThumbnailRequest(BaseModel):
"""Request to get thumbnail"""
model_config = ConfigDict(populate_by_name=True)
asset_id: str = Field(alias="assetId")
timestamp: float
width: int | None = None
format: Literal["jpg", "png", "webp"] | None = None
class ThumbnailResponse(BaseModel):
"""Thumbnail response"""
model_config = ConfigDict(populate_by_name=True)
url: str
timestamp: float
width: int
height: int
class RegenerateThumbnailRequest(BaseModel):
"""Request to regenerate thumbnail"""
model_config = ConfigDict(populate_by_name=True)
asset_id: str = Field(alias="assetId")
timestamp: float
width: int | None = None
format: Literal["jpg", "png", "webp"] | None = None
class RegenerateThumbnailResponse(BaseModel):
"""Regenerate thumbnail response"""
model_config = ConfigDict(populate_by_name=True)
id: str | None = None
asset_id: str = Field(alias="assetId")
timestamp: float
url: str | None = None
width: int | None = None
height: int | None = None
format: str
status: str | None = None
class ExtractAudioRequest(BaseModel):
"""Request to extract audio"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
asset_id: str = Field(alias="assetId")
format: Literal["mp3", "aac", "wav"]
bitrate: int | None = None
class ExtractAudioResponse(BaseModel):
"""Extract audio response"""
model_config = ConfigDict(populate_by_name=True)
job_id: str = Field(alias="jobId")
status: TranscodingStatus
# GIF types
GifStatus = Literal["pending", "processing", "completed", "failed"]
class GenerateGifRequest(BaseModel):
"""Request to generate GIF"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
asset_id: str = Field(alias="assetId")
start_time: float | None = Field(default=None, alias="startTime")
duration: float | None = None
width: int | None = None
fps: int | None = None
optimize_palette: bool | None = Field(default=None, alias="optimizePalette")
class VideoGif(BaseModel):
"""Video GIF"""
model_config = ConfigDict(populate_by_name=True)
id: str
asset_id: str = Field(alias="assetId")
start_time: float = Field(alias="startTime")
duration: float
fps: int
url: str | None = None
width: int | None = None
height: int | None = None
size_bytes: int | None = Field(default=None, alias="sizeBytes")
frame_count: int | None = Field(default=None, alias="frameCount")
status: GifStatus
error_message: str | None = Field(default=None, alias="errorMessage")
created_at: datetime = Field(alias="createdAt")
completed_at: datetime | None = Field(default=None, alias="completedAt")
class ListGifsRequest(BaseModel):
"""Request to list GIFs"""
model_config = ConfigDict(populate_by_name=True)
asset_id: str = Field(alias="assetId")
# Private files types
PrivateFileStatus = Literal["pending", "ready", "failed", "deleted"]
class PrivateFile(BaseModel):
"""Private file"""
model_config = ConfigDict(populate_by_name=True)
id: str
filename: str
original_filename: str = Field(alias="originalFilename")
mime_type: str = Field(alias="mimeType")
size: int
s3_key: str = Field(alias="s3Key")
folder: str | None = None
description: str | None = None
tags: list[str] | None = None
metadata: dict[str, Any] | None = None
status: PrivateFileStatus
created_at: datetime = Field(alias="createdAt")
updated_at: datetime | None = Field(default=None, alias="updatedAt")
class PrivateUploadUrlRequest(BaseModel):
"""Request to get private upload URL"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
filename: str
mime_type: str = Field(alias="mimeType")
size: int
folder: str | None = None
description: str | None = None
metadata: dict[str, Any] | None = None
class PrivateUploadUrlResponse(BaseModel):
"""Private upload URL response"""
model_config = ConfigDict(populate_by_name=True)
upload_url: str = Field(alias="uploadUrl")
file_id: str = Field(alias="fileId")
expires_at: datetime = Field(alias="expiresAt")
class PrivateDownloadUrlRequest(BaseModel):
"""Request to get private download URL"""
model_config = ConfigDict(populate_by_name=True)
file_id: str = Field(alias="fileId")
expires_in: int | None = Field(default=None, alias="expiresIn")
class PrivateDownloadUrlResponse(BaseModel):
"""Private download URL response"""
model_config = ConfigDict(populate_by_name=True)
download_url: str = Field(alias="downloadUrl")
expires_at: datetime = Field(alias="expiresAt")
class ListPrivateFilesRequest(BaseModel):
"""Request to list private files"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
folder: str | None = None
status: PrivateFileStatus | None = None
search: str | None = None
sort_by: Literal["createdAt", "filename", "size"] | None = Field(default=None, alias="sortBy")
sort_order: Literal["asc", "desc"] | None = Field(default=None, alias="sortOrder")
limit: int | None = None
offset: int | None = None
class ListPrivateFilesResponse(BaseModel):
"""Response from listing private files"""
model_config = ConfigDict(populate_by_name=True)
files: list[PrivateFile]
total: int
has_more: bool = Field(alias="hasMore")
class UpdatePrivateFileRequest(BaseModel):
"""Request to update private file"""
model_config = ConfigDict(populate_by_name=True)
file_id: str = Field(alias="fileId")
description: str | None = None
folder: str | None = None
tags: list[str] | None = None
metadata: dict[str, Any] | None = None
class MovePrivateFilesRequest(BaseModel):
"""Request to move private files"""
model_config = ConfigDict(populate_by_name=True)
file_ids: list[str] = Field(alias="fileIds")
folder: str | None
class MovePrivateFilesResponse(BaseModel):
"""Response from moving private files"""
model_config = ConfigDict(populate_by_name=True)
success: bool
moved_count: int = Field(alias="movedCount")
# Bundle types
BundleStatus = Literal["pending", "processing", "ready", "failed", "expired"]
class DownloadBundle(BaseModel):
"""Download bundle"""
model_config = ConfigDict(populate_by_name=True)
id: str
name: str
description: str | None = None
asset_ids: list[str] | None = Field(default=None, alias="assetIds")
private_file_ids: list[str] | None = Field(default=None, alias="privateFileIds")
s3_key: str | None = Field(default=None, alias="s3Key")
size: int | None = None
file_count: int | None = Field(default=None, alias="fileCount")
status: BundleStatus
error: str | None = None
expires_at: datetime | None = Field(default=None, alias="expiresAt")
created_at: datetime = Field(alias="createdAt")
completed_at: datetime | None = Field(default=None, alias="completedAt")
class CreateBundleRequest(BaseModel):
"""Request to create bundle"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
name: str
description: str | None = None
asset_ids: list[str] | None = Field(default=None, alias="assetIds")
private_file_ids: list[str] | None = Field(default=None, alias="privateFileIds")
expires_in: int | None = Field(default=None, alias="expiresIn")
class CreateBundleResponse(BaseModel):
"""Response from creating bundle"""
model_config = ConfigDict(populate_by_name=True)
bundle: DownloadBundle
class ListBundlesRequest(BaseModel):
"""Request to list bundles"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
status: BundleStatus | None = None
search: str | None = None
limit: int | None = None
offset: int | None = None
class ListBundlesResponse(BaseModel):
"""Response from listing bundles"""
model_config = ConfigDict(populate_by_name=True)
bundles: list[DownloadBundle]
total: int
has_more: bool = Field(alias="hasMore")
class BundleDownloadUrlRequest(BaseModel):
"""Request to get bundle download URL"""
model_config = ConfigDict(populate_by_name=True)
bundle_id: str = Field(alias="bundleId")
expires_in: int | None = Field(default=None, alias="expiresIn")
class BundleDownloadUrlResponse(BaseModel):
"""Bundle download URL response"""
model_config = ConfigDict(populate_by_name=True)
download_url: str = Field(alias="downloadUrl")
expires_at: datetime = Field(alias="expiresAt")
# Usage types
CdnEnvironment = Literal["sandbox", "production"]
class CdnUsageRequest(BaseModel):
"""Request for CDN usage"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str | None = Field(default=None, alias="projectSlug")
environment: CdnEnvironment | None = None
period_start: datetime | str | None = Field(default=None, alias="periodStart")
period_end: datetime | str | None = Field(default=None, alias="periodEnd")
class CdnUsageResponse(BaseModel):
"""CDN usage response"""
model_config = ConfigDict(populate_by_name=True)
period_start: datetime = Field(alias="periodStart")
period_end: datetime = Field(alias="periodEnd")
requests: int
bandwidth_bytes: int = Field(alias="bandwidthBytes")
bandwidth_formatted: str = Field(alias="bandwidthFormatted")
transformations: int
storage_bytes: int = Field(alias="storageBytes")
storage_formatted: str = Field(alias="storageFormatted")
estimated_cost_cents: int = Field(alias="estimatedCostCents")
estimated_cost_formatted: str = Field(alias="estimatedCostFormatted")
class CdnUsageHistoryRequest(BaseModel):
"""Request for CDN usage history"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str | None = Field(default=None, alias="projectSlug")
environment: CdnEnvironment | None = None
days: int | None = None
granularity: Literal["hour", "day", "week", "month"] | None = None
class CdnUsageDataPoint(BaseModel):
"""CDN usage data point"""
model_config = ConfigDict(populate_by_name=True)
timestamp: datetime
requests: int
bandwidth_bytes: int = Field(alias="bandwidthBytes")
transformations: int
class CdnUsageHistoryTotals(BaseModel):
"""CDN usage history totals"""
model_config = ConfigDict(populate_by_name=True)
requests: int
bandwidth_bytes: int = Field(alias="bandwidthBytes")
transformations: int
class CdnUsageHistoryResponse(BaseModel):
"""CDN usage history response"""
model_config = ConfigDict(populate_by_name=True)
data: list[CdnUsageDataPoint]
totals: CdnUsageHistoryTotals
class CdnStorageBreakdownRequest(BaseModel):
"""Request for storage breakdown"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str | None = Field(default=None, alias="projectSlug")
environment: CdnEnvironment | None = None
group_by: Literal["type", "folder"] | None = Field(default=None, alias="groupBy")
class CdnStorageBreakdownItem(BaseModel):
"""Storage breakdown item"""
model_config = ConfigDict(populate_by_name=True)
key: str
count: int
size_bytes: int = Field(alias="sizeBytes")
size_formatted: str = Field(alias="sizeFormatted")
percentage: float
class CdnStorageBreakdownTotal(BaseModel):
"""Storage breakdown total"""
model_config = ConfigDict(populate_by_name=True)
count: int
size_bytes: int = Field(alias="sizeBytes")
size_formatted: str = Field(alias="sizeFormatted")
class CdnStorageBreakdownResponse(BaseModel):
"""Storage breakdown response"""
model_config = ConfigDict(populate_by_name=True)
items: list[CdnStorageBreakdownItem]
total: CdnStorageBreakdownTotal
# Video thumbnail types
class VideoThumbnail(BaseModel):
"""Video thumbnail"""
model_config = ConfigDict(populate_by_name=True)
id: str
asset_id: str = Field(alias="assetId")
timestamp: float
url: str
width: int | None = None
height: int | None = None
format: str
class ListThumbnailsResponse(BaseModel):
"""Response from listing thumbnails"""
model_config = ConfigDict(populate_by_name=True)
thumbnails: list[VideoThumbnail]
# Video merge types
MergeStatus = TranscodingStatus
MergeQuality = VideoQuality
MergeOutputFormat = Literal["mp4", "webm"]
# "auto" matches the orientation of the first visual input; explicit values
# force the canvas, with the quality preset setting the short edge
MergeAspectRatio = Literal["auto", "16:9", "9:16", "1:1"]
class TextOverlayShadow(BaseModel):
"""Text overlay shadow configuration"""
model_config = ConfigDict(populate_by_name=True)
color: str | None = None
offset_x: int | None = Field(default=None, alias="offsetX")
offset_y: int | None = Field(default=None, alias="offsetY")
class TextOverlayStroke(BaseModel):
"""Text overlay stroke configuration"""
model_config = ConfigDict(populate_by_name=True)
color: str | None = None
width: int | None = None
class TextOverlay(BaseModel):
"""Text overlay configuration"""
model_config = ConfigDict(populate_by_name=True)
text: str
position: Literal["top", "center", "bottom"] | None = None
font_size: int | None = Field(default=None, alias="fontSize")
font_family: str | None = Field(default=None, alias="fontFamily")
font_weight: Literal["normal", "bold"] | None = Field(default=None, alias="fontWeight")
color: str | None = None
background_color: str | None = Field(default=None, alias="backgroundColor")
padding: int | None = None
max_width: int | None = Field(default=None, alias="maxWidth")
shadow: TextOverlayShadow | None = None
stroke: TextOverlayStroke | None = None
class MergeInputItem(BaseModel):
"""Merge input item"""
model_config = ConfigDict(populate_by_name=True)
asset_id: str = Field(alias="assetId")
duration: float | None = None
start_time: float | None = Field(default=None, alias="startTime")
end_time: float | None = Field(default=None, alias="endTime")
text_overlay: TextOverlay | None = Field(default=None, alias="textOverlay")
class AudioTrackInput(BaseModel):
"""Audio track input"""
model_config = ConfigDict(populate_by_name=True)
asset_id: str = Field(alias="assetId")
loop: bool | None = None
fade_in: float | None = Field(default=None, alias="fadeIn")
fade_out: float | None = Field(default=None, alias="fadeOut")
class MergeOutputConfig(BaseModel):
"""Merge output configuration"""
model_config = ConfigDict(populate_by_name=True)
format: MergeOutputFormat | None = None
quality: MergeQuality | None = None
aspect_ratio: MergeAspectRatio | None = Field(default=None, alias="aspectRatio")
filename: str | None = None
class CreateMergeJobRequest(BaseModel):
"""Request to create merge job"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
inputs: list[MergeInputItem]
audio_track: AudioTrackInput | None = Field(default=None, alias="audioTrack")
output: MergeOutputConfig | None = None
webhook_url: str | None = Field(default=None, alias="webhookUrl")
class MergeJob(BaseModel):
"""Merge job"""
model_config = ConfigDict(populate_by_name=True)
id: str
organization_id: str = Field(alias="organizationId")
project_id: str = Field(alias="projectId")
environment: Literal["sandbox", "production"]
inputs: list[MergeInputItem]
audio_track_asset_id: str | None = Field(default=None, alias="audioTrackAssetId")
output_format: MergeOutputFormat = Field(alias="outputFormat")
output_quality: MergeQuality = Field(alias="outputQuality")
output_aspect_ratio: MergeAspectRatio = Field(default="auto", alias="outputAspectRatio")
output_filename: str | None = Field(default=None, alias="outputFilename")
output_asset_id: str | None = Field(default=None, alias="outputAssetId")
status: MergeStatus
progress: int | None = None
error_message: str | None = Field(default=None, alias="errorMessage")
started_at: datetime | None = Field(default=None, alias="startedAt")
completed_at: datetime | None = Field(default=None, alias="completedAt")
total_duration_seconds: float | None = Field(default=None, alias="totalDurationSeconds")
webhook_url: str | None = Field(default=None, alias="webhookUrl")
created_at: datetime = Field(alias="createdAt")
updated_at: datetime | None = Field(default=None, alias="updatedAt")
class MergeOutputAsset(BaseModel):
"""Merge output asset details"""
model_config = ConfigDict(populate_by_name=True)
id: str
cdn_url: str = Field(alias="cdnUrl")
direct_url: str = Field(alias="directUrl")
filename: str
size: int
duration: float | None = None
class MergeJobWithOutput(MergeJob):
"""Merge job with output asset details"""
model_config = ConfigDict(populate_by_name=True)
output_asset: MergeOutputAsset | None = Field(default=None, alias="outputAsset")
class ListMergeJobsRequest(BaseModel):
"""Request to list merge jobs"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
status: MergeStatus | None = None
limit: int | None = None
offset: int | None = None
class ListMergeJobsResponse(BaseModel):
"""Response from listing merge jobs"""
model_config = ConfigDict(populate_by_name=True)
jobs: list[MergeJob]
total: int
has_more: bool = Field(alias="hasMore")
# S3 Import types
ImportJobStatus = Literal["pending", "validating", "importing", "completed", "failed", "cancelled"]
ImportAuthType = Literal["iam_credentials", "role_assumption"]
ImportPathMode = Literal["preserve", "flatten"]
ImportFileStatus = Literal["pending", "importing", "completed", "failed", "skipped"]
class ImportError(BaseModel):
"""Import error"""
model_config = ConfigDict(populate_by_name=True)
key: str
error: str
timestamp: str
class CreateImportRequest(BaseModel):
"""Request to create S3 import job"""
model_config = ConfigDict(populate_by_name=True)
project_slug: str = Field(alias="projectSlug")
environment: CdnEnvironment | None = None
source_bucket: str = Field(alias="sourceBucket")
source_region: str = Field(alias="sourceRegion")
source_prefix: str | None = Field(default=None, alias="sourcePrefix")
auth_type: ImportAuthType = Field(alias="authType")
access_key_id: str | None = Field(default=None, alias="accessKeyId")
secret_access_key: str | None = Field(default=None, alias="secretAccessKey")
role_arn: str | None = Field(default=None, alias="roleArn")
external_id: str | None = Field(default=None, alias="externalId")
path_mode: ImportPathMode | None = Field(default=None, alias="pathMode")
target_folder: str | None = Field(default=None, alias="targetFolder")
notify_email: str | None = Field(default=None, alias="notifyEmail")
class CreateImportResponse(BaseModel):
"""Response from creating import job"""
model_config = ConfigDict(populate_by_name=True)
import_id: str = Field(alias="importId")
status: ImportJobStatus
source_bucket: str = Field(alias="sourceBucket")
source_region: str = Field(alias="sourceRegion")
source_prefix: str | None = Field(default=None, alias="sourcePrefix")