@vertexvis/api-client-node 0.23.4 → 0.26.0
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/cjs/api.d.ts +901 -20
- package/dist/cjs/api.js +642 -21
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +901 -20
- package/dist/esm/api.js +634 -17
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -861,6 +861,57 @@ export interface CreateBatchRequest {
|
|
|
861
861
|
*/
|
|
862
862
|
'vertexvis/batch:operations': Array<BatchOperation>;
|
|
863
863
|
}
|
|
864
|
+
/**
|
|
865
|
+
*
|
|
866
|
+
* @export
|
|
867
|
+
* @interface CreateDownloadRequest
|
|
868
|
+
*/
|
|
869
|
+
export interface CreateDownloadRequest {
|
|
870
|
+
/**
|
|
871
|
+
*
|
|
872
|
+
* @type {CreateDownloadRequestData}
|
|
873
|
+
* @memberof CreateDownloadRequest
|
|
874
|
+
*/
|
|
875
|
+
data: CreateDownloadRequestData;
|
|
876
|
+
}
|
|
877
|
+
/**
|
|
878
|
+
*
|
|
879
|
+
* @export
|
|
880
|
+
* @interface CreateDownloadRequestData
|
|
881
|
+
*/
|
|
882
|
+
export interface CreateDownloadRequestData {
|
|
883
|
+
/**
|
|
884
|
+
* Resource object type.
|
|
885
|
+
* @type {string}
|
|
886
|
+
* @memberof CreateDownloadRequestData
|
|
887
|
+
*/
|
|
888
|
+
type: string;
|
|
889
|
+
/**
|
|
890
|
+
*
|
|
891
|
+
* @type {CreateDownloadRequestDataAttributes}
|
|
892
|
+
* @memberof CreateDownloadRequestData
|
|
893
|
+
*/
|
|
894
|
+
attributes: CreateDownloadRequestDataAttributes;
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
*
|
|
898
|
+
* @export
|
|
899
|
+
* @interface CreateDownloadRequestDataAttributes
|
|
900
|
+
*/
|
|
901
|
+
export interface CreateDownloadRequestDataAttributes {
|
|
902
|
+
/**
|
|
903
|
+
* Specifies the duration for which this pre-signed request should be valid. After this time has expired, attempting to use the presigned request will fail. (Defaults to 1 hour, max value is 24 hours)
|
|
904
|
+
* @type {number}
|
|
905
|
+
* @memberof CreateDownloadRequestDataAttributes
|
|
906
|
+
*/
|
|
907
|
+
expiry?: number;
|
|
908
|
+
/**
|
|
909
|
+
* Specifies the maximum time (in seconds) a cached response of a signed-url remains fresh and can be used without revalidation. (Defaults to 1 hour, can send up to 30 days)
|
|
910
|
+
* @type {number}
|
|
911
|
+
* @memberof CreateDownloadRequestDataAttributes
|
|
912
|
+
*/
|
|
913
|
+
maxAge?: number;
|
|
914
|
+
}
|
|
864
915
|
/**
|
|
865
916
|
*
|
|
866
917
|
* @export
|
|
@@ -937,6 +988,75 @@ export interface CreateExportRequestDataRelationships {
|
|
|
937
988
|
*/
|
|
938
989
|
state?: ExportStateRelationship;
|
|
939
990
|
}
|
|
991
|
+
/**
|
|
992
|
+
*
|
|
993
|
+
* @export
|
|
994
|
+
* @interface CreateFileCollectionRequest
|
|
995
|
+
*/
|
|
996
|
+
export interface CreateFileCollectionRequest {
|
|
997
|
+
/**
|
|
998
|
+
*
|
|
999
|
+
* @type {CreateFileCollectionRequestData}
|
|
1000
|
+
* @memberof CreateFileCollectionRequest
|
|
1001
|
+
*/
|
|
1002
|
+
data: CreateFileCollectionRequestData;
|
|
1003
|
+
}
|
|
1004
|
+
/**
|
|
1005
|
+
*
|
|
1006
|
+
* @export
|
|
1007
|
+
* @interface CreateFileCollectionRequestData
|
|
1008
|
+
*/
|
|
1009
|
+
export interface CreateFileCollectionRequestData {
|
|
1010
|
+
/**
|
|
1011
|
+
* Resource object type.
|
|
1012
|
+
* @type {string}
|
|
1013
|
+
* @memberof CreateFileCollectionRequestData
|
|
1014
|
+
*/
|
|
1015
|
+
type: CreateFileCollectionRequestDataTypeEnum;
|
|
1016
|
+
/**
|
|
1017
|
+
*
|
|
1018
|
+
* @type {CreateFileCollectionRequestDataAttributes}
|
|
1019
|
+
* @memberof CreateFileCollectionRequestData
|
|
1020
|
+
*/
|
|
1021
|
+
attributes: CreateFileCollectionRequestDataAttributes;
|
|
1022
|
+
}
|
|
1023
|
+
export declare const CreateFileCollectionRequestDataTypeEnum: {
|
|
1024
|
+
readonly FileCollection: "file-collection";
|
|
1025
|
+
};
|
|
1026
|
+
export declare type CreateFileCollectionRequestDataTypeEnum = (typeof CreateFileCollectionRequestDataTypeEnum)[keyof typeof CreateFileCollectionRequestDataTypeEnum];
|
|
1027
|
+
/**
|
|
1028
|
+
*
|
|
1029
|
+
* @export
|
|
1030
|
+
* @interface CreateFileCollectionRequestDataAttributes
|
|
1031
|
+
*/
|
|
1032
|
+
export interface CreateFileCollectionRequestDataAttributes {
|
|
1033
|
+
/**
|
|
1034
|
+
*
|
|
1035
|
+
* @type {string}
|
|
1036
|
+
* @memberof CreateFileCollectionRequestDataAttributes
|
|
1037
|
+
*/
|
|
1038
|
+
name?: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* ID provided for correlation with external systems, e.g. a PLM system.
|
|
1041
|
+
* @type {string}
|
|
1042
|
+
* @memberof CreateFileCollectionRequestDataAttributes
|
|
1043
|
+
*/
|
|
1044
|
+
suppliedId?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* Number of seconds before expiration
|
|
1047
|
+
* @type {number}
|
|
1048
|
+
* @memberof CreateFileCollectionRequestDataAttributes
|
|
1049
|
+
*/
|
|
1050
|
+
expiry?: number;
|
|
1051
|
+
/**
|
|
1052
|
+
* User supplied key-value pairs for a file-collection. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters.
|
|
1053
|
+
* @type {{ [key: string]: string; }}
|
|
1054
|
+
* @memberof CreateFileCollectionRequestDataAttributes
|
|
1055
|
+
*/
|
|
1056
|
+
metadata?: {
|
|
1057
|
+
[key: string]: string;
|
|
1058
|
+
};
|
|
1059
|
+
}
|
|
940
1060
|
/**
|
|
941
1061
|
*
|
|
942
1062
|
* @export
|
|
@@ -999,6 +1119,14 @@ export interface CreateFileRequestDataAttributes {
|
|
|
999
1119
|
* @memberof CreateFileRequestDataAttributes
|
|
1000
1120
|
*/
|
|
1001
1121
|
expiry?: number;
|
|
1122
|
+
/**
|
|
1123
|
+
* User supplied key-value pairs for a file. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters.
|
|
1124
|
+
* @type {{ [key: string]: string; }}
|
|
1125
|
+
* @memberof CreateFileRequestDataAttributes
|
|
1126
|
+
*/
|
|
1127
|
+
metadata?: {
|
|
1128
|
+
[key: string]: string;
|
|
1129
|
+
};
|
|
1002
1130
|
}
|
|
1003
1131
|
/**
|
|
1004
1132
|
*
|
|
@@ -1970,11 +2098,29 @@ export interface CreateStreamKeyRequestDataAttributes {
|
|
|
1970
2098
|
*/
|
|
1971
2099
|
expiry?: number;
|
|
1972
2100
|
/**
|
|
1973
|
-
* Whether to exclude non-visible items in the view
|
|
2101
|
+
* Whether to exclude non-visible items in the view.
|
|
1974
2102
|
* @type {boolean}
|
|
1975
2103
|
* @memberof CreateStreamKeyRequestDataAttributes
|
|
1976
2104
|
*/
|
|
1977
2105
|
excludePrunedItems?: boolean;
|
|
2106
|
+
/**
|
|
2107
|
+
* An optional supplied ID specifying the `scene-view-state` to initialize `scene-view`s created using this `stream-key` to. Mutually exclusive with `sceneViewStateId`.
|
|
2108
|
+
* @type {string}
|
|
2109
|
+
* @memberof CreateStreamKeyRequestDataAttributes
|
|
2110
|
+
*/
|
|
2111
|
+
sceneViewStateSuppliedId?: string;
|
|
2112
|
+
/**
|
|
2113
|
+
* An optional ID specifying the `scene-view-state` to initialize `scene-view`s created using this `stream-key` to. Mutually exclusive with `sceneViewStateSuppliedId`.
|
|
2114
|
+
* @type {string}
|
|
2115
|
+
* @memberof CreateStreamKeyRequestDataAttributes
|
|
2116
|
+
*/
|
|
2117
|
+
sceneViewStateId?: string;
|
|
2118
|
+
/**
|
|
2119
|
+
* Optionally enables or disables the creation of a search session for the view.
|
|
2120
|
+
* @type {boolean}
|
|
2121
|
+
* @memberof CreateStreamKeyRequestDataAttributes
|
|
2122
|
+
*/
|
|
2123
|
+
withSearchSession?: boolean;
|
|
1978
2124
|
}
|
|
1979
2125
|
/**
|
|
1980
2126
|
*
|
|
@@ -2189,6 +2335,73 @@ export interface Dimensions {
|
|
|
2189
2335
|
*/
|
|
2190
2336
|
width: number;
|
|
2191
2337
|
}
|
|
2338
|
+
/**
|
|
2339
|
+
*
|
|
2340
|
+
* @export
|
|
2341
|
+
* @interface DownloadUrl
|
|
2342
|
+
*/
|
|
2343
|
+
export interface DownloadUrl {
|
|
2344
|
+
/**
|
|
2345
|
+
*
|
|
2346
|
+
* @type {DownloadUrlData}
|
|
2347
|
+
* @memberof DownloadUrl
|
|
2348
|
+
*/
|
|
2349
|
+
data: DownloadUrlData;
|
|
2350
|
+
/**
|
|
2351
|
+
*
|
|
2352
|
+
* @type {{ [key: string]: Link; }}
|
|
2353
|
+
* @memberof DownloadUrl
|
|
2354
|
+
*/
|
|
2355
|
+
links?: {
|
|
2356
|
+
[key: string]: Link;
|
|
2357
|
+
};
|
|
2358
|
+
}
|
|
2359
|
+
/**
|
|
2360
|
+
*
|
|
2361
|
+
* @export
|
|
2362
|
+
* @interface DownloadUrlData
|
|
2363
|
+
*/
|
|
2364
|
+
export interface DownloadUrlData {
|
|
2365
|
+
/**
|
|
2366
|
+
*
|
|
2367
|
+
* @type {string}
|
|
2368
|
+
* @memberof DownloadUrlData
|
|
2369
|
+
*/
|
|
2370
|
+
type: string;
|
|
2371
|
+
/**
|
|
2372
|
+
* ID of the resource.
|
|
2373
|
+
* @type {string}
|
|
2374
|
+
* @memberof DownloadUrlData
|
|
2375
|
+
*/
|
|
2376
|
+
id: string;
|
|
2377
|
+
/**
|
|
2378
|
+
*
|
|
2379
|
+
* @type {DownloadUrlDataAttributes}
|
|
2380
|
+
* @memberof DownloadUrlData
|
|
2381
|
+
*/
|
|
2382
|
+
attributes: DownloadUrlDataAttributes;
|
|
2383
|
+
/**
|
|
2384
|
+
*
|
|
2385
|
+
* @type {{ [key: string]: Link; }}
|
|
2386
|
+
* @memberof DownloadUrlData
|
|
2387
|
+
*/
|
|
2388
|
+
links?: {
|
|
2389
|
+
[key: string]: Link;
|
|
2390
|
+
};
|
|
2391
|
+
}
|
|
2392
|
+
/**
|
|
2393
|
+
*
|
|
2394
|
+
* @export
|
|
2395
|
+
* @interface DownloadUrlDataAttributes
|
|
2396
|
+
*/
|
|
2397
|
+
export interface DownloadUrlDataAttributes {
|
|
2398
|
+
/**
|
|
2399
|
+
*
|
|
2400
|
+
* @type {string}
|
|
2401
|
+
* @memberof DownloadUrlDataAttributes
|
|
2402
|
+
*/
|
|
2403
|
+
downloadUrl: string;
|
|
2404
|
+
}
|
|
2192
2405
|
/**
|
|
2193
2406
|
*
|
|
2194
2407
|
* @export
|
|
@@ -2395,6 +2608,131 @@ export interface FeatureLines {
|
|
|
2395
2608
|
*/
|
|
2396
2609
|
width: number;
|
|
2397
2610
|
}
|
|
2611
|
+
/**
|
|
2612
|
+
*
|
|
2613
|
+
* @export
|
|
2614
|
+
* @interface FileCollectionList
|
|
2615
|
+
*/
|
|
2616
|
+
export interface FileCollectionList {
|
|
2617
|
+
/**
|
|
2618
|
+
*
|
|
2619
|
+
* @type {Array<FileCollectionMetadataData>}
|
|
2620
|
+
* @memberof FileCollectionList
|
|
2621
|
+
*/
|
|
2622
|
+
data: Array<FileCollectionMetadataData>;
|
|
2623
|
+
/**
|
|
2624
|
+
*
|
|
2625
|
+
* @type {{ [key: string]: Link; }}
|
|
2626
|
+
* @memberof FileCollectionList
|
|
2627
|
+
*/
|
|
2628
|
+
links: {
|
|
2629
|
+
[key: string]: Link;
|
|
2630
|
+
};
|
|
2631
|
+
}
|
|
2632
|
+
/**
|
|
2633
|
+
*
|
|
2634
|
+
* @export
|
|
2635
|
+
* @interface FileCollectionMetadata
|
|
2636
|
+
*/
|
|
2637
|
+
export interface FileCollectionMetadata {
|
|
2638
|
+
/**
|
|
2639
|
+
*
|
|
2640
|
+
* @type {FileCollectionMetadataData}
|
|
2641
|
+
* @memberof FileCollectionMetadata
|
|
2642
|
+
*/
|
|
2643
|
+
data: FileCollectionMetadataData;
|
|
2644
|
+
/**
|
|
2645
|
+
*
|
|
2646
|
+
* @type {{ [key: string]: Link; }}
|
|
2647
|
+
* @memberof FileCollectionMetadata
|
|
2648
|
+
*/
|
|
2649
|
+
links?: {
|
|
2650
|
+
[key: string]: Link;
|
|
2651
|
+
};
|
|
2652
|
+
}
|
|
2653
|
+
/**
|
|
2654
|
+
*
|
|
2655
|
+
* @export
|
|
2656
|
+
* @interface FileCollectionMetadataData
|
|
2657
|
+
*/
|
|
2658
|
+
export interface FileCollectionMetadataData {
|
|
2659
|
+
/**
|
|
2660
|
+
*
|
|
2661
|
+
* @type {string}
|
|
2662
|
+
* @memberof FileCollectionMetadataData
|
|
2663
|
+
*/
|
|
2664
|
+
type: FileCollectionMetadataDataTypeEnum;
|
|
2665
|
+
/**
|
|
2666
|
+
* ID of the resource.
|
|
2667
|
+
* @type {string}
|
|
2668
|
+
* @memberof FileCollectionMetadataData
|
|
2669
|
+
*/
|
|
2670
|
+
id: string;
|
|
2671
|
+
/**
|
|
2672
|
+
*
|
|
2673
|
+
* @type {FileCollectionMetadataDataAttributes}
|
|
2674
|
+
* @memberof FileCollectionMetadataData
|
|
2675
|
+
*/
|
|
2676
|
+
attributes: FileCollectionMetadataDataAttributes;
|
|
2677
|
+
/**
|
|
2678
|
+
*
|
|
2679
|
+
* @type {{ [key: string]: Link; }}
|
|
2680
|
+
* @memberof FileCollectionMetadataData
|
|
2681
|
+
*/
|
|
2682
|
+
links?: {
|
|
2683
|
+
[key: string]: Link;
|
|
2684
|
+
};
|
|
2685
|
+
}
|
|
2686
|
+
export declare const FileCollectionMetadataDataTypeEnum: {
|
|
2687
|
+
readonly FileCollection: "file-collection";
|
|
2688
|
+
};
|
|
2689
|
+
export declare type FileCollectionMetadataDataTypeEnum = (typeof FileCollectionMetadataDataTypeEnum)[keyof typeof FileCollectionMetadataDataTypeEnum];
|
|
2690
|
+
/**
|
|
2691
|
+
*
|
|
2692
|
+
* @export
|
|
2693
|
+
* @interface FileCollectionMetadataDataAttributes
|
|
2694
|
+
*/
|
|
2695
|
+
export interface FileCollectionMetadataDataAttributes {
|
|
2696
|
+
/**
|
|
2697
|
+
*
|
|
2698
|
+
* @type {string}
|
|
2699
|
+
* @memberof FileCollectionMetadataDataAttributes
|
|
2700
|
+
*/
|
|
2701
|
+
name?: string;
|
|
2702
|
+
/**
|
|
2703
|
+
* ID provided for correlation with external systems, e.g. a PLM system.
|
|
2704
|
+
* @type {string}
|
|
2705
|
+
* @memberof FileCollectionMetadataDataAttributes
|
|
2706
|
+
*/
|
|
2707
|
+
suppliedId?: string;
|
|
2708
|
+
/**
|
|
2709
|
+
*
|
|
2710
|
+
* @type {string}
|
|
2711
|
+
* @memberof FileCollectionMetadataDataAttributes
|
|
2712
|
+
*/
|
|
2713
|
+
created: string;
|
|
2714
|
+
/**
|
|
2715
|
+
*
|
|
2716
|
+
* @type {{ [key: string]: string; }}
|
|
2717
|
+
* @memberof FileCollectionMetadataDataAttributes
|
|
2718
|
+
*/
|
|
2719
|
+
metadata?: {
|
|
2720
|
+
[key: string]: string;
|
|
2721
|
+
};
|
|
2722
|
+
}
|
|
2723
|
+
/**
|
|
2724
|
+
*
|
|
2725
|
+
* @export
|
|
2726
|
+
* @interface FileIdList
|
|
2727
|
+
*/
|
|
2728
|
+
export interface FileIdList {
|
|
2729
|
+
/**
|
|
2730
|
+
*
|
|
2731
|
+
* @type {Array<string>}
|
|
2732
|
+
* @memberof FileIdList
|
|
2733
|
+
*/
|
|
2734
|
+
data: Array<string>;
|
|
2735
|
+
}
|
|
2398
2736
|
/**
|
|
2399
2737
|
*
|
|
2400
2738
|
* @export
|
|
@@ -2518,6 +2856,14 @@ export interface FileMetadataDataAttributes {
|
|
|
2518
2856
|
* @memberof FileMetadataDataAttributes
|
|
2519
2857
|
*/
|
|
2520
2858
|
size?: number;
|
|
2859
|
+
/**
|
|
2860
|
+
*
|
|
2861
|
+
* @type {{ [key: string]: string; }}
|
|
2862
|
+
* @memberof FileMetadataDataAttributes
|
|
2863
|
+
*/
|
|
2864
|
+
metadata?: {
|
|
2865
|
+
[key: string]: string;
|
|
2866
|
+
};
|
|
2521
2867
|
}
|
|
2522
2868
|
/**
|
|
2523
2869
|
* Relationship to a `file`.
|
|
@@ -4174,12 +4520,6 @@ export interface PropertyEntryList {
|
|
|
4174
4520
|
* @interface PropertyKeyType
|
|
4175
4521
|
*/
|
|
4176
4522
|
export interface PropertyKeyType {
|
|
4177
|
-
/**
|
|
4178
|
-
* The key category
|
|
4179
|
-
* @type {string}
|
|
4180
|
-
* @memberof PropertyKeyType
|
|
4181
|
-
*/
|
|
4182
|
-
category: PropertyKeyTypeCategoryEnum;
|
|
4183
4523
|
/**
|
|
4184
4524
|
*
|
|
4185
4525
|
* @type {string}
|
|
@@ -4187,12 +4527,6 @@ export interface PropertyKeyType {
|
|
|
4187
4527
|
*/
|
|
4188
4528
|
name: string;
|
|
4189
4529
|
}
|
|
4190
|
-
export declare const PropertyKeyTypeCategoryEnum: {
|
|
4191
|
-
readonly Vendor: "vendor";
|
|
4192
|
-
readonly Vertex: "vertex";
|
|
4193
|
-
readonly User: "user";
|
|
4194
|
-
};
|
|
4195
|
-
export declare type PropertyKeyTypeCategoryEnum = (typeof PropertyKeyTypeCategoryEnum)[keyof typeof PropertyKeyTypeCategoryEnum];
|
|
4196
4530
|
/**
|
|
4197
4531
|
*
|
|
4198
4532
|
* @export
|
|
@@ -4407,15 +4741,76 @@ export declare type QueryByIdDataAttributesTypeEnum = (typeof QueryByIdDataAttri
|
|
|
4407
4741
|
/**
|
|
4408
4742
|
*
|
|
4409
4743
|
* @export
|
|
4410
|
-
* @interface
|
|
4744
|
+
* @interface QueryByMetadata
|
|
4411
4745
|
*/
|
|
4412
|
-
export interface
|
|
4746
|
+
export interface QueryByMetadata {
|
|
4413
4747
|
/**
|
|
4414
4748
|
*
|
|
4415
|
-
* @type {
|
|
4416
|
-
* @memberof
|
|
4749
|
+
* @type {QueryByMetadataData}
|
|
4750
|
+
* @memberof QueryByMetadata
|
|
4417
4751
|
*/
|
|
4418
|
-
data:
|
|
4752
|
+
data: QueryByMetadataData;
|
|
4753
|
+
}
|
|
4754
|
+
/**
|
|
4755
|
+
*
|
|
4756
|
+
* @export
|
|
4757
|
+
* @interface QueryByMetadataData
|
|
4758
|
+
*/
|
|
4759
|
+
export interface QueryByMetadataData {
|
|
4760
|
+
/**
|
|
4761
|
+
* Resource object type.
|
|
4762
|
+
* @type {string}
|
|
4763
|
+
* @memberof QueryByMetadataData
|
|
4764
|
+
*/
|
|
4765
|
+
type: QueryByMetadataDataTypeEnum;
|
|
4766
|
+
/**
|
|
4767
|
+
*
|
|
4768
|
+
* @type {QueryByMetadataDataAttributes}
|
|
4769
|
+
* @memberof QueryByMetadataData
|
|
4770
|
+
*/
|
|
4771
|
+
attributes: QueryByMetadataDataAttributes;
|
|
4772
|
+
}
|
|
4773
|
+
export declare const QueryByMetadataDataTypeEnum: {
|
|
4774
|
+
readonly QueryByMetadata: "query-by-metadata";
|
|
4775
|
+
};
|
|
4776
|
+
export declare type QueryByMetadataDataTypeEnum = (typeof QueryByMetadataDataTypeEnum)[keyof typeof QueryByMetadataDataTypeEnum];
|
|
4777
|
+
/**
|
|
4778
|
+
*
|
|
4779
|
+
* @export
|
|
4780
|
+
* @interface QueryByMetadataDataAttributes
|
|
4781
|
+
*/
|
|
4782
|
+
export interface QueryByMetadataDataAttributes {
|
|
4783
|
+
/**
|
|
4784
|
+
*
|
|
4785
|
+
* @type {boolean}
|
|
4786
|
+
* @memberof QueryByMetadataDataAttributes
|
|
4787
|
+
*/
|
|
4788
|
+
exactMatch?: boolean;
|
|
4789
|
+
/**
|
|
4790
|
+
*
|
|
4791
|
+
* @type {string}
|
|
4792
|
+
* @memberof QueryByMetadataDataAttributes
|
|
4793
|
+
*/
|
|
4794
|
+
filter: string;
|
|
4795
|
+
/**
|
|
4796
|
+
* Query `metadata`.
|
|
4797
|
+
* @type {Array<string>}
|
|
4798
|
+
* @memberof QueryByMetadataDataAttributes
|
|
4799
|
+
*/
|
|
4800
|
+
keys: Array<string>;
|
|
4801
|
+
}
|
|
4802
|
+
/**
|
|
4803
|
+
*
|
|
4804
|
+
* @export
|
|
4805
|
+
* @interface QueuedJob
|
|
4806
|
+
*/
|
|
4807
|
+
export interface QueuedJob {
|
|
4808
|
+
/**
|
|
4809
|
+
*
|
|
4810
|
+
* @type {QueuedJobData}
|
|
4811
|
+
* @memberof QueuedJob
|
|
4812
|
+
*/
|
|
4813
|
+
data: QueuedJobData;
|
|
4419
4814
|
/**
|
|
4420
4815
|
*
|
|
4421
4816
|
* @type {{ [key: string]: Link; }}
|
|
@@ -5568,10 +5963,10 @@ export interface SceneList {
|
|
|
5568
5963
|
export interface SceneOperation {
|
|
5569
5964
|
/**
|
|
5570
5965
|
* Query `scene-items`. Use `query-by-collection` to combine multiple queries.
|
|
5571
|
-
* @type {QueryById | QueryByCollection | QueryAll}
|
|
5966
|
+
* @type {QueryById | QueryByCollection | QueryAll | QueryByMetadata}
|
|
5572
5967
|
* @memberof SceneOperation
|
|
5573
5968
|
*/
|
|
5574
|
-
query: QueryById | QueryByCollection | QueryAll;
|
|
5969
|
+
query: QueryById | QueryByCollection | QueryAll | QueryByMetadata;
|
|
5575
5970
|
/**
|
|
5576
5971
|
* List of operations to perform on `scene-items` matching the query.
|
|
5577
5972
|
* @type {Array<ChangeVisibilityOp | ChangeMaterialOp | ClearMaterialOp | ChangeTransformOp | ClearTransformOp | SelectOp | DeselectOperation | ClearRenOp | ViewDefaultRenOp | ViewRenByIdOp | ViewRenBySuppliedIdOp | ViewRepByIdOp | ViewRepByPredefinedIdOp | ClearRepOp>}
|
|
@@ -6270,6 +6665,18 @@ export interface StreamKeyDataAttributes {
|
|
|
6270
6665
|
* @memberof StreamKeyDataAttributes
|
|
6271
6666
|
*/
|
|
6272
6667
|
excludePrunedItems?: boolean;
|
|
6668
|
+
/**
|
|
6669
|
+
*
|
|
6670
|
+
* @type {string}
|
|
6671
|
+
* @memberof StreamKeyDataAttributes
|
|
6672
|
+
*/
|
|
6673
|
+
sceneViewStateSuppliedId?: string;
|
|
6674
|
+
/**
|
|
6675
|
+
* ID of the resource.
|
|
6676
|
+
* @type {string}
|
|
6677
|
+
* @memberof StreamKeyDataAttributes
|
|
6678
|
+
*/
|
|
6679
|
+
sceneViewStateId?: string;
|
|
6273
6680
|
}
|
|
6274
6681
|
/**
|
|
6275
6682
|
*
|
|
@@ -6495,6 +6902,55 @@ export interface UpdateApplicationRequestDataAttributes {
|
|
|
6495
6902
|
*/
|
|
6496
6903
|
redirect_uris?: Array<string>;
|
|
6497
6904
|
}
|
|
6905
|
+
/**
|
|
6906
|
+
*
|
|
6907
|
+
* @export
|
|
6908
|
+
* @interface UpdateFileCollectionRequest
|
|
6909
|
+
*/
|
|
6910
|
+
export interface UpdateFileCollectionRequest {
|
|
6911
|
+
/**
|
|
6912
|
+
*
|
|
6913
|
+
* @type {UpdateFileCollectionRequestData}
|
|
6914
|
+
* @memberof UpdateFileCollectionRequest
|
|
6915
|
+
*/
|
|
6916
|
+
data: UpdateFileCollectionRequestData;
|
|
6917
|
+
}
|
|
6918
|
+
/**
|
|
6919
|
+
*
|
|
6920
|
+
* @export
|
|
6921
|
+
* @interface UpdateFileCollectionRequestData
|
|
6922
|
+
*/
|
|
6923
|
+
export interface UpdateFileCollectionRequestData {
|
|
6924
|
+
/**
|
|
6925
|
+
* Resource object type.
|
|
6926
|
+
* @type {string}
|
|
6927
|
+
* @memberof UpdateFileCollectionRequestData
|
|
6928
|
+
*/
|
|
6929
|
+
type: UpdateFileCollectionRequestDataTypeEnum;
|
|
6930
|
+
/**
|
|
6931
|
+
*
|
|
6932
|
+
* @type {UpdateFileCollectionRequestDataAttributes}
|
|
6933
|
+
* @memberof UpdateFileCollectionRequestData
|
|
6934
|
+
*/
|
|
6935
|
+
attributes: UpdateFileCollectionRequestDataAttributes;
|
|
6936
|
+
}
|
|
6937
|
+
export declare const UpdateFileCollectionRequestDataTypeEnum: {
|
|
6938
|
+
readonly FileCollection: "file-collection";
|
|
6939
|
+
};
|
|
6940
|
+
export declare type UpdateFileCollectionRequestDataTypeEnum = (typeof UpdateFileCollectionRequestDataTypeEnum)[keyof typeof UpdateFileCollectionRequestDataTypeEnum];
|
|
6941
|
+
/**
|
|
6942
|
+
*
|
|
6943
|
+
* @export
|
|
6944
|
+
* @interface UpdateFileCollectionRequestDataAttributes
|
|
6945
|
+
*/
|
|
6946
|
+
export interface UpdateFileCollectionRequestDataAttributes {
|
|
6947
|
+
/**
|
|
6948
|
+
* Number of seconds before expiration
|
|
6949
|
+
* @type {number}
|
|
6950
|
+
* @memberof UpdateFileCollectionRequestDataAttributes
|
|
6951
|
+
*/
|
|
6952
|
+
expiry?: number;
|
|
6953
|
+
}
|
|
6498
6954
|
/**
|
|
6499
6955
|
*
|
|
6500
6956
|
* @export
|
|
@@ -8626,11 +9082,393 @@ export declare class ExportsApi extends BaseAPI {
|
|
|
8626
9082
|
*/
|
|
8627
9083
|
getQueuedExport(requestParameters: ExportsApiGetQueuedExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
|
|
8628
9084
|
}
|
|
9085
|
+
/**
|
|
9086
|
+
* FileCollectionsApi - axios parameter creator
|
|
9087
|
+
* @export
|
|
9088
|
+
*/
|
|
9089
|
+
export declare const FileCollectionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9090
|
+
/**
|
|
9091
|
+
* Add files to a `file-collection`.
|
|
9092
|
+
* @param {string} id The `file-collection` ID.
|
|
9093
|
+
* @param {FileIdList} fileIdList
|
|
9094
|
+
* @param {*} [options] Override http request option.
|
|
9095
|
+
* @throws {RequiredError}
|
|
9096
|
+
*/
|
|
9097
|
+
addFileCollectionFiles: (id: string, fileIdList: FileIdList, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9098
|
+
/**
|
|
9099
|
+
* Create a `file-collection`.
|
|
9100
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
9101
|
+
* @param {*} [options] Override http request option.
|
|
9102
|
+
* @throws {RequiredError}
|
|
9103
|
+
*/
|
|
9104
|
+
createFileCollection: (createFileCollectionRequest: CreateFileCollectionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9105
|
+
/**
|
|
9106
|
+
* Delete a `file-collection`.
|
|
9107
|
+
* @param {string} id The `file-collection` ID.
|
|
9108
|
+
* @param {*} [options] Override http request option.
|
|
9109
|
+
* @throws {RequiredError}
|
|
9110
|
+
*/
|
|
9111
|
+
deleteFileCollection: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9112
|
+
/**
|
|
9113
|
+
* Get a `file-collection` by ID.
|
|
9114
|
+
* @param {string} id The `file-collection` ID.
|
|
9115
|
+
* @param {*} [options] Override http request option.
|
|
9116
|
+
* @throws {RequiredError}
|
|
9117
|
+
*/
|
|
9118
|
+
getFileCollection: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9119
|
+
/**
|
|
9120
|
+
* List the files in a `file-collection`.
|
|
9121
|
+
* @param {string} id The `file-collection` ID.
|
|
9122
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9123
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9124
|
+
* @param {*} [options] Override http request option.
|
|
9125
|
+
* @throws {RequiredError}
|
|
9126
|
+
*/
|
|
9127
|
+
listFileCollectionFiles: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9128
|
+
/**
|
|
9129
|
+
* List `file-collection`s by supplied ID.
|
|
9130
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9131
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9132
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9133
|
+
* @param {*} [options] Override http request option.
|
|
9134
|
+
* @throws {RequiredError}
|
|
9135
|
+
*/
|
|
9136
|
+
listFileCollections: (pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9137
|
+
/**
|
|
9138
|
+
* Update a `file-collection`.
|
|
9139
|
+
* @param {string} id The `file-collection` ID.
|
|
9140
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
9141
|
+
* @param {*} [options] Override http request option.
|
|
9142
|
+
* @throws {RequiredError}
|
|
9143
|
+
*/
|
|
9144
|
+
updateFileCollection: (id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9145
|
+
};
|
|
9146
|
+
/**
|
|
9147
|
+
* FileCollectionsApi - functional programming interface
|
|
9148
|
+
* @export
|
|
9149
|
+
*/
|
|
9150
|
+
export declare const FileCollectionsApiFp: (configuration?: Configuration | undefined) => {
|
|
9151
|
+
/**
|
|
9152
|
+
* Add files to a `file-collection`.
|
|
9153
|
+
* @param {string} id The `file-collection` ID.
|
|
9154
|
+
* @param {FileIdList} fileIdList
|
|
9155
|
+
* @param {*} [options] Override http request option.
|
|
9156
|
+
* @throws {RequiredError}
|
|
9157
|
+
*/
|
|
9158
|
+
addFileCollectionFiles(id: string, fileIdList: FileIdList, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
|
|
9159
|
+
/**
|
|
9160
|
+
* Create a `file-collection`.
|
|
9161
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
9162
|
+
* @param {*} [options] Override http request option.
|
|
9163
|
+
* @throws {RequiredError}
|
|
9164
|
+
*/
|
|
9165
|
+
createFileCollection(createFileCollectionRequest: CreateFileCollectionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
|
|
9166
|
+
/**
|
|
9167
|
+
* Delete a `file-collection`.
|
|
9168
|
+
* @param {string} id The `file-collection` ID.
|
|
9169
|
+
* @param {*} [options] Override http request option.
|
|
9170
|
+
* @throws {RequiredError}
|
|
9171
|
+
*/
|
|
9172
|
+
deleteFileCollection(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
9173
|
+
/**
|
|
9174
|
+
* Get a `file-collection` by ID.
|
|
9175
|
+
* @param {string} id The `file-collection` ID.
|
|
9176
|
+
* @param {*} [options] Override http request option.
|
|
9177
|
+
* @throws {RequiredError}
|
|
9178
|
+
*/
|
|
9179
|
+
getFileCollection(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
|
|
9180
|
+
/**
|
|
9181
|
+
* List the files in a `file-collection`.
|
|
9182
|
+
* @param {string} id The `file-collection` ID.
|
|
9183
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9184
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9185
|
+
* @param {*} [options] Override http request option.
|
|
9186
|
+
* @throws {RequiredError}
|
|
9187
|
+
*/
|
|
9188
|
+
listFileCollectionFiles(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileList>>;
|
|
9189
|
+
/**
|
|
9190
|
+
* List `file-collection`s by supplied ID.
|
|
9191
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9192
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9193
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9194
|
+
* @param {*} [options] Override http request option.
|
|
9195
|
+
* @throws {RequiredError}
|
|
9196
|
+
*/
|
|
9197
|
+
listFileCollections(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionList>>;
|
|
9198
|
+
/**
|
|
9199
|
+
* Update a `file-collection`.
|
|
9200
|
+
* @param {string} id The `file-collection` ID.
|
|
9201
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
9202
|
+
* @param {*} [options] Override http request option.
|
|
9203
|
+
* @throws {RequiredError}
|
|
9204
|
+
*/
|
|
9205
|
+
updateFileCollection(id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
9206
|
+
};
|
|
9207
|
+
/**
|
|
9208
|
+
* FileCollectionsApi - factory interface
|
|
9209
|
+
* @export
|
|
9210
|
+
*/
|
|
9211
|
+
export declare const FileCollectionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9212
|
+
/**
|
|
9213
|
+
* Add files to a `file-collection`.
|
|
9214
|
+
* @param {string} id The `file-collection` ID.
|
|
9215
|
+
* @param {FileIdList} fileIdList
|
|
9216
|
+
* @param {*} [options] Override http request option.
|
|
9217
|
+
* @throws {RequiredError}
|
|
9218
|
+
*/
|
|
9219
|
+
addFileCollectionFiles(id: string, fileIdList: FileIdList, options?: any): AxiosPromise<FileCollectionMetadata>;
|
|
9220
|
+
/**
|
|
9221
|
+
* Create a `file-collection`.
|
|
9222
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
9223
|
+
* @param {*} [options] Override http request option.
|
|
9224
|
+
* @throws {RequiredError}
|
|
9225
|
+
*/
|
|
9226
|
+
createFileCollection(createFileCollectionRequest: CreateFileCollectionRequest, options?: any): AxiosPromise<FileCollectionMetadata>;
|
|
9227
|
+
/**
|
|
9228
|
+
* Delete a `file-collection`.
|
|
9229
|
+
* @param {string} id The `file-collection` ID.
|
|
9230
|
+
* @param {*} [options] Override http request option.
|
|
9231
|
+
* @throws {RequiredError}
|
|
9232
|
+
*/
|
|
9233
|
+
deleteFileCollection(id: string, options?: any): AxiosPromise<void>;
|
|
9234
|
+
/**
|
|
9235
|
+
* Get a `file-collection` by ID.
|
|
9236
|
+
* @param {string} id The `file-collection` ID.
|
|
9237
|
+
* @param {*} [options] Override http request option.
|
|
9238
|
+
* @throws {RequiredError}
|
|
9239
|
+
*/
|
|
9240
|
+
getFileCollection(id: string, options?: any): AxiosPromise<FileCollectionMetadata>;
|
|
9241
|
+
/**
|
|
9242
|
+
* List the files in a `file-collection`.
|
|
9243
|
+
* @param {string} id The `file-collection` ID.
|
|
9244
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9245
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9246
|
+
* @param {*} [options] Override http request option.
|
|
9247
|
+
* @throws {RequiredError}
|
|
9248
|
+
*/
|
|
9249
|
+
listFileCollectionFiles(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<FileList>;
|
|
9250
|
+
/**
|
|
9251
|
+
* List `file-collection`s by supplied ID.
|
|
9252
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9253
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9254
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9255
|
+
* @param {*} [options] Override http request option.
|
|
9256
|
+
* @throws {RequiredError}
|
|
9257
|
+
*/
|
|
9258
|
+
listFileCollections(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<FileCollectionList>;
|
|
9259
|
+
/**
|
|
9260
|
+
* Update a `file-collection`.
|
|
9261
|
+
* @param {string} id The `file-collection` ID.
|
|
9262
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
9263
|
+
* @param {*} [options] Override http request option.
|
|
9264
|
+
* @throws {RequiredError}
|
|
9265
|
+
*/
|
|
9266
|
+
updateFileCollection(id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: any): AxiosPromise<void>;
|
|
9267
|
+
};
|
|
9268
|
+
/**
|
|
9269
|
+
* Request parameters for addFileCollectionFiles operation in FileCollectionsApi.
|
|
9270
|
+
* @export
|
|
9271
|
+
* @interface FileCollectionsApiAddFileCollectionFilesRequest
|
|
9272
|
+
*/
|
|
9273
|
+
export interface FileCollectionsApiAddFileCollectionFilesRequest {
|
|
9274
|
+
/**
|
|
9275
|
+
* The `file-collection` ID.
|
|
9276
|
+
* @type {string}
|
|
9277
|
+
* @memberof FileCollectionsApiAddFileCollectionFiles
|
|
9278
|
+
*/
|
|
9279
|
+
readonly id: string;
|
|
9280
|
+
/**
|
|
9281
|
+
*
|
|
9282
|
+
* @type {FileIdList}
|
|
9283
|
+
* @memberof FileCollectionsApiAddFileCollectionFiles
|
|
9284
|
+
*/
|
|
9285
|
+
readonly fileIdList: FileIdList;
|
|
9286
|
+
}
|
|
9287
|
+
/**
|
|
9288
|
+
* Request parameters for createFileCollection operation in FileCollectionsApi.
|
|
9289
|
+
* @export
|
|
9290
|
+
* @interface FileCollectionsApiCreateFileCollectionRequest
|
|
9291
|
+
*/
|
|
9292
|
+
export interface FileCollectionsApiCreateFileCollectionRequest {
|
|
9293
|
+
/**
|
|
9294
|
+
*
|
|
9295
|
+
* @type {CreateFileCollectionRequest}
|
|
9296
|
+
* @memberof FileCollectionsApiCreateFileCollection
|
|
9297
|
+
*/
|
|
9298
|
+
readonly createFileCollectionRequest: CreateFileCollectionRequest;
|
|
9299
|
+
}
|
|
9300
|
+
/**
|
|
9301
|
+
* Request parameters for deleteFileCollection operation in FileCollectionsApi.
|
|
9302
|
+
* @export
|
|
9303
|
+
* @interface FileCollectionsApiDeleteFileCollectionRequest
|
|
9304
|
+
*/
|
|
9305
|
+
export interface FileCollectionsApiDeleteFileCollectionRequest {
|
|
9306
|
+
/**
|
|
9307
|
+
* The `file-collection` ID.
|
|
9308
|
+
* @type {string}
|
|
9309
|
+
* @memberof FileCollectionsApiDeleteFileCollection
|
|
9310
|
+
*/
|
|
9311
|
+
readonly id: string;
|
|
9312
|
+
}
|
|
9313
|
+
/**
|
|
9314
|
+
* Request parameters for getFileCollection operation in FileCollectionsApi.
|
|
9315
|
+
* @export
|
|
9316
|
+
* @interface FileCollectionsApiGetFileCollectionRequest
|
|
9317
|
+
*/
|
|
9318
|
+
export interface FileCollectionsApiGetFileCollectionRequest {
|
|
9319
|
+
/**
|
|
9320
|
+
* The `file-collection` ID.
|
|
9321
|
+
* @type {string}
|
|
9322
|
+
* @memberof FileCollectionsApiGetFileCollection
|
|
9323
|
+
*/
|
|
9324
|
+
readonly id: string;
|
|
9325
|
+
}
|
|
9326
|
+
/**
|
|
9327
|
+
* Request parameters for listFileCollectionFiles operation in FileCollectionsApi.
|
|
9328
|
+
* @export
|
|
9329
|
+
* @interface FileCollectionsApiListFileCollectionFilesRequest
|
|
9330
|
+
*/
|
|
9331
|
+
export interface FileCollectionsApiListFileCollectionFilesRequest {
|
|
9332
|
+
/**
|
|
9333
|
+
* The `file-collection` ID.
|
|
9334
|
+
* @type {string}
|
|
9335
|
+
* @memberof FileCollectionsApiListFileCollectionFiles
|
|
9336
|
+
*/
|
|
9337
|
+
readonly id: string;
|
|
9338
|
+
/**
|
|
9339
|
+
* The cursor for the next page of items.
|
|
9340
|
+
* @type {string}
|
|
9341
|
+
* @memberof FileCollectionsApiListFileCollectionFiles
|
|
9342
|
+
*/
|
|
9343
|
+
readonly pageCursor?: string;
|
|
9344
|
+
/**
|
|
9345
|
+
* The number of items to return.
|
|
9346
|
+
* @type {number}
|
|
9347
|
+
* @memberof FileCollectionsApiListFileCollectionFiles
|
|
9348
|
+
*/
|
|
9349
|
+
readonly pageSize?: number;
|
|
9350
|
+
}
|
|
9351
|
+
/**
|
|
9352
|
+
* Request parameters for listFileCollections operation in FileCollectionsApi.
|
|
9353
|
+
* @export
|
|
9354
|
+
* @interface FileCollectionsApiListFileCollectionsRequest
|
|
9355
|
+
*/
|
|
9356
|
+
export interface FileCollectionsApiListFileCollectionsRequest {
|
|
9357
|
+
/**
|
|
9358
|
+
* The cursor for the next page of items.
|
|
9359
|
+
* @type {string}
|
|
9360
|
+
* @memberof FileCollectionsApiListFileCollections
|
|
9361
|
+
*/
|
|
9362
|
+
readonly pageCursor?: string;
|
|
9363
|
+
/**
|
|
9364
|
+
* The number of items to return.
|
|
9365
|
+
* @type {number}
|
|
9366
|
+
* @memberof FileCollectionsApiListFileCollections
|
|
9367
|
+
*/
|
|
9368
|
+
readonly pageSize?: number;
|
|
9369
|
+
/**
|
|
9370
|
+
* Comma-separated list of supplied IDs to filter on.
|
|
9371
|
+
* @type {string}
|
|
9372
|
+
* @memberof FileCollectionsApiListFileCollections
|
|
9373
|
+
*/
|
|
9374
|
+
readonly filterSuppliedId?: string;
|
|
9375
|
+
}
|
|
9376
|
+
/**
|
|
9377
|
+
* Request parameters for updateFileCollection operation in FileCollectionsApi.
|
|
9378
|
+
* @export
|
|
9379
|
+
* @interface FileCollectionsApiUpdateFileCollectionRequest
|
|
9380
|
+
*/
|
|
9381
|
+
export interface FileCollectionsApiUpdateFileCollectionRequest {
|
|
9382
|
+
/**
|
|
9383
|
+
* The `file-collection` ID.
|
|
9384
|
+
* @type {string}
|
|
9385
|
+
* @memberof FileCollectionsApiUpdateFileCollection
|
|
9386
|
+
*/
|
|
9387
|
+
readonly id: string;
|
|
9388
|
+
/**
|
|
9389
|
+
*
|
|
9390
|
+
* @type {UpdateFileCollectionRequest}
|
|
9391
|
+
* @memberof FileCollectionsApiUpdateFileCollection
|
|
9392
|
+
*/
|
|
9393
|
+
readonly updateFileCollectionRequest: UpdateFileCollectionRequest;
|
|
9394
|
+
}
|
|
9395
|
+
/**
|
|
9396
|
+
* FileCollectionsApi - object-oriented interface
|
|
9397
|
+
* @export
|
|
9398
|
+
* @class FileCollectionsApi
|
|
9399
|
+
* @extends {BaseAPI}
|
|
9400
|
+
*/
|
|
9401
|
+
export declare class FileCollectionsApi extends BaseAPI {
|
|
9402
|
+
/**
|
|
9403
|
+
* Add files to a `file-collection`.
|
|
9404
|
+
* @param {FileCollectionsApiAddFileCollectionFilesRequest} requestParameters Request parameters.
|
|
9405
|
+
* @param {*} [options] Override http request option.
|
|
9406
|
+
* @throws {RequiredError}
|
|
9407
|
+
* @memberof FileCollectionsApi
|
|
9408
|
+
*/
|
|
9409
|
+
addFileCollectionFiles(requestParameters: FileCollectionsApiAddFileCollectionFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
|
|
9410
|
+
/**
|
|
9411
|
+
* Create a `file-collection`.
|
|
9412
|
+
* @param {FileCollectionsApiCreateFileCollectionRequest} requestParameters Request parameters.
|
|
9413
|
+
* @param {*} [options] Override http request option.
|
|
9414
|
+
* @throws {RequiredError}
|
|
9415
|
+
* @memberof FileCollectionsApi
|
|
9416
|
+
*/
|
|
9417
|
+
createFileCollection(requestParameters: FileCollectionsApiCreateFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
|
|
9418
|
+
/**
|
|
9419
|
+
* Delete a `file-collection`.
|
|
9420
|
+
* @param {FileCollectionsApiDeleteFileCollectionRequest} requestParameters Request parameters.
|
|
9421
|
+
* @param {*} [options] Override http request option.
|
|
9422
|
+
* @throws {RequiredError}
|
|
9423
|
+
* @memberof FileCollectionsApi
|
|
9424
|
+
*/
|
|
9425
|
+
deleteFileCollection(requestParameters: FileCollectionsApiDeleteFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9426
|
+
/**
|
|
9427
|
+
* Get a `file-collection` by ID.
|
|
9428
|
+
* @param {FileCollectionsApiGetFileCollectionRequest} requestParameters Request parameters.
|
|
9429
|
+
* @param {*} [options] Override http request option.
|
|
9430
|
+
* @throws {RequiredError}
|
|
9431
|
+
* @memberof FileCollectionsApi
|
|
9432
|
+
*/
|
|
9433
|
+
getFileCollection(requestParameters: FileCollectionsApiGetFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
|
|
9434
|
+
/**
|
|
9435
|
+
* List the files in a `file-collection`.
|
|
9436
|
+
* @param {FileCollectionsApiListFileCollectionFilesRequest} requestParameters Request parameters.
|
|
9437
|
+
* @param {*} [options] Override http request option.
|
|
9438
|
+
* @throws {RequiredError}
|
|
9439
|
+
* @memberof FileCollectionsApi
|
|
9440
|
+
*/
|
|
9441
|
+
listFileCollectionFiles(requestParameters: FileCollectionsApiListFileCollectionFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileList, any>>;
|
|
9442
|
+
/**
|
|
9443
|
+
* List `file-collection`s by supplied ID.
|
|
9444
|
+
* @param {FileCollectionsApiListFileCollectionsRequest} requestParameters Request parameters.
|
|
9445
|
+
* @param {*} [options] Override http request option.
|
|
9446
|
+
* @throws {RequiredError}
|
|
9447
|
+
* @memberof FileCollectionsApi
|
|
9448
|
+
*/
|
|
9449
|
+
listFileCollections(requestParameters?: FileCollectionsApiListFileCollectionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionList, any>>;
|
|
9450
|
+
/**
|
|
9451
|
+
* Update a `file-collection`.
|
|
9452
|
+
* @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
|
|
9453
|
+
* @param {*} [options] Override http request option.
|
|
9454
|
+
* @throws {RequiredError}
|
|
9455
|
+
* @memberof FileCollectionsApi
|
|
9456
|
+
*/
|
|
9457
|
+
updateFileCollection(requestParameters: FileCollectionsApiUpdateFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9458
|
+
}
|
|
8629
9459
|
/**
|
|
8630
9460
|
* FilesApi - axios parameter creator
|
|
8631
9461
|
* @export
|
|
8632
9462
|
*/
|
|
8633
9463
|
export declare const FilesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9464
|
+
/**
|
|
9465
|
+
* Create a download uri for a `file` by ID.
|
|
9466
|
+
* @param {string} id The `file` ID.
|
|
9467
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
9468
|
+
* @param {*} [options] Override http request option.
|
|
9469
|
+
* @throws {RequiredError}
|
|
9470
|
+
*/
|
|
9471
|
+
createDownloadUrl: (id: string, createDownloadRequest: CreateDownloadRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8634
9472
|
/**
|
|
8635
9473
|
* Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
|
|
8636
9474
|
* @param {CreateFileRequest} createFileRequest
|
|
@@ -8683,6 +9521,14 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration |
|
|
|
8683
9521
|
* @export
|
|
8684
9522
|
*/
|
|
8685
9523
|
export declare const FilesApiFp: (configuration?: Configuration | undefined) => {
|
|
9524
|
+
/**
|
|
9525
|
+
* Create a download uri for a `file` by ID.
|
|
9526
|
+
* @param {string} id The `file` ID.
|
|
9527
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
9528
|
+
* @param {*} [options] Override http request option.
|
|
9529
|
+
* @throws {RequiredError}
|
|
9530
|
+
*/
|
|
9531
|
+
createDownloadUrl(id: string, createDownloadRequest: CreateDownloadRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<DownloadUrl>>;
|
|
8686
9532
|
/**
|
|
8687
9533
|
* Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
|
|
8688
9534
|
* @param {CreateFileRequest} createFileRequest
|
|
@@ -8735,6 +9581,14 @@ export declare const FilesApiFp: (configuration?: Configuration | undefined) =>
|
|
|
8735
9581
|
* @export
|
|
8736
9582
|
*/
|
|
8737
9583
|
export declare const FilesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9584
|
+
/**
|
|
9585
|
+
* Create a download uri for a `file` by ID.
|
|
9586
|
+
* @param {string} id The `file` ID.
|
|
9587
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
9588
|
+
* @param {*} [options] Override http request option.
|
|
9589
|
+
* @throws {RequiredError}
|
|
9590
|
+
*/
|
|
9591
|
+
createDownloadUrl(id: string, createDownloadRequest: CreateDownloadRequest, options?: any): AxiosPromise<DownloadUrl>;
|
|
8738
9592
|
/**
|
|
8739
9593
|
* Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
|
|
8740
9594
|
* @param {CreateFileRequest} createFileRequest
|
|
@@ -8782,6 +9636,25 @@ export declare const FilesApiFactory: (configuration?: Configuration | undefined
|
|
|
8782
9636
|
*/
|
|
8783
9637
|
uploadFile(id: string, body: any, options?: any): AxiosPromise<void>;
|
|
8784
9638
|
};
|
|
9639
|
+
/**
|
|
9640
|
+
* Request parameters for createDownloadUrl operation in FilesApi.
|
|
9641
|
+
* @export
|
|
9642
|
+
* @interface FilesApiCreateDownloadUrlRequest
|
|
9643
|
+
*/
|
|
9644
|
+
export interface FilesApiCreateDownloadUrlRequest {
|
|
9645
|
+
/**
|
|
9646
|
+
* The `file` ID.
|
|
9647
|
+
* @type {string}
|
|
9648
|
+
* @memberof FilesApiCreateDownloadUrl
|
|
9649
|
+
*/
|
|
9650
|
+
readonly id: string;
|
|
9651
|
+
/**
|
|
9652
|
+
*
|
|
9653
|
+
* @type {CreateDownloadRequest}
|
|
9654
|
+
* @memberof FilesApiCreateDownloadUrl
|
|
9655
|
+
*/
|
|
9656
|
+
readonly createDownloadRequest: CreateDownloadRequest;
|
|
9657
|
+
}
|
|
8785
9658
|
/**
|
|
8786
9659
|
* Request parameters for createFile operation in FilesApi.
|
|
8787
9660
|
* @export
|
|
@@ -8891,6 +9764,14 @@ export interface FilesApiUploadFileRequest {
|
|
|
8891
9764
|
* @extends {BaseAPI}
|
|
8892
9765
|
*/
|
|
8893
9766
|
export declare class FilesApi extends BaseAPI {
|
|
9767
|
+
/**
|
|
9768
|
+
* Create a download uri for a `file` by ID.
|
|
9769
|
+
* @param {FilesApiCreateDownloadUrlRequest} requestParameters Request parameters.
|
|
9770
|
+
* @param {*} [options] Override http request option.
|
|
9771
|
+
* @throws {RequiredError}
|
|
9772
|
+
* @memberof FilesApi
|
|
9773
|
+
*/
|
|
9774
|
+
createDownloadUrl(requestParameters: FilesApiCreateDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadUrl, any>>;
|
|
8894
9775
|
/**
|
|
8895
9776
|
* Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
|
|
8896
9777
|
* @param {FilesApiCreateFileRequest} requestParameters Request parameters.
|