@vertexvis/api-client-node 0.30.0 → 0.30.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/api.d.ts CHANGED
@@ -2135,6 +2135,74 @@ export interface CreateSceneViewStateRequestDataRelationships {
2135
2135
  */
2136
2136
  source: SceneViewRelationship | SceneViewStateRelationship;
2137
2137
  }
2138
+ /**
2139
+ *
2140
+ * @export
2141
+ * @interface CreateSearchSessionRequest
2142
+ */
2143
+ export interface CreateSearchSessionRequest {
2144
+ /**
2145
+ *
2146
+ * @type {CreateSearchSessionRequestData}
2147
+ * @memberof CreateSearchSessionRequest
2148
+ */
2149
+ data: CreateSearchSessionRequestData;
2150
+ }
2151
+ /**
2152
+ *
2153
+ * @export
2154
+ * @interface CreateSearchSessionRequestData
2155
+ */
2156
+ export interface CreateSearchSessionRequestData {
2157
+ /**
2158
+ * Resource object type.
2159
+ * @type {string}
2160
+ * @memberof CreateSearchSessionRequestData
2161
+ */
2162
+ type: CreateSearchSessionRequestDataTypeEnum;
2163
+ /**
2164
+ *
2165
+ * @type {CreateSearchSessionRequestDataAttributes}
2166
+ * @memberof CreateSearchSessionRequestData
2167
+ */
2168
+ attributes: CreateSearchSessionRequestDataAttributes;
2169
+ /**
2170
+ *
2171
+ * @type {CreateSearchSessionRequestDataRelationships}
2172
+ * @memberof CreateSearchSessionRequestData
2173
+ */
2174
+ relationships: CreateSearchSessionRequestDataRelationships;
2175
+ }
2176
+ export declare const CreateSearchSessionRequestDataTypeEnum: {
2177
+ readonly SearchSession: "search-session";
2178
+ };
2179
+ export declare type CreateSearchSessionRequestDataTypeEnum = (typeof CreateSearchSessionRequestDataTypeEnum)[keyof typeof CreateSearchSessionRequestDataTypeEnum];
2180
+ /**
2181
+ *
2182
+ * @export
2183
+ * @interface CreateSearchSessionRequestDataAttributes
2184
+ */
2185
+ export interface CreateSearchSessionRequestDataAttributes {
2186
+ /**
2187
+ * Number of seconds before the search session is deleted.
2188
+ * @type {number}
2189
+ * @memberof CreateSearchSessionRequestDataAttributes
2190
+ */
2191
+ expiry?: number;
2192
+ }
2193
+ /**
2194
+ *
2195
+ * @export
2196
+ * @interface CreateSearchSessionRequestDataRelationships
2197
+ */
2198
+ export interface CreateSearchSessionRequestDataRelationships {
2199
+ /**
2200
+ *
2201
+ * @type {SceneRelationship}
2202
+ * @memberof CreateSearchSessionRequestDataRelationships
2203
+ */
2204
+ scene?: SceneRelationship;
2205
+ }
2138
2206
  /**
2139
2207
  *
2140
2208
  * @export
@@ -3054,6 +3122,12 @@ export interface FilterExpression {
3054
3122
  * @memberof FilterExpression
3055
3123
  */
3056
3124
  lte?: string;
3125
+ /**
3126
+ * A value of a filter.
3127
+ * @type {string}
3128
+ * @memberof FilterExpression
3129
+ */
3130
+ contains?: string;
3057
3131
  }
3058
3132
  /**
3059
3133
  *
@@ -6659,6 +6733,79 @@ export declare const SceneViewStateRelationshipDataTypeEnum: {
6659
6733
  readonly SceneViewState: "scene-view-state";
6660
6734
  };
6661
6735
  export declare type SceneViewStateRelationshipDataTypeEnum = (typeof SceneViewStateRelationshipDataTypeEnum)[keyof typeof SceneViewStateRelationshipDataTypeEnum];
6736
+ /**
6737
+ *
6738
+ * @export
6739
+ * @interface SearchSession
6740
+ */
6741
+ export interface SearchSession {
6742
+ /**
6743
+ *
6744
+ * @type {SearchSessionData}
6745
+ * @memberof SearchSession
6746
+ */
6747
+ data: SearchSessionData;
6748
+ /**
6749
+ *
6750
+ * @type {{ [key: string]: Link; }}
6751
+ * @memberof SearchSession
6752
+ */
6753
+ links?: {
6754
+ [key: string]: Link;
6755
+ };
6756
+ }
6757
+ /**
6758
+ *
6759
+ * @export
6760
+ * @interface SearchSessionData
6761
+ */
6762
+ export interface SearchSessionData {
6763
+ /**
6764
+ *
6765
+ * @type {string}
6766
+ * @memberof SearchSessionData
6767
+ */
6768
+ type: string;
6769
+ /**
6770
+ * ID of the resource.
6771
+ * @type {string}
6772
+ * @memberof SearchSessionData
6773
+ */
6774
+ id: string;
6775
+ /**
6776
+ *
6777
+ * @type {SearchSessionDataAttributes}
6778
+ * @memberof SearchSessionData
6779
+ */
6780
+ attributes: SearchSessionDataAttributes;
6781
+ /**
6782
+ *
6783
+ * @type {SceneViewDataRelationships}
6784
+ * @memberof SearchSessionData
6785
+ */
6786
+ relationships?: SceneViewDataRelationships;
6787
+ /**
6788
+ *
6789
+ * @type {{ [key: string]: Link; }}
6790
+ * @memberof SearchSessionData
6791
+ */
6792
+ links?: {
6793
+ [key: string]: Link;
6794
+ };
6795
+ }
6796
+ /**
6797
+ *
6798
+ * @export
6799
+ * @interface SearchSessionDataAttributes
6800
+ */
6801
+ export interface SearchSessionDataAttributes {
6802
+ /**
6803
+ *
6804
+ * @type {string}
6805
+ * @memberof SearchSessionDataAttributes
6806
+ */
6807
+ status: string;
6808
+ }
6662
6809
  /**
6663
6810
  *
6664
6811
  * @export
@@ -11128,7 +11275,7 @@ export declare class PartRenditionsApi extends BaseAPI {
11128
11275
  */
11129
11276
  export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
