@vertexvis/api-client-node 0.35.0 → 0.36.0

package/dist/cjs/api.d.ts

@@ -542,10 +542,10 @@ export interface AttachmentData {
 export interface AttachmentDataAttributes {
     /**
      * The underlying content of the attachment
-     * @type {FileAttachment | SceneViewStateAttachment}
+     * @type {FileAttachment}
      * @memberof AttachmentDataAttributes
      */
-    content: FileAttachment | SceneViewStateAttachment;
+    content: FileAttachment;
 }
 /**
  *
@@ -1177,10 +1177,10 @@ export declare type CreateAttachmentRequestDataTypeEnum = (typeof CreateAttachme
 export interface CreateAttachmentRequestDataAttributes {
     /**
      *
-     * @type {WithFileContent | WithSceneViewStateContent}
+     * @type {WithFileContent}
      * @memberof CreateAttachmentRequestDataAttributes
      */
-    withContent: WithFileContent | WithSceneViewStateContent;
+    withContent: WithFileContent;
 }
 /**
  *
@@ -3407,11 +3407,18 @@ export interface DownloadUrlData {
  */
 export interface DownloadUrlDataAttributes {
     /**
-     *
+     * Deprecated. Use `uri` instead.
      * @type {string}
      * @memberof DownloadUrlDataAttributes
+     * @deprecated
      */
     downloadUrl: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DownloadUrlDataAttributes
+     */
+    uri: string;
 }
 /**
  *
@@ -3662,6 +3669,24 @@ export interface FileAttachment {
      * @memberof FileAttachment
      */
     id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FileAttachment
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FileAttachment
+     */
+    status: string;
+    /**
+     *
+     * @type {number}
+     * @memberof FileAttachment
+     */
+    size?: number;
 }
 export declare const FileAttachmentTypeEnum: {
     readonly File: "file";
@@ -5666,6 +5691,73 @@ export interface Point {
      */
     dy: number;
 }
+/**
+ *
+ * @export
+ * @interface PresignedUrl
+ */
+export interface PresignedUrl {
+    /**
+     *
+     * @type {PresignedUrlData}
+     * @memberof PresignedUrl
+     */
+    data: PresignedUrlData;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof PresignedUrl
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface PresignedUrlData
+ */
+export interface PresignedUrlData {
+    /**
+     *
+     * @type {string}
+     * @memberof PresignedUrlData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof PresignedUrlData
+     */
+    id: string;
+    /**
+     *
+     * @type {PresignedUrlDataAttributes}
+     * @memberof PresignedUrlData
+     */
+    attributes: PresignedUrlDataAttributes;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof PresignedUrlData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface PresignedUrlDataAttributes
+ */
+export interface PresignedUrlDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof PresignedUrlDataAttributes
+     */
+    uri: string;
+}
 /**
  *
  * @export
@@ -7696,6 +7788,12 @@ export interface SceneReference {
      * @memberof SceneReference
      */
     sceneItemId?: string;
+    /**
+     *
+     * @type {Array<ThumbnailData>}
+     * @memberof SceneReference
+     */
+    thumbnails: Array<ThumbnailData>;
 }
 export declare const SceneReferenceTypeEnum: {
     readonly SceneReference: "scene-reference";
@@ -8127,29 +8225,6 @@ export interface SceneViewState {
         [key: string]: Link;
     };
 }
-/**
- *
- * @export
- * @interface SceneViewStateAttachment
- */
-export interface SceneViewStateAttachment {
-    /**
-     *
-     * @type {string}
-     * @memberof SceneViewStateAttachment
-     */
-    type: SceneViewStateAttachmentTypeEnum;
-    /**
-     * ID of the resource.
-     * @type {string}
-     * @memberof SceneViewStateAttachment
-     */
-    id: string;
-}
-export declare const SceneViewStateAttachmentTypeEnum: {
-    readonly SceneViewState: "scene-view-state";
-};
-export declare type SceneViewStateAttachmentTypeEnum = (typeof SceneViewStateAttachmentTypeEnum)[keyof typeof SceneViewStateAttachmentTypeEnum];
 /**
  *
  * @export
@@ -9058,6 +9133,14 @@ export interface UpdateFileCollectionRequestDataAttributes {
      * @memberof UpdateFileCollectionRequestDataAttributes
      */
     expiry?: number;
+    /**
+     * Updates to file collection metadata. Null values delete the associated key/value pair.
+     * @type {{ [key: string]: string; }}
+     * @memberof UpdateFileCollectionRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
 }
 /**
  *
@@ -9109,6 +9192,14 @@ export interface UpdateFileRequestDataAttributes {
      * @memberof UpdateFileRequestDataAttributes
      */
     expiry?: number | null;
+    /**
+     * Updates to file metadata. Null values delete the associated key/value pair.
+     * @type {{ [key: string]: string; }}
+     * @memberof UpdateFileRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
 }
 /**
  * An operation that updates items with the specified revision to the default rendition.
@@ -9892,73 +9983,6 @@ export declare const UpdateWebhookSubscriptionRequestDataAttributesStatusEnum: {
     readonly Paused: "paused";
 };
 export declare type UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = (typeof UpdateWebhookSubscriptionRequestDataAttributesStatusEnum)[keyof typeof UpdateWebhookSubscriptionRequestDataAttributesStatusEnum];
-/**
- *
- * @export
- * @interface UploadUrl
- */
-export interface UploadUrl {
-    /**
-     *
-     * @type {UploadUrlData}
-     * @memberof UploadUrl
-     */
-    data: UploadUrlData;
-    /**
-     *
-     * @type {{ [key: string]: Link; }}
-     * @memberof UploadUrl
-     */
-    links?: {
-        [key: string]: Link;
-    };
-}
-/**
- *
- * @export
- * @interface UploadUrlData
- */
-export interface UploadUrlData {
-    /**
-     *
-     * @type {string}
-     * @memberof UploadUrlData
-     */
-    type: string;
-    /**
-     * ID of the resource.
-     * @type {string}
-     * @memberof UploadUrlData
-     */
-    id: string;
-    /**
-     *
-     * @type {UploadUrlDataAttributes}
-     * @memberof UploadUrlData
-     */
-    attributes: UploadUrlDataAttributes;
-    /**
-     *
-     * @type {{ [key: string]: Link; }}
-     * @memberof UploadUrlData
-     */
-    links?: {
-        [key: string]: Link;
-    };
-}
-/**
- *
- * @export
- * @interface UploadUrlDataAttributes
- */
-export interface UploadUrlDataAttributes {
-    /**
-     *
-     * @type {string}
-     * @memberof UploadUrlDataAttributes
-     */
-    uploadUrl: string;
-}
 /**
  *
  * @export
@@ -10985,29 +11009,6 @@ export declare const WithSceneViewIdTypeEnum: {
     readonly SceneViewId: "scene-view-id";
 };
 export declare type WithSceneViewIdTypeEnum = (typeof WithSceneViewIdTypeEnum)[keyof typeof WithSceneViewIdTypeEnum];
-/**
- *
- * @export
- * @interface WithSceneViewStateContent
- */
-export interface WithSceneViewStateContent {
-    /**
-     *
-     * @type {string}
-     * @memberof WithSceneViewStateContent
-     */
-    type: WithSceneViewStateContentTypeEnum;
-    /**
-     *
-     * @type {WithSceneViewId | WithSceneViewStateId}
-     * @memberof WithSceneViewStateContent
-     */
-    withSceneViewState: WithSceneViewId | WithSceneViewStateId;
-}
-export declare const WithSceneViewStateContentTypeEnum: {
-    readonly SceneViewStateContent: "scene-view-state-content";
-};
-export declare type WithSceneViewStateContentTypeEnum = (typeof WithSceneViewStateContentTypeEnum)[keyof typeof WithSceneViewStateContentTypeEnum];
 /**
  * A sceneViewStateId to be associated as a reference.
  * @export
@@ -11583,6 +11584,22 @@ export declare const AttachmentsApiAxiosParamCreator: (configuration?: Configura
      * @throws {RequiredError}
      */
     createAttachment: (createAttachmentRequest: CreateAttachmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a download url for a file `attachment` by ID.
+     * @param {string} id The &#x60;attachment&#x60; ID.
+     * @param {CreateDownloadRequest} createDownloadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAttachmentDownloadUrl: (id: string, createDownloadRequest: CreateDownloadRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create an upload url for a file `attachment` by ID.
+     * @param {string} id The &#x60;attachment&#x60; ID.
+     * @param {CreateUploadRequest} createUploadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAttachmentUploadUrl: (id: string, createUploadRequest: CreateUploadRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List attachments **Preview:** This is a preview API and is subject to change.
      * @param {string} filterRelationshipId A relationship id to filter attachments for
@@ -11606,6 +11623,22 @@ export declare const AttachmentsApiFp: (configuration?: Configuration | undefine
      * @throws {RequiredError}
      */
     createAttachment(createAttachmentRequest: CreateAttachmentRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Attachment>>;
+    /**
+     * Create a download url for a file `attachment` by ID.
+     * @param {string} id The &#x60;attachment&#x60; ID.
+     * @param {CreateDownloadRequest} createDownloadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAttachmentDownloadUrl(id: string, createDownloadRequest: CreateDownloadRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PresignedUrl>>;
+    /**
+     * Create an upload url for a file `attachment` by ID.
+     * @param {string} id The &#x60;attachment&#x60; ID.
+     * @param {CreateUploadRequest} createUploadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAttachmentUploadUrl(id: string, createUploadRequest: CreateUploadRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PresignedUrl>>;
     /**
      * List attachments **Preview:** This is a preview API and is subject to change.
      * @param {string} filterRelationshipId A relationship id to filter attachments for
@@ -11629,6 +11662,22 @@ export declare const AttachmentsApiFactory: (configuration?: Configuration | und
      * @throws {RequiredError}
      */
     createAttachment(createAttachmentRequest: CreateAttachmentRequest, options?: any): AxiosPromise<Attachment>;
+    /**
+     * Create a download url for a file `attachment` by ID.
+     * @param {string} id The &#x60;attachment&#x60; ID.
+     * @param {CreateDownloadRequest} createDownloadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAttachmentDownloadUrl(id: string, createDownloadRequest: CreateDownloadRequest, options?: any): AxiosPromise<PresignedUrl>;
+    /**
+     * Create an upload url for a file `attachment` by ID.
+     * @param {string} id The &#x60;attachment&#x60; ID.
+     * @param {CreateUploadRequest} createUploadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAttachmentUploadUrl(id: string, createUploadRequest: CreateUploadRequest, options?: any): AxiosPromise<PresignedUrl>;
     /**
      * List attachments **Preview:** This is a preview API and is subject to change.
      * @param {string} filterRelationshipId A relationship id to filter attachments for
@@ -11653,6 +11702,44 @@ export interface AttachmentsApiCreateAttachmentRequest {
      */
     readonly createAttachmentRequest: CreateAttachmentRequest;
 }
+/**
+ * Request parameters for createAttachmentDownloadUrl operation in AttachmentsApi.
+ * @export
+ * @interface AttachmentsApiCreateAttachmentDownloadUrlRequest
+ */
+export interface AttachmentsApiCreateAttachmentDownloadUrlRequest {
+    /**
+     * The &#x60;attachment&#x60; ID.
+     * @type {string}
+     * @memberof AttachmentsApiCreateAttachmentDownloadUrl
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {CreateDownloadRequest}
+     * @memberof AttachmentsApiCreateAttachmentDownloadUrl
+     */
+    readonly createDownloadRequest: CreateDownloadRequest;
+}
+/**
+ * Request parameters for createAttachmentUploadUrl operation in AttachmentsApi.
+ * @export
+ * @interface AttachmentsApiCreateAttachmentUploadUrlRequest
+ */
+export interface AttachmentsApiCreateAttachmentUploadUrlRequest {
+    /**
+     * The &#x60;attachment&#x60; ID.
+     * @type {string}
+     * @memberof AttachmentsApiCreateAttachmentUploadUrl
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {CreateUploadRequest}
+     * @memberof AttachmentsApiCreateAttachmentUploadUrl
+     */
+    readonly createUploadRequest: CreateUploadRequest;
+}
 /**
  * Request parameters for listAttachments operation in AttachmentsApi.
  * @export
@@ -11699,6 +11786,22 @@ export declare class AttachmentsApi extends BaseAPI {
      * @memberof AttachmentsApi
      */
     createAttachment(requestParameters: AttachmentsApiCreateAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Attachment, any>>;
+    /**
+     * Create a download url for a file `attachment` by ID.
+     * @param {AttachmentsApiCreateAttachmentDownloadUrlRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AttachmentsApi
+     */
+    createAttachmentDownloadUrl(requestParameters: AttachmentsApiCreateAttachmentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PresignedUrl, any>>;
+    /**
+     * Create an upload url for a file `attachment` by ID.
+     * @param {AttachmentsApiCreateAttachmentUploadUrlRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AttachmentsApi
+     */
+    createAttachmentUploadUrl(requestParameters: AttachmentsApiCreateAttachmentUploadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PresignedUrl, any>>;
     /**
      * List attachments **Preview:** This is a preview API and is subject to change.
      * @param {AttachmentsApiListAttachmentsRequest} requestParameters Request parameters.
@@ -12896,7 +12999,7 @@ export declare const FilesApiFp: (configuration?: Configuration | undefined) =>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createUploadUrl(id: string, createUploadRequest: CreateUploadRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<UploadUrl>>;
+    createUploadUrl(id: string, createUploadRequest: CreateUploadRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PresignedUrl>>;
     /**
      * Delete a `file`.
      * @param {string} id The &#x60;file&#x60; ID.
@@ -12964,7 +13067,7 @@ export declare const FilesApiFactory: (configuration?: Configuration | undefined
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createUploadUrl(id: string, createUploadRequest: CreateUploadRequest, options?: any): AxiosPromise<UploadUrl>;
+    createUploadUrl(id: string, createUploadRequest: CreateUploadRequest, options?: any): AxiosPromise<PresignedUrl>;
     /**
      * Delete a `file`.
      * @param {string} id The &#x60;file&#x60; ID.
@@ -13175,7 +13278,7 @@ export declare class FilesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FilesApi
      */
-    createUploadUrl(requestParameters: FilesApiCreateUploadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadUrl, any>>;
+    createUploadUrl(requestParameters: FilesApiCreateUploadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PresignedUrl, any>>;
     /**
      * Delete a `file`.
      * @param {FilesApiDeleteFileRequest} requestParameters Request parameters.