diff --git a/api.ts b/api.ts index 5ad2eb6..e5f01c3 100644 --- a/api.ts +++ b/api.ts @@ -501,6 +501,39 @@ export interface ArchiveManifestEntry { */ directory?: string; } +/** + * + * @export + * @interface ArrowEndShape + */ +export interface ArrowEndShape { + /** + * + * @type {string} + * @memberof ArrowEndShape + */ + type: ArrowEndShapeTypeEnum; + /** + * A numerical floating-point value. + * @type {number} + * @memberof ArrowEndShape + */ + width: number; + /** + * Indicates if the arrow end should be filled. + * @type {boolean} + * @memberof ArrowEndShape + */ + filled: boolean; +} + +export const ArrowEndShapeTypeEnum = { + ArrowEnd: 'arrow-end', +} as const; + +export type ArrowEndShapeTypeEnum = + (typeof ArrowEndShapeTypeEnum)[keyof typeof ArrowEndShapeTypeEnum]; + /** * * @export @@ -544,6 +577,12 @@ export interface AttachmentData { * @memberof AttachmentData */ attributes: AttachmentDataAttributes; + /** + * + * @type {AttachmentDataRelationships} + * @memberof AttachmentData + */ + relationships: AttachmentDataRelationships; } /** * @@ -558,6 +597,19 @@ export interface AttachmentDataAttributes { */ content: FileAttachment; } +/** + * + * @export + * @interface AttachmentDataRelationships + */ +export interface AttachmentDataRelationships { + /** + * + * @type {AttachmentRelationship} + * @memberof AttachmentDataRelationships + */ + relationship?: AttachmentRelationship; +} /** * * @export @@ -577,6 +629,47 @@ export interface AttachmentList { */ links: { [key: string]: Link }; } +/** + * + * @export + * @interface AttachmentRelationship + */ +export interface AttachmentRelationship { + /** + * + * @type {AttachmentRelationshipData} + * @memberof AttachmentRelationship + */ + data: AttachmentRelationshipData; +} +/** + * + * @export + * @interface AttachmentRelationshipData + */ +export interface AttachmentRelationshipData { + /** + * + * @type {string} + * @memberof AttachmentRelationshipData + */ + type: AttachmentRelationshipDataTypeEnum; + /** + * ID of the resource. + * @type {string} + * @memberof AttachmentRelationshipData + */ + id: string; +} + +export const AttachmentRelationshipDataTypeEnum = { + Thread: 'thread', + Reply: 'reply', +} as const; + +export type AttachmentRelationshipDataTypeEnum = + (typeof AttachmentRelationshipDataTypeEnum)[keyof typeof AttachmentRelationshipDataTypeEnum]; + /** * * @export @@ -676,6 +769,63 @@ export interface BoundingBox { * @interface CADExportConfig */ export interface CADExportConfig extends ExportConfig {} +/** + * + * @export + * @interface CalloutItem + */ +export interface CalloutItem { + /** + * + * @type {string} + * @memberof CalloutItem + */ + type: CalloutItemTypeEnum; + /** + * + * @type {Color3} + * @memberof CalloutItem + */ + primaryColor: Color3; + /** + * + * @type {Color3} + * @memberof CalloutItem + */ + accentColor: Color3; + /** + * + * @type {string} + * @memberof CalloutItem + */ + text: string; + /** + * + * @type {Vector3} + * @memberof CalloutItem + */ + anchorPosition: Vector3; + /** + * + * @type {Vector2} + * @memberof CalloutItem + */ + textPosition: Vector2; + /** + * ID of the resource. + * @type {string} + * @memberof CalloutItem + */ + sceneItemId?: string; +} + +export const CalloutItemTypeEnum = { + CalloutItem: 'callout-item', +} as const; + +export type CalloutItemTypeEnum = + (typeof CalloutItemTypeEnum)[keyof typeof CalloutItemTypeEnum]; + /** * Fit camera in 3D space based on items in scene. * @export @@ -698,6 +848,164 @@ 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 + * @interface CanvasDocument + */ +export interface CanvasDocument { + /** + * + * @type {string} + * @memberof CanvasDocument + */ + type: CanvasDocumentTypeEnum; + /** + * + * @type {Array} + * @memberof CanvasDocument + */ + items: Array< + LineItem2d | OvalItem2d | FreeformItem2d | CalloutItem | PinItem2d + >; +} + +export const CanvasDocumentTypeEnum = { + CanvasDocumentV1: 'canvas-document-v1', +} as const; + +export type CanvasDocumentTypeEnum = + (typeof CanvasDocumentTypeEnum)[keyof typeof CanvasDocumentTypeEnum]; + +/** + * Relationship to a `canvas`. + * @export + * @interface CanvasRelationship + */ +export interface CanvasRelationship { + /** + * + * @type {CanvasRelationshipData} + * @memberof CanvasRelationship + */ + data: CanvasRelationshipData; +} +/** + * + * @export + * @interface CanvasRelationshipData + */ +export interface CanvasRelationshipData { + /** + * Resource object type. + * @type {string} + * @memberof CanvasRelationshipData + */ + type: CanvasRelationshipDataTypeEnum; + /** + * ID of the resource. + * @type {string} + * @memberof CanvasRelationshipData + */ + id: string; +} + +export const CanvasRelationshipDataTypeEnum = { + Canvas: 'canvas', +} as const; + +export type CanvasRelationshipDataTypeEnum = + (typeof CanvasRelationshipDataTypeEnum)[keyof typeof CanvasRelationshipDataTypeEnum]; + /** * * @export @@ -779,6 +1087,39 @@ export const ChangeVisibilityOpTypeEnum = { export type ChangeVisibilityOpTypeEnum = (typeof ChangeVisibilityOpTypeEnum)[keyof typeof ChangeVisibilityOpTypeEnum]; +/** + * + * @export + * @interface CircleEndShape + */ +export interface CircleEndShape { + /** + * + * @type {string} + * @memberof CircleEndShape + */ + type: CircleEndShapeTypeEnum; + /** + * A numerical floating-point value for the diameter of the end. + * @type {number} + * @memberof CircleEndShape + */ + diameter: number; + /** + * Indicates if the circle end should be filled. + * @type {boolean} + * @memberof CircleEndShape + */ + filled: boolean; +} + +export const CircleEndShapeTypeEnum = { + CircleEnd: 'circle-end', +} as const; + +export type CircleEndShapeTypeEnum = + (typeof CircleEndShapeTypeEnum)[keyof typeof CircleEndShapeTypeEnum]; + /** * * @export @@ -2034,6 +2375,12 @@ export interface CreateReplyRequestDataAttributes { * @memberof CreateReplyRequestDataAttributes */ isDrafting?: boolean; + /** + * + * @type {CreateSceneReference} + * @memberof CreateReplyRequestDataAttributes + */ + reference?: CreateSceneReference; } /** * @@ -2801,6 +3148,12 @@ export interface CreateSceneViewStateRequestDataAttributes { * @memberof CreateSceneViewStateRequestDataAttributes */ suppliedId?: string; + /** + * + * @type {WithCanvas} + * @memberof CreateSceneViewStateRequestDataAttributes + */ + withCanvas?: WithCanvas; } /** * @@ -3385,6 +3738,33 @@ export interface CrossSectioning { */ planes: Array; } +/** + * + * @export + * @interface DashEndShape + */ +export interface DashEndShape { + /** + * + * @type {string} + * @memberof DashEndShape + */ + type: DashEndShapeTypeEnum; + /** + * A numerical floating-point value indicating the width of the dash. + * @type {number} + * @memberof DashEndShape + */ + width: number; +} + +export const DashEndShapeTypeEnum = { + DashEnd: 'dash-end', +} as const; + +export type DashEndShapeTypeEnum = + (typeof DashEndShapeTypeEnum)[keyof typeof DashEndShapeTypeEnum]; + /** * Create Part Assembly * @export @@ -4141,6 +4521,19 @@ export const FileRelationshipDataTypeEnum = { export type FileRelationshipDataTypeEnum = (typeof FileRelationshipDataTypeEnum)[keyof typeof FileRelationshipDataTypeEnum]; +/** + * + * @export + * @interface FillStyle + */ +export interface FillStyle { + /** + * + * @type {Color3} + * @memberof FillStyle + */ + color: Color3; +} /** * Describes how an attribute should be filtered. * @export @@ -4190,6 +4583,45 @@ export interface FilterExpression { */ contains?: string; } +/** + * + * @export + * @interface FreeformItem2d + */ +export interface FreeformItem2d { + /** + * + * @type {string} + * @memberof FreeformItem2d + */ + type: FreeformItem2dTypeEnum; + /** + * + * @type {StrokeStyle} + * @memberof FreeformItem2d + */ + stroke: StrokeStyle; + /** + * + * @type {FillStyle} + * @memberof FreeformItem2d + */ + fill: FillStyle; + /** + * + * @type {Array} + * @memberof FreeformItem2d + */ + positions: Array; +} + +export const FreeformItem2dTypeEnum = { + FreeformItem2d: 'freeform-item-2d', +} as const; + +export type FreeformItem2dTypeEnum = + (typeof FreeformItem2dTypeEnum)[keyof typeof FreeformItem2dTypeEnum]; + /** * * @export @@ -4471,6 +4903,63 @@ export interface HitResultDataRelationships { */ sceneItem: RelationshipData; } +/** + * + * @export + * @interface LineItem2d + */ +export interface LineItem2d { + /** + * + * @type {string} + * @memberof LineItem2d + */ + type: LineItem2dTypeEnum; + /** + * + * @type {StrokeStyle} + * @memberof LineItem2d + */ + stroke: StrokeStyle; + /** + * + * @type {FillStyle} + * @memberof LineItem2d + */ + fill: FillStyle; + /** + * + * @type {Vector2} + * @memberof LineItem2d + */ + startPosition: Vector2; + /** + * + * @type {Vector2} + * @memberof LineItem2d + */ + endPosition: Vector2; + /** + * + * @type {ArrowEndShape | CircleEndShape | DashEndShape} + * @memberof LineItem2d + */ + startShape?: ArrowEndShape | CircleEndShape | DashEndShape; + /** + * + * @type {ArrowEndShape | CircleEndShape | DashEndShape} + * @memberof LineItem2d + */ + endShape?: ArrowEndShape | CircleEndShape | DashEndShape; +} + +export const LineItem2dTypeEnum = { + LineItem2d: 'line-item-2d', +} as const; + +export type LineItem2dTypeEnum = + (typeof LineItem2dTypeEnum)[keyof typeof LineItem2dTypeEnum]; + /** * * @export @@ -4840,14 +5329,59 @@ export interface OrthographicCamera { * @type {Vector3} * @memberof OrthographicCamera */ - up: Vector3; + up: Vector3; + /** + * + * @type {number} + * @memberof OrthographicCamera + */ + fovHeight: number; +} +/** + * + * @export + * @interface OvalItem2d + */ +export interface OvalItem2d { + /** + * + * @type {string} + * @memberof OvalItem2d + */ + type: OvalItem2dTypeEnum; + /** + * + * @type {StrokeStyle} + * @memberof OvalItem2d + */ + stroke: StrokeStyle; + /** + * + * @type {FillStyle} + * @memberof OvalItem2d + */ + fill: FillStyle; + /** + * + * @type {Vector2} + * @memberof OvalItem2d + */ + topLeft: Vector2; /** * - * @type {number} - * @memberof OrthographicCamera + * @type {Vector2} + * @memberof OvalItem2d */ - fovHeight: number; + bottomRight: Vector2; } + +export const OvalItem2dTypeEnum = { + OvalItem2d: 'oval-item-2d', +} as const; + +export type OvalItem2dTypeEnum = + (typeof OvalItem2dTypeEnum)[keyof typeof OvalItem2dTypeEnum]; + /** * * @export @@ -5738,6 +6272,51 @@ export interface PerspectiveCamera { */ fovY?: number; } +/** + * + * @export + * @interface PinItem2d + */ +export interface PinItem2d { + /** + * + * @type {string} + * @memberof PinItem2d + */ + type: PinItem2dTypeEnum; + /** + * + * @type {Color3} + * @memberof PinItem2d + */ + primaryColor: Color3; + /** + * + * @type {Color3} + * @memberof PinItem2d + */ + accentColor: Color3; + /** + * + * @type {Vector3} + * @memberof PinItem2d + */ + position: Vector3; + /** + * ID of the resource. + * @type {string} + * @memberof PinItem2d + */ + sceneItemId?: string; +} + +export const PinItem2dTypeEnum = { + PinItem2d: 'pin-item-2d', +} as const; + +export type PinItem2dTypeEnum = + (typeof PinItem2dTypeEnum)[keyof typeof PinItem2dTypeEnum]; + /** * * @export @@ -6842,6 +7421,12 @@ export interface ReplyDataAttributes { * @memberof ReplyDataAttributes */ isDrafting: boolean; + /** + * + * @type {SceneReference} + * @memberof ReplyDataAttributes + */ + reference?: SceneReference; } /** * @@ -7983,6 +8568,12 @@ export interface SceneReference { * @memberof SceneReference */ thumbnails: Array; + /** + * ID of the resource. + * @type {string} + * @memberof SceneReference + */ + canvasId?: string; } export const SceneReferenceTypeEnum = { @@ -8434,6 +9025,12 @@ export interface SceneViewStateData { * @memberof SceneViewStateData */ attributes: SceneViewStateDataAttributes; + /** + * + * @type {SceneViewStateDataRelationships} + * @memberof SceneViewStateData + */ + relationships?: SceneViewStateDataRelationships; /** * * @type {{ [key: string]: Link; }} @@ -8490,6 +9087,19 @@ export interface SceneViewStateDataAttributes { */ suppliedId?: string; } +/** + * + * @export + * @interface SceneViewStateDataRelationships + */ +export interface SceneViewStateDataRelationships { + /** + * + * @type {CanvasRelationship} + * @memberof SceneViewStateDataRelationships + */ + canvas?: CanvasRelationship; +} /** * * @export @@ -8830,6 +9440,25 @@ export interface StreamKeyList { */ links: { [key: string]: Link }; } +/** + * + * @export + * @interface StrokeStyle + */ +export interface StrokeStyle { + /** + * + * @type {Color3} + * @memberof StrokeStyle + */ + color: Color3; + /** + * A numerical floating-point value. + * @type {number} + * @memberof StrokeStyle + */ + thickness: number; +} /** * * @export @@ -10066,10 +10695,29 @@ export interface UpdateSceneViewStateRequestData { type: string; /** * - * @type {CreateSceneViewStateRequestDataAttributes} + * @type {UpdateSceneViewStateRequestDataAttributes} * @memberof UpdateSceneViewStateRequestData */ - attributes: CreateSceneViewStateRequestDataAttributes; + attributes: UpdateSceneViewStateRequestDataAttributes; +} +/** + * + * @export + * @interface UpdateSceneViewStateRequestDataAttributes + */ +export interface UpdateSceneViewStateRequestDataAttributes { + /** + * + * @type {string} + * @memberof UpdateSceneViewStateRequestDataAttributes + */ + name?: string; + /** + * ID provided for correlation. For example, an existing ID from a PLM system. + * @type {string} + * @memberof UpdateSceneViewStateRequestDataAttributes + */ + suppliedId?: string; } /** * @@ -10577,6 +11225,25 @@ export const UserRelationshipDataTypeEnum = { export type UserRelationshipDataTypeEnum = (typeof UserRelationshipDataTypeEnum)[keyof typeof UserRelationshipDataTypeEnum]; +/** + * 2D Vector. + * @export + * @interface Vector2 + */ +export interface Vector2 { + /** + * x-axis coordinate. + * @type {number} + * @memberof Vector2 + */ + x: number; + /** + * y-axis coordinate. + * @type {number} + * @memberof Vector2 + */ + y: number; +} /** * 3D vector. * @export @@ -11182,6 +11849,39 @@ export interface WebhookSubscriptionList { */ links: { [key: string]: Link }; } +/** + * + * @export + * @interface WithCanvas + */ +export interface WithCanvas { + /** + * + * @type {string} + * @memberof WithCanvas + */ + type: WithCanvasTypeEnum; + /** + * + * @type {CanvasDocument} + * @memberof WithCanvas + */ + document: CanvasDocument; + /** + * + * @type {string} + * @memberof WithCanvas + */ + suppliedId?: string; +} + +export const WithCanvasTypeEnum = { + WithCanvas: 'with-canvas', +} as const; + +export type WithCanvasTypeEnum = + (typeof WithCanvasTypeEnum)[keyof typeof WithCanvasTypeEnum]; + /** * * @export @@ -11254,6 +11954,12 @@ export interface WithSceneViewId { * @memberof WithSceneViewId */ sceneViewId: string; + /** + * + * @type {WithCanvas} + * @memberof WithSceneViewId + */ + withCanvas?: WithCanvas; } export const WithSceneViewIdTypeEnum = { @@ -13831,6 +14537,166 @@ 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 diff --git a/client/version.ts b/client/version.ts index 70daa2e..9cde9ef 100644 --- a/client/version.ts +++ b/client/version.ts @@ -1 +1 @@ -export const version = '0.36.0'; +export const version = '0.37.0'; diff --git a/package.json b/package.json index 2946b6d..18d3fe5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vertexvis/api-client-node", - "version": "0.36.0", + "version": "0.37.0", "description": "The Vertex REST API client for Node.js.", "license": "MIT", "author": "Vertex Developers (https://developer.vertexvis.com)", diff --git a/spec.yml b/spec.yml index 33210fc..b9d78b5 100644 --- a/spec.yml +++ b/spec.yml @@ -31,6 +31,7 @@ tags: - description: Requires Engage Module name: attachments - name: batches + - name: canvases - description: Requires Engage Module name: collaboration-contexts - name: exports @@ -1191,6 +1192,65 @@ 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 @@ -10840,6 +10900,15 @@ components: schema: $ref: '#/components/schemas/Vector3' style: deepObject + CanvasId: + description: The `canvas` ID. + explode: false + in: path + name: id + required: true + schema: + $ref: '#/components/schemas/Uuid' + style: simple CollaborationContextId: description: The `collaboration-context` ID. explode: false @@ -11828,6 +11897,18 @@ 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: @@ -13417,9 +13498,12 @@ components: type: string attributes: $ref: '#/components/schemas/AttachmentData_attributes' + relationships: + $ref: '#/components/schemas/AttachmentData_relationships' required: - attributes - id + - relationships - type type: object WithFileContent: @@ -13560,6 +13644,30 @@ 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: @@ -14826,6 +14934,8 @@ components: type: string attributes: $ref: '#/components/schemas/SceneViewStateData_attributes' + relationships: + $ref: '#/components/schemas/SceneViewStateData_relationships' links: additionalProperties: $ref: '#/components/schemas/Link' @@ -14835,6 +14945,24 @@ components: - id - type type: object + WithCanvas: + additionalProperties: false + properties: + type: + enum: + - with-canvas + type: string + document: + $ref: '#/components/schemas/CanvasDocument' + suppliedId: + example: some-string + maxLength: 1024 + minLength: 1 + type: string + required: + - document + - type + type: object SceneViewRelationship: additionalProperties: false description: Relationship to a `scene-view`. @@ -15388,6 +15516,44 @@ components: - status - type type: object + AttachmentRelationship: + additionalProperties: false + properties: + data: + $ref: '#/components/schemas/AttachmentRelationship_data' + required: + - data + type: object + CanvasDocument: + additionalProperties: false + properties: + type: + enum: + - 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`. @@ -15411,6 +15577,8 @@ components: format: uuid maxLength: 36 type: string + withCanvas: + $ref: '#/components/schemas/WithCanvas' required: - sceneViewId - type @@ -15465,6 +15633,12 @@ components: items: $ref: '#/components/schemas/ThumbnailData' type: array + canvasId: + description: ID of the resource. + example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3 + format: uuid + maxLength: 36 + type: string required: - sceneId - thumbnails @@ -16104,6 +16278,15 @@ components: - color - width type: object + CanvasRelationship: + additionalProperties: false + description: Relationship to a `canvas`. + properties: + data: + $ref: '#/components/schemas/CanvasRelationshipData' + required: + - data + type: object HexColor: description: A hex color value. example: '#FFFFFF' @@ -16287,6 +16470,144 @@ 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/Color3' + accentColor: + $ref: '#/components/schemas/Color3' + text: + example: some-string + maxLength: 1024 + minLength: 1 + 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/Color3' + accentColor: + $ref: '#/components/schemas/Color3' + 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 SelectFileById: additionalProperties: false description: Queries a file by its unique ID. @@ -16407,6 +16728,26 @@ components: maximum: 255 minimum: 0 type: integer + CanvasRelationshipData: + additionalProperties: false + properties: + type: + description: Resource object type. + enum: + - canvas + example: canvas + maxLength: 32 + 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 RelationshipLinks: additionalProperties: false example: @@ -16418,6 +16759,94 @@ components: required: - related type: object + StrokeStyle: + additionalProperties: false + properties: + color: + $ref: '#/components/schemas/Color3' + thickness: + description: A numerical floating-point value. + type: number + required: + - color + - thickness + type: object + FillStyle: + additionalProperties: false + properties: + color: + $ref: '#/components/schemas/Color3' + required: + - color + type: object + Vector2: + additionalProperties: false + description: 2D Vector. + properties: + x: + description: x-axis coordinate. + example: 1.0 + type: number + y: + description: y-axis coordinate. + example: 0.0 + type: number + required: + - x + - 'y' + type: object + ArrowEndShape: + additionalProperties: false + properties: + type: + enum: + - arrow-end + type: string + width: + description: A numerical floating-point value. + type: number + filled: + description: Indicates if the arrow end should be filled. + type: boolean + required: + - filled + - type + - width + type: object + CircleEndShape: + additionalProperties: false + properties: + type: + enum: + - circle-end + type: string + diameter: + description: A numerical floating-point value for the diameter of the end. + type: number + filled: + description: Indicates if the circle end should be filled. + type: boolean + required: + - diameter + - filled + - type + type: object + DashEndShape: + additionalProperties: false + properties: + type: + enum: + - dash-end + type: string + width: + description: + A numerical floating-point value indicating the width of the + dash. + type: number + required: + - type + - width + type: object CreateAccountRequest_data_attributes: properties: name: @@ -17021,6 +17450,11 @@ components: type: string isDrafting: type: boolean + reference: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/CreateSceneReference' required: - body type: object @@ -17855,6 +18289,8 @@ components: example: PN12345 maxLength: 1024 type: string + withCanvas: + $ref: '#/components/schemas/WithCanvas' type: object CreateSceneViewStateRequest_data_relationships: properties: @@ -17881,6 +18317,21 @@ components: - relationships - type type: object + UpdateSceneViewStateRequest_data_attributes: + properties: + name: + example: some-string + maxLength: 1024 + minLength: 1 + type: string + suppliedId: + description: + ID provided for correlation. For example, an existing ID from + a PLM system. + example: PN12345 + maxLength: 1024 + type: string + type: object UpdateSceneViewStateRequest_data: properties: type: @@ -17889,7 +18340,7 @@ components: maxLength: 32 type: string attributes: - $ref: '#/components/schemas/CreateSceneViewStateRequest_data_attributes' + $ref: '#/components/schemas/UpdateSceneViewStateRequest_data_attributes' required: - attributes - type @@ -18367,6 +18818,11 @@ components: - content - thumbnails type: object + AttachmentData_relationships: + properties: + relationship: + $ref: '#/components/schemas/AttachmentRelationship' + type: object PresignedUrlData_attributes: properties: uri: @@ -18414,6 +18870,28 @@ 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: @@ -18607,6 +19085,11 @@ components: isDrafting: description: Indicates whether or not the thread is in a drafted state type: boolean + reference: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/SceneReference' required: - body - createdAt @@ -19264,6 +19747,11 @@ components: minLength: 1 type: string type: object + SceneViewStateData_relationships: + properties: + canvas: + $ref: '#/components/schemas/CanvasRelationship' + type: object SceneViewRelationship_data: properties: type: @@ -19516,6 +20004,23 @@ components: - topics - url type: object + AttachmentRelationship_data: + properties: + type: + enum: + - thread + - reply + 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 AccountRelationship_data: properties: type: