@vertexvis/api-client-node 0.23.2 → 0.24.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 +673 -2
- package/dist/cjs/api.js +329 -3
- package/dist/cjs/client/helpers/parts.d.ts +3 -1
- package/dist/cjs/client/helpers/parts.js +13 -4
- package/dist/cjs/client/utils.d.ts +2 -1
- package/dist/cjs/client/utils.js +4 -2
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +673 -2
- package/dist/esm/api.js +318 -0
- package/dist/esm/client/helpers/parts.d.ts +3 -1
- package/dist/esm/client/helpers/parts.js +13 -4
- package/dist/esm/client/utils.d.ts +2 -1
- package/dist/esm/client/utils.js +4 -2
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +1 -1
package/dist/cjs/api.d.ts
CHANGED
|
@@ -1215,6 +1215,12 @@ export interface CreatePartRequestDataAttributes {
|
|
|
1215
1215
|
* @memberof CreatePartRequestDataAttributes
|
|
1216
1216
|
*/
|
|
1217
1217
|
suppliedRevisionId?: string;
|
|
1218
|
+
/**
|
|
1219
|
+
* ID provided for correlation of the revision. This is an optional ID to be able to create a version of a revision. For example, if and existing revision in a PLM system is modified, the suppliedIterationId can be used to allow creating a new part revision having an already existing suppliedId and suppliedRevisionId. This can be used when modification to an existing revision is made in the PLM system before the revision is released.
|
|
1220
|
+
* @type {string}
|
|
1221
|
+
* @memberof CreatePartRequestDataAttributes
|
|
1222
|
+
*/
|
|
1223
|
+
suppliedIterationId?: string;
|
|
1218
1224
|
/**
|
|
1219
1225
|
* Whether or not to index metadata in the part file. To ignore metadata from the part file and add your own, pass `false` for `indexMetadata` and supply custom metadata using the `metadata` field.
|
|
1220
1226
|
* @type {boolean}
|
|
@@ -1964,11 +1970,29 @@ export interface CreateStreamKeyRequestDataAttributes {
|
|
|
1964
1970
|
*/
|
|
1965
1971
|
expiry?: number;
|
|
1966
1972
|
/**
|
|
1967
|
-
* Whether to exclude non-visible items in the view
|
|
1973
|
+
* Whether to exclude non-visible items in the view.
|
|
1968
1974
|
* @type {boolean}
|
|
1969
1975
|
* @memberof CreateStreamKeyRequestDataAttributes
|
|
1970
1976
|
*/
|
|
1971
1977
|
excludePrunedItems?: boolean;
|
|
1978
|
+
/**
|
|
1979
|
+
* An optional supplied ID specifying the `scene-view-state` to initialize `scene-view`s created using this `stream-key` to. Mutually exclusive with `sceneViewStateId`.
|
|
1980
|
+
* @type {string}
|
|
1981
|
+
* @memberof CreateStreamKeyRequestDataAttributes
|
|
1982
|
+
*/
|
|
1983
|
+
sceneViewStateSuppliedId?: string;
|
|
1984
|
+
/**
|
|
1985
|
+
* An optional ID specifying the `scene-view-state` to initialize `scene-view`s created using this `stream-key` to. Mutually exclusive with `sceneViewStateSuppliedId`.
|
|
1986
|
+
* @type {string}
|
|
1987
|
+
* @memberof CreateStreamKeyRequestDataAttributes
|
|
1988
|
+
*/
|
|
1989
|
+
sceneViewStateId?: string;
|
|
1990
|
+
/**
|
|
1991
|
+
* Optionally enables or disables the creation of a search session for the view.
|
|
1992
|
+
* @type {boolean}
|
|
1993
|
+
* @memberof CreateStreamKeyRequestDataAttributes
|
|
1994
|
+
*/
|
|
1995
|
+
withSearchSession?: boolean;
|
|
1972
1996
|
}
|
|
1973
1997
|
/**
|
|
1974
1998
|
*
|
|
@@ -3394,6 +3418,42 @@ export declare const PartDataRelationshipsPartRevisionsTypeEnum: {
|
|
|
3394
3418
|
readonly PartRevision: "part-revision";
|
|
3395
3419
|
};
|
|
3396
3420
|
export declare type PartDataRelationshipsPartRevisionsTypeEnum = (typeof PartDataRelationshipsPartRevisionsTypeEnum)[keyof typeof PartDataRelationshipsPartRevisionsTypeEnum];
|
|
3421
|
+
/**
|
|
3422
|
+
* Relationship to a `part-instance`.
|
|
3423
|
+
* @export
|
|
3424
|
+
* @interface PartInstanceRelationship
|
|
3425
|
+
*/
|
|
3426
|
+
export interface PartInstanceRelationship {
|
|
3427
|
+
/**
|
|
3428
|
+
*
|
|
3429
|
+
* @type {PartInstanceRelationshipData}
|
|
3430
|
+
* @memberof PartInstanceRelationship
|
|
3431
|
+
*/
|
|
3432
|
+
data: PartInstanceRelationshipData;
|
|
3433
|
+
}
|
|
3434
|
+
/**
|
|
3435
|
+
*
|
|
3436
|
+
* @export
|
|
3437
|
+
* @interface PartInstanceRelationshipData
|
|
3438
|
+
*/
|
|
3439
|
+
export interface PartInstanceRelationshipData {
|
|
3440
|
+
/**
|
|
3441
|
+
* Resource object type.
|
|
3442
|
+
* @type {string}
|
|
3443
|
+
* @memberof PartInstanceRelationshipData
|
|
3444
|
+
*/
|
|
3445
|
+
type: PartInstanceRelationshipDataTypeEnum;
|
|
3446
|
+
/**
|
|
3447
|
+
* ID of the resource.
|
|
3448
|
+
* @type {string}
|
|
3449
|
+
* @memberof PartInstanceRelationshipData
|
|
3450
|
+
*/
|
|
3451
|
+
id: string;
|
|
3452
|
+
}
|
|
3453
|
+
export declare const PartInstanceRelationshipDataTypeEnum: {
|
|
3454
|
+
readonly PartInstance: "part-instance";
|
|
3455
|
+
};
|
|
3456
|
+
export declare type PartInstanceRelationshipDataTypeEnum = (typeof PartInstanceRelationshipDataTypeEnum)[keyof typeof PartInstanceRelationshipDataTypeEnum];
|
|
3397
3457
|
/**
|
|
3398
3458
|
*
|
|
3399
3459
|
* @export
|
|
@@ -3685,6 +3745,12 @@ export interface PartRevisionDataAttributes {
|
|
|
3685
3745
|
* @memberof PartRevisionDataAttributes
|
|
3686
3746
|
*/
|
|
3687
3747
|
suppliedId?: string;
|
|
3748
|
+
/**
|
|
3749
|
+
*
|
|
3750
|
+
* @type {string}
|
|
3751
|
+
* @memberof PartRevisionDataAttributes
|
|
3752
|
+
*/
|
|
3753
|
+
suppliedIterationId?: string;
|
|
3688
3754
|
/**
|
|
3689
3755
|
*
|
|
3690
3756
|
* @type {string}
|
|
@@ -3748,6 +3814,90 @@ export interface PartRevisionInstance {
|
|
|
3748
3814
|
*/
|
|
3749
3815
|
transform?: Matrix4;
|
|
3750
3816
|
}
|
|
3817
|
+
/**
|
|
3818
|
+
*
|
|
3819
|
+
* @export
|
|
3820
|
+
* @interface PartRevisionInstanceData
|
|
3821
|
+
*/
|
|
3822
|
+
export interface PartRevisionInstanceData {
|
|
3823
|
+
/**
|
|
3824
|
+
*
|
|
3825
|
+
* @type {string}
|
|
3826
|
+
* @memberof PartRevisionInstanceData
|
|
3827
|
+
*/
|
|
3828
|
+
type: string;
|
|
3829
|
+
/**
|
|
3830
|
+
* ID of the resource.
|
|
3831
|
+
* @type {string}
|
|
3832
|
+
* @memberof PartRevisionInstanceData
|
|
3833
|
+
*/
|
|
3834
|
+
id: string;
|
|
3835
|
+
/**
|
|
3836
|
+
*
|
|
3837
|
+
* @type {PartRevisionInstanceDataAttributes}
|
|
3838
|
+
* @memberof PartRevisionInstanceData
|
|
3839
|
+
*/
|
|
3840
|
+
attributes: PartRevisionInstanceDataAttributes;
|
|
3841
|
+
/**
|
|
3842
|
+
*
|
|
3843
|
+
* @type {PartRevisionInstanceDataRelationships}
|
|
3844
|
+
* @memberof PartRevisionInstanceData
|
|
3845
|
+
*/
|
|
3846
|
+
relationships: PartRevisionInstanceDataRelationships;
|
|
3847
|
+
}
|
|
3848
|
+
/**
|
|
3849
|
+
*
|
|
3850
|
+
* @export
|
|
3851
|
+
* @interface PartRevisionInstanceDataAttributes
|
|
3852
|
+
*/
|
|
3853
|
+
export interface PartRevisionInstanceDataAttributes {
|
|
3854
|
+
/**
|
|
3855
|
+
* A 0-based index used for defining a consistent ordering for children of an assembly
|
|
3856
|
+
* @type {number}
|
|
3857
|
+
* @memberof PartRevisionInstanceDataAttributes
|
|
3858
|
+
*/
|
|
3859
|
+
ordinal?: number;
|
|
3860
|
+
/**
|
|
3861
|
+
*
|
|
3862
|
+
* @type {Matrix4}
|
|
3863
|
+
* @memberof PartRevisionInstanceDataAttributes
|
|
3864
|
+
*/
|
|
3865
|
+
transform?: Matrix4;
|
|
3866
|
+
}
|
|
3867
|
+
/**
|
|
3868
|
+
* This is the relationship from the instance to the parent revision
|
|
3869
|
+
* @export
|
|
3870
|
+
* @interface PartRevisionInstanceDataRelationships
|
|
3871
|
+
*/
|
|
3872
|
+
export interface PartRevisionInstanceDataRelationships {
|
|
3873
|
+
/**
|
|
3874
|
+
*
|
|
3875
|
+
* @type {PartRevisionRelationship}
|
|
3876
|
+
* @memberof PartRevisionInstanceDataRelationships
|
|
3877
|
+
*/
|
|
3878
|
+
partRevision: PartRevisionRelationship;
|
|
3879
|
+
}
|
|
3880
|
+
/**
|
|
3881
|
+
*
|
|
3882
|
+
* @export
|
|
3883
|
+
* @interface PartRevisionInstanceList
|
|
3884
|
+
*/
|
|
3885
|
+
export interface PartRevisionInstanceList {
|
|
3886
|
+
/**
|
|
3887
|
+
*
|
|
3888
|
+
* @type {Array<PartRevisionInstanceData>}
|
|
3889
|
+
* @memberof PartRevisionInstanceList
|
|
3890
|
+
*/
|
|
3891
|
+
data: Array<PartRevisionInstanceData>;
|
|
3892
|
+
/**
|
|
3893
|
+
*
|
|
3894
|
+
* @type {{ [key: string]: Link; }}
|
|
3895
|
+
* @memberof PartRevisionInstanceList
|
|
3896
|
+
*/
|
|
3897
|
+
links: {
|
|
3898
|
+
[key: string]: Link;
|
|
3899
|
+
};
|
|
3900
|
+
}
|
|
3751
3901
|
/**
|
|
3752
3902
|
*
|
|
3753
3903
|
* @export
|
|
@@ -3800,6 +3950,12 @@ export interface PartRevisionSuppliedId {
|
|
|
3800
3950
|
* @memberof PartRevisionSuppliedId
|
|
3801
3951
|
*/
|
|
3802
3952
|
suppliedRevisionId: string;
|
|
3953
|
+
/**
|
|
3954
|
+
* Optional iteration ID for the revision. For example, a generated version id from a PLM system to a specific revision. Used when a existing revision is modified.
|
|
3955
|
+
* @type {string}
|
|
3956
|
+
* @memberof PartRevisionSuppliedId
|
|
3957
|
+
*/
|
|
3958
|
+
suppliedIterationId?: string;
|
|
3803
3959
|
}
|
|
3804
3960
|
/**
|
|
3805
3961
|
* A camera type that mimics the way the human eye sees.
|
|
@@ -3911,6 +4067,220 @@ export interface Point {
|
|
|
3911
4067
|
*/
|
|
3912
4068
|
dy: number;
|
|
3913
4069
|
}
|
|
4070
|
+
/**
|
|
4071
|
+
*
|
|
4072
|
+
* @export
|
|
4073
|
+
* @interface PropertyDateType
|
|
4074
|
+
*/
|
|
4075
|
+
export interface PropertyDateType {
|
|
4076
|
+
/**
|
|
4077
|
+
* Type of property value.
|
|
4078
|
+
* @type {string}
|
|
4079
|
+
* @memberof PropertyDateType
|
|
4080
|
+
*/
|
|
4081
|
+
type: PropertyDateTypeTypeEnum;
|
|
4082
|
+
/**
|
|
4083
|
+
* A date value.
|
|
4084
|
+
* @type {string}
|
|
4085
|
+
* @memberof PropertyDateType
|
|
4086
|
+
*/
|
|
4087
|
+
value: string;
|
|
4088
|
+
}
|
|
4089
|
+
export declare const PropertyDateTypeTypeEnum: {
|
|
4090
|
+
readonly Date: "date";
|
|
4091
|
+
};
|
|
4092
|
+
export declare type PropertyDateTypeTypeEnum = (typeof PropertyDateTypeTypeEnum)[keyof typeof PropertyDateTypeTypeEnum];
|
|
4093
|
+
/**
|
|
4094
|
+
*
|
|
4095
|
+
* @export
|
|
4096
|
+
* @interface PropertyDoubleType
|
|
4097
|
+
*/
|
|
4098
|
+
export interface PropertyDoubleType {
|
|
4099
|
+
/**
|
|
4100
|
+
* Type of property value.
|
|
4101
|
+
* @type {string}
|
|
4102
|
+
* @memberof PropertyDoubleType
|
|
4103
|
+
*/
|
|
4104
|
+
type: PropertyDoubleTypeTypeEnum;
|
|
4105
|
+
/**
|
|
4106
|
+
*
|
|
4107
|
+
* @type {number}
|
|
4108
|
+
* @memberof PropertyDoubleType
|
|
4109
|
+
*/
|
|
4110
|
+
value: number;
|
|
4111
|
+
}
|
|
4112
|
+
export declare const PropertyDoubleTypeTypeEnum: {
|
|
4113
|
+
readonly Double: "double";
|
|
4114
|
+
};
|
|
4115
|
+
export declare type PropertyDoubleTypeTypeEnum = (typeof PropertyDoubleTypeTypeEnum)[keyof typeof PropertyDoubleTypeTypeEnum];
|
|
4116
|
+
/**
|
|
4117
|
+
*
|
|
4118
|
+
* @export
|
|
4119
|
+
* @interface PropertyEntryData
|
|
4120
|
+
*/
|
|
4121
|
+
export interface PropertyEntryData {
|
|
4122
|
+
/**
|
|
4123
|
+
*
|
|
4124
|
+
* @type {string}
|
|
4125
|
+
* @memberof PropertyEntryData
|
|
4126
|
+
*/
|
|
4127
|
+
type: string;
|
|
4128
|
+
/**
|
|
4129
|
+
*
|
|
4130
|
+
* @type {string}
|
|
4131
|
+
* @memberof PropertyEntryData
|
|
4132
|
+
*/
|
|
4133
|
+
id: string;
|
|
4134
|
+
/**
|
|
4135
|
+
*
|
|
4136
|
+
* @type {PropertyEntryDataAttributes}
|
|
4137
|
+
* @memberof PropertyEntryData
|
|
4138
|
+
*/
|
|
4139
|
+
attributes: PropertyEntryDataAttributes;
|
|
4140
|
+
/**
|
|
4141
|
+
*
|
|
4142
|
+
* @type {{ [key: string]: Link; }}
|
|
4143
|
+
* @memberof PropertyEntryData
|
|
4144
|
+
*/
|
|
4145
|
+
links?: {
|
|
4146
|
+
[key: string]: Link;
|
|
4147
|
+
};
|
|
4148
|
+
}
|
|
4149
|
+
/**
|
|
4150
|
+
*
|
|
4151
|
+
* @export
|
|
4152
|
+
* @interface PropertyEntryDataAttributes
|
|
4153
|
+
*/
|
|
4154
|
+
export interface PropertyEntryDataAttributes {
|
|
4155
|
+
/**
|
|
4156
|
+
*
|
|
4157
|
+
* @type {PropertyStringType | PropertyDoubleType | PropertyLongType | PropertyDateType}
|
|
4158
|
+
* @memberof PropertyEntryDataAttributes
|
|
4159
|
+
*/
|
|
4160
|
+
value: PropertyStringType | PropertyDoubleType | PropertyLongType | PropertyDateType;
|
|
4161
|
+
/**
|
|
4162
|
+
*
|
|
4163
|
+
* @type {PropertyKeyType}
|
|
4164
|
+
* @memberof PropertyEntryDataAttributes
|
|
4165
|
+
*/
|
|
4166
|
+
key: PropertyKeyType;
|
|
4167
|
+
}
|
|
4168
|
+
/**
|
|
4169
|
+
*
|
|
4170
|
+
* @export
|
|
4171
|
+
* @interface PropertyEntryList
|
|
4172
|
+
*/
|
|
4173
|
+
export interface PropertyEntryList {
|
|
4174
|
+
/**
|
|
4175
|
+
*
|
|
4176
|
+
* @type {Array<PropertyEntryData>}
|
|
4177
|
+
* @memberof PropertyEntryList
|
|
4178
|
+
*/
|
|
4179
|
+
data: Array<PropertyEntryData>;
|
|
4180
|
+
/**
|
|
4181
|
+
*
|
|
4182
|
+
* @type {{ [key: string]: Link; }}
|
|
4183
|
+
* @memberof PropertyEntryList
|
|
4184
|
+
*/
|
|
4185
|
+
links: {
|
|
4186
|
+
[key: string]: Link;
|
|
4187
|
+
};
|
|
4188
|
+
}
|
|
4189
|
+
/**
|
|
4190
|
+
*
|
|
4191
|
+
* @export
|
|
4192
|
+
* @interface PropertyKeyType
|
|
4193
|
+
*/
|
|
4194
|
+
export interface PropertyKeyType {
|
|
4195
|
+
/**
|
|
4196
|
+
*
|
|
4197
|
+
* @type {string}
|
|
4198
|
+
* @memberof PropertyKeyType
|
|
4199
|
+
*/
|
|
4200
|
+
name: string;
|
|
4201
|
+
}
|
|
4202
|
+
/**
|
|
4203
|
+
*
|
|
4204
|
+
* @export
|
|
4205
|
+
* @interface PropertyLongType
|
|
4206
|
+
*/
|
|
4207
|
+
export interface PropertyLongType {
|
|
4208
|
+
/**
|
|
4209
|
+
* Type of property-entry value.
|
|
4210
|
+
* @type {string}
|
|
4211
|
+
* @memberof PropertyLongType
|
|
4212
|
+
*/
|
|
4213
|
+
type: PropertyLongTypeTypeEnum;
|
|
4214
|
+
/**
|
|
4215
|
+
* A numerical long value.
|
|
4216
|
+
* @type {number}
|
|
4217
|
+
* @memberof PropertyLongType
|
|
4218
|
+
*/
|
|
4219
|
+
value: number;
|
|
4220
|
+
}
|
|
4221
|
+
export declare const PropertyLongTypeTypeEnum: {
|
|
4222
|
+
readonly Long: "long";
|
|
4223
|
+
};
|
|
4224
|
+
export declare type PropertyLongTypeTypeEnum = (typeof PropertyLongTypeTypeEnum)[keyof typeof PropertyLongTypeTypeEnum];
|
|
4225
|
+
/**
|
|
4226
|
+
* Relationship to a `property-set`.
|
|
4227
|
+
* @export
|
|
4228
|
+
* @interface PropertySetRelationship
|
|
4229
|
+
*/
|
|
4230
|
+
export interface PropertySetRelationship {
|
|
4231
|
+
/**
|
|
4232
|
+
*
|
|
4233
|
+
* @type {PropertySetRelationshipData}
|
|
4234
|
+
* @memberof PropertySetRelationship
|
|
4235
|
+
*/
|
|
4236
|
+
data: PropertySetRelationshipData;
|
|
4237
|
+
}
|
|
4238
|
+
/**
|
|
4239
|
+
*
|
|
4240
|
+
* @export
|
|
4241
|
+
* @interface PropertySetRelationshipData
|
|
4242
|
+
*/
|
|
4243
|
+
export interface PropertySetRelationshipData {
|
|
4244
|
+
/**
|
|
4245
|
+
* Resource object type.
|
|
4246
|
+
* @type {string}
|
|
4247
|
+
* @memberof PropertySetRelationshipData
|
|
4248
|
+
*/
|
|
4249
|
+
type: PropertySetRelationshipDataTypeEnum;
|
|
4250
|
+
/**
|
|
4251
|
+
* ID of the resource.
|
|
4252
|
+
* @type {string}
|
|
4253
|
+
* @memberof PropertySetRelationshipData
|
|
4254
|
+
*/
|
|
4255
|
+
id: string;
|
|
4256
|
+
}
|
|
4257
|
+
export declare const PropertySetRelationshipDataTypeEnum: {
|
|
4258
|
+
readonly PropertySet: "property-set";
|
|
4259
|
+
};
|
|
4260
|
+
export declare type PropertySetRelationshipDataTypeEnum = (typeof PropertySetRelationshipDataTypeEnum)[keyof typeof PropertySetRelationshipDataTypeEnum];
|
|
4261
|
+
/**
|
|
4262
|
+
*
|
|
4263
|
+
* @export
|
|
4264
|
+
* @interface PropertyStringType
|
|
4265
|
+
*/
|
|
4266
|
+
export interface PropertyStringType {
|
|
4267
|
+
/**
|
|
4268
|
+
* Type of property-entry value.
|
|
4269
|
+
* @type {string}
|
|
4270
|
+
* @memberof PropertyStringType
|
|
4271
|
+
*/
|
|
4272
|
+
type: PropertyStringTypeTypeEnum;
|
|
4273
|
+
/**
|
|
4274
|
+
* A string value.
|
|
4275
|
+
* @type {string}
|
|
4276
|
+
* @memberof PropertyStringType
|
|
4277
|
+
*/
|
|
4278
|
+
value: string;
|
|
4279
|
+
}
|
|
4280
|
+
export declare const PropertyStringTypeTypeEnum: {
|
|
4281
|
+
readonly String: "string";
|
|
4282
|
+
};
|
|
4283
|
+
export declare type PropertyStringTypeTypeEnum = (typeof PropertyStringTypeTypeEnum)[keyof typeof PropertyStringTypeTypeEnum];
|
|
3914
4284
|
/**
|
|
3915
4285
|
* Resource object type.
|
|
3916
4286
|
* @export
|
|
@@ -5906,6 +6276,18 @@ export interface StreamKeyDataAttributes {
|
|
|
5906
6276
|
* @memberof StreamKeyDataAttributes
|
|
5907
6277
|
*/
|
|
5908
6278
|
excludePrunedItems?: boolean;
|
|
6279
|
+
/**
|
|
6280
|
+
*
|
|
6281
|
+
* @type {string}
|
|
6282
|
+
* @memberof StreamKeyDataAttributes
|
|
6283
|
+
*/
|
|
6284
|
+
sceneViewStateSuppliedId?: string;
|
|
6285
|
+
/**
|
|
6286
|
+
* ID of the resource.
|
|
6287
|
+
* @type {string}
|
|
6288
|
+
* @memberof StreamKeyDataAttributes
|
|
6289
|
+
*/
|
|
6290
|
+
sceneViewStateId?: string;
|
|
5909
6291
|
}
|
|
5910
6292
|
/**
|
|
5911
6293
|
*
|
|
@@ -6602,7 +6984,7 @@ export interface UpdateSceneRequestDataAttributes {
|
|
|
6602
6984
|
* @type {string}
|
|
6603
6985
|
* @memberof UpdateSceneRequestDataAttributes
|
|
6604
6986
|
*/
|
|
6605
|
-
suppliedId?: string;
|
|
6987
|
+
suppliedId?: string | null;
|
|
6606
6988
|
/**
|
|
6607
6989
|
*
|
|
6608
6990
|
* @type {string}
|
|
@@ -6786,6 +7168,72 @@ export declare const UpdateWebhookSubscriptionRequestDataAttributesStatusEnum: {
|
|
|
6786
7168
|
readonly Paused: "paused";
|
|
6787
7169
|
};
|
|
6788
7170
|
export declare type UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = (typeof UpdateWebhookSubscriptionRequestDataAttributesStatusEnum)[keyof typeof UpdateWebhookSubscriptionRequestDataAttributesStatusEnum];
|
|
7171
|
+
/**
|
|
7172
|
+
*
|
|
7173
|
+
* @export
|
|
7174
|
+
* @interface UpsertPropertyEntriesRequest
|
|
7175
|
+
*/
|
|
7176
|
+
export interface UpsertPropertyEntriesRequest {
|
|
7177
|
+
/**
|
|
7178
|
+
*
|
|
7179
|
+
* @type {UpsertPropertyEntriesRequestData}
|
|
7180
|
+
* @memberof UpsertPropertyEntriesRequest
|
|
7181
|
+
*/
|
|
7182
|
+
data: UpsertPropertyEntriesRequestData;
|
|
7183
|
+
}
|
|
7184
|
+
/**
|
|
7185
|
+
*
|
|
7186
|
+
* @export
|
|
7187
|
+
* @interface UpsertPropertyEntriesRequestData
|
|
7188
|
+
*/
|
|
7189
|
+
export interface UpsertPropertyEntriesRequestData {
|
|
7190
|
+
/**
|
|
7191
|
+
* Resource object type.
|
|
7192
|
+
* @type {string}
|
|
7193
|
+
* @memberof UpsertPropertyEntriesRequestData
|
|
7194
|
+
*/
|
|
7195
|
+
type: string;
|
|
7196
|
+
/**
|
|
7197
|
+
*
|
|
7198
|
+
* @type {UpsertPropertyEntriesRequestDataAttributes}
|
|
7199
|
+
* @memberof UpsertPropertyEntriesRequestData
|
|
7200
|
+
*/
|
|
7201
|
+
attributes: UpsertPropertyEntriesRequestDataAttributes;
|
|
7202
|
+
/**
|
|
7203
|
+
*
|
|
7204
|
+
* @type {UpsertPropertyEntriesRequestDataRelationships}
|
|
7205
|
+
* @memberof UpsertPropertyEntriesRequestData
|
|
7206
|
+
*/
|
|
7207
|
+
relationships: UpsertPropertyEntriesRequestDataRelationships;
|
|
7208
|
+
}
|
|
7209
|
+
/**
|
|
7210
|
+
*
|
|
7211
|
+
* @export
|
|
7212
|
+
* @interface UpsertPropertyEntriesRequestDataAttributes
|
|
7213
|
+
*/
|
|
7214
|
+
export interface UpsertPropertyEntriesRequestDataAttributes {
|
|
7215
|
+
/**
|
|
7216
|
+
* Property entries for a provided resource or property set.
|
|
7217
|
+
* @type {{ [key: string]: PropertyStringType | PropertyDoubleType | PropertyLongType | PropertyDateType | object; }}
|
|
7218
|
+
* @memberof UpsertPropertyEntriesRequestDataAttributes
|
|
7219
|
+
*/
|
|
7220
|
+
entries: {
|
|
7221
|
+
[key: string]: PropertyStringType | PropertyDoubleType | PropertyLongType | PropertyDateType | object;
|
|
7222
|
+
};
|
|
7223
|
+
}
|
|
7224
|
+
/**
|
|
7225
|
+
*
|
|
7226
|
+
* @export
|
|
7227
|
+
* @interface UpsertPropertyEntriesRequestDataRelationships
|
|
7228
|
+
*/
|
|
7229
|
+
export interface UpsertPropertyEntriesRequestDataRelationships {
|
|
7230
|
+
/**
|
|
7231
|
+
* Relationship to the property set by `property-set`, `part-revision`, `part-instance` or `scene-item`.
|
|
7232
|
+
* @type {PropertySetRelationship | PartRevisionRelationship | SceneItemRelationship | PartInstanceRelationship}
|
|
7233
|
+
* @memberof UpsertPropertyEntriesRequestDataRelationships
|
|
7234
|
+
*/
|
|
7235
|
+
propertySet: PropertySetRelationship | PartRevisionRelationship | SceneItemRelationship | PartInstanceRelationship;
|
|
7236
|
+
}
|
|
6789
7237
|
/**
|
|
6790
7238
|
* 3D vector.
|
|
6791
7239
|
* @export
|
|
@@ -9477,6 +9925,92 @@ export declare class PartRenditionsApi extends BaseAPI {
|
|
|
9477
9925
|
*/
|
|
9478
9926
|
getPartRenditions(requestParameters?: PartRenditionsApiGetPartRenditionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartRenditionList, any>>;
|
|
9479
9927
|
}
|
|
9928
|
+
/**
|
|
9929
|
+
* PartRevisionInstancesApi - axios parameter creator
|
|
9930
|
+
* @export
|
|
9931
|
+
*/
|
|
9932
|
+
export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
9933
|
+
/**
|
|
9934
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
9935
|
+
* @param {string} [filterParent] Parent ID to filter on.
|
|
9936
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9937
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9938
|
+
* @param {*} [options] Override http request option.
|
|
9939
|
+
* @throws {RequiredError}
|
|
9940
|
+
*/
|
|
9941
|
+
getPartRevisionInstanceList: (filterParent?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9942
|
+
};
|
|
9943
|
+
/**
|
|
9944
|
+
* PartRevisionInstancesApi - functional programming interface
|
|
9945
|
+
* @export
|
|
9946
|
+
*/
|
|
9947
|
+
export declare const PartRevisionInstancesApiFp: (configuration?: Configuration | undefined) => {
|
|
9948
|
+
/**
|
|
9949
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
9950
|
+
* @param {string} [filterParent] Parent ID to filter on.
|
|
9951
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9952
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9953
|
+
* @param {*} [options] Override http request option.
|
|
9954
|
+
* @throws {RequiredError}
|
|
9955
|
+
*/
|
|
9956
|
+
getPartRevisionInstanceList(filterParent?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PartRevisionInstanceList>>;
|
|
9957
|
+
};
|
|
9958
|
+
/**
|
|
9959
|
+
* PartRevisionInstancesApi - factory interface
|
|
9960
|
+
* @export
|
|
9961
|
+
*/
|
|
9962
|
+
export declare const PartRevisionInstancesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
9963
|
+
/**
|
|
9964
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
9965
|
+
* @param {string} [filterParent] Parent ID to filter on.
|
|
9966
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
9967
|
+
* @param {number} [pageSize] The number of items to return.
|
|
9968
|
+
* @param {*} [options] Override http request option.
|
|
9969
|
+
* @throws {RequiredError}
|
|
9970
|
+
*/
|
|
9971
|
+
getPartRevisionInstanceList(filterParent?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<PartRevisionInstanceList>;
|
|
9972
|
+
};
|
|
9973
|
+
/**
|
|
9974
|
+
* Request parameters for getPartRevisionInstanceList operation in PartRevisionInstancesApi.
|
|
9975
|
+
* @export
|
|
9976
|
+
* @interface PartRevisionInstancesApiGetPartRevisionInstanceListRequest
|
|
9977
|
+
*/
|
|
9978
|
+
export interface PartRevisionInstancesApiGetPartRevisionInstanceListRequest {
|
|
9979
|
+
/**
|
|
9980
|
+
* Parent ID to filter on.
|
|
9981
|
+
* @type {string}
|
|
9982
|
+
* @memberof PartRevisionInstancesApiGetPartRevisionInstanceList
|
|
9983
|
+
*/
|
|
9984
|
+
readonly filterParent?: string;
|
|
9985
|
+
/**
|
|
9986
|
+
* The cursor for the next page of items.
|
|
9987
|
+
* @type {string}
|
|
9988
|
+
* @memberof PartRevisionInstancesApiGetPartRevisionInstanceList
|
|
9989
|
+
*/
|
|
9990
|
+
readonly pageCursor?: string;
|
|
9991
|
+
/**
|
|
9992
|
+
* The number of items to return.
|
|
9993
|
+
* @type {number}
|
|
9994
|
+
* @memberof PartRevisionInstancesApiGetPartRevisionInstanceList
|
|
9995
|
+
*/
|
|
9996
|
+
readonly pageSize?: number;
|
|
9997
|
+
}
|
|
9998
|
+
/**
|
|
9999
|
+
* PartRevisionInstancesApi - object-oriented interface
|
|
10000
|
+
* @export
|
|
10001
|
+
* @class PartRevisionInstancesApi
|
|
10002
|
+
* @extends {BaseAPI}
|
|
10003
|
+
*/
|
|
10004
|
+
export declare class PartRevisionInstancesApi extends BaseAPI {
|
|
10005
|
+
/**
|
|
10006
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
10007
|
+
* @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
|
|
10008
|
+
* @param {*} [options] Override http request option.
|
|
10009
|
+
* @throws {RequiredError}
|
|
10010
|
+
* @memberof PartRevisionInstancesApi
|
|
10011
|
+
*/
|
|
10012
|
+
getPartRevisionInstanceList(requestParameters?: PartRevisionInstancesApiGetPartRevisionInstanceListRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartRevisionInstanceList, any>>;
|
|
10013
|
+
}
|
|
9480
10014
|
/**
|
|
9481
10015
|
* PartRevisionsApi - axios parameter creator
|
|
9482
10016
|
* @export
|
|
@@ -10257,6 +10791,143 @@ export declare class PmiApi extends BaseAPI {
|
|
|
10257
10791
|
*/
|
|
10258
10792
|
getPmiAnnotations(requestParameters?: PmiApiGetPmiAnnotationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PmiAnnotationList, any>>;
|
|
10259
10793
|
}
|
|
10794
|
+
/**
|
|
10795
|
+
* PropertyEntriesApi - axios parameter creator
|
|
10796
|
+
* @export
|
|
10797
|
+
*/
|
|
10798
|
+
export declare const PropertyEntriesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
10799
|
+
/**
|
|
10800
|
+
* Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
|
|
10801
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10802
|
+
* @param {number} [pageSize] The number of items to return.
|
|
10803
|
+
* @param {string} [filterResourceId] A resource ID to filter on
|
|
10804
|
+
* @param {string} [filterResourceType] The provided type for the resource ids
|
|
10805
|
+
* @param {*} [options] Override http request option.
|
|
10806
|
+
* @throws {RequiredError}
|
|
10807
|
+
*/
|
|
10808
|
+
getPropertyEntries: (pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10809
|
+
/**
|
|
10810
|
+
* Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
|
|
10811
|
+
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
10812
|
+
* @param {*} [options] Override http request option.
|
|
10813
|
+
* @throws {RequiredError}
|
|
10814
|
+
*/
|
|
10815
|
+
upsertPropertyEntries: (upsertPropertyEntriesRequest: UpsertPropertyEntriesRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10816
|
+
};
|
|
10817
|
+
/**
|
|
10818
|
+
* PropertyEntriesApi - functional programming interface
|
|
10819
|
+
* @export
|
|
10820
|
+
*/
|
|
10821
|
+
export declare const PropertyEntriesApiFp: (configuration?: Configuration | undefined) => {
|
|
10822
|
+
/**
|
|
10823
|
+
* Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
|
|
10824
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10825
|
+
* @param {number} [pageSize] The number of items to return.
|
|
10826
|
+
* @param {string} [filterResourceId] A resource ID to filter on
|
|
10827
|
+
* @param {string} [filterResourceType] The provided type for the resource ids
|
|
10828
|
+
* @param {*} [options] Override http request option.
|
|
10829
|
+
* @throws {RequiredError}
|
|
10830
|
+
*/
|
|
10831
|
+
getPropertyEntries(pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PropertyEntryList>>;
|
|
10832
|
+
/**
|
|
10833
|
+
* Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
|
|
10834
|
+
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
10835
|
+
* @param {*} [options] Override http request option.
|
|
10836
|
+
* @throws {RequiredError}
|
|
10837
|
+
*/
|
|
10838
|
+
upsertPropertyEntries(upsertPropertyEntriesRequest: UpsertPropertyEntriesRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
10839
|
+
};
|
|
10840
|
+
/**
|
|
10841
|
+
* PropertyEntriesApi - factory interface
|
|
10842
|
+
* @export
|
|
10843
|
+
*/
|
|
10844
|
+
export declare const PropertyEntriesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
10845
|
+
/**
|
|
10846
|
+
* Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
|
|
10847
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
10848
|
+
* @param {number} [pageSize] The number of items to return.
|
|
10849
|
+
* @param {string} [filterResourceId] A resource ID to filter on
|
|
10850
|
+
* @param {string} [filterResourceType] The provided type for the resource ids
|
|
10851
|
+
* @param {*} [options] Override http request option.
|
|
10852
|
+
* @throws {RequiredError}
|
|
10853
|
+
*/
|
|
10854
|
+
getPropertyEntries(pageCursor?: string | undefined, pageSize?: number | undefined, filterResourceId?: string | undefined, filterResourceType?: string | undefined, options?: any): AxiosPromise<PropertyEntryList>;
|
|
10855
|
+
/**
|
|
10856
|
+
* Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
|
|
10857
|
+
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
10858
|
+
* @param {*} [options] Override http request option.
|
|
10859
|
+
* @throws {RequiredError}
|
|
10860
|
+
*/
|
|
10861
|
+
upsertPropertyEntries(upsertPropertyEntriesRequest: UpsertPropertyEntriesRequest, options?: any): AxiosPromise<void>;
|
|
10862
|
+
};
|
|
10863
|
+
/**
|
|
10864
|
+
* Request parameters for getPropertyEntries operation in PropertyEntriesApi.
|
|
10865
|
+
* @export
|
|
10866
|
+
* @interface PropertyEntriesApiGetPropertyEntriesRequest
|
|
10867
|
+
*/
|
|
10868
|
+
export interface PropertyEntriesApiGetPropertyEntriesRequest {
|
|
10869
|
+
/**
|
|
10870
|
+
* The cursor for the next page of items.
|
|
10871
|
+
* @type {string}
|
|
10872
|
+
* @memberof PropertyEntriesApiGetPropertyEntries
|
|
10873
|
+
*/
|
|
10874
|
+
readonly pageCursor?: string;
|
|
10875
|
+
/**
|
|
10876
|
+
* The number of items to return.
|
|
10877
|
+
* @type {number}
|
|
10878
|
+
* @memberof PropertyEntriesApiGetPropertyEntries
|
|
10879
|
+
*/
|
|
10880
|
+
readonly pageSize?: number;
|
|
10881
|
+
/**
|
|
10882
|
+
* A resource ID to filter on
|
|
10883
|
+
* @type {string}
|
|
10884
|
+
* @memberof PropertyEntriesApiGetPropertyEntries
|
|
10885
|
+
*/
|
|
10886
|
+
readonly filterResourceId?: string;
|
|
10887
|
+
/**
|
|
10888
|
+
* The provided type for the resource ids
|
|
10889
|
+
* @type {string}
|
|
10890
|
+
* @memberof PropertyEntriesApiGetPropertyEntries
|
|
10891
|
+
*/
|
|
10892
|
+
readonly filterResourceType?: string;
|
|
10893
|
+
}
|
|
10894
|
+
/**
|
|
10895
|
+
* Request parameters for upsertPropertyEntries operation in PropertyEntriesApi.
|
|
10896
|
+
* @export
|
|
10897
|
+
* @interface PropertyEntriesApiUpsertPropertyEntriesRequest
|
|
10898
|
+
*/
|
|
10899
|
+
export interface PropertyEntriesApiUpsertPropertyEntriesRequest {
|
|
10900
|
+
/**
|
|
10901
|
+
*
|
|
10902
|
+
* @type {UpsertPropertyEntriesRequest}
|
|
10903
|
+
* @memberof PropertyEntriesApiUpsertPropertyEntries
|
|
10904
|
+
*/
|
|
10905
|
+
readonly upsertPropertyEntriesRequest: UpsertPropertyEntriesRequest;
|
|
10906
|
+
}
|
|
10907
|
+
/**
|
|
10908
|
+
* PropertyEntriesApi - object-oriented interface
|
|
10909
|
+
* @export
|
|
10910
|
+
* @class PropertyEntriesApi
|
|
10911
|
+
* @extends {BaseAPI}
|
|
10912
|
+
*/
|
|
10913
|
+
export declare class PropertyEntriesApi extends BaseAPI {
|
|
10914
|
+
/**
|
|
10915
|
+
* Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
|
|
10916
|
+
* @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
|
|
10917
|
+
* @param {*} [options] Override http request option.
|
|
10918
|
+
* @throws {RequiredError}
|
|
10919
|
+
* @memberof PropertyEntriesApi
|
|
10920
|
+
*/
|
|
10921
|
+
getPropertyEntries(requestParameters?: PropertyEntriesApiGetPropertyEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PropertyEntryList, any>>;
|
|
10922
|
+
/**
|
|
10923
|
+
* Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
|
|
10924
|
+
* @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
|
|
10925
|
+
* @param {*} [options] Override http request option.
|
|
10926
|
+
* @throws {RequiredError}
|
|
10927
|
+
* @memberof PropertyEntriesApi
|
|
10928
|
+
*/
|
|
10929
|
+
upsertPropertyEntries(requestParameters: PropertyEntriesApiUpsertPropertyEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10930
|
+
}
|
|
10260
10931
|
/**
|
|
10261
10932
|
* SceneAlterationsApi - axios parameter creator
|
|
10262
10933
|
* @export
|