@vertexvis/api-client-node 0.22.6 → 0.23.1

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/esm/api.d.ts CHANGED
@@ -993,6 +993,12 @@ export interface CreateFileRequestDataAttributes {
993
993
  * @memberof CreateFileRequestDataAttributes
994
994
  */
995
995
  rootFileName?: string;
996
+ /**
997
+ * Number of seconds before the file is deleted.
998
+ * @type {number}
999
+ * @memberof CreateFileRequestDataAttributes
1000
+ */
1001
+ expiry?: number;
996
1002
  }
997
1003
  /**
998
1004
  *
@@ -1626,6 +1632,12 @@ export interface CreateSceneItemRequestDataAttributes {
1626
1632
  metadata?: {
1627
1633
  [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
1628
1634
  };
1635
+ /**
1636
+ * 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.
1637
+ * @type {Array<string>}
1638
+ * @memberof CreateSceneItemRequestDataAttributes
1639
+ */
1640
+ experimentalSourceMetadataKeys?: Array<string>;
1629
1641
  }
1630
1642
  /**
1631
1643
  *
@@ -1727,7 +1739,7 @@ export interface CreateSceneRequestDataAttributes {
1727
1739
  */
1728
1740
  worldOrientation?: Orientation;
1729
1741
  /**
1730
- * 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.
1742
+ * 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.
1731
1743
  * @type {{ [key: string]: string; }}
1732
1744
  * @memberof CreateSceneRequestDataAttributes
1733
1745
  */
@@ -2537,6 +2549,49 @@ export declare const FileRelationshipDataTypeEnum: {
2537
2549
  readonly File: "file";
2538
2550
  };
2539
2551
  export declare type FileRelationshipDataTypeEnum = (typeof FileRelationshipDataTypeEnum)[keyof typeof FileRelationshipDataTypeEnum];
2552
+ /**
2553
+ * Describes how an attribute should be filtered.
2554
+ * @export
2555
+ * @interface FilterExpression
2556
+ */
2557
+ export interface FilterExpression {
2558
+ /**
2559
+ * A value of a filter.
2560
+ * @type {string}
2561
+ * @memberof FilterExpression
2562
+ */
2563
+ eq?: string;
2564
+ /**
2565
+ * A value of a filter.
2566
+ * @type {string}
2567
+ * @memberof FilterExpression
2568
+ */
2569
+ neq?: string;
2570
+ /**
2571
+ * A value of a filter.
2572
+ * @type {string}
2573
+ * @memberof FilterExpression
2574
+ */
2575
+ gt?: string;
2576
+ /**
2577
+ * A value of a filter.
2578
+ * @type {string}
2579
+ * @memberof FilterExpression
2580
+ */
2581
+ gte?: string;
2582
+ /**
2583
+ * A value of a filter.
2584
+ * @type {string}
2585
+ * @memberof FilterExpression
2586
+ */
2587
+ lt?: string;
2588
+ /**
2589
+ * A value of a filter.
2590
+ * @type {string}
2591
+ * @memberof FilterExpression
2592
+ */
2593
+ lte?: string;
2594
+ }
2540
2595
  /**
2541
2596
  *
2542
2597
  * @export
@@ -2972,6 +3027,100 @@ export interface MetadataStringType {
2972
3027
  */
2973
3028
  value: string;
2974
3029
  }
3030
+ /**
3031
+ *
3032
+ * @export
3033
+ * @interface ModelView
3034
+ */
3035
+ export interface ModelView {
3036
+ /**
3037
+ *
3038
+ * @type {ModelViewData}
3039
+ * @memberof ModelView
3040
+ */
3041
+ data: ModelViewData;
3042
+ /**
3043
+ *
3044
+ * @type {{ [key: string]: Link; }}
3045
+ * @memberof ModelView
3046
+ */
3047
+ links?: {
3048
+ [key: string]: Link;
3049
+ };
3050
+ }
3051
+ /**
3052
+ *
3053
+ * @export
3054
+ * @interface ModelViewData
3055
+ */
3056
+ export interface ModelViewData {
3057
+ /**
3058
+ *
3059
+ * @type {string}
3060
+ * @memberof ModelViewData
3061
+ */
3062
+ type: string;
3063
+ /**
3064
+ * ID of the resource.
3065
+ * @type {string}
3066
+ * @memberof ModelViewData
3067
+ */
3068
+ id: string;
3069
+ /**
3070
+ *
3071
+ * @type {CreateAccountRequestDataAttributes}
3072
+ * @memberof ModelViewData
3073
+ */
3074
+ attributes: CreateAccountRequestDataAttributes;
3075
+ /**
3076
+ *
3077
+ * @type {ModelViewDataRelationships}
3078
+ * @memberof ModelViewData
3079
+ */
3080
+ relationships: ModelViewDataRelationships;
3081
+ /**
3082
+ *
3083
+ * @type {{ [key: string]: Link; }}
3084
+ * @memberof ModelViewData
3085
+ */
3086
+ links?: {
3087
+ [key: string]: Link;
3088
+ };
3089
+ }
3090
+ /**
3091
+ *
3092
+ * @export
3093
+ * @interface ModelViewDataRelationships
3094
+ */
3095
+ export interface ModelViewDataRelationships {
3096
+ /**
3097
+ *
3098
+ * @type {PartRevisionRelationship}
3099
+ * @memberof ModelViewDataRelationships
3100
+ */
3101
+ partRevision: PartRevisionRelationship;
3102
+ }
3103
+ /**
3104
+ *
3105
+ * @export
3106
+ * @interface ModelViewList
3107
+ */
3108
+ export interface ModelViewList {
3109
+ /**
3110
+ *
3111
+ * @type {Array<ModelViewData>}
3112
+ * @memberof ModelViewList
3113
+ */
3114
+ data: Array<ModelViewData>;
3115
+ /**
3116
+ *
3117
+ * @type {{ [key: string]: Link; }}
3118
+ * @memberof ModelViewList
3119
+ */
3120
+ links: {
3121
+ [key: string]: Link;
3122
+ };
3123
+ }
2975
3124
  /**
2976
3125
  *
2977
3126
  * @export
@@ -3689,6 +3838,60 @@ export interface PerspectiveCamera {
3689
3838
  */