11130
11277
  /**
11131
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11278
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11132
11279
  * @param {string} [filterParent] Parent ID to filter on.
11133
11280
  * @param {string} [pageCursor] The cursor for the next page of items.
11134
11281
  * @param {number} [pageSize] The number of items to return.
@@ -11143,7 +11290,7 @@ export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?:
11143
11290
  */
11144
11291
  export declare const PartRevisionInstancesApiFp: (configuration?: Configuration | undefined) => {
11145
11292
  /**
11146
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11293
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11147
11294
  * @param {string} [filterParent] Parent ID to filter on.
11148
11295
  * @param {string} [pageCursor] The cursor for the next page of items.
11149
11296
  * @param {number} [pageSize] The number of items to return.
@@ -11158,7 +11305,7 @@ export declare const PartRevisionInstancesApiFp: (configuration?: Configuration
11158
11305
  */
11159
11306
  export declare const PartRevisionInstancesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
11160
11307
  /**
11161
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11308
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11162
11309
  * @param {string} [filterParent] Parent ID to filter on.
11163
11310
  * @param {string} [pageCursor] The cursor for the next page of items.
11164
11311
  * @param {number} [pageSize] The number of items to return.
@@ -11200,7 +11347,7 @@ export interface PartRevisionInstancesApiGetPartRevisionInstanceListRequest {
11200
11347
  */
11201
11348
  export declare class PartRevisionInstancesApi extends BaseAPI {
11202
11349
  /**
11203
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11350
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11204
11351
  * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
11205
11352
  * @param {*} [options] Override http request option.
11206
11353
  * @throws {RequiredError}
@@ -14624,6 +14771,116 @@ export declare class ScenesApi extends BaseAPI {
14624
14771
  */
14625
14772
  updateScene(requestParameters: ScenesApiUpdateSceneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scene, any>>;
14626
14773
  }
14774
+ /**
14775
+ * SearchSessionsApi - axios parameter creator
14776
+ * @export
14777
+ */
14778
+ export declare const SearchSessionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
14779
+ /**
14780
+ * Create a `search-session`.
14781
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
14782
+ * @param {*} [options] Override http request option.
14783
+ * @throws {RequiredError}
14784
+ */
14785
+ createSearchSession: (createSearchSessionRequest: CreateSearchSessionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
14786
+ /**
14787
+ * Get a `search-session`.
14788
+ * @param {string} id The &#x60;search-session&#x60; ID.
14789
+ * @param {*} [options] Override http request option.
14790
+ * @throws {RequiredError}
14791
+ */
14792
+ getSearchSession: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
14793
+ };
14794
+ /**
14795
+ * SearchSessionsApi - functional programming interface
14796
+ * @export
14797
+ */
14798
+ export declare const SearchSessionsApiFp: (configuration?: Configuration | undefined) => {
14799
+ /**
14800
+ * Create a `search-session`.
14801
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
14802
+ * @param {*} [options] Override http request option.
14803
+ * @throws {RequiredError}
14804
+ */
14805
+ createSearchSession(createSearchSessionRequest: CreateSearchSessionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SearchSession>>;
14806
+ /**
14807
+ * Get a `search-session`.
14808
+ * @param {string} id The &#x60;search-session&#x60; ID.
14809
+ * @param {*} [options] Override http request option.
14810
+ * @throws {RequiredError}
14811
+ */
14812
+ getSearchSession(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SearchSession>>;
14813
+ };
14814
+ /**
14815
+ * SearchSessionsApi - factory interface
14816
+ * @export
14817
+ */
14818
+ export declare const SearchSessionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
14819
+ /**
14820
+ * Create a `search-session`.
14821
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
14822
+ * @param {*} [options] Override http request option.
14823
+ * @throws {RequiredError}
14824
+ */
14825
+ createSearchSession(createSearchSessionRequest: CreateSearchSessionRequest, options?: any): AxiosPromise<SearchSession>;
14826
+ /**
14827
+ * Get a `search-session`.
14828
+ * @param {string} id The &#x60;search-session&#x60; ID.
14829
+ * @param {*} [options] Override http request option.
14830
+ * @throws {RequiredError}
14831
+ */
14832
+ getSearchSession(id: string, options?: any): AxiosPromise<SearchSession>;
14833
+ };
14834
+ /**
14835
+ * Request parameters for createSearchSession operation in SearchSessionsApi.
14836
+ * @export
14837
+ * @interface SearchSessionsApiCreateSearchSessionRequest
14838
+ */
14839
+ export interface SearchSessionsApiCreateSearchSessionRequest {
14840
+ /**
14841
+ *
14842
+ * @type {CreateSearchSessionRequest}
14843
+ * @memberof SearchSessionsApiCreateSearchSession
14844
+ */
14845
+ readonly createSearchSessionRequest: CreateSearchSessionRequest;
14846
+ }
14847
+ /**
14848
+ * Request parameters for getSearchSession operation in SearchSessionsApi.
14849
+ * @export
14850
+ * @interface SearchSessionsApiGetSearchSessionRequest
14851
+ */
14852
+ export interface SearchSessionsApiGetSearchSessionRequest {
14853
+ /**
14854
+ * The &#x60;search-session&#x60; ID.
14855
+ * @type {string}
14856
+ * @memberof SearchSessionsApiGetSearchSession
14857
+ */
14858
+ readonly id: string;
14859
+ }
14860
+ /**
14861
+ * SearchSessionsApi - object-oriented interface
14862
+ * @export
14863
+ * @class SearchSessionsApi
14864
+ * @extends {BaseAPI}
14865
+ */
14866
+ export declare class SearchSessionsApi extends BaseAPI {
14867
+ /**
14868
+ * Create a `search-session`.
14869
+ * @param {SearchSessionsApiCreateSearchSessionRequest} requestParameters Request parameters.
14870
+ * @param {*} [options] Override http request option.
14871
+ * @throws {RequiredError}
14872
+ * @memberof SearchSessionsApi
14873
+ */
14874
+ createSearchSession(requestParameters: SearchSessionsApiCreateSearchSessionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchSession, any>>;
14875
+ /**
14876
+ * Get a `search-session`.
14877
+ * @param {SearchSessionsApiGetSearchSessionRequest} requestParameters Request parameters.
14878
+ * @param {*} [options] Override http request option.
14879
+ * @throws {RequiredError}
14880
+ * @memberof SearchSessionsApi
14881
+ */
14882
+ getSearchSession(requestParameters: SearchSessionsApiGetSearchSessionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchSession, any>>;
14883
+ }
14627
14884
  /**
14628
14885
  * StreamKeysApi - axios parameter creator
14629
14886
  * @export
package/dist/cjs/api.js CHANGED
@@ -25,10 +25,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
25
25
  return (mod && mod.__esModule) ? mod : { "default": mod };
26
26
  };
27
27
  Object.defineProperty(exports, "__esModule", { value: true });
28
- exports.ViewRenBySuppliedIdOpTypeEnum = exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateItemToDefaultRenditionOperationTypeEnum = exports.UpdateFileCollectionRequestDataTypeEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = exports.SelectFileBySuppliedIdTypeEnum = exports.SelectFileByIdTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByMetadataDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PropertyStringTypeTypeEnum = exports.PropertySetRelationshipDataTypeEnum = exports.PropertyLongTypeTypeEnum = exports.PropertyDoubleTypeTypeEnum = exports.PropertyDateTypeTypeEnum = exports.PartRenditionRelationshipDataTypeEnum = exports.PartRelationshipDataTypeEnum = exports.PartInstanceRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.FileJobArchiveOperationTypeEnum = exports.FileCollectionMetadataDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.CreateSceneItemRequestDataAttributesResolutionRuleEnum = exports.CreateFileJobRequestDataTypeEnum = exports.CreateFileCollectionRequestDataTypeEnum = exports.ClearTransformOpTypeEnum = exports.ClearRepOpTypeEnum = exports.ClearRenOpTypeEnum = exports.ClearMaterialOpTypeEnum = exports.ChangeVisibilityOpTypeEnum = exports.ChangeTransformOpTypeEnum = exports.ChangeMaterialOpTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
- exports.PartRenditionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.ModelViewsApi = exports.ModelViewsApiFactory = exports.ModelViewsApiFp = exports.ModelViewsApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.FileJobsApi = exports.FileJobsApiFactory = exports.FileJobsApiFp = exports.FileJobsApiAxiosParamCreator = exports.FileCollectionsApi = exports.FileCollectionsApiFactory = exports.FileCollectionsApiFp = exports.FileCollectionsApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = void 0;
30
- exports.SceneViewsApiFactory = exports.SceneViewsApiFp = exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = exports.SceneSynchronizationsApi = exports.SceneSynchronizationsApiFactory = exports.SceneSynchronizationsApiFp = exports.SceneSynchronizationsApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAnnotationsApi = exports.SceneAnnotationsApiFactory = exports.SceneAnnotationsApiFp = exports.SceneAnnotationsApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PropertyEntriesApi = exports.PropertyEntriesApiFactory = exports.PropertyEntriesApiFp = exports.PropertyEntriesApiAxiosParamCreator = exports.PmiApi = exports.PmiApiFactory = exports.PmiApiFp = exports.PmiApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.PartRevisionInstancesApi = exports.PartRevisionInstancesApiFactory = exports.PartRevisionInstancesApiFp = exports.PartRevisionInstancesApiAxiosParamCreator = exports.PartRenditionsApi = exports.PartRenditionsApiFactory = exports.PartRenditionsApiFp = void 0;
31
- exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = void 0;
28
+ exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateItemToDefaultRenditionOperationTypeEnum = exports.UpdateFileCollectionRequestDataTypeEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = exports.SelectFileBySuppliedIdTypeEnum = exports.SelectFileByIdTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByMetadataDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PropertyStringTypeTypeEnum = exports.PropertySetRelationshipDataTypeEnum = exports.PropertyLongTypeTypeEnum = exports.PropertyDoubleTypeTypeEnum = exports.PropertyDateTypeTypeEnum = exports.PartRenditionRelationshipDataTypeEnum = exports.PartRelationshipDataTypeEnum = exports.PartInstanceRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.FileJobArchiveOperationTypeEnum = exports.FileCollectionMetadataDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.CreateSearchSessionRequestDataTypeEnum = exports.CreateSceneItemRequestDataAttributesResolutionRuleEnum = exports.CreateFileJobRequestDataTypeEnum = exports.CreateFileCollectionRequestDataTypeEnum = exports.ClearTransformOpTypeEnum = exports.ClearRepOpTypeEnum = exports.ClearRenOpTypeEnum = exports.ClearMaterialOpTypeEnum = exports.ChangeVisibilityOpTypeEnum = exports.ChangeTransformOpTypeEnum = exports.ChangeMaterialOpTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
+ exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.ModelViewsApi = exports.ModelViewsApiFactory = exports.ModelViewsApiFp = exports.ModelViewsApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.FileJobsApi = exports.FileJobsApiFactory = exports.FileJobsApiFp = exports.FileJobsApiAxiosParamCreator = exports.FileCollectionsApi = exports.FileCollectionsApiFactory = exports.FileCollectionsApiFp = exports.FileCollectionsApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = exports.ViewRenBySuppliedIdOpTypeEnum = void 0;
30
+ exports.SceneViewsApiFp = exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = exports.SceneSynchronizationsApi = exports.SceneSynchronizationsApiFactory = exports.SceneSynchronizationsApiFp = exports.SceneSynchronizationsApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAnnotationsApi = exports.SceneAnnotationsApiFactory = exports.SceneAnnotationsApiFp = exports.SceneAnnotationsApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PropertyEntriesApi = exports.PropertyEntriesApiFactory = exports.PropertyEntriesApiFp = exports.PropertyEntriesApiAxiosParamCreator = exports.PmiApi = exports.PmiApiFactory = exports.PmiApiFp = exports.PmiApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.PartRevisionInstancesApi = exports.PartRevisionInstancesApiFactory = exports.PartRevisionInstancesApiFp = exports.PartRevisionInstancesApiAxiosParamCreator = exports.PartRenditionsApi = exports.PartRenditionsApiFactory = exports.PartRenditionsApiFp = exports.PartRenditionsApiAxiosParamCreator = void 0;
31
+ exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.SearchSessionsApi = exports.SearchSessionsApiFactory = exports.SearchSessionsApiFp = exports.SearchSessionsApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = exports.SceneViewsApiFactory = void 0;
32
32
  const axios_1 = __importDefault(require("axios"));
33
33
  // Some imports not used depending on template conditions
34
34
  // @ts-ignore
@@ -77,6 +77,9 @@ exports.CreateSceneItemRequestDataAttributesResolutionRuleEnum = {
77
77
  LatestIteration: 'latest-iteration',
78
78
  LatestRevision: 'latest-revision',
79
79
  };
80
+ exports.CreateSearchSessionRequestDataTypeEnum = {
81
+ SearchSession: 'search-session',
82
+ };
80
83
  exports.DeselectOperationTypeEnum = {
81
84
  Deselect: 'deselect',
82
85
  };
@@ -4133,7 +4136,7 @@ exports.PartRenditionsApi = PartRenditionsApi;
4133
4136
  const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
4134
4137
  return {
4135
4138
  /**
4136
- * 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.
4139
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4137
4140
  * @param {string} [filterParent] Parent ID to filter on.
4138
4141
  * @param {string} [pageCursor] The cursor for the next page of items.
4139
4142
  * @param {number} [pageSize] The number of items to return.
@@ -4183,7 +4186,7 @@ const PartRevisionInstancesApiFp = function (configuration) {
4183
4186
  const localVarAxiosParamCreator = (0, exports.PartRevisionInstancesApiAxiosParamCreator)(configuration);
4184
4187
  return {
4185
4188
  /**
4186
- * 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.
4189
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4187
4190
  * @param {string} [filterParent] Parent ID to filter on.
4188
4191
  * @param {string} [pageCursor] The cursor for the next page of items.
4189
4192
  * @param {number} [pageSize] The number of items to return.
@@ -4207,7 +4210,7 @@ const PartRevisionInstancesApiFactory = function (configuration, basePath, axios
4207
4210
  const localVarFp = (0, exports.PartRevisionInstancesApiFp)(configuration);
4208
4211
  return {
4209
4212
  /**
4210
- * 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.
4213
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4211
4214
  * @param {string} [filterParent] Parent ID to filter on.
4212
4215
  * @param {string} [pageCursor] The cursor for the next page of items.
4213
4216
  * @param {number} [pageSize] The number of items to return.
@@ -4230,7 +4233,7 @@ exports.PartRevisionInstancesApiFactory = PartRevisionInstancesApiFactory;
4230
4233
  */
4231
4234
  class PartRevisionInstancesApi extends base_1.BaseAPI {
4232
4235
  /**
4233
- * 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.
4236
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4234
4237
  * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
4235
4238
  * @param {*} [options] Override http request option.
4236
4239
  * @throws {RequiredError}
@@ -8966,6 +8969,178 @@ class ScenesApi extends base_1.BaseAPI {
8966
8969
  }
8967
8970
  }
8968
8971
  exports.ScenesApi = ScenesApi;
8972
+ /**
8973
+ * SearchSessionsApi - axios parameter creator
8974
+ * @export
8975
+ */
8976
+ const SearchSessionsApiAxiosParamCreator = function (configuration) {
8977
+ return {
8978
+ /**
8979
+ * Create a `search-session`.
8980
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
8981
+ * @param {*} [options] Override http request option.
8982
+ * @throws {RequiredError}
8983
+ */
8984
+ createSearchSession: (createSearchSessionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
8985
+ var _a;
8986
+ // verify required parameter 'createSearchSessionRequest' is not null or undefined
8987
+ (0, common_1.assertParamExists)('createSearchSession', 'createSearchSessionRequest', createSearchSessionRequest);
8988
+ const localVarPath = `/search-sessions`;
8989
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8990
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
8991
+ let baseOptions;
8992
+ if (configuration) {
8993
+ baseOptions = configuration.baseOptions;
8994
+ }
8995
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
8996
+ const localVarHeaderParameter = {};
8997
+ const localVarQueryParameter = {};
8998
+ // authentication OAuth2 required
8999
+ // oauth required
9000
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
9001
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
9002
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
9003
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
9004
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9005
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createSearchSessionRequest, localVarRequestOptions, configuration);
9006
+ return {
9007
+ url: (0, common_1.toPathString)(localVarUrlObj),
9008
+ options: localVarRequestOptions,
9009
+ };
9010
+ }),
9011
+ /**
9012
+ * Get a `search-session`.
9013
+ * @param {string} id The &#x60;search-session&#x60; ID.
9014
+ * @param {*} [options] Override http request option.
9015
+ * @throws {RequiredError}
9016
+ */
9017
+ getSearchSession: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
9018
+ var _b;
9019
+ // verify required parameter 'id' is not null or undefined
9020
+ (0, common_1.assertParamExists)('getSearchSession', 'id', id);
9021
+ const localVarPath = `/search-sessions/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
9022
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9023
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
9024
+ let baseOptions;
9025
+ if (configuration) {
9026
+ baseOptions = configuration.baseOptions;
9027
+ }
9028
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
9029
+ const localVarHeaderParameter = {};
9030
+ const localVarQueryParameter = {};
9031
+ // authentication OAuth2 required
9032
+ // oauth required
9033
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
9034
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
9035
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
9036
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9037
+ return {
9038
+ url: (0, common_1.toPathString)(localVarUrlObj),
9039
+ options: localVarRequestOptions,
9040
+ };
9041
+ }),
9042
+ };
9043
+ };
9044
+ exports.SearchSessionsApiAxiosParamCreator = SearchSessionsApiAxiosParamCreator;
9045
+ /**
9046
+ * SearchSessionsApi - functional programming interface
9047
+ * @export
9048
+ */
9049
+ const SearchSessionsApiFp = function (configuration) {
9050
+ const localVarAxiosParamCreator = (0, exports.SearchSessionsApiAxiosParamCreator)(configuration);
9051
+ return {
9052
+ /**
9053
+ * Create a `search-session`.
9054
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
9055
+ * @param {*} [options] Override http request option.
9056
+ * @throws {RequiredError}
9057
+ */
9058
+ createSearchSession(createSearchSessionRequest, options) {
9059
+ return __awaiter(this, void 0, void 0, function* () {
9060
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createSearchSession(createSearchSessionRequest, options);
9061
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
9062
+ });
9063
+ },
9064
+ /**
9065
+ * Get a `search-session`.
9066
+ * @param {string} id The &#x60;search-session&#x60; ID.
9067
+ * @param {*} [options] Override http request option.
9068
+ * @throws {RequiredError}
9069
+ */
9070
+ getSearchSession(id, options) {
9071
+ return __awaiter(this, void 0, void 0, function* () {
9072
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSearchSession(id, options);
9073
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
9074
+ });
9075
+ },
9076
+ };
9077
+ };
9078
+ exports.SearchSessionsApiFp = SearchSessionsApiFp;
9079
+ /**
9080
+ * SearchSessionsApi - factory interface
9081
+ * @export
9082
+ */
9083
+ const SearchSessionsApiFactory = function (configuration, basePath, axios) {
9084
+ const localVarFp = (0, exports.SearchSessionsApiFp)(configuration);
9085
+ return {
9086
+ /**
9087
+ * Create a `search-session`.
9088
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
9089
+ * @param {*} [options] Override http request option.
9090
+ * @throws {RequiredError}
9091
+ */
9092
+ createSearchSession(createSearchSessionRequest, options) {
9093
+ return localVarFp
9094
+ .createSearchSession(createSearchSessionRequest, options)
9095
+ .then((request) => request(axios, basePath));
9096
+ },
9097
+ /**
9098
+ * Get a `search-session`.
9099
+ * @param {string} id The &#x60;search-session&#x60; ID.
9100
+ * @param {*} [options] Override http request option.
9101
+ * @throws {RequiredError}
9102
+ */
9103
+ getSearchSession(id, options) {
9104
+ return localVarFp
9105
+ .getSearchSession(id, options)
9106
+ .then((request) => request(axios, basePath));
9107
+ },
9108
+ };
9109
+ };
9110
+ exports.SearchSessionsApiFactory = SearchSessionsApiFactory;
9111
+ /**
9112
+ * SearchSessionsApi - object-oriented interface
9113
+ * @export
9114
+ * @class SearchSessionsApi
9115
+ * @extends {BaseAPI}
9116
+ */
9117
+ class SearchSessionsApi extends base_1.BaseAPI {
9118
+ /**
9119
+ * Create a `search-session`.
9120
+ * @param {SearchSessionsApiCreateSearchSessionRequest} requestParameters Request parameters.
9121
+ * @param {*} [options] Override http request option.
9122
+ * @throws {RequiredError}
9123
+ * @memberof SearchSessionsApi
9124
+ */
9125
+ createSearchSession(requestParameters, options) {
9126
+ return (0, exports.SearchSessionsApiFp)(this.configuration)
9127
+ .createSearchSession(requestParameters.createSearchSessionRequest, options)
9128
+ .then((request) => request(this.axios, this.basePath));
9129
+ }
9130
+ /**
9131
+ * Get a `search-session`.
9132
+ * @param {SearchSessionsApiGetSearchSessionRequest} requestParameters Request parameters.
9133
+ * @param {*} [options] Override http request option.
9134
+ * @throws {RequiredError}
9135
+ * @memberof SearchSessionsApi
9136
+ */
9137
+ getSearchSession(requestParameters, options) {
9138
+ return (0, exports.SearchSessionsApiFp)(this.configuration)
9139
+ .getSearchSession(requestParameters.id, options)
9140
+ .then((request) => request(this.axios, this.basePath));
9141
+ }
9142
+ }
9143
+ exports.SearchSessionsApi = SearchSessionsApi;
8969
9144
  /**
8970
9145
  * StreamKeysApi - axios parameter creator
8971
9146
  * @export
@@ -1 +1 @@
1
- export declare const version = "0.30.0";
1
+ export declare const version = "0.30.2";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.version = void 0;
4
- exports.version = '0.30.0';
4
+ exports.version = '0.30.2';
package/dist/esm/api.d.ts CHANGED
@@ -2135,6 +2135,74 @@ export interface CreateSceneViewStateRequestDataRelationships {
2135
2135
  */
2136
2136
  source: SceneViewRelationship | SceneViewStateRelationship;
2137
2137
  }
2138
+ /**
2139
+ *
2140
+ * @export
2141
+ * @interface CreateSearchSessionRequest
2142
+ */
2143
+ export interface CreateSearchSessionRequest {
2144
+ /**
2145
+ *
2146
+ * @type {CreateSearchSessionRequestData}
2147
+ * @memberof CreateSearchSessionRequest
2148
+ */
2149
+ data: CreateSearchSessionRequestData;
2150
+ }
2151
+ /**
2152
+ *
2153
+ * @export
2154
+ * @interface CreateSearchSessionRequestData
2155
+ */
2156
+ export interface CreateSearchSessionRequestData {
2157
+ /**
2158
+ * Resource object type.
2159
+ * @type {string}
2160
+ * @memberof CreateSearchSessionRequestData
2161
+ */
2162
+ type: CreateSearchSessionRequestDataTypeEnum;
2163
+ /**
2164
+ *
2165
+ * @type {CreateSearchSessionRequestDataAttributes}
2166
+ * @memberof CreateSearchSessionRequestData
2167
+ */
2168
+ attributes: CreateSearchSessionRequestDataAttributes;
2169
+ /**
2170
+ *
2171
+ * @type {CreateSearchSessionRequestDataRelationships}
2172
+ * @memberof CreateSearchSessionRequestData
2173
+ */
2174
+ relationships: CreateSearchSessionRequestDataRelationships;
2175
+ }
2176
+ export declare const CreateSearchSessionRequestDataTypeEnum: {
2177
+ readonly SearchSession: "search-session";
2178
+ };
2179
+ export declare type CreateSearchSessionRequestDataTypeEnum = (typeof CreateSearchSessionRequestDataTypeEnum)[keyof typeof CreateSearchSessionRequestDataTypeEnum];
2180
+ /**
2181
+ *
2182
+ * @export
2183
+ * @interface CreateSearchSessionRequestDataAttributes
2184
+ */
2185
+ export interface CreateSearchSessionRequestDataAttributes {
2186
+ /**
2187
+ * Number of seconds before the search session is deleted.
2188
+ * @type {number}
2189
+ * @memberof CreateSearchSessionRequestDataAttributes
2190
+ */
2191
+ expiry?: number;
2192
+ }
2193
+ /**
2194
+ *
2195
+ * @export
2196
+ * @interface CreateSearchSessionRequestDataRelationships
2197
+ */
2198
+ export interface CreateSearchSessionRequestDataRelationships {
2199
+ /**
2200
+ *
2201
+ * @type {SceneRelationship}
2202
+ * @memberof CreateSearchSessionRequestDataRelationships
2203
+ */
2204
+ scene?: SceneRelationship;
2205
+ }
2138
2206
  /**
2139
2207
  *
2140
2208
  * @export
@@ -3054,6 +3122,12 @@ export interface FilterExpression {
3054
3122
  * @memberof FilterExpression
3055
3123
  */
3056
3124
  lte?: string;
3125
+ /**
3126
+ * A value of a filter.
3127
+ * @type {string}
3128
+ * @memberof FilterExpression
3129
+ */
3130
+ contains?: string;
3057
3131
  }
3058
3132
  /**
3059
3133
  *
@@ -6659,6 +6733,79 @@ export declare const SceneViewStateRelationshipDataTypeEnum: {
6659
6733
  readonly SceneViewState: "scene-view-state";
6660
6734
  };
6661
6735
  export declare type SceneViewStateRelationshipDataTypeEnum = (typeof SceneViewStateRelationshipDataTypeEnum)[keyof typeof SceneViewStateRelationshipDataTypeEnum];
6736
+ /**
6737
+ *
6738
+ * @export
6739
+ * @interface SearchSession
6740
+ */
6741
+ export interface SearchSession {
6742
+ /**
6743
+ *
6744
+ * @type {SearchSessionData}
6745
+ * @memberof SearchSession
6746
+ */
6747
+ data: SearchSessionData;
6748
+ /**
6749
+ *
6750
+ * @type {{ [key: string]: Link; }}
6751
+ * @memberof SearchSession
6752
+ */
6753
+ links?: {
6754
+ [key: string]: Link;
6755
+ };
6756
+ }
6757
+ /**
6758
+ *
6759
+ * @export
6760
+ * @interface SearchSessionData
6761
+ */
6762
+ export interface SearchSessionData {
6763
+ /**
6764
+ *
6765
+ * @type {string}
6766
+ * @memberof SearchSessionData
6767
+ */
6768
+ type: string;
6769
+ /**
6770
+ * ID of the resource.
6771
+ * @type {string}
6772
+ * @memberof SearchSessionData
6773
+ */
6774
+ id: string;
6775
+ /**
6776
+ *
6777
+ * @type {SearchSessionDataAttributes}
6778
+ * @memberof SearchSessionData
6779
+ */
6780
+ attributes: SearchSessionDataAttributes;
6781
+ /**
6782
+ *
6783
+ * @type {SceneViewDataRelationships}
6784
+ * @memberof SearchSessionData
6785
+ */
6786
+ relationships?: SceneViewDataRelationships;
6787
+ /**
6788
+ *
6789
+ * @type {{ [key: string]: Link; }}
6790
+ * @memberof SearchSessionData
6791
+ */
6792
+ links?: {
6793
+ [key: string]: Link;
6794
+ };
6795
+ }
6796
+ /**
6797
+ *
6798
+ * @export
6799
+ * @interface SearchSessionDataAttributes
6800
+ */
6801
+ export interface SearchSessionDataAttributes {
6802
+ /**
6803
+ *
6804
+ * @type {string}
6805
+ * @memberof SearchSessionDataAttributes
6806
+ */
6807
+ status: string;
6808
+ }
6662
6809
  /**
6663
6810
  *
6664
6811
  * @export
@@ -11128,7 +11275,7 @@ export declare class PartRenditionsApi extends BaseAPI {
11128
11275
  */
11129
11276
  export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
11130
11277
  /**
11131
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11278
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11132
11279
  * @param {string} [filterParent] Parent ID to filter on.
11133
11280
  * @param {string} [pageCursor] The cursor for the next page of items.
11134
11281
  * @param {number} [pageSize] The number of items to return.
@@ -11143,7 +11290,7 @@ export declare const PartRevisionInstancesApiAxiosParamCreator: (configuration?:
11143
11290
  */
11144
11291
  export declare const PartRevisionInstancesApiFp: (configuration?: Configuration | undefined) => {
11145
11292
  /**
11146
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11293
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11147
11294
  * @param {string} [filterParent] Parent ID to filter on.
11148
11295
  * @param {string} [pageCursor] The cursor for the next page of items.
11149
11296
  * @param {number} [pageSize] The number of items to return.
@@ -11158,7 +11305,7 @@ export declare const PartRevisionInstancesApiFp: (configuration?: Configuration
11158
11305
  */
11159
11306
  export declare const PartRevisionInstancesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
11160
11307
  /**
11161
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11308
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11162
11309
  * @param {string} [filterParent] Parent ID to filter on.
11163
11310
  * @param {string} [pageCursor] The cursor for the next page of items.
11164
11311
  * @param {number} [pageSize] The number of items to return.
@@ -11200,7 +11347,7 @@ export interface PartRevisionInstancesApiGetPartRevisionInstanceListRequest {
11200
11347
  */
11201
11348
  export declare class PartRevisionInstancesApi extends BaseAPI {
11202
11349
  /**
11203
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11350
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
11204
11351
  * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
11205
11352
  * @param {*} [options] Override http request option.
11206
11353
  * @throws {RequiredError}
@@ -14624,6 +14771,116 @@ export declare class ScenesApi extends BaseAPI {
14624
14771
  */
14625
14772
  updateScene(requestParameters: ScenesApiUpdateSceneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scene, any>>;
14626
14773
  }
14774
+ /**
14775
+ * SearchSessionsApi - axios parameter creator
14776
+ * @export
14777
+ */
14778
+ export declare const SearchSessionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
14779
+ /**
14780
+ * Create a `search-session`.
14781
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
14782
+ * @param {*} [options] Override http request option.
14783
+ * @throws {RequiredError}
14784
+ */
14785
+ createSearchSession: (createSearchSessionRequest: CreateSearchSessionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
14786
+ /**
14787
+ * Get a `search-session`.
14788
+ * @param {string} id The &#x60;search-session&#x60; ID.
14789
+ * @param {*} [options] Override http request option.
14790
+ * @throws {RequiredError}
14791
+ */
14792
+ getSearchSession: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
14793
+ };
14794
+ /**
14795
+ * SearchSessionsApi - functional programming interface
14796
+ * @export
14797
+ */
14798
+ export declare const SearchSessionsApiFp: (configuration?: Configuration | undefined) => {
14799
+ /**
14800
+ * Create a `search-session`.
14801
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
14802
+ * @param {*} [options] Override http request option.
14803
+ * @throws {RequiredError}
14804
+ */
14805
+ createSearchSession(createSearchSessionRequest: CreateSearchSessionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SearchSession>>;
14806
+ /**
14807
+ * Get a `search-session`.
14808
+ * @param {string} id The &#x60;search-session&#x60; ID.
14809
+ * @param {*} [options] Override http request option.
14810
+ * @throws {RequiredError}
14811
+ */
14812
+ getSearchSession(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SearchSession>>;
14813
+ };
14814
+ /**
14815
+ * SearchSessionsApi - factory interface
14816
+ * @export
14817
+ */
14818
+ export declare const SearchSessionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
14819
+ /**
14820
+ * Create a `search-session`.
14821
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
14822
+ * @param {*} [options] Override http request option.
14823
+ * @throws {RequiredError}
14824
+ */
14825
+ createSearchSession(createSearchSessionRequest: CreateSearchSessionRequest, options?: any): AxiosPromise<SearchSession>;
14826
+ /**
14827
+ * Get a `search-session`.
14828
+ * @param {string} id The &#x60;search-session&#x60; ID.
14829
+ * @param {*} [options] Override http request option.
14830
+ * @throws {RequiredError}
14831
+ */
14832
+ getSearchSession(id: string, options?: any): AxiosPromise<SearchSession>;
14833
+ };
14834
+ /**
14835
+ * Request parameters for createSearchSession operation in SearchSessionsApi.
14836
+ * @export
14837
+ * @interface SearchSessionsApiCreateSearchSessionRequest
14838
+ */
14839
+ export interface SearchSessionsApiCreateSearchSessionRequest {
14840
+ /**
14841
+ *
14842
+ * @type {CreateSearchSessionRequest}
14843
+ * @memberof SearchSessionsApiCreateSearchSession
14844
+ */
14845
+ readonly createSearchSessionRequest: CreateSearchSessionRequest;
14846
+ }
14847
+ /**
14848
+ * Request parameters for getSearchSession operation in SearchSessionsApi.
14849
+ * @export
14850
+ * @interface SearchSessionsApiGetSearchSessionRequest
14851
+ */
14852
+ export interface SearchSessionsApiGetSearchSessionRequest {
14853
+ /**
14854
+ * The &#x60;search-session&#x60; ID.
14855
+ * @type {string}
14856
+ * @memberof SearchSessionsApiGetSearchSession
14857
+ */
14858
+ readonly id: string;
14859
+ }
14860
+ /**
14861
+ * SearchSessionsApi - object-oriented interface
14862
+ * @export
14863
+ * @class SearchSessionsApi
14864
+ * @extends {BaseAPI}
14865
+ */
14866
+ export declare class SearchSessionsApi extends BaseAPI {
14867
+ /**
14868
+ * Create a `search-session`.
14869
+ * @param {SearchSessionsApiCreateSearchSessionRequest} requestParameters Request parameters.
14870
+ * @param {*} [options] Override http request option.
14871
+ * @throws {RequiredError}
14872
+ * @memberof SearchSessionsApi
14873
+ */
14874
+ createSearchSession(requestParameters: SearchSessionsApiCreateSearchSessionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchSession, any>>;
14875
+ /**
14876
+ * Get a `search-session`.
14877
+ * @param {SearchSessionsApiGetSearchSessionRequest} requestParameters Request parameters.
14878
+ * @param {*} [options] Override http request option.
14879
+ * @throws {RequiredError}
14880
+ * @memberof SearchSessionsApi
14881
+ */
14882
+ getSearchSession(requestParameters: SearchSessionsApiGetSearchSessionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchSession, any>>;
14883
+ }
14627
14884
  /**
14628
14885
  * StreamKeysApi - axios parameter creator
14629
14886
  * @export
package/dist/esm/api.js CHANGED
@@ -68,6 +68,9 @@ export const CreateSceneItemRequestDataAttributesResolutionRuleEnum = {
68
68
  LatestIteration: 'latest-iteration',
69
69
  LatestRevision: 'latest-revision',
70
70
  };
71
+ export const CreateSearchSessionRequestDataTypeEnum = {
72
+ SearchSession: 'search-session',
73
+ };
71
74
  export const DeselectOperationTypeEnum = {
72
75
  Deselect: 'deselect',
73
76
  };
@@ -4076,7 +4079,7 @@ export class PartRenditionsApi extends BaseAPI {
4076
4079
  export const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
4077
4080
  return {
4078
4081
  /**
4079
- * 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.
4082
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4080
4083
  * @param {string} [filterParent] Parent ID to filter on.
4081
4084
  * @param {string} [pageCursor] The cursor for the next page of items.
4082
4085
  * @param {number} [pageSize] The number of items to return.
@@ -4125,7 +4128,7 @@ export const PartRevisionInstancesApiFp = function (configuration) {
4125
4128
  const localVarAxiosParamCreator = PartRevisionInstancesApiAxiosParamCreator(configuration);
4126
4129
  return {
4127
4130
  /**
4128
- * 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.
4131
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4129
4132
  * @param {string} [filterParent] Parent ID to filter on.
4130
4133
  * @param {string} [pageCursor] The cursor for the next page of items.
4131
4134
  * @param {number} [pageSize] The number of items to return.
@@ -4148,7 +4151,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
4148
4151
  const localVarFp = PartRevisionInstancesApiFp(configuration);
4149
4152
  return {
4150
4153
  /**
4151
- * 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.
4154
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4152
4155
  * @param {string} [filterParent] Parent ID to filter on.
4153
4156
  * @param {string} [pageCursor] The cursor for the next page of items.
4154
4157
  * @param {number} [pageSize] The number of items to return.
@@ -4170,7 +4173,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
4170
4173
  */
4171
4174
  export class PartRevisionInstancesApi extends BaseAPI {
4172
4175
  /**
4173
- * 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.
4176
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4174
4177
  * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
4175
4178
  * @param {*} [options] Override http request option.
4176
4179
  * @throws {RequiredError}
@@ -8857,6 +8860,174 @@ export class ScenesApi extends BaseAPI {
8857
8860
  .then((request) => request(this.axios, this.basePath));
8858
8861
  }
8859
8862
  }
8863
+ /**
8864
+ * SearchSessionsApi - axios parameter creator
8865
+ * @export
8866
+ */
8867
+ export const SearchSessionsApiAxiosParamCreator = function (configuration) {
8868
+ return {
8869
+ /**
8870
+ * Create a `search-session`.
8871
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
8872
+ * @param {*} [options] Override http request option.
8873
+ * @throws {RequiredError}
8874
+ */
8875
+ createSearchSession: (createSearchSessionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
8876
+ var _a;
8877
+ // verify required parameter 'createSearchSessionRequest' is not null or undefined
8878
+ assertParamExists('createSearchSession', 'createSearchSessionRequest', createSearchSessionRequest);
8879
+ const localVarPath = `/search-sessions`;
8880
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8881
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8882
+ let baseOptions;
8883
+ if (configuration) {
8884
+ baseOptions = configuration.baseOptions;
8885
+ }
8886
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
8887
+ const localVarHeaderParameter = {};
8888
+ const localVarQueryParameter = {};
8889
+ // authentication OAuth2 required
8890
+ // oauth required
8891
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
8892
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
8893
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8894
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
8895
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8896
+ localVarRequestOptions.data = serializeDataIfNeeded(createSearchSessionRequest, localVarRequestOptions, configuration);
8897
+ return {
8898
+ url: toPathString(localVarUrlObj),
8899
+ options: localVarRequestOptions,
8900
+ };
8901
+ }),
8902
+ /**
8903
+ * Get a `search-session`.
8904
+ * @param {string} id The &#x60;search-session&#x60; ID.
8905
+ * @param {*} [options] Override http request option.
8906
+ * @throws {RequiredError}
8907
+ */
8908
+ getSearchSession: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
8909
+ var _b;
8910
+ // verify required parameter 'id' is not null or undefined
8911
+ assertParamExists('getSearchSession', 'id', id);
8912
+ const localVarPath = `/search-sessions/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
8913
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8914
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8915
+ let baseOptions;
8916
+ if (configuration) {
8917
+ baseOptions = configuration.baseOptions;
8918
+ }
8919
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
8920
+ const localVarHeaderParameter = {};
8921
+ const localVarQueryParameter = {};
8922
+ // authentication OAuth2 required
8923
+ // oauth required
8924
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
8925
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8926
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
8927
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8928
+ return {
8929
+ url: toPathString(localVarUrlObj),
8930
+ options: localVarRequestOptions,
8931
+ };
8932
+ }),
8933
+ };
8934
+ };
8935
+ /**
8936
+ * SearchSessionsApi - functional programming interface
8937
+ * @export
8938
+ */
8939
+ export const SearchSessionsApiFp = function (configuration) {
8940
+ const localVarAxiosParamCreator = SearchSessionsApiAxiosParamCreator(configuration);
8941
+ return {
8942
+ /**
8943
+ * Create a `search-session`.
8944
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
8945
+ * @param {*} [options] Override http request option.
8946
+ * @throws {RequiredError}
8947
+ */
8948
+ createSearchSession(createSearchSessionRequest, options) {
8949
+ return __awaiter(this, void 0, void 0, function* () {
8950
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createSearchSession(createSearchSessionRequest, options);
8951
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
8952
+ });
8953
+ },
8954
+ /**
8955
+ * Get a `search-session`.
8956
+ * @param {string} id The &#x60;search-session&#x60; ID.
8957
+ * @param {*} [options] Override http request option.
8958
+ * @throws {RequiredError}
8959
+ */
8960
+ getSearchSession(id, options) {
8961
+ return __awaiter(this, void 0, void 0, function* () {
8962
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSearchSession(id, options);
8963
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
8964
+ });
8965
+ },
8966
+ };
8967
+ };
8968
+ /**
8969
+ * SearchSessionsApi - factory interface
8970
+ * @export
8971
+ */
8972
+ export const SearchSessionsApiFactory = function (configuration, basePath, axios) {
8973
+ const localVarFp = SearchSessionsApiFp(configuration);
8974
+ return {
8975
+ /**
8976
+ * Create a `search-session`.
8977
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
8978
+ * @param {*} [options] Override http request option.
8979
+ * @throws {RequiredError}
8980
+ */
8981
+ createSearchSession(createSearchSessionRequest, options) {
8982
+ return localVarFp
8983
+ .createSearchSession(createSearchSessionRequest, options)
8984
+ .then((request) => request(axios, basePath));
8985
+ },
8986
+ /**
8987
+ * Get a `search-session`.
8988
+ * @param {string} id The &#x60;search-session&#x60; ID.
8989
+ * @param {*} [options] Override http request option.
8990
+ * @throws {RequiredError}
8991
+ */
8992
+ getSearchSession(id, options) {
8993
+ return localVarFp
8994
+ .getSearchSession(id, options)
8995
+ .then((request) => request(axios, basePath));
8996
+ },
8997
+ };
8998
+ };
8999
+ /**
9000
+ * SearchSessionsApi - object-oriented interface
9001
+ * @export
9002
+ * @class SearchSessionsApi
9003
+ * @extends {BaseAPI}
9004
+ */
9005
+ export class SearchSessionsApi extends BaseAPI {
9006
+ /**
9007
+ * Create a `search-session`.
9008
+ * @param {SearchSessionsApiCreateSearchSessionRequest} requestParameters Request parameters.
9009
+ * @param {*} [options] Override http request option.
9010
+ * @throws {RequiredError}
9011
+ * @memberof SearchSessionsApi
9012
+ */
9013
+ createSearchSession(requestParameters, options) {
9014
+ return SearchSessionsApiFp(this.configuration)
9015
+ .createSearchSession(requestParameters.createSearchSessionRequest, options)
9016
+ .then((request) => request(this.axios, this.basePath));
9017
+ }
9018
+ /**
9019
+ * Get a `search-session`.
9020
+ * @param {SearchSessionsApiGetSearchSessionRequest} requestParameters Request parameters.
9021
+ * @param {*} [options] Override http request option.
9022
+ * @throws {RequiredError}
9023
+ * @memberof SearchSessionsApi
9024
+ */
9025
+ getSearchSession(requestParameters, options) {
9026
+ return SearchSessionsApiFp(this.configuration)
9027
+ .getSearchSession(requestParameters.id, options)
9028
+ .then((request) => request(this.axios, this.basePath));
9029
+ }
9030
+ }
8860
9031
  /**
8861
9032
  * StreamKeysApi - axios parameter creator
8862
9033
  * @export
@@ -1 +1 @@
1
- export declare const version = "0.30.0";
1
+ export declare const version = "0.30.2";
@@ -1 +1 @@
1
- export const version = '0.30.0';
1
+ export const version = '0.30.2';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertexvis/api-client-node",
3
- "version": "0.30.0",
3
+ "version": "0.30.2",
4
4
  "description": "The Vertex REST API client for Node.js.",
5
5
  "license": "MIT",
6
6
  "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",