From 1778e1c57dac065bf7ea270e036342b96d1c8f8d Mon Sep 17 00:00:00 2001 From: Jeff Murray Date: Fri, 10 Apr 2026 15:53:22 -0500 Subject: [PATCH 1/2] Generate --- api.ts | 595 ++++++++++++++++++++++++++++++++++++++++++++++++++----- spec.yml | 318 +++++++++++++++++++++++++++-- 2 files changed, 841 insertions(+), 72 deletions(-) diff --git a/api.ts b/api.ts index d998b7b..d217b87 100644 --- a/api.ts +++ b/api.ts @@ -960,12 +960,40 @@ export interface CanvasDocument { } export const CanvasDocumentTypeEnum = { - CanvasDocumentV1: 'canvas-document-v1', + _3dV1: 'canvas-document-3d-v1', + V1: 'canvas-document-v1', } as const; export type CanvasDocumentTypeEnum = (typeof CanvasDocumentTypeEnum)[keyof typeof CanvasDocumentTypeEnum]; +/** + * + * @export + * @interface CanvasDocument2d + */ +export interface CanvasDocument2d { + /** + * + * @type {string} + * @memberof CanvasDocument2d + */ + type: CanvasDocument2dTypeEnum; + /** + * + * @type {Array} + * @memberof CanvasDocument2d + */ + items: Array; +} + +export const CanvasDocument2dTypeEnum = { + CanvasDocument2dV1: 'canvas-document-2d-v1', +} as const; + +export type CanvasDocument2dTypeEnum = + (typeof CanvasDocument2dTypeEnum)[keyof typeof CanvasDocument2dTypeEnum]; + /** * Relationship to a `canvas`. * @export @@ -1633,6 +1661,125 @@ export const CreateCollaborationContextRequestDataTypeEnum = { export type CreateCollaborationContextRequestDataTypeEnum = (typeof CreateCollaborationContextRequestDataTypeEnum)[keyof typeof CreateCollaborationContextRequestDataTypeEnum]; +/** + * Document annotation used when creating a document reference. + * @export + * @interface CreateDocumentAnnotation + */ +export interface CreateDocumentAnnotation { + /** + * + * @type {string} + * @memberof CreateDocumentAnnotation + */ + type: CreateDocumentAnnotationTypeEnum; + /** + * The content of the document annotation. + * @type {PdfMarkup} + * @memberof CreateDocumentAnnotation + */ + content: PdfMarkup; +} + +export const CreateDocumentAnnotationTypeEnum = { + DocumentAnnotation: 'document-annotation', +} as const; + +export type CreateDocumentAnnotationTypeEnum = + (typeof CreateDocumentAnnotationTypeEnum)[keyof typeof CreateDocumentAnnotationTypeEnum]; + +/** + * A reference to a document to be created for a thread or reply. + * @export + * @interface CreateDocumentReference + */ +export interface CreateDocumentReference { + /** + * + * @type {string} + * @memberof CreateDocumentReference + */ + type: CreateDocumentReferenceTypeEnum; + /** + * ID of the resource. + * @type {string} + * @memberof CreateDocumentReference + */ + documentId?: string; + /** + * + * @type {CreateDocumentAnnotation} + * @memberof CreateDocumentReference + */ + documentAnnotation?: CreateDocumentAnnotation; +} + +export const CreateDocumentReferenceTypeEnum = { + DocumentReference: 'document-reference', +} as const; + +export type CreateDocumentReferenceTypeEnum = + (typeof CreateDocumentReferenceTypeEnum)[keyof typeof CreateDocumentReferenceTypeEnum]; + +/** + * + * @export + * @interface CreateDocumentRequest + */ +export interface CreateDocumentRequest { + /** + * + * @type {CreateDocumentRequestData} + * @memberof CreateDocumentRequest + */ + data: CreateDocumentRequestData; +} +/** + * + * @export + * @interface CreateDocumentRequestData + */ +export interface CreateDocumentRequestData { + /** + * + * @type {string} + * @memberof CreateDocumentRequestData + */ + type: CreateDocumentRequestDataTypeEnum; + /** + * + * @type {CreateDocumentRequestDataAttributes} + * @memberof CreateDocumentRequestData + */ + attributes: CreateDocumentRequestDataAttributes; +} + +export const CreateDocumentRequestDataTypeEnum = { + Document: 'document', +} as const; + +export type CreateDocumentRequestDataTypeEnum = + (typeof CreateDocumentRequestDataTypeEnum)[keyof typeof CreateDocumentRequestDataTypeEnum]; + +/** + * + * @export + * @interface CreateDocumentRequestDataAttributes + */ +export interface CreateDocumentRequestDataAttributes { + /** + * + * @type {string} + * @memberof CreateDocumentRequestDataAttributes + */ + fileId: string; + /** + * + * @type {string} + * @memberof CreateDocumentRequestDataAttributes + */ + suppliedId?: string; +} /** * * @export @@ -2363,12 +2510,6 @@ export type CreateReplyRequestDataTypeEnum = * @interface CreateReplyRequestDataAttributes */ export interface CreateReplyRequestDataAttributes { - /** - * - * @type {string} - * @memberof CreateReplyRequestDataAttributes - */ - body?: string; /** * * @type {boolean} @@ -2377,10 +2518,10 @@ export interface CreateReplyRequestDataAttributes { isDrafting?: boolean; /** * - * @type {CreateSceneReference} + * @type {CreateSceneReference | CreateDocumentReference} * @memberof CreateReplyRequestDataAttributes */ - reference?: CreateSceneReference; + reference?: CreateSceneReference | CreateDocumentReference; /** * * @type {WithBodyDocument} @@ -3379,12 +3520,6 @@ export interface CreateThreadRequestDataAttributes { * @memberof CreateThreadRequestDataAttributes */ title?: string; - /** - * - * @type {string} - * @memberof CreateThreadRequestDataAttributes - */ - body?: string; /** * * @type {boolean} @@ -3393,16 +3528,22 @@ export interface CreateThreadRequestDataAttributes { isDrafting?: boolean; /** * - * @type {CreateSceneReference} + * @type {CreateSceneReference | CreateDocumentReference} * @memberof CreateThreadRequestDataAttributes */ - reference?: CreateSceneReference; + reference?: CreateSceneReference | CreateDocumentReference; /** * * @type {WithBodyDocument} * @memberof CreateThreadRequestDataAttributes */ withBodyDocument?: WithBodyDocument; + /** + * + * @type {string} + * @memberof CreateThreadRequestDataAttributes + */ + group?: string; } /** * @@ -3857,6 +3998,130 @@ export interface Dimensions { */ width: number; } +/** + * + * @export + * @interface Document + */ +export interface Document { + /** + * + * @type {DocumentData} + * @memberof Document + */ + data: DocumentData; + /** + * + * @type {{ [key: string]: Link; }} + * @memberof Document + */ + links?: { [key: string]: Link }; +} +/** + * + * @export + * @interface DocumentData + */ +export interface DocumentData { + /** + * + * @type {string} + * @memberof DocumentData + */ + id: string; + /** + * + * @type {string} + * @memberof DocumentData + */ + type: DocumentDataTypeEnum; + /** + * + * @type {DocumentDataAttributes} + * @memberof DocumentData + */ + attributes: DocumentDataAttributes; +} + +export const DocumentDataTypeEnum = { + Document: 'document', +} as const; + +export type DocumentDataTypeEnum = + (typeof DocumentDataTypeEnum)[keyof typeof DocumentDataTypeEnum]; + +/** + * + * @export + * @interface DocumentDataAttributes + */ +export interface DocumentDataAttributes { + /** + * + * @type {string} + * @memberof DocumentDataAttributes + */ + fileId: string; + /** + * + * @type {string} + * @memberof DocumentDataAttributes + */ + suppliedId?: string; + /** + * + * @type {string} + * @memberof DocumentDataAttributes + */ + documentType: DocumentDataAttributesDocumentTypeEnum; + /** + * + * @type {string} + * @memberof DocumentDataAttributes + */ + createdAt: string; +} + +export const DocumentDataAttributesDocumentTypeEnum = { + Pdf: 'PDF', +} as const; + +export type DocumentDataAttributesDocumentTypeEnum = + (typeof DocumentDataAttributesDocumentTypeEnum)[keyof typeof DocumentDataAttributesDocumentTypeEnum]; + +/** + * A reference to a document for a thread or reply. + * @export + * @interface DocumentReference + */ +export interface DocumentReference { + /** + * + * @type {string} + * @memberof DocumentReference + */ + type: DocumentReferenceTypeEnum; + /** + * ID of the resource. + * @type {string} + * @memberof DocumentReference + */ + documentId: string; + /** + * ID of the resource. + * @type {string} + * @memberof DocumentReference + */ + documentAnnotationId: string; +} + +export const DocumentReferenceTypeEnum = { + DocumentReference: 'document-reference', +} as const; + +export type DocumentReferenceTypeEnum = + (typeof DocumentReferenceTypeEnum)[keyof typeof DocumentReferenceTypeEnum]; + /** * * @export @@ -6261,6 +6526,39 @@ export const PartsDomainSubjectDomainEnum = { export type PartsDomainSubjectDomainEnum = (typeof PartsDomainSubjectDomainEnum)[keyof typeof PartsDomainSubjectDomainEnum]; +/** + * PDF markup document annotation content used when creating 2d Markup for a PDF + * @export + * @interface PdfMarkup + */ +export interface PdfMarkup { + /** + * + * @type {string} + * @memberof PdfMarkup + */ + type: PdfMarkupTypeEnum; + /** + * + * @type {number} + * @memberof PdfMarkup + */ + pageNumber: number; + /** + * + * @type {CanvasDocument2d} + * @memberof PdfMarkup + */ + canvas: CanvasDocument2d; +} + +export const PdfMarkupTypeEnum = { + PdfMarkup: 'pdf-markup', +} as const; + +export type PdfMarkupTypeEnum = + (typeof PdfMarkupTypeEnum)[keyof typeof PdfMarkupTypeEnum]; + /** * * @export @@ -7565,10 +7863,10 @@ export interface ReplyDataAttributes { isDrafting: boolean; /** * - * @type {SceneReference} + * @type {SceneReference | DocumentReference} * @memberof ReplyDataAttributes */ - reference?: SceneReference; + reference?: SceneReference | DocumentReference; /** * * @type {TextDocument} @@ -9826,16 +10124,22 @@ export interface ThreadDataAttributes { replyCount?: number; /** * - * @type {SceneReference} + * @type {SceneReference | DocumentReference} * @memberof ThreadDataAttributes */ - reference?: SceneReference; + reference?: SceneReference | DocumentReference; /** * * @type {TextDocument} * @memberof ThreadDataAttributes */ bodyDocument?: TextDocument; + /** + * + * @type {string} + * @memberof ThreadDataAttributes + */ + group?: string; /** * List of mentions in the thread * @type {Array} @@ -10531,12 +10835,6 @@ export interface UpdateReplyRequestData { * @interface UpdateReplyRequestDataAttributes */ export interface UpdateReplyRequestDataAttributes { - /** - * - * @type {string} - * @memberof UpdateReplyRequestDataAttributes - */ - body?: string | null; /** * * @type {boolean} @@ -11060,7 +11358,7 @@ export interface UpdateThreadRequestDataAttributes { * @type {string} * @memberof UpdateThreadRequestDataAttributes */ - body?: string | null; + group?: string | null; /** * * @type {WithBodyDocument} @@ -15911,6 +16209,178 @@ export class CollaborationContextsApi extends BaseAPI { } } +/** + * DocumentsApi - axios parameter creator + * @export + */ +export const DocumentsApiAxiosParamCreator = function ( + configuration?: Configuration +) { + return { + /** + * Creates a document. **Preview:** This is a preview API and is subject to change. + * @param {CreateDocumentRequest} createDocumentRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createDocument: async ( + createDocumentRequest: CreateDocumentRequest, + options: AxiosRequestConfig = {} + ): Promise => { + // verify required parameter 'createDocumentRequest' is not null or undefined + assertParamExists( + 'createDocument', + 'createDocumentRequest', + createDocumentRequest + ); + 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: 'POST', + ...baseOptions, + ...options, + }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication OAuth2 required + // oauth required + await setOAuthToObject( + localVarHeaderParameter, + 'OAuth2', + [], + configuration + ); + + localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions?.headers ?? {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + createDocumentRequest, + localVarRequestOptions, + configuration + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + }; +}; + +/** + * DocumentsApi - functional programming interface + * @export + */ +export const DocumentsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + DocumentsApiAxiosParamCreator(configuration); + return { + /** + * Creates a document. **Preview:** This is a preview API and is subject to change. + * @param {CreateDocumentRequest} createDocumentRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createDocument( + createDocumentRequest: CreateDocumentRequest, + options?: AxiosRequestConfig + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.createDocument( + createDocumentRequest, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + }; +}; + +/** + * DocumentsApi - factory interface + * @export + */ +export const DocumentsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance +) { + const localVarFp = DocumentsApiFp(configuration); + return { + /** + * Creates a document. **Preview:** This is a preview API and is subject to change. + * @param {CreateDocumentRequest} createDocumentRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createDocument( + createDocumentRequest: CreateDocumentRequest, + options?: any + ): AxiosPromise { + return localVarFp + .createDocument(createDocumentRequest, options) + .then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createDocument operation in DocumentsApi. + * @export + * @interface DocumentsApiCreateDocumentRequest + */ +export interface DocumentsApiCreateDocumentRequest { + /** + * + * @type {CreateDocumentRequest} + * @memberof DocumentsApiCreateDocument + */ + readonly createDocumentRequest: CreateDocumentRequest; +} + +/** + * DocumentsApi - object-oriented interface + * @export + * @class DocumentsApi + * @extends {BaseAPI} + */ +export class DocumentsApi extends BaseAPI { + /** + * Creates a document. **Preview:** This is a preview API and is subject to change. + * @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DocumentsApi + */ + public createDocument( + requestParameters: DocumentsApiCreateDocumentRequest, + options?: AxiosRequestConfig + ) { + return DocumentsApiFp(this.configuration) + .createDocument(requestParameters.createDocumentRequest, options) + .then((request) => request(this.axios, this.basePath)); + } +} + /** * ExportsApi - axios parameter creator * @export @@ -33550,21 +34020,23 @@ export const ThreadsApiAxiosParamCreator = function ( /** * Get a page of `thread`s. * @param {string} [fieldsThread] Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested. - * @param {string} [filterCollaborationContextId] A collaboration context to filter on. + * @param {Array} [filterCollaborationContextId] Collaboration contexts to filter on. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [include] Comma-separated list of relationships to include in response. - * @param {Array} [filterThreadStatus] The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved. + * @param {Array} [filterStatus] The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved. + * @param {Array} [filterGroup] The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getThreads: async ( fieldsThread?: string, - filterCollaborationContextId?: string, + filterCollaborationContextId?: Array, pageCursor?: string, pageSize?: number, include?: string, - filterThreadStatus?: Array, + filterStatus?: Array, + filterGroup?: Array, options: AxiosRequestConfig = {} ): Promise => { const localVarPath = `/threads`; @@ -33596,7 +34068,7 @@ export const ThreadsApiAxiosParamCreator = function ( localVarQueryParameter['fields[thread]'] = fieldsThread; } - if (filterCollaborationContextId !== undefined) { + if (filterCollaborationContextId) { localVarQueryParameter['filter[collaborationContextId]'] = filterCollaborationContextId; } @@ -33613,9 +34085,16 @@ export const ThreadsApiAxiosParamCreator = function ( localVarQueryParameter['include'] = include; } - if (filterThreadStatus) { - localVarQueryParameter['filter[threadStatus]'] = - filterThreadStatus.join(COLLECTION_FORMATS.csv); + if (filterStatus) { + localVarQueryParameter['filter[status]'] = filterStatus.join( + COLLECTION_FORMATS.csv + ); + } + + if (filterGroup) { + localVarQueryParameter['filter[group]'] = filterGroup.join( + COLLECTION_FORMATS.csv + ); } setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -33811,21 +34290,23 @@ export const ThreadsApiFp = function (configuration?: Configuration) { /** * Get a page of `thread`s. * @param {string} [fieldsThread] Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested. - * @param {string} [filterCollaborationContextId] A collaboration context to filter on. + * @param {Array} [filterCollaborationContextId] Collaboration contexts to filter on. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [include] Comma-separated list of relationships to include in response. - * @param {Array} [filterThreadStatus] The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved. + * @param {Array} [filterStatus] The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved. + * @param {Array} [filterGroup] The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getThreads( fieldsThread?: string, - filterCollaborationContextId?: string, + filterCollaborationContextId?: Array, pageCursor?: string, pageSize?: number, include?: string, - filterThreadStatus?: Array, + filterStatus?: Array, + filterGroup?: Array, options?: AxiosRequestConfig ): Promise< (axios?: AxiosInstance, basePath?: string) => AxiosPromise @@ -33836,7 +34317,8 @@ export const ThreadsApiFp = function (configuration?: Configuration) { pageCursor, pageSize, include, - filterThreadStatus, + filterStatus, + filterGroup, options ); return createRequestFunction( @@ -33945,21 +34427,23 @@ export const ThreadsApiFactory = function ( /** * Get a page of `thread`s. * @param {string} [fieldsThread] Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested. - * @param {string} [filterCollaborationContextId] A collaboration context to filter on. + * @param {Array} [filterCollaborationContextId] Collaboration contexts to filter on. * @param {string} [pageCursor] The cursor for the next page of items. * @param {number} [pageSize] The number of items to return. * @param {string} [include] Comma-separated list of relationships to include in response. - * @param {Array} [filterThreadStatus] The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved. + * @param {Array} [filterStatus] The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved. + * @param {Array} [filterGroup] The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getThreads( fieldsThread?: string, - filterCollaborationContextId?: string, + filterCollaborationContextId?: Array, pageCursor?: string, pageSize?: number, include?: string, - filterThreadStatus?: Array, + filterStatus?: Array, + filterGroup?: Array, options?: any ): AxiosPromise { return localVarFp @@ -33969,7 +34453,8 @@ export const ThreadsApiFactory = function ( pageCursor, pageSize, include, - filterThreadStatus, + filterStatus, + filterGroup, options ) .then((request) => request(axios, basePath)); @@ -34084,11 +34569,11 @@ export interface ThreadsApiGetThreadsRequest { readonly fieldsThread?: string; /** - * A collaboration context to filter on. - * @type {string} + * Collaboration contexts to filter on. + * @type {Array} * @memberof ThreadsApiGetThreads */ - readonly filterCollaborationContextId?: string; + readonly filterCollaborationContextId?: Array; /** * The cursor for the next page of items. @@ -34116,7 +34601,14 @@ export interface ThreadsApiGetThreadsRequest { * @type {Array} * @memberof ThreadsApiGetThreads */ - readonly filterThreadStatus?: Array; + readonly filterStatus?: Array; + + /** + * The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456. + * @type {Array} + * @memberof ThreadsApiGetThreads + */ + readonly filterGroup?: Array; } /** @@ -34238,7 +34730,8 @@ export class ThreadsApi extends BaseAPI { requestParameters.pageCursor, requestParameters.pageSize, requestParameters.include, - requestParameters.filterThreadStatus, + requestParameters.filterStatus, + requestParameters.filterGroup, options ) .then((request) => request(this.axios, this.basePath)); diff --git a/spec.yml b/spec.yml index 87cfdc1..958a484 100644 --- a/spec.yml +++ b/spec.yml @@ -34,6 +34,7 @@ tags: - name: canvases - description: Requires Engage Module name: collaboration-contexts + - name: documents - name: exports - name: files - name: file-collections @@ -1963,15 +1964,16 @@ paths: maxLength: 32 type: string style: form - - description: A collaboration context to filter on. + - description: Collaboration contexts to filter on. explode: true in: query name: filter[collaborationContextId] required: false schema: - example: some-id-1 - maxLength: 1024 - type: string + items: + type: string + maxItems: 100 + type: array style: form - description: The cursor for the next page of items. explode: true @@ -2008,13 +2010,24 @@ paths: The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved. explode: false in: query - name: filter[threadStatus] + name: filter[status] required: false schema: items: $ref: '#/components/schemas/ThreadStatus' type: array style: form + - description: | + The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456. + explode: false + in: query + name: filter[group] + required: false + schema: + items: + type: string + type: array + style: form responses: '200': content: @@ -3113,6 +3126,67 @@ paths: - OAuth2: [] tags: - file-jobs + /documents: + post: + description: | + Creates a document. + **Preview:** This is a preview API and is subject to change. + operationId: createDocument + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/CreateDocumentRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/Document' + description: Created + headers: + location: + $ref: '#/components/headers/Location' + '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: + 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 /geometry-sets: get: description: Get `geometry-sets`. @@ -11012,15 +11086,16 @@ components: $ref: '#/components/schemas/Uuid' style: simple CollaborationContextIdFilter: - description: A collaboration context to filter on. + description: Collaboration contexts to filter on. explode: true in: query name: filter[collaborationContextId] required: false schema: - example: some-id-1 - maxLength: 1024 - type: string + items: + type: string + maxItems: 100 + type: array style: form CollaborationContextUserSearchFilter: description: Query users by e-mail or full name @@ -11524,13 +11599,25 @@ components: The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved. explode: false in: query - name: filter[threadStatus] + name: filter[status] required: false schema: items: $ref: '#/components/schemas/ThreadStatus' type: array style: form + ThreadGroupFilter: + description: | + The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456. + explode: false + in: query + name: filter[group] + required: false + schema: + items: + type: string + type: array + style: form PropertyEntriesResourceIdFilter: description: A resource ID to filter on explode: true @@ -12244,6 +12331,26 @@ components: required: - data type: object + CreateDocumentRequest: + additionalProperties: false + properties: + data: + $ref: '#/components/schemas/CreateDocumentRequest_data' + required: + - data + type: object + Document: + additionalProperties: false + properties: + data: + $ref: '#/components/schemas/DocumentData' + links: + additionalProperties: + $ref: '#/components/schemas/Link' + type: object + required: + - data + type: object GeometrySetList: additionalProperties: false properties: @@ -13873,6 +13980,25 @@ components: - sceneId - type type: object + CreateDocumentReference: + additionalProperties: false + description: A reference to a document to be created for a thread or reply. + properties: + type: + enum: + - document-reference + type: string + documentId: + description: ID of the resource. + example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 + format: uuid + maxLength: 36 + type: string + documentAnnotation: + $ref: '#/components/schemas/CreateDocumentAnnotation' + required: + - type + type: object WithBodyDocument: additionalProperties: false properties: @@ -14020,6 +14146,23 @@ components: - manifest - type type: object + DocumentData: + additionalProperties: false + properties: + id: + format: uuid + type: string + type: + enum: + - document + type: string + attributes: + $ref: '#/components/schemas/DocumentData_attributes' + required: + - attributes + - id + - type + type: object GeometrySetData: additionalProperties: false properties: @@ -15645,6 +15788,7 @@ components: properties: type: enum: + - canvas-document-3d-v1 - canvas-document-v1 type: string items: @@ -15717,6 +15861,26 @@ components: - sceneViewStateId - type type: object + CreateDocumentAnnotation: + additionalProperties: false + description: Document annotation used when creating a document 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 TextDocument: additionalProperties: false properties: @@ -15773,6 +15937,31 @@ components: - thumbnails - type type: object + DocumentReference: + additionalProperties: false + description: A reference to a document for a thread or reply. + properties: + type: + enum: + - document-reference + type: string + documentId: + description: ID of the resource. + example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 + format: uuid + maxLength: 36 + type: string + documentAnnotationId: + description: ID of the resource. + example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 + format: uuid + maxLength: 36 + type: string + required: + - documentAnnotationId + - documentId + - type + type: object KnownUser: additionalProperties: false properties: @@ -16736,9 +16925,6 @@ components: accentColor: $ref: '#/components/schemas/RGBA' text: - example: some-string - maxLength: 1024 - minLength: 1 type: string anchorPosition: $ref: '#/components/schemas/Vector3' @@ -16783,6 +16969,26 @@ components: - primaryColor - type type: object + PdfMarkup: + additionalProperties: false + description: + PDF markup document annotation content used when creating 2d Markup + for a PDF + properties: + type: + enum: + - pdf-markup + type: string + pageNumber: + format: int32 + type: integer + canvas: + $ref: '#/components/schemas/CanvasDocument2d' + required: + - canvas + - pageNumber + - type + type: object RootNode: additionalProperties: false properties: @@ -17083,6 +17289,32 @@ 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: @@ -17452,8 +17684,6 @@ components: $ref: '#/components/schemas/ThreadStatus' title: type: string - body: - type: string isDrafting: type: boolean reference: @@ -17461,8 +17691,12 @@ components: propertyName: type oneOf: - $ref: '#/components/schemas/CreateSceneReference' + - $ref: '#/components/schemas/CreateDocumentReference' withBodyDocument: $ref: '#/components/schemas/WithBodyDocument' + group: + maxLength: 1024 + type: string required: - status - type @@ -17490,7 +17724,8 @@ components: type: string isDrafting: type: boolean - body: + group: + maxLength: 1024 nullable: true type: string withBodyDocument: @@ -17701,6 +17936,28 @@ components: - attributes - type type: object + CreateDocumentRequest_data_attributes: + properties: + fileId: + format: uuid + type: string + suppliedId: + type: string + required: + - fileId + type: object + CreateDocumentRequest_data: + properties: + type: + enum: + - document + type: string + attributes: + $ref: '#/components/schemas/CreateDocumentRequest_data_attributes' + required: + - attributes + - type + type: object CreateGeometrySetRequest_data_relationships: properties: source: @@ -17723,9 +17980,6 @@ components: type: object UpdateReplyRequest_data_attributes: properties: - body: - nullable: true - type: string isDrafting: type: boolean withBodyDocument: @@ -17746,8 +18000,6 @@ components: type: object CreateReplyRequest_data_attributes: properties: - body: - type: string isDrafting: type: boolean reference: @@ -17755,6 +18007,7 @@ components: propertyName: type oneOf: - $ref: '#/components/schemas/CreateSceneReference' + - $ref: '#/components/schemas/CreateDocumentReference' withBodyDocument: $ref: '#/components/schemas/WithBodyDocument' type: object @@ -19261,8 +19514,11 @@ components: propertyName: type oneOf: - $ref: '#/components/schemas/SceneReference' + - $ref: '#/components/schemas/DocumentReference' bodyDocument: $ref: '#/components/schemas/TextDocument' + group: + type: string mentions: description: List of mentions in the thread items: @@ -19382,6 +19638,25 @@ components: required: - created type: object + DocumentData_attributes: + properties: + fileId: + format: uuid + type: string + suppliedId: + type: string + documentType: + enum: + - PDF + type: string + createdAt: + format: date-time + type: string + required: + - createdAt + - documentType + - fileId + type: object ReplyData_attributes: properties: createdAt: @@ -19406,6 +19681,7 @@ components: propertyName: type oneOf: - $ref: '#/components/schemas/SceneReference' + - $ref: '#/components/schemas/DocumentReference' bodyDocument: $ref: '#/components/schemas/TextDocument' mentions: From 7294bcb61fde931c2c0adcac1bf48cfd8ded42a3 Mon Sep 17 00:00:00 2001 From: Jeff Murray Date: Fri, 10 Apr 2026 15:53:36 -0500 Subject: [PATCH 2/2] v0.41.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 6994038..75a0e08 100644 --- a/client/version.ts +++ b/client/version.ts @@ -1 +1 @@ -export const version = '0.40.0'; +export const version = '0.41.0'; diff --git a/package.json b/package.json index 4b34fc6..fc98bf1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vertexvis/api-client-node", - "version": "0.40.0", + "version": "0.41.0", "description": "The Vertex REST API client for Node.js.", "license": "MIT", "author": "Vertex Developers (https://developer.vertexvis.com)",