-
Notifications
You must be signed in to change notification settings - Fork 319
/
Copy pathapi.js
699 lines (615 loc) · 27.5 KB
/
api.js
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
const utils = require("./utils");
const call_api = require("./api_client/call_api");
const fs = require("fs");
const {
extend,
pickOnlyExistingValues
} = utils;
const TRANSFORMATIONS_URI = "transformations";
function deleteResourcesParams(options, params = {}) {
return extend(params, pickOnlyExistingValues(options, "keep_original", "invalidate", "next_cursor", "transformations"));
}
function getResourceParams(options) {
return pickOnlyExistingValues(options, "exif", "cinemagraph_analysis", "colors", "derived_next_cursor", "faces", "image_metadata", "media_metadata", "pages", "phash", "coordinates", "max_results", "versions", "accessibility_analysis", 'related', 'related_next_cursor');
}
exports.ping = function ping(callback, options = {}) {
return call_api("get", ["ping"], {}, callback, options);
};
exports.usage = function usage(callback, options = {}) {
const uri = ["usage"];
if (options.date) {
uri.push(options.date);
}
return call_api("get", uri, {}, callback, options);
};
exports.resource_types = function resource_types(callback, options = {}) {
return call_api("get", ["resources"], {}, callback, options);
};
exports.resources = function resources(callback, options = {}) {
let resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type;
uri = ["resources", resource_type];
if (type != null) {
uri.push(type);
}
if ((options.start_at != null) && Object.prototype.toString.call(options.start_at) === '[object Date]') {
options.start_at = options.start_at.toUTCString();
}
return call_api("get", uri, pickOnlyExistingValues(options, "next_cursor", "max_results", "prefix", "tags", "context", "direction", "moderations", "start_at", "metadata"), callback, options);
};
exports.resources_by_tag = function resources_by_tag(tag, callback, options = {}) {
let resource_type, uri;
resource_type = options.resource_type || "image";
uri = ["resources", resource_type, "tags", tag];
return call_api("get", uri, pickOnlyExistingValues(options, "next_cursor", "max_results", "tags", "context", "direction", "moderations", "metadata"), callback, options);
};
exports.resources_by_context = function resources_by_context(key, value, callback, options = {}) {
let params, resource_type, uri;
resource_type = options.resource_type || "image";
uri = ["resources", resource_type, "context"];
params = pickOnlyExistingValues(options, "next_cursor", "max_results", "tags", "context", "direction", "moderations", "metadata");
params.key = key;
if (value != null) {
params.value = value;
}
return call_api("get", uri, params, callback, options);
};
exports.resources_by_moderation = function resources_by_moderation(kind, status, callback, options = {}) {
let resource_type, uri;
resource_type = options.resource_type || "image";
uri = ["resources", resource_type, "moderations", kind, status];
return call_api("get", uri, pickOnlyExistingValues(options, "next_cursor", "max_results", "tags", "context", "direction", "moderations", "metadata"), callback, options);
};
exports.resource_by_asset_id = function resource_by_asset_id(asset_id, callback, options = {}) {
const uri = ["resources", asset_id];
return call_api("get", uri, getResourceParams(options), callback, options);
}
exports.resources_by_asset_folder = function resources_by_asset_folder(asset_folder, callback, options = {}) {
let params, uri;
uri = ["resources", 'by_asset_folder'];
params = pickOnlyExistingValues(options, "next_cursor", "max_results", "tags", "context", "moderations");
params.asset_folder = asset_folder;
return call_api("get", uri, params, callback, options);
};
exports.resources_by_asset_ids = function resources_by_asset_ids(asset_ids, callback, options = {}) {
let params, uri;
uri = ["resources", "by_asset_ids"];
params = pickOnlyExistingValues(options, "tags", "context", "moderations");
params["asset_ids[]"] = asset_ids;
return call_api("get", uri, params, callback, options);
}
exports.resources_by_ids = function resources_by_ids(public_ids, callback, options = {}) {
let params, resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type || "upload";
uri = ["resources", resource_type, type];
params = pickOnlyExistingValues(options, "tags", "context", "moderations");
params["public_ids[]"] = public_ids;
return call_api("get", uri, params, callback, options);
};
exports.resource = function resource(public_id, callback, options = {}) {
let resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type || "upload";
uri = ["resources", resource_type, type, public_id];
return call_api("get", uri, getResourceParams(options), callback, options);
};
exports.restore = function restore(public_ids, callback, options = {}) {
options.content_type = 'json';
let resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type || "upload";
uri = ["resources", resource_type, type, "restore"];
return call_api("post", uri, {
public_ids: public_ids,
versions: options.versions
}, callback, options);
};
exports.update = function update(public_id, callback, options = {}) {
let params, resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type || "upload";
uri = ["resources", resource_type, type, public_id];
params = utils.updateable_resource_params(options);
if (options.moderation_status != null) {
params.moderation_status = options.moderation_status;
}
if (options.clear_invalid != null) {
params.clear_invalid = options.clear_invalid;
}
return call_api("post", uri, params, callback, options);
};
exports.delete_resources = function delete_resources(public_ids, callback, options = {}) {
let resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type || "upload";
uri = ["resources", resource_type, type];
return call_api("delete", uri, deleteResourcesParams(options, {
"public_ids[]": public_ids
}), callback, options);
};
exports.delete_resources_by_prefix = function delete_resources_by_prefix(prefix, callback, options = {}) {
let resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type || "upload";
uri = ["resources", resource_type, type];
return call_api("delete", uri, deleteResourcesParams(options, {
prefix: prefix
}), callback, options);
};
exports.delete_resources_by_tag = function delete_resources_by_tag(tag, callback, options = {}) {
let resource_type, uri;
resource_type = options.resource_type || "image";
uri = ["resources", resource_type, "tags", tag];
return call_api("delete", uri, deleteResourcesParams(options), callback, options);
};
exports.delete_all_resources = function delete_all_resources(callback, options = {}) {
let resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type || "upload";
uri = ["resources", resource_type, type];
return call_api("delete", uri, deleteResourcesParams(options, {
all: true
}), callback, options);
};
const createRelationParams = (publicIds = []) => {
return {
assets_to_relate: Array.isArray(publicIds) ? publicIds : [publicIds]
};
};
const deleteRelationParams = (publicIds = []) => {
return {
assets_to_unrelate: Array.isArray(publicIds) ? publicIds : [publicIds]
};
};
exports.add_related_assets = (publicId, assetsToRelate, callback, options = {}) => {
const params = createRelationParams(assetsToRelate);
return call_api('post', ['resources', 'related_assets', options.resource_type, options.type, publicId], params, callback, options);
};
exports.add_related_assets_by_asset_id = (assetId, assetsToRelate, callback, options = {}) => {
const params = createRelationParams(assetsToRelate);
return call_api('post', ['resources', 'related_assets', assetId], params, callback, options);
};
exports.delete_related_assets = (publicId, assetsToUnrelate, callback, options = {}) => {
const params = deleteRelationParams(assetsToUnrelate);
return call_api('delete', ['resources', 'related_assets', options.resource_type, options.type, publicId], params, callback, options);
};
exports.delete_related_assets_by_asset_id = (assetId, assetsToUnrelate, callback, options = {}) => {
const params = deleteRelationParams(assetsToUnrelate);
return call_api('delete', ['resources', 'related_assets', assetId], params, callback, options);
};
exports.delete_derived_resources = function delete_derived_resources(derived_resource_ids, callback, options = {}) {
let uri;
uri = ["derived_resources"];
return call_api("delete", uri, {
"derived_resource_ids[]": derived_resource_ids
}, callback, options);
};
exports.delete_derived_by_transformation = function delete_derived_by_transformation(
public_ids,
transformations,
callback,
options = {}
) {
let params, resource_type, type, uri;
resource_type = options.resource_type || "image";
type = options.type || "upload";
uri = "resources/" + resource_type + "/" + type;
params = extend({
"public_ids[]": public_ids
}, pickOnlyExistingValues(options, "invalidate"));
params.keep_original = true;
params.transformations = utils.build_eager(transformations);
return call_api("delete", uri, params, callback, options);
};
exports.tags = function tags(callback, options = {}) {
let resource_type, uri;
resource_type = options.resource_type || "image";
uri = ["tags", resource_type];
return call_api("get", uri, pickOnlyExistingValues(options, "next_cursor", "max_results", "prefix"), callback, options);
};
exports.transformations = function transformations(callback, options = {}) {
const params = pickOnlyExistingValues(options, "next_cursor", "max_results", "named");
return call_api("get", TRANSFORMATIONS_URI, params, callback, options);
};
exports.transformation = function transformation(transformationName, callback, options = {}) {
const params = pickOnlyExistingValues(options, "next_cursor", "max_results");
params.transformation = utils.build_eager(transformationName);
return call_api("get", TRANSFORMATIONS_URI, params, callback, options);
};
exports.delete_transformation = function delete_transformation(transformationName, callback, options = {}) {
const params = {};
params.transformation = utils.build_eager(transformationName);
return call_api("delete", TRANSFORMATIONS_URI, params, callback, options);
};
exports.update_transformation = function update_transformation(transformationName, updates, callback, options = {}) {
const params = pickOnlyExistingValues(updates, "allowed_for_strict");
params.transformation = utils.build_eager(transformationName);
if (updates.unsafe_update != null) {
params.unsafe_update = utils.build_eager(updates.unsafe_update);
}
return call_api("put", TRANSFORMATIONS_URI, params, callback, options);
};
exports.create_transformation = function create_transformation(name, definition, callback, options = {}) {
const params = {name};
params.transformation = utils.build_eager(definition);
return call_api("post", TRANSFORMATIONS_URI, params, callback, options);
};
exports.upload_presets = function upload_presets(callback, options = {}) {
return call_api("get", ["upload_presets"], pickOnlyExistingValues(options, "next_cursor", "max_results"), callback, options);
};
exports.upload_preset = function upload_preset(name, callback, options = {}) {
let uri;
uri = ["upload_presets", name];
return call_api("get", uri, {}, callback, options);
};
exports.delete_upload_preset = function delete_upload_preset(name, callback, options = {}) {
let uri;
uri = ["upload_presets", name];
return call_api("delete", uri, {}, callback, options);
};
exports.update_upload_preset = function update_upload_preset(name, callback, options = {}) {
let params, uri;
uri = ["upload_presets", name];
params = utils.merge(utils.clear_blank(utils.build_upload_params(options)), pickOnlyExistingValues(options, "unsigned", "disallow_public_id", "live"));
return call_api("put", uri, params, callback, options);
};
exports.create_upload_preset = function create_upload_preset(callback, options = {}) {
let params, uri;
uri = ["upload_presets"];
params = utils.merge(utils.clear_blank(utils.build_upload_params(options)), pickOnlyExistingValues(options, "name", "unsigned", "disallow_public_id", "live"));
return call_api("post", uri, params, callback, options);
};
exports.root_folders = function root_folders(callback, options = {}) {
let uri, params;
uri = ["folders"];
params = pickOnlyExistingValues(options, "next_cursor", "max_results");
return call_api("get", uri, params, callback, options);
};
exports.sub_folders = function sub_folders(path, callback, options = {}) {
let uri, params;
uri = ["folders", path];
params = pickOnlyExistingValues(options, "next_cursor", "max_results");
return call_api("get", uri, params, callback, options);
};
/**
* Creates an empty folder
*
* @param {string} path The folder path to create
* @param {function} callback Callback function
* @param {object} options Configuration options
* @returns {*}
*/
exports.create_folder = function create_folder(path, callback, options = {}) {
let uri;
uri = ["folders", path];
return call_api("post", uri, {}, callback, options);
};
exports.delete_folder = function delete_folder(path, callback, options = {}) {
let uri;
uri = ["folders", path];
return call_api("delete", uri, {}, callback, options);
};
exports.upload_mappings = function upload_mappings(callback, options = {}) {
let params;
params = pickOnlyExistingValues(options, "next_cursor", "max_results");
return call_api("get", "upload_mappings", params, callback, options);
};
exports.upload_mapping = function upload_mapping(name, callback, options = {}) {
if (name == null) {
name = null;
}
return call_api("get", 'upload_mappings', {
folder: name
}, callback, options);
};
exports.delete_upload_mapping = function delete_upload_mapping(name, callback, options = {}) {
return call_api("delete", 'upload_mappings', {
folder: name
}, callback, options);
};
exports.update_upload_mapping = function update_upload_mapping(name, callback, options = {}) {
let params;
params = pickOnlyExistingValues(options, "template");
params.folder = name;
return call_api("put", 'upload_mappings', params, callback, options);
};
exports.create_upload_mapping = function create_upload_mapping(name, callback, options = {}) {
let params;
params = pickOnlyExistingValues(options, "template");
params.folder = name;
return call_api("post", 'upload_mappings', params, callback, options);
};
function publishResource(byKey, value, callback, options = {}) {
let params, resource_type, uri;
params = pickOnlyExistingValues(options, "type", "invalidate", "overwrite");
params[byKey] = value;
resource_type = options.resource_type || "image";
uri = ["resources", resource_type, "publish_resources"];
options = extend({
resource_type: resource_type
}, options);
return call_api("post", uri, params, callback, options);
}
exports.publish_by_prefix = function publish_by_prefix(prefix, callback, options = {}) {
return publishResource("prefix", prefix, callback, options);
};
exports.publish_by_tag = function publish_by_tag(tag, callback, options = {}) {
return publishResource("tag", tag, callback, options);
};
exports.publish_by_ids = function publish_by_ids(public_ids, callback, options = {}) {
return publishResource("public_ids", public_ids, callback, options);
};
exports.list_streaming_profiles = function list_streaming_profiles(callback, options = {}) {
return call_api("get", "streaming_profiles", {}, callback, options);
};
exports.get_streaming_profile = function get_streaming_profile(name, callback, options = {}) {
return call_api("get", "streaming_profiles/" + name, {}, callback, options);
};
exports.delete_streaming_profile = function delete_streaming_profile(name, callback, options = {}) {
return call_api("delete", "streaming_profiles/" + name, {}, callback, options);
};
exports.update_streaming_profile = function update_streaming_profile(name, callback, options = {}) {
let params;
params = utils.build_streaming_profiles_param(options);
return call_api("put", "streaming_profiles/" + name, params, callback, options);
};
exports.create_streaming_profile = function create_streaming_profile(name, callback, options = {}) {
let params;
params = utils.build_streaming_profiles_param(options);
params.name = name;
return call_api("post", 'streaming_profiles', params, callback, options);
};
function updateResourcesAccessMode(access_mode, by_key, value, callback, options = {}) {
let params, resource_type, type;
resource_type = options.resource_type || "image";
type = options.type || "upload";
params = {
access_mode: access_mode
};
params[by_key] = value;
return call_api("post", "resources/" + resource_type + "/" + type + "/update_access_mode", params, callback, options);
}
exports.search = function search(params, callback, options = {}) {
options.content_type = 'json';
return call_api("post", "resources/search", params, callback, options);
};
function handleImageFile(image_file) {
if (Buffer.isBuffer(image_file)) {
return image_file;
}
if (typeof image_file === 'string') {
return fs.createReadStream(image_file);
}
throw new Error('image_file has to be either a path to file or a buffer');
}
exports.visual_search = function visual_search(params, callback, options = {}) {
const allowedParams = pickOnlyExistingValues(params, 'image_url', 'image_asset_id', 'text', 'image_file');
if ('image_file' in allowedParams) {
const imageFileData = handleImageFile(allowedParams.image_file);
return call_api('post', ['resources', 'visual_search'], {image_file: imageFileData}, callback, options);
}
return call_api('get', ['resources', 'visual_search'], allowedParams, callback, options);
};
exports.search_folders = function search_folders(params, callback, options = {}) {
options.content_type = 'json';
return call_api("post", "folders/search", params, callback, options);
};
exports.update_resources_access_mode_by_prefix = function update_resources_access_mode_by_prefix(
access_mode,
prefix,
callback,
options = {}
) {
return updateResourcesAccessMode(access_mode, "prefix", prefix, callback, options);
};
exports.update_resources_access_mode_by_tag = function update_resources_access_mode_by_tag(
access_mode,
tag,
callback,
options = {}
) {
return updateResourcesAccessMode(access_mode, "tag", tag, callback, options);
};
exports.update_resources_access_mode_by_ids = function update_resources_access_mode_by_ids(
access_mode,
ids,
callback,
options = {}
) {
return updateResourcesAccessMode(access_mode, "public_ids[]", ids, callback, options);
};
/**
* Creates a new metadata field definition
*
* @see https://cloudinary.com/documentation/admin_api#create_a_metadata_field
*
* @param {Object} field The field to add
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.add_metadata_field = function add_metadata_field(field, callback, options = {}) {
const params = pickOnlyExistingValues(field, "external_id", "type", "label", "mandatory", "default_value", "validation", "datasource");
options.content_type = "json";
return call_api("post", ["metadata_fields"], params, callback, options);
};
/**
* Returns a list of all metadata field definitions
*
* @see https://cloudinary.com/documentation/admin_api#get_metadata_fields
*
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.list_metadata_fields = function list_metadata_fields(callback, options = {}) {
return call_api("get", ["metadata_fields"], {}, callback, options);
};
/**
* Deletes a metadata field definition.
*
* The field should no longer be considered a valid candidate for all other endpoints
*
* @see https://cloudinary.com/documentation/admin_api#delete_a_metadata_field_by_external_id
*
* @param {String} field_external_id The external id of the field to delete
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.delete_metadata_field = function delete_metadata_field(field_external_id, callback, options = {}) {
return call_api("delete", ["metadata_fields", field_external_id], {}, callback, options);
};
/**
* Get a metadata field by external id
*
* @see https://cloudinary.com/documentation/admin_api#get_a_metadata_field_by_external_id
*
* @param {String} external_id The ID of the metadata field to retrieve
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.metadata_field_by_field_id = function metadata_field_by_field_id(external_id, callback, options = {}) {
return call_api("get", ["metadata_fields", external_id], {}, callback, options);
};
/**
* Updates a metadata field by external id
*
* Updates a metadata field definition (partially, no need to pass the entire object) passed as JSON data.
* See {@link https://cloudinary.com/documentation/admin_api#generic_structure_of_a_metadata_field Generic structure of a metadata field} for details.
*
* @see https://cloudinary.com/documentation/admin_api#update_a_metadata_field_by_external_id
*
* @param {String} external_id The ID of the metadata field to update
* @param {Object} field Updated values of metadata field
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.update_metadata_field = function update_metadata_field(external_id, field, callback, options = {}) {
const params = pickOnlyExistingValues(field, "external_id", "type", "label", "mandatory", "default_value", "validation", "datasource");
options.content_type = "json";
return call_api("put", ["metadata_fields", external_id], params, callback, options);
};
/**
* Updates a metadata field datasource
*
* Updates the datasource of a supported field type (currently only enum and set), passed as JSON data. The
* update is partial: datasource entries with an existing external_id will be updated and entries with new
* external_id’s (or without external_id’s) will be appended.
*
* @see https://cloudinary.com/documentation/admin_api#update_a_metadata_field_datasource
*
* @param {String} field_external_id The ID of the field to update
* @param {Object} entries_external_id Updated values for datasource
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.update_metadata_field_datasource = function update_metadata_field_datasource(field_external_id, entries_external_id, callback, options = {}) {
const params = pickOnlyExistingValues(entries_external_id, "values");
options.content_type = "json";
return call_api("put", ["metadata_fields", field_external_id, "datasource"], params, callback, options);
};
/**
* Deletes entries in a metadata field datasource
*
* Deletes (blocks) the datasource entries for a specified metadata field definition. Sets the state of the
* entries to inactive. This is a soft delete, the entries still exist under the hood and can be activated again
* with the restore datasource entries method.
*
* @see https://cloudinary.com/documentation/admin_api#delete_entries_in_a_metadata_field_datasource
*
* @param {String} field_external_id The ID of the metadata field
* @param {Array} entries_external_id An array of IDs of datasource entries to delete
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.delete_datasource_entries = function delete_datasource_entries(field_external_id, entries_external_id, callback, options = {}) {
options.content_type = "json";
const params = {external_ids: entries_external_id};
return call_api("delete", ["metadata_fields", field_external_id, "datasource"], params, callback, options);
};
/**
* Restores entries in a metadata field datasource
*
* Restores (unblocks) any previously deleted datasource entries for a specified metadata field definition.
* Sets the state of the entries to active.
*
* @see https://cloudinary.com/documentation/admin_api#restore_entries_in_a_metadata_field_datasource
*
* @param {String} field_external_id The ID of the metadata field
* @param {Array} entries_external_id An array of IDs of datasource entries to delete
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.restore_metadata_field_datasource = function restore_metadata_field_datasource(field_external_id, entries_external_id, callback, options = {}) {
options.content_type = "json";
const params = {external_ids: entries_external_id};
return call_api("post", ["metadata_fields", field_external_id, "datasource_restore"], params, callback, options);
};
/**
* Sorts metadata field datasource. Currently supports only value
* @param {String} field_external_id The ID of the metadata field
* @param {String} sort_by Criteria for the sort. Currently supports only value
* @param {String} direction Optional (gets either asc or desc)
* @param {Function} callback Callback function
* @param {Object} options Configuration options
*
* @return {Object}
*/
exports.order_metadata_field_datasource = function order_metadata_field_datasource(field_external_id, sort_by, direction, callback, options = {}) {
options.content_type = "json";
const params = {
order_by: sort_by,
direction: direction
};
return call_api("post", ["metadata_fields", field_external_id, "datasource", "order"], params, callback, options);
};
/**
* Reorders metadata fields.
*
* @param {String} order_by Criteria for the order (one of the fields 'label', 'external_id', 'created_at').
* @param {String} direction Optional (gets either asc or desc).
* @param {Function} callback Callback function.
* @param {Object} options Configuration options.
*
* @return {Object}
*/
exports.reorder_metadata_fields = function reorder_metadata_fields(order_by, direction, callback, options = {}) {
options.content_type = "json";
const params = {
order_by,
direction
};
return call_api("put", ["metadata_fields", "order"], params, callback, options);
};
exports.list_metadata_rules = function list_metadata_rules(callback, options = {}) {
return call_api('get', ['metadata_rules'], {}, callback, options);
};
exports.add_metadata_rule = function add_metadata_rule(metadata_rule, callback, options = {}) {
options.content_type = 'json';
const params = pickOnlyExistingValues(metadata_rule, 'metadata_field_id', 'condition', 'result', 'name');
return call_api('post', ['metadata_rules'], params, callback, options);
};
exports.update_metadata_rule = function update_metadata_rule(field_external_id, updated_metadata_rule, callback, options = {}) {
options.content_type = 'json';
const params = pickOnlyExistingValues(updated_metadata_rule, 'metadata_field_id', 'condition', 'result', 'name', 'state');
return call_api('put', ['metadata_rules', field_external_id], params, callback, options);
};
exports.delete_metadata_rule = function delete_metadata_rule(field_external_id, callback, options = {}) {
return call_api('delete', ['metadata_rules', field_external_id], {}, callback, options);
};