@vidispine/api 23.4.0-pre.2 → 23.4.0-pre.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +257 -5
- package/package.json +20 -21
package/dist/index.d.ts
CHANGED
|
@@ -174,6 +174,9 @@ import type { VXAListDocument } from '@vidispine/types';
|
|
|
174
174
|
import type { WaveformDataDocument } from '@vidispine/types';
|
|
175
175
|
import type { WebsocketUpdateRequestDocument } from '@vidispine/types';
|
|
176
176
|
|
|
177
|
+
/**
|
|
178
|
+
* @namespace
|
|
179
|
+
*/
|
|
177
180
|
export declare const AnalyzePreset: {
|
|
178
181
|
/**
|
|
179
182
|
* List Analyze Preset All Presets
|
|
@@ -262,6 +265,9 @@ export declare const AnalyzePreset: {
|
|
|
262
265
|
}) => Promise<AxiosResponse<AnalyzePresetDocument>>;
|
|
263
266
|
};
|
|
264
267
|
|
|
268
|
+
/**
|
|
269
|
+
* @interface
|
|
270
|
+
*/
|
|
265
271
|
export declare const Api: {
|
|
266
272
|
/**
|
|
267
273
|
* Root API
|
|
@@ -279,6 +285,9 @@ export declare const Api: {
|
|
|
279
285
|
}) => Promise<AxiosResponse<string>>;
|
|
280
286
|
};
|
|
281
287
|
|
|
288
|
+
/**
|
|
289
|
+
* @namespace
|
|
290
|
+
*/
|
|
282
291
|
export declare const ApiInit: {
|
|
283
292
|
/**
|
|
284
293
|
* Init Api Init
|
|
@@ -296,6 +305,9 @@ export declare const ApiInit: {
|
|
|
296
305
|
}) => Promise<AxiosResponse<string>>;
|
|
297
306
|
};
|
|
298
307
|
|
|
308
|
+
/**
|
|
309
|
+
* @namespace
|
|
310
|
+
*/
|
|
299
311
|
export declare const ApplicationWadl: {
|
|
300
312
|
/**
|
|
301
313
|
* Get Application Wadl
|
|
@@ -366,6 +378,9 @@ export declare const ApplicationWadl: {
|
|
|
366
378
|
}) => Promise<AxiosResponse<string>>;
|
|
367
379
|
};
|
|
368
380
|
|
|
381
|
+
/**
|
|
382
|
+
* @namespace
|
|
383
|
+
*/
|
|
369
384
|
export declare const AutoProjection: {
|
|
370
385
|
/**
|
|
371
386
|
* List Auto Projection Rule Names
|
|
@@ -520,8 +535,11 @@ export declare const AutoProjection: {
|
|
|
520
535
|
}) => Promise<AxiosResponse<any>>;
|
|
521
536
|
};
|
|
522
537
|
|
|
523
|
-
declare type AxiosRequestHeaderConfig = AxiosRequestConfig['headers'];
|
|
538
|
+
export declare type AxiosRequestHeaderConfig = AxiosRequestConfig['headers'];
|
|
524
539
|
|
|
540
|
+
/**
|
|
541
|
+
* @namespace
|
|
542
|
+
*/
|
|
525
543
|
export declare const BulkyPut: {
|
|
526
544
|
/**
|
|
527
545
|
* Put Bulky Put Bulky Metadata No Auth
|
|
@@ -585,6 +603,9 @@ export declare const BulkyPut: {
|
|
|
585
603
|
}) => Promise<AxiosResponse<any>>;
|
|
586
604
|
};
|
|
587
605
|
|
|
606
|
+
/**
|
|
607
|
+
* @namespace
|
|
608
|
+
*/
|
|
588
609
|
export declare const Callback: {
|
|
589
610
|
/**
|
|
590
611
|
* Cloud Callback Convert Call Back No Auth
|
|
@@ -623,6 +644,9 @@ export declare const Callback: {
|
|
|
623
644
|
}) => Promise<AxiosResponse<any>>;
|
|
624
645
|
};
|
|
625
646
|
|
|
647
|
+
/**
|
|
648
|
+
* @namespace
|
|
649
|
+
*/
|
|
626
650
|
export declare const Collection: {
|
|
627
651
|
/**
|
|
628
652
|
* Delete Collections
|
|
@@ -4341,6 +4365,9 @@ export declare const Collection: {
|
|
|
4341
4365
|
}) => Promise<AxiosResponse<any>>;
|
|
4342
4366
|
};
|
|
4343
4367
|
|
|
4368
|
+
/**
|
|
4369
|
+
* @namespace
|
|
4370
|
+
*/
|
|
4344
4371
|
export declare const Component: {
|
|
4345
4372
|
/**
|
|
4346
4373
|
* List Components
|
|
@@ -5129,6 +5156,9 @@ export declare const Component: {
|
|
|
5129
5156
|
}) => Promise<AxiosResponse<ShapeDocument>>;
|
|
5130
5157
|
};
|
|
5131
5158
|
|
|
5159
|
+
/**
|
|
5160
|
+
* @namespace
|
|
5161
|
+
*/
|
|
5132
5162
|
export declare const Configuration: {
|
|
5133
5163
|
/**
|
|
5134
5164
|
* List Configurations
|
|
@@ -5720,6 +5750,9 @@ export declare const Configuration: {
|
|
|
5720
5750
|
}) => Promise<AxiosResponse<any>>;
|
|
5721
5751
|
};
|
|
5722
5752
|
|
|
5753
|
+
/**
|
|
5754
|
+
* @namespace
|
|
5755
|
+
*/
|
|
5723
5756
|
export declare const Conform: {
|
|
5724
5757
|
/**
|
|
5725
5758
|
* Post Conform
|
|
@@ -5772,6 +5805,9 @@ export declare const Conform: {
|
|
|
5772
5805
|
}) => Promise<AxiosResponse<JobDocument>>;
|
|
5773
5806
|
};
|
|
5774
5807
|
|
|
5808
|
+
/**
|
|
5809
|
+
* @namespace
|
|
5810
|
+
*/
|
|
5775
5811
|
export declare const Cost: {
|
|
5776
5812
|
/**
|
|
5777
5813
|
* Get Cost Estimate
|
|
@@ -5817,6 +5853,9 @@ export declare const Cost: {
|
|
|
5817
5853
|
}) => Promise<AxiosResponse<CostEstimateDocument>>;
|
|
5818
5854
|
};
|
|
5819
5855
|
|
|
5856
|
+
/**
|
|
5857
|
+
* @namespace
|
|
5858
|
+
*/
|
|
5820
5859
|
export declare const Datatype: {
|
|
5821
5860
|
/**
|
|
5822
5861
|
* Init Datatype
|
|
@@ -5833,6 +5872,9 @@ export declare const Datatype: {
|
|
|
5833
5872
|
}) => Promise<AxiosResponse<any>>;
|
|
5834
5873
|
};
|
|
5835
5874
|
|
|
5875
|
+
/**
|
|
5876
|
+
* @namespace
|
|
5877
|
+
*/
|
|
5836
5878
|
export declare const Debug: {
|
|
5837
5879
|
/**
|
|
5838
5880
|
* Echo Debug No Auth
|
|
@@ -5852,6 +5894,9 @@ export declare const Debug: {
|
|
|
5852
5894
|
}) => Promise<AxiosResponse<string>>;
|
|
5853
5895
|
};
|
|
5854
5896
|
|
|
5897
|
+
/**
|
|
5898
|
+
* @namespace
|
|
5899
|
+
*/
|
|
5855
5900
|
export declare const DeletionLock: {
|
|
5856
5901
|
/**
|
|
5857
5902
|
* List Deletion Lock List
|
|
@@ -6509,6 +6554,9 @@ export declare const DeletionLock: {
|
|
|
6509
6554
|
}) => Promise<AxiosResponse<any>>;
|
|
6510
6555
|
};
|
|
6511
6556
|
|
|
6557
|
+
/**
|
|
6558
|
+
* @namespace
|
|
6559
|
+
*/
|
|
6512
6560
|
declare const Document_2: {
|
|
6513
6561
|
/**
|
|
6514
6562
|
* List Document Instance List
|
|
@@ -7110,6 +7158,9 @@ declare const Document_2: {
|
|
|
7110
7158
|
};
|
|
7111
7159
|
export { Document_2 as Document }
|
|
7112
7160
|
|
|
7161
|
+
/**
|
|
7162
|
+
* @namespace
|
|
7163
|
+
*/
|
|
7113
7164
|
export declare const Eidr: {
|
|
7114
7165
|
/**
|
|
7115
7166
|
* Setup Eidr
|
|
@@ -7126,6 +7177,9 @@ export declare const Eidr: {
|
|
|
7126
7177
|
}) => Promise<AxiosResponse<any>>;
|
|
7127
7178
|
};
|
|
7128
7179
|
|
|
7180
|
+
/**
|
|
7181
|
+
* @namespace
|
|
7182
|
+
*/
|
|
7129
7183
|
declare const Error_2: {
|
|
7130
7184
|
/**
|
|
7131
7185
|
* List Errors
|
|
@@ -7188,6 +7242,9 @@ declare const Error_2: {
|
|
|
7188
7242
|
};
|
|
7189
7243
|
export { Error_2 as Error }
|
|
7190
7244
|
|
|
7245
|
+
/**
|
|
7246
|
+
* @namespace
|
|
7247
|
+
*/
|
|
7191
7248
|
declare const Event_2: {
|
|
7192
7249
|
/**
|
|
7193
7250
|
* Get Event Updates Get
|
|
@@ -7369,6 +7426,9 @@ declare const Event_2: {
|
|
|
7369
7426
|
};
|
|
7370
7427
|
export { Event_2 as Event }
|
|
7371
7428
|
|
|
7429
|
+
/**
|
|
7430
|
+
* @namespace
|
|
7431
|
+
*/
|
|
7372
7432
|
export declare const ExportLocation: {
|
|
7373
7433
|
/**
|
|
7374
7434
|
* List Export Locations
|
|
@@ -7628,6 +7688,9 @@ export declare const ExportLocation: {
|
|
|
7628
7688
|
}) => Promise<AxiosResponse<string>>;
|
|
7629
7689
|
};
|
|
7630
7690
|
|
|
7691
|
+
/**
|
|
7692
|
+
* @namespace
|
|
7693
|
+
*/
|
|
7631
7694
|
export declare const ExportTemplate: {
|
|
7632
7695
|
/**
|
|
7633
7696
|
* List Export Templates
|
|
@@ -7771,6 +7834,9 @@ export declare const ExportTemplate: {
|
|
|
7771
7834
|
}) => Promise<AxiosResponse<any>>;
|
|
7772
7835
|
};
|
|
7773
7836
|
|
|
7837
|
+
/**
|
|
7838
|
+
* @namespace
|
|
7839
|
+
*/
|
|
7774
7840
|
export declare const ExternalId: {
|
|
7775
7841
|
/**
|
|
7776
7842
|
* List External Id Patterns
|
|
@@ -7873,6 +7939,9 @@ export declare const ExternalId: {
|
|
|
7873
7939
|
}) => Promise<AxiosResponse<any>>;
|
|
7874
7940
|
};
|
|
7875
7941
|
|
|
7942
|
+
/**
|
|
7943
|
+
* @namespace
|
|
7944
|
+
*/
|
|
7876
7945
|
export declare const FieldGroup: {
|
|
7877
7946
|
/**
|
|
7878
7947
|
* List Collection Field Group Groups
|
|
@@ -8553,6 +8622,9 @@ export declare const FieldGroup: {
|
|
|
8553
8622
|
}) => Promise<AxiosResponse<any>>;
|
|
8554
8623
|
};
|
|
8555
8624
|
|
|
8625
|
+
/**
|
|
8626
|
+
* @namespace
|
|
8627
|
+
*/
|
|
8556
8628
|
declare const File_2: {
|
|
8557
8629
|
/**
|
|
8558
8630
|
* List File
|
|
@@ -11810,7 +11882,7 @@ declare const File_2: {
|
|
|
11810
11882
|
};
|
|
11811
11883
|
export { File_2 as File }
|
|
11812
11884
|
|
|
11813
|
-
declare type GenericQueryParam = string | number | boolean;
|
|
11885
|
+
export declare type GenericQueryParam = string | number | boolean;
|
|
11814
11886
|
|
|
11815
11887
|
/**
|
|
11816
11888
|
* Get the default axios instance used in requests
|
|
@@ -11819,6 +11891,9 @@ declare type GenericQueryParam = string | number | boolean;
|
|
|
11819
11891
|
*/
|
|
11820
11892
|
export declare const getAxiosInstance: () => AxiosInstance;
|
|
11821
11893
|
|
|
11894
|
+
/**
|
|
11895
|
+
* @namespace
|
|
11896
|
+
*/
|
|
11822
11897
|
export declare const Group: {
|
|
11823
11898
|
/**
|
|
11824
11899
|
* Delete Groups
|
|
@@ -12966,6 +13041,9 @@ export declare const Group: {
|
|
|
12966
13041
|
}) => Promise<AxiosResponse<UserListDocument>>;
|
|
12967
13042
|
};
|
|
12968
13043
|
|
|
13044
|
+
/**
|
|
13045
|
+
* @namespace
|
|
13046
|
+
*/
|
|
12969
13047
|
export declare const Import: {
|
|
12970
13048
|
/**
|
|
12971
13049
|
* Post Import
|
|
@@ -14052,6 +14130,9 @@ export declare const Import: {
|
|
|
14052
14130
|
}) => Promise<AxiosResponse<string>>;
|
|
14053
14131
|
};
|
|
14054
14132
|
|
|
14133
|
+
/**
|
|
14134
|
+
* @namespace
|
|
14135
|
+
*/
|
|
14055
14136
|
export declare const IsOnline: {
|
|
14056
14137
|
/**
|
|
14057
14138
|
* Is Online No Auth
|
|
@@ -14073,6 +14154,9 @@ export declare const IsOnline: {
|
|
|
14073
14154
|
}) => Promise<AxiosResponse<string>>;
|
|
14074
14155
|
};
|
|
14075
14156
|
|
|
14157
|
+
/**
|
|
14158
|
+
* @namespace
|
|
14159
|
+
*/
|
|
14076
14160
|
export declare const Item: {
|
|
14077
14161
|
/**
|
|
14078
14162
|
* Delete Item List
|
|
@@ -18763,6 +18847,9 @@ export declare const Item: {
|
|
|
18763
18847
|
}) => Promise<AxiosResponse<WaveformDataDocument>>;
|
|
18764
18848
|
};
|
|
18765
18849
|
|
|
18850
|
+
/**
|
|
18851
|
+
* @namespace
|
|
18852
|
+
*/
|
|
18766
18853
|
export declare const Javascript: {
|
|
18767
18854
|
/**
|
|
18768
18855
|
* Get Javascript Debugging Sessions
|
|
@@ -18846,6 +18933,9 @@ export declare const Javascript: {
|
|
|
18846
18933
|
}) => Promise<AxiosResponse<string>>;
|
|
18847
18934
|
};
|
|
18848
18935
|
|
|
18936
|
+
/**
|
|
18937
|
+
* @namespace
|
|
18938
|
+
*/
|
|
18849
18939
|
export declare const Job: {
|
|
18850
18940
|
/**
|
|
18851
18941
|
* Delete Job List
|
|
@@ -19659,6 +19749,9 @@ export declare const Job: {
|
|
|
19659
19749
|
}) => Promise<AxiosResponse<JobDocument>>;
|
|
19660
19750
|
};
|
|
19661
19751
|
|
|
19752
|
+
/**
|
|
19753
|
+
* @namespace
|
|
19754
|
+
*/
|
|
19662
19755
|
export declare const Jobtype: {
|
|
19663
19756
|
/**
|
|
19664
19757
|
* List Jobtype Job Types
|
|
@@ -19678,10 +19771,13 @@ export declare const Jobtype: {
|
|
|
19678
19771
|
}) => Promise<AxiosResponse<URIListDocument>>;
|
|
19679
19772
|
};
|
|
19680
19773
|
|
|
19681
|
-
declare type KeyValueObjectQueryParam = {
|
|
19774
|
+
export declare type KeyValueObjectQueryParam = {
|
|
19682
19775
|
[key: string]: SingleOrArrayGenericQueryParam;
|
|
19683
19776
|
};
|
|
19684
19777
|
|
|
19778
|
+
/**
|
|
19779
|
+
* @namespace
|
|
19780
|
+
*/
|
|
19685
19781
|
export declare const Library: {
|
|
19686
19782
|
/**
|
|
19687
19783
|
* Delete Library Libraries
|
|
@@ -21577,6 +21673,9 @@ export declare const Library: {
|
|
|
21577
21673
|
}) => Promise<AxiosResponse<any>>;
|
|
21578
21674
|
};
|
|
21579
21675
|
|
|
21676
|
+
/**
|
|
21677
|
+
* @namespace
|
|
21678
|
+
*/
|
|
21580
21679
|
export declare const License: {
|
|
21581
21680
|
/**
|
|
21582
21681
|
* Get License
|
|
@@ -21783,6 +21882,9 @@ export declare const License: {
|
|
|
21783
21882
|
}) => Promise<AxiosResponse<any>>;
|
|
21784
21883
|
};
|
|
21785
21884
|
|
|
21885
|
+
/**
|
|
21886
|
+
* @namespace
|
|
21887
|
+
*/
|
|
21786
21888
|
export declare const Log: {
|
|
21787
21889
|
/**
|
|
21788
21890
|
* Get Log Content
|
|
@@ -21950,6 +22052,9 @@ export declare function login({ serverUrl, token, username, password, bearerToke
|
|
|
21950
22052
|
*/
|
|
21951
22053
|
export declare function logout(): void;
|
|
21952
22054
|
|
|
22055
|
+
/**
|
|
22056
|
+
* @namespace
|
|
22057
|
+
*/
|
|
21953
22058
|
export declare const Metadata: {
|
|
21954
22059
|
/**
|
|
21955
22060
|
* Get Metadata
|
|
@@ -22202,6 +22307,9 @@ export declare const Metadata: {
|
|
|
22202
22307
|
}) => Promise<AxiosResponse<MetadataEntryDocument>>;
|
|
22203
22308
|
};
|
|
22204
22309
|
|
|
22310
|
+
/**
|
|
22311
|
+
* @namespace
|
|
22312
|
+
*/
|
|
22205
22313
|
export declare const MetadataField: {
|
|
22206
22314
|
/**
|
|
22207
22315
|
* List Metadata Fields
|
|
@@ -22830,6 +22938,9 @@ export declare const MetadataField: {
|
|
|
22830
22938
|
}) => Promise<AxiosResponse<any>>;
|
|
22831
22939
|
};
|
|
22832
22940
|
|
|
22941
|
+
/**
|
|
22942
|
+
* @namespace
|
|
22943
|
+
*/
|
|
22833
22944
|
export declare const Metadatarepair: {
|
|
22834
22945
|
/**
|
|
22835
22946
|
* Repair Metadatarepair Metadata
|
|
@@ -22846,6 +22957,9 @@ export declare const Metadatarepair: {
|
|
|
22846
22957
|
}) => Promise<AxiosResponse<any>>;
|
|
22847
22958
|
};
|
|
22848
22959
|
|
|
22960
|
+
/**
|
|
22961
|
+
* @namespace
|
|
22962
|
+
*/
|
|
22849
22963
|
export declare const MetadataSchema: {
|
|
22850
22964
|
/**
|
|
22851
22965
|
* Delete Metadata Schema
|
|
@@ -22960,6 +23074,9 @@ export declare const MetadataSchema: {
|
|
|
22960
23074
|
}) => Promise<AxiosResponse<any>>;
|
|
22961
23075
|
};
|
|
22962
23076
|
|
|
23077
|
+
/**
|
|
23078
|
+
* @namespace
|
|
23079
|
+
*/
|
|
22963
23080
|
declare const Notification_2: {
|
|
22964
23081
|
/**
|
|
22965
23082
|
* Delete Notifications
|
|
@@ -23162,6 +23279,9 @@ declare const Notification_2: {
|
|
|
23162
23279
|
};
|
|
23163
23280
|
export { Notification_2 as Notification }
|
|
23164
23281
|
|
|
23282
|
+
/**
|
|
23283
|
+
* @namespace
|
|
23284
|
+
*/
|
|
23165
23285
|
export declare const Otif: {
|
|
23166
23286
|
/**
|
|
23167
23287
|
* List Otif
|
|
@@ -23567,6 +23687,9 @@ export declare const Otif: {
|
|
|
23567
23687
|
}) => Promise<AxiosResponse<string>>;
|
|
23568
23688
|
};
|
|
23569
23689
|
|
|
23690
|
+
/**
|
|
23691
|
+
* @namespace
|
|
23692
|
+
*/
|
|
23570
23693
|
export declare const Populate: {
|
|
23571
23694
|
/**
|
|
23572
23695
|
* Populate Items
|
|
@@ -23622,6 +23745,9 @@ export declare const Populate: {
|
|
|
23622
23745
|
}) => Promise<AxiosResponse<any>>;
|
|
23623
23746
|
};
|
|
23624
23747
|
|
|
23748
|
+
/**
|
|
23749
|
+
* @namespace
|
|
23750
|
+
*/
|
|
23625
23751
|
export declare const Poster: {
|
|
23626
23752
|
/**
|
|
23627
23753
|
* Delete Poster Thumbnails For Item
|
|
@@ -23884,6 +24010,9 @@ export declare const Poster: {
|
|
|
23884
24010
|
}) => Promise<AxiosResponse<string>>;
|
|
23885
24011
|
};
|
|
23886
24012
|
|
|
24013
|
+
/**
|
|
24014
|
+
* @namespace
|
|
24015
|
+
*/
|
|
23887
24016
|
export declare const PresetMediaconvertTemplates: {
|
|
23888
24017
|
/**
|
|
23889
24018
|
* Setup Preset Mediaconvert Templates Media Convert Presets
|
|
@@ -23900,6 +24029,9 @@ export declare const PresetMediaconvertTemplates: {
|
|
|
23900
24029
|
}) => Promise<AxiosResponse<string>>;
|
|
23901
24030
|
};
|
|
23902
24031
|
|
|
24032
|
+
/**
|
|
24033
|
+
* @namespace
|
|
24034
|
+
*/
|
|
23903
24035
|
export declare const PresetTemplates: {
|
|
23904
24036
|
/**
|
|
23905
24037
|
* Setup Preset Templates Presets
|
|
@@ -23916,6 +24048,9 @@ export declare const PresetTemplates: {
|
|
|
23916
24048
|
}) => Promise<AxiosResponse<string>>;
|
|
23917
24049
|
};
|
|
23918
24050
|
|
|
24051
|
+
/**
|
|
24052
|
+
* @namespace
|
|
24053
|
+
*/
|
|
23919
24054
|
export declare const Projection: {
|
|
23920
24055
|
/**
|
|
23921
24056
|
* List Projections
|
|
@@ -24048,6 +24183,9 @@ export declare const Projection: {
|
|
|
24048
24183
|
}) => Promise<AxiosResponse<string>>;
|
|
24049
24184
|
};
|
|
24050
24185
|
|
|
24186
|
+
/**
|
|
24187
|
+
* @namespace
|
|
24188
|
+
*/
|
|
24051
24189
|
export declare const Quota: {
|
|
24052
24190
|
/**
|
|
24053
24191
|
* List Quota Rules
|
|
@@ -24670,6 +24808,9 @@ export declare const Quota: {
|
|
|
24670
24808
|
}) => Promise<AxiosResponse<any>>;
|
|
24671
24809
|
};
|
|
24672
24810
|
|
|
24811
|
+
/**
|
|
24812
|
+
* @namespace
|
|
24813
|
+
*/
|
|
24673
24814
|
export declare const Reindex: {
|
|
24674
24815
|
/**
|
|
24675
24816
|
* Get Reindexing
|
|
@@ -24722,6 +24863,9 @@ export declare const Reindex: {
|
|
|
24722
24863
|
}) => Promise<AxiosResponse<ReindexRequestDocument>>;
|
|
24723
24864
|
};
|
|
24724
24865
|
|
|
24866
|
+
/**
|
|
24867
|
+
* @namespace
|
|
24868
|
+
*/
|
|
24725
24869
|
export declare const Relation: {
|
|
24726
24870
|
/**
|
|
24727
24871
|
* Add Item Relations
|
|
@@ -24815,6 +24959,9 @@ export declare const Relation: {
|
|
|
24815
24959
|
}) => Promise<AxiosResponse<ItemRelationDocument>>;
|
|
24816
24960
|
};
|
|
24817
24961
|
|
|
24962
|
+
/**
|
|
24963
|
+
* @namespace
|
|
24964
|
+
*/
|
|
24818
24965
|
export declare const Resource: {
|
|
24819
24966
|
/**
|
|
24820
24967
|
* List Resource Types
|
|
@@ -25160,6 +25307,9 @@ export declare const Resource: {
|
|
|
25160
25307
|
}) => Promise<AxiosResponse<any>>;
|
|
25161
25308
|
};
|
|
25162
25309
|
|
|
25310
|
+
/**
|
|
25311
|
+
* @namespace
|
|
25312
|
+
*/
|
|
25163
25313
|
export declare const Root: {
|
|
25164
25314
|
/**
|
|
25165
25315
|
* Get Root Hi
|
|
@@ -25176,6 +25326,9 @@ export declare const Root: {
|
|
|
25176
25326
|
}) => Promise<AxiosResponse<string>>;
|
|
25177
25327
|
};
|
|
25178
25328
|
|
|
25329
|
+
/**
|
|
25330
|
+
* @namespace
|
|
25331
|
+
*/
|
|
25179
25332
|
export declare const Samples: {
|
|
25180
25333
|
/**
|
|
25181
25334
|
* List Samples Types
|
|
@@ -25262,6 +25415,9 @@ export declare const Samples: {
|
|
|
25262
25415
|
}) => Promise<AxiosResponse<string>>;
|
|
25263
25416
|
};
|
|
25264
25417
|
|
|
25418
|
+
/**
|
|
25419
|
+
* @namespace
|
|
25420
|
+
*/
|
|
25265
25421
|
export declare const ScheduledRequest: {
|
|
25266
25422
|
/**
|
|
25267
25423
|
* Delete Scheduled Requests
|
|
@@ -25362,6 +25518,9 @@ export declare const ScheduledRequest: {
|
|
|
25362
25518
|
}) => Promise<AxiosResponse<string>>;
|
|
25363
25519
|
};
|
|
25364
25520
|
|
|
25521
|
+
/**
|
|
25522
|
+
* @namespace
|
|
25523
|
+
*/
|
|
25365
25524
|
export declare const Schema: {
|
|
25366
25525
|
/**
|
|
25367
25526
|
* Get Schema Latest
|
|
@@ -25433,6 +25592,9 @@ export declare const Schema: {
|
|
|
25433
25592
|
}) => Promise<AxiosResponse<string>>;
|
|
25434
25593
|
};
|
|
25435
25594
|
|
|
25595
|
+
/**
|
|
25596
|
+
* @namespace
|
|
25597
|
+
*/
|
|
25436
25598
|
export declare const Search: {
|
|
25437
25599
|
/**
|
|
25438
25600
|
* Browse Search
|
|
@@ -25815,6 +25977,9 @@ export declare const Search: {
|
|
|
25815
25977
|
}) => Promise<AxiosResponse<any>>;
|
|
25816
25978
|
};
|
|
25817
25979
|
|
|
25980
|
+
/**
|
|
25981
|
+
* @namespace
|
|
25982
|
+
*/
|
|
25818
25983
|
export declare const Secret: {
|
|
25819
25984
|
/**
|
|
25820
25985
|
* List Secrets
|
|
@@ -25942,6 +26107,9 @@ export declare const Secret: {
|
|
|
25942
26107
|
}) => Promise<AxiosResponse<any>>;
|
|
25943
26108
|
};
|
|
25944
26109
|
|
|
26110
|
+
/**
|
|
26111
|
+
* @namespace
|
|
26112
|
+
*/
|
|
25945
26113
|
export declare const Selftest: {
|
|
25946
26114
|
/**
|
|
25947
26115
|
* Get Selftest
|
|
@@ -26029,6 +26197,9 @@ export declare const Selftest: {
|
|
|
26029
26197
|
}) => Promise<AxiosResponse<SelfTestDocument>>;
|
|
26030
26198
|
};
|
|
26031
26199
|
|
|
26200
|
+
/**
|
|
26201
|
+
* @namespace
|
|
26202
|
+
*/
|
|
26032
26203
|
export declare const Sequence: {
|
|
26033
26204
|
/**
|
|
26034
26205
|
* Get Sequence Entity In Format
|
|
@@ -26155,6 +26326,9 @@ export declare const Sequence: {
|
|
|
26155
26326
|
*/
|
|
26156
26327
|
export declare const setAxiosInstance: (axiosProps: CreateAxiosDefaults) => void;
|
|
26157
26328
|
|
|
26329
|
+
/**
|
|
26330
|
+
* @namespace
|
|
26331
|
+
*/
|
|
26158
26332
|
export declare const Shape: {
|
|
26159
26333
|
/**
|
|
26160
26334
|
* List File Shape List Document By Path
|
|
@@ -28344,6 +28518,9 @@ export declare const Shape: {
|
|
|
28344
28518
|
}) => Promise<AxiosResponse<ShapeDocument>>;
|
|
28345
28519
|
};
|
|
28346
28520
|
|
|
28521
|
+
/**
|
|
28522
|
+
* @namespace
|
|
28523
|
+
*/
|
|
28347
28524
|
export declare const ShapeTag: {
|
|
28348
28525
|
/**
|
|
28349
28526
|
* List Shape Tags
|
|
@@ -28737,8 +28914,11 @@ export declare const ShapeTag: {
|
|
|
28737
28914
|
}) => Promise<AxiosResponse<any>>;
|
|
28738
28915
|
};
|
|
28739
28916
|
|
|
28740
|
-
declare type SingleOrArrayGenericQueryParam = GenericQueryParam | GenericQueryParam[];
|
|
28917
|
+
export declare type SingleOrArrayGenericQueryParam = GenericQueryParam | GenericQueryParam[];
|
|
28741
28918
|
|
|
28919
|
+
/**
|
|
28920
|
+
* @namespace
|
|
28921
|
+
*/
|
|
28742
28922
|
export declare const Site: {
|
|
28743
28923
|
/**
|
|
28744
28924
|
* List Sites
|
|
@@ -29175,6 +29355,9 @@ export declare const Site: {
|
|
|
29175
29355
|
}) => Promise<AxiosResponse<SimpleMetadataDocument>>;
|
|
29176
29356
|
};
|
|
29177
29357
|
|
|
29358
|
+
/**
|
|
29359
|
+
* @namespace
|
|
29360
|
+
*/
|
|
29178
29361
|
export declare const Stitch: {
|
|
29179
29362
|
/**
|
|
29180
29363
|
* Get Stitch Image No Auth
|
|
@@ -29211,6 +29394,9 @@ export declare const Stitch: {
|
|
|
29211
29394
|
}) => Promise<AxiosResponse<string>>;
|
|
29212
29395
|
};
|
|
29213
29396
|
|
|
29397
|
+
/**
|
|
29398
|
+
* @namespace
|
|
29399
|
+
*/
|
|
29214
29400
|
declare const Storage_2: {
|
|
29215
29401
|
/**
|
|
29216
29402
|
* List Storages
|
|
@@ -38309,6 +38495,9 @@ declare const Storage_2: {
|
|
|
38309
38495
|
};
|
|
38310
38496
|
export { Storage_2 as Storage }
|
|
38311
38497
|
|
|
38498
|
+
/**
|
|
38499
|
+
* @namespace
|
|
38500
|
+
*/
|
|
38312
38501
|
export declare const StorageRule: {
|
|
38313
38502
|
/**
|
|
38314
38503
|
* Get Storage Rules
|
|
@@ -38335,6 +38524,9 @@ export declare const StorageRule: {
|
|
|
38335
38524
|
}) => Promise<AxiosResponse<StorageRulesDocument>>;
|
|
38336
38525
|
};
|
|
38337
38526
|
|
|
38527
|
+
/**
|
|
38528
|
+
* @namespace
|
|
38529
|
+
*/
|
|
38338
38530
|
export declare const SystemStatus: {
|
|
38339
38531
|
/**
|
|
38340
38532
|
* Get System Status
|
|
@@ -38352,6 +38544,9 @@ export declare const SystemStatus: {
|
|
|
38352
38544
|
}) => Promise<AxiosResponse<string>>;
|
|
38353
38545
|
};
|
|
38354
38546
|
|
|
38547
|
+
/**
|
|
38548
|
+
* @namespace
|
|
38549
|
+
*/
|
|
38355
38550
|
export declare const TaskDefinition: {
|
|
38356
38551
|
/**
|
|
38357
38552
|
* List Task Definitions
|
|
@@ -39052,6 +39247,9 @@ export declare const TaskDefinition: {
|
|
|
39052
39247
|
}) => Promise<AxiosResponse<string>>;
|
|
39053
39248
|
};
|
|
39054
39249
|
|
|
39250
|
+
/**
|
|
39251
|
+
* @namespace
|
|
39252
|
+
*/
|
|
39055
39253
|
export declare const TaskGroup: {
|
|
39056
39254
|
/**
|
|
39057
39255
|
* Delete Task Group Groups
|
|
@@ -39337,6 +39535,9 @@ export declare const TaskGroup: {
|
|
|
39337
39535
|
}) => Promise<AxiosResponse<any>>;
|
|
39338
39536
|
};
|
|
39339
39537
|
|
|
39538
|
+
/**
|
|
39539
|
+
* @namespace
|
|
39540
|
+
*/
|
|
39340
39541
|
export declare const Thumbnail: {
|
|
39341
39542
|
/**
|
|
39342
39543
|
* Delete Thumbnails For Item
|
|
@@ -39601,6 +39802,9 @@ export declare const Thumbnail: {
|
|
|
39601
39802
|
}) => Promise<AxiosResponse<string>>;
|
|
39602
39803
|
};
|
|
39603
39804
|
|
|
39805
|
+
/**
|
|
39806
|
+
* @namespace
|
|
39807
|
+
*/
|
|
39604
39808
|
export declare const ThumbnailPut: {
|
|
39605
39809
|
/**
|
|
39606
39810
|
* Put Thumbnail Put Image No Auth
|
|
@@ -39624,6 +39828,9 @@ export declare const ThumbnailPut: {
|
|
|
39624
39828
|
}) => Promise<AxiosResponse<string>>;
|
|
39625
39829
|
};
|
|
39626
39830
|
|
|
39831
|
+
/**
|
|
39832
|
+
* @namespace
|
|
39833
|
+
*/
|
|
39627
39834
|
export declare const Token: {
|
|
39628
39835
|
/**
|
|
39629
39836
|
* Get Token String
|
|
@@ -39650,6 +39857,9 @@ export declare const Token: {
|
|
|
39650
39857
|
}) => Promise<AxiosResponse<AuthenticationTokenDocument>>;
|
|
39651
39858
|
};
|
|
39652
39859
|
|
|
39860
|
+
/**
|
|
39861
|
+
* @namespace
|
|
39862
|
+
*/
|
|
39653
39863
|
export declare const Transcode: {
|
|
39654
39864
|
/**
|
|
39655
39865
|
* Post Transcode
|
|
@@ -39680,6 +39890,9 @@ export declare const Transcode: {
|
|
|
39680
39890
|
}) => Promise<AxiosResponse<JobDocument>>;
|
|
39681
39891
|
};
|
|
39682
39892
|
|
|
39893
|
+
/**
|
|
39894
|
+
* @namespace
|
|
39895
|
+
*/
|
|
39683
39896
|
export declare const TranscoderValidate: {
|
|
39684
39897
|
/**
|
|
39685
39898
|
* Get Transcoder Validate Validation
|
|
@@ -39704,6 +39917,9 @@ export declare const TranscoderValidate: {
|
|
|
39704
39917
|
}) => Promise<AxiosResponse<TranscoderLicenseStatusDocument>>;
|
|
39705
39918
|
};
|
|
39706
39919
|
|
|
39920
|
+
/**
|
|
39921
|
+
* @namespace
|
|
39922
|
+
*/
|
|
39707
39923
|
export declare const Transfer: {
|
|
39708
39924
|
/**
|
|
39709
39925
|
* List All Transfers
|
|
@@ -39778,6 +39994,9 @@ export declare const Transfer: {
|
|
|
39778
39994
|
}) => Promise<AxiosResponse<any>>;
|
|
39779
39995
|
};
|
|
39780
39996
|
|
|
39997
|
+
/**
|
|
39998
|
+
* @namespace
|
|
39999
|
+
*/
|
|
39781
40000
|
export declare const Transfertest: {
|
|
39782
40001
|
/**
|
|
39783
40002
|
* Post Transfertest Transfer
|
|
@@ -39809,6 +40028,9 @@ export declare const Transfertest: {
|
|
|
39809
40028
|
}) => Promise<AxiosResponse<string>>;
|
|
39810
40029
|
};
|
|
39811
40030
|
|
|
40031
|
+
/**
|
|
40032
|
+
* @namespace
|
|
40033
|
+
*/
|
|
39812
40034
|
export declare const User: {
|
|
39813
40035
|
/**
|
|
39814
40036
|
* List Users
|
|
@@ -40854,6 +41076,9 @@ export declare const User: {
|
|
|
40854
41076
|
}) => Promise<AxiosResponse<string>>;
|
|
40855
41077
|
};
|
|
40856
41078
|
|
|
41079
|
+
/**
|
|
41080
|
+
* @namespace
|
|
41081
|
+
*/
|
|
40857
41082
|
export declare const Usercacherepair: {
|
|
40858
41083
|
/**
|
|
40859
41084
|
* Repair Usercacherepair User Cache
|
|
@@ -40875,6 +41100,9 @@ export declare const Usercacherepair: {
|
|
|
40875
41100
|
}) => Promise<AxiosResponse<string>>;
|
|
40876
41101
|
};
|
|
40877
41102
|
|
|
41103
|
+
/**
|
|
41104
|
+
* @namespace
|
|
41105
|
+
*/
|
|
40878
41106
|
export declare const Version: {
|
|
40879
41107
|
/**
|
|
40880
41108
|
* Get Version
|
|
@@ -40894,7 +41122,7 @@ export declare const Version: {
|
|
|
40894
41122
|
}) => Promise<AxiosResponse<VersionDocument>>;
|
|
40895
41123
|
};
|
|
40896
41124
|
|
|
40897
|
-
declare type VidiCoreRequestHeaderConfig = {
|
|
41125
|
+
export declare type VidiCoreRequestHeaderConfig = {
|
|
40898
41126
|
username?: string;
|
|
40899
41127
|
password?: string;
|
|
40900
41128
|
token?: string;
|
|
@@ -40903,6 +41131,15 @@ declare type VidiCoreRequestHeaderConfig = {
|
|
|
40903
41131
|
accept?: string;
|
|
40904
41132
|
} & AxiosRequestHeaderConfig;
|
|
40905
41133
|
|
|
41134
|
+
export declare interface VidiCoreRequestProps extends Omit<AxiosRequestConfig, 'headers' | 'params'> {
|
|
41135
|
+
headers?: VidiCoreRequestHeaderConfig;
|
|
41136
|
+
queryParams?: object;
|
|
41137
|
+
axiosInstance?: AxiosInstance;
|
|
41138
|
+
}
|
|
41139
|
+
|
|
41140
|
+
/**
|
|
41141
|
+
* @namespace
|
|
41142
|
+
*/
|
|
40906
41143
|
export declare const VidispineLogs: {
|
|
40907
41144
|
/**
|
|
40908
41145
|
* Get Vidispine Logs Log And Messages
|
|
@@ -41136,6 +41373,9 @@ export declare const VidispineLogs: {
|
|
|
41136
41373
|
}) => Promise<AxiosResponse<string>>;
|
|
41137
41374
|
};
|
|
41138
41375
|
|
|
41376
|
+
/**
|
|
41377
|
+
* @namespace
|
|
41378
|
+
*/
|
|
41139
41379
|
export declare const VidispineService: {
|
|
41140
41380
|
/**
|
|
41141
41381
|
* List Vidispine Service Services
|
|
@@ -41272,6 +41512,9 @@ export declare const VidispineService: {
|
|
|
41272
41512
|
}) => Promise<AxiosResponse<string>>;
|
|
41273
41513
|
};
|
|
41274
41514
|
|
|
41515
|
+
/**
|
|
41516
|
+
* @namespace
|
|
41517
|
+
*/
|
|
41275
41518
|
export declare const Vsaconnect: {
|
|
41276
41519
|
/**
|
|
41277
41520
|
* Configure Vsaconnect Atmosphere Resource
|
|
@@ -41306,6 +41549,9 @@ export declare const Vsaconnect: {
|
|
|
41306
41549
|
}) => Promise<AxiosResponse<any>>;
|
|
41307
41550
|
};
|
|
41308
41551
|
|
|
41552
|
+
/**
|
|
41553
|
+
* @namespace
|
|
41554
|
+
*/
|
|
41309
41555
|
export declare const Vxa: {
|
|
41310
41556
|
/**
|
|
41311
41557
|
* List Vxa VXA Node Resources
|
|
@@ -41416,6 +41662,9 @@ export declare const Vxa: {
|
|
|
41416
41662
|
}) => Promise<AxiosResponse<string>>;
|
|
41417
41663
|
};
|
|
41418
41664
|
|
|
41665
|
+
/**
|
|
41666
|
+
* @namespace
|
|
41667
|
+
*/
|
|
41419
41668
|
export declare const Waveform: {
|
|
41420
41669
|
/**
|
|
41421
41670
|
* Get Waveform Image No Auth
|
|
@@ -41438,6 +41687,9 @@ export declare const Waveform: {
|
|
|
41438
41687
|
}) => Promise<AxiosResponse<string>>;
|
|
41439
41688
|
};
|
|
41440
41689
|
|
|
41690
|
+
/**
|
|
41691
|
+
* @namespace
|
|
41692
|
+
*/
|
|
41441
41693
|
export declare const Whoami: {
|
|
41442
41694
|
/**
|
|
41443
41695
|
* Whoami
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vidispine/api",
|
|
3
|
-
"version": "23.4.0-pre.
|
|
3
|
+
"version": "23.4.0-pre.4",
|
|
4
4
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
5
5
|
"publishConfig": {
|
|
6
|
-
"access": "public"
|
|
6
|
+
"access": "public",
|
|
7
|
+
"registry": "https://registry.npmjs.org"
|
|
7
8
|
},
|
|
8
9
|
"description": "Typescript API for VidiCore",
|
|
9
10
|
"homepage": "https://vidispine.github.io/vdt/?path=/docs/api",
|
|
@@ -28,38 +29,36 @@
|
|
|
28
29
|
"scripts": {
|
|
29
30
|
"build": "yarn vite build",
|
|
30
31
|
"build:watch": "yarn vite build --watch --mode development",
|
|
31
|
-
"build:docs": "yarn typedoc --out ../../docs/build/api",
|
|
32
|
-
"update:docs": "yarn typedoc --logLevel Error && echo \"api docs updated\"",
|
|
32
|
+
"build:docs": "yarn typedoc --plugin typedoc-plugin-missing-exports --internalModule Internal --out ../../docs/build/api",
|
|
33
|
+
"update:docs": "yarn typedoc --plugin typedoc-plugin-missing-exports --internalModule Internal --logLevel Error && echo \"api docs updated\"",
|
|
33
34
|
"start:docs": "rimraf build/docs && yarn update:docs && yarn vite serve -c vite.docs.config",
|
|
34
35
|
"type-check": "tsc --noEmit --emitDeclarationOnly false",
|
|
35
|
-
"typedoc-check": "yarn typedoc --emit none --treatWarningsAsErrors --validation.invalidLink true --validation.notExported true --validation.notDocumented
|
|
36
|
+
"typedoc-check": "yarn typedoc --emit none --treatWarningsAsErrors --validation.invalidLink true --validation.notExported true --validation.notDocumented false",
|
|
36
37
|
"lint": "yarn type-check && eslint . --cache --max-warnings=0 --ext .js,.jsx,.ts,.tsx,.md,.mdx",
|
|
37
38
|
"format": "prettier . --check"
|
|
38
39
|
},
|
|
39
40
|
"dependencies": {
|
|
40
|
-
"@vidispine/types": "23.4.0-pre.
|
|
41
|
+
"@vidispine/types": "23.4.0-pre.4"
|
|
41
42
|
},
|
|
42
43
|
"peerDependencies": {
|
|
43
44
|
"axios": "^1.1.3",
|
|
44
45
|
"buffer": "^6.0.0"
|
|
45
46
|
},
|
|
46
47
|
"devDependencies": {
|
|
47
|
-
"@vidispine/eslint-config-base": "23.4.0-pre.
|
|
48
|
-
"@vidispine/eslint-config-mdx": "23.4.0-pre.
|
|
49
|
-
"@vidispine/eslint-config-storybook": "23.4.0-pre.
|
|
50
|
-
"@vidispine/
|
|
51
|
-
"
|
|
52
|
-
"axios": "1.5.0",
|
|
48
|
+
"@vidispine/eslint-config-base": "23.4.0-pre.4",
|
|
49
|
+
"@vidispine/eslint-config-mdx": "23.4.0-pre.4",
|
|
50
|
+
"@vidispine/eslint-config-storybook": "23.4.0-pre.4",
|
|
51
|
+
"@vidispine/tests": "23.4.0-pre.4",
|
|
52
|
+
"axios": "1.6.2",
|
|
53
53
|
"buffer": "6.0.3",
|
|
54
|
-
"
|
|
55
|
-
"
|
|
56
|
-
"
|
|
57
|
-
"
|
|
58
|
-
"typedoc": "
|
|
59
|
-
"
|
|
60
|
-
"
|
|
61
|
-
"vite": "
|
|
62
|
-
"vite-plugin-dts": "3.5.3"
|
|
54
|
+
"eslint": "8.55.0",
|
|
55
|
+
"prettier": "3.1.1",
|
|
56
|
+
"rimraf": "5.0.5",
|
|
57
|
+
"typedoc": "0.25.4",
|
|
58
|
+
"typedoc-plugin-missing-exports": "2.1.0",
|
|
59
|
+
"typescript": "5.0.4",
|
|
60
|
+
"vite": "4.5.1",
|
|
61
|
+
"vite-plugin-dts": "3.6.4"
|
|
63
62
|
},
|
|
64
63
|
"eslintConfig": {
|
|
65
64
|
"extends": [
|