1 | import { Transform } from 'stream';
|
2 |
|
3 |
|
4 | declare module 'cloudinary' {
|
5 |
|
6 |
|
7 |
|
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 |
|
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 |
|
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 | private_cdn?: boolean;
|
331 | secure_distribution?: string;
|
332 | force_version?: boolean;
|
333 | ssl_detected?: boolean;
|
334 | secure?: boolean;
|
335 | cdn_subdomain?: boolean;
|
336 | secure_cdn_subdomain?: boolean;
|
337 | cname?: string;
|
338 | shorten?: boolean;
|
339 | sign_url?: boolean;
|
340 | long_url_signature?: boolean;
|
341 | use_root_path?: boolean;
|
342 | auth_token?: object;
|
343 | account_id?: string;
|
344 | provisioning_api_key?: string;
|
345 | provisioning_api_secret?: string;
|
346 | oauth_token?: string;
|
347 |
|
348 | [futureKey: string]: any;
|
349 | }
|
350 |
|
351 | export interface ResourceOptions {
|
352 | type?: string;
|
353 | resource_type?: string;
|
354 | }
|
355 |
|
356 | export interface UrlOptions extends ResourceOptions {
|
357 | version?: string;
|
358 | format?: string;
|
359 | url_suffix?: string;
|
360 |
|
361 | [futureKey: string]: any;
|
362 | }
|
363 |
|
364 | export interface ImageTagOptions {
|
365 | html_height?: string;
|
366 | html_width?: string;
|
367 | srcset?: object;
|
368 | attributes?: object;
|
369 | client_hints?: boolean;
|
370 | responsive?: boolean;
|
371 | hidpi?: boolean;
|
372 | responsive_placeholder?: boolean;
|
373 |
|
374 | [futureKey: string]: any;
|
375 | }
|
376 |
|
377 | export interface VideoTagOptions {
|
378 | source_types?: string | string[];
|
379 | source_transformation?: TransformationOptions;
|
380 | fallback_content?: string;
|
381 | poster?: string | object;
|
382 | controls?: boolean;
|
383 | preload?: string;
|
384 |
|
385 | [futureKey: string]: any;
|
386 | }
|
387 |
|
388 |
|
389 | export interface AdminApiOptions {
|
390 | agent?: object;
|
391 | content_type?: string;
|
392 | oauth_token?: string;
|
393 |
|
394 | [futureKey: string]: any;
|
395 | }
|
396 |
|
397 | export interface ArchiveApiOptions {
|
398 | allow_missing?: boolean;
|
399 | async?: boolean;
|
400 | expires_at?: number;
|
401 | flatten_folders?: boolean;
|
402 | flatten_transformations?: boolean;
|
403 | keep_derived?: boolean;
|
404 | mode?: string;
|
405 | notification_url?: string;
|
406 | prefixes?: string;
|
407 | public_ids?: string[] | string;
|
408 | fully_qualified_public_ids?: string[] | string;
|
409 | skip_transformation_name?: boolean;
|
410 | tags?: string | string[];
|
411 | target_format?: TargetArchiveFormat;
|
412 | target_public_id?: string;
|
413 | target_tags?: string[];
|
414 | timestamp?: number;
|
415 | transformations?: TransformationOptions;
|
416 | type?: DeliveryType
|
417 | use_original_filename?: boolean;
|
418 |
|
419 | [futureKey: string]: any;
|
420 | }
|
421 |
|
422 | export interface UpdateApiOptions extends ResourceOptions {
|
423 | access_control?: string[];
|
424 | auto_tagging?: number;
|
425 | background_removal?: string;
|
426 | categorization?: string;
|
427 | context?: boolean | string;
|
428 | custom_coordinates?: string;
|
429 | detection?: string;
|
430 | face_coordinates?: string;
|
431 | headers?: string;
|
432 | notification_url?: string;
|
433 | ocr?: string;
|
434 | raw_convert?: string;
|
435 | similarity_search?: string;
|
436 | tags?: string | string[];
|
437 | moderation_status?: string;
|
438 | unsafe_update?: object;
|
439 | allowed_for_strict?: boolean;
|
440 |
|
441 | [futureKey: string]: any;
|
442 | }
|
443 |
|
444 | export interface PublishApiOptions extends ResourceOptions {
|
445 | invalidate?: boolean;
|
446 | overwrite?: boolean;
|
447 |
|
448 | [futureKey: string]: any;
|
449 | }
|
450 |
|
451 | export interface ResourceApiOptions extends ResourceOptions {
|
452 | transformation?: TransformationOptions;
|
453 | transformations?: TransformationOptions;
|
454 | keep_original?: boolean;
|
455 | next_cursor?: boolean | string;
|
456 | public_ids?: string[];
|
457 | prefix?: string;
|
458 | all?: boolean;
|
459 | max_results?: number;
|
460 | tags?: boolean;
|
461 | tag?: string;
|
462 | context?: boolean;
|
463 | direction?: number | string;
|
464 | moderations?: boolean;
|
465 | start_at?: string;
|
466 | exif?: boolean;
|
467 | colors?: boolean;
|
468 | derived_next_cursor?: string;
|
469 | faces?: boolean;
|
470 | image_metadata?: boolean;
|
471 | pages?: boolean;
|
472 | coordinates?: boolean;
|
473 | phash?: boolean;
|
474 | cinemagraph_analysis?: boolean;
|
475 | accessibility_analysis?: boolean;
|
476 |
|
477 | [futureKey: string]: any;
|
478 | }
|
479 |
|
480 | export interface UploadApiOptions {
|
481 | access_mode?: AccessMode;
|
482 | allowed_formats?: Array<VideoFormat> | Array<ImageFormat>;
|
483 | async?: boolean;
|
484 | backup?: boolean;
|
485 | callback?: string;
|
486 | colors?: boolean;
|
487 | discard_original_filename?: boolean;
|
488 | eager?: TransformationOptions;
|
489 | eager_async?: boolean;
|
490 | eager_notification_url?: string;
|
491 | eval?: string;
|
492 | exif?: boolean;
|
493 | faces?: boolean;
|
494 | folder?: string;
|
495 | format?: VideoFormat | ImageFormat;
|
496 | image_metadata?: boolean;
|
497 | invalidate?: boolean;
|
498 | moderation?: ModerationKind;
|
499 | notification_url?: string;
|
500 | overwrite?: boolean;
|
501 | phash?: boolean;
|
502 | proxy?: string;
|
503 | public_id?: string;
|
504 | quality_analysis?: boolean;
|
505 | responsive_breakpoints?: object;
|
506 | return_delete_token?: boolean
|
507 | timestamp?: number;
|
508 | transformation?: TransformationOptions;
|
509 | type?: DeliveryType;
|
510 | unique_filename?: boolean;
|
511 | upload_preset?: string;
|
512 | use_filename?: boolean;
|
513 | chunk_size?: number;
|
514 | disable_promises?: boolean;
|
515 | oauth_token?: string;
|
516 |
|
517 | [futureKey: string]: any;
|
518 | }
|
519 |
|
520 | export interface ProvisioningApiOptions {
|
521 | account_id?: string;
|
522 | provisioning_api_key?: string;
|
523 | provisioning_api_secret?: string;
|
524 | agent?: object;
|
525 | content_type?: string;
|
526 |
|
527 | [futureKey: string]: any;
|
528 | }
|
529 |
|
530 | export interface AuthTokenApiOptions {
|
531 | key: string;
|
532 | acl: string;
|
533 | ip?: string;
|
534 | start_time?: number;
|
535 | duration?: number;
|
536 | expiration?: number;
|
537 | url?: string;
|
538 | }
|
539 |
|
540 | type TransformationOptions =
|
541 | string
|
542 | | string[]
|
543 | | VideoTransformationOptions
|
544 | | ImageTransformationOptions
|
545 | | Object
|
546 | | Array<ImageTransformationOptions>
|
547 | | Array<VideoTransformationOptions>;
|
548 |
|
549 | type ImageTransformationAndTagsOptions = ImageTransformationOptions | ImageTagOptions;
|
550 | type VideoTransformationAndTagsOptions = VideoTransformationOptions | VideoTagOptions;
|
551 | type ImageAndVideoFormatOptions = ImageFormat | VideoFormat;
|
552 | type ConfigAndUrlOptions = ConfigOptions | UrlOptions;
|
553 | type AdminAndPublishOptions = AdminApiOptions | PublishApiOptions;
|
554 | type AdminAndResourceOptions = AdminApiOptions | ResourceApiOptions;
|
555 | type AdminAndUpdateApiOptions = AdminApiOptions | UpdateApiOptions;
|
556 |
|
557 |
|
558 | type Status = string | "pending" | "approved" | "rejected";
|
559 | type StreamingProfiles = string | "4k" | "full_hd" | "hd" | "sd" | "full_hd_wifi" | "full_hd_lean" | "hd_lean";
|
560 | type ModerationKind = string | "manual" | "webpurify" | "aws_rek" | "metascan";
|
561 | type AccessMode = string | "public" | "authenticated";
|
562 | type TargetArchiveFormat = string | "zip" | "tgz";
|
563 |
|
564 |
|
565 | type ResponseCallback = (err?: any, callResult?: any) => any;
|
566 |
|
567 | type UploadResponseCallback = (err?: UploadApiErrorResponse, callResult?: UploadApiResponse) => void;
|
568 |
|
569 | export interface UploadApiResponse {
|
570 | public_id: string;
|
571 | version: number;
|
572 | signature: string;
|
573 | width: number;
|
574 | height: number;
|
575 | format: string;
|
576 | resource_type: string;
|
577 | created_at: string;
|
578 | tags: Array<string>;
|
579 | pages: number;
|
580 | bytes: number;
|
581 | type: string;
|
582 | etag: string;
|
583 | placeholder: boolean;
|
584 | url: string;
|
585 | secure_url: string;
|
586 | access_mode: string;
|
587 | original_filename: string;
|
588 | moderation: Array<string>;
|
589 | access_control: Array<string>;
|
590 | context: object;
|
591 | metadata: object;
|
592 |
|
593 | [futureKey: string]: any;
|
594 | }
|
595 |
|
596 | export interface UploadApiErrorResponse {
|
597 | message: string;
|
598 | name: string;
|
599 | http_code: number;
|
600 |
|
601 | [futureKey: string]: any;
|
602 | }
|
603 |
|
604 | class UploadStream extends Transform {
|
605 | }
|
606 |
|
607 | export interface DeleteApiResponse {
|
608 | message: string;
|
609 | http_code: number;
|
610 | }
|
611 |
|
612 | export interface MetadataFieldApiOptions {
|
613 | external_id?: string;
|
614 | type?: string;
|
615 | label?: string;
|
616 | mandatory?: boolean;
|
617 | default_value?: number;
|
618 | validation?: object;
|
619 | datasource?: object;
|
620 |
|
621 | [futureKey: string]: any;
|
622 | }
|
623 |
|
624 | export interface MetadataFieldApiResponse {
|
625 | external_id: string;
|
626 | type: string;
|
627 | label: string;
|
628 | mandatory: boolean;
|
629 | default_value: number;
|
630 | validation: object;
|
631 | datasource: object;
|
632 |
|
633 | [futureKey: string]: any;
|
634 | }
|
635 |
|
636 | export interface MetadataFieldsApiResponse {
|
637 | metadata_fields: MetadataFieldApiResponse[]
|
638 | }
|
639 |
|
640 | export interface DatasourceChange {
|
641 | values: Array<object>
|
642 | }
|
643 |
|
644 | export interface ResourceApiResponse {
|
645 | resources: [
|
646 | {
|
647 | public_id: string;
|
648 | format: string;
|
649 | version: number;
|
650 | resource_type: string;
|
651 | type: string;
|
652 | placeholder: boolean;
|
653 | created_at: string;
|
654 | bytes: number;
|
655 | width: number;
|
656 | height: number;
|
657 | backup: boolean;
|
658 | access_mode: string;
|
659 | url: string;
|
660 | secure_url: string;
|
661 | tags: Array<string>;
|
662 | context: object;
|
663 | next_cursor: string;
|
664 | derived_next_cursor: string;
|
665 | exif: object;
|
666 | image_metadata: object;
|
667 | faces: number[][];
|
668 | quality_analysis: number;
|
669 | colors: string[][];
|
670 | derived: Array<string>;
|
671 | moderation: object;
|
672 | phash: string;
|
673 | predominant: object;
|
674 | coordinates: object;
|
675 | access_control: Array<string>;
|
676 | pages: number;
|
677 |
|
678 | [futureKey: string]: any;
|
679 | }
|
680 | ]
|
681 | }
|
682 |
|
683 |
|
684 | export namespace v2 {
|
685 |
|
686 |
|
687 |
|
688 | function cloudinary_js_config(): string;
|
689 |
|
690 | function config(new_config?: boolean | ConfigOptions): ConfigOptions;
|
691 |
|
692 | function config<K extends keyof ConfigOptions, V extends ConfigOptions[K]>(key: K, value?: undefined): V;
|
693 |
|
694 | function config<K extends keyof ConfigOptions, V extends ConfigOptions[K]>(key: K, value: V): ConfigOptions & { [Property in K]: V }
|
695 |
|
696 | function url(public_id: string, options?: TransformationOptions | ConfigAndUrlOptions): string;
|
697 |
|
698 |
|
699 |
|
700 | function image(source: string, options?: ImageTransformationAndTagsOptions | ConfigAndUrlOptions): string;
|
701 |
|
702 | function picture(public_id: string, options?: ImageTransformationAndTagsOptions | ConfigAndUrlOptions): string;
|
703 |
|
704 | function source(public_id: string, options?: TransformationOptions | ConfigAndUrlOptions): string;
|
705 |
|
706 | function video(public_id: string, options?: VideoTransformationAndTagsOptions | ConfigAndUrlOptions): string;
|
707 |
|
708 |
|
709 |
|
710 | namespace utils {
|
711 |
|
712 | function sign_request(params_to_sign: object, options?: ConfigAndUrlOptions): { signature: string; api_key: string; [key:string]:any};
|
713 |
|
714 | function api_sign_request(params_to_sign: object, api_secret: string): string;
|
715 |
|
716 | function api_url(action?: string, options?: ConfigAndUrlOptions): string;
|
717 |
|
718 | function url(public_id?: string, options?: TransformationOptions | ConfigAndUrlOptions): string;
|
719 |
|
720 | function video_thumbnail_url(public_id?: string, options?: VideoTransformationOptions | ConfigAndUrlOptions): string;
|
721 |
|
722 | function video_url(public_id?: string, options?: VideoTransformationOptions | ConfigAndUrlOptions): string;
|
723 |
|
724 | function archive_params(options?: ArchiveApiOptions): Promise<any>;
|
725 |
|
726 | function download_archive_url(options?: ArchiveApiOptions | ConfigAndUrlOptions): string
|
727 |
|
728 | function download_zip_url(options?: ArchiveApiOptions | ConfigAndUrlOptions): string;
|
729 |
|
730 | function generate_auth_token(options?: AuthTokenApiOptions): string;
|
731 |
|
732 | function webhook_signature(data?: string, timestamp?: number, options?: ConfigOptions): string;
|
733 |
|
734 | function private_download_url(publicID: string, format:string, options: Partial<{
|
735 | resource_type: ResourceType;
|
736 | type: DeliveryType;
|
737 | expires_at: number;
|
738 | attachment: boolean;
|
739 | }>): string;
|
740 | }
|
741 |
|
742 | /****************************** Admin API V2 Methods *************************************/
|
743 |
|
744 | namespace api {
|
745 | function create_streaming_profile(name: string, options: AdminApiOptions | { display_name?: string, representations: TransformationOptions }, callback?: ResponseCallback): Promise<any>;
|
746 |
|
747 | function create_transformation(name: string, transformation: TransformationOptions, callback?: ResponseCallback): Promise<any>;
|
748 |
|
749 | function create_transformation(name: string, transformation: TransformationOptions, options?: AdminApiOptions | { allowed_for_strict?: boolean }, callback?: ResponseCallback): Promise<any>;
|
750 |
|
751 | function create_upload_mapping(folder: string, options: AdminApiOptions | { template: string }, callback?: ResponseCallback): Promise<any>;
|
752 |
|
753 | function create_upload_preset(options?: AdminApiOptions | { name?: string, unsigned?: boolean, disallow_public_id?: boolean }, callback?: ResponseCallback): Promise<any>;
|
754 |
|
755 | function delete_all_resources(value?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
|
756 |
|
757 | function delete_derived_by_transformation(public_ids: string[], transformations: TransformationOptions, callback?: ResponseCallback): Promise<any>;
|
758 |
|
759 | function delete_derived_by_transformation(public_ids: string[], transformations: TransformationOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
760 |
|
761 | function delete_derived_resources(public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
762 |
|
763 | function delete_derived_resources(public_ids: string[], options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
|
764 |
|
765 | function delete_resources(value: string[], callback?: ResponseCallback): Promise<any>;
|
766 |
|
767 | function delete_resources(value: string[], options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
|
768 |
|
769 | function delete_resources_by_prefix(prefix: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
|
770 |
|
771 | function delete_resources_by_prefix(prefix: string, callback?: ResponseCallback): Promise<any>;
|
772 |
|
773 | function delete_resources_by_tag(tag: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
|
774 |
|
775 | function delete_resources_by_tag(tag: string, callback?: ResponseCallback): Promise<any>;
|
776 |
|
777 | function delete_streaming_profile(name: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
778 |
|
779 | function delete_streaming_profile(name: string, callback?: ResponseCallback): Promise<any>;
|
780 |
|
781 | function delete_transformation(transformationName: TransformationOptions, callback?: ResponseCallback): Promise<any>;
|
782 |
|
783 | function delete_transformation(transformationName: TransformationOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
784 |
|
785 | function delete_upload_mapping(folder: string, callback?: ResponseCallback): Promise<any>;
|
786 |
|
787 | function delete_upload_mapping(folder: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
788 |
|
789 | function delete_upload_preset(name: string, callback?: ResponseCallback): Promise<any>;
|
790 |
|
791 | function delete_upload_preset(name: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
792 |
|
793 | function get_streaming_profile(name: string | ResponseCallback, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
794 |
|
795 | function get_streaming_profile(name: string | ResponseCallback, callback?: ResponseCallback): Promise<any>;
|
796 |
|
797 | function list_streaming_profiles(callback?: ResponseCallback): Promise<any>;
|
798 |
|
799 | function list_streaming_profiles(options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
800 |
|
801 | function ping(options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
802 |
|
803 | function ping(callback?: ResponseCallback): Promise<any>;
|
804 |
|
805 | function publish_by_ids(public_ids: string[], options?: AdminAndPublishOptions, callback?: ResponseCallback): Promise<any>;
|
806 |
|
807 | function publish_by_ids(public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
808 |
|
809 | function publish_by_prefix(prefix: string[] | string, options?: AdminAndPublishOptions, callback?: ResponseCallback): Promise<any>;
|
810 |
|
811 | function publish_by_prefix(prefix: string[] | string, callback?: ResponseCallback): Promise<any>;
|
812 |
|
813 | function publish_by_tag(tag: string, options?: AdminAndPublishOptions, callback?: ResponseCallback): Promise<any>;
|
814 |
|
815 | function publish_by_tag(tag: string, callback?: ResponseCallback): Promise<any>;
|
816 |
|
817 | function resource(public_id: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
|
818 |
|
819 | function resource(public_id: string, callback?: ResponseCallback): Promise<any>;
|
820 |
|
821 | function resource_types(options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
822 |
|
823 | function resources(options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<any>;
|
824 |
|
825 | function resources_by_context(key: string, value?: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<ResourceApiResponse>;
|
826 |
|
827 | function resources_by_context(key: string, value?: string, options?: AdminAndResourceOptions): Promise<ResourceApiResponse>;
|
828 |
|
829 | function resources_by_context(key: string, options?: AdminAndResourceOptions): Promise<ResourceApiResponse>;
|
830 |
|
831 | function resources_by_context(key: string, callback?: ResponseCallback): Promise<ResourceApiResponse>;
|
832 |
|
833 | function resources_by_ids(public_ids: string[] | string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<ResourceApiResponse>;
|
834 |
|
835 | function resources_by_ids(public_ids: string[] | string, callback?: ResponseCallback): Promise<ResourceApiResponse>;
|
836 |
|
837 | function resources_by_moderation(moderation: ModerationKind, status: Status, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<ResourceApiResponse>;
|
838 |
|
839 | function resources_by_moderation(moderation: ModerationKind, status: Status, callback?: ResponseCallback): Promise<ResourceApiResponse>;
|
840 |
|
841 | function resources_by_tag(tag: string, options?: AdminAndResourceOptions, callback?: ResponseCallback): Promise<ResourceApiResponse>;
|
842 |
|
843 | function resources_by_tag(tag: string, callback?: ResponseCallback): Promise<ResourceApiResponse>;
|
844 |
|
845 | function restore(public_ids: string[], options?: AdminApiOptions | { resource_type: ResourceType, type: DeliveryType }, callback?: ResponseCallback): Promise<any>;
|
846 |
|
847 | function restore(public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
848 |
|
849 | function root_folders(callback?: ResponseCallback, options?: AdminApiOptions): Promise<any>;
|
850 |
|
851 | function search(params: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
852 |
|
853 | function search(params: string, callback?: ResponseCallback): Promise<any>;
|
854 |
|
855 | function sub_folders(root_folder: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
856 |
|
857 | function sub_folders(root_folder: string, callback?: ResponseCallback): Promise<any>;
|
858 |
|
859 | function tags(callback?: ResponseCallback, options?: AdminApiOptions | { max_results?: number, next_cursor?: string, prefix?: string }): Promise<any>;
|
860 |
|
861 | function transformation(transformation: TransformationOptions, options?: AdminApiOptions | { max_results?: number, next_cursor?: string, named?: boolean }, callback?: ResponseCallback): Promise<any>;
|
862 |
|
863 | function transformation(transformation: TransformationOptions, callback?: ResponseCallback): Promise<any>;
|
864 |
|
865 | function transformations(options?: AdminApiOptions | { max_results?: number, next_cursor?: string, named?: boolean }, callback?: ResponseCallback): Promise<any>;
|
866 |
|
867 | function transformations(callback?: ResponseCallback): Promise<any>;
|
868 |
|
869 | function update(public_id: string, options?: AdminAndUpdateApiOptions, callback?: ResponseCallback): Promise<any>;
|
870 |
|
871 | function update(public_id: string, callback?: ResponseCallback): Promise<any>;
|
872 |
|
873 | function update_resources_access_mode_by_ids(access_mode: AccessMode, ids: string[], options?: AdminAndUpdateApiOptions, callback?: ResponseCallback): Promise<any>;
|
874 |
|
875 | function update_resources_access_mode_by_ids(access_mode: AccessMode, ids: string[], callback?: ResponseCallback): Promise<any>;
|
876 |
|
877 | function update_resources_access_mode_by_prefix(access_mode: AccessMode, prefix: string, options?: AdminAndUpdateApiOptions, callback?: ResponseCallback): Promise<any>;
|
878 |
|
879 | function update_resources_access_mode_by_prefix(access_mode: AccessMode, prefix: string, callback?: ResponseCallback): Promise<any>;
|
880 |
|
881 | function update_resources_access_mode_by_tag(access_mode: AccessMode, tag: string, options?: AdminAndUpdateApiOptions, callback?: ResponseCallback): Promise<any>;
|
882 |
|
883 | function update_resources_access_mode_by_tag(access_mode: AccessMode, tag: string, callback?: ResponseCallback): Promise<any>;
|
884 |
|
885 | function update_streaming_profile(name: string, options: { display_name?: string, representations: Array<{ transformation?: VideoTransformationOptions }> }, callback?: ResponseCallback): Promise<any>;
|
886 |
|
887 | function update_transformation(transformation_name: TransformationOptions, updates?: TransformationOptions, callback?: ResponseCallback): Promise<any>;
|
888 |
|
889 | function update_transformation(transformation_name: TransformationOptions, callback?: ResponseCallback): Promise<any>;
|
890 |
|
891 | function update_upload_mapping(name: string, options: AdminApiOptions | { template: string }, callback?: ResponseCallback): Promise<any>;
|
892 |
|
893 | function update_upload_preset(name?: string, options?: AdminApiOptions | { unsigned?: boolean, disallow_public_id?: boolean }, callback?: ResponseCallback): Promise<any>;
|
894 |
|
895 | function update_upload_preset(name?: string, callback?: ResponseCallback): Promise<any>;
|
896 |
|
897 | function upload_mapping(name?: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
898 |
|
899 | function upload_mapping(name?: string, callback?: ResponseCallback): Promise<any>;
|
900 |
|
901 | function upload_mappings(options?: AdminApiOptions | { max_results?: number, next_cursor?: string }, callback?: ResponseCallback): Promise<any>;
|
902 |
|
903 | function upload_mappings(callback?: ResponseCallback): Promise<any>;
|
904 |
|
905 | function upload_preset(name?: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
906 |
|
907 | function upload_preset(name?: string, callback?: ResponseCallback): Promise<any>;
|
908 |
|
909 | function upload_presets(options?: AdminApiOptions | { max_results?: number, next_cursor?: string }, callback?: ResponseCallback): Promise<any>;
|
910 |
|
911 | function usage(callback?: ResponseCallback, options?: AdminApiOptions): Promise<any>;
|
912 |
|
913 | function usage(options?: AdminApiOptions): Promise<any>;
|
914 |
|
915 | function create_folder(path:string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
916 |
|
917 | function delete_folder(path:string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
|
918 |
|
919 |
|
920 |
|
921 | function add_metadata_field(field: MetadataFieldApiOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
|
922 |
|
923 | function add_metadata_field(field: MetadataFieldApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
|
924 |
|
925 | function list_metadata_fields(callback?: ResponseCallback, options?: AdminApiOptions): Promise<MetadataFieldsApiResponse>;
|
926 |
|
927 | function list_metadata_fields(options?: AdminApiOptions): Promise<MetadataFieldsApiResponse>;
|
928 |
|
929 | function delete_metadata_field(field_external_id: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<DeleteApiResponse>;
|
930 |
|
931 | function delete_metadata_field(field_external_id: string, callback?: ResponseCallback): Promise<DeleteApiResponse>;
|
932 |
|
933 | function metadata_field_by_field_id(external_id:string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
|
934 |
|
935 | function metadata_field_by_field_id(external_id:string, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
|
936 |
|
937 | function update_metadata_field(external_id: string, field: MetadataFieldApiOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
|
938 |
|
939 | function update_metadata_field(external_id: string, field: MetadataFieldApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
|
940 |
|
941 | function update_metadata_field_datasource(field_external_id: string, entries_external_id: object, options?: AdminApiOptions, callback?: ResponseCallback): Promise<DatasourceChange>;
|
942 |
|
943 | function update_metadata_field_datasource(field_external_id: string, entries_external_id: object, callback?: ResponseCallback): Promise<DatasourceChange>;
|
944 |
|
945 | function delete_datasource_entries(field_external_id: string, entries_external_id: string[], options?: AdminApiOptions, callback?: ResponseCallback): Promise<DatasourceChange>;
|
946 |
|
947 | function delete_datasource_entries(field_external_id: string, entries_external_id: string[], callback?: ResponseCallback): Promise<DatasourceChange>;
|
948 |
|
949 | function restore_metadata_field_datasource(field_external_id: string, entries_external_id: string[], options?: AdminApiOptions, callback?: ResponseCallback): Promise<DatasourceChange>;
|
950 |
|
951 | function restore_metadata_field_datasource(field_external_id: string, entries_external_id: string[], callback?: ResponseCallback): Promise<DatasourceChange>;
|
952 | }
|
953 |
|
954 |
|
955 |
|
956 | namespace uploader {
|
957 | function add_context(context: string, public_ids: string[], options?: { type?: DeliveryType, resource_type?: ResourceType }, callback?: ResponseCallback): Promise<any>;
|
958 |
|
959 | function add_context(context: string, public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
960 |
|
961 | function add_tag(tag: string, public_ids: string[], options?: { type?: DeliveryType, resource_type?: ResourceType }, callback?: ResponseCallback): Promise<any>;
|
962 |
|
963 | function add_tag(tag: string, public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
964 |
|
965 | function create_archive(options?: ArchiveApiOptions, target_format?: TargetArchiveFormat, callback?: ResponseCallback,): Promise<any>;
|
966 |
|
967 | function create_zip(options?: ArchiveApiOptions, callback?: ResponseCallback): Promise<any>;
|
968 |
|
969 | function destroy(public_id: string, options?: { resource_type?: ResourceType, type?: DeliveryType, invalidate?: boolean }, callback?: ResponseCallback,): Promise<any>;
|
970 |
|
971 | function destroy(public_id: string, callback?: ResponseCallback,): Promise<any>;
|
972 |
|
973 | function explicit(public_id: string, options?: UploadApiOptions, callback?: ResponseCallback): Promise<any>;
|
974 |
|
975 | function explicit(public_id: string, callback?: ResponseCallback): Promise<any>;
|
976 |
|
977 | function explode(public_id: string, options?: { page?: 'all', type?: DeliveryType, format?: ImageAndVideoFormatOptions, notification_url?: string, transformations?: TransformationOptions }, callback?: ResponseCallback): Promise<any>
|
978 |
|
979 | function explode(public_id: string, callback?: ResponseCallback): Promise<any>
|
980 |
|
981 | function generate_sprite(tag: string, options?: { transformation?: TransformationOptions, format?: ImageAndVideoFormatOptions, notification_url?: string, async?: boolean }, callback?: ResponseCallback): Promise<any>;
|
982 |
|
983 | function generate_sprite(tag: string, callback?: ResponseCallback): Promise<any>;
|
984 |
|
985 | function image_upload_tag(field?: string, options?: UploadApiOptions): Promise<any>;
|
986 |
|
987 | function multi(tag: string, options?: { transformation?: TransformationOptions, async?: boolean, format?: ImageAndVideoFormatOptions, notification_url?: string }, callback?: ResponseCallback): Promise<any>;
|
988 |
|
989 | function multi(tag: string, callback?: ResponseCallback): Promise<any>;
|
990 |
|
991 | function remove_all_context(public_ids: string[], options?: { context?: string, resource_type?: ResourceType, type?: DeliveryType }, callback?: ResponseCallback): Promise<any>;
|
992 |
|
993 | function remove_all_context(public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
994 |
|
995 | function remove_all_tags(public_ids: string[], options?: { tag?: string, resource_type?: ResourceType, type?: DeliveryType }, callback?: ResponseCallback): Promise<any>;
|
996 |
|
997 | function remove_all_tags(public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
998 |
|
999 | function remove_tag(tag: string, public_ids: string[], options?: { tag?: string, resource_type?: ResourceType, type?: DeliveryType }, callback?: ResponseCallback): Promise<any>;
|
1000 |
|
1001 | function remove_tag(tag: string, public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
1002 |
|
1003 | 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>;
|
1004 |
|
1005 | function rename(from_public_id: string, to_public_id: string, callback?: ResponseCallback): Promise<any>;
|
1006 |
|
1007 | function replace_tag(tag: string, public_ids: string[], options?: { resource_type?: ResourceType, type?: DeliveryType }, callback?: ResponseCallback): Promise<any>;
|
1008 |
|
1009 | function replace_tag(tag: string, public_ids: string[], callback?: ResponseCallback): Promise<any>;
|
1010 |
|
1011 | function text(text: string, options?: TextStyleOptions | { public_id?: string }, callback?: ResponseCallback): Promise<any>;
|
1012 |
|
1013 | function text(text: string, callback?: ResponseCallback): Promise<any>;
|
1014 |
|
1015 | function unsigned_image_upload_tag(field: string, upload_preset: string, options?: UploadApiOptions): Promise<any>;
|
1016 |
|
1017 | function unsigned_upload(file: string, upload_preset: string, options?: UploadApiOptions, callback?: ResponseCallback): Promise<any>;
|
1018 |
|
1019 | function unsigned_upload(file: string, upload_preset: string, callback?: ResponseCallback): Promise<any>;
|
1020 |
|
1021 | function unsigned_upload_stream(upload_preset: string, options?: UploadApiOptions, callback?: ResponseCallback): UploadStream;
|
1022 |
|
1023 | function unsigned_upload_stream(upload_preset: string, callback?: ResponseCallback): UploadStream;
|
1024 |
|
1025 | function upload(file: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
|
1026 |
|
1027 | function upload(file: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
|
1028 |
|
1029 | function upload_chunked(path: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
|
1030 |
|
1031 | function upload_chunked(path: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
|
1032 |
|
1033 | function upload_chunked_stream(options?: UploadApiOptions, callback?: UploadResponseCallback): UploadStream;
|
1034 |
|
1035 | function upload_large(path: string, options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
|
1036 |
|
1037 | function upload_large(path: string, callback?: UploadResponseCallback): Promise<UploadApiResponse>;
|
1038 |
|
1039 | function upload_stream(options?: UploadApiOptions, callback?: UploadResponseCallback): UploadStream;
|
1040 |
|
1041 | function upload_stream(callback?: UploadResponseCallback): UploadStream;
|
1042 |
|
1043 | function upload_tag_params(options?: UploadApiOptions, callback?: UploadResponseCallback): Promise<any>;
|
1044 |
|
1045 | function upload_url(options?: ConfigOptions): Promise<any>;
|
1046 |
|
1047 | function create_slideshow(options?: ConfigOptions & { manifest_transformation?: TransformationOptions, manifest_json?: Record<string, any>}, callback?: UploadResponseCallback): Promise<any>;
|
1048 |
|
1049 | /****************************** Structured Metadata API V2 Methods *************************************/
|
1050 |
|
1051 | function update_metadata(metadata: string | object, public_ids: string[], options?:UploadApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
|
1052 |
|
1053 | function update_metadata(metadata: string| object, public_ids: string[], callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;
|
1054 | }
|
1055 |
|
1056 | /****************************** Search API *************************************/
|
1057 |
|
1058 | class search {
|
1059 |
|
1060 | aggregate(value?: string): search;
|
1061 |
|
1062 | execute(): Promise<any>;
|
1063 |
|
1064 | expression(value?: string): search;
|
1065 |
|
1066 | max_results(value?: number): search;
|
1067 |
|
1068 | next_cursor(value?: string): search;
|
1069 |
|
1070 | sort_by(key: string, value: 'asc' | 'desc'): search;
|
1071 |
|
1072 | to_query(value?: string): search;
|
1073 |
|
1074 | with_field(value?: string): search;
|
1075 |
|
1076 | static aggregate(args?: string): search;
|
1077 |
|
1078 | static expression(args?: string): search;
|
1079 |
|
1080 | static instance(args?: string): search;
|
1081 |
|
1082 | static max_results(args?: number): search;
|
1083 |
|
1084 | static next_cursor(args?: string): search;
|
1085 |
|
1086 | static sort_by(key: string, value: 'asc' | 'desc'): search;
|
1087 |
|
1088 | static with_field(args?: string): search;
|
1089 | }
|
1090 |
|
1091 |
|
1092 |
|
1093 | namespace provisioning {
|
1094 | namespace account {
|
1095 | function sub_accounts(enabled: boolean, ids?: string[], prefix?: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1096 |
|
1097 | function sub_account(subAccountId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1098 |
|
1099 | function create_sub_account(name: string, cloudName: string, customAttributes?: object, enabled?: boolean, baseAccount?: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1100 |
|
1101 | function delete_sub_account(subAccountId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1102 |
|
1103 | function update_sub_account(subAccountId: string, name?: string, cloudName?: string, customAttributes?: object, enabled?: boolean, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1104 |
|
1105 | function user(userId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1106 |
|
1107 | function users(pending: boolean, userIds?: string[], prefix?: string, subAccountId?: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1108 |
|
1109 | function create_user(name: string, email: string, role: string, subAccountIds?: string[], options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1110 |
|
1111 | function update_user(userId: string, name?: string, email?: string, role?: string, subAccountIds?: string[], options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1112 |
|
1113 | function delete_user(userId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1114 |
|
1115 | function create_user_group(name: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1116 |
|
1117 | function update_user_group(groupId: string, name: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1118 |
|
1119 | function delete_user_group(groupId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1120 |
|
1121 | function add_user_to_group(groupId: string, userId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1122 |
|
1123 | function remove_user_from_group(groupId: string, userId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1124 |
|
1125 | function user_group(groupId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1126 |
|
1127 | function user_groups(options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1128 |
|
1129 | function user_group_users(groupId: string, options?: ProvisioningApiOptions, callback?: ResponseCallback): Promise<any>;
|
1130 | }
|
1131 | }
|
1132 | }
|
1133 | }
|