@vertexvis/api-client-node 0.24.0 → 0.30.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 +1308 -111
- package/dist/cjs/api.js +1030 -142
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +1308 -111
- package/dist/esm/api.js +1015 -136
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +3 -2
package/dist/cjs/api.d.ts
CHANGED
|
@@ -433,6 +433,25 @@ export interface ApplicationList {
|
|
|
433
433
|
[key: string]: Link;
|
|
434
434
|
};
|
|
435
435
|
}
|
|
436
|
+
/**
|
|
437
|
+
* Represents a file and directory within an archive.
|
|
438
|
+
* @export
|
|
439
|
+
* @interface ArchiveManifestEntry
|
|
440
|
+
*/
|
|
441
|
+
export interface ArchiveManifestEntry {
|
|
442
|
+
/**
|
|
443
|
+
* Represents a query to select a file.
|
|
444
|
+
* @type {SelectFileById | SelectFileBySuppliedId}
|
|
445
|
+
* @memberof ArchiveManifestEntry
|
|
446
|
+
*/
|
|
447
|
+
selector: SelectFileById | SelectFileBySuppliedId;
|
|
448
|
+
/**
|
|
449
|
+
* The directory in the archive where the file will be placed.
|
|
450
|
+
* @type {string}
|
|
451
|
+
* @memberof ArchiveManifestEntry
|
|
452
|
+
*/
|
|
453
|
+
directory?: string;
|
|
454
|
+
}
|
|
436
455
|
/**
|
|
437
456
|
*
|
|
438
457
|
* @export
|
|
@@ -861,6 +880,51 @@ export interface CreateBatchRequest {
|
|
|
861
880
|
*/
|
|
862
881
|
'vertexvis/batch:operations': Array<BatchOperation>;
|
|
863
882
|
}
|
|
883
|
+
/**
|
|
884
|
+
*
|
|
885
|
+
* @export
|
|
886
|
+
* @interface CreateDownloadRequest
|
|
887
|
+
*/
|
|
888
|
+
export interface CreateDownloadRequest {
|
|
889
|
+
/**
|
|
890
|
+
*
|
|
891
|
+
* @type {CreateDownloadRequestData}
|
|
892
|
+
* @memberof CreateDownloadRequest
|
|
893
|
+
*/
|
|
894
|
+
data: CreateDownloadRequestData;
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
*
|
|
898
|
+
* @export
|
|
899
|
+
* @interface CreateDownloadRequestData
|
|
900
|
+
*/
|
|
901
|
+
export interface CreateDownloadRequestData {
|
|
902
|
+
/**
|
|
903
|
+
* Resource object type.
|
|
904
|
+
* @type {string}
|
|
905
|
+
* @memberof CreateDownloadRequestData
|
|
906
|
+
*/
|
|
907
|
+
type: string;
|
|
908
|
+
/**
|
|
909
|
+
*
|
|
910
|
+
* @type {CreateDownloadRequestDataAttributes}
|
|
911
|
+
* @memberof CreateDownloadRequestData
|
|
912
|
+
*/
|
|
913
|
+
attributes: CreateDownloadRequestDataAttributes;
|
|
914
|
+
}
|
|
915
|
+
/**
|
|
916
|
+
*
|
|
917
|
+
* @export
|
|
918
|
+
* @interface CreateDownloadRequestDataAttributes
|
|
919
|
+
*/
|
|
920
|
+
export interface CreateDownloadRequestDataAttributes {
|
|
921
|
+
/**
|
|
922
|
+
* 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)
|
|
923
|
+
* @type {number}
|
|
924
|
+
* @memberof CreateDownloadRequestDataAttributes
|
|
925
|
+
*/
|
|
926
|
+
expiry?: number;
|
|
927
|
+
}
|
|
864
928
|
/**
|
|
865
929
|
*
|
|
866
930
|
* @export
|
|
@@ -937,6 +1001,124 @@ export interface CreateExportRequestDataRelationships {
|
|
|
937
1001
|
*/
|
|
938
1002
|
state?: ExportStateRelationship;
|
|
939
1003
|
}
|
|
1004
|
+
/**
|
|
1005
|
+
*
|
|
1006
|
+
* @export
|
|
1007
|
+
* @interface CreateFileCollectionRequest
|
|
1008
|
+
*/
|
|
1009
|
+
export interface CreateFileCollectionRequest {
|
|
1010
|
+
/**
|
|
1011
|
+
*
|
|
1012
|
+
* @type {CreateFileCollectionRequestData}
|
|
1013
|
+
* @memberof CreateFileCollectionRequest
|
|
1014
|
+
*/
|
|
1015
|
+
data: CreateFileCollectionRequestData;
|
|
1016
|
+
}
|
|
1017
|
+
/**
|
|
1018
|
+
*
|
|
1019
|
+
* @export
|
|
1020
|
+
* @interface CreateFileCollectionRequestData
|
|
1021
|
+
*/
|
|
1022
|
+
export interface CreateFileCollectionRequestData {
|
|
1023
|
+
/**
|
|
1024
|
+
* Resource object type.
|
|
1025
|
+
* @type {string}
|
|
1026
|
+
* @memberof CreateFileCollectionRequestData
|
|
1027
|
+
*/
|
|
1028
|
+
type: CreateFileCollectionRequestDataTypeEnum;
|
|
1029
|
+
/**
|
|
1030
|
+
*
|
|
1031
|
+
* @type {CreateFileCollectionRequestDataAttributes}
|
|
1032
|
+
* @memberof CreateFileCollectionRequestData
|
|
1033
|
+
*/
|
|
1034
|
+
attributes: CreateFileCollectionRequestDataAttributes;
|
|
1035
|
+
}
|
|
1036
|
+
export declare const CreateFileCollectionRequestDataTypeEnum: {
|
|
1037
|
+
readonly FileCollection: "file-collection";
|
|
1038
|
+
};
|
|
1039
|
+
export declare type CreateFileCollectionRequestDataTypeEnum = (typeof CreateFileCollectionRequestDataTypeEnum)[keyof typeof CreateFileCollectionRequestDataTypeEnum];
|
|
1040
|
+
/**
|
|
1041
|
+
*
|
|
1042
|
+
* @export
|
|
1043
|
+
* @interface CreateFileCollectionRequestDataAttributes
|
|
1044
|
+
*/
|
|
1045
|
+
export interface CreateFileCollectionRequestDataAttributes {
|
|
1046
|
+
/**
|
|
1047
|
+
*
|
|
1048
|
+
* @type {string}
|
|
1049
|
+
* @memberof CreateFileCollectionRequestDataAttributes
|
|
1050
|
+
*/
|
|
1051
|
+
name?: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* ID provided for correlation with external systems, e.g. a PLM system.
|
|
1054
|
+
* @type {string}
|
|
1055
|
+
* @memberof CreateFileCollectionRequestDataAttributes
|
|
1056
|
+
*/
|
|
1057
|
+
suppliedId?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Number of seconds before expiration
|
|
1060
|
+
* @type {number}
|
|
1061
|
+
* @memberof CreateFileCollectionRequestDataAttributes
|
|
1062
|
+
*/
|
|
1063
|
+
expiry?: number;
|
|
1064
|
+
/**
|
|
1065
|
+
* 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.
|
|
1066
|
+
* @type {{ [key: string]: string; }}
|
|
1067
|
+
* @memberof CreateFileCollectionRequestDataAttributes
|
|
1068
|
+
*/
|
|
1069
|
+
metadata?: {
|
|
1070
|
+
[key: string]: string;
|
|
1071
|
+
};
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
*
|
|
1075
|
+
* @export
|
|
1076
|
+
* @interface CreateFileJobRequest
|
|
1077
|
+
*/
|
|
1078
|
+
export interface CreateFileJobRequest {
|
|
1079
|
+
/**
|
|
1080
|
+
*
|
|
1081
|
+
* @type {CreateFileJobRequestData}
|
|
1082
|
+
* @memberof CreateFileJobRequest
|
|
1083
|
+
*/
|
|
1084
|
+
data: CreateFileJobRequestData;
|
|
1085
|
+
}
|
|
1086
|
+
/**
|
|
1087
|
+
*
|
|
1088
|
+
* @export
|
|
1089
|
+
* @interface CreateFileJobRequestData
|
|
1090
|
+
*/
|
|
1091
|
+
export interface CreateFileJobRequestData {
|
|
1092
|
+
/**
|
|
1093
|
+
* Resource object type.
|
|
1094
|
+
* @type {string}
|
|
1095
|
+
* @memberof CreateFileJobRequestData
|
|
1096
|
+
*/
|
|
1097
|
+
type: CreateFileJobRequestDataTypeEnum;
|
|
1098
|
+
/**
|
|
1099
|
+
*
|
|
1100
|
+
* @type {CreateFileJobRequestDataAttributes}
|
|
1101
|
+
* @memberof CreateFileJobRequestData
|
|
1102
|
+
*/
|
|
1103
|
+
attributes: CreateFileJobRequestDataAttributes;
|
|
1104
|
+
}
|
|
1105
|
+
export declare const CreateFileJobRequestDataTypeEnum: {
|
|
1106
|
+
readonly FileJob: "file-job";
|
|
1107
|
+
};
|
|
1108
|
+
export declare type CreateFileJobRequestDataTypeEnum = (typeof CreateFileJobRequestDataTypeEnum)[keyof typeof CreateFileJobRequestDataTypeEnum];
|
|
1109
|
+
/**
|
|
1110
|
+
*
|
|
1111
|
+
* @export
|
|
1112
|
+
* @interface CreateFileJobRequestDataAttributes
|
|
1113
|
+
*/
|
|
1114
|
+
export interface CreateFileJobRequestDataAttributes {
|
|
1115
|
+
/**
|
|
1116
|
+
* An object that describes the operation a file job will perform.
|
|
1117
|
+
* @type {FileJobArchiveOperation}
|
|
1118
|
+
* @memberof CreateFileJobRequestDataAttributes
|
|
1119
|
+
*/
|
|
1120
|
+
operation: FileJobArchiveOperation;
|
|
1121
|
+
}
|
|
940
1122
|
/**
|
|
941
1123
|
*
|
|
942
1124
|
* @export
|
|
@@ -999,6 +1181,14 @@ export interface CreateFileRequestDataAttributes {
|
|
|
999
1181
|
* @memberof CreateFileRequestDataAttributes
|
|
1000
1182
|
*/
|
|
1001
1183
|
expiry?: number;
|
|
1184
|
+
/**
|
|
1185
|
+
* 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.
|
|
1186
|
+
* @type {{ [key: string]: string; }}
|
|
1187
|
+
* @memberof CreateFileRequestDataAttributes
|
|
1188
|
+
*/
|
|
1189
|
+
metadata?: {
|
|
1190
|
+
[key: string]: string;
|
|
1191
|
+
};
|
|
1002
1192
|
}
|
|
1003
1193
|
/**
|
|
1004
1194
|
*
|
|
@@ -1228,9 +1418,10 @@ export interface CreatePartRequestDataAttributes {
|
|
|
1228
1418
|
*/
|
|
1229
1419
|
indexMetadata?: boolean;
|
|
1230
1420
|
/**
|
|
1231
|
-
* Additional metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
|
|
1421
|
+
* Additional metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified. This has been deprecated and replaced by the PATCH endpoint /property-entries
|
|
1232
1422
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
1233
1423
|
* @memberof CreatePartRequestDataAttributes
|
|
1424
|
+
* @deprecated
|
|
1234
1425
|
*/
|
|
1235
1426
|
metadata?: {
|
|
1236
1427
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -1583,7 +1774,7 @@ export interface CreateSceneItemRequestDataAttributes {
|
|
|
1583
1774
|
*/
|
|
1584
1775
|
ordinal?: number;
|
|
1585
1776
|
/**
|
|
1586
|
-
* Optional ability to specify a parent scene item by scene item supplied ID. For example, an
|
|
1777
|
+
* Optional ability to specify a parent scene item by scene item supplied ID. For example, an existing ID from a PLM system. This approach is an alternative to providing a specific scene item ID with the relationship parent property.
|
|
1587
1778
|
* @type {string}
|
|
1588
1779
|
* @memberof CreateSceneItemRequestDataAttributes
|
|
1589
1780
|
*/
|
|
@@ -1594,6 +1785,12 @@ export interface CreateSceneItemRequestDataAttributes {
|
|
|
1594
1785
|
* @memberof CreateSceneItemRequestDataAttributes
|
|
1595
1786
|
*/
|
|
1596
1787
|
partInstanceSuppliedIdsAsSuppliedIds?: boolean;
|
|
1788
|
+
/**
|
|
1789
|
+
* Optional rule to guide the part-revision resolution algorithm in cases where required qualifiers are not explicitly specified by the query. In the case of assembly parts, the resolution rule also applies recursively to the resolution of the child parts. \'as-specified\' (the default) directs the resolution algorithm to use only the ids specified in this query. An incomplete specification will result in an error. \'latest-iteration\' directs the resolution algorithm to select, within the scope of the specified part-revision, the iteration possessing the newest creation timestamp. Any iteration identifiers specified by this query are ignored. Failure to specify a part-revision will result in an error. \'latest-revision\' directs the resolution algorithm to select the part-revision possessing the newest creation timestamp. \'latest-revision\' implies \'latest-iteration\' resolution logic.
|
|
1790
|
+
* @type {string}
|
|
1791
|
+
* @memberof CreateSceneItemRequestDataAttributes
|
|
1792
|
+
*/
|
|
1793
|
+
resolutionRule?: CreateSceneItemRequestDataAttributesResolutionRuleEnum;
|
|
1597
1794
|
/**
|
|
1598
1795
|
*
|
|
1599
1796
|
* @type {PartRevisionSuppliedId}
|
|
@@ -1631,20 +1828,27 @@ export interface CreateSceneItemRequestDataAttributes {
|
|
|
1631
1828
|
*/
|
|
1632
1829
|
endItem?: boolean;
|
|
1633
1830
|
/**
|
|
1634
|
-
* Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
|
|
1831
|
+
* Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file. This has been deprecated and replaced by the PATCH endpoint /property-entries.
|
|
1635
1832
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
1636
1833
|
* @memberof CreateSceneItemRequestDataAttributes
|
|
1834
|
+
* @deprecated
|
|
1637
1835
|
*/
|
|
1638
1836
|
metadata?: {
|
|
1639
1837
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
1640
1838
|
};
|
|
1641
1839
|
/**
|
|
1642
|
-
* Specifies which metadata keys should be copied from the source item. Sending null will
|
|
1840
|
+
* Specifies which metadata keys should be copied from the source item. Sending null will default to all keys. Sending an empty string will copy none of the sources\' metadata. Sending an array of [\"KEY1\", \"KEY2] will include KEY1 and KEY2 from the source in the scene item creation. This is marked experimental since future releases are expected to prevent copying metadata entirely.
|
|
1643
1841
|
* @type {Array<string>}
|
|
1644
1842
|
* @memberof CreateSceneItemRequestDataAttributes
|
|
1645
1843
|
*/
|
|
1646
1844
|
experimentalSourceMetadataKeys?: Array<string>;
|
|
1647
1845
|
}
|
|
1846
|
+
export declare const CreateSceneItemRequestDataAttributesResolutionRuleEnum: {
|
|
1847
|
+
readonly AsSpecified: "as-specified";
|
|
1848
|
+
readonly LatestIteration: "latest-iteration";
|
|
1849
|
+
readonly LatestRevision: "latest-revision";
|
|
1850
|
+
};
|
|
1851
|
+
export declare type CreateSceneItemRequestDataAttributesResolutionRuleEnum = (typeof CreateSceneItemRequestDataAttributesResolutionRuleEnum)[keyof typeof CreateSceneItemRequestDataAttributesResolutionRuleEnum];
|
|
1648
1852
|
/**
|
|
1649
1853
|
*
|
|
1650
1854
|
* @export
|
|
@@ -1752,6 +1956,12 @@ export interface CreateSceneRequestDataAttributes {
|
|
|
1752
1956
|
metadata?: {
|
|
1753
1957
|
[key: string]: string;
|
|
1754
1958
|
};
|
|
1959
|
+
/**
|
|
1960
|
+
* Number of seconds before expiration
|
|
1961
|
+
* @type {number}
|
|
1962
|
+
* @memberof CreateSceneRequestDataAttributes
|
|
1963
|
+
*/
|
|
1964
|
+
expiry?: number;
|
|
1755
1965
|
}
|
|
1756
1966
|
/**
|
|
1757
1967
|
*
|
|
@@ -1988,7 +2198,7 @@ export interface CreateStreamKeyRequestDataAttributes {
|
|
|
1988
2198
|
*/
|
|
1989
2199
|
sceneViewStateId?: string;
|
|
1990
2200
|
/**
|
|
1991
|
-
* Optionally enables or disables the creation of a search session for the view.
|
|
2201
|
+
* Optionally enables or disables the creation of a search session for the view. The default creates a session for the scene-view
|
|
1992
2202
|
* @type {boolean}
|
|
1993
2203
|
* @memberof CreateStreamKeyRequestDataAttributes
|
|
1994
2204
|
*/
|
|
@@ -2207,6 +2417,73 @@ export interface Dimensions {
|
|
|
2207
2417
|
*/
|
|
2208
2418
|
width: number;
|
|
2209
2419
|
}
|
|
2420
|
+
/**
|
|
2421
|
+
*
|
|
2422
|
+
* @export
|
|
2423
|
+
* @interface DownloadUrl
|
|
2424
|
+
*/
|
|
2425
|
+
export interface DownloadUrl {
|
|
2426
|
+
/**
|
|
2427
|
+
*
|
|
2428
|
+
* @type {DownloadUrlData}
|
|
2429
|
+
* @memberof DownloadUrl
|
|
2430
|
+
*/
|
|
2431
|
+
data: DownloadUrlData;
|
|
2432
|
+
/**
|
|
2433
|
+
*
|
|
2434
|
+
* @type {{ [key: string]: Link; }}
|
|
2435
|
+
* @memberof DownloadUrl
|
|
2436
|
+
*/
|
|
2437
|
+
links?: {
|
|
2438
|
+
[key: string]: Link;
|
|
2439
|
+
};
|
|
2440
|
+
}
|
|
2441
|
+
/**
|
|
2442
|
+
*
|
|
2443
|
+
* @export
|
|
2444
|
+
* @interface DownloadUrlData
|
|
2445
|
+
*/
|
|
2446
|
+
export interface DownloadUrlData {
|
|
2447
|
+
/**
|
|
2448
|
+
*
|
|
2449
|
+
* @type {string}
|
|
2450
|
+
* @memberof DownloadUrlData
|
|
2451
|
+
*/
|
|
2452
|
+
type: string;
|
|
2453
|
+
/**
|
|
2454
|
+
* ID of the resource.
|
|
2455
|
+
* @type {string}
|
|
2456
|
+
* @memberof DownloadUrlData
|
|
2457
|
+
*/
|
|
2458
|
+
id: string;
|
|
2459
|
+
/**
|
|
2460
|
+
*
|
|
2461
|
+
* @type {DownloadUrlDataAttributes}
|
|
2462
|
+
* @memberof DownloadUrlData
|
|
2463
|
+
*/
|
|
2464
|
+
attributes: DownloadUrlDataAttributes;
|
|
2465
|
+
/**
|
|
2466
|
+
*
|
|
2467
|
+
* @type {{ [key: string]: Link; }}
|
|
2468
|
+
* @memberof DownloadUrlData
|
|
2469
|
+
*/
|
|
2470
|
+
links?: {
|
|
2471
|
+
[key: string]: Link;
|
|
2472
|
+
};
|
|
2473
|
+
}
|
|
2474
|
+
/**
|
|
2475
|
+
*
|
|
2476
|
+
* @export
|
|
2477
|
+
* @interface DownloadUrlDataAttributes
|
|
2478
|
+
*/
|
|
2479
|
+
export interface DownloadUrlDataAttributes {
|
|
2480
|
+
/**
|
|
2481
|
+
*
|
|
2482
|
+
* @type {string}
|
|
2483
|
+
* @memberof DownloadUrlDataAttributes
|
|
2484
|
+
*/
|
|
2485
|
+
downloadUrl: string;
|
|
2486
|
+
}
|
|
2210
2487
|
/**
|
|
2211
2488
|
*
|
|
2212
2489
|
* @export
|
|
@@ -2416,19 +2693,19 @@ export interface FeatureLines {
|
|
|
2416
2693
|
/**
|
|
2417
2694
|
*
|
|
2418
2695
|
* @export
|
|
2419
|
-
* @interface
|
|
2696
|
+
* @interface FileCollectionList
|
|
2420
2697
|
*/
|
|
2421
|
-
export interface
|
|
2698
|
+
export interface FileCollectionList {
|
|
2422
2699
|
/**
|
|
2423
2700
|
*
|
|
2424
|
-
* @type {Array<
|
|
2425
|
-
* @memberof
|
|
2701
|
+
* @type {Array<FileCollectionMetadataData>}
|
|
2702
|
+
* @memberof FileCollectionList
|
|
2426
2703
|
*/
|
|
2427
|
-
data: Array<
|
|
2704
|
+
data: Array<FileCollectionMetadataData>;
|
|
2428
2705
|
/**
|
|
2429
2706
|
*
|
|
2430
2707
|
* @type {{ [key: string]: Link; }}
|
|
2431
|
-
* @memberof
|
|
2708
|
+
* @memberof FileCollectionList
|
|
2432
2709
|
*/
|
|
2433
2710
|
links: {
|
|
2434
2711
|
[key: string]: Link;
|
|
@@ -2437,19 +2714,19 @@ export interface FileList {
|
|
|
2437
2714
|
/**
|
|
2438
2715
|
*
|
|
2439
2716
|
* @export
|
|
2440
|
-
* @interface
|
|
2717
|
+
* @interface FileCollectionMetadata
|
|
2441
2718
|
*/
|
|
2442
|
-
export interface
|
|
2719
|
+
export interface FileCollectionMetadata {
|
|
2443
2720
|
/**
|
|
2444
2721
|
*
|
|
2445
|
-
* @type {
|
|
2446
|
-
* @memberof
|
|
2722
|
+
* @type {FileCollectionMetadataData}
|
|
2723
|
+
* @memberof FileCollectionMetadata
|
|
2447
2724
|
*/
|
|
2448
|
-
data:
|
|
2725
|
+
data: FileCollectionMetadataData;
|
|
2449
2726
|
/**
|
|
2450
2727
|
*
|
|
2451
2728
|
* @type {{ [key: string]: Link; }}
|
|
2452
|
-
* @memberof
|
|
2729
|
+
* @memberof FileCollectionMetadata
|
|
2453
2730
|
*/
|
|
2454
2731
|
links?: {
|
|
2455
2732
|
[key: string]: Link;
|
|
@@ -2458,118 +2735,280 @@ export interface FileMetadata {
|
|
|
2458
2735
|
/**
|
|
2459
2736
|
*
|
|
2460
2737
|
* @export
|
|
2461
|
-
* @interface
|
|
2738
|
+
* @interface FileCollectionMetadataData
|
|
2462
2739
|
*/
|
|
2463
|
-
export interface
|
|
2740
|
+
export interface FileCollectionMetadataData {
|
|
2464
2741
|
/**
|
|
2465
2742
|
*
|
|
2466
2743
|
* @type {string}
|
|
2467
|
-
* @memberof
|
|
2744
|
+
* @memberof FileCollectionMetadataData
|
|
2468
2745
|
*/
|
|
2469
|
-
type:
|
|
2746
|
+
type: FileCollectionMetadataDataTypeEnum;
|
|
2470
2747
|
/**
|
|
2471
2748
|
* ID of the resource.
|
|
2472
2749
|
* @type {string}
|
|
2473
|
-
* @memberof
|
|
2750
|
+
* @memberof FileCollectionMetadataData
|
|
2474
2751
|
*/
|
|
2475
2752
|
id: string;
|
|
2476
2753
|
/**
|
|
2477
2754
|
*
|
|
2478
|
-
* @type {
|
|
2479
|
-
* @memberof
|
|
2755
|
+
* @type {FileCollectionMetadataDataAttributes}
|
|
2756
|
+
* @memberof FileCollectionMetadataData
|
|
2480
2757
|
*/
|
|
2481
|
-
attributes:
|
|
2758
|
+
attributes: FileCollectionMetadataDataAttributes;
|
|
2482
2759
|
/**
|
|
2483
2760
|
*
|
|
2484
2761
|
* @type {{ [key: string]: Link; }}
|
|
2485
|
-
* @memberof
|
|
2762
|
+
* @memberof FileCollectionMetadataData
|
|
2486
2763
|
*/
|
|
2487
2764
|
links?: {
|
|
2488
2765
|
[key: string]: Link;
|
|
2489
2766
|
};
|
|
2490
2767
|
}
|
|
2768
|
+
export declare const FileCollectionMetadataDataTypeEnum: {
|
|
2769
|
+
readonly FileCollection: "file-collection";
|
|
2770
|
+
};
|
|
2771
|
+
export declare type FileCollectionMetadataDataTypeEnum = (typeof FileCollectionMetadataDataTypeEnum)[keyof typeof FileCollectionMetadataDataTypeEnum];
|
|
2491
2772
|
/**
|
|
2492
2773
|
*
|
|
2493
2774
|
* @export
|
|
2494
|
-
* @interface
|
|
2775
|
+
* @interface FileCollectionMetadataDataAttributes
|
|
2495
2776
|
*/
|
|
2496
|
-
export interface
|
|
2497
|
-
/**
|
|
2498
|
-
*
|
|
2499
|
-
* @type {string}
|
|
2500
|
-
* @memberof FileMetadataDataAttributes
|
|
2501
|
-
*/
|
|
2502
|
-
name: string;
|
|
2777
|
+
export interface FileCollectionMetadataDataAttributes {
|
|
2503
2778
|
/**
|
|
2504
2779
|
*
|
|
2505
2780
|
* @type {string}
|
|
2506
|
-
* @memberof
|
|
2781
|
+
* @memberof FileCollectionMetadataDataAttributes
|
|
2507
2782
|
*/
|
|
2508
|
-
|
|
2783
|
+
name?: string;
|
|
2509
2784
|
/**
|
|
2510
|
-
*
|
|
2785
|
+
* ID provided for correlation with external systems, e.g. a PLM system.
|
|
2511
2786
|
* @type {string}
|
|
2512
|
-
* @memberof
|
|
2787
|
+
* @memberof FileCollectionMetadataDataAttributes
|
|
2513
2788
|
*/
|
|
2514
2789
|
suppliedId?: string;
|
|
2515
2790
|
/**
|
|
2516
2791
|
*
|
|
2517
2792
|
* @type {string}
|
|
2518
|
-
* @memberof
|
|
2519
|
-
*/
|
|
2520
|
-
rootFileName?: string;
|
|
2521
|
-
/**
|
|
2522
|
-
*
|
|
2523
|
-
* @type {string}
|
|
2524
|
-
* @memberof FileMetadataDataAttributes
|
|
2793
|
+
* @memberof FileCollectionMetadataDataAttributes
|
|
2525
2794
|
*/
|
|
2526
2795
|
created: string;
|
|
2527
2796
|
/**
|
|
2528
2797
|
*
|
|
2529
|
-
* @type {string}
|
|
2530
|
-
* @memberof
|
|
2531
|
-
*/
|
|
2532
|
-
uploaded?: string;
|
|
2533
|
-
/**
|
|
2534
|
-
*
|
|
2535
|
-
* @type {number}
|
|
2536
|
-
* @memberof FileMetadataDataAttributes
|
|
2798
|
+
* @type {{ [key: string]: string; }}
|
|
2799
|
+
* @memberof FileCollectionMetadataDataAttributes
|
|
2537
2800
|
*/
|
|
2538
|
-
|
|
2801
|
+
metadata?: {
|
|
2802
|
+
[key: string]: string;
|
|
2803
|
+
};
|
|
2539
2804
|
}
|
|
2540
2805
|
/**
|
|
2541
|
-
*
|
|
2806
|
+
*
|
|
2542
2807
|
* @export
|
|
2543
|
-
* @interface
|
|
2808
|
+
* @interface FileIdList
|
|
2544
2809
|
*/
|
|
2545
|
-
export interface
|
|
2810
|
+
export interface FileIdList {
|
|
2546
2811
|
/**
|
|
2547
2812
|
*
|
|
2548
|
-
* @type {
|
|
2549
|
-
* @memberof
|
|
2813
|
+
* @type {Array<string>}
|
|
2814
|
+
* @memberof FileIdList
|
|
2550
2815
|
*/
|
|
2551
|
-
data:
|
|
2816
|
+
data: Array<string>;
|
|
2552
2817
|
}
|
|
2553
2818
|
/**
|
|
2554
|
-
*
|
|
2819
|
+
* The operation for a file archival job.
|
|
2555
2820
|
* @export
|
|
2556
|
-
* @interface
|
|
2821
|
+
* @interface FileJobArchiveOperation
|
|
2557
2822
|
*/
|
|
2558
|
-
export interface
|
|
2823
|
+
export interface FileJobArchiveOperation {
|
|
2559
2824
|
/**
|
|
2560
|
-
*
|
|
2825
|
+
*
|
|
2561
2826
|
* @type {string}
|
|
2562
|
-
* @memberof
|
|
2827
|
+
* @memberof FileJobArchiveOperation
|
|
2563
2828
|
*/
|
|
2564
|
-
type:
|
|
2829
|
+
type: FileJobArchiveOperationTypeEnum;
|
|
2565
2830
|
/**
|
|
2566
2831
|
* ID of the resource.
|
|
2567
2832
|
* @type {string}
|
|
2568
|
-
* @memberof
|
|
2833
|
+
* @memberof FileJobArchiveOperation
|
|
2569
2834
|
*/
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
|
|
2835
|
+
fileId: string;
|
|
2836
|
+
/**
|
|
2837
|
+
*
|
|
2838
|
+
* @type {Array<ArchiveManifestEntry>}
|
|
2839
|
+
* @memberof FileJobArchiveOperation
|
|
2840
|
+
*/
|
|
2841
|
+
manifest: Array<ArchiveManifestEntry>;
|
|
2842
|
+
}
|
|
2843
|
+
export declare const FileJobArchiveOperationTypeEnum: {
|
|
2844
|
+
readonly FileArchiveOperation: "file-archive-operation";
|
|
2845
|
+
};
|
|
2846
|
+
export declare type FileJobArchiveOperationTypeEnum = (typeof FileJobArchiveOperationTypeEnum)[keyof typeof FileJobArchiveOperationTypeEnum];
|
|
2847
|
+
/**
|
|
2848
|
+
*
|
|
2849
|
+
* @export
|
|
2850
|
+
* @interface FileList
|
|
2851
|
+
*/
|
|
2852
|
+
export interface FileList {
|
|
2853
|
+
/**
|
|
2854
|
+
*
|
|
2855
|
+
* @type {Array<FileMetadataData>}
|
|
2856
|
+
* @memberof FileList
|
|
2857
|
+
*/
|
|
2858
|
+
data: Array<FileMetadataData>;
|
|
2859
|
+
/**
|
|
2860
|
+
*
|
|
2861
|
+
* @type {{ [key: string]: Link; }}
|
|
2862
|
+
* @memberof FileList
|
|
2863
|
+
*/
|
|
2864
|
+
links: {
|
|
2865
|
+
[key: string]: Link;
|
|
2866
|
+
};
|
|
2867
|
+
}
|
|
2868
|
+
/**
|
|
2869
|
+
*
|
|
2870
|
+
* @export
|
|
2871
|
+
* @interface FileMetadata
|
|
2872
|
+
*/
|
|
2873
|
+
export interface FileMetadata {
|
|
2874
|
+
/**
|
|
2875
|
+
*
|
|
2876
|
+
* @type {FileMetadataData}
|
|
2877
|
+
* @memberof FileMetadata
|
|
2878
|
+
*/
|
|
2879
|
+
data: FileMetadataData;
|
|
2880
|
+
/**
|
|
2881
|
+
*
|
|
2882
|
+
* @type {{ [key: string]: Link; }}
|
|
2883
|
+
* @memberof FileMetadata
|
|
2884
|
+
*/
|
|
2885
|
+
links?: {
|
|
2886
|
+
[key: string]: Link;
|
|
2887
|
+
};
|
|
2888
|
+
}
|
|
2889
|
+
/**
|
|
2890
|
+
*
|
|
2891
|
+
* @export
|
|
2892
|
+
* @interface FileMetadataData
|
|
2893
|
+
*/
|
|
2894
|
+
export interface FileMetadataData {
|
|
2895
|
+
/**
|
|
2896
|
+
*
|
|
2897
|
+
* @type {string}
|
|
2898
|
+
* @memberof FileMetadataData
|
|
2899
|
+
*/
|
|
2900
|
+
type: string;
|
|
2901
|
+
/**
|
|
2902
|
+
* ID of the resource.
|
|
2903
|
+
* @type {string}
|
|
2904
|
+
* @memberof FileMetadataData
|
|
2905
|
+
*/
|
|
2906
|
+
id: string;
|
|
2907
|
+
/**
|
|
2908
|
+
*
|
|
2909
|
+
* @type {FileMetadataDataAttributes}
|
|
2910
|
+
* @memberof FileMetadataData
|
|
2911
|
+
*/
|
|
2912
|
+
attributes: FileMetadataDataAttributes;
|
|
2913
|
+
/**
|
|
2914
|
+
*
|
|
2915
|
+
* @type {{ [key: string]: Link; }}
|
|
2916
|
+
* @memberof FileMetadataData
|
|
2917
|
+
*/
|
|
2918
|
+
links?: {
|
|
2919
|
+
[key: string]: Link;
|
|
2920
|
+
};
|
|
2921
|
+
}
|
|
2922
|
+
/**
|
|
2923
|
+
*
|
|
2924
|
+
* @export
|
|
2925
|
+
* @interface FileMetadataDataAttributes
|
|
2926
|
+
*/
|
|
2927
|
+
export interface FileMetadataDataAttributes {
|
|
2928
|
+
/**
|
|
2929
|
+
*
|
|
2930
|
+
* @type {string}
|
|
2931
|
+
* @memberof FileMetadataDataAttributes
|
|
2932
|
+
*/
|
|
2933
|
+
name: string;
|
|
2934
|
+
/**
|
|
2935
|
+
*
|
|
2936
|
+
* @type {string}
|
|
2937
|
+
* @memberof FileMetadataDataAttributes
|
|
2938
|
+
*/
|
|
2939
|
+
status: string;
|
|
2940
|
+
/**
|
|
2941
|
+
*
|
|
2942
|
+
* @type {string}
|
|
2943
|
+
* @memberof FileMetadataDataAttributes
|
|
2944
|
+
*/
|
|
2945
|
+
suppliedId?: string;
|
|
2946
|
+
/**
|
|
2947
|
+
*
|
|
2948
|
+
* @type {string}
|
|
2949
|
+
* @memberof FileMetadataDataAttributes
|
|
2950
|
+
*/
|
|
2951
|
+
rootFileName?: string;
|
|
2952
|
+
/**
|
|
2953
|
+
*
|
|
2954
|
+
* @type {string}
|
|
2955
|
+
* @memberof FileMetadataDataAttributes
|
|
2956
|
+
*/
|
|
2957
|
+
created: string;
|
|
2958
|
+
/**
|
|
2959
|
+
*
|
|
2960
|
+
* @type {string}
|
|
2961
|
+
* @memberof FileMetadataDataAttributes
|
|
2962
|
+
*/
|
|
2963
|
+
uploaded?: string;
|
|
2964
|
+
/**
|
|
2965
|
+
*
|
|
2966
|
+
* @type {number}
|
|
2967
|
+
* @memberof FileMetadataDataAttributes
|
|
2968
|
+
*/
|
|
2969
|
+
size?: number;
|
|
2970
|
+
/**
|
|
2971
|
+
*
|
|
2972
|
+
* @type {{ [key: string]: string; }}
|
|
2973
|
+
* @memberof FileMetadataDataAttributes
|
|
2974
|
+
*/
|
|
2975
|
+
metadata?: {
|
|
2976
|
+
[key: string]: string;
|
|
2977
|
+
};
|
|
2978
|
+
}
|
|
2979
|
+
/**
|
|
2980
|
+
* Relationship to a `file`.
|
|
2981
|
+
* @export
|
|
2982
|
+
* @interface FileRelationship
|
|
2983
|
+
*/
|
|
2984
|
+
export interface FileRelationship {
|
|
2985
|
+
/**
|
|
2986
|
+
*
|
|
2987
|
+
* @type {FileRelationshipData}
|
|
2988
|
+
* @memberof FileRelationship
|
|
2989
|
+
*/
|
|
2990
|
+
data: FileRelationshipData;
|
|
2991
|
+
}
|
|
2992
|
+
/**
|
|
2993
|
+
*
|
|
2994
|
+
* @export
|
|
2995
|
+
* @interface FileRelationshipData
|
|
2996
|
+
*/
|
|
2997
|
+
export interface FileRelationshipData {
|
|
2998
|
+
/**
|
|
2999
|
+
* Resource object type.
|
|
3000
|
+
* @type {string}
|
|
3001
|
+
* @memberof FileRelationshipData
|
|
3002
|
+
*/
|
|
3003
|
+
type: FileRelationshipDataTypeEnum;
|
|
3004
|
+
/**
|
|
3005
|
+
* ID of the resource.
|
|
3006
|
+
* @type {string}
|
|
3007
|
+
* @memberof FileRelationshipData
|
|
3008
|
+
*/
|
|
3009
|
+
id: string;
|
|
3010
|
+
}
|
|
3011
|
+
export declare const FileRelationshipDataTypeEnum: {
|
|
2573
3012
|
readonly File: "file";
|
|
2574
3013
|
};
|
|
2575
3014
|
export declare type FileRelationshipDataTypeEnum = (typeof FileRelationshipDataTypeEnum)[keyof typeof FileRelationshipDataTypeEnum];
|
|
@@ -3310,9 +3749,10 @@ export interface PartAssemblyRelationshipData {
|
|
|
3310
3749
|
*/
|
|
3311
3750
|
children: Array<PartRevisionInstance>;
|
|
3312
3751
|
/**
|
|
3313
|
-
* Additional metadata about the `part` and/or `part-revision`.
|
|
3752
|
+
* Additional metadata about the `part` and/or `part-revision`. This has been deprecated and replaced by the PATCH endpoint /property-entries
|
|
3314
3753
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
3315
3754
|
* @memberof PartAssemblyRelationshipData
|
|
3755
|
+
* @deprecated
|
|
3316
3756
|
*/
|
|
3317
3757
|
metadata?: {
|
|
3318
3758
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -3732,9 +4172,10 @@ export interface PartRevisionDataAttributes {
|
|
|
3732
4172
|
*/
|
|
3733
4173
|
created?: string;
|
|
3734
4174
|
/**
|
|
3735
|
-
*
|
|
4175
|
+
* This has been deprecated and replaced by the GET endpoint /property-entries
|
|
3736
4176
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
3737
4177
|
* @memberof PartRevisionDataAttributes
|
|
4178
|
+
* @deprecated
|
|
3738
4179
|
*/
|
|
3739
4180
|
metadata?: {
|
|
3740
4181
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -4410,6 +4851,67 @@ export declare const QueryByIdDataAttributesTypeEnum: {
|
|
|
4410
4851
|
readonly SuppliedId: "suppliedId";
|
|
4411
4852
|
};
|
|
4412
4853
|
export declare type QueryByIdDataAttributesTypeEnum = (typeof QueryByIdDataAttributesTypeEnum)[keyof typeof QueryByIdDataAttributesTypeEnum];
|
|
4854
|
+
/**
|
|
4855
|
+
*
|
|
4856
|
+
* @export
|
|
4857
|
+
* @interface QueryByMetadata
|
|
4858
|
+
*/
|
|
4859
|
+
export interface QueryByMetadata {
|
|
4860
|
+
/**
|
|
4861
|
+
*
|
|
4862
|
+
* @type {QueryByMetadataData}
|
|
4863
|
+
* @memberof QueryByMetadata
|
|
4864
|
+
*/
|
|
4865
|
+
data: QueryByMetadataData;
|
|
4866
|
+
}
|
|
4867
|
+
/**
|
|
4868
|
+
*
|
|
4869
|
+
* @export
|
|
4870
|
+
* @interface QueryByMetadataData
|
|
4871
|
+
*/
|
|
4872
|
+
export interface QueryByMetadataData {
|
|
4873
|
+
/**
|
|
4874
|
+
* Resource object type.
|
|
4875
|
+
* @type {string}
|
|
4876
|
+
* @memberof QueryByMetadataData
|
|
4877
|
+
*/
|
|
4878
|
+
type: QueryByMetadataDataTypeEnum;
|
|
4879
|
+
/**
|
|
4880
|
+
*
|
|
4881
|
+
* @type {QueryByMetadataDataAttributes}
|
|
4882
|
+
* @memberof QueryByMetadataData
|
|
4883
|
+
*/
|
|
4884
|
+
attributes: QueryByMetadataDataAttributes;
|
|
4885
|
+
}
|
|
4886
|
+
export declare const QueryByMetadataDataTypeEnum: {
|
|
4887
|
+
readonly QueryByMetadata: "query-by-metadata";
|
|
4888
|
+
};
|
|
4889
|
+
export declare type QueryByMetadataDataTypeEnum = (typeof QueryByMetadataDataTypeEnum)[keyof typeof QueryByMetadataDataTypeEnum];
|
|
4890
|
+
/**
|
|
4891
|
+
*
|
|
4892
|
+
* @export
|
|
4893
|
+
* @interface QueryByMetadataDataAttributes
|
|
4894
|
+
*/
|
|
4895
|
+
export interface QueryByMetadataDataAttributes {
|
|
4896
|
+
/**
|
|
4897
|
+
*
|
|
4898
|
+
* @type {boolean}
|
|
4899
|
+
* @memberof QueryByMetadataDataAttributes
|
|
4900
|
+
*/
|
|
4901
|
+
exactMatch?: boolean;
|
|
4902
|
+
/**
|
|
4903
|
+
*
|
|
4904
|
+
* @type {string}
|
|
4905
|
+
* @memberof QueryByMetadataDataAttributes
|
|
4906
|
+
*/
|
|
4907
|
+
filter: string;
|
|
4908
|
+
/**
|
|
4909
|
+
* Query `metadata`.
|
|
4910
|
+
* @type {Array<string>}
|
|
4911
|
+
* @memberof QueryByMetadataDataAttributes
|
|
4912
|
+
*/
|
|
4913
|
+
keys: Array<string>;
|
|
4914
|
+
}
|
|
4413
4915
|
/**
|
|
4414
4916
|
*
|
|
4415
4917
|
* @export
|
|
@@ -5170,6 +5672,12 @@ export interface SceneDataAttributes {
|
|
|
5170
5672
|
* @memberof SceneDataAttributes
|
|
5171
5673
|
*/
|
|
5172
5674
|
sceneItemCount?: number;
|
|
5675
|
+
/**
|
|
5676
|
+
*
|
|
5677
|
+
* @type {string}
|
|
5678
|
+
* @memberof SceneDataAttributes
|
|
5679
|
+
*/
|
|
5680
|
+
expiresAt?: string;
|
|
5173
5681
|
/**
|
|
5174
5682
|
* User supplied key-value pairs for a scene. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters.
|
|
5175
5683
|
* @type {{ [key: string]: string; }}
|
|
@@ -5270,9 +5778,10 @@ export interface SceneItemDataAttributes {
|
|
|
5270
5778
|
*/
|
|
5271
5779
|
materialOverride?: ColorMaterial;
|
|
5272
5780
|
/**
|
|
5273
|
-
*
|
|
5781
|
+
* This has been deprecated and replaced by the GET endpoint /property-entries
|
|
5274
5782
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
5275
5783
|
* @memberof SceneItemDataAttributes
|
|
5784
|
+
* @deprecated
|
|
5276
5785
|
*/
|
|
5277
5786
|
metadata?: {
|
|
5278
5787
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -5574,10 +6083,10 @@ export interface SceneList {
|
|
|
5574
6083
|
export interface SceneOperation {
|
|
5575
6084
|
/**
|
|
5576
6085
|
* Query `scene-items`. Use `query-by-collection` to combine multiple queries.
|
|
5577
|
-
* @type {QueryById | QueryByCollection | QueryAll}
|
|
6086
|
+
* @type {QueryById | QueryByCollection | QueryAll | QueryByMetadata}
|
|
5578
6087
|
* @memberof SceneOperation
|
|
5579
6088
|
*/
|
|
5580
|
-
query: QueryById | QueryByCollection | QueryAll;
|
|
6089
|
+
query: QueryById | QueryByCollection | QueryAll | QueryByMetadata;
|
|
5581
6090
|
/**
|
|
5582
6091
|
* List of operations to perform on `scene-items` matching the query.
|
|
5583
6092
|
* @type {Array<ChangeVisibilityOp | ChangeMaterialOp | ClearMaterialOp | ChangeTransformOp | ClearTransformOp | SelectOp | DeselectOperation | ClearRenOp | ViewDefaultRenOp | ViewRenByIdOp | ViewRenBySuppliedIdOp | ViewRepByIdOp | ViewRepByPredefinedIdOp | ClearRepOp>}
|
|
@@ -6169,6 +6678,52 @@ export interface SectionPlane {
|
|
|
6169
6678
|
*/
|
|
6170
6679
|
offset: number;
|
|
6171
6680
|
}
|
|
6681
|
+
/**
|
|
6682
|
+
* Queries a file by its unique ID.
|
|
6683
|
+
* @export
|
|
6684
|
+
* @interface SelectFileById
|
|
6685
|
+
*/
|
|
6686
|
+
export interface SelectFileById {
|
|
6687
|
+
/**
|
|
6688
|
+
*
|
|
6689
|
+
* @type {string}
|
|
6690
|
+
* @memberof SelectFileById
|
|
6691
|
+
*/
|
|
6692
|
+
type: SelectFileByIdTypeEnum;
|
|
6693
|
+
/**
|
|
6694
|
+
* ID of the resource.
|
|
6695
|
+
* @type {string}
|
|
6696
|
+
* @memberof SelectFileById
|
|
6697
|
+
*/
|
|
6698
|
+
id: string;
|
|
6699
|
+
}
|
|
6700
|
+
export declare const SelectFileByIdTypeEnum: {
|
|
6701
|
+
readonly FileById: "file-by-id";
|
|
6702
|
+
};
|
|
6703
|
+
export declare type SelectFileByIdTypeEnum = (typeof SelectFileByIdTypeEnum)[keyof typeof SelectFileByIdTypeEnum];
|
|
6704
|
+
/**
|
|
6705
|
+
* Queries a file by its supplied ID.
|
|
6706
|
+
* @export
|
|
6707
|
+
* @interface SelectFileBySuppliedId
|
|
6708
|
+
*/
|
|
6709
|
+
export interface SelectFileBySuppliedId {
|
|
6710
|
+
/**
|
|
6711
|
+
*
|
|
6712
|
+
* @type {string}
|
|
6713
|
+
* @memberof SelectFileBySuppliedId
|
|
6714
|
+
*/
|
|
6715
|
+
type: SelectFileBySuppliedIdTypeEnum;
|
|
6716
|
+
/**
|
|
6717
|
+
*
|
|
6718
|
+
* @type {string}
|
|
6719
|
+
* @memberof SelectFileBySuppliedId
|
|
6720
|
+
*/
|
|
6721
|
+
id: string;
|
|
6722
|
+
}
|
|
6723
|
+
export declare const SelectFileBySuppliedIdTypeEnum: {
|
|
6724
|
+
readonly FileBySuppliedId: "file-by-supplied-id";
|
|
6725
|
+
};
|
|
6726
|
+
export declare type SelectFileBySuppliedIdTypeEnum = (typeof SelectFileBySuppliedIdTypeEnum)[keyof typeof SelectFileBySuppliedIdTypeEnum];
|
|
6172
6727
|
/**
|
|
6173
6728
|
*
|
|
6174
6729
|
* @export
|
|
@@ -6516,32 +7071,81 @@ export interface UpdateApplicationRequestDataAttributes {
|
|
|
6516
7071
|
/**
|
|
6517
7072
|
*
|
|
6518
7073
|
* @export
|
|
6519
|
-
* @interface
|
|
7074
|
+
* @interface UpdateFileCollectionRequest
|
|
6520
7075
|
*/
|
|
6521
|
-
export interface
|
|
7076
|
+
export interface UpdateFileCollectionRequest {
|
|
6522
7077
|
/**
|
|
6523
7078
|
*
|
|
6524
|
-
* @type {
|
|
6525
|
-
* @memberof
|
|
7079
|
+
* @type {UpdateFileCollectionRequestData}
|
|
7080
|
+
* @memberof UpdateFileCollectionRequest
|
|
6526
7081
|
*/
|
|
6527
|
-
data:
|
|
7082
|
+
data: UpdateFileCollectionRequestData;
|
|
6528
7083
|
}
|
|
6529
7084
|
/**
|
|
6530
7085
|
*
|
|
6531
7086
|
* @export
|
|
6532
|
-
* @interface
|
|
7087
|
+
* @interface UpdateFileCollectionRequestData
|
|
6533
7088
|
*/
|
|
6534
|
-
export interface
|
|
7089
|
+
export interface UpdateFileCollectionRequestData {
|
|
6535
7090
|
/**
|
|
6536
7091
|
* Resource object type.
|
|
6537
7092
|
* @type {string}
|
|
6538
|
-
* @memberof
|
|
7093
|
+
* @memberof UpdateFileCollectionRequestData
|
|
6539
7094
|
*/
|
|
6540
|
-
type:
|
|
7095
|
+
type: UpdateFileCollectionRequestDataTypeEnum;
|
|
6541
7096
|
/**
|
|
6542
7097
|
*
|
|
6543
|
-
* @type {
|
|
6544
|
-
* @memberof
|
|
7098
|
+
* @type {UpdateFileCollectionRequestDataAttributes}
|
|
7099
|
+
* @memberof UpdateFileCollectionRequestData
|
|
7100
|
+
*/
|
|
7101
|
+
attributes: UpdateFileCollectionRequestDataAttributes;
|
|
7102
|
+
}
|
|
7103
|
+
export declare const UpdateFileCollectionRequestDataTypeEnum: {
|
|
7104
|
+
readonly FileCollection: "file-collection";
|
|
7105
|
+
};
|
|
7106
|
+
export declare type UpdateFileCollectionRequestDataTypeEnum = (typeof UpdateFileCollectionRequestDataTypeEnum)[keyof typeof UpdateFileCollectionRequestDataTypeEnum];
|
|
7107
|
+
/**
|
|
7108
|
+
*
|
|
7109
|
+
* @export
|
|
7110
|
+
* @interface UpdateFileCollectionRequestDataAttributes
|
|
7111
|
+
*/
|
|
7112
|
+
export interface UpdateFileCollectionRequestDataAttributes {
|
|
7113
|
+
/**
|
|
7114
|
+
* Number of seconds before expiration
|
|
7115
|
+
* @type {number}
|
|
7116
|
+
* @memberof UpdateFileCollectionRequestDataAttributes
|
|
7117
|
+
*/
|
|
7118
|
+
expiry?: number;
|
|
7119
|
+
}
|
|
7120
|
+
/**
|
|
7121
|
+
*
|
|
7122
|
+
* @export
|
|
7123
|
+
* @interface UpdateFileRequest
|
|
7124
|
+
*/
|
|
7125
|
+
export interface UpdateFileRequest {
|
|
7126
|
+
/**
|
|
7127
|
+
*
|
|
7128
|
+
* @type {UpdateFileRequestData}
|
|
7129
|
+
* @memberof UpdateFileRequest
|
|
7130
|
+
*/
|
|
7131
|
+
data: UpdateFileRequestData;
|
|
7132
|
+
}
|
|
7133
|
+
/**
|
|
7134
|
+
*
|
|
7135
|
+
* @export
|
|
7136
|
+
* @interface UpdateFileRequestData
|
|
7137
|
+
*/
|
|
7138
|
+
export interface UpdateFileRequestData {
|
|
7139
|
+
/**
|
|
7140
|
+
* Resource object type.
|
|
7141
|
+
* @type {string}
|
|
7142
|
+
* @memberof UpdateFileRequestData
|
|
7143
|
+
*/
|
|
7144
|
+
type: string;
|
|
7145
|
+
/**
|
|
7146
|
+
*
|
|
7147
|
+
* @type {UpdateFileRequestDataAttributes}
|
|
7148
|
+
* @memberof UpdateFileRequestData
|
|
6545
7149
|
*/
|
|
6546
7150
|
attributes: UpdateFileRequestDataAttributes;
|
|
6547
7151
|
}
|
|
@@ -6632,9 +7236,10 @@ export interface UpdatePartRevisionRequestData {
|
|
|
6632
7236
|
*/
|
|
6633
7237
|
export interface UpdatePartRevisionRequestDataAttributes {
|
|
6634
7238
|
/**
|
|
6635
|
-
* Metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
|
|
7239
|
+
* Metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified. This has been deprecated and replaced by the PATCH endpoint /property-entries
|
|
6636
7240
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
6637
7241
|
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
7242
|
+
* @deprecated
|
|
6638
7243
|
*/
|
|
6639
7244
|
metadata?: {
|
|
6640
7245
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -7003,6 +7608,12 @@ export interface UpdateSceneRequestDataAttributes {
|
|
|
7003
7608
|
* @memberof UpdateSceneRequestDataAttributes
|
|
7004
7609
|
*/
|
|
7005
7610
|
worldOrientation?: Orientation;
|
|
7611
|
+
/**
|
|
7612
|
+
* Number of seconds before expiration
|
|
7613
|
+
* @type {number}
|
|
7614
|
+
* @memberof UpdateSceneRequestDataAttributes
|
|
7615
|
+
*/
|
|
7616
|
+
expiry?: number;
|
|
7006
7617
|
/**
|
|
7007
7618
|
* User supplied key-value pairs for a scene. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters. A null value will delete the entry in the map, all other key/value pairs provided here will be inserted or updated into the existing scene metadata.
|
|
7008
7619
|
* @type {{ [key: string]: string; }}
|
|
@@ -8644,11 +9255,554 @@ export declare class ExportsApi extends BaseAPI {
|
|
|
8644
9255
|
*/
|
|
8645
9256
|
getQueuedExport(requestParameters: ExportsApiGetQueuedExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
|
|
8646
9257
|
}
|
|
9258
|
+
/**
|
|
9259
|
+
* FileCollectionsApi - axios parameter creator
|
|
9260
|
+
* @export
|
|
9261
|
+
*/
|
|
9262
|
+
export declare const FileCollectionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9263
|
+
/**
|
|
9264
|
+
* Add files to a `file-collection`.
|
|
9265
|
+
* @param {string} id The `file-collection` ID.
|
|
9266
|
+
* @param {FileIdList} fileIdList
|
|
9267
|
+
* @param {*} [options] Override http request option.
|
|
9268
|
+
* @throws {RequiredError}
|
|
9269
|
+
*/
|
|
9270
|
+
addFileCollectionFiles: (id: string, fileIdList: FileIdList, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9271
|
+
/**
|
|
9272
|
+
* Create a `file-collection`.
|
|
9273
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
9274
|
+
* @param {*} [options] Override http request option.
|
|
9275
|
+
* @throws {RequiredError}
|
|
9276
|
+
*/
|
|
9277
|
+
createFileCollection: (createFileCollectionRequest: CreateFileCollectionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9278
|
+
/**
|
|
9279
|
+
* Delete a `file-collection`.
|
|
9280
|
+
* @param {string} id The `file-collection` ID.
|
|
9281
|
+
* @param {*} [options] Override http request option.
|
|
9282
|
+
* @throws {RequiredError}
|
|
9283
|
+
*/
|
|
9284
|
+
deleteFileCollection: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9285
|
+
/**
|
|
9286
|
+
* Get a `file-collection` by ID.
|
|
9287
|
+
* @param {string} id The `file-collection` ID.
|
|
9288
|
+
* @param {*} [options] Override http request option.
|
|
9289
|
+
* @throws {RequiredError}
|
|
9290
|
+
*/
|
|
9291
|
+
getFileCollection: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9292
|
+
/**
|
|
9293
|
+
* List the files in a `file-collection`.
|
|
9294
|
+
* @param {string} id The `file-collection` ID.
|
|
9295
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9296
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9297
|
+
* @param {*} [options] Override http request option.
|
|
9298
|
+
* @throws {RequiredError}
|
|
9299
|
+
*/
|
|
9300
|
+
listFileCollectionFiles: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9301
|
+
/**
|
|
9302
|
+
* List `file-collection`s by supplied ID.
|
|
9303
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9304
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9305
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9306
|
+
* @param {*} [options] Override http request option.
|
|
9307
|
+
* @throws {RequiredError}
|
|
9308
|
+
*/
|
|
9309
|
+
listFileCollections: (pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9310
|
+
/**
|
|
9311
|
+
* Remove a file from a `file-collection`.
|
|
9312
|
+
* @param {string} id The `file-collection` ID.
|
|
9313
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
9314
|
+
* @param {*} [options] Override http request option.
|
|
9315
|
+
* @throws {RequiredError}
|
|
9316
|
+
*/
|
|
9317
|
+
removeFileCollectionFiles: (id: string, filterFileId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9318
|
+
/**
|
|
9319
|
+
* Update a `file-collection`.
|
|
9320
|
+
* @param {string} id The `file-collection` ID.
|
|
9321
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
9322
|
+
* @param {*} [options] Override http request option.
|
|
9323
|
+
* @throws {RequiredError}
|
|
9324
|
+
*/
|
|
9325
|
+
updateFileCollection: (id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9326
|
+
};
|
|
9327
|
+
/**
|
|
9328
|
+
* FileCollectionsApi - functional programming interface
|
|
9329
|
+
* @export
|
|
9330
|
+
*/
|
|
9331
|
+
export declare const FileCollectionsApiFp: (configuration?: Configuration | undefined) => {
|
|
9332
|
+
/**
|
|
9333
|
+
* Add files to a `file-collection`.
|
|
9334
|
+
* @param {string} id The `file-collection` ID.
|
|
9335
|
+
* @param {FileIdList} fileIdList
|
|
9336
|
+
* @param {*} [options] Override http request option.
|
|
9337
|
+
* @throws {RequiredError}
|
|
9338
|
+
*/
|
|
9339
|
+
addFileCollectionFiles(id: string, fileIdList: FileIdList, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
|
|
9340
|
+
/**
|
|
9341
|
+
* Create a `file-collection`.
|
|
9342
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
9343
|
+
* @param {*} [options] Override http request option.
|
|
9344
|
+
* @throws {RequiredError}
|
|
9345
|
+
*/
|
|
9346
|
+
createFileCollection(createFileCollectionRequest: CreateFileCollectionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
|
|
9347
|
+
/**
|
|
9348
|
+
* Delete a `file-collection`.
|
|
9349
|
+
* @param {string} id The `file-collection` ID.
|
|
9350
|
+
* @param {*} [options] Override http request option.
|
|
9351
|
+
* @throws {RequiredError}
|
|
9352
|
+
*/
|
|
9353
|
+
deleteFileCollection(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
9354
|
+
/**
|
|
9355
|
+
* Get a `file-collection` by ID.
|
|
9356
|
+
* @param {string} id The `file-collection` ID.
|
|
9357
|
+
* @param {*} [options] Override http request option.
|
|
9358
|
+
* @throws {RequiredError}
|
|
9359
|
+
*/
|
|
9360
|
+
getFileCollection(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
|
|
9361
|
+
/**
|
|
9362
|
+
* List the files in a `file-collection`.
|
|
9363
|
+
* @param {string} id The `file-collection` ID.
|
|
9364
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9365
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9366
|
+
* @param {*} [options] Override http request option.
|
|
9367
|
+
* @throws {RequiredError}
|
|
9368
|
+
*/
|
|
9369
|
+
listFileCollectionFiles(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileList>>;
|
|
9370
|
+
/**
|
|
9371
|
+
* List `file-collection`s by supplied ID.
|
|
9372
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9373
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9374
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9375
|
+
* @param {*} [options] Override http request option.
|
|
9376
|
+
* @throws {RequiredError}
|
|
9377
|
+
*/
|
|
9378
|
+
listFileCollections(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionList>>;
|
|
9379
|
+
/**
|
|
9380
|
+
* Remove a file from a `file-collection`.
|
|
9381
|
+
* @param {string} id The `file-collection` ID.
|
|
9382
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
9383
|
+
* @param {*} [options] Override http request option.
|
|
9384
|
+
* @throws {RequiredError}
|
|
9385
|
+
*/
|
|
9386
|
+
removeFileCollectionFiles(id: string, filterFileId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
9387
|
+
/**
|
|
9388
|
+
* Update a `file-collection`.
|
|
9389
|
+
* @param {string} id The `file-collection` ID.
|
|
9390
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
9391
|
+
* @param {*} [options] Override http request option.
|
|
9392
|
+
* @throws {RequiredError}
|
|
9393
|
+
*/
|
|
9394
|
+
updateFileCollection(id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
9395
|
+
};
|
|
9396
|
+
/**
|
|
9397
|
+
* FileCollectionsApi - factory interface
|
|
9398
|
+
* @export
|
|
9399
|
+
*/
|
|
9400
|
+
export declare const FileCollectionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9401
|
+
/**
|
|
9402
|
+
* Add files to a `file-collection`.
|
|
9403
|
+
* @param {string} id The `file-collection` ID.
|
|
9404
|
+
* @param {FileIdList} fileIdList
|
|
9405
|
+
* @param {*} [options] Override http request option.
|
|
9406
|
+
* @throws {RequiredError}
|
|
9407
|
+
*/
|
|
9408
|
+
addFileCollectionFiles(id: string, fileIdList: FileIdList, options?: any): AxiosPromise<FileCollectionMetadata>;
|
|
9409
|
+
/**
|
|
9410
|
+
* Create a `file-collection`.
|
|
9411
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
9412
|
+
* @param {*} [options] Override http request option.
|
|
9413
|
+
* @throws {RequiredError}
|
|
9414
|
+
*/
|
|
9415
|
+
createFileCollection(createFileCollectionRequest: CreateFileCollectionRequest, options?: any): AxiosPromise<FileCollectionMetadata>;
|
|
9416
|
+
/**
|
|
9417
|
+
* Delete a `file-collection`.
|
|
9418
|
+
* @param {string} id The `file-collection` ID.
|
|
9419
|
+
* @param {*} [options] Override http request option.
|
|
9420
|
+
* @throws {RequiredError}
|
|
9421
|
+
*/
|
|
9422
|
+
deleteFileCollection(id: string, options?: any): AxiosPromise<void>;
|
|
9423
|
+
/**
|
|
9424
|
+
* Get a `file-collection` by ID.
|
|
9425
|
+
* @param {string} id The `file-collection` ID.
|
|
9426
|
+
* @param {*} [options] Override http request option.
|
|
9427
|
+
* @throws {RequiredError}
|
|
9428
|
+
*/
|
|
9429
|
+
getFileCollection(id: string, options?: any): AxiosPromise<FileCollectionMetadata>;
|
|
9430
|
+
/**
|
|
9431
|
+
* List the files in a `file-collection`.
|
|
9432
|
+
* @param {string} id The `file-collection` ID.
|
|
9433
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9434
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9435
|
+
* @param {*} [options] Override http request option.
|
|
9436
|
+
* @throws {RequiredError}
|
|
9437
|
+
*/
|
|
9438
|
+
listFileCollectionFiles(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<FileList>;
|
|
9439
|
+
/**
|
|
9440
|
+
* List `file-collection`s by supplied ID.
|
|
9441
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9442
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9443
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9444
|
+
* @param {*} [options] Override http request option.
|
|
9445
|
+
* @throws {RequiredError}
|
|
9446
|
+
*/
|
|
9447
|
+
listFileCollections(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<FileCollectionList>;
|
|
9448
|
+
/**
|
|
9449
|
+
* Remove a file from a `file-collection`.
|
|
9450
|
+
* @param {string} id The `file-collection` ID.
|
|
9451
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
9452
|
+
* @param {*} [options] Override http request option.
|
|
9453
|
+
* @throws {RequiredError}
|
|
9454
|
+
*/
|
|
9455
|
+
removeFileCollectionFiles(id: string, filterFileId?: string | undefined, options?: any): AxiosPromise<void>;
|
|
9456
|
+
/**
|
|
9457
|
+
* Update a `file-collection`.
|
|
9458
|
+
* @param {string} id The `file-collection` ID.
|
|
9459
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
9460
|
+
* @param {*} [options] Override http request option.
|
|
9461
|
+
* @throws {RequiredError}
|
|
9462
|
+
*/
|
|
9463
|
+
updateFileCollection(id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: any): AxiosPromise<void>;
|
|
9464
|
+
};
|
|
9465
|
+
/**
|
|
9466
|
+
* Request parameters for addFileCollectionFiles operation in FileCollectionsApi.
|
|
9467
|
+
* @export
|
|
9468
|
+
* @interface FileCollectionsApiAddFileCollectionFilesRequest
|
|
9469
|
+
*/
|
|
9470
|
+
export interface FileCollectionsApiAddFileCollectionFilesRequest {
|
|
9471
|
+
/**
|
|
9472
|
+
* The `file-collection` ID.
|
|
9473
|
+
* @type {string}
|
|
9474
|
+
* @memberof FileCollectionsApiAddFileCollectionFiles
|
|
9475
|
+
*/
|
|
9476
|
+
readonly id: string;
|
|
9477
|
+
/**
|
|
9478
|
+
*
|
|
9479
|
+
* @type {FileIdList}
|
|
9480
|
+
* @memberof FileCollectionsApiAddFileCollectionFiles
|
|
9481
|
+
*/
|
|
9482
|
+
readonly fileIdList: FileIdList;
|
|
9483
|
+
}
|
|
9484
|
+
/**
|
|
9485
|
+
* Request parameters for createFileCollection operation in FileCollectionsApi.
|
|
9486
|
+
* @export
|
|
9487
|
+
* @interface FileCollectionsApiCreateFileCollectionRequest
|
|
9488
|
+
*/
|
|
9489
|
+
export interface FileCollectionsApiCreateFileCollectionRequest {
|
|
9490
|
+
/**
|
|
9491
|
+
*
|
|
9492
|
+
* @type {CreateFileCollectionRequest}
|
|
9493
|
+
* @memberof FileCollectionsApiCreateFileCollection
|
|
9494
|
+
*/
|
|
9495
|
+
readonly createFileCollectionRequest: CreateFileCollectionRequest;
|
|
9496
|
+
}
|
|
9497
|
+
/**
|
|
9498
|
+
* Request parameters for deleteFileCollection operation in FileCollectionsApi.
|
|
9499
|
+
* @export
|
|
9500
|
+
* @interface FileCollectionsApiDeleteFileCollectionRequest
|
|
9501
|
+
*/
|
|
9502
|
+
export interface FileCollectionsApiDeleteFileCollectionRequest {
|
|
9503
|
+
/**
|
|
9504
|
+
* The `file-collection` ID.
|
|
9505
|
+
* @type {string}
|
|
9506
|
+
* @memberof FileCollectionsApiDeleteFileCollection
|
|
9507
|
+
*/
|
|
9508
|
+
readonly id: string;
|
|
9509
|
+
}
|
|
9510
|
+
/**
|
|
9511
|
+
* Request parameters for getFileCollection operation in FileCollectionsApi.
|
|
9512
|
+
* @export
|
|
9513
|
+
* @interface FileCollectionsApiGetFileCollectionRequest
|
|
9514
|
+
*/
|
|
9515
|
+
export interface FileCollectionsApiGetFileCollectionRequest {
|
|
9516
|
+
/**
|
|
9517
|
+
* The `file-collection` ID.
|
|
9518
|
+
* @type {string}
|
|
9519
|
+
* @memberof FileCollectionsApiGetFileCollection
|
|
9520
|
+
*/
|
|
9521
|
+
readonly id: string;
|
|
9522
|
+
}
|
|
9523
|
+
/**
|
|
9524
|
+
* Request parameters for listFileCollectionFiles operation in FileCollectionsApi.
|
|
9525
|
+
* @export
|
|
9526
|
+
* @interface FileCollectionsApiListFileCollectionFilesRequest
|
|
9527
|
+
*/
|
|
9528
|
+
export interface FileCollectionsApiListFileCollectionFilesRequest {
|
|
9529
|
+
/**
|
|
9530
|
+
* The `file-collection` ID.
|
|
9531
|
+
* @type {string}
|
|
9532
|
+
* @memberof FileCollectionsApiListFileCollectionFiles
|
|
9533
|
+
*/
|
|
9534
|
+
readonly id: string;
|
|
9535
|
+
/**
|
|
9536
|
+
* The cursor for the next page of items.
|
|
9537
|
+
* @type {string}
|
|
9538
|
+
* @memberof FileCollectionsApiListFileCollectionFiles
|
|
9539
|
+
*/
|
|
9540
|
+
readonly pageCursor?: string;
|
|
9541
|
+
/**
|
|
9542
|
+
* The number of items to return.
|
|
9543
|
+
* @type {number}
|
|
9544
|
+
* @memberof FileCollectionsApiListFileCollectionFiles
|
|
9545
|
+
*/
|
|
9546
|
+
readonly pageSize?: number;
|
|
9547
|
+
}
|
|
9548
|
+
/**
|
|
9549
|
+
* Request parameters for listFileCollections operation in FileCollectionsApi.
|
|
9550
|
+
* @export
|
|
9551
|
+
* @interface FileCollectionsApiListFileCollectionsRequest
|
|
9552
|
+
*/
|
|
9553
|
+
export interface FileCollectionsApiListFileCollectionsRequest {
|
|
9554
|
+
/**
|
|
9555
|
+
* The cursor for the next page of items.
|
|
9556
|
+
* @type {string}
|
|
9557
|
+
* @memberof FileCollectionsApiListFileCollections
|
|
9558
|
+
*/
|
|
9559
|
+
readonly pageCursor?: string;
|
|
9560
|
+
/**
|
|
9561
|
+
* The number of items to return.
|
|
9562
|
+
* @type {number}
|
|
9563
|
+
* @memberof FileCollectionsApiListFileCollections
|
|
9564
|
+
*/
|
|
9565
|
+
readonly pageSize?: number;
|
|
9566
|
+
/**
|
|
9567
|
+
* Comma-separated list of supplied IDs to filter on.
|
|
9568
|
+
* @type {string}
|
|
9569
|
+
* @memberof FileCollectionsApiListFileCollections
|
|
9570
|
+
*/
|
|
9571
|
+
readonly filterSuppliedId?: string;
|
|
9572
|
+
}
|
|
9573
|
+
/**
|
|
9574
|
+
* Request parameters for removeFileCollectionFiles operation in FileCollectionsApi.
|
|
9575
|
+
* @export
|
|
9576
|
+
* @interface FileCollectionsApiRemoveFileCollectionFilesRequest
|
|
9577
|
+
*/
|
|
9578
|
+
export interface FileCollectionsApiRemoveFileCollectionFilesRequest {
|
|
9579
|
+
/**
|
|
9580
|
+
* The `file-collection` ID.
|
|
9581
|
+
* @type {string}
|
|
9582
|
+
* @memberof FileCollectionsApiRemoveFileCollectionFiles
|
|
9583
|
+
*/
|
|
9584
|
+
readonly id: string;
|
|
9585
|
+
/**
|
|
9586
|
+
* Comma-separated list of file-ids to filter on.
|
|
9587
|
+
* @type {string}
|
|
9588
|
+
* @memberof FileCollectionsApiRemoveFileCollectionFiles
|
|
9589
|
+
*/
|
|
9590
|
+
readonly filterFileId?: string;
|
|
9591
|
+
}
|
|
9592
|
+
/**
|
|
9593
|
+
* Request parameters for updateFileCollection operation in FileCollectionsApi.
|
|
9594
|
+
* @export
|
|
9595
|
+
* @interface FileCollectionsApiUpdateFileCollectionRequest
|
|
9596
|
+
*/
|
|
9597
|
+
export interface FileCollectionsApiUpdateFileCollectionRequest {
|
|
9598
|
+
/**
|
|
9599
|
+
* The `file-collection` ID.
|
|
9600
|
+
* @type {string}
|
|
9601
|
+
* @memberof FileCollectionsApiUpdateFileCollection
|
|
9602
|
+
*/
|
|
9603
|
+
readonly id: string;
|
|
9604
|
+
/**
|
|
9605
|
+
*
|
|
9606
|
+
* @type {UpdateFileCollectionRequest}
|
|
9607
|
+
* @memberof FileCollectionsApiUpdateFileCollection
|
|
9608
|
+
*/
|
|
9609
|
+
readonly updateFileCollectionRequest: UpdateFileCollectionRequest;
|
|
9610
|
+
}
|
|
9611
|
+
/**
|
|
9612
|
+
* FileCollectionsApi - object-oriented interface
|
|
9613
|
+
* @export
|
|
9614
|
+
* @class FileCollectionsApi
|
|
9615
|
+
* @extends {BaseAPI}
|
|
9616
|
+
*/
|
|
9617
|
+
export declare class FileCollectionsApi extends BaseAPI {
|
|
9618
|
+
/**
|
|
9619
|
+
* Add files to a `file-collection`.
|
|
9620
|
+
* @param {FileCollectionsApiAddFileCollectionFilesRequest} requestParameters Request parameters.
|
|
9621
|
+
* @param {*} [options] Override http request option.
|
|
9622
|
+
* @throws {RequiredError}
|
|
9623
|
+
* @memberof FileCollectionsApi
|
|
9624
|
+
*/
|
|
9625
|
+
addFileCollectionFiles(requestParameters: FileCollectionsApiAddFileCollectionFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
|
|
9626
|
+
/**
|
|
9627
|
+
* Create a `file-collection`.
|
|
9628
|
+
* @param {FileCollectionsApiCreateFileCollectionRequest} requestParameters Request parameters.
|
|
9629
|
+
* @param {*} [options] Override http request option.
|
|
9630
|
+
* @throws {RequiredError}
|
|
9631
|
+
* @memberof FileCollectionsApi
|
|
9632
|
+
*/
|
|
9633
|
+
createFileCollection(requestParameters: FileCollectionsApiCreateFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
|
|
9634
|
+
/**
|
|
9635
|
+
* Delete a `file-collection`.
|
|
9636
|
+
* @param {FileCollectionsApiDeleteFileCollectionRequest} requestParameters Request parameters.
|
|
9637
|
+
* @param {*} [options] Override http request option.
|
|
9638
|
+
* @throws {RequiredError}
|
|
9639
|
+
* @memberof FileCollectionsApi
|
|
9640
|
+
*/
|
|
9641
|
+
deleteFileCollection(requestParameters: FileCollectionsApiDeleteFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9642
|
+
/**
|
|
9643
|
+
* Get a `file-collection` by ID.
|
|
9644
|
+
* @param {FileCollectionsApiGetFileCollectionRequest} requestParameters Request parameters.
|
|
9645
|
+
* @param {*} [options] Override http request option.
|
|
9646
|
+
* @throws {RequiredError}
|
|
9647
|
+
* @memberof FileCollectionsApi
|
|
9648
|
+
*/
|
|
9649
|
+
getFileCollection(requestParameters: FileCollectionsApiGetFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
|
|
9650
|
+
/**
|
|
9651
|
+
* List the files in a `file-collection`.
|
|
9652
|
+
* @param {FileCollectionsApiListFileCollectionFilesRequest} requestParameters Request parameters.
|
|
9653
|
+
* @param {*} [options] Override http request option.
|
|
9654
|
+
* @throws {RequiredError}
|
|
9655
|
+
* @memberof FileCollectionsApi
|
|
9656
|
+
*/
|
|
9657
|
+
listFileCollectionFiles(requestParameters: FileCollectionsApiListFileCollectionFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileList, any>>;
|
|
9658
|
+
/**
|
|
9659
|
+
* List `file-collection`s by supplied ID.
|
|
9660
|
+
* @param {FileCollectionsApiListFileCollectionsRequest} requestParameters Request parameters.
|
|
9661
|
+
* @param {*} [options] Override http request option.
|
|
9662
|
+
* @throws {RequiredError}
|
|
9663
|
+
* @memberof FileCollectionsApi
|
|
9664
|
+
*/
|
|
9665
|
+
listFileCollections(requestParameters?: FileCollectionsApiListFileCollectionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionList, any>>;
|
|
9666
|
+
/**
|
|
9667
|
+
* Remove a file from a `file-collection`.
|
|
9668
|
+
* @param {FileCollectionsApiRemoveFileCollectionFilesRequest} requestParameters Request parameters.
|
|
9669
|
+
* @param {*} [options] Override http request option.
|
|
9670
|
+
* @throws {RequiredError}
|
|
9671
|
+
* @memberof FileCollectionsApi
|
|
9672
|
+
*/
|
|
9673
|
+
removeFileCollectionFiles(requestParameters: FileCollectionsApiRemoveFileCollectionFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9674
|
+
/**
|
|
9675
|
+
* Update a `file-collection`.
|
|
9676
|
+
* @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
|
|
9677
|
+
* @param {*} [options] Override http request option.
|
|
9678
|
+
* @throws {RequiredError}
|
|
9679
|
+
* @memberof FileCollectionsApi
|
|
9680
|
+
*/
|
|
9681
|
+
updateFileCollection(requestParameters: FileCollectionsApiUpdateFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9682
|
+
}
|
|
9683
|
+
/**
|
|
9684
|
+
* FileJobsApi - axios parameter creator
|
|
9685
|
+
* @export
|
|
9686
|
+
*/
|
|
9687
|
+
export declare const FileJobsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9688
|
+
/**
|
|
9689
|
+
* Create a `file-job`.
|
|
9690
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
9691
|
+
* @param {*} [options] Override http request option.
|
|
9692
|
+
* @throws {RequiredError}
|
|
9693
|
+
*/
|
|
9694
|
+
createFileJob: (createFileJobRequest: CreateFileJobRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9695
|
+
/**
|
|
9696
|
+
* Get the status and result of a `file-job`.
|
|
9697
|
+
* @param {string} id The ID of a file job.
|
|
9698
|
+
* @param {*} [options] Override http request option.
|
|
9699
|
+
* @throws {RequiredError}
|
|
9700
|
+
*/
|
|
9701
|
+
getFileJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9702
|
+
};
|
|
9703
|
+
/**
|
|
9704
|
+
* FileJobsApi - functional programming interface
|
|
9705
|
+
* @export
|
|
9706
|
+
*/
|
|
9707
|
+
export declare const FileJobsApiFp: (configuration?: Configuration | undefined) => {
|
|
9708
|
+
/**
|
|
9709
|
+
* Create a `file-job`.
|
|
9710
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
9711
|
+
* @param {*} [options] Override http request option.
|
|
9712
|
+
* @throws {RequiredError}
|
|
9713
|
+
*/
|
|
9714
|
+
createFileJob(createFileJobRequest: CreateFileJobRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
|
|
9715
|
+
/**
|
|
9716
|
+
* Get the status and result of a `file-job`.
|
|
9717
|
+
* @param {string} id The ID of a file job.
|
|
9718
|
+
* @param {*} [options] Override http request option.
|
|
9719
|
+
* @throws {RequiredError}
|
|
9720
|
+
*/
|
|
9721
|
+
getFileJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
|
|
9722
|
+
};
|
|
9723
|
+
/**
|
|
9724
|
+
* FileJobsApi - factory interface
|
|
9725
|
+
* @export
|
|
9726
|
+
*/
|
|
9727
|
+
export declare const FileJobsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9728
|
+
/**
|
|
9729
|
+
* Create a `file-job`.
|
|
9730
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
9731
|
+
* @param {*} [options] Override http request option.
|
|
9732
|
+
* @throws {RequiredError}
|
|
9733
|
+
*/
|
|
9734
|
+
createFileJob(createFileJobRequest: CreateFileJobRequest, options?: any): AxiosPromise<QueuedJob>;
|
|
9735
|
+
/**
|
|
9736
|
+
* Get the status and result of a `file-job`.
|
|
9737
|
+
* @param {string} id The ID of a file job.
|
|
9738
|
+
* @param {*} [options] Override http request option.
|
|
9739
|
+
* @throws {RequiredError}
|
|
9740
|
+
*/
|
|
9741
|
+
getFileJob(id: string, options?: any): AxiosPromise<QueuedJob>;
|
|
9742
|
+
};
|
|
9743
|
+
/**
|
|
9744
|
+
* Request parameters for createFileJob operation in FileJobsApi.
|
|
9745
|
+
* @export
|
|
9746
|
+
* @interface FileJobsApiCreateFileJobRequest
|
|
9747
|
+
*/
|
|
9748
|
+
export interface FileJobsApiCreateFileJobRequest {
|
|
9749
|
+
/**
|
|
9750
|
+
*
|
|
9751
|
+
* @type {CreateFileJobRequest}
|
|
9752
|
+
* @memberof FileJobsApiCreateFileJob
|
|
9753
|
+
*/
|
|
9754
|
+
readonly createFileJobRequest: CreateFileJobRequest;
|
|
9755
|
+
}
|
|
9756
|
+
/**
|
|
9757
|
+
* Request parameters for getFileJob operation in FileJobsApi.
|
|
9758
|
+
* @export
|
|
9759
|
+
* @interface FileJobsApiGetFileJobRequest
|
|
9760
|
+
*/
|
|
9761
|
+
export interface FileJobsApiGetFileJobRequest {
|
|
9762
|
+
/**
|
|
9763
|
+
* The ID of a file job.
|
|
9764
|
+
* @type {string}
|
|
9765
|
+
* @memberof FileJobsApiGetFileJob
|
|
9766
|
+
*/
|
|
9767
|
+
readonly id: string;
|
|
9768
|
+
}
|
|
9769
|
+
/**
|
|
9770
|
+
* FileJobsApi - object-oriented interface
|
|
9771
|
+
* @export
|
|
9772
|
+
* @class FileJobsApi
|
|
9773
|
+
* @extends {BaseAPI}
|
|
9774
|
+
*/
|
|
9775
|
+
export declare class FileJobsApi extends BaseAPI {
|
|
9776
|
+
/**
|
|
9777
|
+
* Create a `file-job`.
|
|
9778
|
+
* @param {FileJobsApiCreateFileJobRequest} requestParameters Request parameters.
|
|
9779
|
+
* @param {*} [options] Override http request option.
|
|
9780
|
+
* @throws {RequiredError}
|
|
9781
|
+
* @memberof FileJobsApi
|
|
9782
|
+
*/
|
|
9783
|
+
createFileJob(requestParameters: FileJobsApiCreateFileJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
|
|
9784
|
+
/**
|
|
9785
|
+
* Get the status and result of a `file-job`.
|
|
9786
|
+
* @param {FileJobsApiGetFileJobRequest} requestParameters Request parameters.
|
|
9787
|
+
* @param {*} [options] Override http request option.
|
|
9788
|
+
* @throws {RequiredError}
|
|
9789
|
+
* @memberof FileJobsApi
|
|
9790
|
+
*/
|
|
9791
|
+
getFileJob(requestParameters: FileJobsApiGetFileJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
|
|
9792
|
+
}
|
|
8647
9793
|
/**
|
|
8648
9794
|
* FilesApi - axios parameter creator
|
|
8649
9795
|
* @export
|
|
8650
9796
|
*/
|
|
8651
9797
|
export declare const FilesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9798
|
+
/**
|
|
9799
|
+
* Create a download uri for a `file` by ID.
|
|
9800
|
+
* @param {string} id The `file` ID.
|
|
9801
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
9802
|
+
* @param {*} [options] Override http request option.
|
|
9803
|
+
* @throws {RequiredError}
|
|
9804
|
+
*/
|
|
9805
|
+
createDownloadUrl: (id: string, createDownloadRequest: CreateDownloadRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8652
9806
|
/**
|
|
8653
9807
|
* 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.
|
|
8654
9808
|
* @param {CreateFileRequest} createFileRequest
|
|
@@ -8701,6 +9855,14 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration |
|
|
|
8701
9855
|
* @export
|
|
8702
9856
|
*/
|
|
8703
9857
|
export declare const FilesApiFp: (configuration?: Configuration | undefined) => {
|
|
9858
|
+
/**
|
|
9859
|
+
* Create a download uri for a `file` by ID.
|
|
9860
|
+
* @param {string} id The `file` ID.
|
|
9861
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
9862
|
+
* @param {*} [options] Override http request option.
|
|
9863
|
+
* @throws {RequiredError}
|
|
9864
|
+
*/
|
|
9865
|
+
createDownloadUrl(id: string, createDownloadRequest: CreateDownloadRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<DownloadUrl>>;
|
|
8704
9866
|
/**
|
|
8705
9867
|
* 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.
|
|
8706
9868
|
* @param {CreateFileRequest} createFileRequest
|
|
@@ -8753,6 +9915,14 @@ export declare const FilesApiFp: (configuration?: Configuration | undefined) =>
|
|
|
8753
9915
|
* @export
|
|
8754
9916
|
*/
|
|
8755
9917
|
export declare const FilesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9918
|
+
/**
|
|
9919
|
+
* Create a download uri for a `file` by ID.
|
|
9920
|
+
* @param {string} id The `file` ID.
|
|
9921
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
9922
|
+
* @param {*} [options] Override http request option.
|
|
9923
|
+
* @throws {RequiredError}
|
|
9924
|
+
*/
|
|
9925
|
+
createDownloadUrl(id: string, createDownloadRequest: CreateDownloadRequest, options?: any): AxiosPromise<DownloadUrl>;
|
|
8756
9926
|
/**
|
|
8757
9927
|
* 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.
|
|
8758
9928
|
* @param {CreateFileRequest} createFileRequest
|
|
@@ -8800,6 +9970,25 @@ export declare const FilesApiFactory: (configuration?: Configuration | undefined
|
|
|
8800
9970
|
*/
|
|
8801
9971
|
uploadFile(id: string, body: any, options?: any): AxiosPromise<void>;
|
|
8802
9972
|
};
|
|
9973
|
+
/**
|
|
9974
|
+
* Request parameters for createDownloadUrl operation in FilesApi.
|
|
9975
|
+
* @export
|
|
9976
|
+
* @interface FilesApiCreateDownloadUrlRequest
|
|
9977
|
+
*/
|
|
9978
|
+
export interface FilesApiCreateDownloadUrlRequest {
|
|
9979
|
+
/**
|
|
9980
|
+
* The `file` ID.
|
|
9981
|
+
* @type {string}
|
|
9982
|
+
* @memberof FilesApiCreateDownloadUrl
|
|
9983
|
+
*/
|
|
9984
|
+
readonly id: string;
|
|
9985
|
+
/**
|
|
9986
|
+
*
|
|
9987
|
+
* @type {CreateDownloadRequest}
|
|
9988
|
+
* @memberof FilesApiCreateDownloadUrl
|
|
9989
|
+
*/
|
|
9990
|
+
readonly createDownloadRequest: CreateDownloadRequest;
|
|
9991
|
+
}
|
|
8803
9992
|
/**
|
|
8804
9993
|
* Request parameters for createFile operation in FilesApi.
|
|
8805
9994
|
* @export
|
|
@@ -8909,6 +10098,14 @@ export interface FilesApiUploadFileRequest {
|
|
|
8909
10098
|
* @extends {BaseAPI}
|
|
8910
10099
|
*/
|
|
8911
10100
|
export declare class FilesApi extends BaseAPI {
|
|
10101
|
+
/**
|
|
10102
|
+
* Create a download uri for a `file` by ID.
|
|
10103
|
+
* @param {FilesApiCreateDownloadUrlRequest} requestParameters Request parameters.
|
|
10104
|
+
* @param {*} [options] Override http request option.
|
|
10105
|
+
* @throws {RequiredError}
|
|
10106
|
+
* @memberof FilesApi
|
|
10107
|
+
*/
|
|
10108
|
+
createDownloadUrl(requestParameters: FilesApiCreateDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadUrl, any>>;
|
|
8912
10109
|
/**
|
|
8913
10110
|
* 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.
|
|
8914
10111
|
* @param {FilesApiCreateFileRequest} requestParameters Request parameters.
|
|
@@ -9743,7 +10940,7 @@ export declare class Oauth2Api extends BaseAPI {
|
|
|
9743
10940
|
*/
|
|
9744
10941
|
export declare const PartRenditionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9745
10942
|
/**
|
|
9746
|
-
*
|
|
10943
|
+
* Creates a part-rendition associated with a part-revision
|
|
9747
10944
|
* @param {string} id The `part-revision` ID.
|
|
9748
10945
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
9749
10946
|
* @param {*} [options] Override http request option.
|
|
@@ -9774,7 +10971,7 @@ export declare const PartRenditionsApiAxiosParamCreator: (configuration?: Config
|
|
|
9774
10971
|
*/
|
|
9775
10972
|
export declare const PartRenditionsApiFp: (configuration?: Configuration | undefined) => {
|
|
9776
10973
|
/**
|
|
9777
|
-
*
|
|
10974
|
+
* Creates a part-rendition associated with a part-revision
|
|
9778
10975
|
* @param {string} id The `part-revision` ID.
|
|
9779
10976
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
9780
10977
|
* @param {*} [options] Override http request option.
|
|
@@ -9805,7 +11002,7 @@ export declare const PartRenditionsApiFp: (configuration?: Configuration | undef
|
|
|
9805
11002
|
*/
|
|
9806
11003
|
export declare const PartRenditionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9807
11004
|
/**
|
|
9808
|
-
*
|
|
11005
|
+
* Creates a part-rendition associated with a part-revision
|
|
9809
11006
|
* @param {string} id The `part-revision` ID.
|
|
9810
11007
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
9811
11008
|
* @param {*} [options] Override http request option.
|
|
@@ -9901,7 +11098,7 @@ export interface PartRenditionsApiGetPartRenditionsRequest {
|
|
|
9901
11098
|
*/
|
|
9902
11099
|
export declare class PartRenditionsApi extends BaseAPI {
|
|
9903
11100
|
/**
|
|
9904
|
-
*
|
|
11101
|
+
* Creates a part-rendition associated with a part-revision
|
|
9905
11102
|
* @param {PartRenditionsApiCreatePartRenditionRequest} requestParameters Request parameters.
|
|
9906
11103
|
* @param {*} [options] Override http request option.
|
|
9907
11104
|
* @throws {RequiredError}
|
|
@@ -9931,7 +11128,7 @@ export declare class PartRenditionsApi extends BaseAPI {
|
|
|
9931
11128
|
*/
|
|
9932
11129
|
export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9933
11130
|
/**
|
|
9934
|
-
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal
|
|
11131
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
9935
11132
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
9936
11133
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9937
11134
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -9946,7 +11143,7 @@ export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?:
|
|
|
9946
11143
|
*/
|
|
9947
11144
|
export declare const PartRevisionInstancesApiFp: (configuration?: Configuration | undefined) => {
|
|
9948
11145
|
/**
|
|
9949
|
-
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal
|
|
11146
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
9950
11147
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
9951
11148
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9952
11149
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -9961,7 +11158,7 @@ export declare const PartRevisionInstancesApiFp: (configuration?: Configuration
|
|
|
9961
11158
|
*/
|
|
9962
11159
|
export declare const PartRevisionInstancesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9963
11160
|
/**
|
|
9964
|
-
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal
|
|
11161
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
9965
11162
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
9966
11163
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9967
11164
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -10003,7 +11200,7 @@ export interface PartRevisionInstancesApiGetPartRevisionInstanceListRequest {
|
|
|
10003
11200
|
*/
|
|
10004
11201
|
export declare class PartRevisionInstancesApi extends BaseAPI {
|
|
10005
11202
|
/**
|
|
10006
|
-
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal
|
|
11203
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
10007
11204
|
* @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
|
|
10008
11205
|
* @param {*} [options] Override http request option.
|
|
10009
11206
|
* @throws {RequiredError}
|
|
@@ -10068,7 +11265,7 @@ export declare const PartRevisionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
10068
11265
|
*/
|
|
10069
11266
|
renderPartRevision: (id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10070
11267
|
/**
|
|
10071
|
-
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.
|
|
11268
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
10072
11269
|
* @param {string} id The `part-revision` ID.
|
|
10073
11270
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
10074
11271
|
* @param {*} [options] Override http request option.
|
|
@@ -10133,7 +11330,7 @@ export declare const PartRevisionsApiFp: (configuration?: Configuration | undefi
|
|
|
10133
11330
|
*/
|
|
10134
11331
|
renderPartRevision(id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<any>>;
|
|
10135
11332
|
/**
|
|
10136
|
-
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.
|
|
11333
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
10137
11334
|
* @param {string} id The `part-revision` ID.
|
|
10138
11335
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
10139
11336
|
* @param {*} [options] Override http request option.
|
|
@@ -10198,7 +11395,7 @@ export declare const PartRevisionsApiFactory: (configuration?: Configuration | u
|
|
|
10198
11395
|
*/
|
|
10199
11396
|
renderPartRevision(id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: any): AxiosPromise<any>;
|
|
10200
11397
|
/**
|
|
10201
|
-
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.
|
|
11398
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
10202
11399
|
* @param {string} id The `part-revision` ID.
|
|
10203
11400
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
10204
11401
|
* @param {*} [options] Override http request option.
|
|
@@ -10434,7 +11631,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
10434
11631
|
*/
|
|
10435
11632
|
renderPartRevision(requestParameters: PartRevisionsApiRenderPartRevisionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
10436
11633
|
/**
|
|
10437
|
-
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.
|
|
11634
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
10438
11635
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
10439
11636
|
* @param {*} [options] Override http request option.
|
|
10440
11637
|
* @throws {RequiredError}
|
|
@@ -10448,7 +11645,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
10448
11645
|
*/
|
|
10449
11646
|
export declare const PartsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
10450
11647
|
/**
|
|
10451
|
-
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`
|
|
11648
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
10452
11649
|
* @param {CreatePartRequest} createPartRequest
|
|
10453
11650
|
* @param {*} [options] Override http request option.
|
|
10454
11651
|
* @throws {RequiredError}
|
|
@@ -10492,7 +11689,7 @@ export declare const PartsApiAxiosParamCreator: (configuration?: Configuration |
|
|
|
10492
11689
|
*/
|
|
10493
11690
|
export declare const PartsApiFp: (configuration?: Configuration | undefined) => {
|
|
10494
11691
|
/**
|
|
10495
|
-
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`
|
|
11692
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
10496
11693
|
* @param {CreatePartRequest} createPartRequest
|
|
10497
11694
|
* @param {*} [options] Override http request option.
|
|
10498
11695
|
* @throws {RequiredError}
|
|
@@ -10536,7 +11733,7 @@ export declare const PartsApiFp: (configuration?: Configuration | undefined) =>
|
|
|
10536
11733
|
*/
|
|
10537
11734
|
export declare const PartsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
10538
11735
|
/**
|
|
10539
|
-
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`
|
|
11736
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
10540
11737
|
* @param {CreatePartRequest} createPartRequest
|
|
10541
11738
|
* @param {*} [options] Override http request option.
|
|
10542
11739
|
* @throws {RequiredError}
|
|
@@ -10665,7 +11862,7 @@ export interface PartsApiGetQueuedPartDeletionRequest {
|
|
|
10665
11862
|
*/
|
|
10666
11863
|
export declare class PartsApi extends BaseAPI {
|
|
10667
11864
|
/**
|
|
10668
|
-
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`
|
|
11865
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
10669
11866
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
10670
11867
|
* @param {*} [options] Override http request option.
|
|
10671
11868
|
* @throws {RequiredError}
|
|
@@ -10797,7 +11994,7 @@ export declare class PmiApi extends BaseAPI {
|
|
|
10797
11994
|
*/
|
|
10798
11995
|
export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
10799
11996
|
/**
|
|
10800
|
-
* Get `property-entries` by a resource ID
|
|
11997
|
+
* Get `property-entries` by a resource ID
|
|
10801
11998
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10802
11999
|
* @param {number} [pageSize] The number of items to return.
|
|
10803
12000
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -10807,7 +12004,7 @@ export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Confi
|
|
|
10807
12004
|
*/
|
|
10808
12005
|
getPropertyEntries: (pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10809
12006
|
/**
|
|
10810
|
-
* Upsert property-entries for a provided resource.
|
|
12007
|
+
* Upsert property-entries for a provided resource.
|
|
10811
12008
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
10812
12009
|
* @param {*} [options] Override http request option.
|
|
10813
12010
|
* @throws {RequiredError}
|
|
@@ -10820,7 +12017,7 @@ export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Confi
|
|
|
10820
12017
|
*/
|
|
10821
12018
|
export declare const PropertyEntriesApiFp: (configuration?: Configuration | undefined) => {
|
|
10822
12019
|
/**
|
|
10823
|
-
* Get `property-entries` by a resource ID
|
|
12020
|
+
* Get `property-entries` by a resource ID
|
|
10824
12021
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10825
12022
|
* @param {number} [pageSize] The number of items to return.
|
|
10826
12023
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -10830,7 +12027,7 @@ export declare const PropertyEntriesApiFp: (configuration?: Configuration | unde
|
|
|
10830
12027
|
*/
|
|
10831
12028
|
getPropertyEntries(pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PropertyEntryList>>;
|
|
10832
12029
|
/**
|
|
10833
|
-
* Upsert property-entries for a provided resource.
|
|
12030
|
+
* Upsert property-entries for a provided resource.
|
|
10834
12031
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
10835
12032
|
* @param {*} [options] Override http request option.
|
|
10836
12033
|
* @throws {RequiredError}
|
|
@@ -10843,7 +12040,7 @@ export declare const PropertyEntriesApiFp: (configuration?: Configuration | unde
|
|
|
10843
12040
|
*/
|
|
10844
12041
|
export declare const PropertyEntriesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
10845
12042
|
/**
|
|
10846
|
-
* Get `property-entries` by a resource ID
|
|
12043
|
+
* Get `property-entries` by a resource ID
|
|
10847
12044
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10848
12045
|
* @param {number} [pageSize] The number of items to return.
|
|
10849
12046
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -10853,7 +12050,7 @@ export declare const PropertyEntriesApiFactory: (configuration?: Configuration |
|
|
|
10853
12050
|
*/
|
|
10854
12051
|
getPropertyEntries(pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: any): AxiosPromise<PropertyEntryList>;
|
|
10855
12052
|
/**
|
|
10856
|
-
* Upsert property-entries for a provided resource.
|
|
12053
|
+
* Upsert property-entries for a provided resource.
|
|
10857
12054
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
10858
12055
|
* @param {*} [options] Override http request option.
|
|
10859
12056
|
* @throws {RequiredError}
|
|
@@ -10912,7 +12109,7 @@ export interface PropertyEntriesApiUpsertPropertyEntriesRequest {
|
|
|
10912
12109
|
*/
|
|
10913
12110
|
export declare class PropertyEntriesApi extends BaseAPI {
|
|
10914
12111
|
/**
|
|
10915
|
-
* Get `property-entries` by a resource ID
|
|
12112
|
+
* Get `property-entries` by a resource ID
|
|
10916
12113
|
* @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
|
|
10917
12114
|
* @param {*} [options] Override http request option.
|
|
10918
12115
|
* @throws {RequiredError}
|
|
@@ -10920,7 +12117,7 @@ export declare class PropertyEntriesApi extends BaseAPI {
|
|
|
10920
12117
|
*/
|
|
10921
12118
|
getPropertyEntries(requestParameters?: PropertyEntriesApiGetPropertyEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PropertyEntryList, any>>;
|
|
10922
12119
|
/**
|
|
10923
|
-
* Upsert property-entries for a provided resource.
|
|
12120
|
+
* Upsert property-entries for a provided resource.
|
|
10924
12121
|
* @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
|
|
10925
12122
|
* @param {*} [options] Override http request option.
|
|
10926
12123
|
* @throws {RequiredError}
|