@vertexvis/api-client-node 0.21.2 → 0.22.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 +415 -49
- package/dist/cjs/api.js +217 -16
- package/dist/cjs/client/helpers/files.d.ts +2 -1
- package/dist/cjs/client/helpers/index.d.ts +1 -1
- package/dist/cjs/client/helpers/index.js +1 -1
- package/dist/cjs/client/helpers/parts.d.ts +2 -1
- package/dist/cjs/client/index.d.ts +1 -1
- package/dist/cjs/client/index.js +1 -1
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/esm/api.d.ts +415 -49
- package/dist/esm/api.js +210 -13
- package/dist/esm/client/helpers/files.d.ts +2 -1
- package/dist/esm/client/helpers/index.d.ts +1 -1
- package/dist/esm/client/helpers/index.js +1 -1
- package/dist/esm/client/helpers/parts.d.ts +2 -1
- package/dist/esm/client/index.d.ts +1 -1
- package/dist/esm/client/index.js +1 -1
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/package.json +10 -10
package/dist/cjs/api.d.ts
CHANGED
|
@@ -468,7 +468,7 @@ export interface BatchOperation {
|
|
|
468
468
|
export declare const BatchOperationOpEnum: {
|
|
469
469
|
readonly Add: "add";
|
|
470
470
|
};
|
|
471
|
-
export declare type BatchOperationOpEnum = typeof BatchOperationOpEnum[keyof typeof BatchOperationOpEnum];
|
|
471
|
+
export declare type BatchOperationOpEnum = (typeof BatchOperationOpEnum)[keyof typeof BatchOperationOpEnum];
|
|
472
472
|
/**
|
|
473
473
|
* Target of batch operation.
|
|
474
474
|
* @export
|
|
@@ -491,7 +491,7 @@ export interface BatchOperationRef {
|
|
|
491
491
|
export declare const BatchOperationRefTypeEnum: {
|
|
492
492
|
readonly Scene: "scene";
|
|
493
493
|
};
|
|
494
|
-
export declare type BatchOperationRefTypeEnum = typeof BatchOperationRefTypeEnum[keyof typeof BatchOperationRefTypeEnum];
|
|
494
|
+
export declare type BatchOperationRefTypeEnum = (typeof BatchOperationRefTypeEnum)[keyof typeof BatchOperationRefTypeEnum];
|
|
495
495
|
/**
|
|
496
496
|
* 3D bounding-box
|
|
497
497
|
* @export
|
|
@@ -535,7 +535,7 @@ export declare const CameraFitTypeEnum: {
|
|
|
535
535
|
readonly FitVisibleSceneItems: "fit-visible-scene-items";
|
|
536
536
|
readonly Reset: "reset";
|
|
537
537
|
};
|
|
538
|
-
export declare type CameraFitTypeEnum = typeof CameraFitTypeEnum[keyof typeof CameraFitTypeEnum];
|
|
538
|
+
export declare type CameraFitTypeEnum = (typeof CameraFitTypeEnum)[keyof typeof CameraFitTypeEnum];
|
|
539
539
|
/**
|
|
540
540
|
*
|
|
541
541
|
* @export
|
|
@@ -558,7 +558,7 @@ export interface ChangeMaterialOperation {
|
|
|
558
558
|
export declare const ChangeMaterialOperationTypeEnum: {
|
|
559
559
|
readonly ChangeMaterial: "change-material";
|
|
560
560
|
};
|
|
561
|
-
export declare type ChangeMaterialOperationTypeEnum = typeof ChangeMaterialOperationTypeEnum[keyof typeof ChangeMaterialOperationTypeEnum];
|
|
561
|
+
export declare type ChangeMaterialOperationTypeEnum = (typeof ChangeMaterialOperationTypeEnum)[keyof typeof ChangeMaterialOperationTypeEnum];
|
|
562
562
|
/**
|
|
563
563
|
*
|
|
564
564
|
* @export
|
|
@@ -581,7 +581,7 @@ export interface ChangeTransformOperation {
|
|
|
581
581
|
export declare const ChangeTransformOperationTypeEnum: {
|
|
582
582
|
readonly ChangeTransform: "change-transform";
|
|
583
583
|
};
|
|
584
|
-
export declare type ChangeTransformOperationTypeEnum = typeof ChangeTransformOperationTypeEnum[keyof typeof ChangeTransformOperationTypeEnum];
|
|
584
|
+
export declare type ChangeTransformOperationTypeEnum = (typeof ChangeTransformOperationTypeEnum)[keyof typeof ChangeTransformOperationTypeEnum];
|
|
585
585
|
/**
|
|
586
586
|
*
|
|
587
587
|
* @export
|
|
@@ -604,7 +604,7 @@ export interface ChangeVisibilityOperation {
|
|
|
604
604
|
export declare const ChangeVisibilityOperationTypeEnum: {
|
|
605
605
|
readonly ChangeVisibility: "change-visibility";
|
|
606
606
|
};
|
|
607
|
-
export declare type ChangeVisibilityOperationTypeEnum = typeof ChangeVisibilityOperationTypeEnum[keyof typeof ChangeVisibilityOperationTypeEnum];
|
|
607
|
+
export declare type ChangeVisibilityOperationTypeEnum = (typeof ChangeVisibilityOperationTypeEnum)[keyof typeof ChangeVisibilityOperationTypeEnum];
|
|
608
608
|
/**
|
|
609
609
|
*
|
|
610
610
|
* @export
|
|
@@ -621,7 +621,7 @@ export interface ClearMaterialOperation {
|
|
|
621
621
|
export declare const ClearMaterialOperationTypeEnum: {
|
|
622
622
|
readonly ClearMaterial: "clear-material";
|
|
623
623
|
};
|
|
624
|
-
export declare type ClearMaterialOperationTypeEnum = typeof ClearMaterialOperationTypeEnum[keyof typeof ClearMaterialOperationTypeEnum];
|
|
624
|
+
export declare type ClearMaterialOperationTypeEnum = (typeof ClearMaterialOperationTypeEnum)[keyof typeof ClearMaterialOperationTypeEnum];
|
|
625
625
|
/**
|
|
626
626
|
*
|
|
627
627
|
* @export
|
|
@@ -638,7 +638,7 @@ export interface ClearTransformOperation {
|
|
|
638
638
|
export declare const ClearTransformOperationTypeEnum: {
|
|
639
639
|
readonly ClearTransform: "clear-transform";
|
|
640
640
|
};
|
|
641
|
-
export declare type ClearTransformOperationTypeEnum = typeof ClearTransformOperationTypeEnum[keyof typeof ClearTransformOperationTypeEnum];
|
|
641
|
+
export declare type ClearTransformOperationTypeEnum = (typeof ClearTransformOperationTypeEnum)[keyof typeof ClearTransformOperationTypeEnum];
|
|
642
642
|
/**
|
|
643
643
|
* RGB color.
|
|
644
644
|
* @export
|
|
@@ -1050,6 +1050,69 @@ export interface CreateHitRequestDataAttributes {
|
|
|
1050
1050
|
*/
|
|
1051
1051
|
viewport: Dimensions;
|
|
1052
1052
|
}
|
|
1053
|
+
/**
|
|
1054
|
+
*
|
|
1055
|
+
* @export
|
|
1056
|
+
* @interface CreatePartRenditionRequest
|
|
1057
|
+
*/
|
|
1058
|
+
export interface CreatePartRenditionRequest {
|
|
1059
|
+
/**
|
|
1060
|
+
*
|
|
1061
|
+
* @type {CreatePartRenditionRequestData}
|
|
1062
|
+
* @memberof CreatePartRenditionRequest
|
|
1063
|
+
*/
|
|
1064
|
+
data: CreatePartRenditionRequestData;
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* Create a new part rendition. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part rendition with an empty geometry and return a `201` status code. 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, the returned value will include a `part-rendition` that references the translated geometry.
|
|
1068
|
+
* @export
|
|
1069
|
+
* @interface CreatePartRenditionRequestData
|
|
1070
|
+
*/
|
|
1071
|
+
export interface CreatePartRenditionRequestData {
|
|
1072
|
+
/**
|
|
1073
|
+
* Resource object type.
|
|
1074
|
+
* @type {string}
|
|
1075
|
+
* @memberof CreatePartRenditionRequestData
|
|
1076
|
+
*/
|
|
1077
|
+
type: string;
|
|
1078
|
+
/**
|
|
1079
|
+
*
|
|
1080
|
+
* @type {CreatePartRenditionRequestDataAttributes}
|
|
1081
|
+
* @memberof CreatePartRenditionRequestData
|
|
1082
|
+
*/
|
|
1083
|
+
attributes: CreatePartRenditionRequestDataAttributes;
|
|
1084
|
+
/**
|
|
1085
|
+
*
|
|
1086
|
+
* @type {CreateGeometrySetRequestDataRelationships}
|
|
1087
|
+
* @memberof CreatePartRenditionRequestData
|
|
1088
|
+
*/
|
|
1089
|
+
relationships?: CreateGeometrySetRequestDataRelationships;
|
|
1090
|
+
}
|
|
1091
|
+
/**
|
|
1092
|
+
*
|
|
1093
|
+
* @export
|
|
1094
|
+
* @interface CreatePartRenditionRequestDataAttributes
|
|
1095
|
+
*/
|
|
1096
|
+
export interface CreatePartRenditionRequestDataAttributes {
|
|
1097
|
+
/**
|
|
1098
|
+
*
|
|
1099
|
+
* @type {string}
|
|
1100
|
+
* @memberof CreatePartRenditionRequestDataAttributes
|
|
1101
|
+
*/
|
|
1102
|
+
name?: string;
|
|
1103
|
+
/**
|
|
1104
|
+
* ID provided for correlation. For example, an existing ID from a PLM system.
|
|
1105
|
+
* @type {string}
|
|
1106
|
+
* @memberof CreatePartRenditionRequestDataAttributes
|
|
1107
|
+
*/
|
|
1108
|
+
suppliedId?: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* Whether or not to replace the default rendition for the part revision with the newly created rendition.
|
|
1111
|
+
* @type {boolean}
|
|
1112
|
+
* @memberof CreatePartRenditionRequestDataAttributes
|
|
1113
|
+
*/
|
|
1114
|
+
makeDefault?: boolean;
|
|
1115
|
+
}
|
|
1053
1116
|
/**
|
|
1054
1117
|
*
|
|
1055
1118
|
* @export
|
|
@@ -1435,11 +1498,11 @@ export interface CreateSceneItemRequestDataRelationships {
|
|
|
1435
1498
|
*/
|
|
1436
1499
|
parent?: SceneItemRelationship;
|
|
1437
1500
|
/**
|
|
1438
|
-
* Relationship to a `geometry-set`, `part-revision`, or `scene`.
|
|
1439
|
-
* @type {GeometrySetRelationship | PartRevisionRelationship | SceneRelationship}
|
|
1501
|
+
* Relationship to a `geometry-set`, `part-revision`, `part-rendition`, or `scene`.
|
|
1502
|
+
* @type {GeometrySetRelationship | PartRevisionRelationship | SceneRelationship | PartRenditionRelationship}
|
|
1440
1503
|
* @memberof CreateSceneItemRequestDataRelationships
|
|
1441
1504
|
*/
|
|
1442
|
-
source?: GeometrySetRelationship | PartRevisionRelationship | SceneRelationship;
|
|
1505
|
+
source?: GeometrySetRelationship | PartRevisionRelationship | SceneRelationship | PartRenditionRelationship;
|
|
1443
1506
|
/**
|
|
1444
1507
|
*
|
|
1445
1508
|
* @type {SceneItemRelationship}
|
|
@@ -1933,7 +1996,7 @@ export interface DeselectOperation {
|
|
|
1933
1996
|
export declare const DeselectOperationTypeEnum: {
|
|
1934
1997
|
readonly Deselect: "deselect";
|
|
1935
1998
|
};
|
|
1936
|
-
export declare type DeselectOperationTypeEnum = typeof DeselectOperationTypeEnum[keyof typeof DeselectOperationTypeEnum];
|
|
1999
|
+
export declare type DeselectOperationTypeEnum = (typeof DeselectOperationTypeEnum)[keyof typeof DeselectOperationTypeEnum];
|
|
1937
2000
|
/**
|
|
1938
2001
|
* An item\'s height and width.
|
|
1939
2002
|
* @export
|
|
@@ -2074,7 +2137,7 @@ export interface ExportRelationshipData {
|
|
|
2074
2137
|
export declare const ExportRelationshipDataTypeEnum: {
|
|
2075
2138
|
readonly Scene: "scene";
|
|
2076
2139
|
};
|
|
2077
|
-
export declare type ExportRelationshipDataTypeEnum = typeof ExportRelationshipDataTypeEnum[keyof typeof ExportRelationshipDataTypeEnum];
|
|
2140
|
+
export declare type ExportRelationshipDataTypeEnum = (typeof ExportRelationshipDataTypeEnum)[keyof typeof ExportRelationshipDataTypeEnum];
|
|
2078
2141
|
/**
|
|
2079
2142
|
* Relationship to an `export`.
|
|
2080
2143
|
* @export
|
|
@@ -2110,7 +2173,7 @@ export interface ExportStateRelationshipData {
|
|
|
2110
2173
|
export declare const ExportStateRelationshipDataTypeEnum: {
|
|
2111
2174
|
readonly SceneViewState: "scene-view-state";
|
|
2112
2175
|
};
|
|
2113
|
-
export declare type ExportStateRelationshipDataTypeEnum = typeof ExportStateRelationshipDataTypeEnum[keyof typeof ExportStateRelationshipDataTypeEnum];
|
|
2176
|
+
export declare type ExportStateRelationshipDataTypeEnum = (typeof ExportStateRelationshipDataTypeEnum)[keyof typeof ExportStateRelationshipDataTypeEnum];
|
|
2114
2177
|
/**
|
|
2115
2178
|
*
|
|
2116
2179
|
* @export
|
|
@@ -2318,7 +2381,7 @@ export interface FileRelationshipData {
|
|
|
2318
2381
|
export declare const FileRelationshipDataTypeEnum: {
|
|
2319
2382
|
readonly File: "file";
|
|
2320
2383
|
};
|
|
2321
|
-
export declare type FileRelationshipDataTypeEnum = typeof FileRelationshipDataTypeEnum[keyof typeof FileRelationshipDataTypeEnum];
|
|
2384
|
+
export declare type FileRelationshipDataTypeEnum = (typeof FileRelationshipDataTypeEnum)[keyof typeof FileRelationshipDataTypeEnum];
|
|
2322
2385
|
/**
|
|
2323
2386
|
*
|
|
2324
2387
|
* @export
|
|
@@ -2429,7 +2492,7 @@ export interface GeometrySetRelationshipData {
|
|
|
2429
2492
|
export declare const GeometrySetRelationshipDataTypeEnum: {
|
|
2430
2493
|
readonly GeometrySet: "geometry-set";
|
|
2431
2494
|
};
|
|
2432
|
-
export declare type GeometrySetRelationshipDataTypeEnum = typeof GeometrySetRelationshipDataTypeEnum[keyof typeof GeometrySetRelationshipDataTypeEnum];
|
|
2495
|
+
export declare type GeometrySetRelationshipDataTypeEnum = (typeof GeometrySetRelationshipDataTypeEnum)[keyof typeof GeometrySetRelationshipDataTypeEnum];
|
|
2433
2496
|
/**
|
|
2434
2497
|
*
|
|
2435
2498
|
* @export
|
|
@@ -3026,7 +3089,7 @@ export interface PartDataRelationshipsPartRevisions {
|
|
|
3026
3089
|
export declare const PartDataRelationshipsPartRevisionsTypeEnum: {
|
|
3027
3090
|
readonly PartRevision: "part-revision";
|
|
3028
3091
|
};
|
|
3029
|
-
export declare type PartDataRelationshipsPartRevisionsTypeEnum = typeof PartDataRelationshipsPartRevisionsTypeEnum[keyof typeof PartDataRelationshipsPartRevisionsTypeEnum];
|
|
3092
|
+
export declare type PartDataRelationshipsPartRevisionsTypeEnum = (typeof PartDataRelationshipsPartRevisionsTypeEnum)[keyof typeof PartDataRelationshipsPartRevisionsTypeEnum];
|
|
3030
3093
|
/**
|
|
3031
3094
|
*
|
|
3032
3095
|
* @export
|
|
@@ -3070,7 +3133,147 @@ export interface PartRelationshipData {
|
|
|
3070
3133
|
export declare const PartRelationshipDataTypeEnum: {
|
|
3071
3134
|
readonly Part: "part";
|
|
3072
3135
|
};
|
|
3073
|
-
export declare type PartRelationshipDataTypeEnum = typeof PartRelationshipDataTypeEnum[keyof typeof PartRelationshipDataTypeEnum];
|
|
3136
|
+
export declare type PartRelationshipDataTypeEnum = (typeof PartRelationshipDataTypeEnum)[keyof typeof PartRelationshipDataTypeEnum];
|
|
3137
|
+
/**
|
|
3138
|
+
*
|
|
3139
|
+
* @export
|
|
3140
|
+
* @interface PartRendition
|
|
3141
|
+
*/
|
|
3142
|
+
export interface PartRendition {
|
|
3143
|
+
/**
|
|
3144
|
+
*
|
|
3145
|
+
* @type {PartRenditionData}
|
|
3146
|
+
* @memberof PartRendition
|
|
3147
|
+
*/
|
|
3148
|
+
data: PartRenditionData;
|
|
3149
|
+
/**
|
|
3150
|
+
*
|
|
3151
|
+
* @type {{ [key: string]: Link; }}
|
|
3152
|
+
* @memberof PartRendition
|
|
3153
|
+
*/
|
|
3154
|
+
links?: {
|
|
3155
|
+
[key: string]: Link;
|
|
3156
|
+
};
|
|
3157
|
+
}
|
|
3158
|
+
/**
|
|
3159
|
+
*
|
|
3160
|
+
* @export
|
|
3161
|
+
* @interface PartRenditionData
|
|
3162
|
+
*/
|
|
3163
|
+
export interface PartRenditionData {
|
|
3164
|
+
/**
|
|
3165
|
+
*
|
|
3166
|
+
* @type {string}
|
|
3167
|
+
* @memberof PartRenditionData
|
|
3168
|
+
*/
|
|
3169
|
+
type: string;
|
|
3170
|
+
/**
|
|
3171
|
+
* ID of the resource.
|
|
3172
|
+
* @type {string}
|
|
3173
|
+
* @memberof PartRenditionData
|
|
3174
|
+
*/
|
|
3175
|
+
id: string;
|
|
3176
|
+
/**
|
|
3177
|
+
*
|
|
3178
|
+
* @type {PartRenditionDataAttributes}
|
|
3179
|
+
* @memberof PartRenditionData
|
|
3180
|
+
*/
|
|
3181
|
+
attributes: PartRenditionDataAttributes;
|
|
3182
|
+
/**
|
|
3183
|
+
*
|
|
3184
|
+
* @type {PartRenditionDataRelationships}
|
|
3185
|
+
* @memberof PartRenditionData
|
|
3186
|
+
*/
|
|
3187
|
+
relationships: PartRenditionDataRelationships;
|
|
3188
|
+
/**
|
|
3189
|
+
*
|
|
3190
|
+
* @type {{ [key: string]: Link; }}
|
|
3191
|
+
* @memberof PartRenditionData
|
|
3192
|
+
*/
|
|
3193
|
+
links?: {
|
|
3194
|
+
[key: string]: Link;
|
|
3195
|
+
};
|
|
3196
|
+
}
|
|
3197
|
+
/**
|
|
3198
|
+
*
|
|
3199
|
+
* @export
|
|
3200
|
+
* @interface PartRenditionDataAttributes
|
|
3201
|
+
*/
|
|
3202
|
+
export interface PartRenditionDataAttributes {
|
|
3203
|
+
/**
|
|
3204
|
+
*
|
|
3205
|
+
* @type {string}
|
|
3206
|
+
* @memberof PartRenditionDataAttributes
|
|
3207
|
+
*/
|
|
3208
|
+
created?: string;
|
|
3209
|
+
/**
|
|
3210
|
+
*
|
|
3211
|
+
* @type {string}
|
|
3212
|
+
* @memberof PartRenditionDataAttributes
|
|
3213
|
+
*/
|
|
3214
|
+
suppliedId?: string;
|
|
3215
|
+
/**
|
|
3216
|
+
*
|
|
3217
|
+
* @type {string}
|
|
3218
|
+
* @memberof PartRenditionDataAttributes
|
|
3219
|
+
*/
|
|
3220
|
+
name?: string;
|
|
3221
|
+
}
|
|
3222
|
+
/**
|
|
3223
|
+
*
|
|
3224
|
+
* @export
|
|
3225
|
+
* @interface PartRenditionDataRelationships
|
|
3226
|
+
*/
|
|
3227
|
+
export interface PartRenditionDataRelationships {
|
|
3228
|
+
/**
|
|
3229
|
+
*
|
|
3230
|
+
* @type {GeometrySetRelationshipData}
|
|
3231
|
+
* @memberof PartRenditionDataRelationships
|
|
3232
|
+
*/
|
|
3233
|
+
geometrySet?: GeometrySetRelationshipData;
|
|
3234
|
+
/**
|
|
3235
|
+
*
|
|
3236
|
+
* @type {PartRevisionRelationship}
|
|
3237
|
+
* @memberof PartRenditionDataRelationships
|
|
3238
|
+
*/
|
|
3239
|
+
partRevision?: PartRevisionRelationship;
|
|
3240
|
+
}
|
|
3241
|
+
/**
|
|
3242
|
+
* Relationship to a `part-rendition`.
|
|
3243
|
+
* @export
|
|
3244
|
+
* @interface PartRenditionRelationship
|
|
3245
|
+
*/
|
|
3246
|
+
export interface PartRenditionRelationship {
|
|
3247
|
+
/**
|
|
3248
|
+
*
|
|
3249
|
+
* @type {PartRenditionRelationshipData}
|
|
3250
|
+
* @memberof PartRenditionRelationship
|
|
3251
|
+
*/
|
|
3252
|
+
data: PartRenditionRelationshipData;
|
|
3253
|
+
}
|
|
3254
|
+
/**
|
|
3255
|
+
*
|
|
3256
|
+
* @export
|
|
3257
|
+
* @interface PartRenditionRelationshipData
|
|
3258
|
+
*/
|
|
3259
|
+
export interface PartRenditionRelationshipData {
|
|
3260
|
+
/**
|
|
3261
|
+
* Resource object type.
|
|
3262
|
+
* @type {string}
|
|
3263
|
+
* @memberof PartRenditionRelationshipData
|
|
3264
|
+
*/
|
|
3265
|
+
type: PartRenditionRelationshipDataTypeEnum;
|
|
3266
|
+
/**
|
|
3267
|
+
* ID of the resource.
|
|
3268
|
+
* @type {string}
|
|
3269
|
+
* @memberof PartRenditionRelationshipData
|
|
3270
|
+
*/
|
|
3271
|
+
id: string;
|
|
3272
|
+
}
|
|
3273
|
+
export declare const PartRenditionRelationshipDataTypeEnum: {
|
|
3274
|
+
readonly PartRendition: "part-rendition";
|
|
3275
|
+
};
|
|
3276
|
+
export declare type PartRenditionRelationshipDataTypeEnum = (typeof PartRenditionRelationshipDataTypeEnum)[keyof typeof PartRenditionRelationshipDataTypeEnum];
|
|
3074
3277
|
/**
|
|
3075
3278
|
*
|
|
3076
3279
|
* @export
|
|
@@ -3182,6 +3385,12 @@ export interface PartRevisionDataRelationships {
|
|
|
3182
3385
|
* @memberof PartRevisionDataRelationships
|
|
3183
3386
|
*/
|
|
3184
3387
|
part?: PartRelationshipData;
|
|
3388
|
+
/**
|
|
3389
|
+
*
|
|
3390
|
+
* @type {PartRenditionRelationship}
|
|
3391
|
+
* @memberof PartRevisionDataRelationships
|
|
3392
|
+
*/
|
|
3393
|
+
defaultPartRendition?: PartRenditionRelationship;
|
|
3185
3394
|
}
|
|
3186
3395
|
/**
|
|
3187
3396
|
* A reference to an existing PartRevision. Specify one and only one of referenceId or suppliedReferenceId to refer to a revision.
|
|
@@ -3331,7 +3540,7 @@ export interface Point {
|
|
|
3331
3540
|
export declare const QueryAll: {
|
|
3332
3541
|
readonly All: "all";
|
|
3333
3542
|
};
|
|
3334
|
-
export declare type QueryAll = typeof QueryAll[keyof typeof QueryAll];
|
|
3543
|
+
export declare type QueryAll = (typeof QueryAll)[keyof typeof QueryAll];
|
|
3335
3544
|
/**
|
|
3336
3545
|
*
|
|
3337
3546
|
* @export
|
|
@@ -3367,7 +3576,7 @@ export interface QueryByCollectionData {
|
|
|
3367
3576
|
export declare const QueryByCollectionDataTypeEnum: {
|
|
3368
3577
|
readonly QueryByCollection: "query-by-collection";
|
|
3369
3578
|
};
|
|
3370
|
-
export declare type QueryByCollectionDataTypeEnum = typeof QueryByCollectionDataTypeEnum[keyof typeof QueryByCollectionDataTypeEnum];
|
|
3579
|
+
export declare type QueryByCollectionDataTypeEnum = (typeof QueryByCollectionDataTypeEnum)[keyof typeof QueryByCollectionDataTypeEnum];
|
|
3371
3580
|
/**
|
|
3372
3581
|
*
|
|
3373
3582
|
* @export
|
|
@@ -3391,7 +3600,7 @@ export declare const QueryByCollectionDataAttributesTypeEnum: {
|
|
|
3391
3600
|
readonly And: "and";
|
|
3392
3601
|
readonly Or: "or";
|
|
3393
3602
|
};
|
|
3394
|
-
export declare type QueryByCollectionDataAttributesTypeEnum = typeof QueryByCollectionDataAttributesTypeEnum[keyof typeof QueryByCollectionDataAttributesTypeEnum];
|
|
3603
|
+
export declare type QueryByCollectionDataAttributesTypeEnum = (typeof QueryByCollectionDataAttributesTypeEnum)[keyof typeof QueryByCollectionDataAttributesTypeEnum];
|
|
3395
3604
|
/**
|
|
3396
3605
|
*
|
|
3397
3606
|
* @export
|
|
@@ -3427,7 +3636,7 @@ export interface QueryByIdData {
|
|
|
3427
3636
|
export declare const QueryByIdDataTypeEnum: {
|
|
3428
3637
|
readonly QueryById: "query-by-id";
|
|
3429
3638
|
};
|
|
3430
|
-
export declare type QueryByIdDataTypeEnum = typeof QueryByIdDataTypeEnum[keyof typeof QueryByIdDataTypeEnum];
|
|
3639
|
+
export declare type QueryByIdDataTypeEnum = (typeof QueryByIdDataTypeEnum)[keyof typeof QueryByIdDataTypeEnum];
|
|
3431
3640
|
/**
|
|
3432
3641
|
*
|
|
3433
3642
|
* @export
|
|
@@ -3451,7 +3660,7 @@ export declare const QueryByIdDataAttributesTypeEnum: {
|
|
|
3451
3660
|
readonly Id: "id";
|
|
3452
3661
|
readonly SuppliedId: "suppliedId";
|
|
3453
3662
|
};
|
|
3454
|
-
export declare type QueryByIdDataAttributesTypeEnum = typeof QueryByIdDataAttributesTypeEnum[keyof typeof QueryByIdDataAttributesTypeEnum];
|
|
3663
|
+
export declare type QueryByIdDataAttributesTypeEnum = (typeof QueryByIdDataAttributesTypeEnum)[keyof typeof QueryByIdDataAttributesTypeEnum];
|
|
3455
3664
|
/**
|
|
3456
3665
|
*
|
|
3457
3666
|
* @export
|
|
@@ -3566,10 +3775,10 @@ export interface QueuedTranslationJob {
|
|
|
3566
3775
|
data: QueuedTranslationJobData;
|
|
3567
3776
|
/**
|
|
3568
3777
|
*
|
|
3569
|
-
* @type {Array<GeometrySetData | PartRevisionData>}
|
|
3778
|
+
* @type {Array<GeometrySetData | PartRevisionData | PartRenditionData>}
|
|
3570
3779
|
* @memberof QueuedTranslationJob
|
|
3571
3780
|
*/
|
|
3572
|
-
included?: Array<GeometrySetData | PartRevisionData>;
|
|
3781
|
+
included?: Array<GeometrySetData | PartRevisionData | PartRenditionData>;
|
|
3573
3782
|
/**
|
|
3574
3783
|
*
|
|
3575
3784
|
* @type {{ [key: string]: Link; }}
|
|
@@ -3667,6 +3876,12 @@ export interface QueuedTranslationJobDataRelationships {
|
|
|
3667
3876
|
* @memberof QueuedTranslationJobDataRelationships
|
|
3668
3877
|
*/
|
|
3669
3878
|
partRevision?: PartRevisionRelationship;
|
|
3879
|
+
/**
|
|
3880
|
+
*
|
|
3881
|
+
* @type {PartRenditionRelationship}
|
|
3882
|
+
* @memberof QueuedTranslationJobDataRelationships
|
|
3883
|
+
*/
|
|
3884
|
+
partRendition?: PartRenditionRelationship;
|
|
3670
3885
|
}
|
|
3671
3886
|
/**
|
|
3672
3887
|
*
|
|
@@ -4105,16 +4320,22 @@ export interface SceneItemDataAttributes {
|
|
|
4105
4320
|
export interface SceneItemDataRelationships {
|
|
4106
4321
|
/**
|
|
4107
4322
|
*
|
|
4108
|
-
* @type {GeometrySetRelationship | PartRevisionRelationship | SceneRelationship}
|
|
4323
|
+
* @type {GeometrySetRelationship | PartRevisionRelationship | SceneRelationship | PartRenditionRelationship}
|
|
4109
4324
|
* @memberof SceneItemDataRelationships
|
|
4110
4325
|
*/
|
|
4111
|
-
source?: GeometrySetRelationship | PartRevisionRelationship | SceneRelationship;
|
|
4326
|
+
source?: GeometrySetRelationship | PartRevisionRelationship | SceneRelationship | PartRenditionRelationship;
|
|
4112
4327
|
/**
|
|
4113
4328
|
*
|
|
4114
4329
|
* @type {SceneItemRelationship}
|
|
4115
4330
|
* @memberof SceneItemDataRelationships
|
|
4116
4331
|
*/
|
|
4117
4332
|
parent?: SceneItemRelationship;
|
|
4333
|
+
/**
|
|
4334
|
+
*
|
|
4335
|
+
* @type {PartRenditionRelationship}
|
|
4336
|
+
* @memberof SceneItemDataRelationships
|
|
4337
|
+
*/
|
|
4338
|
+
partRendition?: PartRenditionRelationship;
|
|
4118
4339
|
}
|
|
4119
4340
|
/**
|
|
4120
4341
|
*
|
|
@@ -4321,7 +4542,7 @@ export interface SceneItemRelationshipData {
|
|
|
4321
4542
|
export declare const SceneItemRelationshipDataTypeEnum: {
|
|
4322
4543
|
readonly SceneItem: "scene-item";
|
|
4323
4544
|
};
|
|
4324
|
-
export declare type SceneItemRelationshipDataTypeEnum = typeof SceneItemRelationshipDataTypeEnum[keyof typeof SceneItemRelationshipDataTypeEnum];
|
|
4545
|
+
export declare type SceneItemRelationshipDataTypeEnum = (typeof SceneItemRelationshipDataTypeEnum)[keyof typeof SceneItemRelationshipDataTypeEnum];
|
|
4325
4546
|
/**
|
|
4326
4547
|
*
|
|
4327
4548
|
* @export
|
|
@@ -4397,7 +4618,7 @@ export interface SceneRelationshipData {
|
|
|
4397
4618
|
export declare const SceneRelationshipDataTypeEnum: {
|
|
4398
4619
|
readonly Scene: "scene";
|
|
4399
4620
|
};
|
|
4400
|
-
export declare type SceneRelationshipDataTypeEnum = typeof SceneRelationshipDataTypeEnum[keyof typeof SceneRelationshipDataTypeEnum];
|
|
4621
|
+
export declare type SceneRelationshipDataTypeEnum = (typeof SceneRelationshipDataTypeEnum)[keyof typeof SceneRelationshipDataTypeEnum];
|
|
4401
4622
|
/**
|
|
4402
4623
|
*
|
|
4403
4624
|
* @export
|
|
@@ -4583,7 +4804,7 @@ export interface SceneViewRelationshipData {
|
|
|
4583
4804
|
export declare const SceneViewRelationshipDataTypeEnum: {
|
|
4584
4805
|
readonly SceneView: "scene-view";
|
|
4585
4806
|
};
|
|
4586
|
-
export declare type SceneViewRelationshipDataTypeEnum = typeof SceneViewRelationshipDataTypeEnum[keyof typeof SceneViewRelationshipDataTypeEnum];
|
|
4807
|
+
export declare type SceneViewRelationshipDataTypeEnum = (typeof SceneViewRelationshipDataTypeEnum)[keyof typeof SceneViewRelationshipDataTypeEnum];
|
|
4587
4808
|
/**
|
|
4588
4809
|
*
|
|
4589
4810
|
* @export
|
|
@@ -4743,7 +4964,7 @@ export interface SceneViewStateRelationshipData {
|
|
|
4743
4964
|
export declare const SceneViewStateRelationshipDataTypeEnum: {
|
|
4744
4965
|
readonly SceneViewState: "scene-view-state";
|
|
4745
4966
|
};
|
|
4746
|
-
export declare type SceneViewStateRelationshipDataTypeEnum = typeof SceneViewStateRelationshipDataTypeEnum[keyof typeof SceneViewStateRelationshipDataTypeEnum];
|
|
4967
|
+
export declare type SceneViewStateRelationshipDataTypeEnum = (typeof SceneViewStateRelationshipDataTypeEnum)[keyof typeof SceneViewStateRelationshipDataTypeEnum];
|
|
4747
4968
|
/**
|
|
4748
4969
|
*
|
|
4749
4970
|
* @export
|
|
@@ -4779,7 +5000,7 @@ export interface SelectOperation {
|
|
|
4779
5000
|
export declare const SelectOperationTypeEnum: {
|
|
4780
5001
|
readonly Select: "select";
|
|
4781
5002
|
};
|
|
4782
|
-
export declare type SelectOperationTypeEnum = typeof SelectOperationTypeEnum[keyof typeof SelectOperationTypeEnum];
|
|
5003
|
+
export declare type SelectOperationTypeEnum = (typeof SelectOperationTypeEnum)[keyof typeof SelectOperationTypeEnum];
|
|
4783
5004
|
/**
|
|
4784
5005
|
*
|
|
4785
5006
|
* @export
|
|
@@ -5043,7 +5264,7 @@ export declare const UpdateAccountRequestDataAttributesStatusEnum: {
|
|
|
5043
5264
|
readonly Active: "active";
|
|
5044
5265
|
readonly Disabled: "disabled";
|
|
5045
5266
|
};
|
|
5046
|
-
export declare type UpdateAccountRequestDataAttributesStatusEnum = typeof UpdateAccountRequestDataAttributesStatusEnum[keyof typeof UpdateAccountRequestDataAttributesStatusEnum];
|
|
5267
|
+
export declare type UpdateAccountRequestDataAttributesStatusEnum = (typeof UpdateAccountRequestDataAttributesStatusEnum)[keyof typeof UpdateAccountRequestDataAttributesStatusEnum];
|
|
5047
5268
|
/**
|
|
5048
5269
|
*
|
|
5049
5270
|
* @export
|
|
@@ -5441,7 +5662,7 @@ export declare const UpdateSceneRequestDataAttributesStateEnum: {
|
|
|
5441
5662
|
readonly Draft: "draft";
|
|
5442
5663
|
readonly Commit: "commit";
|
|
5443
5664
|
};
|
|
5444
|
-
export declare type UpdateSceneRequestDataAttributesStateEnum = typeof UpdateSceneRequestDataAttributesStateEnum[keyof typeof UpdateSceneRequestDataAttributesStateEnum];
|
|
5665
|
+
export declare type UpdateSceneRequestDataAttributesStateEnum = (typeof UpdateSceneRequestDataAttributesStateEnum)[keyof typeof UpdateSceneRequestDataAttributesStateEnum];
|
|
5445
5666
|
/**
|
|
5446
5667
|
*
|
|
5447
5668
|
* @export
|
|
@@ -5592,7 +5813,7 @@ export declare const UpdateWebhookSubscriptionRequestDataAttributesStatusEnum: {
|
|
|
5592
5813
|
readonly Active: "active";
|
|
5593
5814
|
readonly Paused: "paused";
|
|
5594
5815
|
};
|
|
5595
|
-
export declare type UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = typeof UpdateWebhookSubscriptionRequestDataAttributesStatusEnum[keyof typeof UpdateWebhookSubscriptionRequestDataAttributesStatusEnum];
|
|
5816
|
+
export declare type UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = (typeof UpdateWebhookSubscriptionRequestDataAttributesStatusEnum)[keyof typeof UpdateWebhookSubscriptionRequestDataAttributesStatusEnum];
|
|
5596
5817
|
/**
|
|
5597
5818
|
* 3D vector.
|
|
5598
5819
|
* @export
|
|
@@ -5788,7 +6009,7 @@ export interface WebhookEventDataRelationshipsOwnerData {
|
|
|
5788
6009
|
export declare const WebhookEventDataRelationshipsOwnerDataTypeEnum: {
|
|
5789
6010
|
readonly Account: "account";
|
|
5790
6011
|
};
|
|
5791
|
-
export declare type WebhookEventDataRelationshipsOwnerDataTypeEnum = typeof WebhookEventDataRelationshipsOwnerDataTypeEnum[keyof typeof WebhookEventDataRelationshipsOwnerDataTypeEnum];
|
|
6012
|
+
export declare type WebhookEventDataRelationshipsOwnerDataTypeEnum = (typeof WebhookEventDataRelationshipsOwnerDataTypeEnum)[keyof typeof WebhookEventDataRelationshipsOwnerDataTypeEnum];
|
|
5792
6013
|
/**
|
|
5793
6014
|
* Relationship to a `resource`.
|
|
5794
6015
|
* @export
|
|
@@ -5922,7 +6143,7 @@ export declare const WebhookSubscriptionDataAttributesStatusEnum: {
|
|
|
5922
6143
|
readonly Active: "active";
|
|
5923
6144
|
readonly Paused: "paused";
|
|
5924
6145
|
};
|
|
5925
|
-
export declare type WebhookSubscriptionDataAttributesStatusEnum = typeof WebhookSubscriptionDataAttributesStatusEnum[keyof typeof WebhookSubscriptionDataAttributesStatusEnum];
|
|
6146
|
+
export declare type WebhookSubscriptionDataAttributesStatusEnum = (typeof WebhookSubscriptionDataAttributesStatusEnum)[keyof typeof WebhookSubscriptionDataAttributesStatusEnum];
|
|
5926
6147
|
/**
|
|
5927
6148
|
*
|
|
5928
6149
|
* @export
|
|
@@ -6604,6 +6825,83 @@ export declare class BatchesApi extends BaseAPI {
|
|
|
6604
6825
|
*/
|
|
6605
6826
|
getQueuedBatch(requestParameters: BatchesApiGetQueuedBatchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
|
|
6606
6827
|
}
|
|
6828
|
+
/**
|
|
6829
|
+
* DefaultApi - axios parameter creator
|
|
6830
|
+
* @export
|
|
6831
|
+
*/
|
|
6832
|
+
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
6833
|
+
/**
|
|
6834
|
+
*
|
|
6835
|
+
* @param {string} id The `part-revision` ID.
|
|
6836
|
+
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
6837
|
+
* @param {*} [options] Override http request option.
|
|
6838
|
+
* @throws {RequiredError}
|
|
6839
|
+
*/
|
|
6840
|
+
createPartRendition: (id: string, createPartRenditionRequest: CreatePartRenditionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6841
|
+
};
|
|
6842
|
+
/**
|
|
6843
|
+
* DefaultApi - functional programming interface
|
|
6844
|
+
* @export
|
|
6845
|
+
*/
|
|
6846
|
+
export declare const DefaultApiFp: (configuration?: Configuration | undefined) => {
|
|
6847
|
+
/**
|
|
6848
|
+
*
|
|
6849
|
+
* @param {string} id The `part-revision` ID.
|
|
6850
|
+
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
6851
|
+
* @param {*} [options] Override http request option.
|
|
6852
|
+
* @throws {RequiredError}
|
|
6853
|
+
*/
|
|
6854
|
+
createPartRendition(id: string, createPartRenditionRequest: CreatePartRenditionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PartRendition>>;
|
|
6855
|
+
};
|
|
6856
|
+
/**
|
|
6857
|
+
* DefaultApi - factory interface
|
|
6858
|
+
* @export
|
|
6859
|
+
*/
|
|
6860
|
+
export declare const DefaultApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
6861
|
+
/**
|
|
6862
|
+
*
|
|
6863
|
+
* @param {string} id The `part-revision` ID.
|
|
6864
|
+
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
6865
|
+
* @param {*} [options] Override http request option.
|
|
6866
|
+
* @throws {RequiredError}
|
|
6867
|
+
*/
|
|
6868
|
+
createPartRendition(id: string, createPartRenditionRequest: CreatePartRenditionRequest, options?: any): AxiosPromise<PartRendition>;
|
|
6869
|
+
};
|
|
6870
|
+
/**
|
|
6871
|
+
* Request parameters for createPartRendition operation in DefaultApi.
|
|
6872
|
+
* @export
|
|
6873
|
+
* @interface DefaultApiCreatePartRenditionRequest
|
|
6874
|
+
*/
|
|
6875
|
+
export interface DefaultApiCreatePartRenditionRequest {
|
|
6876
|
+
/**
|
|
6877
|
+
* The `part-revision` ID.
|
|
6878
|
+
* @type {string}
|
|
6879
|
+
* @memberof DefaultApiCreatePartRendition
|
|
6880
|
+
*/
|
|
6881
|
+
readonly id: string;
|
|
6882
|
+
/**
|
|
6883
|
+
*
|
|
6884
|
+
* @type {CreatePartRenditionRequest}
|
|
6885
|
+
* @memberof DefaultApiCreatePartRendition
|
|
6886
|
+
*/
|
|
6887
|
+
readonly createPartRenditionRequest: CreatePartRenditionRequest;
|
|
6888
|
+
}
|
|
6889
|
+
/**
|
|
6890
|
+
* DefaultApi - object-oriented interface
|
|
6891
|
+
* @export
|
|
6892
|
+
* @class DefaultApi
|
|
6893
|
+
* @extends {BaseAPI}
|
|
6894
|
+
*/
|
|
6895
|
+
export declare class DefaultApi extends BaseAPI {
|
|
6896
|
+
/**
|
|
6897
|
+
*
|
|
6898
|
+
* @param {DefaultApiCreatePartRenditionRequest} requestParameters Request parameters.
|
|
6899
|
+
* @param {*} [options] Override http request option.
|
|
6900
|
+
* @throws {RequiredError}
|
|
6901
|
+
* @memberof DefaultApi
|
|
6902
|
+
*/
|
|
6903
|
+
createPartRendition(requestParameters: DefaultApiCreatePartRenditionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartRendition, any>>;
|
|
6904
|
+
}
|
|
6607
6905
|
/**
|
|
6608
6906
|
* ExportsApi - axios parameter creator
|
|
6609
6907
|
* @export
|
|
@@ -9860,7 +10158,7 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9860
10158
|
* @param {number} [pageSize] The number of items to return.
|
|
9861
10159
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9862
10160
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9863
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `
|
|
10161
|
+
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
|
|
9864
10162
|
* @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
|
|
9865
10163
|
* @param {*} [options] Override http request option.
|
|
9866
10164
|
* @throws {RequiredError}
|
|
@@ -9926,7 +10224,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
|
|
|
9926
10224
|
* @param {number} [pageSize] The number of items to return.
|
|
9927
10225
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9928
10226
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9929
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `
|
|
10227
|
+
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
|
|
9930
10228
|
* @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
|
|
9931
10229
|
* @param {*} [options] Override http request option.
|
|
9932
10230
|
* @throws {RequiredError}
|
|
@@ -9992,7 +10290,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
|
|
|
9992
10290
|
* @param {number} [pageSize] The number of items to return.
|
|
9993
10291
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9994
10292
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9995
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `
|
|
10293
|
+
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
|
|
9996
10294
|
* @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
|
|
9997
10295
|
* @param {*} [options] Override http request option.
|
|
9998
10296
|
* @throws {RequiredError}
|
|
@@ -10107,7 +10405,7 @@ export interface ScenesApiGetScenesRequest {
|
|
|
10107
10405
|
*/
|
|
10108
10406
|
readonly filterSuppliedId?: string;
|
|
10109
10407
|
/**
|
|
10110
|
-
* Comma-separated list of fields to return in response. An empty value returns no fields. `
|
|
10408
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
|
|
10111
10409
|
* @type {string}
|
|
10112
10410
|
* @memberof ScenesApiGetScenes
|
|
10113
10411
|
*/
|
|
@@ -10428,9 +10726,10 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
|
|
|
10428
10726
|
*/
|
|
10429
10727
|
getInspectionJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10430
10728
|
/**
|
|
10431
|
-
* Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
|
|
10729
|
+
* This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
|
|
10432
10730
|
* @param {string} id The `queued-translation` ID.
|
|
10433
10731
|
* @param {*} [options] Override http request option.
|
|
10732
|
+
* @deprecated
|
|
10434
10733
|
* @throws {RequiredError}
|
|
10435
10734
|
*/
|
|
10436
10735
|
getQueuedTranslation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -10442,11 +10741,21 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
|
|
|
10442
10741
|
*/
|
|
10443
10742
|
getQueuedTranslationJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10444
10743
|
/**
|
|
10445
|
-
* Get
|
|
10744
|
+
* Get all current translation jobs in progress.
|
|
10745
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10746
|
+
* @param {number} [pageSize] The number of items to return.
|
|
10747
|
+
* @param {string} [filterStatus] Status to filter on.
|
|
10748
|
+
* @param {*} [options] Override http request option.
|
|
10749
|
+
* @throws {RequiredError}
|
|
10750
|
+
*/
|
|
10751
|
+
getQueuedTranslationJobs: (pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10752
|
+
/**
|
|
10753
|
+
* This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
|
|
10446
10754
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10447
10755
|
* @param {number} [pageSize] The number of items to return.
|
|
10448
10756
|
* @param {string} [filterStatus] Status to filter on.
|
|
10449
10757
|
* @param {*} [options] Override http request option.
|
|
10758
|
+
* @deprecated
|
|
10450
10759
|
* @throws {RequiredError}
|
|
10451
10760
|
*/
|
|
10452
10761
|
getQueuedTranslations: (pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -10471,9 +10780,10 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
|
|
|
10471
10780
|
*/
|
|
10472
10781
|
getInspectionJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<TranslationInspectionJob>>;
|
|
10473
10782
|
/**
|
|
10474
|
-
* Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
|
|
10783
|
+
* This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
|
|
10475
10784
|
* @param {string} id The `queued-translation` ID.
|
|
10476
10785
|
* @param {*} [options] Override http request option.
|
|
10786
|
+
* @deprecated
|
|
10477
10787
|
* @throws {RequiredError}
|
|
10478
10788
|
*/
|
|
10479
10789
|
getQueuedTranslation(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
|
|
@@ -10485,11 +10795,21 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
|
|
|
10485
10795
|
*/
|
|
10486
10796
|
getQueuedTranslationJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedTranslationJob>>;
|
|
10487
10797
|
/**
|
|
10488
|
-
* Get
|
|
10798
|
+
* Get all current translation jobs in progress.
|
|
10799
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10800
|
+
* @param {number} [pageSize] The number of items to return.
|
|
10801
|
+
* @param {string} [filterStatus] Status to filter on.
|
|
10802
|
+
* @param {*} [options] Override http request option.
|
|
10803
|
+
* @throws {RequiredError}
|
|
10804
|
+
*/
|
|
10805
|
+
getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJobList>>;
|
|
10806
|
+
/**
|
|
10807
|
+
* This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
|
|
10489
10808
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10490
10809
|
* @param {number} [pageSize] The number of items to return.
|
|
10491
10810
|
* @param {string} [filterStatus] Status to filter on.
|
|
10492
10811
|
* @param {*} [options] Override http request option.
|
|
10812
|
+
* @deprecated
|
|
10493
10813
|
* @throws {RequiredError}
|
|
10494
10814
|
*/
|
|
10495
10815
|
getQueuedTranslations(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJobList>>;
|
|
@@ -10514,9 +10834,10 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
|
|
|
10514
10834
|
*/
|
|
10515
10835
|
getInspectionJob(id: string, options?: any): AxiosPromise<TranslationInspectionJob>;
|
|
10516
10836
|
/**
|
|
10517
|
-
* Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
|
|
10837
|
+
* This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
|
|
10518
10838
|
* @param {string} id The `queued-translation` ID.
|
|
10519
10839
|
* @param {*} [options] Override http request option.
|
|
10840
|
+
* @deprecated
|
|
10520
10841
|
* @throws {RequiredError}
|
|
10521
10842
|
*/
|
|
10522
10843
|
getQueuedTranslation(id: string, options?: any): AxiosPromise<QueuedJob>;
|
|
@@ -10528,11 +10849,21 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
|
|
|
10528
10849
|
*/
|
|
10529
10850
|
getQueuedTranslationJob(id: string, options?: any): AxiosPromise<QueuedTranslationJob>;
|
|
10530
10851
|
/**
|
|
10531
|
-
* Get
|
|
10852
|
+
* Get all current translation jobs in progress.
|
|
10853
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10854
|
+
* @param {number} [pageSize] The number of items to return.
|
|
10855
|
+
* @param {string} [filterStatus] Status to filter on.
|
|
10856
|
+
* @param {*} [options] Override http request option.
|
|
10857
|
+
* @throws {RequiredError}
|
|
10858
|
+
*/
|
|
10859
|
+
getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: any): AxiosPromise<QueuedJobList>;
|
|
10860
|
+
/**
|
|
10861
|
+
* This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
|
|
10532
10862
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10533
10863
|
* @param {number} [pageSize] The number of items to return.
|
|
10534
10864
|
* @param {string} [filterStatus] Status to filter on.
|
|
10535
10865
|
* @param {*} [options] Override http request option.
|
|
10866
|
+
* @deprecated
|
|
10536
10867
|
* @throws {RequiredError}
|
|
10537
10868
|
*/
|
|
10538
10869
|
getQueuedTranslations(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: any): AxiosPromise<QueuedJobList>;
|
|
@@ -10589,6 +10920,31 @@ export interface TranslationInspectionsApiGetQueuedTranslationJobRequest {
|
|
|
10589
10920
|
*/
|
|
10590
10921
|
readonly id: string;
|
|
10591
10922
|
}
|
|
10923
|
+
/**
|
|
10924
|
+
* Request parameters for getQueuedTranslationJobs operation in TranslationInspectionsApi.
|
|
10925
|
+
* @export
|
|
10926
|
+
* @interface TranslationInspectionsApiGetQueuedTranslationJobsRequest
|
|
10927
|
+
*/
|
|
10928
|
+
export interface TranslationInspectionsApiGetQueuedTranslationJobsRequest {
|
|
10929
|
+
/**
|
|
10930
|
+
* The cursor for the next page of items.
|
|
10931
|
+
* @type {string}
|
|
10932
|
+
* @memberof TranslationInspectionsApiGetQueuedTranslationJobs
|
|
10933
|
+
*/
|
|
10934
|
+
readonly pageCursor?: string;
|
|
10935
|
+
/**
|
|
10936
|
+
* The number of items to return.
|
|
10937
|
+
* @type {number}
|
|
10938
|
+
* @memberof TranslationInspectionsApiGetQueuedTranslationJobs
|
|
10939
|
+
*/
|
|
10940
|
+
readonly pageSize?: number;
|
|
10941
|
+
/**
|
|
10942
|
+
* Status to filter on.
|
|
10943
|
+
* @type {string}
|
|
10944
|
+
* @memberof TranslationInspectionsApiGetQueuedTranslationJobs
|
|
10945
|
+
*/
|
|
10946
|
+
readonly filterStatus?: string;
|
|
10947
|
+
}
|
|
10592
10948
|
/**
|
|
10593
10949
|
* Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.
|
|
10594
10950
|
* @export
|
|
@@ -10638,9 +10994,10 @@ export declare class TranslationInspectionsApi extends BaseAPI {
|
|
|
10638
10994
|
*/
|
|
10639
10995
|
getInspectionJob(requestParameters: TranslationInspectionsApiGetInspectionJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TranslationInspectionJob, any>>;
|
|
10640
10996
|
/**
|
|
10641
|
-
* Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
|
|
10997
|
+
* This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
|
|
10642
10998
|
* @param {TranslationInspectionsApiGetQueuedTranslationRequest} requestParameters Request parameters.
|
|
10643
10999
|
* @param {*} [options] Override http request option.
|
|
11000
|
+
* @deprecated
|
|
10644
11001
|
* @throws {RequiredError}
|
|
10645
11002
|
* @memberof TranslationInspectionsApi
|
|
10646
11003
|
*/
|
|
@@ -10654,9 +11011,18 @@ export declare class TranslationInspectionsApi extends BaseAPI {
|
|
|
10654
11011
|
*/
|
|
10655
11012
|
getQueuedTranslationJob(requestParameters: TranslationInspectionsApiGetQueuedTranslationJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedTranslationJob, any>>;
|
|
10656
11013
|
/**
|
|
10657
|
-
* Get
|
|
11014
|
+
* Get all current translation jobs in progress.
|
|
11015
|
+
* @param {TranslationInspectionsApiGetQueuedTranslationJobsRequest} requestParameters Request parameters.
|
|
11016
|
+
* @param {*} [options] Override http request option.
|
|
11017
|
+
* @throws {RequiredError}
|
|
11018
|
+
* @memberof TranslationInspectionsApi
|
|
11019
|
+
*/
|
|
11020
|
+
getQueuedTranslationJobs(requestParameters?: TranslationInspectionsApiGetQueuedTranslationJobsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJobList, any>>;
|
|
11021
|
+
/**
|
|
11022
|
+
* This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
|
|
10658
11023
|
* @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
|
|
10659
11024
|
* @param {*} [options] Override http request option.
|
|
11025
|
+
* @deprecated
|
|
10660
11026
|
* @throws {RequiredError}
|
|
10661
11027
|
* @memberof TranslationInspectionsApi
|
|
10662
11028
|
*/
|