AccountsApi - axios parameter creator
Create an account
.
Create an application
for an account
.
The `account` ID.
Delete an account
.
The `account` ID.
Get an account
.
The `account` ID.
Update an account
.
The `account` ID.
AccountsApi - factory interface
Create an account
.
Create an application
for an account
.
The `account` ID.
Delete an account
.
The `account` ID.
Get an account
.
The `account` ID.
Update an account
.
The `account` ID.
AccountsApi - functional programming interface
Create an account
.
Create an application
for an account
.
The `account` ID.
Delete an account
.
The `account` ID.
Get an account
.
The `account` ID.
Update an account
.
The `account` ID.
ApplicationsApi - axios parameter creator
Create an OAuth2 application
.
Delete an application
.
The `application` ID.
Get an application
.
The `application` ID.
Get applications
.
Update an application
.
The `application` ID.
ApplicationsApi - factory interface
Create an OAuth2 application
.
Delete an application
.
The `application` ID.
Get an application
.
The `application` ID.
Get applications
.
Update an application
.
The `application` ID.
ApplicationsApi - functional programming interface
Create an OAuth2 application
.
Delete an application
.
The `application` ID.
Get an application
.
The `application` ID.
Get applications
.
Update an application
.
The `application` ID.
BatchesApi - axios parameter creator
Create a batch
. This API is asynchronous, returning the location of a queued-batch
. Check the status via the getQueuedBatch API.
Get a batch
by ID.
The `file` ID.
Get a queued-batch
. The response is either the status if running
or error
or, upon completion, redirects to the created batch
.
The `queued-batch` ID.
BatchesApi - factory interface
Create a batch
. This API is asynchronous, returning the location of a queued-batch
. Check the status via the getQueuedBatch API.
Get a batch
by ID.
The `file` ID.
Get a queued-batch
. The response is either the status if running
or error
or, upon completion, redirects to the created batch
.
The `queued-batch` ID.
BatchesApi - functional programming interface
Create a batch
. This API is asynchronous, returning the location of a queued-batch
. Check the status via the getQueuedBatch API.
Get a batch
by ID.
The `file` ID.
Get a queued-batch
. The response is either the status if running
or error
or, upon completion, redirects to the created batch
.
The `queued-batch` ID.
ExportsApi - axios parameter creator
Create an export
. This API is asynchronous, returning the location of a queued-export
. Check the status via the getQueuedExport API.
Get an export
by ID.
The `export` ID.
Get a queued-export
. The response is either the status if running
or error
or, upon completion, redirects to the created export
.
The `queued-export` ID.
ExportsApi - factory interface
Create an export
. This API is asynchronous, returning the location of a queued-export
. Check the status via the getQueuedExport API.
Get an export
by ID.
The `export` ID.
Get a queued-export
. The response is either the status if running
or error
or, upon completion, redirects to the created export
.
The `queued-export` ID.
ExportsApi - functional programming interface
Create an export
. This API is asynchronous, returning the location of a queued-export
. Check the status via the getQueuedExport API.
Get an export
by ID.
The `export` ID.
Get a queued-export
. The response is either the status if running
or error
or, upon completion, redirects to the created export
.
The `queued-export` ID.
FilesApi - axios parameter creator
Create a file
. Once created, upload file content via the uploadFile API. For details including supported file formats, see our Import data guide.
Delete a file
.
The `file` ID.
Get a file
by ID.
The `file` ID.
Get files
.
Upload a file
. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
The `file` ID.
FilesApi - factory interface
Create a file
. Once created, upload file content via the uploadFile API. For details including supported file formats, see our Import data guide.
Delete a file
.
The `file` ID.
Get a file
by ID.
The `file` ID.
Get files
.
Upload a file
. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
The `file` ID.
FilesApi - functional programming interface
Create a file
. Once created, upload file content via the uploadFile API. For details including supported file formats, see our Import data guide.
Delete a file
.
The `file` ID.
Get a file
by ID.
The `file` ID.
Get files
.
Upload a file
. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
The `file` ID.
GeometrySetsApi - axios parameter creator
Create a geometry-set
. Once created, create scenes via the createScene API. For details, see our Import data guide.
Get a geometry-set
by ID.
The `geometry-set` ID.
Get geometry-sets
.
GeometrySetsApi - factory interface
Create a geometry-set
. Once created, create scenes via the createScene API. For details, see our Import data guide.
Get a geometry-set
by ID.
The `geometry-set` ID.
Get geometry-sets
.
GeometrySetsApi - functional programming interface
Create a geometry-set
. Once created, create scenes via the createScene API. For details, see our Import data guide.
Get a geometry-set
by ID.
The `geometry-set` ID.
Get geometry-sets
.
HitsApi - axios parameter creator
Create a hit
for a scene
.
The `scene` ID.
Create a hit
for a scene-view
.
The `scene-view` ID.
HitsApi - factory interface
Create a hit
for a scene
.
The `scene` ID.
Create a hit
for a scene-view
.
The `scene-view` ID.
HitsApi - functional programming interface
Create a hit
for a scene
.
The `scene` ID.
Create a hit
for a scene-view
.
The `scene-view` ID.
Oauth2Api - axios parameter creator
Accept Consent Challenge to login.
Challenge ID from oauth2 flow
Accept Login Challenge with subject & login challenge
Login Challenge ID from oauth2 flow
Create an OAuth2 access token. For details, see our Authentication guide.
Revoke an OAuth2 access token.
Oauth2Api - factory interface
Accept Consent Challenge to login.
Challenge ID from oauth2 flow
Accept Login Challenge with subject & login challenge
Login Challenge ID from oauth2 flow
Create an OAuth2 access token. For details, see our Authentication guide.
Revoke an OAuth2 access token.
Oauth2Api - functional programming interface
Accept Consent Challenge to login.
Challenge ID from oauth2 flow
Accept Login Challenge with subject & login challenge
Login Challenge ID from oauth2 flow
Create an OAuth2 access token. For details, see our Authentication guide.
Revoke an OAuth2 access token.
PartRevisionsApi - axios parameter creator
Delete a part-revision
.
The `part-revision` ID.
Get a part-revision
by ID.
The `part-revision` ID.
Get part-revisions
for a part
.
The `part` ID.
Get a queued-part-revision-deletion
by ID.
The `queued-part-revision-deletion` ID.
Get a rendered image of a part-revision
.
The `part-revision` ID.
Update a part-revision
. When given a file
relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, indexMetadata
, name
, suppliedIdKey
, suppliedRevisionIdKey
, and suppliedInstanceIdKey
. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
The `part-revision` ID.
PartRevisionsApi - factory interface
Delete a part-revision
.
The `part-revision` ID.
Get a part-revision
by ID.
The `part-revision` ID.
Get part-revisions
for a part
.
The `part` ID.
Get a queued-part-revision-deletion
by ID.
The `queued-part-revision-deletion` ID.
Get a rendered image of a part-revision
.
The `part-revision` ID.
Update a part-revision
. When given a file
relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, indexMetadata
, name
, suppliedIdKey
, suppliedRevisionIdKey
, and suppliedInstanceIdKey
. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
The `part-revision` ID.
PartRevisionsApi - functional programming interface
Delete a part-revision
.
The `part-revision` ID.
Get a part-revision
by ID.
The `part-revision` ID.
Get part-revisions
for a part
.
The `part` ID.
Get a queued-part-revision-deletion
by ID.
The `queued-part-revision-deletion` ID.
Get a rendered image of a part-revision
.
The `part-revision` ID.
Update a part-revision
. When given a file
relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, indexMetadata
, name
, suppliedIdKey
, suppliedRevisionIdKey
, and suppliedInstanceIdKey
. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
The `part-revision` ID.
PartsApi - axios parameter creator
Create a part
. This endpoint includes multiple successful response codes: [201
, 202
]. When not given a relationship, this endpoint will create a part with an empty part revision and return a 201
status code of the part. When given a relationship to translate, this endpoint will return a 202
status code with the location of a queued-translation
. The status of the translation can be queried via getQueuedTranslation
. After the translation is complete, a part
and part-revision
that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for my-part-id
, 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 guides for more information.
Delete a part
.
The `part` ID.
Get a part
by ID.
The `part` ID.
Get parts
.
Get a queued-part-deletion
by ID.
The `queued-part-deletion` ID.
PartsApi - factory interface
Create a part
. This endpoint includes multiple successful response codes: [201
, 202
]. When not given a relationship, this endpoint will create a part with an empty part revision and return a 201
status code of the part. When given a relationship to translate, this endpoint will return a 202
status code with the location of a queued-translation
. The status of the translation can be queried via getQueuedTranslation
. After the translation is complete, a part
and part-revision
that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for my-part-id
, 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 guides for more information.
Delete a part
.
The `part` ID.
Get a part
by ID.
The `part` ID.
Get parts
.
Get a queued-part-deletion
by ID.
The `queued-part-deletion` ID.
PartsApi - functional programming interface
Create a part
. This endpoint includes multiple successful response codes: [201
, 202
]. When not given a relationship, this endpoint will create a part with an empty part revision and return a 201
status code of the part. When given a relationship to translate, this endpoint will return a 202
status code with the location of a queued-translation
. The status of the translation can be queried via getQueuedTranslation
. After the translation is complete, a part
and part-revision
that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for my-part-id
, 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 guides for more information.
Delete a part
.
The `part` ID.
Get a part
by ID.
The `part` ID.
Get parts
.
Get a queued-part-deletion
by ID.
The `queued-part-deletion` ID.
SceneAlterationsApi - axios parameter creator
Create a scene-alteration
for a scene-view
.
The `scene-view` ID.
Get a queued-scene-alteration
by ID.
The `queued-scene-alteration` ID.
Get a scene-alteration
by ID.
The `scene-alteration` ID.
Get scene-alterations
for a scene-view
.
The `scene-view` ID.
SceneAlterationsApi - factory interface
Create a scene-alteration
for a scene-view
.
The `scene-view` ID.
Get a queued-scene-alteration
by ID.
The `queued-scene-alteration` ID.
Get a scene-alteration
by ID.
The `scene-alteration` ID.
Get scene-alterations
for a scene-view
.
The `scene-view` ID.
SceneAlterationsApi - functional programming interface
Create a scene-alteration
for a scene-view
.
The `scene-view` ID.
Get a queued-scene-alteration
by ID.
The `queued-scene-alteration` ID.
Get a scene-alteration
by ID.
The `scene-alteration` ID.
Get scene-alterations
for a scene-view
.
The `scene-view` ID.
SceneItemOverridesApi - axios parameter creator
Create a scene-item-override
for a scene-view
.
The `scene-view` ID.
Delete a scene-item-override
.
The `scene-item-override` ID.
Get scene-item-overrides
for a scene-view
.
The `scene-view` ID.
Update a scene-item-override
.
The `scene-item-override` ID.
SceneItemOverridesApi - factory interface
Create a scene-item-override
for a scene-view
.
The `scene-view` ID.
Delete a scene-item-override
.
The `scene-item-override` ID.
Get scene-item-overrides
for a scene-view
.
The `scene-view` ID.
Update a scene-item-override
.
The `scene-item-override` ID.
SceneItemOverridesApi - functional programming interface
Create a scene-item-override
for a scene-view
.
The `scene-view` ID.
Delete a scene-item-override
.
The `scene-item-override` ID.
Get scene-item-overrides
for a scene-view
.
The `scene-view` ID.
Update a scene-item-override
.
The `scene-item-override` ID.
SceneItemsApi - axios parameter creator
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 guide.
The `scene` ID.
Delete a scene-item
.
The `scene-item` ID.
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 guide.
The `queued-scene-item` ID.
Get a queued-scene-item-deletion
by ID.
The `queued-scene-item-deletion` ID.
Get a scene-item
by ID.
The `scene-item` ID.
Get scene-items
for a scene
.
The `scene` ID.
Update a scene-item
.
The `scene-item` ID.
SceneItemsApi - factory interface
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 guide.
The `scene` ID.
Delete a scene-item
.
The `scene-item` ID.
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 guide.
The `queued-scene-item` ID.
Get a queued-scene-item-deletion
by ID.
The `queued-scene-item-deletion` ID.
Get a scene-item
by ID.
The `scene-item` ID.
Get scene-items
for a scene
.
The `scene` ID.
Update a scene-item
.
The `scene-item` ID.
SceneItemsApi - functional programming interface
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 guide.
The `scene` ID.
Delete a scene-item
.
The `scene-item` ID.
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 guide.
The `queued-scene-item` ID.
Get a queued-scene-item-deletion
by ID.
The `queued-scene-item-deletion` ID.
Get a scene-item
by ID.
The `scene-item` ID.
Get scene-items
for a scene
.
The `scene` ID.
Update a scene-item
.
The `scene-item` ID.
SceneViewStatesApi - axios parameter creator
Create a scene-view-state
for a scene
.
The `scene` ID.
Delete a scene-view-state
.
The `scene-view-state` ID.
Get a scene-view-state
by ID.
The `scene-view-state` ID.
Get scene-view-states
for a scene
.
The `scene` ID.
Update a scene-view-state
.
The `scene-view-state` ID.
SceneViewStatesApi - factory interface
Create a scene-view-state
for a scene
.
The `scene` ID.
Delete a scene-view-state
.
The `scene-view-state` ID.
Get a scene-view-state
by ID.
The `scene-view-state` ID.
Get scene-view-states
for a scene
.
The `scene` ID.
Update a scene-view-state
.
The `scene-view-state` ID.
SceneViewStatesApi - functional programming interface
Create a scene-view-state
for a scene
.
The `scene` ID.
Delete a scene-view-state
.
The `scene-view-state` ID.
Get a scene-view-state
by ID.
The `scene-view-state` ID.
Get scene-view-states
for a scene
.
The `scene` ID.
Update a scene-view-state
.
The `scene-view-state` ID.
SceneViewsApi - axios parameter creator
Create a scene-view
of a scene
.
The `scene` ID.
Delete a scene-view
.
The `scene-view` ID.
Get a scene-view
by ID.
The `scene-view` ID.
Get scene-view
s for a scene
.
The `scene` ID.
Get a scene-item
within a view by ID.
The `scene-view` ID.
The `scene-item` ID.
Get a rendered image of a scene-view
. If a single pixel is returned, ensure the scene
is in the commit
state and contains scene items.
The `scene-view` ID.
Update a scene-view
.
The `scene-view` ID.
SceneViewsApi - factory interface
Create a scene-view
of a scene
.
The `scene` ID.
Delete a scene-view
.
The `scene-view` ID.
Get a scene-view
by ID.
The `scene-view` ID.
Get scene-view
s for a scene
.
The `scene` ID.
Get a scene-item
within a view by ID.
The `scene-view` ID.
The `scene-item` ID.
Get a rendered image of a scene-view
. If a single pixel is returned, ensure the scene
is in the commit
state and contains scene items.
The `scene-view` ID.
Update a scene-view
.
The `scene-view` ID.
SceneViewsApi - functional programming interface
Create a scene-view
of a scene
.
The `scene` ID.
Delete a scene-view
.
The `scene-view` ID.
Get a scene-view
by ID.
The `scene-view` ID.
Get scene-view
s for a scene
.
The `scene` ID.
Get a scene-item
within a view by ID.
The `scene-view` ID.
The `scene-item` ID.
Get a rendered image of a scene-view
. If a single pixel is returned, ensure the scene
is in the commit
state and contains scene items.
The `scene-view` ID.
Update a scene-view
.
The `scene-view` ID.
ScenesApi - axios parameter creator
Create a scene
. Once created, add scene items via the createSceneItem API. For details, see our Render static scenes guide.
Delete a scene
.
The `scene` ID.
Get a queued-scene
.
The `scene` ID.
Get a scene
by ID.
The `scene` ID.
Get scenes
.
Get a rendered image of a scene
. If only a single pixel is returned, ensure the scene
is in the commit
state and contains scene items.
The `scene` ID.
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 guide.
The `scene` ID.
ScenesApi - factory interface
Create a scene
. Once created, add scene items via the createSceneItem API. For details, see our Render static scenes guide.
Delete a scene
.
The `scene` ID.
Get a queued-scene
.
The `scene` ID.
Get a scene
by ID.
The `scene` ID.
Get scenes
.
Get a rendered image of a scene
. If only a single pixel is returned, ensure the scene
is in the commit
state and contains scene items.
The `scene` ID.
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 guide.
The `scene` ID.
ScenesApi - functional programming interface
Create a scene
. Once created, add scene items via the createSceneItem API. For details, see our Render static scenes guide.
Delete a scene
.
The `scene` ID.
Get a queued-scene
.
The `scene` ID.
Get a scene
by ID.
The `scene` ID.
Get scenes
.
Get a rendered image of a scene
. If only a single pixel is returned, ensure the scene
is in the commit
state and contains scene items.
The `scene` ID.
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 guide.
The `scene` ID.
StreamKeysApi - axios parameter creator
Create a stream-key
for a scene
.
The `scene` ID.
Delete a stream-key
.
The `stream-key` ID.
Get stream-key
s.
StreamKeysApi - factory interface
Create a stream-key
for a scene
.
The `scene` ID.
Delete a stream-key
.
The `stream-key` ID.
Get stream-key
s.
StreamKeysApi - functional programming interface
Create a stream-key
for a scene
.
The `scene` ID.
Delete a stream-key
.
The `stream-key` ID.
Get stream-key
s.
TranslationInspectionsApi - axios parameter creator
Create a translation-inspection
.
Get a translation-inspection
by ID.
The `translation-inspection` ID.
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 guide.
The `queued-translation` ID.
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 guide.
The `queued-translation` ID.
Get queued-translation
s.
TranslationInspectionsApi - factory interface
Create a translation-inspection
.
Get a translation-inspection
by ID.
The `translation-inspection` ID.
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 guide.
The `queued-translation` ID.
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 guide.
The `queued-translation` ID.
Get queued-translation
s.
TranslationInspectionsApi - functional programming interface
Create a translation-inspection
.
Get a translation-inspection
by ID.
The `translation-inspection` ID.
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 guide.
The `queued-translation` ID.
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 guide.
The `queued-translation` ID.
Get queued-translation
s.
WebhookSubscriptionsApi - axios parameter creator
Create a webhook-subscription
Delete a webhook-subscription
.
The `webhook-subscription` ID.
Get a webhook-subscription
.
The `webhook-subscription` ID.
Get webhook-subscription
s.
Update a webhook-subscription
.
The `webhook-subscription` ID.
WebhookSubscriptionsApi - factory interface
Create a webhook-subscription
Delete a webhook-subscription
.
The `webhook-subscription` ID.
Get a webhook-subscription
.
The `webhook-subscription` ID.
Get webhook-subscription
s.
Update a webhook-subscription
.
The `webhook-subscription` ID.
WebhookSubscriptionsApi - functional programming interface
Create a webhook-subscription
Delete a webhook-subscription
.
The `webhook-subscription` ID.
Get a webhook-subscription
.
The `webhook-subscription` ID.
Get webhook-subscription
s.
Update a webhook-subscription
.
The `webhook-subscription` ID.
Split an array into a 2D array of chunkSize
chunks.
An array.
The number of chunks to split a
into.
A 2D number array.
Check for array equality.
A number array.
A number array.
true
if a
and b
are equal.
Check for 2D array equality.
A 2D number array.
A 2D number array.
true
if a
and b
are equal.
Create an export.
The CreateExportReq.
Create part and file resources if they don't already exist.
Create part and file resources if they don't already exist.
Create a scene with scene items.
Create a scene with scene items using experimental strategy.
Create a scene item.
The CreateSceneItemReq.
Create scene items within a scene.
Create scene items within a scene.
Create an OAuth2 token.
Whether or not a value is null or undefined.
Delay execution by the given milliseconds.
Amount of milliseconds to delay.
Delete all files.
URI encode given value if it isn't already.
value to encode.
Encoded value.
Call getter
and return item if suppliedId
matches.
Function called to get item.
ID to match.
Item if and only if it matches ID.
Get an Error message produced by VertexClient.
Get a page of results from a listing.
Function called to get list of items.
Page of results and optional cursor to get next page.
Get a part revision by supplied ID.
Group an array by the result of getKey
.
An array.
Function returning key to group the array by.
A 2D array.
Return the first item in an array.
An array.
The first item.
Check if array is the 4x4 identity matrix.
true
if 4x4 identity matrix.
Check if a value is URI encoded.
true
if URI encoded.
Check if webhook signature is valid.
body of webhook as string.
your webhook subscription secret.
signature from x-vertex-signature
header.
true
if webhook signature is valid and body is safe to parse.
Log an Error produced by VertexClient.
Matrix multiply two 2D arrays.
A 2D number array.
A 2D number array.
The 2D multiplied array.
Get the current epoch.
The current epoch.
Parse the query parameters from a URL.
A URL to parse.
Partition an array into two arrays, a and b, based on isA
predicate.
Poll getQueuedJob
until redirected to resulting resource, error
, or reach
polling.maxAttempts
.
Poll a scene until it reaches the ready state.
The PollSceneReadyReq.
Convert JavaScript object to a pretty JSON string.
A JavaScript object.
The pretty JSON format.
Render a part revision.
The RenderImageReq.
Render a scene.
The RenderImageReq.
Render a scene view.
The RenderImageReq.
Convert an orientation
, translation
, and scale
to a 4x4 transform.
The transform's orientation as a nine-element array.
The transform's translation as a three-element array.
The transform's scale.
A 4x4 transform.
Convert a comma-separated string to a float array.
A default to use if a
is undefined.
The value to convert.
A float array.
Try a request with a streaming response and handle errors.
Function with streaming response type.
Update a scene.
Create a file resource and upload a file.
The UploadFileReq.
Create a file resource and upload a file if it doesn't already exist.
The UploadFileReq.
Base paths for various Vertex environments.