From 99299cc18c77a40ba2549c01b64f2494306fe72a Mon Sep 17 00:00:00 2001 From: Jeff Murray Date: Wed, 15 Apr 2026 16:18:57 -0500 Subject: [PATCH 1/2] Update to latest spec --- api.ts | 578 ++++++++++++++++++++++++------------------ spec.yml | 754 ++++++++++++++++++++++++++++++------------------------- 2 files changed, 737 insertions(+), 595 deletions(-) diff --git a/api.ts b/api.ts index d217b87..5c8721c 100644 --- a/api.ts +++ b/api.ts @@ -848,95 +848,6 @@ export const CameraFitTypeEnum = { export type CameraFitTypeEnum = (typeof CameraFitTypeEnum)[keyof typeof CameraFitTypeEnum]; -/** - * - * @export - * @interface Canvas - */ -export interface Canvas { - /** - * - * @type {CanvasData} - * @memberof Canvas - */ - data: CanvasData; - /** - * - * @type {{ [key: string]: Link; }} - * @memberof Canvas - */ - links?: { [key: string]: Link }; -} -/** - * - * @export - * @interface CanvasData - */ -export interface CanvasData { - /** - * - * @type {string} - * @memberof CanvasData - */ - type: CanvasDataTypeEnum; - /** - * ID of the resource. - * @type {string} - * @memberof CanvasData - */ - id: string; - /** - * - * @type {CanvasDataAttributes} - * @memberof CanvasData - */ - attributes: CanvasDataAttributes; - /** - * - * @type {{ [key: string]: Link; }} - * @memberof CanvasData - */ - links?: { [key: string]: Link }; -} - -export const CanvasDataTypeEnum = { - Canvas: 'canvas', -} as const; - -export type CanvasDataTypeEnum = - (typeof CanvasDataTypeEnum)[keyof typeof CanvasDataTypeEnum]; - -/** - * - * @export - * @interface CanvasDataAttributes - */ -export interface CanvasDataAttributes { - /** - * - * @type {CanvasDocument} - * @memberof CanvasDataAttributes - */ - document: CanvasDocument; - /** - * - * @type {string} - * @memberof CanvasDataAttributes - */ - createdAt: string; - /** - * - * @type {string} - * @memberof CanvasDataAttributes - */ - modifiedAt: string; - /** - * - * @type {string} - * @memberof CanvasDataAttributes - */ - suppliedId?: string; -} /** * * @export @@ -4017,6 +3928,33 @@ export interface Document { */ links?: { [key: string]: Link }; } +/** + * A resolved document annotation for a thread or reply reference. + * @export + * @interface DocumentAnnotation + */ +export interface DocumentAnnotation { + /** + * + * @type {string} + * @memberof DocumentAnnotation + */ + type: DocumentAnnotationTypeEnum; + /** + * The content of the document annotation. + * @type {PdfMarkup} + * @memberof DocumentAnnotation + */ + content: PdfMarkup; +} + +export const DocumentAnnotationTypeEnum = { + DocumentAnnotation: 'document-annotation', +} as const; + +export type DocumentAnnotationTypeEnum = + (typeof DocumentAnnotationTypeEnum)[keyof typeof DocumentAnnotationTypeEnum]; + /** * * @export @@ -4089,6 +4027,25 @@ export const DocumentDataAttributesDocumentTypeEnum = { export type DocumentDataAttributesDocumentTypeEnum = (typeof DocumentDataAttributesDocumentTypeEnum)[keyof typeof DocumentDataAttributesDocumentTypeEnum]; +/** + * + * @export + * @interface DocumentList + */ +export interface DocumentList { + /** + * + * @type {Array} + * @memberof DocumentList + */ + data: Array; + /** + * + * @type {{ [key: string]: Link; }} + * @memberof DocumentList + */ + links: { [key: string]: Link }; +} /** * A reference to a document for a thread or reply. * @export @@ -4113,6 +4070,12 @@ export interface DocumentReference { * @memberof DocumentReference */ documentAnnotationId: string; + /** + * + * @type {DocumentAnnotation} + * @memberof DocumentReference + */ + documentAnnotation?: DocumentAnnotation; } export const DocumentReferenceTypeEnum = { @@ -15148,166 +15111,6 @@ export class BatchesApi extends BaseAPI { } } -/** - * CanvasesApi - axios parameter creator - * @export - */ -export const CanvasesApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * Get a `canvas` by ID. - * @param {string} id The `canvas` ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCanvas: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCanvas', 'id', id); - const localVarPath = `/canvases/{id}`.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; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: 'GET', - ...baseOptions, - ...options, - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication OAuth2 required - // oauth required - await setOAuthToObject( - localVarHeaderParameter, - 'OAuth2', - [], - configuration - ); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions?.headers ?? {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers, - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - }; -}; - -/** - * CanvasesApi - functional programming interface - * @export - */ -export const CanvasesApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = CanvasesApiAxiosParamCreator(configuration); - return { - /** - * Get a `canvas` by ID. - * @param {string} id The `canvas` ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getCanvas( - id: string, - options?: AxiosRequestConfig - ): Promise< - (axios?: AxiosInstance, basePath?: string) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCanvas( - id, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - }; -}; - -/** - * CanvasesApi - factory interface - * @export - */ -export const CanvasesApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = CanvasesApiFp(configuration); - return { - /** - * Get a `canvas` by ID. - * @param {string} id The `canvas` ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCanvas(id: string, options?: any): AxiosPromise { - return localVarFp - .getCanvas(id, options) - .then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getCanvas operation in CanvasesApi. - * @export - * @interface CanvasesApiGetCanvasRequest - */ -export interface CanvasesApiGetCanvasRequest { - /** - * The `canvas` ID. - * @type {string} - * @memberof CanvasesApiGetCanvas - */ - readonly id: string; -} - -/** - * CanvasesApi - object-oriented interface - * @export - * @class CanvasesApi - * @extends {BaseAPI} - */ -export class CanvasesApi extends BaseAPI { - /** - * Get a `canvas` by ID. - * @param {CanvasesApiGetCanvasRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CanvasesApi - */ - public getCanvas( - requestParameters: CanvasesApiGetCanvasRequest, - options?: AxiosRequestConfig - ) { - return CanvasesApiFp(this.configuration) - .getCanvas(requestParameters.id, options) - .then((request) => request(this.axios, this.basePath)); - } -} - /** * CollaborationContextsApi - axios parameter creator * @export @@ -16273,6 +16076,123 @@ export const DocumentsApiAxiosParamCreator = function ( configuration ); + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get a `document` by ID. **Preview:** This is a preview API and is subject to change. + * @param {string} id The `document` ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDocument: async ( + id: string, + options: AxiosRequestConfig = {} + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getDocument', 'id', id); + const localVarPath = `/documents/{id}`.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; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { + method: 'GET', + ...baseOptions, + ...options, + }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication OAuth2 required + // oauth required + await setOAuthToObject( + localVarHeaderParameter, + 'OAuth2', + [], + configuration + ); + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions?.headers ?? {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get `documents`. **Preview:** This is a preview API and is subject to change. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDocuments: async ( + pageCursor?: string, + pageSize?: number, + filterSuppliedId?: string, + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/documents`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { + method: 'GET', + ...baseOptions, + ...options, + }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication OAuth2 required + // oauth required + await setOAuthToObject( + localVarHeaderParameter, + 'OAuth2', + [], + configuration + ); + + if (pageCursor !== undefined) { + localVarQueryParameter['page[cursor]'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['page[size]'] = pageSize; + } + + if (filterSuppliedId !== undefined) { + localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions?.headers ?? {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -16312,6 +16232,58 @@ export const DocumentsApiFp = function (configuration?: Configuration) { configuration ); }, + /** + * Get a `document` by ID. **Preview:** This is a preview API and is subject to change. + * @param {string} id The `document` ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getDocument( + id: string, + options?: AxiosRequestConfig + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument( + id, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Get `documents`. **Preview:** This is a preview API and is subject to change. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getDocuments( + pageCursor?: string, + pageSize?: number, + filterSuppliedId?: string, + options?: AxiosRequestConfig + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDocuments( + pageCursor, + pageSize, + filterSuppliedId, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, }; }; @@ -16340,6 +16312,35 @@ export const DocumentsApiFactory = function ( .createDocument(createDocumentRequest, options) .then((request) => request(axios, basePath)); }, + /** + * Get a `document` by ID. **Preview:** This is a preview API and is subject to change. + * @param {string} id The `document` ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDocument(id: string, options?: any): AxiosPromise { + return localVarFp + .getDocument(id, options) + .then((request) => request(axios, basePath)); + }, + /** + * Get `documents`. **Preview:** This is a preview API and is subject to change. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDocuments( + pageCursor?: string, + pageSize?: number, + filterSuppliedId?: string, + options?: any + ): AxiosPromise { + return localVarFp + .getDocuments(pageCursor, pageSize, filterSuppliedId, options) + .then((request) => request(axios, basePath)); + }, }; }; @@ -16357,6 +16358,48 @@ export interface DocumentsApiCreateDocumentRequest { readonly createDocumentRequest: CreateDocumentRequest; } +/** + * Request parameters for getDocument operation in DocumentsApi. + * @export + * @interface DocumentsApiGetDocumentRequest + */ +export interface DocumentsApiGetDocumentRequest { + /** + * The `document` ID. + * @type {string} + * @memberof DocumentsApiGetDocument + */ + readonly id: string; +} + +/** + * Request parameters for getDocuments operation in DocumentsApi. + * @export + * @interface DocumentsApiGetDocumentsRequest + */ +export interface DocumentsApiGetDocumentsRequest { + /** + * The cursor for the next page of items. + * @type {string} + * @memberof DocumentsApiGetDocuments + */ + readonly pageCursor?: string; + + /** + * The number of items to return. + * @type {number} + * @memberof DocumentsApiGetDocuments + */ + readonly pageSize?: number; + + /** + * Comma-separated list of supplied IDs to filter on. + * @type {string} + * @memberof DocumentsApiGetDocuments + */ + readonly filterSuppliedId?: string; +} + /** * DocumentsApi - object-oriented interface * @export @@ -16379,6 +16422,43 @@ export class DocumentsApi extends BaseAPI { .createDocument(requestParameters.createDocumentRequest, options) .then((request) => request(this.axios, this.basePath)); } + + /** + * Get a `document` by ID. **Preview:** This is a preview API and is subject to change. + * @param {DocumentsApiGetDocumentRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DocumentsApi + */ + public getDocument( + requestParameters: DocumentsApiGetDocumentRequest, + options?: AxiosRequestConfig + ) { + return DocumentsApiFp(this.configuration) + .getDocument(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Get `documents`. **Preview:** This is a preview API and is subject to change. + * @param {DocumentsApiGetDocumentsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DocumentsApi + */ + public getDocuments( + requestParameters: DocumentsApiGetDocumentsRequest = {}, + options?: AxiosRequestConfig + ) { + return DocumentsApiFp(this.configuration) + .getDocuments( + requestParameters.pageCursor, + requestParameters.pageSize, + requestParameters.filterSuppliedId, + options + ) + .then((request) => request(this.axios, this.basePath)); + } } /** diff --git a/spec.yml b/spec.yml index 958a484..2725074 100644 --- a/spec.yml +++ b/spec.yml @@ -1193,65 +1193,6 @@ paths: - OAuth2: [] tags: - batches - /canvases/{id}: - get: - description: Get a `canvas` by ID. - operationId: getCanvas - parameters: - - description: The `canvas` ID. - explode: false - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/Uuid' - style: simple - responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/Canvas' - description: OK - '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: - - canvases /collaboration-contexts: get: description: List `collaboration-context`s @@ -3127,6 +3068,78 @@ paths: tags: - file-jobs /documents: + get: + description: | + Get `documents`. + **Preview:** This is a preview API and is subject to change. + operationId: getDocuments + parameters: + - 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 + - description: Comma-separated list of supplied IDs to filter on. + explode: true + in: query + name: filter[suppliedId] + required: false + schema: + example: some-id-1,some-id-2 + maxLength: 1024 + type: string + style: form + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/DocumentList' + description: OK + '401': + content: + application/vnd.api+json: + example: + errors: + - status: '401' + code: Unauthorized + title: Invalid or missing credentials. + schema: + $ref: '#/components/schemas/Failure' + description: Unauthorized + '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: + - documents post: description: | Creates a document. @@ -3187,6 +3200,67 @@ paths: - OAuth2: [] tags: - documents + /documents/{id}: + get: + description: | + Get a `document` by ID. + **Preview:** This is a preview API and is subject to change. + operationId: getDocument + parameters: + - description: The `document` ID. + explode: false + in: path + name: id + required: true + schema: + $ref: '#/components/schemas/Uuid' + style: simple + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/Document' + description: OK + '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: + - documents /geometry-sets: get: description: Get `geometry-sets`. @@ -11149,6 +11223,15 @@ components: schema: $ref: '#/components/schemas/Uuid' style: simple + DocumentId: + description: The `document` ID. + explode: false + in: path + name: id + required: true + schema: + $ref: '#/components/schemas/Uuid' + style: simple FileId: description: The `file` ID. explode: false @@ -12087,18 +12170,6 @@ components: required: - vertexvis/batch:results type: object - Canvas: - additionalProperties: false - properties: - data: - $ref: '#/components/schemas/CanvasData' - links: - additionalProperties: - $ref: '#/components/schemas/Link' - type: object - required: - - data - type: object CollaborationContextList: additionalProperties: false properties: @@ -12331,6 +12402,21 @@ components: required: - data type: object + DocumentList: + additionalProperties: false + properties: + data: + items: + $ref: '#/components/schemas/DocumentData' + type: array + links: + additionalProperties: + $ref: '#/components/schemas/Link' + type: object + required: + - data + - links + type: object CreateDocumentRequest: additionalProperties: false properties: @@ -13854,30 +13940,6 @@ components: - id - type type: object - CanvasData: - additionalProperties: false - properties: - type: - enum: - - canvas - type: string - id: - description: ID of the resource. - example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 - format: uuid - maxLength: 36 - type: string - attributes: - $ref: '#/components/schemas/CanvasData_attributes' - links: - additionalProperties: - $ref: '#/components/schemas/Link' - type: object - required: - - attributes - - id - - type - type: object CollaborationContextData: additionalProperties: false properties: @@ -15783,53 +15845,22 @@ components: required: - data type: object - CanvasDocument: + AccountRelationship: + additionalProperties: false + description: Relationship to an `account`. + properties: + data: + $ref: '#/components/schemas/AccountRelationship_data' + required: + - data + type: object + WithSceneViewId: additionalProperties: false + description: A sceneViewId to be associated as a reference. properties: type: enum: - - canvas-document-3d-v1 - - canvas-document-v1 - type: string - items: - items: - description: A canvas item. - discriminator: - mapping: - line-item-2d: '#/components/schemas/LineItem2d' - oval-item-2d: '#/components/schemas/OvalItem2d' - freeform-item-2d: '#/components/schemas/FreeformItem2d' - callout-item: '#/components/schemas/CalloutItem' - pin-item-2d: '#/components/schemas/PinItem2d' - propertyName: type - oneOf: - - $ref: '#/components/schemas/LineItem2d' - - $ref: '#/components/schemas/OvalItem2d' - - $ref: '#/components/schemas/FreeformItem2d' - - $ref: '#/components/schemas/CalloutItem' - - $ref: '#/components/schemas/PinItem2d' - maxItems: 1024 - type: array - required: - - items - - type - type: object - AccountRelationship: - additionalProperties: false - description: Relationship to an `account`. - properties: - data: - $ref: '#/components/schemas/AccountRelationship_data' - required: - - data - type: object - WithSceneViewId: - additionalProperties: false - description: A sceneViewId to be associated as a reference. - properties: - type: - enum: - - scene-view-id + - scene-view-id type: string sceneViewId: description: ID of the resource. @@ -15957,6 +15988,8 @@ components: format: uuid maxLength: 36 type: string + documentAnnotation: + $ref: '#/components/schemas/DocumentAnnotation' required: - documentAnnotationId - documentId @@ -16651,6 +16684,37 @@ components: required: - data type: object + CanvasDocument: + additionalProperties: false + properties: + type: + enum: + - canvas-document-3d-v1 + - canvas-document-v1 + type: string + items: + items: + description: A canvas item. + discriminator: + mapping: + line-item-2d: '#/components/schemas/LineItem2d' + oval-item-2d: '#/components/schemas/OvalItem2d' + freeform-item-2d: '#/components/schemas/FreeformItem2d' + callout-item: '#/components/schemas/CalloutItem' + pin-item-2d: '#/components/schemas/PinItem2d' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LineItem2d' + - $ref: '#/components/schemas/OvalItem2d' + - $ref: '#/components/schemas/FreeformItem2d' + - $ref: '#/components/schemas/CalloutItem' + - $ref: '#/components/schemas/PinItem2d' + maxItems: 1024 + type: array + required: + - items + - type + type: object HexColor: description: A hex color value. example: '#FFFFFF' @@ -16834,141 +16898,6 @@ components: required: - domain type: object - LineItem2d: - additionalProperties: false - properties: - type: - enum: - - line-item-2d - type: string - stroke: - $ref: '#/components/schemas/StrokeStyle' - fill: - $ref: '#/components/schemas/FillStyle' - startPosition: - $ref: '#/components/schemas/Vector2' - endPosition: - $ref: '#/components/schemas/Vector2' - startShape: - discriminator: - propertyName: type - oneOf: - - $ref: '#/components/schemas/ArrowEndShape' - - $ref: '#/components/schemas/CircleEndShape' - - $ref: '#/components/schemas/DashEndShape' - endShape: - discriminator: - propertyName: type - oneOf: - - $ref: '#/components/schemas/ArrowEndShape' - - $ref: '#/components/schemas/CircleEndShape' - - $ref: '#/components/schemas/DashEndShape' - required: - - endPosition - - fill - - startPosition - - stroke - - type - type: object - OvalItem2d: - additionalProperties: false - properties: - type: - enum: - - oval-item-2d - type: string - stroke: - $ref: '#/components/schemas/StrokeStyle' - fill: - $ref: '#/components/schemas/FillStyle' - topLeft: - $ref: '#/components/schemas/Vector2' - bottomRight: - $ref: '#/components/schemas/Vector2' - required: - - bottomRight - - fill - - stroke - - topLeft - - type - type: object - FreeformItem2d: - additionalProperties: false - properties: - type: - enum: - - freeform-item-2d - type: string - stroke: - $ref: '#/components/schemas/StrokeStyle' - fill: - $ref: '#/components/schemas/FillStyle' - positions: - items: - $ref: '#/components/schemas/Vector2' - type: array - required: - - fill - - positions - - stroke - - type - type: object - CalloutItem: - additionalProperties: false - properties: - type: - enum: - - callout-item - type: string - primaryColor: - $ref: '#/components/schemas/RGBA' - accentColor: - $ref: '#/components/schemas/RGBA' - text: - type: string - anchorPosition: - $ref: '#/components/schemas/Vector3' - textPosition: - $ref: '#/components/schemas/Vector2' - sceneItemId: - description: ID of the resource. - example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 - format: uuid - maxLength: 36 - type: string - required: - - accentColor - - anchorPosition - - primaryColor - - text - - textPosition - - type - type: object - PinItem2d: - additionalProperties: false - properties: - type: - enum: - - pin-item-2d - type: string - primaryColor: - $ref: '#/components/schemas/RGBA' - accentColor: - $ref: '#/components/schemas/RGBA' - position: - $ref: '#/components/schemas/Vector3' - sceneItemId: - description: ID of the resource. - example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 - format: uuid - maxLength: 36 - type: string - required: - - accentColor - - position - - primaryColor - - type - type: object PdfMarkup: additionalProperties: false description: @@ -17012,6 +16941,26 @@ components: - content - type type: object + DocumentAnnotation: + additionalProperties: false + description: A resolved document annotation for a thread or reply reference. + properties: + type: + enum: + - document-annotation + type: string + content: + description: The content of the document annotation. + discriminator: + mapping: + pdf-markup: '#/components/schemas/PdfMarkup' + propertyName: type + oneOf: + - $ref: '#/components/schemas/PdfMarkup' + required: + - content + - type + type: object SelectFileById: additionalProperties: false description: Queries a file by its unique ID. @@ -17152,6 +17101,141 @@ components: - id - type type: object + LineItem2d: + additionalProperties: false + properties: + type: + enum: + - line-item-2d + type: string + stroke: + $ref: '#/components/schemas/StrokeStyle' + fill: + $ref: '#/components/schemas/FillStyle' + startPosition: + $ref: '#/components/schemas/Vector2' + endPosition: + $ref: '#/components/schemas/Vector2' + startShape: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/ArrowEndShape' + - $ref: '#/components/schemas/CircleEndShape' + - $ref: '#/components/schemas/DashEndShape' + endShape: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/ArrowEndShape' + - $ref: '#/components/schemas/CircleEndShape' + - $ref: '#/components/schemas/DashEndShape' + required: + - endPosition + - fill + - startPosition + - stroke + - type + type: object + OvalItem2d: + additionalProperties: false + properties: + type: + enum: + - oval-item-2d + type: string + stroke: + $ref: '#/components/schemas/StrokeStyle' + fill: + $ref: '#/components/schemas/FillStyle' + topLeft: + $ref: '#/components/schemas/Vector2' + bottomRight: + $ref: '#/components/schemas/Vector2' + required: + - bottomRight + - fill + - stroke + - topLeft + - type + type: object + FreeformItem2d: + additionalProperties: false + properties: + type: + enum: + - freeform-item-2d + type: string + stroke: + $ref: '#/components/schemas/StrokeStyle' + fill: + $ref: '#/components/schemas/FillStyle' + positions: + items: + $ref: '#/components/schemas/Vector2' + type: array + required: + - fill + - positions + - stroke + - type + type: object + CalloutItem: + additionalProperties: false + properties: + type: + enum: + - callout-item + type: string + primaryColor: + $ref: '#/components/schemas/RGBA' + accentColor: + $ref: '#/components/schemas/RGBA' + text: + type: string + anchorPosition: + $ref: '#/components/schemas/Vector3' + textPosition: + $ref: '#/components/schemas/Vector2' + sceneItemId: + description: ID of the resource. + example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 + format: uuid + maxLength: 36 + type: string + required: + - accentColor + - anchorPosition + - primaryColor + - text + - textPosition + - type + type: object + PinItem2d: + additionalProperties: false + properties: + type: + enum: + - pin-item-2d + type: string + primaryColor: + $ref: '#/components/schemas/RGBA' + accentColor: + $ref: '#/components/schemas/RGBA' + position: + $ref: '#/components/schemas/Vector3' + sceneItemId: + description: ID of the resource. + example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 + format: uuid + maxLength: 36 + type: string + required: + - accentColor + - position + - primaryColor + - type + type: object RelationshipLinks: additionalProperties: false example: @@ -17163,6 +17247,57 @@ components: required: - related type: object + CanvasDocument2d: + additionalProperties: false + properties: + type: + enum: + - canvas-document-2d-v1 + type: string + items: + items: + description: A 2D canvas item. + discriminator: + mapping: + line-item-2d: '#/components/schemas/LineItem2d' + oval-item-2d: '#/components/schemas/OvalItem2d' + freeform-item-2d: '#/components/schemas/FreeformItem2d' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LineItem2d' + - $ref: '#/components/schemas/OvalItem2d' + - $ref: '#/components/schemas/FreeformItem2d' + maxItems: 1024 + type: array + required: + - items + - type + type: object + ParagraphNode: + additionalProperties: false + properties: + type: + enum: + - paragraph-node + type: string + content: + description: List of paragraph nodes + items: + description: An inline node + discriminator: + mapping: + text-node: '#/components/schemas/TextNode' + mention-node: '#/components/schemas/MentionNode' + propertyName: type + oneOf: + - $ref: '#/components/schemas/TextNode' + - $ref: '#/components/schemas/MentionNode' + maxItems: 100 + type: array + required: + - content + - type + type: object StrokeStyle: additionalProperties: false properties: @@ -17289,57 +17424,6 @@ components: - g - r type: object - CanvasDocument2d: - additionalProperties: false - properties: - type: - enum: - - canvas-document-2d-v1 - type: string - items: - items: - description: A 2D canvas item. - discriminator: - mapping: - line-item-2d: '#/components/schemas/LineItem2d' - oval-item-2d: '#/components/schemas/OvalItem2d' - freeform-item-2d: '#/components/schemas/FreeformItem2d' - propertyName: type - oneOf: - - $ref: '#/components/schemas/LineItem2d' - - $ref: '#/components/schemas/OvalItem2d' - - $ref: '#/components/schemas/FreeformItem2d' - maxItems: 1024 - type: array - required: - - items - - type - type: object - ParagraphNode: - additionalProperties: false - properties: - type: - enum: - - paragraph-node - type: string - content: - description: List of paragraph nodes - items: - description: An inline node - discriminator: - mapping: - text-node: '#/components/schemas/TextNode' - mention-node: '#/components/schemas/MentionNode' - propertyName: type - oneOf: - - $ref: '#/components/schemas/TextNode' - - $ref: '#/components/schemas/MentionNode' - maxItems: 100 - type: array - required: - - content - - type - type: object TextNode: additionalProperties: false properties: @@ -19423,28 +19507,6 @@ components: - created - status type: object - CanvasData_attributes: - properties: - document: - $ref: '#/components/schemas/CanvasDocument' - createdAt: - example: 2020-01-01T12:00:00Z - format: date-time - type: string - modifiedAt: - example: 2020-01-01T12:00:00Z - format: date-time - type: string - suppliedId: - example: some-string - maxLength: 1024 - minLength: 1 - type: string - required: - - createdAt - - document - - modifiedAt - type: object CollaborationContextData_attributes: properties: createdAt: From 600ce32270ee526be493f12036fbe38bfec3bbdf Mon Sep 17 00:00:00 2001 From: Jeff Murray Date: Wed, 15 Apr 2026 16:19:14 -0500 Subject: [PATCH 2/2] v0.42.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 75a0e08..76e8f17 100644 --- a/client/version.ts +++ b/client/version.ts @@ -1 +1 @@ -export const version = '0.41.0'; +export const version = '0.42.0'; diff --git a/package.json b/package.json index fc98bf1..86f241d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vertexvis/api-client-node", - "version": "0.41.0", + "version": "0.42.0", "description": "The Vertex REST API client for Node.js.", "license": "MIT", "author": "Vertex Developers (https://developer.vertexvis.com)",