@vertexvis/api-client-node 0.26.0 → 0.30.2
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 +630 -39
- package/dist/cjs/api.js +466 -30
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +630 -39
- package/dist/esm/api.js +454 -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
|
*
|
|
@@ -2053,6 +2135,74 @@ export interface CreateSceneViewStateRequestDataRelationships {
|
|
|
2053
2135
|
*/
|
|
2054
2136
|
source: SceneViewRelationship | SceneViewStateRelationship;
|
|
2055
2137
|
}
|
|
2138
|
+
/**
|
|
2139
|
+
*
|
|
2140
|
+
* @export
|
|
2141
|
+
* @interface CreateSearchSessionRequest
|
|
2142
|
+
*/
|
|
2143
|
+
export interface CreateSearchSessionRequest {
|
|
2144
|
+
/**
|
|
2145
|
+
*
|
|
2146
|
+
* @type {CreateSearchSessionRequestData}
|
|
2147
|
+
* @memberof CreateSearchSessionRequest
|
|
2148
|
+
*/
|
|
2149
|
+
data: CreateSearchSessionRequestData;
|
|
2150
|
+
}
|
|
2151
|
+
/**
|
|
2152
|
+
*
|
|
2153
|
+
* @export
|
|
2154
|
+
* @interface CreateSearchSessionRequestData
|
|
2155
|
+
*/
|
|
2156
|
+
export interface CreateSearchSessionRequestData {
|
|
2157
|
+
/**
|
|
2158
|
+
* Resource object type.
|
|
2159
|
+
* @type {string}
|
|
2160
|
+
* @memberof CreateSearchSessionRequestData
|
|
2161
|
+
*/
|
|
2162
|
+
type: CreateSearchSessionRequestDataTypeEnum;
|
|
2163
|
+
/**
|
|
2164
|
+
*
|
|
2165
|
+
* @type {CreateSearchSessionRequestDataAttributes}
|
|
2166
|
+
* @memberof CreateSearchSessionRequestData
|
|
2167
|
+
*/
|
|
2168
|
+
attributes: CreateSearchSessionRequestDataAttributes;
|
|
2169
|
+
/**
|
|
2170
|
+
*
|
|
2171
|
+
* @type {CreateSearchSessionRequestDataRelationships}
|
|
2172
|
+
* @memberof CreateSearchSessionRequestData
|
|
2173
|
+
*/
|
|
2174
|
+
relationships: CreateSearchSessionRequestDataRelationships;
|
|
2175
|
+
}
|
|
2176
|
+
export declare const CreateSearchSessionRequestDataTypeEnum: {
|
|
2177
|
+
readonly SearchSession: "search-session";
|
|
2178
|
+
};
|
|
2179
|
+
export declare type CreateSearchSessionRequestDataTypeEnum = (typeof CreateSearchSessionRequestDataTypeEnum)[keyof typeof CreateSearchSessionRequestDataTypeEnum];
|
|
2180
|
+
/**
|
|
2181
|
+
*
|
|
2182
|
+
* @export
|
|
2183
|
+
* @interface CreateSearchSessionRequestDataAttributes
|
|
2184
|
+
*/
|
|
2185
|
+
export interface CreateSearchSessionRequestDataAttributes {
|
|
2186
|
+
/**
|
|
2187
|
+
* Number of seconds before the search session is deleted.
|
|
2188
|
+
* @type {number}
|
|
2189
|
+
* @memberof CreateSearchSessionRequestDataAttributes
|
|
2190
|
+
*/
|
|
2191
|
+
expiry?: number;
|
|
2192
|
+
}
|
|
2193
|
+
/**
|
|
2194
|
+
*
|
|
2195
|
+
* @export
|
|
2196
|
+
* @interface CreateSearchSessionRequestDataRelationships
|
|
2197
|
+
*/
|
|
2198
|
+
export interface CreateSearchSessionRequestDataRelationships {
|
|
2199
|
+
/**
|
|
2200
|
+
*
|
|
2201
|
+
* @type {SceneRelationship}
|
|
2202
|
+
* @memberof CreateSearchSessionRequestDataRelationships
|
|
2203
|
+
*/
|
|
2204
|
+
scene?: SceneRelationship;
|
|
2205
|
+
}
|
|
2056
2206
|
/**
|
|
2057
2207
|
*
|
|
2058
2208
|
* @export
|
|
@@ -2116,7 +2266,7 @@ export interface CreateStreamKeyRequestDataAttributes {
|
|
|
2116
2266
|
*/
|
|
2117
2267
|
sceneViewStateId?: string;
|
|
2118
2268
|
/**
|
|
2119
|
-
* Optionally enables or disables the creation of a search session for the view.
|
|
2269
|
+
* Optionally enables or disables the creation of a search session for the view. The default creates a session for the scene-view
|
|
2120
2270
|
* @type {boolean}
|
|
2121
2271
|
* @memberof CreateStreamKeyRequestDataAttributes
|
|
2122
2272
|
*/
|
|
@@ -2733,6 +2883,35 @@ export interface FileIdList {
|
|
|
2733
2883
|
*/
|
|
2734
2884
|
data: Array<string>;
|
|
2735
2885
|
}
|
|
2886
|
+
/**
|
|
2887
|
+
* The operation for a file archival job.
|
|
2888
|
+
* @export
|
|
2889
|
+
* @interface FileJobArchiveOperation
|
|
2890
|
+
*/
|
|
2891
|
+
export interface FileJobArchiveOperation {
|
|
2892
|
+
/**
|
|
2893
|
+
*
|
|
2894
|
+
* @type {string}
|
|
2895
|
+
* @memberof FileJobArchiveOperation
|
|
2896
|
+
*/
|
|
2897
|
+
type: FileJobArchiveOperationTypeEnum;
|
|
2898
|
+
/**
|
|
2899
|
+
* ID of the resource.
|
|
2900
|
+
* @type {string}
|
|
2901
|
+
* @memberof FileJobArchiveOperation
|
|
2902
|
+
*/
|
|
2903
|
+
fileId: string;
|
|
2904
|
+
/**
|
|
2905
|
+
*
|
|
2906
|
+
* @type {Array<ArchiveManifestEntry>}
|
|
2907
|
+
* @memberof FileJobArchiveOperation
|
|
2908
|
+
*/
|
|
2909
|
+
manifest: Array<ArchiveManifestEntry>;
|
|
2910
|
+
}
|
|
2911
|
+
export declare const FileJobArchiveOperationTypeEnum: {
|
|
2912
|
+
readonly FileArchiveOperation: "file-archive-operation";
|
|
2913
|
+
};
|
|
2914
|
+
export declare type FileJobArchiveOperationTypeEnum = (typeof FileJobArchiveOperationTypeEnum)[keyof typeof FileJobArchiveOperationTypeEnum];
|
|
2736
2915
|
/**
|
|
2737
2916
|
*
|
|
2738
2917
|
* @export
|
|
@@ -2943,6 +3122,12 @@ export interface FilterExpression {
|
|
|
2943
3122
|
* @memberof FilterExpression
|
|
2944
3123
|
*/
|
|
2945
3124
|
lte?: string;
|
|
3125
|
+
/**
|
|
3126
|
+
* A value of a filter.
|
|
3127
|
+
* @type {string}
|
|
3128
|
+
* @memberof FilterExpression
|
|
3129
|
+
*/
|
|
3130
|
+
contains?: string;
|
|
2946
3131
|
}
|
|
2947
3132
|
/**
|
|
2948
3133
|
*
|
|
@@ -3638,9 +3823,10 @@ export interface PartAssemblyRelationshipData {
|
|
|
3638
3823
|
*/
|
|
3639
3824
|
children: Array<PartRevisionInstance>;
|
|
3640
3825
|
/**
|
|
3641
|
-
* Additional metadata about the `part` and/or `part-revision`.
|
|
3826
|
+
* Additional metadata about the `part` and/or `part-revision`. This has been deprecated and replaced by the PATCH endpoint /property-entries
|
|
3642
3827
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
3643
3828
|
* @memberof PartAssemblyRelationshipData
|
|
3829
|
+
* @deprecated
|
|
3644
3830
|
*/
|
|
3645
3831
|
metadata?: {
|
|
3646
3832
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -4060,9 +4246,10 @@ export interface PartRevisionDataAttributes {
|
|
|
4060
4246
|
*/
|
|
4061
4247
|
created?: string;
|
|
4062
4248
|
/**
|
|
4063
|
-
*
|
|
4249
|
+
* This has been deprecated and replaced by the GET endpoint /property-entries
|
|
4064
4250
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
4065
4251
|
* @memberof PartRevisionDataAttributes
|
|
4252
|
+
* @deprecated
|
|
4066
4253
|
*/
|
|
4067
4254
|
metadata?: {
|
|
4068
4255
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -5559,6 +5746,12 @@ export interface SceneDataAttributes {
|
|
|
5559
5746
|
* @memberof SceneDataAttributes
|
|
5560
5747
|
*/
|
|
5561
5748
|
sceneItemCount?: number;
|
|
5749
|
+
/**
|
|
5750
|
+
*
|
|
5751
|
+
* @type {string}
|
|
5752
|
+
* @memberof SceneDataAttributes
|
|
5753
|
+
*/
|
|
5754
|
+
expiresAt?: string;
|
|
5562
5755
|
/**
|
|
5563
5756
|
* 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
5757
|
* @type {{ [key: string]: string; }}
|
|
@@ -5659,9 +5852,10 @@ export interface SceneItemDataAttributes {
|
|
|
5659
5852
|
*/
|
|
5660
5853
|
materialOverride?: ColorMaterial;
|
|
5661
5854
|
/**
|
|
5662
|
-
*
|
|
5855
|
+
* This has been deprecated and replaced by the GET endpoint /property-entries
|
|
5663
5856
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
5664
5857
|
* @memberof SceneItemDataAttributes
|
|
5858
|
+
* @deprecated
|
|
5665
5859
|
*/
|
|
5666
5860
|
metadata?: {
|
|
5667
5861
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -6539,6 +6733,79 @@ export declare const SceneViewStateRelationshipDataTypeEnum: {
|
|
|
6539
6733
|
readonly SceneViewState: "scene-view-state";
|
|
6540
6734
|
};
|
|
6541
6735
|
export declare type SceneViewStateRelationshipDataTypeEnum = (typeof SceneViewStateRelationshipDataTypeEnum)[keyof typeof SceneViewStateRelationshipDataTypeEnum];
|
|
6736
|
+
/**
|
|
6737
|
+
*
|
|
6738
|
+
* @export
|
|
6739
|
+
* @interface SearchSession
|
|
6740
|
+
*/
|
|
6741
|
+
export interface SearchSession {
|
|
6742
|
+
/**
|
|
6743
|
+
*
|
|
6744
|
+
* @type {SearchSessionData}
|
|
6745
|
+
* @memberof SearchSession
|
|
6746
|
+
*/
|
|
6747
|
+
data: SearchSessionData;
|
|
6748
|
+
/**
|
|
6749
|
+
*
|
|
6750
|
+
* @type {{ [key: string]: Link; }}
|
|
6751
|
+
* @memberof SearchSession
|
|
6752
|
+
*/
|
|
6753
|
+
links?: {
|
|
6754
|
+
[key: string]: Link;
|
|
6755
|
+
};
|
|
6756
|
+
}
|
|
6757
|
+
/**
|
|
6758
|
+
*
|
|
6759
|
+
* @export
|
|
6760
|
+
* @interface SearchSessionData
|
|
6761
|
+
*/
|
|
6762
|
+
export interface SearchSessionData {
|
|
6763
|
+
/**
|
|
6764
|
+
*
|
|
6765
|
+
* @type {string}
|
|
6766
|
+
* @memberof SearchSessionData
|
|
6767
|
+
*/
|
|
6768
|
+
type: string;
|
|
6769
|
+
/**
|
|
6770
|
+
* ID of the resource.
|
|
6771
|
+
* @type {string}
|
|
6772
|
+
* @memberof SearchSessionData
|
|
6773
|
+
*/
|
|
6774
|
+
id: string;
|
|
6775
|
+
/**
|
|
6776
|
+
*
|
|
6777
|
+
* @type {SearchSessionDataAttributes}
|
|
6778
|
+
* @memberof SearchSessionData
|
|
6779
|
+
*/
|
|
6780
|
+
attributes: SearchSessionDataAttributes;
|
|
6781
|
+
/**
|
|
6782
|
+
*
|
|
6783
|
+
* @type {SceneViewDataRelationships}
|
|
6784
|
+
* @memberof SearchSessionData
|
|
6785
|
+
*/
|
|
6786
|
+
relationships?: SceneViewDataRelationships;
|
|
6787
|
+
/**
|
|
6788
|
+
*
|
|
6789
|
+
* @type {{ [key: string]: Link; }}
|
|
6790
|
+
* @memberof SearchSessionData
|
|
6791
|
+
*/
|
|
6792
|
+
links?: {
|
|
6793
|
+
[key: string]: Link;
|
|
6794
|
+
};
|
|
6795
|
+
}
|
|
6796
|
+
/**
|
|
6797
|
+
*
|
|
6798
|
+
* @export
|
|
6799
|
+
* @interface SearchSessionDataAttributes
|
|
6800
|
+
*/
|
|
6801
|
+
export interface SearchSessionDataAttributes {
|
|
6802
|
+
/**
|
|
6803
|
+
*
|
|
6804
|
+
* @type {string}
|
|
6805
|
+
* @memberof SearchSessionDataAttributes
|
|
6806
|
+
*/
|
|
6807
|
+
status: string;
|
|
6808
|
+
}
|
|
6542
6809
|
/**
|
|
6543
6810
|
*
|
|
6544
6811
|
* @export
|
|
@@ -6558,6 +6825,52 @@ export interface SectionPlane {
|
|
|
6558
6825
|
*/
|
|
6559
6826
|
offset: number;
|
|
6560
6827
|
}
|
|
6828
|
+
/**
|
|
6829
|
+
* Queries a file by its unique ID.
|
|
6830
|
+
* @export
|
|
6831
|
+
* @interface SelectFileById
|
|
6832
|
+
*/
|
|
6833
|
+
export interface SelectFileById {
|
|
6834
|
+
/**
|
|
6835
|
+
*
|
|
6836
|
+
* @type {string}
|
|
6837
|
+
* @memberof SelectFileById
|
|
6838
|
+
*/
|
|
6839
|
+
type: SelectFileByIdTypeEnum;
|
|
6840
|
+
/**
|
|
6841
|
+
* ID of the resource.
|
|
6842
|
+
* @type {string}
|
|
6843
|
+
* @memberof SelectFileById
|
|
6844
|
+
*/
|
|
6845
|
+
id: string;
|
|
6846
|
+
}
|
|
6847
|
+
export declare const SelectFileByIdTypeEnum: {
|
|
6848
|
+
readonly FileById: "file-by-id";
|
|
6849
|
+
};
|
|
6850
|
+
export declare type SelectFileByIdTypeEnum = (typeof SelectFileByIdTypeEnum)[keyof typeof SelectFileByIdTypeEnum];
|
|
6851
|
+
/**
|
|
6852
|
+
* Queries a file by its supplied ID.
|
|
6853
|
+
* @export
|
|
6854
|
+
* @interface SelectFileBySuppliedId
|
|
6855
|
+
*/
|
|
6856
|
+
export interface SelectFileBySuppliedId {
|
|
6857
|
+
/**
|
|
6858
|
+
*
|
|
6859
|
+
* @type {string}
|
|
6860
|
+
* @memberof SelectFileBySuppliedId
|
|
6861
|
+
*/
|
|
6862
|
+
type: SelectFileBySuppliedIdTypeEnum;
|
|
6863
|
+
/**
|
|
6864
|
+
*
|
|
6865
|
+
* @type {string}
|
|
6866
|
+
* @memberof SelectFileBySuppliedId
|
|
6867
|
+
*/
|
|
6868
|
+
id: string;
|
|
6869
|
+
}
|
|
6870
|
+
export declare const SelectFileBySuppliedIdTypeEnum: {
|
|
6871
|
+
readonly FileBySuppliedId: "file-by-supplied-id";
|
|
6872
|
+
};
|
|
6873
|
+
export declare type SelectFileBySuppliedIdTypeEnum = (typeof SelectFileBySuppliedIdTypeEnum)[keyof typeof SelectFileBySuppliedIdTypeEnum];
|
|
6561
6874
|
/**
|
|
6562
6875
|
*
|
|
6563
6876
|
* @export
|
|
@@ -7070,9 +7383,10 @@ export interface UpdatePartRevisionRequestData {
|
|
|
7070
7383
|
*/
|
|
7071
7384
|
export interface UpdatePartRevisionRequestDataAttributes {
|
|
7072
7385
|
/**
|
|
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.
|
|
7386
|
+
* 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
7387
|
* @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
|
|
7075
7388
|
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
7389
|
+
* @deprecated
|
|
7076
7390
|
*/
|
|
7077
7391
|
metadata?: {
|
|
7078
7392
|
[key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
|
|
@@ -7441,6 +7755,12 @@ export interface UpdateSceneRequestDataAttributes {
|
|
|
7441
7755
|
* @memberof UpdateSceneRequestDataAttributes
|
|
7442
7756
|
*/
|
|
7443
7757
|
worldOrientation?: Orientation;
|
|
7758
|
+
/**
|
|
7759
|
+
* Number of seconds before expiration
|
|
7760
|
+
* @type {number}
|
|
7761
|
+
* @memberof UpdateSceneRequestDataAttributes
|
|
7762
|
+
*/
|
|
7763
|
+
expiry?: number;
|
|
7444
7764
|
/**
|
|
7445
7765
|
* 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
7766
|
* @type {{ [key: string]: string; }}
|
|
@@ -9134,6 +9454,14 @@ export declare const FileCollectionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
9134
9454
|
* @throws {RequiredError}
|
|
9135
9455
|
*/
|
|
9136
9456
|
listFileCollections: (pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9457
|
+
/**
|
|
9458
|
+
* Remove a file from a `file-collection`.
|
|
9459
|
+
* @param {string} id The `file-collection` ID.
|
|
9460
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
9461
|
+
* @param {*} [options] Override http request option.
|
|
9462
|
+
* @throws {RequiredError}
|
|
9463
|
+
*/
|
|
9464
|
+
removeFileCollectionFiles: (id: string, filterFileId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9137
9465
|
/**
|
|
9138
9466
|
* Update a `file-collection`.
|
|
9139
9467
|
* @param {string} id The `file-collection` ID.
|
|
@@ -9195,6 +9523,14 @@ export declare const FileCollectionsApiFp: (configuration?: Configuration | unde
|
|
|
9195
9523
|
* @throws {RequiredError}
|
|
9196
9524
|
*/
|
|
9197
9525
|
listFileCollections(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionList>>;
|
|
9526
|
+
/**
|
|
9527
|
+
* Remove a file from a `file-collection`.
|
|
9528
|
+
* @param {string} id The `file-collection` ID.
|
|
9529
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
9530
|
+
* @param {*} [options] Override http request option.
|
|
9531
|
+
* @throws {RequiredError}
|
|
9532
|
+
*/
|
|
9533
|
+
removeFileCollectionFiles(id: string, filterFileId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
9198
9534
|
/**
|
|
9199
9535
|
* Update a `file-collection`.
|
|
9200
9536
|
* @param {string} id The `file-collection` ID.
|
|
@@ -9256,6 +9592,14 @@ export declare const FileCollectionsApiFactory: (configuration?: Configuration |
|
|
|
9256
9592
|
* @throws {RequiredError}
|
|
9257
9593
|
*/
|
|
9258
9594
|
listFileCollections(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<FileCollectionList>;
|
|
9595
|
+
/**
|
|
9596
|
+
* Remove a file from a `file-collection`.
|
|
9597
|
+
* @param {string} id The `file-collection` ID.
|
|
9598
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
9599
|
+
* @param {*} [options] Override http request option.
|
|
9600
|
+
* @throws {RequiredError}
|
|
9601
|
+
*/
|
|
9602
|
+
removeFileCollectionFiles(id: string, filterFileId?: string | undefined, options?: any): AxiosPromise<void>;
|
|
9259
9603
|
/**
|
|
9260
9604
|
* Update a `file-collection`.
|
|
9261
9605
|
* @param {string} id The `file-collection` ID.
|
|
@@ -9373,6 +9717,25 @@ export interface FileCollectionsApiListFileCollectionsRequest {
|
|
|
9373
9717
|
*/
|
|
9374
9718
|
readonly filterSuppliedId?: string;
|
|
9375
9719
|
}
|
|
9720
|
+
/**
|
|
9721
|
+
* Request parameters for removeFileCollectionFiles operation in FileCollectionsApi.
|
|
9722
|
+
* @export
|
|
9723
|
+
* @interface FileCollectionsApiRemoveFileCollectionFilesRequest
|
|
9724
|
+
*/
|
|
9725
|
+
export interface FileCollectionsApiRemoveFileCollectionFilesRequest {
|
|
9726
|
+
/**
|
|
9727
|
+
* The `file-collection` ID.
|
|
9728
|
+
* @type {string}
|
|
9729
|
+
* @memberof FileCollectionsApiRemoveFileCollectionFiles
|
|
9730
|
+
*/
|
|
9731
|
+
readonly id: string;
|
|
9732
|
+
/**
|
|
9733
|
+
* Comma-separated list of file-ids to filter on.
|
|
9734
|
+
* @type {string}
|
|
9735
|
+
* @memberof FileCollectionsApiRemoveFileCollectionFiles
|
|
9736
|
+
*/
|
|
9737
|
+
readonly filterFileId?: string;
|
|
9738
|
+
}
|
|
9376
9739
|
/**
|
|
9377
9740
|
* Request parameters for updateFileCollection operation in FileCollectionsApi.
|
|
9378
9741
|
* @export
|
|
@@ -9447,6 +9810,14 @@ export declare class FileCollectionsApi extends BaseAPI {
|
|
|
9447
9810
|
* @memberof FileCollectionsApi
|
|
9448
9811
|
*/
|
|
9449
9812
|
listFileCollections(requestParameters?: FileCollectionsApiListFileCollectionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionList, any>>;
|
|
9813
|
+
/**
|
|
9814
|
+
* Remove a file from a `file-collection`.
|
|
9815
|
+
* @param {FileCollectionsApiRemoveFileCollectionFilesRequest} requestParameters Request parameters.
|
|
9816
|
+
* @param {*} [options] Override http request option.
|
|
9817
|
+
* @throws {RequiredError}
|
|
9818
|
+
* @memberof FileCollectionsApi
|
|
9819
|
+
*/
|
|
9820
|
+
removeFileCollectionFiles(requestParameters: FileCollectionsApiRemoveFileCollectionFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9450
9821
|
/**
|
|
9451
9822
|
* Update a `file-collection`.
|
|
9452
9823
|
* @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
|
|
@@ -9456,6 +9827,116 @@ export declare class FileCollectionsApi extends BaseAPI {
|
|
|
9456
9827
|
*/
|
|
9457
9828
|
updateFileCollection(requestParameters: FileCollectionsApiUpdateFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9458
9829
|
}
|
|
9830
|
+
/**
|
|
9831
|
+
* FileJobsApi - axios parameter creator
|
|
9832
|
+
* @export
|
|
9833
|
+
*/
|
|
9834
|
+
export declare const FileJobsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9835
|
+
/**
|
|
9836
|
+
* Create a `file-job`.
|
|
9837
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
9838
|
+
* @param {*} [options] Override http request option.
|
|
9839
|
+
* @throws {RequiredError}
|
|
9840
|
+
*/
|
|
9841
|
+
createFileJob: (createFileJobRequest: CreateFileJobRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9842
|
+
/**
|
|
9843
|
+
* Get the status and result of a `file-job`.
|
|
9844
|
+
* @param {string} id The ID of a file job.
|
|
9845
|
+
* @param {*} [options] Override http request option.
|
|
9846
|
+
* @throws {RequiredError}
|
|
9847
|
+
*/
|
|
9848
|
+
getFileJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9849
|
+
};
|
|
9850
|
+
/**
|
|
9851
|
+
* FileJobsApi - functional programming interface
|
|
9852
|
+
* @export
|
|
9853
|
+
*/
|
|
9854
|
+
export declare const FileJobsApiFp: (configuration?: Configuration | undefined) => {
|
|
9855
|
+
/**
|
|
9856
|
+
* Create a `file-job`.
|
|
9857
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
9858
|
+
* @param {*} [options] Override http request option.
|
|
9859
|
+
* @throws {RequiredError}
|
|
9860
|
+
*/
|
|
9861
|
+
createFileJob(createFileJobRequest: CreateFileJobRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
|
|
9862
|
+
/**
|
|
9863
|
+
* Get the status and result of a `file-job`.
|
|
9864
|
+
* @param {string} id The ID of a file job.
|
|
9865
|
+
* @param {*} [options] Override http request option.
|
|
9866
|
+
* @throws {RequiredError}
|
|
9867
|
+
*/
|
|
9868
|
+
getFileJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
|
|
9869
|
+
};
|
|
9870
|
+
/**
|
|
9871
|
+
* FileJobsApi - factory interface
|
|
9872
|
+
* @export
|
|
9873
|
+
*/
|
|
9874
|
+
export declare const FileJobsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9875
|
+
/**
|
|
9876
|
+
* Create a `file-job`.
|
|
9877
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
9878
|
+
* @param {*} [options] Override http request option.
|
|
9879
|
+
* @throws {RequiredError}
|
|
9880
|
+
*/
|
|
9881
|
+
createFileJob(createFileJobRequest: CreateFileJobRequest, options?: any): AxiosPromise<QueuedJob>;
|
|
9882
|
+
/**
|
|
9883
|
+
* Get the status and result of a `file-job`.
|
|
9884
|
+
* @param {string} id The ID of a file job.
|
|
9885
|
+
* @param {*} [options] Override http request option.
|
|
9886
|
+
* @throws {RequiredError}
|
|
9887
|
+
*/
|
|
9888
|
+
getFileJob(id: string, options?: any): AxiosPromise<QueuedJob>;
|
|
9889
|
+
};
|
|
9890
|
+
/**
|
|
9891
|
+
* Request parameters for createFileJob operation in FileJobsApi.
|
|
9892
|
+
* @export
|
|
9893
|
+
* @interface FileJobsApiCreateFileJobRequest
|
|
9894
|
+
*/
|
|
9895
|
+
export interface FileJobsApiCreateFileJobRequest {
|
|
9896
|
+
/**
|
|
9897
|
+
*
|
|
9898
|
+
* @type {CreateFileJobRequest}
|
|
9899
|
+
* @memberof FileJobsApiCreateFileJob
|
|
9900
|
+
*/
|
|
9901
|
+
readonly createFileJobRequest: CreateFileJobRequest;
|
|
9902
|
+
}
|
|
9903
|
+
/**
|
|
9904
|
+
* Request parameters for getFileJob operation in FileJobsApi.
|
|
9905
|
+
* @export
|
|
9906
|
+
* @interface FileJobsApiGetFileJobRequest
|
|
9907
|
+
*/
|
|
9908
|
+
export interface FileJobsApiGetFileJobRequest {
|
|
9909
|
+
/**
|
|
9910
|
+
* The ID of a file job.
|
|
9911
|
+
* @type {string}
|
|
9912
|
+
* @memberof FileJobsApiGetFileJob
|
|
9913
|
+
*/
|
|
9914
|
+
readonly id: string;
|
|
9915
|
+
}
|
|
9916
|
+
/**
|
|
9917
|
+
* FileJobsApi - object-oriented interface
|
|
9918
|
+
* @export
|
|
9919
|
+
* @class FileJobsApi
|
|
9920
|
+
* @extends {BaseAPI}
|
|
9921
|
+
*/
|
|
9922
|
+
export declare class FileJobsApi extends BaseAPI {
|
|
9923
|
+
/**
|
|
9924
|
+
* Create a `file-job`.
|
|
9925
|
+
* @param {FileJobsApiCreateFileJobRequest} requestParameters Request parameters.
|
|
9926
|
+
* @param {*} [options] Override http request option.
|
|
9927
|
+
* @throws {RequiredError}
|
|
9928
|
+
* @memberof FileJobsApi
|
|
9929
|
+
*/
|
|
9930
|
+
createFileJob(requestParameters: FileJobsApiCreateFileJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
|
|
9931
|
+
/**
|
|
9932
|
+
* Get the status and result of a `file-job`.
|
|
9933
|
+
* @param {FileJobsApiGetFileJobRequest} requestParameters Request parameters.
|
|
9934
|
+
* @param {*} [options] Override http request option.
|
|
9935
|
+
* @throws {RequiredError}
|
|
9936
|
+
* @memberof FileJobsApi
|
|
9937
|
+
*/
|
|
9938
|
+
getFileJob(requestParameters: FileJobsApiGetFileJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
|
|
9939
|
+
}
|
|
9459
9940
|
/**
|
|
9460
9941
|
* FilesApi - axios parameter creator
|
|
9461
9942
|
* @export
|
|
@@ -10606,7 +11087,7 @@ export declare class Oauth2Api extends BaseAPI {
|
|
|
10606
11087
|
*/
|
|
10607
11088
|
export declare const PartRenditionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
10608
11089
|
/**
|
|
10609
|
-
*
|
|
11090
|
+
* Creates a part-rendition associated with a part-revision
|
|
10610
11091
|
* @param {string} id The `part-revision` ID.
|
|
10611
11092
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
10612
11093
|
* @param {*} [options] Override http request option.
|
|
@@ -10637,7 +11118,7 @@ export declare const PartRenditionsApiAxiosParamCreator: (configuration?: Config
|
|
|
10637
11118
|
*/
|
|
10638
11119
|
export declare const PartRenditionsApiFp: (configuration?: Configuration | undefined) => {
|
|
10639
11120
|
/**
|
|
10640
|
-
*
|
|
11121
|
+
* Creates a part-rendition associated with a part-revision
|
|
10641
11122
|
* @param {string} id The `part-revision` ID.
|
|
10642
11123
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
10643
11124
|
* @param {*} [options] Override http request option.
|
|
@@ -10668,7 +11149,7 @@ export declare const PartRenditionsApiFp: (configuration?: Configuration | undef
|
|
|
10668
11149
|
*/
|
|
10669
11150
|
export declare const PartRenditionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
10670
11151
|
/**
|
|
10671
|
-
*
|
|
11152
|
+
* Creates a part-rendition associated with a part-revision
|
|
10672
11153
|
* @param {string} id The `part-revision` ID.
|
|
10673
11154
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
10674
11155
|
* @param {*} [options] Override http request option.
|
|
@@ -10764,7 +11245,7 @@ export interface PartRenditionsApiGetPartRenditionsRequest {
|
|
|
10764
11245
|
*/
|
|
10765
11246
|
export declare class PartRenditionsApi extends BaseAPI {
|
|
10766
11247
|
/**
|
|
10767
|
-
*
|
|
11248
|
+
* Creates a part-rendition associated with a part-revision
|
|
10768
11249
|
* @param {PartRenditionsApiCreatePartRenditionRequest} requestParameters Request parameters.
|
|
10769
11250
|
* @param {*} [options] Override http request option.
|
|
10770
11251
|
* @throws {RequiredError}
|
|
@@ -10794,7 +11275,7 @@ export declare class PartRenditionsApi extends BaseAPI {
|
|
|
10794
11275
|
*/
|
|
10795
11276
|
export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
10796
11277
|
/**
|
|
10797
|
-
* Gets a page of \'part-revision\' instances. An instance is an
|
|
11278
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurrence 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
11279
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
10799
11280
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10800
11281
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -10809,7 +11290,7 @@ export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?:
|
|
|
10809
11290
|
*/
|
|
10810
11291
|
export declare const PartRevisionInstancesApiFp: (configuration?: Configuration | undefined) => {
|
|
10811
11292
|
/**
|
|
10812
|
-
* Gets a page of \'part-revision\' instances. An instance is an
|
|
11293
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurrence 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
11294
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
10814
11295
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10815
11296
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -10824,7 +11305,7 @@ export declare const PartRevisionInstancesApiFp: (configuration?: Configuration
|
|
|
10824
11305
|
*/
|
|
10825
11306
|
export declare const PartRevisionInstancesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
10826
11307
|
/**
|
|
10827
|
-
* Gets a page of \'part-revision\' instances. An instance is an
|
|
11308
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurrence 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
11309
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
10829
11310
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10830
11311
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -10866,7 +11347,7 @@ export interface PartRevisionInstancesApiGetPartRevisionInstanceListRequest {
|
|
|
10866
11347
|
*/
|
|
10867
11348
|
export declare class PartRevisionInstancesApi extends BaseAPI {
|
|
10868
11349
|
/**
|
|
10869
|
-
* Gets a page of \'part-revision\' instances. An instance is an
|
|
11350
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurrence 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
11351
|
* @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
|
|
10871
11352
|
* @param {*} [options] Override http request option.
|
|
10872
11353
|
* @throws {RequiredError}
|
|
@@ -10931,7 +11412,7 @@ export declare const PartRevisionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
10931
11412
|
*/
|
|
10932
11413
|
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
11414
|
/**
|
|
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.
|
|
11415
|
+
* 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
11416
|
* @param {string} id The `part-revision` ID.
|
|
10936
11417
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
10937
11418
|
* @param {*} [options] Override http request option.
|
|
@@ -10996,7 +11477,7 @@ export declare const PartRevisionsApiFp: (configuration?: Configuration | undefi
|
|
|
10996
11477
|
*/
|
|
10997
11478
|
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
11479
|
/**
|
|
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.
|
|
11480
|
+
* 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
11481
|
* @param {string} id The `part-revision` ID.
|
|
11001
11482
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
11002
11483
|
* @param {*} [options] Override http request option.
|
|
@@ -11061,7 +11542,7 @@ export declare const PartRevisionsApiFactory: (configuration?: Configuration | u
|
|
|
11061
11542
|
*/
|
|
11062
11543
|
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
11544
|
/**
|
|
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.
|
|
11545
|
+
* 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
11546
|
* @param {string} id The `part-revision` ID.
|
|
11066
11547
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
11067
11548
|
* @param {*} [options] Override http request option.
|
|
@@ -11297,7 +11778,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
11297
11778
|
*/
|
|
11298
11779
|
renderPartRevision(requestParameters: PartRevisionsApiRenderPartRevisionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
11299
11780
|
/**
|
|
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.
|
|
11781
|
+
* 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
11782
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
11302
11783
|
* @param {*} [options] Override http request option.
|
|
11303
11784
|
* @throws {RequiredError}
|
|
@@ -11311,7 +11792,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
11311
11792
|
*/
|
|
11312
11793
|
export declare const PartsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
11313
11794
|
/**
|
|
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`
|
|
11795
|
+
* 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
11796
|
* @param {CreatePartRequest} createPartRequest
|
|
11316
11797
|
* @param {*} [options] Override http request option.
|
|
11317
11798
|
* @throws {RequiredError}
|
|
@@ -11355,7 +11836,7 @@ export declare const PartsApiAxiosParamCreator: (configuration?: Configuration |
|
|
|
11355
11836
|
*/
|
|
11356
11837
|
export declare const PartsApiFp: (configuration?: Configuration | undefined) => {
|
|
11357
11838
|
/**
|
|
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`
|
|
11839
|
+
* 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
11840
|
* @param {CreatePartRequest} createPartRequest
|
|
11360
11841
|
* @param {*} [options] Override http request option.
|
|
11361
11842
|
* @throws {RequiredError}
|
|
@@ -11399,7 +11880,7 @@ export declare const PartsApiFp: (configuration?: Configuration | undefined) =>
|
|
|
11399
11880
|
*/
|
|
11400
11881
|
export declare const PartsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
11401
11882
|
/**
|
|
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`
|
|
11883
|
+
* 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
11884
|
* @param {CreatePartRequest} createPartRequest
|
|
11404
11885
|
* @param {*} [options] Override http request option.
|
|
11405
11886
|
* @throws {RequiredError}
|
|
@@ -11528,7 +12009,7 @@ export interface PartsApiGetQueuedPartDeletionRequest {
|
|
|
11528
12009
|
*/
|
|
11529
12010
|
export declare class PartsApi extends BaseAPI {
|
|
11530
12011
|
/**
|
|
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`
|
|
12012
|
+
* 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
12013
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
11533
12014
|
* @param {*} [options] Override http request option.
|
|
11534
12015
|
* @throws {RequiredError}
|
|
@@ -11660,7 +12141,7 @@ export declare class PmiApi extends BaseAPI {
|
|
|
11660
12141
|
*/
|
|
11661
12142
|
export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
11662
12143
|
/**
|
|
11663
|
-
* Get `property-entries` by a resource ID
|
|
12144
|
+
* Get `property-entries` by a resource ID
|
|
11664
12145
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
11665
12146
|
* @param {number} [pageSize] The number of items to return.
|
|
11666
12147
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -11670,7 +12151,7 @@ export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Confi
|
|
|
11670
12151
|
*/
|
|
11671
12152
|
getPropertyEntries: (pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11672
12153
|
/**
|
|
11673
|
-
* Upsert property-entries for a provided resource.
|
|
12154
|
+
* Upsert property-entries for a provided resource.
|
|
11674
12155
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
11675
12156
|
* @param {*} [options] Override http request option.
|
|
11676
12157
|
* @throws {RequiredError}
|
|
@@ -11683,7 +12164,7 @@ export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Confi
|
|
|
11683
12164
|
*/
|
|
11684
12165
|
export declare const PropertyEntriesApiFp: (configuration?: Configuration | undefined) => {
|
|
11685
12166
|
/**
|
|
11686
|
-
* Get `property-entries` by a resource ID
|
|
12167
|
+
* Get `property-entries` by a resource ID
|
|
11687
12168
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
11688
12169
|
* @param {number} [pageSize] The number of items to return.
|
|
11689
12170
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -11693,7 +12174,7 @@ export declare const PropertyEntriesApiFp: (configuration?: Configuration | unde
|
|
|
11693
12174
|
*/
|
|
11694
12175
|
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
12176
|
/**
|
|
11696
|
-
* Upsert property-entries for a provided resource.
|
|
12177
|
+
* Upsert property-entries for a provided resource.
|
|
11697
12178
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
11698
12179
|
* @param {*} [options] Override http request option.
|
|
11699
12180
|
* @throws {RequiredError}
|
|
@@ -11706,7 +12187,7 @@ export declare const PropertyEntriesApiFp: (configuration?: Configuration | unde
|
|
|
11706
12187
|
*/
|
|
11707
12188
|
export declare const PropertyEntriesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
11708
12189
|
/**
|
|
11709
|
-
* Get `property-entries` by a resource ID
|
|
12190
|
+
* Get `property-entries` by a resource ID
|
|
11710
12191
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
11711
12192
|
* @param {number} [pageSize] The number of items to return.
|
|
11712
12193
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -11716,7 +12197,7 @@ export declare const PropertyEntriesApiFactory: (configuration?: Configuration |
|
|
|
11716
12197
|
*/
|
|
11717
12198
|
getPropertyEntries(pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: any): AxiosPromise<PropertyEntryList>;
|
|
11718
12199
|
/**
|
|
11719
|
-
* Upsert property-entries for a provided resource.
|
|
12200
|
+
* Upsert property-entries for a provided resource.
|
|
11720
12201
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
11721
12202
|
* @param {*} [options] Override http request option.
|
|
11722
12203
|
* @throws {RequiredError}
|
|
@@ -11775,7 +12256,7 @@ export interface PropertyEntriesApiUpsertPropertyEntriesRequest {
|
|
|
11775
12256
|
*/
|
|
11776
12257
|
export declare class PropertyEntriesApi extends BaseAPI {
|
|
11777
12258
|
/**
|
|
11778
|
-
* Get `property-entries` by a resource ID
|
|
12259
|
+
* Get `property-entries` by a resource ID
|
|
11779
12260
|
* @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
|
|
11780
12261
|
* @param {*} [options] Override http request option.
|
|
11781
12262
|
* @throws {RequiredError}
|
|
@@ -11783,7 +12264,7 @@ export declare class PropertyEntriesApi extends BaseAPI {
|
|
|
11783
12264
|
*/
|
|
11784
12265
|
getPropertyEntries(requestParameters?: PropertyEntriesApiGetPropertyEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PropertyEntryList, any>>;
|
|
11785
12266
|
/**
|
|
11786
|
-
* Upsert property-entries for a provided resource.
|
|
12267
|
+
* Upsert property-entries for a provided resource.
|
|
11787
12268
|
* @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
|
|
11788
12269
|
* @param {*} [options] Override http request option.
|
|
11789
12270
|
* @throws {RequiredError}
|
|
@@ -14290,6 +14771,116 @@ export declare class ScenesApi extends BaseAPI {
|
|
|
14290
14771
|
*/
|
|
14291
14772
|
updateScene(requestParameters: ScenesApiUpdateSceneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scene, any>>;
|
|
14292
14773
|
}
|
|
14774
|
+
/**
|
|
14775
|
+
* SearchSessionsApi - axios parameter creator
|
|
14776
|
+
* @export
|
|
14777
|
+
*/
|
|
14778
|
+
export declare const SearchSessionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
14779
|
+
/**
|
|
14780
|
+
* Create a `search-session`.
|
|
14781
|
+
* @param {CreateSearchSessionRequest} createSearchSessionRequest
|
|
14782
|
+
* @param {*} [options] Override http request option.
|
|
14783
|
+
* @throws {RequiredError}
|
|
14784
|
+
*/
|
|
14785
|
+
createSearchSession: (createSearchSessionRequest: CreateSearchSessionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14786
|
+
/**
|
|
14787
|
+
* Get a `search-session`.
|
|
14788
|
+
* @param {string} id The `search-session` ID.
|
|
14789
|
+
* @param {*} [options] Override http request option.
|
|
14790
|
+
* @throws {RequiredError}
|
|
14791
|
+
*/
|
|
14792
|
+
getSearchSession: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14793
|
+
};
|
|
14794
|
+
/**
|
|
14795
|
+
* SearchSessionsApi - functional programming interface
|
|
14796
|
+
* @export
|
|
14797
|
+
*/
|
|
14798
|
+
export declare const SearchSessionsApiFp: (configuration?: Configuration | undefined) => {
|
|
14799
|
+
/**
|
|
14800
|
+
* Create a `search-session`.
|
|
14801
|
+
* @param {CreateSearchSessionRequest} createSearchSessionRequest
|
|
14802
|
+
* @param {*} [options] Override http request option.
|
|
14803
|
+
* @throws {RequiredError}
|
|
14804
|
+
*/
|
|
14805
|
+
createSearchSession(createSearchSessionRequest: CreateSearchSessionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SearchSession>>;
|
|
14806
|
+
/**
|
|
14807
|
+
* Get a `search-session`.
|
|
14808
|
+
* @param {string} id The `search-session` ID.
|
|
14809
|
+
* @param {*} [options] Override http request option.
|
|
14810
|
+
* @throws {RequiredError}
|
|
14811
|
+
*/
|
|
14812
|
+
getSearchSession(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SearchSession>>;
|
|
14813
|
+
};
|
|
14814
|
+
/**
|
|
14815
|
+
* SearchSessionsApi - factory interface
|
|
14816
|
+
* @export
|
|
14817
|
+
*/
|
|
14818
|
+
export declare const SearchSessionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
14819
|
+
/**
|
|
14820
|
+
* Create a `search-session`.
|
|
14821
|
+
* @param {CreateSearchSessionRequest} createSearchSessionRequest
|
|
14822
|
+
* @param {*} [options] Override http request option.
|
|
14823
|
+
* @throws {RequiredError}
|
|
14824
|
+
*/
|
|
14825
|
+
createSearchSession(createSearchSessionRequest: CreateSearchSessionRequest, options?: any): AxiosPromise<SearchSession>;
|
|
14826
|
+
/**
|
|
14827
|
+
* Get a `search-session`.
|
|
14828
|
+
* @param {string} id The `search-session` ID.
|
|
14829
|
+
* @param {*} [options] Override http request option.
|
|
14830
|
+
* @throws {RequiredError}
|
|
14831
|
+
*/
|
|
14832
|
+
getSearchSession(id: string, options?: any): AxiosPromise<SearchSession>;
|
|
14833
|
+
};
|
|
14834
|
+
/**
|
|
14835
|
+
* Request parameters for createSearchSession operation in SearchSessionsApi.
|
|
14836
|
+
* @export
|
|
14837
|
+
* @interface SearchSessionsApiCreateSearchSessionRequest
|
|
14838
|
+
*/
|
|
14839
|
+
export interface SearchSessionsApiCreateSearchSessionRequest {
|
|
14840
|
+
/**
|
|
14841
|
+
*
|
|
14842
|
+
* @type {CreateSearchSessionRequest}
|
|
14843
|
+
* @memberof SearchSessionsApiCreateSearchSession
|
|
14844
|
+
*/
|
|
14845
|
+
readonly createSearchSessionRequest: CreateSearchSessionRequest;
|
|
14846
|
+
}
|
|
14847
|
+
/**
|
|
14848
|
+
* Request parameters for getSearchSession operation in SearchSessionsApi.
|
|
14849
|
+
* @export
|
|
14850
|
+
* @interface SearchSessionsApiGetSearchSessionRequest
|
|
14851
|
+
*/
|
|
14852
|
+
export interface SearchSessionsApiGetSearchSessionRequest {
|
|
14853
|
+
/**
|
|
14854
|
+
* The `search-session` ID.
|
|
14855
|
+
* @type {string}
|
|
14856
|
+
* @memberof SearchSessionsApiGetSearchSession
|
|
14857
|
+
*/
|
|
14858
|
+
readonly id: string;
|
|
14859
|
+
}
|
|
14860
|
+
/**
|
|
14861
|
+
* SearchSessionsApi - object-oriented interface
|
|
14862
|
+
* @export
|
|
14863
|
+
* @class SearchSessionsApi
|
|
14864
|
+
* @extends {BaseAPI}
|
|
14865
|
+
*/
|
|
14866
|
+
export declare class SearchSessionsApi extends BaseAPI {
|
|
14867
|
+
/**
|
|
14868
|
+
* Create a `search-session`.
|
|
14869
|
+
* @param {SearchSessionsApiCreateSearchSessionRequest} requestParameters Request parameters.
|
|
14870
|
+
* @param {*} [options] Override http request option.
|
|
14871
|
+
* @throws {RequiredError}
|
|
14872
|
+
* @memberof SearchSessionsApi
|
|
14873
|
+
*/
|
|
14874
|
+
createSearchSession(requestParameters: SearchSessionsApiCreateSearchSessionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchSession, any>>;
|
|
14875
|
+
/**
|
|
14876
|
+
* Get a `search-session`.
|
|
14877
|
+
* @param {SearchSessionsApiGetSearchSessionRequest} requestParameters Request parameters.
|
|
14878
|
+
* @param {*} [options] Override http request option.
|
|
14879
|
+
* @throws {RequiredError}
|
|
14880
|
+
* @memberof SearchSessionsApi
|
|
14881
|
+
*/
|
|
14882
|
+
getSearchSession(requestParameters: SearchSessionsApiGetSearchSessionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchSession, any>>;
|
|
14883
|
+
}
|
|
14293
14884
|
/**
|
|
14294
14885
|
* StreamKeysApi - axios parameter creator
|
|
14295
14886
|
* @export
|