3690
3839
  fovY?: number;
3691
3840
  }
3841
+ /**
3842
+ *
3843
+ * @export
3844
+ * @interface PmiAnnotationData
3845
+ */
3846
+ export interface PmiAnnotationData {
3847
+ /**
3848
+ *
3849
+ * @type {string}
3850
+ * @memberof PmiAnnotationData
3851
+ */
3852
+ type: string;
3853
+ /**
3854
+ * ID of the resource.
3855
+ * @type {string}
3856
+ * @memberof PmiAnnotationData
3857
+ */
3858
+ id: string;
3859
+ /**
3860
+ *
3861
+ * @type {CreateAccountRequestDataAttributes}
3862
+ * @memberof PmiAnnotationData
3863
+ */
3864
+ attributes: CreateAccountRequestDataAttributes;
3865
+ /**
3866
+ *
3867
+ * @type {{ [key: string]: Link; }}
3868
+ * @memberof PmiAnnotationData
3869
+ */
3870
+ links?: {
3871
+ [key: string]: Link;
3872
+ };
3873
+ }
3874
+ /**
3875
+ *
3876
+ * @export
3877
+ * @interface PmiAnnotationList
3878
+ */
3879
+ export interface PmiAnnotationList {
3880
+ /**
3881
+ *
3882
+ * @type {Array<PmiAnnotationData>}
3883
+ * @memberof PmiAnnotationList
3884
+ */
3885
+ data: Array<PmiAnnotationData>;
3886
+ /**
3887
+ *
3888
+ * @type {{ [key: string]: Link; }}
3889
+ * @memberof PmiAnnotationList
3890
+ */
3891
+ links: {
3892
+ [key: string]: Link;
3893
+ };
3894
+ }
3692
3895
  /**
3693
3896
  * 2D point.
3694
3897
  * @export
@@ -4483,6 +4686,27 @@ export interface SceneAnnotationSetDataAttributes {
4483
4686
  */
4484
4687
  suppliedId?: string;
4485
4688
  }
4689
+ /**
4690
+ *
4691
+ * @export
4692
+ * @interface SceneAnnotationSetList
4693
+ */
4694
+ export interface SceneAnnotationSetList {
4695
+ /**
4696
+ *
4697
+ * @type {Array<SceneAnnotationSetData>}
4698
+ * @memberof SceneAnnotationSetList
4699
+ */
4700
+ data: Array<SceneAnnotationSetData>;
4701
+ /**
4702
+ *
4703
+ * @type {{ [key: string]: Link; }}
4704
+ * @memberof SceneAnnotationSetList
4705
+ */
4706
+ links: {
4707
+ [key: string]: Link;
4708
+ };
4709
+ }
4486
4710
  /**
4487
4711
  *
4488
4712
  * @export
@@ -5907,6 +6131,51 @@ export interface UpdateApplicationRequestDataAttributes {
5907
6131
  */
5908
6132
  redirect_uris?: Array<string>;
5909
6133
  }
