From 610231a505c4759361e9d329f6634c4c238050e5 Mon Sep 17 00:00:00 2001 From: Jeff Murray Date: Mon, 21 Sep 2026 10:02:36 -0500 Subject: [PATCH 1/2] Update to latest spec --- api.ts | 787 +++++++++++++++++++++++++++++++++---------------------- spec.yml | 502 +++++++++++++++++++++++------------ 2 files changed, 806 insertions(+), 483 deletions(-) diff --git a/api.ts b/api.ts index ca65782..2de1c9c 100644 --- a/api.ts +++ b/api.ts @@ -1448,10 +1448,10 @@ export interface CreateAccountRequestDataAttributes { export interface CreateApplicationRequest { /** * - * @type {CreateAccountRequestData} + * @type {AdminCreateApplicationRequestData} * @memberof CreateApplicationRequest */ - data: CreateAccountRequestData; + data: AdminCreateApplicationRequestData; } /** * @@ -2959,15 +2959,16 @@ export interface CreateSceneItemRequestDataRelationships { */ parent?: SceneItemRelationship; /** - * Relationship to a `geometry-set`, `part-revision`, `part-rendition`, or `scene`. - * @type {GeometrySetRelationship | PartRevisionRelationship | SceneRelationship | PartRenditionRelationship} + * Relationship to a `geometry-set`, `part-revision`, `part-rendition`, `scene`, or `scene-item`. + * @type {GeometrySetRelationship | PartRevisionRelationship | SceneRelationship | PartRenditionRelationship | SceneItemRelationship} * @memberof CreateSceneItemRequestDataRelationships */ source?: | GeometrySetRelationship | PartRevisionRelationship | SceneRelationship - | PartRenditionRelationship; + | PartRenditionRelationship + | SceneItemRelationship; /** * * @type {SceneItemRelationship} @@ -4846,7 +4847,7 @@ export interface FillStyle { color: RGBA; } /** - * Describes how an attribute should be filtered. + * Describes how an attribute should be filtered. Logical operators accept literals or nested filter expressions. Repeated `and` and `or` parameters combine their values with the respective logical operator. * @export * @interface FilterExpression */ @@ -4893,7 +4894,31 @@ export interface FilterExpression { * @memberof FilterExpression */ contains?: string; + /** + * + * @type {FilterExpressionOrLiteral} + * @memberof FilterExpression + */ + and?: FilterExpressionOrLiteral; + /** + * + * @type {FilterExpressionOrLiteral} + * @memberof FilterExpression + */ + or?: FilterExpressionOrLiteral; + /** + * + * @type {FilterExpressionOrLiteral} + * @memberof FilterExpression + */ + not?: FilterExpressionOrLiteral; } +/** + * @type FilterExpressionOrLiteral + * @export + */ +export type FilterExpressionOrLiteral = FilterExpression | string; + /** * * @export @@ -6995,10 +7020,23 @@ export interface PropertyEntryDataAttributes { | PropertyDateType; /** * - * @type {PropertyKey} + * @type {PropertyEntryKey} * @memberof PropertyEntryDataAttributes */ - key: PropertyKey; + key: PropertyEntryKey; +} +/** + * + * @export + * @interface PropertyEntryKey + */ +export interface PropertyEntryKey { + /** + * + * @type {string} + * @memberof PropertyEntryKey + */ + name: string; } /** * @@ -7030,8 +7068,66 @@ export interface PropertyKey { * @type {string} * @memberof PropertyKey */ + type: PropertyKeyTypeEnum; + /** + * + * @type {string} + * @memberof PropertyKey + */ + id: string; + /** + * + * @type {PropertyKeyDataAttributes} + * @memberof PropertyKey + */ + attributes: PropertyKeyDataAttributes; + /** + * + * @type {{ [key: string]: Link; }} + * @memberof PropertyKey + */ + links?: { [key: string]: Link }; +} + +export const PropertyKeyTypeEnum = { + PropertyKey: 'property-key', +} as const; + +export type PropertyKeyTypeEnum = + (typeof PropertyKeyTypeEnum)[keyof typeof PropertyKeyTypeEnum]; + +/** + * + * @export + * @interface PropertyKeyDataAttributes + */ +export interface PropertyKeyDataAttributes { + /** + * + * @type {string} + * @memberof PropertyKeyDataAttributes + */ name: string; } +/** + * + * @export + * @interface PropertyKeyList + */ +export interface PropertyKeyList { + /** + * + * @type {Array} + * @memberof PropertyKeyList + */ + data: Array; + /** + * + * @type {{ [key: string]: Link; }} + * @memberof PropertyKeyList + */ + links: { [key: string]: Link }; +} /** * * @export @@ -7121,96 +7217,6 @@ export interface PropertyKeyPolicyDataAttributes { */ mode: PropertyKeyPolicyMode; } -/** - * - * @export - * @interface PropertyKeyPolicyEntryData - */ -export interface PropertyKeyPolicyEntryData { - /** - * - * @type {string} - * @memberof PropertyKeyPolicyEntryData - */ - type: PropertyKeyPolicyEntryDataTypeEnum; - /** - * - * @type {string} - * @memberof PropertyKeyPolicyEntryData - */ - id: string; - /** - * - * @type {PropertyKeyPolicyEntryDataAttributes} - * @memberof PropertyKeyPolicyEntryData - */ - attributes: PropertyKeyPolicyEntryDataAttributes; - /** - * - * @type {PropertyKeyPolicyEntryDataRelationships} - * @memberof PropertyKeyPolicyEntryData - */ - relationships: PropertyKeyPolicyEntryDataRelationships; - /** - * - * @type {{ [key: string]: Link; }} - * @memberof PropertyKeyPolicyEntryData - */ - links?: { [key: string]: Link }; -} - -export const PropertyKeyPolicyEntryDataTypeEnum = { - PropertyKeyPolicyEntry: 'property-key-policy-entry', -} as const; - -export type PropertyKeyPolicyEntryDataTypeEnum = - (typeof PropertyKeyPolicyEntryDataTypeEnum)[keyof typeof PropertyKeyPolicyEntryDataTypeEnum]; - -/** - * - * @export - * @interface PropertyKeyPolicyEntryDataAttributes - */ -export interface PropertyKeyPolicyEntryDataAttributes { - /** - * - * @type {PropertyKey} - * @memberof PropertyKeyPolicyEntryDataAttributes - */ - key: PropertyKey; -} -/** - * - * @export - * @interface PropertyKeyPolicyEntryDataRelationships - */ -export interface PropertyKeyPolicyEntryDataRelationships { - /** - * - * @type {PropertyKeyPolicyRelationship} - * @memberof PropertyKeyPolicyEntryDataRelationships - */ - propertyKeyPolicy: PropertyKeyPolicyRelationship; -} -/** - * - * @export - * @interface PropertyKeyPolicyEntryList - */ -export interface PropertyKeyPolicyEntryList { - /** - * - * @type {Array} - * @memberof PropertyKeyPolicyEntryList - */ - data: Array; - /** - * - * @type {{ [key: string]: Link; }} - * @memberof PropertyKeyPolicyEntryList - */ - links: { [key: string]: Link }; -} /** * * @export @@ -7244,46 +7250,6 @@ export const PropertyKeyPolicyMode = { export type PropertyKeyPolicyMode = (typeof PropertyKeyPolicyMode)[keyof typeof PropertyKeyPolicyMode]; -/** - * Relationship to a `property-key-policy`. - * @export - * @interface PropertyKeyPolicyRelationship - */ -export interface PropertyKeyPolicyRelationship { - /** - * - * @type {PropertyKeyPolicyRelationshipData} - * @memberof PropertyKeyPolicyRelationship - */ - data: PropertyKeyPolicyRelationshipData; -} -/** - * - * @export - * @interface PropertyKeyPolicyRelationshipData - */ -export interface PropertyKeyPolicyRelationshipData { - /** - * Resource object type. - * @type {string} - * @memberof PropertyKeyPolicyRelationshipData - */ - type: PropertyKeyPolicyRelationshipDataTypeEnum; - /** - * ID of the resource. - * @type {string} - * @memberof PropertyKeyPolicyRelationshipData - */ - id: string; -} - -export const PropertyKeyPolicyRelationshipDataTypeEnum = { - PropertyKeyPolicy: 'property-key-policy', -} as const; - -export type PropertyKeyPolicyRelationshipDataTypeEnum = - (typeof PropertyKeyPolicyRelationshipDataTypeEnum)[keyof typeof PropertyKeyPolicyRelationshipDataTypeEnum]; - /** * * @export @@ -8913,15 +8879,16 @@ export interface SceneItemDataAttributes { */ export interface SceneItemDataRelationships { /** - * - * @type {GeometrySetRelationship | PartRevisionRelationship | SceneRelationship | PartRenditionRelationship} + * Relationship to a `geometry-set`, `part-revision`, `part-rendition`, `scene`, or `scene-item`. + * @type {GeometrySetRelationship | PartRevisionRelationship | SceneRelationship | PartRenditionRelationship | SceneItemRelationship} * @memberof SceneItemDataRelationships */ source?: | GeometrySetRelationship | PartRevisionRelationship | SceneRelationship - | PartRenditionRelationship; + | PartRenditionRelationship + | SceneItemRelationship; /** * * @type {SceneItemRelationship} @@ -10774,6 +10741,12 @@ export interface UpdateApplicationRequestDataAttributes { * @memberof UpdateApplicationRequestDataAttributes */ name?: string; + /** + * + * @type {Array} + * @memberof UpdateApplicationRequestDataAttributes + */ + scopes?: Array; /** * * @type {Array} @@ -11378,6 +11351,12 @@ export interface UpdateSceneItemRequestDataAttributes { * @interface UpdateSceneItemRequestDataRelationships */ export interface UpdateSceneItemRequestDataRelationships { + /** + * Relationship to the scene item\'s new parent. Set this relationship to `null` to move the item to the scene root. + * @type {SceneItemRelationship | object} + * @memberof UpdateSceneItemRequestDataRelationships + */ + parent?: SceneItemRelationship | object | null; /** * Relationship to a `geometry-set` or `part-revision`. * @type {GeometrySetRelationship | PartRevisionRelationship | object} @@ -11802,15 +11781,15 @@ export interface UpsertPropertyEntriesRequestDataRelationships { /** * * @export - * @interface UpsertPropertyKeyPolicyEntriesRequest + * @interface UpsertPropertyKeyPolicyKeysRequest */ -export interface UpsertPropertyKeyPolicyEntriesRequest { +export interface UpsertPropertyKeyPolicyKeysRequest { /** * - * @type {Array} - * @memberof UpsertPropertyKeyPolicyEntriesRequest + * @type {Array} + * @memberof UpsertPropertyKeyPolicyKeysRequest */ - data: Array; + data: Array; } /** * @@ -17513,17 +17492,23 @@ export const FileCollectionsApiAxiosParamCreator = function ( }; }, /** - * List `file-collection`s by supplied ID. + * List `file-collection`s with optional partial name, supplied ID, and creation time filters, sorted by name or creation time. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. - * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. + * @param {FilterExpression} [filterName] A filter expression for the `file-collection` name. The canonical form is a filter expression such as `filter[name][contains]=...`. + * @param {FilterExpression} [filterSuppliedId] A filter expression for the `file-collection` supplied ID. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. + * @param {FilterExpression} [filterCreatedAt] A filter expression for a resource\'s creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. + * @param {'name' | '-name' | 'created' | '-created'} [sort] A sort to apply to file collections. A \"minus\" prefix before the field name specifies descending sort order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFileCollections: async ( pageCursor?: string, pageSize?: number, - filterSuppliedId?: string, + filterName?: FilterExpression, + filterSuppliedId?: FilterExpression, + filterCreatedAt?: FilterExpression, + sort?: 'name' | '-name' | 'created' | '-created', options: AxiosRequestConfig = {} ): Promise => { const localVarPath = `/file-collections`; @@ -17559,10 +17544,22 @@ export const FileCollectionsApiAxiosParamCreator = function ( localVarQueryParameter['page[size]'] = pageSize; } + if (filterName !== undefined) { + localVarQueryParameter['filter[name]'] = filterName; + } + if (filterSuppliedId !== undefined) { localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId; } + if (filterCreatedAt !== undefined) { + localVarQueryParameter['filter[createdAt]'] = filterCreatedAt; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions?.headers ?? {}; localVarRequestOptions.headers = { @@ -17847,17 +17844,23 @@ export const FileCollectionsApiFp = function (configuration?: Configuration) { ); }, /** - * List `file-collection`s by supplied ID. + * List `file-collection`s with optional partial name, supplied ID, and creation time filters, sorted by name or creation time. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. - * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. + * @param {FilterExpression} [filterName] A filter expression for the `file-collection` name. The canonical form is a filter expression such as `filter[name][contains]=...`. + * @param {FilterExpression} [filterSuppliedId] A filter expression for the `file-collection` supplied ID. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. + * @param {FilterExpression} [filterCreatedAt] A filter expression for a resource\'s creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. + * @param {'name' | '-name' | 'created' | '-created'} [sort] A sort to apply to file collections. A \"minus\" prefix before the field name specifies descending sort order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async listFileCollections( pageCursor?: string, pageSize?: number, - filterSuppliedId?: string, + filterName?: FilterExpression, + filterSuppliedId?: FilterExpression, + filterCreatedAt?: FilterExpression, + sort?: 'name' | '-name' | 'created' | '-created', options?: AxiosRequestConfig ): Promise< ( @@ -17869,7 +17872,10 @@ export const FileCollectionsApiFp = function (configuration?: Configuration) { await localVarAxiosParamCreator.listFileCollections( pageCursor, pageSize, + filterName, filterSuppliedId, + filterCreatedAt, + sort, options ); return createRequestFunction( @@ -18024,21 +18030,35 @@ export const FileCollectionsApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * List `file-collection`s by supplied ID. + * List `file-collection`s with optional partial name, supplied ID, and creation time filters, sorted by name or creation time. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. - * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. + * @param {FilterExpression} [filterName] A filter expression for the `file-collection` name. The canonical form is a filter expression such as `filter[name][contains]=...`. + * @param {FilterExpression} [filterSuppliedId] A filter expression for the `file-collection` supplied ID. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. + * @param {FilterExpression} [filterCreatedAt] A filter expression for a resource\'s creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. + * @param {'name' | '-name' | 'created' | '-created'} [sort] A sort to apply to file collections. A \"minus\" prefix before the field name specifies descending sort order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFileCollections( pageCursor?: string, pageSize?: number, - filterSuppliedId?: string, + filterName?: FilterExpression, + filterSuppliedId?: FilterExpression, + filterCreatedAt?: FilterExpression, + sort?: 'name' | '-name' | 'created' | '-created', options?: any ): AxiosPromise { return localVarFp - .listFileCollections(pageCursor, pageSize, filterSuppliedId, options) + .listFileCollections( + pageCursor, + pageSize, + filterName, + filterSuppliedId, + filterCreatedAt, + sort, + options + ) .then((request) => request(axios, basePath)); }, /** @@ -18188,11 +18208,32 @@ export interface FileCollectionsApiListFileCollectionsRequest { readonly pageSize?: number; /** - * Comma-separated list of supplied IDs to filter on. - * @type {string} + * A filter expression for the `file-collection` name. The canonical form is a filter expression such as `filter[name][contains]=...`. + * @type {FilterExpression} * @memberof FileCollectionsApiListFileCollections */ - readonly filterSuppliedId?: string; + readonly filterName?: FilterExpression; + + /** + * A filter expression for the `file-collection` supplied ID. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. + * @type {FilterExpression} + * @memberof FileCollectionsApiListFileCollections + */ + readonly filterSuppliedId?: FilterExpression; + + /** + * A filter expression for a resource\'s creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. + * @type {FilterExpression} + * @memberof FileCollectionsApiListFileCollections + */ + readonly filterCreatedAt?: FilterExpression; + + /** + * A sort to apply to file collections. A \"minus\" prefix before the field name specifies descending sort order. + * @type {'name' | '-name' | 'created' | '-created'} + * @memberof FileCollectionsApiListFileCollections + */ + readonly sort?: 'name' | '-name' | 'created' | '-created'; } /** @@ -18337,7 +18378,7 @@ export class FileCollectionsApi extends BaseAPI { } /** - * List `file-collection`s by supplied ID. + * List `file-collection`s with optional partial name, supplied ID, and creation time filters, sorted by name or creation time. * @param {FileCollectionsApiListFileCollectionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -18351,7 +18392,10 @@ export class FileCollectionsApi extends BaseAPI { .listFileCollections( requestParameters.pageCursor, requestParameters.pageSize, + requestParameters.filterName, requestParameters.filterSuppliedId, + requestParameters.filterCreatedAt, + requestParameters.sort, options ) .then((request) => request(this.axios, this.basePath)); @@ -18998,10 +19042,10 @@ export const FilesApiAxiosParamCreator = function ( * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [sort] A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order. - * @param {FilterExpression} [filterName] A filter expression for the `name` to filter on. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {FilterExpression} [filterFileId] A filter expression for the `fileId` to filter on. * @param {string | FilterExpression} [filterSuppliedId] A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility. - * @param {FilterExpression} [filterCreatedAt] A filter expression for the `createdAt` to filter on. + * @param {FilterExpression} [filterCreatedAt] A filter expression for a resource\'s creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -19009,7 +19053,7 @@ export const FilesApiAxiosParamCreator = function ( pageCursor?: string, pageSize?: number, sort?: string, - filterName?: FilterExpression, + filterName?: FilterExpressionOrLiteral, filterFileId?: FilterExpression, filterSuppliedId?: string | FilterExpression, filterCreatedAt?: FilterExpression, @@ -19411,10 +19455,10 @@ export const FilesApiFp = function (configuration?: Configuration) { * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [sort] A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order. - * @param {FilterExpression} [filterName] A filter expression for the `name` to filter on. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {FilterExpression} [filterFileId] A filter expression for the `fileId` to filter on. * @param {string | FilterExpression} [filterSuppliedId] A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility. - * @param {FilterExpression} [filterCreatedAt] A filter expression for the `createdAt` to filter on. + * @param {FilterExpression} [filterCreatedAt] A filter expression for a resource\'s creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -19422,7 +19466,7 @@ export const FilesApiFp = function (configuration?: Configuration) { pageCursor?: string, pageSize?: number, sort?: string, - filterName?: FilterExpression, + filterName?: FilterExpressionOrLiteral, filterFileId?: FilterExpression, filterSuppliedId?: string | FilterExpression, filterCreatedAt?: FilterExpression, @@ -19619,10 +19663,10 @@ export const FilesApiFactory = function ( * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [sort] A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order. - * @param {FilterExpression} [filterName] A filter expression for the `name` to filter on. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {FilterExpression} [filterFileId] A filter expression for the `fileId` to filter on. * @param {string | FilterExpression} [filterSuppliedId] A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility. - * @param {FilterExpression} [filterCreatedAt] A filter expression for the `createdAt` to filter on. + * @param {FilterExpression} [filterCreatedAt] A filter expression for a resource\'s creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -19630,7 +19674,7 @@ export const FilesApiFactory = function ( pageCursor?: string, pageSize?: number, sort?: string, - filterName?: FilterExpression, + filterName?: FilterExpressionOrLiteral, filterFileId?: FilterExpression, filterSuppliedId?: string | FilterExpression, filterCreatedAt?: FilterExpression, @@ -19810,11 +19854,11 @@ export interface FilesApiGetFilesRequest { readonly sort?: string; /** - * A filter expression for the `name` to filter on. - * @type {FilterExpression} + * Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. + * @type {FilterExpressionOrLiteral} * @memberof FilesApiGetFiles */ - readonly filterName?: FilterExpression; + readonly filterName?: FilterExpressionOrLiteral; /** * A filter expression for the `fileId` to filter on. @@ -19831,7 +19875,7 @@ export interface FilesApiGetFilesRequest { readonly filterSuppliedId?: string | FilterExpression; /** - * A filter expression for the `createdAt` to filter on. + * A filter expression for a resource\'s creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. * @type {FilterExpression} * @memberof FilesApiGetFiles */ @@ -24231,6 +24275,7 @@ export const PartsApiAxiosParamCreator = function ( * Get `parts`. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. * @param {string} [filterOwnerId] Owner ID to filter on. * @param {*} [options] Override http request option. @@ -24239,6 +24284,7 @@ export const PartsApiAxiosParamCreator = function ( getParts: async ( pageCursor?: string, pageSize?: number, + filterName?: FilterExpressionOrLiteral, filterSuppliedId?: string, filterOwnerId?: string, options: AxiosRequestConfig = {} @@ -24276,6 +24322,10 @@ export const PartsApiAxiosParamCreator = function ( localVarQueryParameter['page[size]'] = pageSize; } + if (filterName !== undefined) { + localVarQueryParameter['filter[name]'] = filterName; + } + if (filterSuppliedId !== undefined) { localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId; } @@ -24500,6 +24550,7 @@ export const PartsApiFp = function (configuration?: Configuration) { * Get `parts`. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. * @param {string} [filterOwnerId] Owner ID to filter on. * @param {*} [options] Override http request option. @@ -24508,6 +24559,7 @@ export const PartsApiFp = function (configuration?: Configuration) { async getParts( pageCursor?: string, pageSize?: number, + filterName?: FilterExpressionOrLiteral, filterSuppliedId?: string, filterOwnerId?: string, options?: AxiosRequestConfig @@ -24517,6 +24569,7 @@ export const PartsApiFp = function (configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.getParts( pageCursor, pageSize, + filterName, filterSuppliedId, filterOwnerId, options @@ -24630,6 +24683,7 @@ export const PartsApiFactory = function ( * Get `parts`. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. * @param {string} [filterOwnerId] Owner ID to filter on. * @param {*} [options] Override http request option. @@ -24638,6 +24692,7 @@ export const PartsApiFactory = function ( getParts( pageCursor?: string, pageSize?: number, + filterName?: FilterExpressionOrLiteral, filterSuppliedId?: string, filterOwnerId?: string, options?: any @@ -24646,6 +24701,7 @@ export const PartsApiFactory = function ( .getParts( pageCursor, pageSize, + filterName, filterSuppliedId, filterOwnerId, options @@ -24751,6 +24807,13 @@ export interface PartsApiGetPartsRequest { */ readonly pageSize?: number; + /** + * Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. + * @type {FilterExpressionOrLiteral} + * @memberof PartsApiGetParts + */ + readonly filterName?: FilterExpressionOrLiteral; + /** * Comma-separated list of supplied IDs to filter on. * @type {string} @@ -24871,6 +24934,7 @@ export class PartsApi extends BaseAPI { .getParts( requestParameters.pageCursor, requestParameters.pageSize, + requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.filterOwnerId, options @@ -26183,20 +26247,20 @@ export const PropertyKeyPoliciesApiAxiosParamCreator = function ( }; }, /** - * Delete entries from a `property-key-policy`. + * Delete property keys from a `property-key-policy`. * @param {string} id The `property-key-policy` ID. * @param {string} [filterId] Comma-separated list of IDs to filter on. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deletePropertyKeyPolicyEntries: async ( + deletePropertyKeyPolicyKeys: async ( id: string, filterId?: string, options: AxiosRequestConfig = {} ): Promise => { // verify required parameter 'id' is not null or undefined - assertParamExists('deletePropertyKeyPolicyEntries', 'id', id); - const localVarPath = `/property-key-policies/{id}/entries`.replace( + assertParamExists('deletePropertyKeyPolicyKeys', 'id', id); + const localVarPath = `/property-key-policies/{id}/keys`.replace( `{${'id'}}`, encodeURIComponent(String(id)) ); @@ -26359,22 +26423,25 @@ export const PropertyKeyPoliciesApiAxiosParamCreator = function ( }; }, /** - * Get `property-key-policy-entry` resources for a `property-key-policy`. Accepts `filter[propertyKeyPolicy.id]` and `filter[propertyKeyPolicy.suppliedId]`. When both are provided, `filter[propertyKeyPolicy.id]` takes precedence. + * Get property keys for a `property-key-policy`. + * @param {string} id The `property-key-policy` ID. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. - * @param {string} [filterPropertyKeyPolicyId] The `property-key-policy` ID to filter on. - * @param {string} [filterPropertyKeyPolicySuppliedId] The `property-key-policy` supplied ID to filter on. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listPropertyKeyPolicyEntries: async ( + listPropertyKeyPolicyKeys: async ( + id: string, pageCursor?: string, pageSize?: number, - filterPropertyKeyPolicyId?: string, - filterPropertyKeyPolicySuppliedId?: string, options: AxiosRequestConfig = {} ): Promise => { - const localVarPath = `/property-key-policy-entries`; + // verify required parameter 'id' is not null or undefined + assertParamExists('listPropertyKeyPolicyKeys', 'id', id); + const localVarPath = `/property-key-policies/{id}/keys`.replace( + `{${'id'}}`, + encodeURIComponent(String(id)) + ); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -26407,16 +26474,6 @@ export const PropertyKeyPoliciesApiAxiosParamCreator = function ( localVarQueryParameter['page[size]'] = pageSize; } - if (filterPropertyKeyPolicyId !== undefined) { - localVarQueryParameter['filter[propertyKeyPolicy.id]'] = - filterPropertyKeyPolicyId; - } - - if (filterPropertyKeyPolicySuppliedId !== undefined) { - localVarQueryParameter['filter[propertyKeyPolicy.suppliedId]'] = - filterPropertyKeyPolicySuppliedId; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions?.headers ?? {}; localVarRequestOptions.headers = { @@ -26431,26 +26488,26 @@ export const PropertyKeyPoliciesApiAxiosParamCreator = function ( }; }, /** - * Upsert entries for a `property-key-policy`. + * Upsert property keys for a `property-key-policy`. * @param {string} id The `property-key-policy` ID. - * @param {UpsertPropertyKeyPolicyEntriesRequest} upsertPropertyKeyPolicyEntriesRequest + * @param {UpsertPropertyKeyPolicyKeysRequest} upsertPropertyKeyPolicyKeysRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - upsertPropertyKeyPolicyEntries: async ( + upsertPropertyKeyPolicyKeys: async ( id: string, - upsertPropertyKeyPolicyEntriesRequest: UpsertPropertyKeyPolicyEntriesRequest, + upsertPropertyKeyPolicyKeysRequest: UpsertPropertyKeyPolicyKeysRequest, options: AxiosRequestConfig = {} ): Promise => { // verify required parameter 'id' is not null or undefined - assertParamExists('upsertPropertyKeyPolicyEntries', 'id', id); - // verify required parameter 'upsertPropertyKeyPolicyEntriesRequest' is not null or undefined + assertParamExists('upsertPropertyKeyPolicyKeys', 'id', id); + // verify required parameter 'upsertPropertyKeyPolicyKeysRequest' is not null or undefined assertParamExists( - 'upsertPropertyKeyPolicyEntries', - 'upsertPropertyKeyPolicyEntriesRequest', - upsertPropertyKeyPolicyEntriesRequest + 'upsertPropertyKeyPolicyKeys', + 'upsertPropertyKeyPolicyKeysRequest', + upsertPropertyKeyPolicyKeysRequest ); - const localVarPath = `/property-key-policies/{id}/entries`.replace( + const localVarPath = `/property-key-policies/{id}/keys`.replace( `{${'id'}}`, encodeURIComponent(String(id)) ); @@ -26488,7 +26545,7 @@ export const PropertyKeyPoliciesApiAxiosParamCreator = function ( ...options.headers, }; localVarRequestOptions.data = serializeDataIfNeeded( - upsertPropertyKeyPolicyEntriesRequest, + upsertPropertyKeyPolicyKeysRequest, localVarRequestOptions, configuration ); @@ -26560,13 +26617,13 @@ export const PropertyKeyPoliciesApiFp = function ( ); }, /** - * Delete entries from a `property-key-policy`. + * Delete property keys from a `property-key-policy`. * @param {string} id The `property-key-policy` ID. * @param {string} [filterId] Comma-separated list of IDs to filter on. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deletePropertyKeyPolicyEntries( + async deletePropertyKeyPolicyKeys( id: string, filterId?: string, options?: AxiosRequestConfig @@ -26574,7 +26631,7 @@ export const PropertyKeyPoliciesApiFp = function ( (axios?: AxiosInstance, basePath?: string) => AxiosPromise > { const localVarAxiosArgs = - await localVarAxiosParamCreator.deletePropertyKeyPolicyEntries( + await localVarAxiosParamCreator.deletePropertyKeyPolicyKeys( id, filterId, options @@ -26644,32 +26701,29 @@ export const PropertyKeyPoliciesApiFp = function ( ); }, /** - * Get `property-key-policy-entry` resources for a `property-key-policy`. Accepts `filter[propertyKeyPolicy.id]` and `filter[propertyKeyPolicy.suppliedId]`. When both are provided, `filter[propertyKeyPolicy.id]` takes precedence. + * Get property keys for a `property-key-policy`. + * @param {string} id The `property-key-policy` ID. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. - * @param {string} [filterPropertyKeyPolicyId] The `property-key-policy` ID to filter on. - * @param {string} [filterPropertyKeyPolicySuppliedId] The `property-key-policy` supplied ID to filter on. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listPropertyKeyPolicyEntries( + async listPropertyKeyPolicyKeys( + id: string, pageCursor?: string, pageSize?: number, - filterPropertyKeyPolicyId?: string, - filterPropertyKeyPolicySuppliedId?: string, options?: AxiosRequestConfig ): Promise< ( axios?: AxiosInstance, basePath?: string - ) => AxiosPromise + ) => AxiosPromise > { const localVarAxiosArgs = - await localVarAxiosParamCreator.listPropertyKeyPolicyEntries( + await localVarAxiosParamCreator.listPropertyKeyPolicyKeys( + id, pageCursor, pageSize, - filterPropertyKeyPolicyId, - filterPropertyKeyPolicySuppliedId, options ); return createRequestFunction( @@ -26680,23 +26734,23 @@ export const PropertyKeyPoliciesApiFp = function ( ); }, /** - * Upsert entries for a `property-key-policy`. + * Upsert property keys for a `property-key-policy`. * @param {string} id The `property-key-policy` ID. - * @param {UpsertPropertyKeyPolicyEntriesRequest} upsertPropertyKeyPolicyEntriesRequest + * @param {UpsertPropertyKeyPolicyKeysRequest} upsertPropertyKeyPolicyKeysRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async upsertPropertyKeyPolicyEntries( + async upsertPropertyKeyPolicyKeys( id: string, - upsertPropertyKeyPolicyEntriesRequest: UpsertPropertyKeyPolicyEntriesRequest, + upsertPropertyKeyPolicyKeysRequest: UpsertPropertyKeyPolicyKeysRequest, options?: AxiosRequestConfig ): Promise< (axios?: AxiosInstance, basePath?: string) => AxiosPromise > { const localVarAxiosArgs = - await localVarAxiosParamCreator.upsertPropertyKeyPolicyEntries( + await localVarAxiosParamCreator.upsertPropertyKeyPolicyKeys( id, - upsertPropertyKeyPolicyEntriesRequest, + upsertPropertyKeyPolicyKeysRequest, options ); return createRequestFunction( @@ -26746,19 +26800,19 @@ export const PropertyKeyPoliciesApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * Delete entries from a `property-key-policy`. + * Delete property keys from a `property-key-policy`. * @param {string} id The `property-key-policy` ID. * @param {string} [filterId] Comma-separated list of IDs to filter on. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deletePropertyKeyPolicyEntries( + deletePropertyKeyPolicyKeys( id: string, filterId?: string, options?: any ): AxiosPromise { return localVarFp - .deletePropertyKeyPolicyEntries(id, filterId, options) + .deletePropertyKeyPolicyKeys(id, filterId, options) .then((request) => request(axios, basePath)); }, /** @@ -26799,47 +26853,39 @@ export const PropertyKeyPoliciesApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * Get `property-key-policy-entry` resources for a `property-key-policy`. Accepts `filter[propertyKeyPolicy.id]` and `filter[propertyKeyPolicy.suppliedId]`. When both are provided, `filter[propertyKeyPolicy.id]` takes precedence. + * Get property keys for a `property-key-policy`. + * @param {string} id The `property-key-policy` ID. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. - * @param {string} [filterPropertyKeyPolicyId] The `property-key-policy` ID to filter on. - * @param {string} [filterPropertyKeyPolicySuppliedId] The `property-key-policy` supplied ID to filter on. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listPropertyKeyPolicyEntries( + listPropertyKeyPolicyKeys( + id: string, pageCursor?: string, pageSize?: number, - filterPropertyKeyPolicyId?: string, - filterPropertyKeyPolicySuppliedId?: string, options?: any - ): AxiosPromise { + ): AxiosPromise { return localVarFp - .listPropertyKeyPolicyEntries( - pageCursor, - pageSize, - filterPropertyKeyPolicyId, - filterPropertyKeyPolicySuppliedId, - options - ) + .listPropertyKeyPolicyKeys(id, pageCursor, pageSize, options) .then((request) => request(axios, basePath)); }, /** - * Upsert entries for a `property-key-policy`. + * Upsert property keys for a `property-key-policy`. * @param {string} id The `property-key-policy` ID. - * @param {UpsertPropertyKeyPolicyEntriesRequest} upsertPropertyKeyPolicyEntriesRequest + * @param {UpsertPropertyKeyPolicyKeysRequest} upsertPropertyKeyPolicyKeysRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - upsertPropertyKeyPolicyEntries( + upsertPropertyKeyPolicyKeys( id: string, - upsertPropertyKeyPolicyEntriesRequest: UpsertPropertyKeyPolicyEntriesRequest, + upsertPropertyKeyPolicyKeysRequest: UpsertPropertyKeyPolicyKeysRequest, options?: any ): AxiosPromise { return localVarFp - .upsertPropertyKeyPolicyEntries( + .upsertPropertyKeyPolicyKeys( id, - upsertPropertyKeyPolicyEntriesRequest, + upsertPropertyKeyPolicyKeysRequest, options ) .then((request) => request(axios, basePath)); @@ -26876,22 +26922,22 @@ export interface PropertyKeyPoliciesApiDeletePropertyKeyPolicyRequest { } /** - * Request parameters for deletePropertyKeyPolicyEntries operation in PropertyKeyPoliciesApi. + * Request parameters for deletePropertyKeyPolicyKeys operation in PropertyKeyPoliciesApi. * @export - * @interface PropertyKeyPoliciesApiDeletePropertyKeyPolicyEntriesRequest + * @interface PropertyKeyPoliciesApiDeletePropertyKeyPolicyKeysRequest */ -export interface PropertyKeyPoliciesApiDeletePropertyKeyPolicyEntriesRequest { +export interface PropertyKeyPoliciesApiDeletePropertyKeyPolicyKeysRequest { /** * The `property-key-policy` ID. * @type {string} - * @memberof PropertyKeyPoliciesApiDeletePropertyKeyPolicyEntries + * @memberof PropertyKeyPoliciesApiDeletePropertyKeyPolicyKeys */ readonly id: string; /** * Comma-separated list of IDs to filter on. * @type {string} - * @memberof PropertyKeyPoliciesApiDeletePropertyKeyPolicyEntries + * @memberof PropertyKeyPoliciesApiDeletePropertyKeyPolicyKeys */ readonly filterId?: string; } @@ -26939,59 +26985,52 @@ export interface PropertyKeyPoliciesApiListPropertyKeyPoliciesRequest { } /** - * Request parameters for listPropertyKeyPolicyEntries operation in PropertyKeyPoliciesApi. + * Request parameters for listPropertyKeyPolicyKeys operation in PropertyKeyPoliciesApi. * @export - * @interface PropertyKeyPoliciesApiListPropertyKeyPolicyEntriesRequest + * @interface PropertyKeyPoliciesApiListPropertyKeyPolicyKeysRequest */ -export interface PropertyKeyPoliciesApiListPropertyKeyPolicyEntriesRequest { +export interface PropertyKeyPoliciesApiListPropertyKeyPolicyKeysRequest { + /** + * The `property-key-policy` ID. + * @type {string} + * @memberof PropertyKeyPoliciesApiListPropertyKeyPolicyKeys + */ + readonly id: string; + /** * The cursor for the next page of items. * @type {string} - * @memberof PropertyKeyPoliciesApiListPropertyKeyPolicyEntries + * @memberof PropertyKeyPoliciesApiListPropertyKeyPolicyKeys */ readonly pageCursor?: string; /** * The number of items to return. * @type {number} - * @memberof PropertyKeyPoliciesApiListPropertyKeyPolicyEntries + * @memberof PropertyKeyPoliciesApiListPropertyKeyPolicyKeys */ readonly pageSize?: number; - - /** - * The `property-key-policy` ID to filter on. - * @type {string} - * @memberof PropertyKeyPoliciesApiListPropertyKeyPolicyEntries - */ - readonly filterPropertyKeyPolicyId?: string; - - /** - * The `property-key-policy` supplied ID to filter on. - * @type {string} - * @memberof PropertyKeyPoliciesApiListPropertyKeyPolicyEntries - */ - readonly filterPropertyKeyPolicySuppliedId?: string; } /** - * Request parameters for upsertPropertyKeyPolicyEntries operation in PropertyKeyPoliciesApi. + * Request parameters for upsertPropertyKeyPolicyKeys operation in PropertyKeyPoliciesApi. * @export - * @interface PropertyKeyPoliciesApiUpsertPropertyKeyPolicyEntriesRequest + * @interface PropertyKeyPoliciesApiUpsertPropertyKeyPolicyKeysRequest */ -export interface PropertyKeyPoliciesApiUpsertPropertyKeyPolicyEntriesRequest { +export interface PropertyKeyPoliciesApiUpsertPropertyKeyPolicyKeysRequest { /** * The `property-key-policy` ID. * @type {string} - * @memberof PropertyKeyPoliciesApiUpsertPropertyKeyPolicyEntries + * @memberof PropertyKeyPoliciesApiUpsertPropertyKeyPolicyKeys */ readonly id: string; /** * - * @type {UpsertPropertyKeyPolicyEntriesRequest} - * @memberof PropertyKeyPoliciesApiUpsertPropertyKeyPolicyEntries + * @type {UpsertPropertyKeyPolicyKeysRequest} + * @memberof PropertyKeyPoliciesApiUpsertPropertyKeyPolicyKeys */ - readonly upsertPropertyKeyPolicyEntriesRequest: UpsertPropertyKeyPolicyEntriesRequest; + readonly upsertPropertyKeyPolicyKeysRequest: UpsertPropertyKeyPolicyKeysRequest; } /** @@ -27037,18 +27076,18 @@ export class PropertyKeyPoliciesApi extends BaseAPI { } /** - * Delete entries from a `property-key-policy`. - * @param {PropertyKeyPoliciesApiDeletePropertyKeyPolicyEntriesRequest} requestParameters Request parameters. + * Delete property keys from a `property-key-policy`. + * @param {PropertyKeyPoliciesApiDeletePropertyKeyPolicyKeysRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PropertyKeyPoliciesApi */ - public deletePropertyKeyPolicyEntries( - requestParameters: PropertyKeyPoliciesApiDeletePropertyKeyPolicyEntriesRequest, + public deletePropertyKeyPolicyKeys( + requestParameters: PropertyKeyPoliciesApiDeletePropertyKeyPolicyKeysRequest, options?: AxiosRequestConfig ) { return PropertyKeyPoliciesApiFp(this.configuration) - .deletePropertyKeyPolicyEntries( + .deletePropertyKeyPolicyKeys( requestParameters.id, requestParameters.filterId, options @@ -27094,42 +27133,41 @@ export class PropertyKeyPoliciesApi extends BaseAPI { } /** - * Get `property-key-policy-entry` resources for a `property-key-policy`. Accepts `filter[propertyKeyPolicy.id]` and `filter[propertyKeyPolicy.suppliedId]`. When both are provided, `filter[propertyKeyPolicy.id]` takes precedence. - * @param {PropertyKeyPoliciesApiListPropertyKeyPolicyEntriesRequest} requestParameters Request parameters. + * Get property keys for a `property-key-policy`. + * @param {PropertyKeyPoliciesApiListPropertyKeyPolicyKeysRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PropertyKeyPoliciesApi */ - public listPropertyKeyPolicyEntries( - requestParameters: PropertyKeyPoliciesApiListPropertyKeyPolicyEntriesRequest = {}, + public listPropertyKeyPolicyKeys( + requestParameters: PropertyKeyPoliciesApiListPropertyKeyPolicyKeysRequest, options?: AxiosRequestConfig ) { return PropertyKeyPoliciesApiFp(this.configuration) - .listPropertyKeyPolicyEntries( + .listPropertyKeyPolicyKeys( + requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, - requestParameters.filterPropertyKeyPolicyId, - requestParameters.filterPropertyKeyPolicySuppliedId, options ) .then((request) => request(this.axios, this.basePath)); } /** - * Upsert entries for a `property-key-policy`. - * @param {PropertyKeyPoliciesApiUpsertPropertyKeyPolicyEntriesRequest} requestParameters Request parameters. + * Upsert property keys for a `property-key-policy`. + * @param {PropertyKeyPoliciesApiUpsertPropertyKeyPolicyKeysRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PropertyKeyPoliciesApi */ - public upsertPropertyKeyPolicyEntries( - requestParameters: PropertyKeyPoliciesApiUpsertPropertyKeyPolicyEntriesRequest, + public upsertPropertyKeyPolicyKeys( + requestParameters: PropertyKeyPoliciesApiUpsertPropertyKeyPolicyKeysRequest, options?: AxiosRequestConfig ) { return PropertyKeyPoliciesApiFp(this.configuration) - .upsertPropertyKeyPolicyEntries( + .upsertPropertyKeyPolicyKeys( requestParameters.id, - requestParameters.upsertPropertyKeyPolicyEntriesRequest, + requestParameters.upsertPropertyKeyPolicyKeysRequest, options ) .then((request) => request(this.axios, this.basePath)); @@ -28098,11 +28136,15 @@ export const SceneAlterationsApiAxiosParamCreator = function ( /** * Get `scene-alterations` for a `scene-view`. * @param {string} id The `scene-view` ID. + * @param {string} [pageCursor] The cursor for the next page of items. + * @param {number} [pageSize] The number of items to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSceneAlterations: async ( id: string, + pageCursor?: string, + pageSize?: number, options: AxiosRequestConfig = {} ): Promise => { // verify required parameter 'id' is not null or undefined @@ -28135,6 +28177,14 @@ export const SceneAlterationsApiAxiosParamCreator = function ( configuration ); + if (pageCursor !== undefined) { + localVarQueryParameter['page[cursor]'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['page[size]'] = pageSize; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions?.headers ?? {}; localVarRequestOptions.headers = { @@ -28236,11 +28286,15 @@ export const SceneAlterationsApiFp = function (configuration?: Configuration) { /** * Get `scene-alterations` for a `scene-view`. * @param {string} id The `scene-view` ID. + * @param {string} [pageCursor] The cursor for the next page of items. + * @param {number} [pageSize] The number of items to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getSceneAlterations( id: string, + pageCursor?: string, + pageSize?: number, options?: AxiosRequestConfig ): Promise< ( @@ -28249,7 +28303,12 @@ export const SceneAlterationsApiFp = function (configuration?: Configuration) { ) => AxiosPromise > { const localVarAxiosArgs = - await localVarAxiosParamCreator.getSceneAlterations(id, options); + await localVarAxiosParamCreator.getSceneAlterations( + id, + pageCursor, + pageSize, + options + ); return createRequestFunction( localVarAxiosArgs, globalAxios, @@ -28324,15 +28383,19 @@ export const SceneAlterationsApiFactory = function ( /** * Get `scene-alterations` for a `scene-view`. * @param {string} id The `scene-view` ID. + * @param {string} [pageCursor] The cursor for the next page of items. + * @param {number} [pageSize] The number of items to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSceneAlterations( id: string, + pageCursor?: string, + pageSize?: number, options?: any ): AxiosPromise { return localVarFp - .getSceneAlterations(id, options) + .getSceneAlterations(id, pageCursor, pageSize, options) .then((request) => request(axios, basePath)); }, }; @@ -28401,6 +28464,20 @@ export interface SceneAlterationsApiGetSceneAlterationsRequest { * @memberof SceneAlterationsApiGetSceneAlterations */ readonly id: string; + + /** + * The cursor for the next page of items. + * @type {string} + * @memberof SceneAlterationsApiGetSceneAlterations + */ + readonly pageCursor?: string; + + /** + * The number of items to return. + * @type {number} + * @memberof SceneAlterationsApiGetSceneAlterations + */ + readonly pageSize?: number; } /** @@ -28474,7 +28551,12 @@ export class SceneAlterationsApi extends BaseAPI { options?: AxiosRequestConfig ) { return SceneAlterationsApiFp(this.configuration) - .getSceneAlterations(requestParameters.id, options) + .getSceneAlterations( + requestParameters.id, + requestParameters.pageCursor, + requestParameters.pageSize, + options + ) .then((request) => request(this.axios, this.basePath)); } } @@ -29959,7 +30041,7 @@ export const SceneItemsApiAxiosParamCreator = function ( ) { return { /** - * Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`. Provide an existing `scene` using `relationship.source` to clone it. Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. + * Create a `scene-item` for a `scene`. Provide the source via a `part-revision`, `geometry-set`, `scene`, or `scene-item` UUID using `relationships.source`, or by supplied part-revision IDs using `attributes.source`. Provide an existing `scene` using `relationships.source` to clone it. Provide an existing `scene-item` using `relationships.source` to copy it. The source `scene-item` may belong to a different `scene`. Provide the hierarchical parent either via `scene-item` UUID using `relationships.parent` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. * @param {string} id The `scene` ID. * @param {CreateSceneItemRequest} createSceneItemRequest * @param {*} [options] Override http request option. @@ -30249,6 +30331,7 @@ export const SceneItemsApiAxiosParamCreator = function ( * @param {string} id The `scene` ID. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {string} [filterSource] Source ID to filter on. * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. * @param {string} [filterParent] Parent ID to filter on. Sending null will return items without a parent. @@ -30262,6 +30345,7 @@ export const SceneItemsApiAxiosParamCreator = function ( id: string, pageCursor?: string, pageSize?: number, + filterName?: FilterExpressionOrLiteral, filterSource?: string, filterSuppliedId?: string, filterParent?: string, @@ -30308,6 +30392,10 @@ export const SceneItemsApiAxiosParamCreator = function ( localVarQueryParameter['page[size]'] = pageSize; } + if (filterName !== undefined) { + localVarQueryParameter['filter[name]'] = filterName; + } + if (filterSource !== undefined) { localVarQueryParameter['filter[source]'] = filterSource; } @@ -30425,7 +30513,7 @@ export const SceneItemsApiFp = function (configuration?: Configuration) { SceneItemsApiAxiosParamCreator(configuration); return { /** - * Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`. Provide an existing `scene` using `relationship.source` to clone it. Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. + * Create a `scene-item` for a `scene`. Provide the source via a `part-revision`, `geometry-set`, `scene`, or `scene-item` UUID using `relationships.source`, or by supplied part-revision IDs using `attributes.source`. Provide an existing `scene` using `relationships.source` to clone it. Provide an existing `scene-item` using `relationships.source` to copy it. The source `scene-item` may belong to a different `scene`. Provide the hierarchical parent either via `scene-item` UUID using `relationships.parent` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. * @param {string} id The `scene` ID. * @param {CreateSceneItemRequest} createSceneItemRequest * @param {*} [options] Override http request option. @@ -30546,6 +30634,7 @@ export const SceneItemsApiFp = function (configuration?: Configuration) { * @param {string} id The `scene` ID. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {string} [filterSource] Source ID to filter on. * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. * @param {string} [filterParent] Parent ID to filter on. Sending null will return items without a parent. @@ -30559,6 +30648,7 @@ export const SceneItemsApiFp = function (configuration?: Configuration) { id: string, pageCursor?: string, pageSize?: number, + filterName?: FilterExpressionOrLiteral, filterSource?: string, filterSuppliedId?: string, filterParent?: string, @@ -30573,6 +30663,7 @@ export const SceneItemsApiFp = function (configuration?: Configuration) { id, pageCursor, pageSize, + filterName, filterSource, filterSuppliedId, filterParent, @@ -30629,7 +30720,7 @@ export const SceneItemsApiFactory = function ( const localVarFp = SceneItemsApiFp(configuration); return { /** - * Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`. Provide an existing `scene` using `relationship.source` to clone it. Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. + * Create a `scene-item` for a `scene`. Provide the source via a `part-revision`, `geometry-set`, `scene`, or `scene-item` UUID using `relationships.source`, or by supplied part-revision IDs using `attributes.source`. Provide an existing `scene` using `relationships.source` to clone it. Provide an existing `scene-item` using `relationships.source` to copy it. The source `scene-item` may belong to a different `scene`. Provide the hierarchical parent either via `scene-item` UUID using `relationships.parent` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. * @param {string} id The `scene` ID. * @param {CreateSceneItemRequest} createSceneItemRequest * @param {*} [options] Override http request option. @@ -30701,6 +30792,7 @@ export const SceneItemsApiFactory = function ( * @param {string} id The `scene` ID. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. + * @param {FilterExpressionOrLiteral} [filterName] Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. * @param {string} [filterSource] Source ID to filter on. * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on. * @param {string} [filterParent] Parent ID to filter on. Sending null will return items without a parent. @@ -30714,6 +30806,7 @@ export const SceneItemsApiFactory = function ( id: string, pageCursor?: string, pageSize?: number, + filterName?: FilterExpressionOrLiteral, filterSource?: string, filterSuppliedId?: string, filterParent?: string, @@ -30727,6 +30820,7 @@ export const SceneItemsApiFactory = function ( id, pageCursor, pageSize, + filterName, filterSource, filterSuppliedId, filterParent, @@ -30867,6 +30961,13 @@ export interface SceneItemsApiGetSceneItemsRequest { */ readonly pageSize?: number; + /** + * Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match. + * @type {FilterExpressionOrLiteral} + * @memberof SceneItemsApiGetSceneItems + */ + readonly filterName?: FilterExpressionOrLiteral; + /** * Source ID to filter on. * @type {string} @@ -30939,7 +31040,7 @@ export interface SceneItemsApiUpdateSceneItemRequest { */ export class SceneItemsApi extends BaseAPI { /** - * Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`. Provide an existing `scene` using `relationship.source` to clone it. Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. + * Create a `scene-item` for a `scene`. Provide the source via a `part-revision`, `geometry-set`, `scene`, or `scene-item` UUID using `relationships.source`, or by supplied part-revision IDs using `attributes.source`. Provide an existing `scene` using `relationships.source` to clone it. Provide an existing `scene-item` using `relationships.source` to copy it. The source `scene-item` may belong to a different `scene`. Provide the hierarchical parent either via `scene-item` UUID using `relationships.parent` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. * @param {SceneItemsApiCreateSceneItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -31042,6 +31143,7 @@ export class SceneItemsApi extends BaseAPI { requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, + requestParameters.filterName, requestParameters.filterSource, requestParameters.filterSuppliedId, requestParameters.filterParent, @@ -31151,7 +31253,7 @@ export const SceneSynchronizationsApiAxiosParamCreator = function ( }; }, /** - * Get a `queued-scene-sync-job`. + * Get a `queued-scene-sync-job`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `scene-sync`. * @param {string} id The `queued-scene-sync` ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -31367,7 +31469,7 @@ export const SceneSynchronizationsApiFp = function ( ); }, /** - * Get a `queued-scene-sync-job`. + * Get a `queued-scene-sync-job`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `scene-sync`. * @param {string} id The `queued-scene-sync` ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -31477,7 +31579,7 @@ export const SceneSynchronizationsApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * Get a `queued-scene-sync-job`. + * Get a `queued-scene-sync-job`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `scene-sync`. * @param {string} id The `queued-scene-sync` ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -31639,7 +31741,7 @@ export class SceneSynchronizationsApi extends BaseAPI { } /** - * Get a `queued-scene-sync-job`. + * Get a `queued-scene-sync-job`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `scene-sync`. * @param {SceneSynchronizationsApiGetQueuedSceneSyncRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -35715,11 +35817,15 @@ export const ThreadsApiAxiosParamCreator = function ( /** * Get a `thread`s `user`s. * @param {string} id The `thread` ID. + * @param {string} [pageCursor] The cursor for the next page of items. + * @param {number} [pageSize] The number of items to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getThreadParticipants: async ( id: string, + pageCursor?: string, + pageSize?: number, options: AxiosRequestConfig = {} ): Promise => { // verify required parameter 'id' is not null or undefined @@ -35752,6 +35858,14 @@ export const ThreadsApiAxiosParamCreator = function ( configuration ); + if (pageCursor !== undefined) { + localVarQueryParameter['page[cursor]'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['page[size]'] = pageSize; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions?.headers ?? {}; localVarRequestOptions.headers = { @@ -36017,17 +36131,26 @@ export const ThreadsApiFp = function (configuration?: Configuration) { /** * Get a `thread`s `user`s. * @param {string} id The `thread` ID. + * @param {string} [pageCursor] The cursor for the next page of items. + * @param {number} [pageSize] The number of items to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getThreadParticipants( id: string, + pageCursor?: string, + pageSize?: number, options?: AxiosRequestConfig ): Promise< (axios?: AxiosInstance, basePath?: string) => AxiosPromise > { const localVarAxiosArgs = - await localVarAxiosParamCreator.getThreadParticipants(id, options); + await localVarAxiosParamCreator.getThreadParticipants( + id, + pageCursor, + pageSize, + options + ); return createRequestFunction( localVarAxiosArgs, globalAxios, @@ -36164,12 +36287,19 @@ export const ThreadsApiFactory = function ( /** * Get a `thread`s `user`s. * @param {string} id The `thread` ID. + * @param {string} [pageCursor] The cursor for the next page of items. + * @param {number} [pageSize] The number of items to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getThreadParticipants(id: string, options?: any): AxiosPromise { + getThreadParticipants( + id: string, + pageCursor?: string, + pageSize?: number, + options?: any + ): AxiosPromise { return localVarFp - .getThreadParticipants(id, options) + .getThreadParticipants(id, pageCursor, pageSize, options) .then((request) => request(axios, basePath)); }, /** @@ -36301,6 +36431,20 @@ export interface ThreadsApiGetThreadParticipantsRequest { * @memberof ThreadsApiGetThreadParticipants */ readonly id: string; + + /** + * The cursor for the next page of items. + * @type {string} + * @memberof ThreadsApiGetThreadParticipants + */ + readonly pageCursor?: string; + + /** + * The number of items to return. + * @type {number} + * @memberof ThreadsApiGetThreadParticipants + */ + readonly pageSize?: number; } /** @@ -36456,7 +36600,12 @@ export class ThreadsApi extends BaseAPI { options?: AxiosRequestConfig ) { return ThreadsApiFp(this.configuration) - .getThreadParticipants(requestParameters.id, options) + .getThreadParticipants( + requestParameters.id, + requestParameters.pageCursor, + requestParameters.pageSize, + options + ) .then((request) => request(this.axios, this.basePath)); } @@ -36812,7 +36961,7 @@ export const TranslationInspectionsApiAxiosParamCreator = function ( }; }, /** - * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s. + * This has been deprecated and replaced by **queued-translation-jobs**. This endpoint always redirects (301) to `queued-translation-jobs`, preserving the pagination and filter query parameters. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [filterStatus] Status to filter on. @@ -37084,7 +37233,7 @@ export const TranslationInspectionsApiFp = function ( ); }, /** - * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s. + * This has been deprecated and replaced by **queued-translation-jobs**. This endpoint always redirects (301) to `queued-translation-jobs`, preserving the pagination and filter query parameters. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [filterStatus] Status to filter on. @@ -37098,7 +37247,7 @@ export const TranslationInspectionsApiFp = function ( filterStatus?: string, options?: AxiosRequestConfig ): Promise< - (axios?: AxiosInstance, basePath?: string) => AxiosPromise + (axios?: AxiosInstance, basePath?: string) => AxiosPromise > { const localVarAxiosArgs = await localVarAxiosParamCreator.getQueuedTranslations( @@ -37242,7 +37391,7 @@ export const TranslationInspectionsApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s. + * This has been deprecated and replaced by **queued-translation-jobs**. This endpoint always redirects (301) to `queued-translation-jobs`, preserving the pagination and filter query parameters. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [filterStatus] Status to filter on. @@ -37255,7 +37404,7 @@ export const TranslationInspectionsApiFactory = function ( pageSize?: number, filterStatus?: string, options?: any - ): AxiosPromise { + ): AxiosPromise { return localVarFp .getQueuedTranslations(pageCursor, pageSize, filterStatus, options) .then((request) => request(axios, basePath)); @@ -37516,7 +37665,7 @@ export class TranslationInspectionsApi extends BaseAPI { } /** - * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s. + * This has been deprecated and replaced by **queued-translation-jobs**. This endpoint always redirects (301) to `queued-translation-jobs`, preserving the pagination and filter query parameters. * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated @@ -37811,7 +37960,7 @@ export const UserGroupsApiFp = function (configuration?: Configuration) { id: string, options?: AxiosRequestConfig ): Promise< - (axios?: AxiosInstance, basePath?: string) => AxiosPromise + (axios?: AxiosInstance, basePath?: string) => AxiosPromise > { const localVarAxiosArgs = await localVarAxiosParamCreator.getUserGroup( id, @@ -37874,7 +38023,7 @@ export const UserGroupsApiFactory = function ( * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUserGroup(id: string, options?: any): AxiosPromise { + getUserGroup(id: string, options?: any): AxiosPromise { return localVarFp .getUserGroup(id, options) .then((request) => request(axios, basePath)); diff --git a/spec.yml b/spec.yml index b3eb5b6..9278876 100644 --- a/spec.yml +++ b/spec.yml @@ -45,6 +45,7 @@ tags: - name: oauth2 - name: part-renditions - name: part-revisions + - name: part-revision-topology-exports - name: part-revision-instances - name: parts - name: permission-grants @@ -907,6 +908,9 @@ paths: schema: $ref: '#/components/schemas/PresignedUrl' description: Created + headers: + location: + $ref: '#/components/headers/Location' '401': content: application/vnd.api+json: @@ -972,6 +976,9 @@ paths: schema: $ref: '#/components/schemas/PresignedUrl' description: Created + headers: + location: + $ref: '#/components/headers/Location' '401': content: application/vnd.api+json: @@ -1842,6 +1849,27 @@ paths: schema: $ref: '#/components/schemas/Uuid' style: simple + - description: The cursor for the next page of items. + explode: true + in: query + name: page[cursor] + required: false + schema: + example: cHJkMDVFR2RLag== + type: string + style: form + - description: The number of items to return. + explode: true + in: query + name: page[size] + required: false + schema: + example: 10 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: '200': content: @@ -2042,13 +2070,16 @@ paths: example: -age,name type: string style: form - - description: A filter expression for the `name` to filter on. + - description: + Filters by name. `filter[name]=value` and `filter[name][eq]=value` + perform exact matches, while `filter[name][contains]=value` performs a partial + substring match. explode: true in: query name: filter[name] required: false schema: - $ref: '#/components/schemas/FilterExpression' + $ref: '#/components/schemas/FilterExpressionOrLiteral' style: form - description: A filter expression for the `fileId` to filter on. explode: true @@ -2075,7 +2106,9 @@ paths: type: string - $ref: '#/components/schemas/FilterExpression' style: form - - description: A filter expression for the `createdAt` to filter on. + - description: + A filter expression for a resource's creation time. Use RFC 3339 + timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. explode: true in: query name: filter[createdAt] @@ -2633,7 +2666,9 @@ paths: - files /file-collections: get: - description: List `file-collection`s by supplied ID. + description: + List `file-collection`s with optional partial name, supplied ID, + and creation time filters, sorted by name or creation time. operationId: listFileCollections parameters: - description: The cursor for the next page of items. @@ -2657,14 +2692,50 @@ paths: minimum: 1 type: integer style: form - - description: Comma-separated list of supplied IDs to filter on. + - description: + A filter expression for the `file-collection` name. The canonical + form is a filter expression such as `filter[name][contains]=...`. + explode: true + in: query + name: filter[name] + required: false + schema: + $ref: '#/components/schemas/FilterExpression' + style: form + - description: + A filter expression for the `file-collection` supplied ID. The + canonical form is a filter expression such as `filter[suppliedId][contains]=...`. explode: true in: query name: filter[suppliedId] required: false schema: - example: some-id-1,some-id-2 - maxLength: 1024 + $ref: '#/components/schemas/FilterExpression' + style: form + - description: + A filter expression for a resource's creation time. Use RFC 3339 + timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. + explode: true + in: query + name: filter[createdAt] + required: false + schema: + $ref: '#/components/schemas/FilterExpression' + style: form + - description: + A sort to apply to file collections. A "minus" prefix before + the field name specifies descending sort order. + explode: true + in: query + name: sort + required: false + schema: + enum: + - name + - -name + - created + - -created + example: -created type: string style: form responses: @@ -2674,6 +2745,17 @@ paths: schema: $ref: '#/components/schemas/FileCollectionList' description: OK + '400': + content: + application/vnd.api+json: + example: + errors: + - status: '400' + code: BadRequest + title: Invalid, missing, or out-of-range request parameters. + schema: + $ref: '#/components/schemas/Failure' + description: Bad Request '401': content: application/vnd.api+json: @@ -3078,7 +3160,10 @@ paths: application/vnd.api+json: schema: $ref: '#/components/schemas/QueuedJob' - description: OK + description: Created + headers: + location: + $ref: '#/components/headers/Location' '401': content: application/vnd.api+json: @@ -5073,6 +5158,17 @@ paths: minimum: 1 type: integer style: form + - description: + Filters by name. `filter[name]=value` and `filter[name][eq]=value` + perform exact matches, while `filter[name][contains]=value` performs a partial + substring match. + explode: true + in: query + name: filter[name] + required: false + schema: + $ref: '#/components/schemas/FilterExpressionOrLiteral' + style: form - description: Comma-separated list of supplied IDs to filter on. explode: true in: query @@ -6218,14 +6314,82 @@ paths: - OAuth2: [] tags: - property-key-policies - /property-key-policy-entries: + /property-key-policies/{id}/keys: + delete: + description: Delete property keys from a `property-key-policy`. + operationId: deletePropertyKeyPolicyKeys + parameters: + - description: The `property-key-policy` ID. + explode: false + in: path + name: id + required: true + schema: + $ref: '#/components/schemas/Uuid' + style: simple + - description: Comma-separated list of IDs to filter on. + explode: true + in: query + name: filter[id] + required: false + schema: + example: some-id-1,some-id-2 + type: string + style: form + responses: + '204': + description: No Content + '401': + content: + application/vnd.api+json: + example: + errors: + - status: '401' + code: Unauthorized + title: Invalid or missing credentials. + schema: + $ref: '#/components/schemas/Failure' + description: Unauthorized + '404': + content: + application/vnd.api+json: + example: + errors: + - status: '404' + code: NotFound + title: The requested resource was not found. + schema: + $ref: '#/components/schemas/Failure' + description: Not Found + '415': + content: + application/vnd.api+json: + example: + errors: + - status: '415' + code: UnsupportedMediaType + title: + The provided media type is not supported. Update the Content-Type + header to application/vnd.api+json and try again. + schema: + $ref: '#/components/schemas/Failure' + description: Unsupported Media Type + security: + - OAuth2: [] + tags: + - property-key-policies get: - description: - Get `property-key-policy-entry` resources for a `property-key-policy`. - Accepts `filter[propertyKeyPolicy.id]` and `filter[propertyKeyPolicy.suppliedId]`. - When both are provided, `filter[propertyKeyPolicy.id]` takes precedence. - operationId: listPropertyKeyPolicyEntries + description: Get property keys for a `property-key-policy`. + operationId: listPropertyKeyPolicyKeys parameters: + - description: The `property-key-policy` ID. + explode: false + in: path + name: id + required: true + schema: + $ref: '#/components/schemas/Uuid' + style: simple - description: The cursor for the next page of items. explode: true in: query @@ -6247,28 +6411,12 @@ paths: minimum: 1 type: integer style: form - - description: The `property-key-policy` ID to filter on. - explode: true - in: query - name: filter[propertyKeyPolicy.id] - required: false - schema: - $ref: '#/components/schemas/Uuid' - style: form - - description: The `property-key-policy` supplied ID to filter on. - explode: true - in: query - name: filter[propertyKeyPolicy.suppliedId] - required: false - schema: - $ref: '#/components/schemas/NonEmptyString' - style: form responses: '200': content: application/vnd.api+json: schema: - $ref: '#/components/schemas/PropertyKeyPolicyEntryList' + $ref: '#/components/schemas/PropertyKeyList' description: OK '400': content: @@ -6281,35 +6429,6 @@ paths: schema: $ref: '#/components/schemas/Failure' description: Bad Request - security: - - OAuth2: [] - tags: - - property-key-policies - /property-key-policies/{id}/entries: - delete: - description: Delete entries from a `property-key-policy`. - operationId: deletePropertyKeyPolicyEntries - parameters: - - description: The `property-key-policy` ID. - explode: false - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/Uuid' - style: simple - - description: Comma-separated list of IDs to filter on. - explode: true - in: query - name: filter[id] - required: false - schema: - example: some-id-1,some-id-2 - type: string - style: form - responses: - '204': - description: No Content '401': content: application/vnd.api+json: @@ -6350,8 +6469,8 @@ paths: tags: - property-key-policies post: - description: Upsert entries for a `property-key-policy`. - operationId: upsertPropertyKeyPolicyEntries + description: Upsert property keys for a `property-key-policy`. + operationId: upsertPropertyKeyPolicyKeys parameters: - description: The `property-key-policy` ID. explode: false @@ -6365,7 +6484,7 @@ paths: content: application/vnd.api+json: schema: - $ref: '#/components/schemas/UpsertPropertyKeyPolicyEntriesRequest' + $ref: '#/components/schemas/UpsertPropertyKeyPolicyKeysRequest' required: true responses: '204': @@ -6492,6 +6611,27 @@ paths: schema: $ref: '#/components/schemas/Uuid' style: simple + - description: The cursor for the next page of items. + explode: true + in: query + name: page[cursor] + required: false + schema: + example: cHJkMDVFR2RLag== + type: string + style: form + - description: The number of items to return. + explode: true + in: query + name: page[size] + required: false + schema: + example: 10 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: '200': content: @@ -7204,6 +7344,17 @@ paths: minimum: 1 type: integer style: form + - description: + Filters by name. `filter[name]=value` and `filter[name][eq]=value` + perform exact matches, while `filter[name][contains]=value` performs a partial + substring match. + explode: true + in: query + name: filter[name] + required: false + schema: + $ref: '#/components/schemas/FilterExpressionOrLiteral' + style: form - allowEmptyValue: true description: Source ID to filter on. explode: true @@ -7322,9 +7473,10 @@ paths: - scene-items post: description: |- - Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`. - Provide an existing `scene` using `relationship.source` to clone it. - Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. + Create a `scene-item` for a `scene`. Provide the source via a `part-revision`, `geometry-set`, `scene`, or `scene-item` UUID using `relationships.source`, or by supplied part-revision IDs using `attributes.source`. + Provide an existing `scene` using `relationships.source` to clone it. + Provide an existing `scene-item` using `relationships.source` to copy it. The source `scene-item` may belong to a different `scene`. + Provide the hierarchical parent either via `scene-item` UUID using `relationships.parent` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide. operationId: createSceneItem parameters: @@ -9412,7 +9564,9 @@ paths: - scene-synchronizations /queued-scene-syncs/{id}: get: - description: Get a `queued-scene-sync-job`. + description: + Get a `queued-scene-sync-job`. The response is either the status + if `running` or `error` or, upon completion, redirects to the created `scene-sync`. operationId: getQueuedSceneSync parameters: - description: The `queued-scene-sync` ID. @@ -9430,6 +9584,8 @@ paths: schema: $ref: '#/components/schemas/QueuedJob' description: OK + '301': + description: Moved Permanently '401': content: application/vnd.api+json: @@ -10055,8 +10211,6 @@ paths: schema: $ref: '#/components/schemas/QueuedTranslationJob' description: OK - '301': - description: Moved Permanently '401': content: application/vnd.api+json: @@ -10100,8 +10254,9 @@ paths: get: deprecated: true description: - This has been deprecated and replaced by **queued-translation-jobs** - - Get `queued-translation`s. + This has been deprecated and replaced by **queued-translation-jobs**. + This endpoint always redirects (301) to `queued-translation-jobs`, preserving + the pagination and filter query parameters. operationId: getQueuedTranslations parameters: - description: The cursor for the next page of items. @@ -10136,12 +10291,6 @@ paths: type: string style: form responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/QueuedJobList' - description: OK '301': description: Moved Permanently '401': @@ -10882,8 +11031,12 @@ paths: $ref: '#/components/schemas/Uuid' style: simple responses: - '204': - description: No Content + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/UserGroup' + description: OK '401': content: application/vnd.api+json: @@ -12288,24 +12441,6 @@ components: maxLength: 36 type: string style: form - PropertyKeyPolicyEntryPropertyKeyPolicyIdFilter: - description: The `property-key-policy` ID to filter on. - explode: true - in: query - name: filter[propertyKeyPolicy.id] - required: false - schema: - $ref: '#/components/schemas/Uuid' - style: form - PropertyKeyPolicyEntryPropertyKeyPolicySuppliedIdFilter: - description: The `property-key-policy` supplied ID to filter on. - explode: true - in: query - name: filter[propertyKeyPolicy.suppliedId] - required: false - schema: - $ref: '#/components/schemas/NonEmptyString' - style: form SuppliedIdFilter: description: Comma-separated list of supplied IDs to filter on. explode: true @@ -12318,13 +12453,16 @@ components: type: string style: form NameFilterExpression: - description: A filter expression for the `name` to filter on. + description: + Filters by name. `filter[name]=value` and `filter[name][eq]=value` + perform exact matches, while `filter[name][contains]=value` performs a partial + substring match. explode: true in: query name: filter[name] required: false schema: - $ref: '#/components/schemas/FilterExpression' + $ref: '#/components/schemas/FilterExpressionOrLiteral' style: form SceneNameFilterExpression: description: @@ -12347,6 +12485,28 @@ components: schema: $ref: '#/components/schemas/FilterExpression' style: form + FileCollectionNameFilterExpression: + description: + A filter expression for the `file-collection` name. The canonical + form is a filter expression such as `filter[name][contains]=...`. + explode: true + in: query + name: filter[name] + required: false + schema: + $ref: '#/components/schemas/FilterExpression' + style: form + FileCollectionSuppliedIdFilterExpression: + description: + A filter expression for the `file-collection` supplied ID. The + canonical form is a filter expression such as `filter[suppliedId][contains]=...`. + explode: true + in: query + name: filter[suppliedId] + required: false + schema: + $ref: '#/components/schemas/FilterExpression' + style: form SceneSuppliedIdFilterExpression: description: A filter for the `suppliedId`. The canonical form is a filter expression @@ -12377,7 +12537,9 @@ components: - $ref: '#/components/schemas/FilterExpression' style: form CreatedAtFilterExpression: - description: A filter expression for the `createdAt` to filter on. + description: + A filter expression for a resource's creation time. Use RFC 3339 + timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`. explode: true in: query name: filter[createdAt] @@ -12434,6 +12596,23 @@ components: example: -age,name type: string style: form + FileCollectionsSort: + description: + A sort to apply to file collections. A "minus" prefix before the + field name specifies descending sort order. + explode: true + in: query + name: sort + required: false + schema: + enum: + - name + - -name + - created + - -created + example: -created + type: string + style: form ReplyId: description: The `thread` ID. explode: false @@ -12696,7 +12875,7 @@ components: additionalProperties: false properties: data: - $ref: '#/components/schemas/CreateAccountRequest_data' + $ref: '#/components/schemas/AdminCreateApplicationRequest_data' required: - data type: object @@ -12936,9 +13115,16 @@ components: - data - links type: object + FilterExpressionOrLiteral: + oneOf: + - $ref: '#/components/schemas/FilterLiteral' + - $ref: '#/components/schemas/FilterExpression' FilterExpression: additionalProperties: false - description: Describes how an attribute should be filtered. + description: | + Describes how an attribute should be filtered. Logical operators accept + literals or nested filter expressions. Repeated `and` and `or` parameters + combine their values with the respective logical operator. properties: eq: description: A value of a filter. @@ -12961,6 +13147,12 @@ components: contains: description: A value of a filter. type: string + and: + $ref: '#/components/schemas/FilterExpressionOrLiteral' + or: + $ref: '#/components/schemas/FilterExpressionOrLiteral' + not: + $ref: '#/components/schemas/FilterExpressionOrLiteral' type: object FileList: additionalProperties: false @@ -13582,17 +13774,12 @@ components: required: - data type: object - NonEmptyString: - example: some-string - maxLength: 1024 - minLength: 1 - type: string - PropertyKeyPolicyEntryList: + PropertyKeyList: additionalProperties: false properties: data: items: - $ref: '#/components/schemas/PropertyKeyPolicyEntryData' + $ref: '#/components/schemas/PropertyKey' type: array links: additionalProperties: @@ -13602,12 +13789,12 @@ components: - data - links type: object - UpsertPropertyKeyPolicyEntriesRequest: + UpsertPropertyKeyPolicyKeysRequest: additionalProperties: false properties: data: items: - $ref: '#/components/schemas/PropertyKey' + $ref: '#/components/schemas/PropertyEntryKey' type: array required: - data @@ -14426,6 +14613,11 @@ components: - position - up type: object + NonEmptyString: + example: some-string + maxLength: 1024 + minLength: 1 + type: string DateTime: example: 2020-01-01T12:00:00Z format: date-time @@ -15532,13 +15724,13 @@ components: required: - type type: object - PropertyKeyPolicyEntryData: + PropertyKey: additionalProperties: false properties: type: enum: - - property-key-policy-entry - example: property-key-policy-entry + - property-key + example: property-key type: string id: example: some-string @@ -15546,9 +15738,7 @@ components: minLength: 1 type: string attributes: - $ref: '#/components/schemas/PropertyKeyPolicyEntryDataAttributes' - relationships: - $ref: '#/components/schemas/PropertyKeyPolicyEntryDataRelationships' + $ref: '#/components/schemas/PropertyKeyDataAttributes' links: additionalProperties: $ref: '#/components/schemas/Link' @@ -15556,10 +15746,9 @@ components: required: - attributes - id - - relationships - type type: object - PropertyKey: + PropertyEntryKey: additionalProperties: false properties: name: @@ -15851,6 +16040,10 @@ components: value: $ref: '#/components/schemas/ColorMaterial' type: object + NullableObject: + maxProperties: 0 + nullable: true + type: object GeometrySetRelationship: additionalProperties: false description: Relationship to a `geometry-set`. @@ -15860,10 +16053,6 @@ components: required: - data type: object - NullableObject: - maxProperties: 0 - nullable: true - type: object CreateSceneItemRequestData: additionalProperties: false properties: @@ -17022,21 +17211,16 @@ components: mode: $ref: '#/components/schemas/PropertyKeyPolicyMode' type: object - PropertyKeyPolicyEntryDataAttributes: - additionalProperties: false - properties: - key: - $ref: '#/components/schemas/PropertyKey' - required: - - key - type: object - PropertyKeyPolicyEntryDataRelationships: + PropertyKeyDataAttributes: additionalProperties: false properties: - propertyKeyPolicy: - $ref: '#/components/schemas/PropertyKeyPolicyRelationship' + name: + example: some-string + maxLength: 1024 + minLength: 1 + type: string required: - - propertyKeyPolicy + - name type: object QueryById: additionalProperties: false @@ -17828,15 +18012,6 @@ components: - allowlist - denylist type: string - PropertyKeyPolicyRelationship: - additionalProperties: false - description: Relationship to a `property-key-policy`. - properties: - data: - $ref: '#/components/schemas/PropertyKeyPolicyRelationship_data' - required: - - data - type: object QueryBySceneItemId: additionalProperties: false properties: @@ -18485,6 +18660,10 @@ components: maxLength: 1024 minLength: 1 type: string + scopes: + items: + $ref: '#/components/schemas/NonEmptyString' + type: array redirect_uris: items: $ref: '#/components/schemas/NonEmptyString' @@ -19545,6 +19724,14 @@ components: type: object UpdateSceneItemRequest_data_relationships: properties: + parent: + anyOf: + - $ref: '#/components/schemas/SceneItemRelationship' + - $ref: '#/components/schemas/NullableObject' + description: + Relationship to the scene item's new parent. Set this relationship + to `null` to move the item to the scene root. + nullable: true source: anyOf: - $ref: '#/components/schemas/GeometrySetRelationship' @@ -20694,6 +20881,10 @@ components: - $ref: '#/components/schemas/PartRevisionRelationship' - $ref: '#/components/schemas/SceneRelationship' - $ref: '#/components/schemas/PartRenditionRelationship' + - $ref: '#/components/schemas/SceneItemRelationship' + description: + Relationship to a `geometry-set`, `part-revision`, `part-rendition`, + `scene`, or `scene-item`. parent: $ref: '#/components/schemas/SceneItemRelationship' partRendition: @@ -20916,7 +21107,7 @@ components: - $ref: '#/components/schemas/PropertyLongType' - $ref: '#/components/schemas/PropertyDateType' key: - $ref: '#/components/schemas/PropertyKey' + $ref: '#/components/schemas/PropertyEntryKey' required: - key - value @@ -21115,9 +21306,10 @@ components: - $ref: '#/components/schemas/PartRevisionRelationship' - $ref: '#/components/schemas/SceneRelationship' - $ref: '#/components/schemas/PartRenditionRelationship' + - $ref: '#/components/schemas/SceneItemRelationship' description: Relationship to a `geometry-set`, `part-revision`, `part-rendition`, - or `scene`. + `scene`, or `scene-item`. referenceTree: $ref: '#/components/schemas/SceneItemRelationship' type: object @@ -21788,24 +21980,6 @@ components: required: - data type: object - PropertyKeyPolicyRelationship_data: - properties: - type: - description: Resource object type. - enum: - - property-key-policy - example: property-key-policy - type: string - id: - description: ID of the resource. - example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 - format: uuid - maxLength: 36 - type: string - required: - - id - - type - type: object securitySchemes: OAuth2: flows: From f9bffa854765aa4a1178ead1e3fefeee5a02c0e8 Mon Sep 17 00:00:00 2001 From: Jeff Murray Date: Mon, 21 Sep 2026 10:42:58 -0500 Subject: [PATCH 2/2] v0.45.0 --- client/version.ts | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/client/version.ts b/client/version.ts index a89e3c3..fbc6b57 100644 --- a/client/version.ts +++ b/client/version.ts @@ -1 +1 @@ -export const version = '0.44.0'; +export const version = '0.45.0'; diff --git a/package.json b/package.json index 32866cd..7a23272 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vertexvis/api-client-node", - "version": "0.44.0", + "version": "0.45.0", "description": "The Vertex REST API client for Node.js.", "license": "MIT", "author": "Vertex Developers (https://developer.vertex3d.com)",