@managespace/sdk 0.1.166 → 0.1.168

package/src/generated/apis/default-api.ts

@@ -92,7 +92,9 @@ import type {
   CustomerStatus,
   DailyDepositsReportFilters,
   DocumentComplete,
+  DocumentCreated,
   DocumentHierarchy,
+  DocumentStatus,
   DocumentUrl,
   ExecuteBy,
   ExtensibilityRepo,
@@ -380,8 +382,12 @@ import {
     DailyDepositsReportFiltersToJSON,
     DocumentCompleteFromJSON,
     DocumentCompleteToJSON,
+    DocumentCreatedFromJSON,
+    DocumentCreatedToJSON,
     DocumentHierarchyFromJSON,
     DocumentHierarchyToJSON,
+    DocumentStatusFromJSON,
+    DocumentStatusToJSON,
     DocumentUrlFromJSON,
     DocumentUrlToJSON,
     ExecuteByFromJSON,
@@ -1152,6 +1158,10 @@ export interface GetDocumentHierarchyRequest {
     siteId?: string;
 }
 
+export interface GetDocumentStatusRequest {
+    documentId: string;
+}
+
 export interface GetDocumentUrlRequest {
     documentId: string;
 }
@@ -2703,7 +2713,7 @@ export class DefaultApi extends runtime.BaseAPI {
 
     /**
      */
-    async createDocumentRaw(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Success>> {
+    async createDocumentRaw(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCreated>> {
         if (requestParameters['siteId'] == null) {
             throw new runtime.RequiredError(
                 'siteId',
@@ -2740,12 +2750,12 @@ export class DefaultApi extends runtime.BaseAPI {
             body: CreateDocumentToJSON(requestParameters['createDocument']),
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentCreatedFromJSON(jsonValue));
     }
 
     /**
      */
-    async createDocument(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Success> {
+    async createDocument(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCreated> {
         const response = await this.createDocumentRaw(requestParameters, initOverrides);
         return await response.value();
     }
@@ -6695,6 +6705,45 @@ export class DefaultApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     */
+    async getDocumentStatusRaw(requestParameters: GetDocumentStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentStatus>> {
+        if (requestParameters['documentId'] == null) {
+            throw new runtime.RequiredError(
+                'documentId',
+                'Required parameter "documentId" was null or undefined when calling getDocumentStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/object-store/documents/{documentId}/status`.replace(`{${"documentId"}}`, encodeURIComponent(String(requestParameters['documentId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentStatusFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async getDocumentStatus(requestParameters: GetDocumentStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentStatus> {
+        const response = await this.getDocumentStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      */
     async getDocumentUrlRaw(requestParameters: GetDocumentUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentUrl>> {

package/src/generated/models/document-complete.ts

@@ -50,6 +50,12 @@ export interface DocumentComplete {
      * @memberof DocumentComplete
      */
     userId?: string;
+    /**
+     * Email address of the signer.
+     * @type {string}
+     * @memberof DocumentComplete
+     */
+    signerEmail?: string;
     /**
      * Whether all signatures have been gathered or not.
      * @type {boolean}
@@ -57,11 +63,11 @@ export interface DocumentComplete {
      */
     allSignaturesGathered: boolean;
     /**
-     * Downloadable URL of the document.
+     * Downloadable URL of the document. Required when allSignaturesGathered is true.
      * @type {string}
      * @memberof DocumentComplete
      */
-    fileUrl: string;
+    fileUrl?: string;
 }
 
 /**
@@ -69,7 +75,6 @@ export interface DocumentComplete {
  */
 export function instanceOfDocumentComplete(value: object): value is DocumentComplete {
     if (!('allSignaturesGathered' in value) || value['allSignaturesGathered'] === undefined) return false;
-    if (!('fileUrl' in value) || value['fileUrl'] === undefined) return false;
     return true;
 }
 
@@ -88,8 +93,9 @@ export function DocumentCompleteFromJSONTyped(json: any, ignoreDiscriminator: bo
         'customerId': json['customerId'] == null ? undefined : json['customerId'],
         'contactId': json['contactId'] == null ? undefined : json['contactId'],
         'userId': json['userId'] == null ? undefined : json['userId'],
+        'signerEmail': json['signerEmail'] == null ? undefined : json['signerEmail'],
         'allSignaturesGathered': json['allSignaturesGathered'],
-        'fileUrl': json['fileUrl'],
+        'fileUrl': json['fileUrl'] == null ? undefined : json['fileUrl'],
     };
 }
 
@@ -109,6 +115,7 @@ export function DocumentCompleteToJSONTyped(value?: DocumentComplete | null, ign
         'customerId': value['customerId'],
         'contactId': value['contactId'],
         'userId': value['userId'],
+        'signerEmail': value['signerEmail'],
         'allSignaturesGathered': value['allSignaturesGathered'],
         'fileUrl': value['fileUrl'],
     };

package/src/generated/models/document-created.ts

@@ -0,0 +1,99 @@
+// @ts-nocheck
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { EmbedConfig } from './embed-config';
+import {
+    EmbedConfigFromJSON,
+    EmbedConfigFromJSONTyped,
+    EmbedConfigToJSON,
+    EmbedConfigToJSONTyped,
+} from './embed-config';
+
+/**
+ * 
+ * @export
+ * @interface DocumentCreated
+ */
+export interface DocumentCreated {
+    /**
+     * The success status of the operation.
+     * @type {boolean}
+     * @memberof DocumentCreated
+     */
+    success: boolean;
+    /**
+     * Provider-agnostic embed configuration for rendering the signing UI.
+     * @type {EmbedConfig}
+     * @memberof DocumentCreated
+     */
+    embedConfig?: EmbedConfig;
+    /**
+     * Per-signer embed configurations keyed by role (e.g. operator, tenant).
+     * @type {{ [key: string]: EmbedConfig; }}
+     * @memberof DocumentCreated
+     */
+    signerEmbedConfigs?: { [key: string]: EmbedConfig; };
+    /**
+     * External document identifier from the signing provider.
+     * @type {string}
+     * @memberof DocumentCreated
+     */
+    documentId?: string;
+}
+
+/**
+ * Check if a given object implements the DocumentCreated interface.
+ */
+export function instanceOfDocumentCreated(value: object): value is DocumentCreated {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    return true;
+}
+
+export function DocumentCreatedFromJSON(json: any): DocumentCreated {
+    return DocumentCreatedFromJSONTyped(json, false);
+}
+
+export function DocumentCreatedFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentCreated {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'embedConfig': json['embedConfig'] == null ? undefined : EmbedConfigFromJSON(json['embedConfig']),
+        'signerEmbedConfigs': json['signerEmbedConfigs'] == null ? undefined : (mapValues(json['signerEmbedConfigs'], EmbedConfigFromJSON)),
+        'documentId': json['documentId'] == null ? undefined : json['documentId'],
+    };
+}
+
+export function DocumentCreatedToJSON(json: any): DocumentCreated {
+    return DocumentCreatedToJSONTyped(json, false);
+}
+
+export function DocumentCreatedToJSONTyped(value?: DocumentCreated | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'embedConfig': EmbedConfigToJSON(value['embedConfig']),
+        'signerEmbedConfigs': value['signerEmbedConfigs'] == null ? undefined : (mapValues(value['signerEmbedConfigs'], EmbedConfigToJSON)),
+        'documentId': value['documentId'],
+    };
+}
+

package/src/generated/models/document-status-signer.ts

@@ -0,0 +1,102 @@
+// @ts-nocheck
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface DocumentStatusSigner
+ */
+export interface DocumentStatusSigner {
+    /**
+     * Name of the signer.
+     * @type {string}
+     * @memberof DocumentStatusSigner
+     */
+    name: string;
+    /**
+     * Email address of the signer.
+     * @type {string}
+     * @memberof DocumentStatusSigner
+     */
+    email: string;
+    /**
+     * Role of the signer.
+     * @type {string}
+     * @memberof DocumentStatusSigner
+     */
+    role: string;
+    /**
+     * Signing status (e.g. pending, completed).
+     * @type {string}
+     * @memberof DocumentStatusSigner
+     */
+    status: string;
+    /**
+     * Timestamp when the signer completed signing.
+     * @type {string}
+     * @memberof DocumentStatusSigner
+     */
+    completedAt?: string;
+}
+
+/**
+ * Check if a given object implements the DocumentStatusSigner interface.
+ */
+export function instanceOfDocumentStatusSigner(value: object): value is DocumentStatusSigner {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('role' in value) || value['role'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function DocumentStatusSignerFromJSON(json: any): DocumentStatusSigner {
+    return DocumentStatusSignerFromJSONTyped(json, false);
+}
+
+export function DocumentStatusSignerFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentStatusSigner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'email': json['email'],
+        'role': json['role'],
+        'status': json['status'],
+        'completedAt': json['completedAt'] == null ? undefined : json['completedAt'],
+    };
+}
+
+export function DocumentStatusSignerToJSON(json: any): DocumentStatusSigner {
+    return DocumentStatusSignerToJSONTyped(json, false);
+}
+
+export function DocumentStatusSignerToJSONTyped(value?: DocumentStatusSigner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'email': value['email'],
+        'role': value['role'],
+        'status': value['status'],
+        'completedAt': value['completedAt'],
+    };
+}
+

package/src/generated/models/document-status.ts

@@ -0,0 +1,102 @@
+// @ts-nocheck
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { DocumentStatusSigner } from './document-status-signer';
+import {
+    DocumentStatusSignerFromJSON,
+    DocumentStatusSignerFromJSONTyped,
+    DocumentStatusSignerToJSON,
+    DocumentStatusSignerToJSONTyped,
+} from './document-status-signer';
+
+/**
+ * 
+ * @export
+ * @interface DocumentStatus
+ */
+export interface DocumentStatus {
+    /**
+     * External document identifier from the signing provider.
+     * @type {string}
+     * @memberof DocumentStatus
+     */
+    documentId: string;
+    /**
+     * Overall document status (e.g. pending, completed).
+     * @type {string}
+     * @memberof DocumentStatus
+     */
+    status: string;
+    /**
+     * Whether all required signatures have been gathered.
+     * @type {boolean}
+     * @memberof DocumentStatus
+     */
+    allSignaturesGathered: boolean;
+    /**
+     * Status of each individual signer.
+     * @type {Array<DocumentStatusSigner>}
+     * @memberof DocumentStatus
+     */
+    signers: Array<DocumentStatusSigner>;
+}
+
+/**
+ * Check if a given object implements the DocumentStatus interface.
+ */
+export function instanceOfDocumentStatus(value: object): value is DocumentStatus {
+    if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('allSignaturesGathered' in value) || value['allSignaturesGathered'] === undefined) return false;
+    if (!('signers' in value) || value['signers'] === undefined) return false;
+    return true;
+}
+
+export function DocumentStatusFromJSON(json: any): DocumentStatus {
+    return DocumentStatusFromJSONTyped(json, false);
+}
+
+export function DocumentStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'documentId': json['documentId'],
+        'status': json['status'],
+        'allSignaturesGathered': json['allSignaturesGathered'],
+        'signers': ((json['signers'] as Array<any>).map(DocumentStatusSignerFromJSON)),
+    };
+}
+
+export function DocumentStatusToJSON(json: any): DocumentStatus {
+    return DocumentStatusToJSONTyped(json, false);
+}
+
+export function DocumentStatusToJSONTyped(value?: DocumentStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'documentId': value['documentId'],
+        'status': value['status'],
+        'allSignaturesGathered': value['allSignaturesGathered'],
+        'signers': ((value['signers'] as Array<any>).map(DocumentStatusSignerToJSON)),
+    };
+}
+

package/src/generated/models/embed-config.ts

@@ -0,0 +1,93 @@
+// @ts-nocheck
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface EmbedConfig
+ */
+export interface EmbedConfig {
+    /**
+     * URL of the provider script to load.
+     * @type {string}
+     * @memberof EmbedConfig
+     */
+    scriptUrl: string;
+    /**
+     * Custom element tag name to render.
+     * @type {string}
+     * @memberof EmbedConfig
+     */
+    tagName: string;
+    /**
+     * Attributes to set on the custom element.
+     * @type {{ [key: string]: string; }}
+     * @memberof EmbedConfig
+     */
+    attributes: { [key: string]: string; };
+    /**
+     * DOM event name fired on completion.
+     * @type {string}
+     * @memberof EmbedConfig
+     */
+    completionEvent?: string;
+}
+
+/**
+ * Check if a given object implements the EmbedConfig interface.
+ */
+export function instanceOfEmbedConfig(value: object): value is EmbedConfig {
+    if (!('scriptUrl' in value) || value['scriptUrl'] === undefined) return false;
+    if (!('tagName' in value) || value['tagName'] === undefined) return false;
+    if (!('attributes' in value) || value['attributes'] === undefined) return false;
+    return true;
+}
+
+export function EmbedConfigFromJSON(json: any): EmbedConfig {
+    return EmbedConfigFromJSONTyped(json, false);
+}
+
+export function EmbedConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmbedConfig {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scriptUrl': json['scriptUrl'],
+        'tagName': json['tagName'],
+        'attributes': json['attributes'],
+        'completionEvent': json['completionEvent'] == null ? undefined : json['completionEvent'],
+    };
+}
+
+export function EmbedConfigToJSON(json: any): EmbedConfig {
+    return EmbedConfigToJSONTyped(json, false);
+}
+
+export function EmbedConfigToJSONTyped(value?: EmbedConfig | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scriptUrl': value['scriptUrl'],
+        'tagName': value['tagName'],
+        'attributes': value['attributes'],
+        'completionEvent': value['completionEvent'],
+    };
+}
+

package/src/generated/models/index.ts

@@ -98,10 +98,14 @@ export * from './customer-payment-method';
 export * from './customer-status';
 export * from './daily-deposits-report-filters';
 export * from './document-complete';
+export * from './document-created';
 export * from './document-field';
 export * from './document-hierarchy';
 export * from './document-signer';
+export * from './document-status';
+export * from './document-status-signer';
 export * from './document-url';
+export * from './embed-config';
 export * from './execute-by';
 export * from './extensibility-function-definition';
 export * from './extensibility-function-instance';