6134
+ /**
6135
+ *
6136
+ * @export
6137
+ * @interface UpdateFileRequest
6138
+ */
6139
+ export interface UpdateFileRequest {
6140
+ /**
6141
+ *
6142
+ * @type {UpdateFileRequestData}
6143
+ * @memberof UpdateFileRequest
6144
+ */
6145
+ data: UpdateFileRequestData;
6146
+ }
6147
+ /**
6148
+ *
6149
+ * @export
6150
+ * @interface UpdateFileRequestData
6151
+ */
6152
+ export interface UpdateFileRequestData {
6153
+ /**
6154
+ * Resource object type.
6155
+ * @type {string}
6156
+ * @memberof UpdateFileRequestData
6157
+ */
6158
+ type: string;
6159
+ /**
6160
+ *
6161
+ * @type {UpdateFileRequestDataAttributes}
6162
+ * @memberof UpdateFileRequestData
6163
+ */
6164
+ attributes: UpdateFileRequestDataAttributes;
6165
+ }
6166
+ /**
6167
+ *
6168
+ * @export
6169
+ * @interface UpdateFileRequestDataAttributes
6170
+ */
6171
+ export interface UpdateFileRequestDataAttributes {
6172
+ /**
6173
+ * Number of seconds before the file is deleted.
6174
+ * @type {number}
6175
+ * @memberof UpdateFileRequestDataAttributes
6176
+ */
6177
+ expiry?: number | null;
6178
+ }
5910
6179
  /**
5911
6180
  * An operation that updates items with the specified revision to the default rendition.
5912
6181
  * @export
@@ -7962,6 +8231,14 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration |
7962
8231
  * @throws {RequiredError}
7963
8232
  */
