UNPKG

46.5 kBTypeScriptView Raw
1import { Transform } from 'stream';
2
3
4declare module 'cloudinary' {
5
6 /****************************** Constants *************************************/
7 /****************************** Transformations *******************************/
8 type CropMode =
9 string
10 | "scale"
11 | "fit"
12 | "limit"
13 | "mfit"
14 | "fill"
15 | "lfill"
16 | "pad"
17 | "lpad"
18 | "mpad"
19 | "crop"
20 | "thumb"
21 | "imagga_crop"
22 | "imagga_scale";
23 type Gravity =
24 string
25 | "north_west"
26 | "north"
27 | "north_east"
28 | "west"
29 | "center"
30 | "east"
31 | "south_west"
32 | "south"
33 | "south_east"
34 | "xy_center"
35 | "face"
36 | "face:center"
37 | "face:auto"
38 | "faces"
39 | "faces:center"
40 | "faces:auto"
41 | "body"
42 | "body:face"
43 | "adv_face"
44 | "adv_faces"
45 | "adv_eyes"
46 | "custom"
47 | "custom:face"
48 | "custom:faces"
49 | "custom:adv_face"
50 | "custom:adv_faces"
51 | "auto"
52 | "auto:adv_face"
53 | "auto:adv_faces"
54 | "auto:adv_eyes"
55 | "auto:body"
56 | "auto:face"
57 | "auto:faces"
58 | "auto:custom_no_override"
59 | "auto:none"
60 | "liquid"
61 | "ocr_text";
62 type Angle = number | string | Array<number | string> | "auto_right" | "auto_left" | "ignore" | "vflip" | "hflip";
63 type ImageEffect =
64 string
65 | "hue"
66 | "red"
67 | "green"
68 | "blue"
69 | "negate"
70 | "brightness"
71 | "auto_brightness"
72 | "brightness_hsb"
73 | "sepia"
74 | "grayscale"
75 | "blackwhite"
76 | "saturation"
77 | "colorize"
78 | "replace_color"
79 | "simulate_colorblind"
80 | "assist_colorblind"
81 | "recolor"
82 | "tint"
83 | "contrast"
84 | "auto_contrast"
85 | "auto_color"
86 | "vibrance"
87 | "noise"
88 | "ordered_dither"
89 | "pixelate_faces"
90 | "pixelate_region"
91 | "pixelate"
92 | "unsharp_mask"
93 | "sharpen"
94 | "blur_faces"
95 | "blur_region"
96 | "blur"
97 | "tilt_shift"
98 | "gradient_fade"
99 | "vignette"
100 | "anti_removal"
101 | "overlay"
102 | "mask"
103 | "multiply"
104 | "displace"
105 | "shear"
106 | "distort"
107 | "trim"
108 | "make_transparent"
109 | "shadow"
110 | "viesus_correct"
111 | "fill_light"
112 | "gamma"
113 | "improve";
114
115 type VideoEffect = string | "accelerate" | "reverse" | "boomerang" | "loop" | "make_transparent" | "transition";
116 type AudioCodec = string | "none" | "aac" | "vorbis" | "mp3";
117 type AudioFrequency =
118 string
119 | number
120 | 8000
121 | 11025
122 | 16000
123 | 22050
124 | 32000
125 | 37800
126 | 44056
127 | 44100
128 | 47250
129 | 48000
130 | 88200
131 | 96000
132 | 176400
133 | 192000;
134 /****************************** Flags *************************************/
135 type ImageFlags =
136 string
137 | Array<string>
138 | "any_format"
139 | "attachment"
140 | "apng"
141 | "awebp"
142 | "clip"
143 | "clip_evenodd"
144 | "cutter"
145 | "force_strip"
146 | "getinfo"
147 | "ignore_aspect_ratio"
148 | "immutable_cache"
149 | "keep_attribution"
150 | "keep_iptc"
151 | "layer_apply"
152 | "lossy"
153 | "preserve_transparency"
154 | "png8"
155 | "png32"
156 | "progressive"
157 | "rasterize"
158 | "region_relative"
159 | "relative"
160 | "replace_image"
161 | "sanitize"
162 | "strip_profile"
163 | "text_no_trim"
164 | "no_overflow"
165 | "text_disallow_overflow"
166 | "tiff8_lzw"
167 | "tiled";
168 type VideoFlags =
169 string
170 | Array<string>
171 | "animated"
172 | "awebp"
173 | "attachment"
174 | "streaming_attachment"
175 | "hlsv3"
176 | "keep_dar"
177 | "splice"
178 | "layer_apply"
179 | "no_stream"
180 | "mono"
181 | "relative"
182 | "truncate_ts"
183 | "waveform";
184 type ColorSpace = string | "srgb" | "no_cmyk" | "keep_cmyk";
185 type DeliveryType =
186 string
187 | "upload"
188 | "private"
189 | "authenticated"
190 | "fetch"
191 | "multi"
192 | "text"
193 | "asset"
194 | "list"
195 | "facebook"
196 | "twitter"
197 | "twitter_name"
198 | "instagram"
199 | "gravatar"
200 | "youtube"
201 | "hulu"
202 | "vimeo"
203 | "animoto"
204 | "worldstarhiphop"
205 | "dailymotion";
206 /****************************** URL *************************************/
207 type ResourceType = string | "image" | "raw" | "video";
208 type ImageFormat =
209 string
210 | "gif"
211 | "png"
212 | "jpg"
213 | "bmp"
214 | "ico"
215 | "pdf"
216 | "tiff"
217 | "eps"
218 | "jpc"
219 | "jp2"
220 | "psd"
221 | "webp"
222 | "zip"
223 | "svg"
224 | "webm"
225 | "wdp"
226 | "hpx"
227 | "djvu"
228 | "ai"
229 | "flif"
230 | "bpg"
231 | "miff"
232 | "tga"
233 | "heic"
234 type VideoFormat =
235 string
236 | "auto"
237 | "flv"
238 | "m3u8"
239 | "ts"
240 | "mov"
241 | "mkv"
242 | "mp4"
243 | "mpd"
244 | "ogv"
245 | "webm"
246
247 export interface CommonTransformationOptions {
248 transformation?: TransformationOptions;
249 raw_transformation?: string;
250 crop?: CropMode;
251 width?: number | string;
252 height?: number | string;
253 size?: string;
254 aspect_ratio?: number | string;
255 gravity?: Gravity;
256 x?: number | string;
257 y?: number | string;
258 zoom?: number | string;
259 effect?: string | Array<number | string>;
260 background?: string;
261 angle?: Angle;
262 radius?: number | string;
263 overlay?: string | object;
264 custom_function?: string | { function_type: string | "wasm" | "remote", source: string }
265 variables?: Array<string | object>;
266 if?: string;
267 else?: string;
268 end_if?: string;
269 dpr?: number | string;
270 quality?: number | string;
271 delay?: number | string;
272
273 [futureKey: string]: any;
274 }
275
276 export interface ImageTransformationOptions extends CommonTransformationOptions {
277 underlay?: string | Object;
278 color?: string;
279 color_space?: ColorSpace;
280 opacity?: number | string;
281 border?: string;
282 default_image?: string;
283 density?: number | string;
284 format?: ImageFormat;
285 fetch_format?: ImageFormat;
286 effect?: string | Array<number | string> | ImageEffect;
287 page?: number | string;
288 flags?: ImageFlags | string;
289
290 [futureKey: string]: any;
291 }
292
293 interface VideoTransformationOptions extends CommonTransformationOptions {
294 audio_codec?: AudioCodec;
295 audio_frequency?: AudioFrequency;
296 video_codec?: string | Object;
297 bit_rate?: number | string;
298 fps?: string | Array<number | string>;
299 keyframe_interval?: string;
300 offset?: string,
301 start_offset?: number | string;
302 end_offset?: number | string;
303 duration?: number | string;
304 streaming_profile?: StreamingProfiles
305 video_sampling?: number | string;
306 format?: VideoFormat;
307 fetch_format?: VideoFormat;
308 effect?: string | Array<number | string> | VideoEffect;
309 flags?: VideoFlags;
310
311 [futureKey: string]: any;
312 }
313
314 interface TextStyleOptions {
315 text_style?: string;
316 font_family?: string;
317 font_size?: number;
318 font_color?: string;
319 font_weight?: string;
320 font_style?: string;
321 background?: string;
322 opacity?: number;
323 text_decoration?: string
324 }
325
326 interface ConfigOptions {
327 cloud_name?: string;
328 api_key?: string;
329 api_secret?: string;
330 api_proxy?: string;
331 private_cdn?: boolean;
332 secure_distribution?: string;
333 force_version?: boolean;
334 ssl_detected?: boolean;
335 secure?: boolean;
336 cdn_subdomain?: boolean;
337 secure_cdn_subdomain?: boolean;
338 cname?: string;
339 shorten?: boolean;
340 sign_url?: boolean;
341 long_url_signature?: boolean;
342 use_root_path?: boolean;
343 auth_token?: object;
344 account_id?: string;
345 provisioning_api_key?: string;
346 provisioning_api_secret?: string;
347 oauth_token?: string;
348
349 [futureKey: string]: any;
350 }
351
352 export interface ResourceOptions {
353 type?: string;
354 resource_type?: string;
355 }
356
357 export interface UrlOptions extends ResourceOptions {
358 version?: string;
359 format?: string;
360 url_suffix?: string;
361
362 [futureKey: string]: any;
363 }
364
365 export interface ImageTagOptions {
366 html_height?: string;
367 html_width?: string;
368 srcset?: object;
369 attributes?: object;
370 client_hints?: boolean;
371 responsive?: boolean;
372 hidpi?: boolean;
373 responsive_placeholder?: boolean;
374
375 [futureKey: string]: any;
376 }
377
378 export interface VideoTagOptions {
379 source_types?: string | string[];
380 source_transformation?: TransformationOptions;
381 fallback_content?: string;
382 poster?: string | object;
383 controls?: boolean;
384 preload?: string;
385
386 [futureKey: string]: any;
387 }
388
389 /****************************** Admin API Options *************************************/
390 export interface AdminApiOptions {
391 agent?: object;
392 content_type?: string;
393 oauth_token?: string;
394
395 [futureKey: string]: any;
396 }
397
398 export interface ArchiveApiOptions {
399 allow_missing?: boolean;
400 async?: boolean;
401 expires_at?: number;
402 flatten_folders?: boolean;
403 flatten_transformations?: boolean;
404 keep_derived?: boolean;
405 mode?: string;
406 notification_url?: string;
407 prefixes?: string;
408 public_ids?: string[] | string;
409 fully_qualified_public_ids?: string[] | string;
410 skip_transformation_name?: boolean;
411 tags?: string | string[];
412 target_format?: TargetArchiveFormat;
413 target_public_id?: string;
414 target_tags?: string[];
415 timestamp?: number;
416 transformations?: TransformationOptions;
417 type?: DeliveryType
418 use_original_filename?: boolean;
419
420 [futureKey: string]: any;
421 }
422
423 export interface UpdateApiOptions extends ResourceOptions {
424 access_control?: string[];
425 auto_tagging?: number;
426 background_removal?: string;
427 categorization?: string;
428 context?: boolean | string;
429 custom_coordinates?: string;
430 detection?: string;
431 face_coordinates?: string;
432 headers?: string;
433 notification_url?: string;
434 ocr?: string;
435 raw_convert?: string;
436 similarity_search?: string;
437 tags?: string | string[];
438 moderation_status?: string;
439 unsafe_update?: object;
440 allowed_for_strict?: boolean;
441
442 [futureKey: string]: any;
443 }
444
445 export interface PublishApiOptions extends ResourceOptions {
446 invalidate?: boolean;
447 overwrite?: boolean;
448
449 [futureKey: string]: any;
450 }
451
452 export interface ResourceApiOptions extends ResourceOptions {
453 transformation?: TransformationOptions;
454 transformations?: TransformationOptions;
455 keep_original?: boolean;
456 next_cursor?: boolean | string;
457 public_ids?: string[];
458 prefix?: string;
459 all?: boolean;
460 max_results?: number;
461 tags?: boolean;
462 tag?: string;
463 context?: boolean;
464 direction?: number | string;
465 moderations?: boolean;
466 start_at?: string;
467 exif?: boolean;
468 colors?: boolean;
469 derived_next_cursor?: string;
470 faces?: boolean;
471 image_metadata?: boolean;
472 pages?: boolean;
473 coordinates?: boolean;
474 phash?: boolean;
475 cinemagraph_analysis?: boolean;
476 accessibility_analysis?: boolean;
477
478 [futureKey: string]: any;
479 }
480
481 export interface UploadApiOptions {
482 access_mode?: AccessMode;
483 allowed_formats?: Array<VideoFormat> | Array<ImageFormat>;
484 async?: boolean;
485 backup?: boolean;
486 callback?: string;
487 colors?: boolean;
488 discard_original_filename?: boolean;
489 eager?: TransformationOptions;
490 eager_async?: boolean;
491 eager_notification_url?: string;
492 eval?: string;
493 exif?: boolean;
494 faces?: boolean;
495 folder?: string;
496 format?: VideoFormat | ImageFormat;
497 image_metadata?: boolean;
498 invalidate?: boolean;
499 moderation?: ModerationKind;
500 notification_url?: string;
501 overwrite?: boolean;
502 phash?: boolean;
503 proxy?: string;
504 public_id?: string;
505 quality_analysis?: boolean;
506 responsive_breakpoints?: object;
507 return_delete_token?: boolean
508 timestamp?: number;
509 transformation?: TransformationOptions;
510 type?: DeliveryType;
511 unique_filename?: boolean;
512 upload_preset?: string;
513 use_filename?: boolean;
514 chunk_size?: number;
515 disable_promises?: boolean;
516 oauth_token?: string;
517
518 [futureKey: string]: any;
519 }
520
521 export interface ProvisioningApiOptions {
522 account_id?: string;
523 provisioning_api_key?: string;
524 provisioning_api_secret?: string;
525 agent?: object;
526 content_type?: string;
527
528 [futureKey: string]: any;
529 }
530
531 export interface AuthTokenApiOptions {
532 key: string;
533 acl: string;
534 ip?: string;
535 start_time?: number;
536 duration?: number;
537 expiration?: number;
538 url?: string;
539 }
540
541 type TransformationOptions =
542 string
543 | string[]
544 | VideoTransformationOptions
545 | ImageTransformationOptions
546 | Object
547 | Array<ImageTransformationOptions>
548 | Array<VideoTransformationOptions>;
549
550 type ImageTransformationAndTagsOptions = ImageTransformationOptions | ImageTagOptions;
551 type VideoTransformationAndTagsOptions = VideoTransformationOptions | VideoTagOptions;
552 type ImageAndVideoFormatOptions = ImageFormat | VideoFormat;
553 type ConfigAndUrlOptions = ConfigOptions | UrlOptions;
554 type AdminAndPublishOptions = AdminApiOptions | PublishApiOptions;
555 type AdminAndResourceOptions = AdminApiOptions | ResourceApiOptions;
556 type AdminAndUpdateApiOptions = AdminApiOptions | UpdateApiOptions;
557
558 /****************************** API *************************************/
559 type Status = string | "pending" | "approved" | "rejected";
560 type StreamingProfiles = string | "4k" | "full_hd" | "hd" | "sd" | "full_hd_wifi" | "full_hd_lean" | "hd_lean";
561 type ModerationKind = string | "manual" | "webpurify" | "aws_rek" | "metascan";
562 type AccessMode = string | "public" | "authenticated";
563 type TargetArchiveFormat = string | "zip" | "tgz";
564
565 // err is kept for backwards compatibility, it currently will always be undefined
566 type ResponseCallback = (err?: any, callResult?: any) => any;
567
568 type UploadResponseCallback = (err?: UploadApiErrorResponse, callResult?: UploadApiResponse) => void;
569
570 export interface UploadApiResponse {
571 public_id: string;
572 version: number;
573 signature: string;
574 width: number;
575 height: number;
576 format: string;
577 resource_type: string;
578 created_at: string;
579 tags: Array<string>;
580 pages: number;
581 bytes: number;
582 type: string;
583 etag: string;
584 placeholder: boolean;
585 url: string;
586 secure_url: string;
587 access_mode: string;
588 original_filename: string;
589 moderation: Array<string>;
590 access_control: Array<string>;
591 context: object;
592 metadata: object;
593
594 [futureKey: string]: any;
595 }
596
597 export interface UploadApiErrorResponse {
598 message: string;
599 name: string;
600 http_code: number;
601
602 [futureKey: string]: any;
603 }
604
605 class UploadStream extends Transform {
606 }
607
608 export interface DeleteApiResponse {
609 message: string;
610 http_code: number;
611 }
612
613 export interface MetadataFieldApiOptions {
614 external_id?: string;
615 type?: string;
616 label?: string;
617 mandatory?: boolean;
618 default_value?: number;
619 validation?: object;
620 datasource?: object;
621
622 [futureKey: string]: any;
623 }
624
625 export interface MetadataFieldApiResponse {
626 external_id: string;
627 type: string;
628 label: string;
629 mandatory: boolean;
630 default_value: number;
631 validation: object;
632 datasource: object;
633
634 [futureKey: string]: any;
635 }
636
637 export interface MetadataFieldsApiResponse {
638 metadata_fields: MetadataFieldApiResponse[]
639 }
640
641 export interface DatasourceChange {
642 values: Array<object>
643 }
644
645 export interface ResourceApiResponse {
646 resources: [
647 {
648 public_id: string;
649 format: string;
650 version: number;
651 resource_type: string;
652 type: string;
653 placeholder: boolean;
654 created_at: string;
655 bytes: number;
656 width: number;
657 height: number;
658 backup: boolean;
659 access_mode: string;
660 url: string;
661 secure_url: string;
662 tags: Array<string>;
663 context: object;
664 next_cursor: string;
665 derived_next_cursor: string;
666 exif: object;
667 image_metadata: object;
668 faces: number[][];
669 quality_analysis: number;
670 colors: string[][];
671 derived: Array<string>;
672 moderation: object;
673 phash: string;
674 predominant: object;
675 coordinates: object;
676 access_control: Array<string>;
677 pages: number;
678
679 [futureKey: string]: any;
680 }
681 ]
682 }
683
684
685 export namespace v2 {
686
687 /****************************** Global Utils *************************************/
688
689 function cloudinary_js_config(): string;
690
691 function config(new_config?: boolean | ConfigOptions): ConfigOptions;
692
693 function config<K extends keyof ConfigOptions, V extends ConfigOptions[K]>(key: K, value?: undefined): V;
694
695 function config<K extends keyof ConfigOptions, V extends ConfigOptions[K]>(key: K, value: V): ConfigOptions & { [Property in K]: V }
696
697 function url(public_id: string, options?: TransformationOptions | ConfigAndUrlOptions): string;
698
699 /****************************** Tags *************************************/
700
701 function image(source: string, options?: ImageTransformationAndTagsOptions | ConfigAndUrlOptions): string;
702
703 function picture(public_id: string, options?: ImageTransformationAndTagsOptions | ConfigAndUrlOptions): string;
704
705 function source(public_id: string, options?: TransformationOptions | ConfigAndUrlOptions): string;
706
707 function video(public_id: string, options?: VideoTransformationAndTagsOptions | ConfigAndUrlOptions): string;
708
709 /****************************** Utils *************************************/
710
711 namespace utils {
712
713 function sign_request(params_to_sign: object, options?: ConfigAndUrlOptions): { signature: string; api_key: string; [key:string]:any};
714
715 function api_sign_request(params_to_sign: object, api_secret: string): string;
716
717 function api_url(action?: string, options?: ConfigAndUrlOptions): string;
718
719 function url(public_id?: string, options?: TransformationOptions | ConfigAndUrlOptions): string;
720
721 function video_thumbnail_url(public_id?: string, options?: VideoTransformationOptions | ConfigAndUrlOptions): string;
722
723 function video_url(public_id?: string, options?: VideoTransformationOptions | ConfigAndUrlOptions): string;
724
725 function archive_params(options?: ArchiveApiOptions): Promise<any>;
726
727 function download_archive_url(options?: ArchiveApiOptions | ConfigAndUrlOptions): string
728
729 function download_zip_url(options?: ArchiveApiOptions | ConfigAndUrlOptions): string;
730
731 function generate_auth_token(options?: AuthTokenApiOptions): string;
732
733 function webhook_signature(data?: string, timestamp?: number, options?: ConfigOptions): string;
734
735 function private_download_url(publicID: string, format:string, options: Partial<{
736 resource_type: ResourceType;
737 type: DeliveryType;
738 expires_at: number;
739 attachment: boolean;
740 }>): string;
741 }
742
743 /****************************** Admin API V2 Methods *************************************/
744
745 namespace api {
746 function create_streaming_profile(name: string, options: AdminApiOptions | { display_name?: string, representations: TransformationOptions }, callback?: ResponseCallback): Promise<any>;
747
748 function create_transformation(name: string, transformation: TransformationOptions, callback?: ResponseCallback): Promise<any>;
749
750 function create_transformation(name: string, transformation: TransformationOptions, options?: AdminApiOptions | { allowed_for_strict?: boolean }, callback?: ResponseCallback): Promise<any>;
751
752 function create_upload_mapping(folder: string, options: AdminApiOptions | { template: string }, callback?: ResponseCallback): Promise<any>;
753
754 function create_upload_preset(options?: AdminApiOptions | { name?: string, unsigned?: boolean, disallow_public_id?: boolean }, callback?: ResponseCallback): Promise<any>;
755
756 function delete_all_resources(value?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
757
758 function delete_derived_by_transformation(public_ids: string[], transformations: TransformationOptions, callback?: ResponseCallback): Promise<any>;
759
760 function delete_derived_by_transformation(public_ids: string[], transformations: TransformationOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
761
762 function delete_derived_resources(public_ids: string[], callback?: ResponseCallback): Promise<any>;
763
764 function delete_derived_resources(public_ids: string[], options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
765
766 function delete_resources(value: string[], callback?: ResponseCallback): Promise<any>;
767
768 function delete_resources(value: string[], options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
769
770 function delete_resources_by_prefix(prefix: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
771
772 function delete_resources_by_prefix(prefix: string, callback?: ResponseCallback): Promise<any>;
773
774 function delete_resources_by_tag(tag: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
775
776 function delete_resources_by_tag(tag: string, callback?: ResponseCallback): Promise<any>;
777
778 function delete_streaming_profile(name: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
779
780 function delete_streaming_profile(name: string, callback?: ResponseCallback): Promise<any>;
781
782 function delete_transformation(transformationName: TransformationOptions, callback?: ResponseCallback): Promise<any>;
783
784 function delete_transformation(transformationName: TransformationOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
785
786 function delete_upload_mapping(folder: string, callback?: ResponseCallback): Promise<any>;
787
788 function delete_upload_mapping(folder: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
789
790 function delete_upload_preset(name: string, callback?: ResponseCallback): Promise<any>;
791
792 function delete_upload_preset(name: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
793
794 function get_streaming_profile(name: string | ResponseCallback, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
795
796 function get_streaming_profile(name: string | ResponseCallback, callback?: ResponseCallback): Promise<any>;
797
798 function list_streaming_profiles(callback?: ResponseCallback): Promise<any>;
799
800 function list_streaming_profiles(options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
801
802 function ping(options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
803
804 function ping(callback?: ResponseCallback): Promise<any>;
805
806 function publish_by_ids(public_ids: string[], options?: AdminAndPublishOptions, callback?: ResponseCallback): Promise<any>;
807
808 function publish_by_ids(public_ids: string[], callback?: ResponseCallback): Promise<any>;
809
810 function publish_by_prefix(prefix: string[] | string, options?: AdminAndPublishOptions, callback?: ResponseCallback): Promise<any>;
811
812 function publish_by_prefix(prefix: string[] | string, callback?: ResponseCallback): Promise<any>;
813
814 function publish_by_tag(tag: string, options?: AdminAndPublishOptions, callback?: ResponseCallback): Promise<any>;
815
816 function publish_by_tag(tag: string, callback?: ResponseCallback): Promise<any>;
817
818 function resource(public_id: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
819
820 function resource(public_id: string, callback?: ResponseCallback): Promise<any>;
821
822 function resource_types(options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
823
824 function resources(options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
825
826 function resources_by_context(key: string, value?: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<ResourceApiResponse>;
827
828 function resources_by_context(key: string, value?: string, options?: AdminAndResourceOptions): Promise<ResourceApiResponse>;
829
830 function resources_by_context(key: string, options?: AdminAndResourceOptions): Promise<ResourceApiResponse>;
831
832 function resources_by_context(key: string, callback?: ResponseCallback): Promise<ResourceApiResponse>;
833
834 function resources_by_ids(public_ids: string[] | string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<ResourceApiResponse>;
835
836 function resources_by_ids(public_ids: string[] | string, callback?: ResponseCallback): Promise<ResourceApiResponse>;
837
838 function resources_by_moderation(moderation: ModerationKind, status: Status, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<ResourceApiResponse>;
839
840 function resources_by_moderation(moderation: ModerationKind, status: Status, callback?: ResponseCallback): Promise<ResourceApiResponse>;
841
842 function resources_by_tag(tag: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<ResourceApiResponse>;
843
844 function resources_by_tag(tag: string, callback?: ResponseCallback): Promise<ResourceApiResponse>;
845
846 function restore(public_ids: string[], options?: AdminApiOptions | { resource_type: ResourceType, type: DeliveryType }, callback?: ResponseCallback): Promise<any>;
847
848 function restore(public_ids: string[], callback?: ResponseCallback): Promise<any>;
849
850 function root_folders(callback?: ResponseCallback, options?: AdminApiOptions): Promise<any>;
851
852 function search(params: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
853
854 function search(params: string, callback?: ResponseCallback): Promise<any>;
855
856 function sub_folders(root_folder: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
857
858 function sub_folders(root_folder: string, callback?: ResponseCallback): Promise<any>;
859
860 function tags(callback?: ResponseCallback, options?: AdminApiOptions | { max_results?: number, next_cursor?: string, prefix?: string }): Promise<any>;
861
862 function transformation(transformation: TransformationOptions, options?: AdminApiOptions | { max_results?: number, next_cursor?: string, named?: boolean }, callback?: ResponseCallback): Promise<any>;
863
864 function transformation(transformation: TransformationOptions, callback?: ResponseCallback): Promise<any>;
865
866 function transformations(options?: AdminApiOptions | { max_results?: number, next_cursor?: string, named?: boolean }, callback?: ResponseCallback): Promise<any>;
867
868 function transformations(callback?: ResponseCallback): Promise<any>;
869
870 function update(public_id: string, options?: AdminAndUpdateApiOptions, callback?: ResponseCallback): Promise<any>;
871
872 function update(public_id: string, callback?: ResponseCallback): Promise<any>;
873
874 function update_resources_access_mode_by_ids(access_mode: AccessMode, ids: string[], options?: AdminAndUpdateApiOptions, callback?: ResponseCallback): Promise<any>;
875
876 function update_resources_access_mode_by_ids(access_mode: AccessMode, ids: string[], callback?: ResponseCallback): Promise<any>;
877
878 function update_resources_access_mode_by_prefix(access_mode: AccessMode, prefix: string, options?: AdminAndUpdateApiOptions, callback?: ResponseCallback): Promise<any>;
879
880 function update_resources_access_mode_by_prefix(access_mode: AccessMode, prefix: string, callback?: ResponseCallback): Promise<any>;
881
882 function update_resources_access_mode_by_tag(access_mode: AccessMode, tag: string, options?: AdminAndUpdateApiOptions, callback?: ResponseCallback): Promise<any>;
883
884 function update_resources_access_mode_by_tag(access_mode: AccessMode, tag: string, callback?: ResponseCallback): Promise<any>;
885
886 function update_streaming_profile(name: string, options: { display_name?: string, representations: Array<{ transformation?: VideoTransformationOptions }> }, callback?: ResponseCallback): Promise<any>;
887
888 function update_transformation(transformation_name: TransformationOptions, updates?: TransformationOptions, callback?: ResponseCallback): Promise<any>;
889
890 function update_transformation(transformation_name: TransformationOptions, callback?: ResponseCallback): Promise<any>;
891
892 function update_upload_mapping(name: string, options: AdminApiOptions | { template: string }, callback?: ResponseCallback): Promise<any>;
893
894 function update_upload_preset(name?: string, options?: AdminApiOptions | { unsigned?: boolean, disallow_public_id?: boolean }, callback?: ResponseCallback): Promise<any>;
895
896 function update_upload_preset(name?: string, callback?: ResponseCallback): Promise<any>;
897
898 function upload_mapping(name?: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
899
900 function upload_mapping(name?: string, callback?: ResponseCallback): Promise<any>;
901
902 function upload_mappings(options?: AdminApiOptions | { max_results?: number, next_cursor?: string }, callback?: ResponseCallback): Promise<any>;
903
904 function upload_mappings(callback?: ResponseCallback): Promise<any>;
905
906 function upload_preset(name?: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
907
908 function upload_preset(name?: string, callback?: ResponseCallback): Promise<any>;
909
910 function upload_presets(options?: AdminApiOptions | { max_results?: number, next_cursor?: string }, callback?: ResponseCallback): Promise<any>;
911
912 function usage(callback?: ResponseCallback, options?: AdminApiOptions): Promise<any>;
913
914 function usage(options?: AdminApiOptions): Promise<any>;
915
916 function create_folder(path:string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
917
918 function delete_folder(path:string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
919
920 /****************************** Structured Metadata API V2 Methods *************************************/
921
922 function add_metadata_field(field: MetadataFieldApiOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
923
924 function add_metadata_field(field: MetadataFieldApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
925
926 function list_metadata_fields(callback?: ResponseCallback, options?: AdminApiOptions): Promise<MetadataFieldsApiResponse>;
927
928 function list_metadata_fields(options?: AdminApiOptions): Promise<MetadataFieldsApiResponse>;
929
930 function delete_metadata_field(field_external_id: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<DeleteApiResponse>;
931
932 function delete_metadata_field(field_external_id: string, callback?: ResponseCallback): Promise<DeleteApiResponse>;
933
934 function metadata_field_by_field_id(external_id:string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
935
936 function metadata_field_by_field_id(external_id:string, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
937
938 function update_metadata_field(external_id: string, field: MetadataFieldApiOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
939
940 function update_metadata_field(external_id: string, field: MetadataFieldApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
941
942 function update_metadata_field_datasource(field_external_id: string, entries_external_id: object, options?: AdminApiOptions, callback?: ResponseCallback): Promise<DatasourceChange>;
943
944 function update_metadata_field_datasource(field_external_id: string, entries_external_id: object, callback?: ResponseCallback): Promise<DatasourceChange>;
945
946 function delete_datasource_entries(field_external_id: string, entries_external_id: string[], options?: AdminApiOptions, callback?: ResponseCallback): Promise<DatasourceChange>;
947
948 function delete_datasource_entries(field_external_id: string, entries_external_id: string[], callback?: ResponseCallback): Promise<DatasourceChange>;
949
950 function restore_metadata_field_datasource(field_external_id: string, entries_external_id: string[], options?: AdminApiOptions, callback?: ResponseCallback): Promise<DatasourceChange>;
951
952 function restore_metadata_field_datasource(field_external_id: string, entries_external_id: string[], callback?: ResponseCallback): Promise<DatasourceChange>;
953 }
954
955 /****************************** Upload API V2 Methods *************************************/
956
957 namespace uploader {
958 function add_context(context: string, public_ids: string[], options?: { type?: DeliveryType, resource_type?: ResourceType }, callback?: ResponseCallback): Promise<any>;
959
960 function add_context(context: string, public_ids: string[], callback?: ResponseCallback): Promise<any>;
961
962 function add_tag(tag: string, public_ids: string[], options?: { type?: DeliveryType, resource_type?: ResourceType }, callback?: ResponseCallback): Promise<any>;
963
964 function add_tag(tag: string, public_ids: string[], callback?: ResponseCallback): Promise<any>;
965
966 function create_archive(options?: ArchiveApiOptions, target_format?: TargetArchiveFormat, callback?: ResponseCallback,): Promise<any>;
967
968 function create_zip(options?: ArchiveApiOptions, callback?: ResponseCallback): Promise<any>;
969
970 function destroy(public_id: string, options?: { resource_type?: ResourceType, type?: DeliveryType, invalidate?: boolean }, callback?: ResponseCallback,): Promise<any>;
971
972 function destroy(public_id: string, callback?: ResponseCallback,): Promise<any>;
973
974 function explicit(public_id: string, options?: UploadApiOptions, callback?: ResponseCallback): Promise<any>;
975
976 function explicit(public_id: string, callback?: ResponseCallback): Promise<any>;
977
978 function explode(public_id: string, options?: { page?: 'all', type?: DeliveryType, format?: ImageAndVideoFormatOptions, notification_url?: string, transformations?: TransformationOptions }, callback?: ResponseCallback): Promise<any>
979
980 function explode(public_id: string, callback?: ResponseCallback): Promise<any>
981
982 function generate_sprite(tag: string, options?: { transformation?: TransformationOptions, format?: ImageAndVideoFormatOptions, notification_url?: string, async?: boolean }, callback?: ResponseCallback): Promise<any>;
983
984 function generate_sprite(tag: string, callback?: ResponseCallback): Promise<any>;
985
986 function image_upload_tag(field?: string, options?: UploadApiOptions): Promise<any>;
987
988 function multi(tag: string, options?: { transformation?: TransformationOptions, async?: boolean, format?: ImageAndVideoFormatOptions, notification_url?: string }, callback?: ResponseCallback): Promise<any>;
989
990 function multi(tag: string, callback?: ResponseCallback): Promise<any>;
991
992 function remove_all_context(public_ids: string[], options?: { context?: string, resource_type?: ResourceType, type?: DeliveryType }, callback?: ResponseCallback): Promise<any>;
993
994 function remove_all_context(public_ids: string[], callback?: ResponseCallback): Promise<any>;
995
996 function remove_all_tags(public_ids: string[], options?: { tag?: string, resource_type?: ResourceType, type?: DeliveryType }, callback?: ResponseCallback): Promise<any>;
997
998 function remove_all_tags(public_ids: string[], callback?: ResponseCallback): Promise<any>;
999
1000 function remove_tag(tag: string, public_ids: string[], options?: { tag?: string, resource_type?: ResourceType, type?: DeliveryType }, callback?: ResponseCallback): Promise<any>;
1001
1002 function remove_tag(tag: string, public_ids: string[], callback?: ResponseCallback): Promise<any>;
1003
1004 function rename(from_public_id: string, to_public_id: string, options?: { resource_type?: ResourceType, type?: DeliveryType, to_type?: DeliveryType, overwrite?: boolean, invalidate?: boolean }, callback?: ResponseCallback): Promise<any>;
1005
1006 function rename(from_public_id: string, to_public_id: string, callback?: ResponseCallback): Promise<any>;
1007
1008 function replace_tag(tag: string, public_ids: string[], options?: { resource_type?: ResourceType, type?: DeliveryType }, callback?: ResponseCallback): Promise<any>;
1009
1010 function replace_tag(tag: string, public_ids: string[], callback?: ResponseCallback): Promise<any>;
1011
1012 function text(text: string, options?: TextStyleOptions | { public_id?: string }, callback?: ResponseCallback): Promise<any>;
1013
1014 function text(text: string, callback?: ResponseCallback): Promise<any>;
1015
1016 function unsigned_image_upload_tag(field: string, upload_preset: string, options?: UploadApiOptions): Promise<any>;
1017
1018 function unsigned_upload(file: string, upload_preset: string, options?: UploadApiOptions, callback?: ResponseCallback): Promise<any>;
1019
1020 function unsigned_upload(file: string, upload_preset: string, callback?: ResponseCallback): Promise<any>;
1021
1022 function unsigned_upload_stream(upload_preset: string, options?: UploadApiOptions, callback?: ResponseCallback): UploadStream;
1023
1024 function unsigned_upload_stream(upload_preset: string, callback?: ResponseCallback): UploadStream;
1025
1026 function upload(file: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
1027
1028 function upload(file: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
1029
1030 function upload_chunked(path: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
1031
1032 function upload_chunked(path: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
1033
1034 function upload_chunked_stream(options?: UploadApiOptions, callback?: UploadResponseCallback): UploadStream;
1035
1036 function upload_large(path: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
1037
1038 function upload_large(path: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
1039
1040 function upload_stream(options?: UploadApiOptions, callback?: UploadResponseCallback): UploadStream;
1041
1042 function upload_stream(callback?: UploadResponseCallback): UploadStream;
1043
1044 function upload_tag_params(options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<any>;
1045
1046 function upload_url(options?: ConfigOptions): Promise<any>;
1047
1048 function create_slideshow(options?: ConfigOptions & { manifest_transformation?: TransformationOptions, manifest_json?: Record<string, any>}, callback?: UploadResponseCallback): Promise<any>;
1049
1050 /****************************** Structured Metadata API V2 Methods *************************************/
1051
1052 function update_metadata(metadata: string | object, public_ids: string[], options?:UploadApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
1053
1054 function update_metadata(metadata: string| object, public_ids: string[], callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
1055 }
1056
1057 /****************************** Search API *************************************/
1058
1059 class search {
1060
1061 aggregate(value?: string): search;
1062
1063 execute(): Promise<any>;
1064
1065 expression(value?: string): search;
1066
1067 max_results(value?: number): search;
1068
1069 next_cursor(value?: string): search;
1070
1071 sort_by(key: string, value: 'asc' | 'desc'): search;
1072
1073 to_query(value?: string): search;
1074
1075 with_field(value?: string): search;
1076
1077 static aggregate(args?: string): search;
1078
1079 static expression(args?: string): search;
1080
1081 static instance(args?: string): search;
1082
1083 static max_results(args?: number): search;
1084
1085 static next_cursor(args?: string): search;
1086
1087 static sort_by(key: string, value: 'asc' | 'desc'): search;
1088
1089 static with_field(args?: string): search;
1090 }
1091
1092 /****************************** Provisioning API *************************************/
1093
1094 namespace provisioning {
1095 namespace account {
1096 function sub_accounts(enabled: boolean, ids?: string[], prefix?: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1097
1098 function sub_account(subAccountId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1099
1100 function create_sub_account(name: string, cloudName: string, customAttributes?: object, enabled?: boolean, baseAccount?: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1101
1102 function delete_sub_account(subAccountId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1103
1104 function update_sub_account(subAccountId: string, name?: string, cloudName?: string, customAttributes?: object, enabled?: boolean, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1105
1106 function user(userId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1107
1108 function users(pending: boolean, userIds?: string[], prefix?: string, subAccountId?: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1109
1110 function create_user(name: string, email: string, role: string, subAccountIds?: string[], options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1111
1112 function update_user(userId: string, name?: string, email?: string, role?: string, subAccountIds?: string[], options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1113
1114 function delete_user(userId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1115
1116 function create_user_group(name: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1117
1118 function update_user_group(groupId: string, name: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1119
1120 function delete_user_group(groupId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1121
1122 function add_user_to_group(groupId: string, userId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1123
1124 function remove_user_from_group(groupId: string, userId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1125
1126 function user_group(groupId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1127
1128 function user_groups(options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1129
1130 function user_group_users(groupId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
1131 }
1132 }
1133 }
1134}