@vertexvis/api-client-node 0.26.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 +373 -39
- package/dist/cjs/api.js +291 -30
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +373 -39
- package/dist/esm/api.js +283 -26
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +3 -2
package/dist/esm/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
|
|
@@ -905,12 +924,6 @@ export interface CreateDownloadRequestDataAttributes {
|
|
|
905
924
|
* @memberof CreateDownloadRequestDataAttributes
|
|
906
925
|
*/
|
|
907
926
|
expiry?: number;
|
|
908
|
-
/**
|
|
909
|
-
* Specifies the maximum time (in seconds) a cached response of a signed-url remains fresh and can be used without revalidation. (Defaults to 1 hour, can send up to 30 days)
|
|
910
|
-
* @type {number}
|
|
911
|
-
* @memberof CreateDownloadRequestDataAttributes
|
|
912
|
-
*/
|
|
913
|
-
maxAge?: number;
|
|
914
927
|
}
|
|
915
928
|
/**
|
|
916
929
|
*
|
|
@@ -1057,6 +1070,55 @@ export interface CreateFileCollectionRequestDataAttributes {
|
|
|
1057
1070
|
[key: string]: string;
|
|
1058
1071
|
};
|
|
1059
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
|
+
}
|
|
1060
1122
|
/**
|
|
1061
1123
|
*
|
|
1062
1124
|
* @export
|
|
@@ -1356,9 +1418,10 @@ export interface CreatePartRequestDataAttributes {
|
|
|
1356
1418
|
*/
|
|
1357
1419
|
indexMetadata?: boolean;
|
|
1358
1420
|
/**
|
|
1359
|
-
* 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
|
|
1360
1422
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
1361
1423
|
* @memberof CreatePartRequestDataAttributes
|
|
1424
|
+
* @deprecated
|
|
1362
1425
|
*/
|
|
1363
1426
|
metadata?: {
|
|
1364
1427
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -1711,7 +1774,7 @@ export interface CreateSceneItemRequestDataAttributes {
|
|
|
1711
1774
|
*/
|
|
1712
1775
|
ordinal?: number;
|
|
1713
1776
|
/**
|
|
1714
|
-
* 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.
|
|
1715
1778
|
* @type {string}
|
|
1716
1779
|
* @memberof CreateSceneItemRequestDataAttributes
|
|
1717
1780
|
*/
|
|
@@ -1722,6 +1785,12 @@ export interface CreateSceneItemRequestDataAttributes {
|
|
|
1722
1785
|
* @memberof CreateSceneItemRequestDataAttributes
|
|
1723
1786
|
*/
|
|
1724
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;
|
|
1725
1794
|
/**
|
|
1726
1795
|
*
|
|
1727
1796
|
* @type {PartRevisionSuppliedId}
|
|
@@ -1759,20 +1828,27 @@ export interface CreateSceneItemRequestDataAttributes {
|
|
|
1759
1828
|
*/
|
|
1760
1829
|
endItem?: boolean;
|
|
1761
1830
|
/**
|
|
1762
|
-
* 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.
|
|
1763
1832
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
1764
1833
|
* @memberof CreateSceneItemRequestDataAttributes
|
|
1834
|
+
* @deprecated
|
|
1765
1835
|
*/
|
|
1766
1836
|
metadata?: {
|
|
1767
1837
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
1768
1838
|
};
|
|
1769
1839
|
/**
|
|
1770
|
-
* 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.
|
|
1771
1841
|
* @type {Array<string>}
|
|
1772
1842
|
* @memberof CreateSceneItemRequestDataAttributes
|
|
1773
1843
|
*/
|
|
1774
1844
|
experimentalSourceMetadataKeys?: Array<string>;
|
|
1775
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];
|
|
1776
1852
|
/**
|
|
1777
1853
|
*
|
|
1778
1854
|
* @export
|
|
@@ -1880,6 +1956,12 @@ export interface CreateSceneRequestDataAttributes {
|
|
|
1880
1956
|
metadata?: {
|
|
1881
1957
|
[key: string]: string;
|
|
1882
1958
|
};
|
|
1959
|
+
/**
|
|
1960
|
+
* Number of seconds before expiration
|
|
1961
|
+
* @type {number}
|
|
1962
|
+
* @memberof CreateSceneRequestDataAttributes
|
|
1963
|
+
*/
|
|
1964
|
+
expiry?: number;
|
|
1883
1965
|
}
|
|
1884
1966
|
/**
|
|
1885
1967
|
*
|
|
@@ -2116,7 +2198,7 @@ export interface CreateStreamKeyRequestDataAttributes {
|
|
|
2116
2198
|
*/
|
|
2117
2199
|
sceneViewStateId?: string;
|
|
2118
2200
|
/**
|
|
2119
|
-
* 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
|
|
2120
2202
|
* @type {boolean}
|
|
2121
2203
|
* @memberof CreateStreamKeyRequestDataAttributes
|
|
2122
2204
|
*/
|
|
@@ -2733,6 +2815,35 @@ export interface FileIdList {
|
|
|
2733
2815
|
*/
|
|
2734
2816
|
data: Array<string>;
|
|
2735
2817
|
}
|
|
2818
|
+
/**
|
|
2819
|
+
* The operation for a file archival job.
|
|
2820
|
+
* @export
|
|
2821
|
+
* @interface FileJobArchiveOperation
|
|
2822
|
+
*/
|
|
2823
|
+
export interface FileJobArchiveOperation {
|
|
2824
|
+
/**
|
|
2825
|
+
*
|
|
2826
|
+
* @type {string}
|
|
2827
|
+
* @memberof FileJobArchiveOperation
|
|
2828
|
+
*/
|
|
2829
|
+
type: FileJobArchiveOperationTypeEnum;
|
|
2830
|
+
/**
|
|
2831
|
+
* ID of the resource.
|
|
2832
|
+
* @type {string}
|
|
2833
|
+
* @memberof FileJobArchiveOperation
|
|
2834
|
+
*/
|
|
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];
|
|
2736
2847
|
/**
|
|
2737
2848
|
*
|
|
2738
2849
|
* @export
|
|
@@ -3638,9 +3749,10 @@ export interface PartAssemblyRelationshipData {
|
|
|
3638
3749
|
*/
|
|
3639
3750
|
children: Array<PartRevisionInstance>;
|
|
3640
3751
|
/**
|
|
3641
|
-
* 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
|
|
3642
3753
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
3643
3754
|
* @memberof PartAssemblyRelationshipData
|
|
3755
|
+
* @deprecated
|
|
3644
3756
|
*/
|
|
3645
3757
|
metadata?: {
|
|
3646
3758
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -4060,9 +4172,10 @@ export interface PartRevisionDataAttributes {
|
|
|
4060
4172
|
*/
|
|
4061
4173
|
created?: string;
|
|
4062
4174
|
/**
|
|
4063
|
-
*
|
|
4175
|
+
* This has been deprecated and replaced by the GET endpoint /property-entries
|
|
4064
4176
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
4065
4177
|
* @memberof PartRevisionDataAttributes
|
|
4178
|
+
* @deprecated
|
|
4066
4179
|
*/
|
|
4067
4180
|
metadata?: {
|
|
4068
4181
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -5559,6 +5672,12 @@ export interface SceneDataAttributes {
|
|
|
5559
5672
|
* @memberof SceneDataAttributes
|
|
5560
5673
|
*/
|
|
5561
5674
|
sceneItemCount?: number;
|
|
5675
|
+
/**
|
|
5676
|
+
*
|
|
5677
|
+
* @type {string}
|
|
5678
|
+
* @memberof SceneDataAttributes
|
|
5679
|
+
*/
|
|
5680
|
+
expiresAt?: string;
|
|
5562
5681
|
/**
|
|
5563
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.
|
|
5564
5683
|
* @type {{ [key: string]: string; }}
|
|
@@ -5659,9 +5778,10 @@ export interface SceneItemDataAttributes {
|
|
|
5659
5778
|
*/
|
|
5660
5779
|
materialOverride?: ColorMaterial;
|
|
5661
5780
|
/**
|
|
5662
|
-
*
|
|
5781
|
+
* This has been deprecated and replaced by the GET endpoint /property-entries
|
|
5663
5782
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
5664
5783
|
* @memberof SceneItemDataAttributes
|
|
5784
|
+
* @deprecated
|
|
5665
5785
|
*/
|
|
5666
5786
|
metadata?: {
|
|
5667
5787
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -6558,6 +6678,52 @@ export interface SectionPlane {
|
|
|
6558
6678
|
*/
|
|
6559
6679
|
offset: number;
|
|
6560
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];
|
|
6561
6727
|
/**
|
|
6562
6728
|
*
|
|
6563
6729
|
* @export
|
|
@@ -7070,9 +7236,10 @@ export interface UpdatePartRevisionRequestData {
|
|
|
7070
7236
|
*/
|
|
7071
7237
|
export interface UpdatePartRevisionRequestDataAttributes {
|
|
7072
7238
|
/**
|
|
7073
|
-
* 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
|
|
7074
7240
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
7075
7241
|
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
7242
|
+
* @deprecated
|
|
7076
7243
|
*/
|
|
7077
7244
|
metadata?: {
|
|
7078
7245
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -7441,6 +7608,12 @@ export interface UpdateSceneRequestDataAttributes {
|
|
|
7441
7608
|
* @memberof UpdateSceneRequestDataAttributes
|
|
7442
7609
|
*/
|
|
7443
7610
|
worldOrientation?: Orientation;
|
|
7611
|
+
/**
|
|
7612
|
+
* Number of seconds before expiration
|
|
7613
|
+
* @type {number}
|
|
7614
|
+
* @memberof UpdateSceneRequestDataAttributes
|
|
7615
|
+
*/
|
|
7616
|
+
expiry?: number;
|
|
7444
7617
|
/**
|
|
7445
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.
|
|
7446
7619
|
* @type {{ [key: string]: string; }}
|
|
@@ -9134,6 +9307,14 @@ export declare const FileCollectionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
9134
9307
|
* @throws {RequiredError}
|
|
9135
9308
|
*/
|
|
9136
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>;
|
|
9137
9318
|
/**
|
|
9138
9319
|
* Update a `file-collection`.
|
|
9139
9320
|
* @param {string} id The `file-collection` ID.
|
|
@@ -9195,6 +9376,14 @@ export declare const FileCollectionsApiFp: (configuration?: Configuration | unde
|
|
|
9195
9376
|
* @throws {RequiredError}
|
|
9196
9377
|
*/
|
|
9197
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>>;
|
|
9198
9387
|
/**
|
|
9199
9388
|
* Update a `file-collection`.
|
|
9200
9389
|
* @param {string} id The `file-collection` ID.
|
|
@@ -9256,6 +9445,14 @@ export declare const FileCollectionsApiFactory: (configuration?: Configuration |
|
|
|
9256
9445
|
* @throws {RequiredError}
|
|
9257
9446
|
*/
|
|
9258
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>;
|
|
9259
9456
|
/**
|
|
9260
9457
|
* Update a `file-collection`.
|
|
9261
9458
|
* @param {string} id The `file-collection` ID.
|
|
@@ -9373,6 +9570,25 @@ export interface FileCollectionsApiListFileCollectionsRequest {
|
|
|
9373
9570
|
*/
|
|
9374
9571
|
readonly filterSuppliedId?: string;
|
|
9375
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
|
+
}
|
|
9376
9592
|
/**
|
|
9377
9593
|
* Request parameters for updateFileCollection operation in FileCollectionsApi.
|
|
9378
9594
|
* @export
|
|
@@ -9447,6 +9663,14 @@ export declare class FileCollectionsApi extends BaseAPI {
|
|
|
9447
9663
|
* @memberof FileCollectionsApi
|
|
9448
9664
|
*/
|
|
9449
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>>;
|
|
9450
9674
|
/**
|
|
9451
9675
|
* Update a `file-collection`.
|
|
9452
9676
|
* @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
|
|
@@ -9456,6 +9680,116 @@ export declare class FileCollectionsApi extends BaseAPI {
|
|
|
9456
9680
|
*/
|
|
9457
9681
|
updateFileCollection(requestParameters: FileCollectionsApiUpdateFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9458
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
|
+
}
|
|
9459
9793
|
/**
|
|
9460
9794
|
* FilesApi - axios parameter creator
|
|
9461
9795
|
* @export
|
|
@@ -10606,7 +10940,7 @@ export declare class Oauth2Api extends BaseAPI {
|
|
|
10606
10940
|
*/
|
|
10607
10941
|
export declare const PartRenditionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
10608
10942
|
/**
|
|
10609
|
-
*
|
|
10943
|
+
* Creates a part-rendition associated with a part-revision
|
|
10610
10944
|
* @param {string} id The `part-revision` ID.
|
|
10611
10945
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
10612
10946
|
* @param {*} [options] Override http request option.
|
|
@@ -10637,7 +10971,7 @@ export declare const PartRenditionsApiAxiosParamCreator: (configuration?: Config
|
|
|
10637
10971
|
*/
|
|
10638
10972
|
export declare const PartRenditionsApiFp: (configuration?: Configuration | undefined) => {
|
|
10639
10973
|
/**
|
|
10640
|
-
*
|
|
10974
|
+
* Creates a part-rendition associated with a part-revision
|
|
10641
10975
|
* @param {string} id The `part-revision` ID.
|
|
10642
10976
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
10643
10977
|
* @param {*} [options] Override http request option.
|
|
@@ -10668,7 +11002,7 @@ export declare const PartRenditionsApiFp: (configuration?: Configuration | undef
|
|
|
10668
11002
|
*/
|
|
10669
11003
|
export declare const PartRenditionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
10670
11004
|
/**
|
|
10671
|
-
*
|
|
11005
|
+
* Creates a part-rendition associated with a part-revision
|
|
10672
11006
|
* @param {string} id The `part-revision` ID.
|
|
10673
11007
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
10674
11008
|
* @param {*} [options] Override http request option.
|
|
@@ -10764,7 +11098,7 @@ export interface PartRenditionsApiGetPartRenditionsRequest {
|
|
|
10764
11098
|
*/
|
|
10765
11099
|
export declare class PartRenditionsApi extends BaseAPI {
|
|
10766
11100
|
/**
|
|
10767
|
-
*
|
|
11101
|
+
* Creates a part-rendition associated with a part-revision
|
|
10768
11102
|
* @param {PartRenditionsApiCreatePartRenditionRequest} requestParameters Request parameters.
|
|
10769
11103
|
* @param {*} [options] Override http request option.
|
|
10770
11104
|
* @throws {RequiredError}
|
|
@@ -10794,7 +11128,7 @@ export declare class PartRenditionsApi extends BaseAPI {
|
|
|
10794
11128
|
*/
|
|
10795
11129
|
export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
10796
11130
|
/**
|
|
10797
|
-
* 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.
|
|
10798
11132
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
10799
11133
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10800
11134
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -10809,7 +11143,7 @@ export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?:
|
|
|
10809
11143
|
*/
|
|
10810
11144
|
export declare const PartRevisionInstancesApiFp: (configuration?: Configuration | undefined) => {
|
|
10811
11145
|
/**
|
|
10812
|
-
* 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.
|
|
10813
11147
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
10814
11148
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10815
11149
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -10824,7 +11158,7 @@ export declare const PartRevisionInstancesApiFp: (configuration?: Configuration
|
|
|
10824
11158
|
*/
|
|
10825
11159
|
export declare const PartRevisionInstancesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
10826
11160
|
/**
|
|
10827
|
-
* 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.
|
|
10828
11162
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
10829
11163
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10830
11164
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -10866,7 +11200,7 @@ export interface PartRevisionInstancesApiGetPartRevisionInstanceListRequest {
|
|
|
10866
11200
|
*/
|
|
10867
11201
|
export declare class PartRevisionInstancesApi extends BaseAPI {
|
|
10868
11202
|
/**
|
|
10869
|
-
* 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.
|
|
10870
11204
|
* @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
|
|
10871
11205
|
* @param {*} [options] Override http request option.
|
|
10872
11206
|
* @throws {RequiredError}
|
|
@@ -10931,7 +11265,7 @@ export declare const PartRevisionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
10931
11265
|
*/
|
|
10932
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>;
|
|
10933
11267
|
/**
|
|
10934
|
-
* 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.
|
|
10935
11269
|
* @param {string} id The `part-revision` ID.
|
|
10936
11270
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
10937
11271
|
* @param {*} [options] Override http request option.
|
|
@@ -10996,7 +11330,7 @@ export declare const PartRevisionsApiFp: (configuration?: Configuration | undefi
|
|
|
10996
11330
|
*/
|
|
10997
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>>;
|
|
10998
11332
|
/**
|
|
10999
|
-
* 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.
|
|
11000
11334
|
* @param {string} id The `part-revision` ID.
|
|
11001
11335
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
11002
11336
|
* @param {*} [options] Override http request option.
|
|
@@ -11061,7 +11395,7 @@ export declare const PartRevisionsApiFactory: (configuration?: Configuration | u
|
|
|
11061
11395
|
*/
|
|
11062
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>;
|
|
11063
11397
|
/**
|
|
11064
|
-
* 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.
|
|
11065
11399
|
* @param {string} id The `part-revision` ID.
|
|
11066
11400
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
11067
11401
|
* @param {*} [options] Override http request option.
|
|
@@ -11297,7 +11631,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
11297
11631
|
*/
|
|
11298
11632
|
renderPartRevision(requestParameters: PartRevisionsApiRenderPartRevisionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
11299
11633
|
/**
|
|
11300
|
-
* 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.
|
|
11301
11635
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
11302
11636
|
* @param {*} [options] Override http request option.
|
|
11303
11637
|
* @throws {RequiredError}
|
|
@@ -11311,7 +11645,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
11311
11645
|
*/
|
|
11312
11646
|
export declare const PartsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
11313
11647
|
/**
|
|
11314
|
-
* 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.
|
|
11315
11649
|
* @param {CreatePartRequest} createPartRequest
|
|
11316
11650
|
* @param {*} [options] Override http request option.
|
|
11317
11651
|
* @throws {RequiredError}
|
|
@@ -11355,7 +11689,7 @@ export declare const PartsApiAxiosParamCreator: (configuration?: Configuration |
|
|
|
11355
11689
|
*/
|
|
11356
11690
|
export declare const PartsApiFp: (configuration?: Configuration | undefined) => {
|
|
11357
11691
|
/**
|
|
11358
|
-
* 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.
|
|
11359
11693
|
* @param {CreatePartRequest} createPartRequest
|
|
11360
11694
|
* @param {*} [options] Override http request option.
|
|
11361
11695
|
* @throws {RequiredError}
|
|
@@ -11399,7 +11733,7 @@ export declare const PartsApiFp: (configuration?: Configuration | undefined) =>
|
|
|
11399
11733
|
*/
|
|
11400
11734
|
export declare const PartsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
11401
11735
|
/**
|
|
11402
|
-
* 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.
|
|
11403
11737
|
* @param {CreatePartRequest} createPartRequest
|
|
11404
11738
|
* @param {*} [options] Override http request option.
|
|
11405
11739
|
* @throws {RequiredError}
|
|
@@ -11528,7 +11862,7 @@ export interface PartsApiGetQueuedPartDeletionRequest {
|
|
|
11528
11862
|
*/
|
|
11529
11863
|
export declare class PartsApi extends BaseAPI {
|
|
11530
11864
|
/**
|
|
11531
|
-
* 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.
|
|
11532
11866
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
11533
11867
|
* @param {*} [options] Override http request option.
|
|
11534
11868
|
* @throws {RequiredError}
|
|
@@ -11660,7 +11994,7 @@ export declare class PmiApi extends BaseAPI {
|
|
|
11660
11994
|
*/
|
|
11661
11995
|
export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
11662
11996
|
/**
|
|
11663
|
-
* Get `property-entries` by a resource ID
|
|
11997
|
+
* Get `property-entries` by a resource ID
|
|
11664
11998
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
11665
11999
|
* @param {number} [pageSize] The number of items to return.
|
|
11666
12000
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -11670,7 +12004,7 @@ export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Confi
|
|
|
11670
12004
|
*/
|
|
11671
12005
|
getPropertyEntries: (pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11672
12006
|
/**
|
|
11673
|
-
* Upsert property-entries for a provided resource.
|
|
12007
|
+
* Upsert property-entries for a provided resource.
|
|
11674
12008
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
11675
12009
|
* @param {*} [options] Override http request option.
|
|
11676
12010
|
* @throws {RequiredError}
|
|
@@ -11683,7 +12017,7 @@ export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Confi
|
|
|
11683
12017
|
*/
|
|
11684
12018
|
export declare const PropertyEntriesApiFp: (configuration?: Configuration | undefined) => {
|
|
11685
12019
|
/**
|
|
11686
|
-
* Get `property-entries` by a resource ID
|
|
12020
|
+
* Get `property-entries` by a resource ID
|
|
11687
12021
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
11688
12022
|
* @param {number} [pageSize] The number of items to return.
|
|
11689
12023
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -11693,7 +12027,7 @@ export declare const PropertyEntriesApiFp: (configuration?: Configuration | unde
|
|
|
11693
12027
|
*/
|
|
11694
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>>;
|
|
11695
12029
|
/**
|
|
11696
|
-
* Upsert property-entries for a provided resource.
|
|
12030
|
+
* Upsert property-entries for a provided resource.
|
|
11697
12031
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
11698
12032
|
* @param {*} [options] Override http request option.
|
|
11699
12033
|
* @throws {RequiredError}
|
|
@@ -11706,7 +12040,7 @@ export declare const PropertyEntriesApiFp: (configuration?: Configuration | unde
|
|
|
11706
12040
|
*/
|
|
11707
12041
|
export declare const PropertyEntriesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
11708
12042
|
/**
|
|
11709
|
-
* Get `property-entries` by a resource ID
|
|
12043
|
+
* Get `property-entries` by a resource ID
|
|
11710
12044
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
11711
12045
|
* @param {number} [pageSize] The number of items to return.
|
|
11712
12046
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -11716,7 +12050,7 @@ export declare const PropertyEntriesApiFactory: (configuration?: Configuration |
|
|
|
11716
12050
|
*/
|
|
11717
12051
|
getPropertyEntries(pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: any): AxiosPromise<PropertyEntryList>;
|
|
11718
12052
|
/**
|
|
11719
|
-
* Upsert property-entries for a provided resource.
|
|
12053
|
+
* Upsert property-entries for a provided resource.
|
|
11720
12054
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
11721
12055
|
* @param {*} [options] Override http request option.
|
|
11722
12056
|
* @throws {RequiredError}
|
|
@@ -11775,7 +12109,7 @@ export interface PropertyEntriesApiUpsertPropertyEntriesRequest {
|
|
|
11775
12109
|
*/
|
|
11776
12110
|
export declare class PropertyEntriesApi extends BaseAPI {
|
|
11777
12111
|
/**
|
|
11778
|
-
* Get `property-entries` by a resource ID
|
|
12112
|
+
* Get `property-entries` by a resource ID
|
|
11779
12113
|
* @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
|
|
11780
12114
|
* @param {*} [options] Override http request option.
|
|
11781
12115
|
* @throws {RequiredError}
|
|
@@ -11783,7 +12117,7 @@ export declare class PropertyEntriesApi extends BaseAPI {
|
|
|
11783
12117
|
*/
|
|
11784
12118
|
getPropertyEntries(requestParameters?: PropertyEntriesApiGetPropertyEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PropertyEntryList, any>>;
|
|
11785
12119
|
/**
|
|
11786
|
-
* Upsert property-entries for a provided resource.
|
|
12120
|
+
* Upsert property-entries for a provided resource.
|
|
11787
12121
|
* @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
|
|
11788
12122
|
* @param {*} [options] Override http request option.
|
|
11789
12123
|
* @throws {RequiredError}
|