7964
8233
  getFiles: (pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8234
+ /**
8235
+ * Update a `file`.
8236
+ * @param {string} id The &#x60;file&#x60; ID.
8237
+ * @param {UpdateFileRequest} updateFileRequest
8238
+ * @param {*} [options] Override http request option.
8239
+ * @throws {RequiredError}
8240
+ */
8241
+ updateFile: (id: string, updateFileRequest: UpdateFileRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7965
8242
  /**
7966
8243
  * Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
7967
8244
  * @param {string} id The &#x60;file&#x60; ID.
@@ -8006,6 +8283,14 @@ export declare const FilesApiFp: (configuration?: Configuration | undefined) =>
8006
8283
  * @throws {RequiredError}
8007
8284
  */
8008
8285
  getFiles(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileList>>;
8286
+ /**
8287
+ * Update a `file`.
8288
+ * @param {string} id The &#x60;file&#x60; ID.
8289
+ * @param {UpdateFileRequest} updateFileRequest
8290
+ * @param {*} [options] Override http request option.
8291
+ * @throws {RequiredError}
8292
+ */
8293
+ updateFile(id: string, updateFileRequest: UpdateFileRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileMetadata>>;
8009
8294
  /**
8010
8295
  * Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
8011
8296
  * @param {string} id The &#x60;file&#x60; ID.
@@ -8050,6 +8335,14 @@ export declare const FilesApiFactory: (configuration?: Configuration | undefined
8050
8335
  * @throws {RequiredError}
8051
8336
  */
8052
8337
  getFiles(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<FileList>;
8338
+ /**
8339
+ * Update a `file`.
8340
+ * @param {string} id The &#x60;file&#x60; ID.
8341
+ * @param {UpdateFileRequest} updateFileRequest
8342
+ * @param {*} [options] Override http request option.
8343
+ * @throws {RequiredError}
8344
+ */
8345
+ updateFile(id: string, updateFileRequest: UpdateFileRequest, options?: any): AxiosPromise<FileMetadata>;
8053
8346
  /**
8054
8347
  * Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
8055
8348
  * @param {string} id The &#x60;file&#x60; ID.
@@ -8123,6 +8416,25 @@ export interface FilesApiGetFilesRequest {
8123
8416
  */
8124
8417
  readonly filterSuppliedId?: string;
8125
8418
  }
8419
+ /**
8420
+ * Request parameters for updateFile operation in FilesApi.
8421
+ * @export
8422
+ * @interface FilesApiUpdateFileRequest
8423
+ */
8424
+ export interface FilesApiUpdateFileRequest {
8425
+ /**
8426
+ * The &#x60;file&#x60; ID.
8427
+ * @type {string}
8428
+ * @memberof FilesApiUpdateFile
8429
+ */
8430
+ readonly id: string;
8431
+ /**
8432
+ *
8433
+ * @type {UpdateFileRequest}
8434
+ * @memberof FilesApiUpdateFile
8435
+ */
8436
+ readonly updateFileRequest: UpdateFileRequest;
8437
+ }
8126
8438
  /**
8127
8439
  * Request parameters for uploadFile operation in FilesApi.
8128
8440
  * @export
@@ -8181,6 +8493,14 @@ export declare class FilesApi extends BaseAPI {
8181
8493
  * @memberof FilesApi
8182
8494
  */
8183
8495
  getFiles(requestParameters?: FilesApiGetFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileList, any>>;
8496
+ /**
8497
+ * Update a `file`.
8498
+ * @param {FilesApiUpdateFileRequest} requestParameters Request parameters.
8499
+ * @param {*} [options] Override http request option.
8500
+ * @throws {RequiredError}
8501
+ * @memberof FilesApi
8502
+ */
8503
+ updateFile(requestParameters: FilesApiUpdateFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileMetadata, any>>;
8184
8504
  /**
8185
8505
  * Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
8186
8506
  * @param {FilesApiUploadFileRequest} requestParameters Request parameters.
@@ -8515,6 +8835,212 @@ export declare class HitsApi extends BaseAPI {
8515
8835
  */
8516
8836
  createSceneViewHit(requestParameters: HitsApiCreateSceneViewHitRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Hit, any>>;
8517
8837
  }
8838
+ /**
8839
+ * ModelViewsApi - axios parameter creator
8840
+ * @export
8841
+ */
8842
+ export declare const ModelViewsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
8843
+ /**
8844
+ * Get the details of a `model-view`.
8845
+ * @param {string} id The &#x60;model-view&#x60; ID.
8846
+ * @param {*} [options] Override http request option.
8847
+ * @throws {RequiredError}
8848
+ */
8849
+ getModelView: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8850
+ /**
8851
+ * Get a paged list of `model-views` for a part revision.
8852
+ * @param {string} id The &#x60;part-revision&#x60; ID.
8853
+ * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
8854
+ * @param {string} [pageCursor] The cursor for the next page of items.
8855
+ * @param {number} [pageSize] The number of items to return.
8856
+ * @param {*} [options] Override http request option.
8857
+ * @throws {RequiredError}
8858
+ */
8859
+ getPartRevisionModelViews: (id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8860
+ /**
8861
+ * Get a paged list of `model-views` for a scene item.
8862
+ * @param {string} id The &#x60;scene-item&#x60; ID.
8863
+ * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
8864
+ * @param {string} [pageCursor] The cursor for the next page of items.
8865
+ * @param {number} [pageSize] The number of items to return.
8866
+ * @param {*} [options] Override http request option.
8867
+ * @throws {RequiredError}
8868
+ */
8869
+ getSceneItemModelViews: (id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8870
+ };
8871
+ /**
8872
+ * ModelViewsApi - functional programming interface
8873
+ * @export
8874
+ */
8875
+ export declare const ModelViewsApiFp: (configuration?: Configuration | undefined) => {
8876
+ /**
8877
+ * Get the details of a `model-view`.
8878
+ * @param {string} id The &#x60;model-view&#x60; ID.
8879
+ * @param {*} [options] Override http request option.
8880
+ * @throws {RequiredError}
8881
+ */
8882
+ getModelView(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ModelView>>;
8883
+ /**
8884
+ * Get a paged list of `model-views` for a part revision.
8885
+ * @param {string} id The &#x60;part-revision&#x60; ID.
8886
+ * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
8887
+ * @param {string} [pageCursor] The cursor for the next page of items.
8888
+ * @param {number} [pageSize] The number of items to return.
8889
+ * @param {*} [options] Override http request option.
8890
+ * @throws {RequiredError}
8891
+ */
8892
+ getPartRevisionModelViews(id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ModelViewList>>;
8893
+ /**
8894
+ * Get a paged list of `model-views` for a scene item.
8895
+ * @param {string} id The &#x60;scene-item&#x60; ID.
8896
+ * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
8897
+ * @param {string} [pageCursor] The cursor for the next page of items.
8898
+ * @param {number} [pageSize] The number of items to return.
8899
+ * @param {*} [options] Override http request option.
8900
+ * @throws {RequiredError}
8901
+ */
8902
+ getSceneItemModelViews(id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ModelViewList>>;
8903
+ };
8904
+ /**
8905
+ * ModelViewsApi - factory interface
8906
+ * @export
8907
+ */
8908
+ export declare const ModelViewsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
8909
+ /**
8910
+ * Get the details of a `model-view`.
8911
+ * @param {string} id The &#x60;model-view&#x60; ID.
8912
+ * @param {*} [options] Override http request option.
8913
+ * @throws {RequiredError}
8914
+ */
8915
+ getModelView(id: string, options?: any): AxiosPromise<ModelView>;
8916
+ /**
8917
+ * Get a paged list of `model-views` for a part revision.
8918
+ * @param {string} id The &#x60;part-revision&#x60; ID.
8919
+ * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
8920
+ * @param {string} [pageCursor] The cursor for the next page of items.
8921
+ * @param {number} [pageSize] The number of items to return.
8922
+ * @param {*} [options] Override http request option.
8923
+ * @throws {RequiredError}
8924
+ */
8925
+ getPartRevisionModelViews(id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<ModelViewList>;
8926
+ /**
8927
+ * Get a paged list of `model-views` for a scene item.
8928
+ * @param {string} id The &#x60;scene-item&#x60; ID.
8929
+ * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
8930
+ * @param {string} [pageCursor] The cursor for the next page of items.
8931
+ * @param {number} [pageSize] The number of items to return.
8932
+ * @param {*} [options] Override http request option.
8933
+ * @throws {RequiredError}
8934
+ */
8935
+ getSceneItemModelViews(id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<ModelViewList>;
8936
+ };
8937
+ /**
8938
+ * Request parameters for getModelView operation in ModelViewsApi.
8939
+ * @export
8940
+ * @interface ModelViewsApiGetModelViewRequest
8941
+ */
8942
+ export interface ModelViewsApiGetModelViewRequest {
8943
+ /**
8944
+ * The &#x60;model-view&#x60; ID.
8945
+ * @type {string}
8946
+ * @memberof ModelViewsApiGetModelView
8947
+ */
8948
+ readonly id: string;
8949
+ }
8950
+ /**
8951
+ * Request parameters for getPartRevisionModelViews operation in ModelViewsApi.
8952
+ * @export
8953
+ * @interface ModelViewsApiGetPartRevisionModelViewsRequest
8954
+ */
8955
+ export interface ModelViewsApiGetPartRevisionModelViewsRequest {
8956
+ /**
8957
+ * The &#x60;part-revision&#x60; ID.
8958
+ * @type {string}
8959
+ * @memberof ModelViewsApiGetPartRevisionModelViews
8960
+ */
8961
+ readonly id: string;
8962
+ /**
8963
+ * Filter model views that contain or do not contain annotations.
8964
+ * @type {boolean}
8965
+ * @memberof ModelViewsApiGetPartRevisionModelViews
8966
+ */
8967
+ readonly filterHasAnnotations?: boolean;
8968
+ /**
8969
+ * The cursor for the next page of items.
8970
+ * @type {string}
8971
+ * @memberof ModelViewsApiGetPartRevisionModelViews
8972
+ */
8973
+ readonly pageCursor?: string;
8974
+ /**
8975
+ * The number of items to return.
8976
+ * @type {number}
8977
+ * @memberof ModelViewsApiGetPartRevisionModelViews
8978
+ */
8979
+ readonly pageSize?: number;
8980
+ }
8981
+ /**
8982
+ * Request parameters for getSceneItemModelViews operation in ModelViewsApi.
8983
+ * @export
8984
+ * @interface ModelViewsApiGetSceneItemModelViewsRequest
8985
+ */
8986
+ export interface ModelViewsApiGetSceneItemModelViewsRequest {
8987
+ /**
8988
+ * The &#x60;scene-item&#x60; ID.
8989
+ * @type {string}
8990
+ * @memberof ModelViewsApiGetSceneItemModelViews
8991
+ */
8992
+ readonly id: string;
8993
+ /**
8994
+ * Filter model views that contain or do not contain annotations.
8995
+ * @type {boolean}
8996
+ * @memberof ModelViewsApiGetSceneItemModelViews
8997
+ */
8998
+ readonly filterHasAnnotations?: boolean;
8999
+ /**
9000
+ * The cursor for the next page of items.
9001
+ * @type {string}
9002
+ * @memberof ModelViewsApiGetSceneItemModelViews
9003
+ */
9004
+ readonly pageCursor?: string;
9005
+ /**
9006
+ * The number of items to return.
9007
+ * @type {number}
9008
+ * @memberof ModelViewsApiGetSceneItemModelViews
9009
+ */
9010
+ readonly pageSize?: number;
9011
+ }
9012
+ /**
9013
+ * ModelViewsApi - object-oriented interface
9014
+ * @export
9015
+ * @class ModelViewsApi
9016
+ * @extends {BaseAPI}
9017
+ */
9018
+ export declare class ModelViewsApi extends BaseAPI {
9019
+ /**
9020
+ * Get the details of a `model-view`.
9021
+ * @param {ModelViewsApiGetModelViewRequest} requestParameters Request parameters.
9022
+ * @param {*} [options] Override http request option.
9023
+ * @throws {RequiredError}
9024
+ * @memberof ModelViewsApi
9025
+ */
9026
+ getModelView(requestParameters: ModelViewsApiGetModelViewRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelView, any>>;
9027
+ /**
9028
+ * Get a paged list of `model-views` for a part revision.
9029
+ * @param {ModelViewsApiGetPartRevisionModelViewsRequest} requestParameters Request parameters.
9030
+ * @param {*} [options] Override http request option.
9031
+ * @throws {RequiredError}
9032
+ * @memberof ModelViewsApi
9033
+ */
9034
+ getPartRevisionModelViews(requestParameters: ModelViewsApiGetPartRevisionModelViewsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelViewList, any>>;
9035
+ /**
9036
+ * Get a paged list of `model-views` for a scene item.
9037
+ * @param {ModelViewsApiGetSceneItemModelViewsRequest} requestParameters Request parameters.
9038
+ * @param {*} [options] Override http request option.
9039
+ * @throws {RequiredError}
9040
+ * @memberof ModelViewsApi
9041
+ */
9042
+ getSceneItemModelViews(requestParameters: ModelViewsApiGetSceneItemModelViewsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelViewList, any>>;
9043
+ }
8518
9044
  /**
8519
9045
  * Oauth2Api - axios parameter creator
8520
9046
  * @export
@@ -9645,6 +10171,92 @@ export declare class PartsApi extends BaseAPI {
9645
10171
  */
9646
10172
  getQueuedPartDeletion(requestParameters: PartsApiGetQueuedPartDeletionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
9647
10173
  }
10174
+ /**
10175
+ * PmiApi - axios parameter creator
10176
+ * @export
10177
+ */
10178
+ export declare const PmiApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
10179
+ /**
10180
+ * List `pmi-annotation`s.
10181
+ * @param {string} [filterModelViewId] Filter annotations belonging to a model view.
10182
+ * @param {string} [pageCursor] The cursor for the next page of items.
10183
+ * @param {number} [pageSize] The number of items to return.
10184
+ * @param {*} [options] Override http request option.
10185
+ * @throws {RequiredError}
10186
+ */
10187
+ getPmiAnnotations: (filterModelViewId?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10188
+ };
10189
+ /**
10190
+ * PmiApi - functional programming interface
10191
+ * @export
10192
+ */
10193
+ export declare const PmiApiFp: (configuration?: Configuration | undefined) => {
10194
+ /**
10195
+ * List `pmi-annotation`s.
10196
+ * @param {string} [filterModelViewId] Filter annotations belonging to a model view.
10197
+ * @param {string} [pageCursor] The cursor for the next page of items.
10198
+ * @param {number} [pageSize] The number of items to return.
10199
+ * @param {*} [options] Override http request option.
10200
+ * @throws {RequiredError}
10201
+ */
10202
+ getPmiAnnotations(filterModelViewId?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PmiAnnotationList>>;
10203
+ };
10204
+ /**
10205
+ * PmiApi - factory interface
10206
+ * @export
10207
+ */
10208
+ export declare const PmiApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
10209
+ /**
10210
+ * List `pmi-annotation`s.
10211
+ * @param {string} [filterModelViewId] Filter annotations belonging to a model view.
10212
+ * @param {string} [pageCursor] The cursor for the next page of items.
10213
+ * @param {number} [pageSize] The number of items to return.
10214
+ * @param {*} [options] Override http request option.
10215
+ * @throws {RequiredError}
10216
+ */
10217
+ getPmiAnnotations(filterModelViewId?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<PmiAnnotationList>;
10218
+ };
10219
+ /**
10220
+ * Request parameters for getPmiAnnotations operation in PmiApi.
10221
+ * @export
10222
+ * @interface PmiApiGetPmiAnnotationsRequest
10223
+ */
10224
+ export interface PmiApiGetPmiAnnotationsRequest {
10225
+ /**
10226
+ * Filter annotations belonging to a model view.
10227
+ * @type {string}
10228
+ * @memberof PmiApiGetPmiAnnotations
10229
+ */
10230
+ readonly filterModelViewId?: string;
10231
+ /**
10232
+ * The cursor for the next page of items.
10233
+ * @type {string}
10234
+ * @memberof PmiApiGetPmiAnnotations
10235
+ */
10236
+ readonly pageCursor?: string;
10237
+ /**
10238
+ * The number of items to return.
10239
+ * @type {number}
10240
+ * @memberof PmiApiGetPmiAnnotations
10241
+ */
10242
+ readonly pageSize?: number;
10243
+ }
10244
+ /**
10245
+ * PmiApi - object-oriented interface
10246
+ * @export
10247
+ * @class PmiApi
10248
+ * @extends {BaseAPI}
10249
+ */
10250
+ export declare class PmiApi extends BaseAPI {
10251
+ /**
10252
+ * List `pmi-annotation`s.
10253
+ * @param {PmiApiGetPmiAnnotationsRequest} requestParameters Request parameters.
10254
+ * @param {*} [options] Override http request option.
10255
+ * @throws {RequiredError}
10256
+ * @memberof PmiApi
10257
+ */
10258
+ getPmiAnnotations(requestParameters?: PmiApiGetPmiAnnotationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PmiAnnotationList, any>>;
10259
+ }
9648
10260
  /**
9649
10261
  * SceneAlterationsApi - axios parameter creator
9650
10262
  * @export
@@ -9876,6 +10488,17 @@ export declare const SceneAnnotationsApiAxiosParamCreator: (configuration?: Conf
9876
10488
  * @throws {RequiredError}
9877
10489
  */
9878
10490
  deleteSceneAnnotation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10491
+ /**
10492
+ * Get `scene-annotation-sets` for a `scene`.
10493
+ * @param {string} id The &#x60;scene&#x60; ID.
10494
+ * @param {string} [pageCursor] The cursor for the next page of items.
10495
+ * @param {number} [pageSize] The number of items to return.
10496
+ * @param {string} [filterId] Comma-separated list of IDs to filter on.
10497
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
10498
+ * @param {*} [options] Override http request option.
10499
+ * @throws {RequiredError}
10500
+ */
10501
+ getSceneAnnotationSets: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9879
10502
  /**
9880
10503
  * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
9881
10504
  * @param {string} id The &#x60;scene-annotation&#x60; ID.
@@ -9913,6 +10536,17 @@ export declare const SceneAnnotationsApiFp: (configuration?: Configuration | und
9913
10536
  * @throws {RequiredError}
9914
10537
  */
9915
10538
  deleteSceneAnnotation(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
10539
+ /**
10540
+ * Get `scene-annotation-sets` for a `scene`.
10541
+ * @param {string} id The &#x60;scene&#x60; ID.
10542
+ * @param {string} [pageCursor] The cursor for the next page of items.
10543
+ * @param {number} [pageSize] The number of items to return.
10544
+ * @param {string} [filterId] Comma-separated list of IDs to filter on.
10545
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
10546
+ * @param {*} [options] Override http request option.
10547
+ * @throws {RequiredError}
10548
+ */
10549
+ getSceneAnnotationSets(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneAnnotationSetList>>;
9916
10550
  /**
9917
10551
  * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
9918
10552
  * @param {string} id The &#x60;scene-annotation&#x60; ID.
@@ -9950,6 +10584,17 @@ export declare const SceneAnnotationsApiFactory: (configuration?: Configuration
9950
10584
  * @throws {RequiredError}
9951
10585
  */
9952
10586
  deleteSceneAnnotation(id: string, options?: any): AxiosPromise<void>;
10587
+ /**
10588
+ * Get `scene-annotation-sets` for a `scene`.
10589
+ * @param {string} id The &#x60;scene&#x60; ID.
10590
+ * @param {string} [pageCursor] The cursor for the next page of items.
10591
+ * @param {number} [pageSize] The number of items to return.
10592
+ * @param {string} [filterId] Comma-separated list of IDs to filter on.
10593
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
10594
+ * @param {*} [options] Override http request option.
10595
+ * @throws {RequiredError}
10596
+ */
10597
+ getSceneAnnotationSets(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<SceneAnnotationSetList>;
9953
10598
  /**
9954
10599
  * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
9955
10600
  * @param {string} id The &#x60;scene-annotation&#x60; ID.
@@ -10010,6 +10655,43 @@ export interface SceneAnnotationsApiDeleteSceneAnnotationRequest {
10010
10655
  */
10011
10656
  readonly id: string;
10012
10657
  }
10658
+ /**
10659
+ * Request parameters for getSceneAnnotationSets operation in SceneAnnotationsApi.
10660
+ * @export
10661
+ * @interface SceneAnnotationsApiGetSceneAnnotationSetsRequest
10662
+ */
10663
+ export interface SceneAnnotationsApiGetSceneAnnotationSetsRequest {
10664
+ /**
10665
+ * The &#x60;scene&#x60; ID.
10666
+ * @type {string}
10667
+ * @memberof SceneAnnotationsApiGetSceneAnnotationSets
10668
+ */
10669
+ readonly id: string;
10670
+ /**
10671
+ * The cursor for the next page of items.
10672
+ * @type {string}
10673
+ * @memberof SceneAnnotationsApiGetSceneAnnotationSets
10674
+ */
10675
+ readonly pageCursor?: string;
10676
+ /**
10677
+ * The number of items to return.
10678
+ * @type {number}
10679
+ * @memberof SceneAnnotationsApiGetSceneAnnotationSets
10680
+ */
10681
+ readonly pageSize?: number;
10682
+ /**
10683
+ * Comma-separated list of IDs to filter on.
10684
+ * @type {string}
10685
+ * @memberof SceneAnnotationsApiGetSceneAnnotationSets
10686
+ */
10687
+ readonly filterId?: string;
10688
+ /**
10689
+ * Comma-separated list of supplied IDs to filter on.
10690
+ * @type {string}
10691
+ * @memberof SceneAnnotationsApiGetSceneAnnotationSets
10692
+ */
10693
+ readonly filterSuppliedId?: string;
10694
+ }
10013
10695
  /**
10014
10696
  * Request parameters for updateSceneAnnotation operation in SceneAnnotationsApi.
10015
10697
  * @export
@@ -10060,6 +10742,14 @@ export declare class SceneAnnotationsApi extends BaseAPI {
10060
10742
  * @memberof SceneAnnotationsApi
10061
10743
  */
10062
10744
  deleteSceneAnnotation(requestParameters: SceneAnnotationsApiDeleteSceneAnnotationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10745
+ /**
10746
+ * Get `scene-annotation-sets` for a `scene`.
10747
+ * @param {SceneAnnotationsApiGetSceneAnnotationSetsRequest} requestParameters Request parameters.
10748
+ * @param {*} [options] Override http request option.
10749
+ * @throws {RequiredError}
10750
+ * @memberof SceneAnnotationsApi
10751
+ */
10752
+ getSceneAnnotationSets(requestParameters: SceneAnnotationsApiGetSceneAnnotationSetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SceneAnnotationSetList, any>>;
10063
10753
  /**
10064
10754
  * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
10065
10755
  * @param {SceneAnnotationsApiUpdateSceneAnnotationRequest} requestParameters Request parameters.
@@ -12283,11 +12973,13 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
12283
12973
  * Get all current translation jobs in progress.
12284
12974
  * @param {string} [pageCursor] The cursor for the next page of items.
12285
12975
  * @param {number} [pageSize] The number of items to return.
12976
+ * @param {string} [sort] A sort to apply to the collection. A \&quot;minus\&quot; prefixed before the field name is used to specify descending sort order.
12286
12977
  * @param {string} [filterStatus] Status to filter on.
12978
+ * @param {FilterExpression} [filterCompletedAt] The completion date and time to filter on.
12287
12979
  * @param {*} [options] Override http request option.
12288
12980
  * @throws {RequiredError}
12289
12981
  */
12290
- getQueuedTranslationJobs: (pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
12982
+ getQueuedTranslationJobs: (pageCursor?: string | undefined, pageSize?: number | undefined, sort?: string | undefined, filterStatus?: string | undefined, filterCompletedAt?: FilterExpression | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
12291
12983
  /**
12292
12984
  * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
12293
12985
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -12337,11 +13029,13 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
12337
13029
  * Get all current translation jobs in progress.
12338
13030
  * @param {string} [pageCursor] The cursor for the next page of items.
12339
13031
  * @param {number} [pageSize] The number of items to return.
13032
+ * @param {string} [sort] A sort to apply to the collection. A \&quot;minus\&quot; prefixed before the field name is used to specify descending sort order.
12340
13033
  * @param {string} [filterStatus] Status to filter on.
13034
+ * @param {FilterExpression} [filterCompletedAt] The completion date and time to filter on.
12341
13035
  * @param {*} [options] Override http request option.
12342
13036
  * @throws {RequiredError}
12343
13037
  */
12344
- getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJobList>>;
13038
+ getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, sort?: string | undefined, filterStatus?: string | undefined, filterCompletedAt?: FilterExpression | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJobList>>;
12345
13039
  /**
12346
13040
  * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
12347
13041
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -12391,11 +13085,13 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
12391
13085
  * Get all current translation jobs in progress.
12392
13086
  * @param {string} [pageCursor] The cursor for the next page of items.
12393
13087
  * @param {number} [pageSize] The number of items to return.
13088
+ * @param {string} [sort] A sort to apply to the collection. A \&quot;minus\&quot; prefixed before the field name is used to specify descending sort order.
12394
13089
  * @param {string} [filterStatus] Status to filter on.
13090
+ * @param {FilterExpression} [filterCompletedAt] The completion date and time to filter on.
12395
13091
  * @param {*} [options] Override http request option.
12396
13092
  * @throws {RequiredError}
12397
13093
  */
12398
- getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: any): AxiosPromise<QueuedJobList>;
13094
+ getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, sort?: string | undefined, filterStatus?: string | undefined, filterCompletedAt?: FilterExpression | undefined, options?: any): AxiosPromise<QueuedJobList>;
12399
13095
  /**
12400
13096
  * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
12401
13097
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -12477,12 +13173,24 @@ export interface TranslationInspectionsApiGetQueuedTranslationJobsRequest {
12477
13173
  * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
12478
13174
  */
12479
13175
  readonly pageSize?: number;
13176
+ /**
13177
+ * A sort to apply to the collection. A \&quot;minus\&quot; prefixed before the field name is used to specify descending sort order.
13178
+ * @type {string}
13179
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
13180
+ */
13181
+ readonly sort?: string;
12480
13182
  /**
12481
13183
  * Status to filter on.
12482
13184
  * @type {string}
12483
13185
  * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
12484
13186
  */
12485
13187
  readonly filterStatus?: string;
13188
+ /**
13189
+ * The completion date and time to filter on.
13190
+ * @type {FilterExpression}
13191
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
13192
+ */
13193
+ readonly filterCompletedAt?: FilterExpression;
12486
13194
  }
12487
13195
  /**
12488
13196
  * Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.