Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

[TypeDoc Documentation](https://vertexvis.github.io/vertex-api-client-node/)

If you're ready to integrate Vertex into your application, this is the place! For more background on the Vertex platform, start with our [Developer Portal](https://developer.vertexvis.com/).
If you're ready to integrate Vertex into your application, this is the place! For more background on the Vertex platform, start with our [Developer Portal](https://developer.vertex3d.com/).

The Vertex REST API client for Node.js is generated using [`openapi-generator`](https://github.com/OpenAPITools/openapi-generator), so it's always up-to-date. On top of the generated code, we've added a higher-level client and helpers in the `./client` directory.

Expand Down
88 changes: 44 additions & 44 deletions api.ts

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
/* eslint-disable */
/**
* Vertex Platform API
* The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application. See our [Developer Guides](https://developer.vertexvis.com/docs/guides/render-your-first-scene) to get started. Notes about the Postman collection and API Reference code samples: - They include all required and optional body parameters for completeness. Remove any optional parameters as desired. - They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
* The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application. See our [Developer Guides](https://developer.vertex3d.com/docs/guides/render-your-first-scene) to get started. Notes about the Postman collection and API Reference code samples: - They include all required and optional body parameters for completeness. Remove any optional parameters as desired. - They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
*
* The version of the OpenAPI document: 1.0
* Contact: support@vertexvis.com
* Contact: support@vertex3d.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
Expand Down
4 changes: 2 additions & 2 deletions client/vertex-client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ const SecToMs = 1000;
* main();
* ```
*
* @see {@link https://developer.vertexvis.com/docs/guides|Developer Guides} to get started.
* @see {@link https://developer.vertex3d.com/docs/guides|Developer Guides} to get started.
*/
export class VertexClient {
public accounts: AccountsApi;
Expand Down Expand Up @@ -268,7 +268,7 @@ export class VertexClient {
throw new Error(
'@vertexvis/api-client-node is not supported in browser environments. ' +
'For details on how your application should communicate with the ' +
'Vertex platform, visit https://developer.vertexvis.com/docs/guides/platform-architecture.'
'Vertex platform, visit https://developer.vertex3d.com/docs/guides/platform-architecture.'
);
}

Expand Down
4 changes: 2 additions & 2 deletions common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
/* eslint-disable */
/**
* Vertex Platform API
* The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application. See our [Developer Guides](https://developer.vertexvis.com/docs/guides/render-your-first-scene) to get started. Notes about the Postman collection and API Reference code samples: - They include all required and optional body parameters for completeness. Remove any optional parameters as desired. - They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
* The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application. See our [Developer Guides](https://developer.vertex3d.com/docs/guides/render-your-first-scene) to get started. Notes about the Postman collection and API Reference code samples: - They include all required and optional body parameters for completeness. Remove any optional parameters as desired. - They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
*
* The version of the OpenAPI document: 1.0
* Contact: support@vertexvis.com
* Contact: support@vertex3d.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
Expand Down
4 changes: 2 additions & 2 deletions configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
/* eslint-disable */
/**
* Vertex Platform API
* The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application. See our [Developer Guides](https://developer.vertexvis.com/docs/guides/render-your-first-scene) to get started. Notes about the Postman collection and API Reference code samples: - They include all required and optional body parameters for completeness. Remove any optional parameters as desired. - They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
* The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application. See our [Developer Guides](https://developer.vertex3d.com/docs/guides/render-your-first-scene) to get started. Notes about the Postman collection and API Reference code samples: - They include all required and optional body parameters for completeness. Remove any optional parameters as desired. - They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
*
* The version of the OpenAPI document: 1.0
* Contact: support@vertexvis.com
* Contact: support@vertex3d.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.42.3",
"description": "The Vertex REST API client for Node.js.",
"license": "MIT",
"author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
"author": "Vertex Developers <support@vertex3d.com> (https://developer.vertex3d.com)",
"homepage": "https://github.com/Vertexvis/vertex-api-client-node#readme",
"repository": {
"type": "git",
Expand Down
34 changes: 17 additions & 17 deletions spec.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
openapi: 3.0.3
info:
contact:
email: support@vertexvis.com
email: support@vertex3d.com
name: Vertex API support
url: https://developer.vertexvis.com/docs/support
url: https://developer.vertex3d.com/docs/support
description: |
The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application.

See our [Developer Guides](https://developer.vertexvis.com/docs/guides/render-your-first-scene) to get started.
See our [Developer Guides](https://developer.vertex3d.com/docs/guides/render-your-first-scene) to get started.

Notes about the Postman collection and API Reference code samples:
- They include all required and optional body parameters for completeness. Remove any optional parameters as desired.
- They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
termsOfService: https://vertexvis.com/terms-of-use
termsOfService: https://vertex3d.com/terms-of-use
title: Vertex Platform API
version: '1.0'
x-logo:
Expand All @@ -21,7 +21,7 @@ info:
altText: Vertex Software
externalDocs:
description: Getting started guides
url: https://developer.vertexvis.com/docs/guides/render-your-first-scene
url: https://developer.vertex3d.com/docs/guides/render-your-first-scene
servers:
- url: https://platform.vertexvis.com
- url: https://platform.platdev.vertexvis.io
Expand Down Expand Up @@ -2078,7 +2078,7 @@ paths:
post:
description:
Create a `file`. Once created, upload file content via the uploadFile
API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api)
API. For details including supported file formats, see our [Import data](https://developer.vertex3d.com/docs/guides/import-data-with-api)
guide.
operationId: createFile
requestBody:
Expand Down Expand Up @@ -3325,7 +3325,7 @@ paths:
post:
description:
Create a `geometry-set`. Once created, create scenes via the createScene
API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api)
API. For details, see our [Import data](https://developer.vertex3d.com/docs/guides/import-data-with-api)
guide.
operationId: createGeometrySet
requestBody:
Expand Down Expand Up @@ -3983,7 +3983,7 @@ paths:
/oauth2/token:
post:
description:
Create an OAuth2 access token. For details, see our [Authentication](https://developer.vertexvis.com/docs/guides/authentication)
Create an OAuth2 access token. For details, see our [Authentication](https://developer.vertex3d.com/docs/guides/authentication)
guide.
operationId: createToken
requestBody:
Expand Down Expand Up @@ -5048,7 +5048,7 @@ paths:
likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the
existing part.

See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more
See our [Import Data](https://developer.vertex3d.com/docs/guides/import-data-with-api) guides for more
information.
operationId: createPart
requestBody:
Expand Down Expand Up @@ -6773,7 +6773,7 @@ paths:
Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`.
Provide an existing `scene` using `relationship.source` to clone it.
Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root.
This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes) guide.
operationId: createSceneItem
parameters:
- description: The `scene` ID.
Expand Down Expand Up @@ -6867,7 +6867,7 @@ paths:
Get a `queued-scene-item`. The response is either the status if
`running` or `error` or, upon completion, redirects to the created `scene-item`.
Once created, commit the scene via the updateScene API. For details, see our
[Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes)
[Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes)
guide.
operationId: getQueuedSceneItem
parameters:
Expand Down Expand Up @@ -7654,7 +7654,7 @@ paths:
post:
description:
Create a `scene`. Once created, add scene items via the createSceneItem
API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes)
API. For details, see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes)
guide.
operationId: createScene
requestBody:
Expand Down Expand Up @@ -7841,7 +7841,7 @@ paths:
description:
Update a `scene` camera and/or state. Once updated, view the scene
via the renderScene API or with the Viewer SDK. For details, see our [Render
static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes)
static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes)
guide.
operationId: updateScene
parameters:
Expand Down Expand Up @@ -9481,7 +9481,7 @@ paths:
Get a `queued-translation-job`. The response is either the status
if `running` or `error` or, upon completion, the `part-revision` that was
created. Once created, create scenes via the createScene API. For details,
see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes)
see our [Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes)
guide.
operationId: getQueuedTranslationJob
parameters:
Expand Down Expand Up @@ -9636,7 +9636,7 @@ paths:
- Get a `queued-translation`. The response is either the status if `running`
or `error` or, upon completion, redirects to the created `part-revision`.
Once created, create scenes via the createScene API. For details, see our
[Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes)
[Render static scenes](https://developer.vertex3d.com/docs/guides/render-static-scenes)
guide.
operationId: getQueuedTranslation
parameters:
Expand Down Expand Up @@ -14883,7 +14883,7 @@ components:
Matrix4Nullable:
additionalProperties: false
description:
4x4 affine transformation matrix, see [Matrix transformations](https://developer.vertexvis.com/docs/guides/matrix-transformations)
4x4 affine transformation matrix, see [Matrix transformations](https://developer.vertex3d.com/docs/guides/matrix-transformations)
for details.
example:
r0:
Expand Down Expand Up @@ -14986,7 +14986,7 @@ components:
Matrix4:
additionalProperties: false
description:
4x4 affine transformation matrix, see [Matrix transformations](https://developer.vertexvis.com/docs/guides/matrix-transformations)
4x4 affine transformation matrix, see [Matrix transformations](https://developer.vertex3d.com/docs/guides/matrix-transformations)
for details.
example:
r0:
Expand Down
Loading