@managespace/sdk 0.1.157 → 0.1.158-extensions

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

@@ -0,0 +1,362 @@
+// @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 * as runtime from '../runtime';
+import type {
+  Extension,
+  ExtensionOrg,
+  Success,
+} from '../models/index';
+import {
+    ExtensionFromJSON,
+    ExtensionToJSON,
+    ExtensionOrgFromJSON,
+    ExtensionOrgToJSON,
+    SuccessFromJSON,
+    SuccessToJSON,
+} from '../models/index';
+
+export interface DisableExtensionRequest {
+    id: string;
+}
+
+export interface EnableExtensionRequest {
+    id: string;
+}
+
+export interface GetBundleRequest {
+    id: string;
+}
+
+export interface GetBundleUrlRequest {
+    id: string;
+}
+
+export interface GetExtensionByIdRequest {
+    id: string;
+}
+
+/**
+ * 
+ */
+export class ExtensionsApi extends runtime.BaseAPI {
+
+    /**
+     * Disable an extension for the current org
+     */
+    async disableExtensionRaw(requestParameters: DisableExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Success>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling disableExtension().'
+            );
+        }
+
+        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/extensibility/extensions/{id}/disable`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessFromJSON(jsonValue));
+    }
+
+    /**
+     * Disable an extension for the current org
+     */
+    async disableExtension(requestParameters: DisableExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Success> {
+        const response = await this.disableExtensionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Enable an extension for the current org
+     */
+    async enableExtensionRaw(requestParameters: EnableExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExtensionOrg>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling enableExtension().'
+            );
+        }
+
+        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/extensibility/extensions/{id}/enable`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionOrgFromJSON(jsonValue));
+    }
+
+    /**
+     * Enable an extension for the current org
+     */
+    async enableExtension(requestParameters: EnableExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExtensionOrg> {
+        const response = await this.enableExtensionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get all available extensions (admin)
+     */
+    async getAllExtensionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Extension>> {
+        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/extensibility/extensions/all`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionFromJSON(jsonValue));
+    }
+
+    /**
+     * Get all available extensions (admin)
+     */
+    async getAllExtensions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Extension> {
+        const response = await this.getAllExtensionsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Download extension bundle (proxied from S3)
+     */
+    async getBundleRaw(requestParameters: GetBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getBundle().'
+            );
+        }
+
+        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/extensibility/extensions/{id}/bundle`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Download extension bundle (proxied from S3)
+     */
+    async getBundle(requestParameters: GetBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getBundleRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get presigned URL for extension bundle
+     */
+    async getBundleUrlRaw(requestParameters: GetBundleUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getBundleUrl().'
+            );
+        }
+
+        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/extensibility/extensions/{id}/bundle-url`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Get presigned URL for extension bundle
+     */
+    async getBundleUrl(requestParameters: GetBundleUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getBundleUrlRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get extension by ID
+     */
+    async getExtensionByIdRaw(requestParameters: GetExtensionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Extension>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getExtensionById().'
+            );
+        }
+
+        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/extensibility/extensions/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionFromJSON(jsonValue));
+    }
+
+    /**
+     * Get extension by ID
+     */
+    async getExtensionById(requestParameters: GetExtensionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Extension> {
+        const response = await this.getExtensionByIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get all enabled extensions for the current org
+     */
+    async getExtensionsForOrgRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Extension>> {
+        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/extensibility/extensions`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionFromJSON(jsonValue));
+    }
+
+    /**
+     * Get all enabled extensions for the current org
+     */
+    async getExtensionsForOrg(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Extension> {
+        const response = await this.getExtensionsForOrgRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Upload a new extension
+     */
+    async uploadExtensionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Extension>> {
+        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/extensibility/extensions`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a new extension
+     */
+    async uploadExtension(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Extension> {
+        const response = await this.uploadExtensionRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/generated/apis/index.ts

@@ -2,3 +2,4 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './default-api';
+export * from './extensions-api';

package/src/generated/models/contact.ts

@@ -67,7 +67,7 @@ export interface Contact {
      * @type {string}
      * @memberof Contact
      */
-    externalId: string | null;
+    msExternalId: string | null;
     /**
      * First name
      * @type {string}
@@ -177,7 +177,7 @@ export interface Contact {
  */
 export function instanceOfContact(value: object): value is Contact {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('externalId' in value) || value['externalId'] === undefined) return false;
+    if (!('msExternalId' in value) || value['msExternalId'] === undefined) return false;
     if (!('firstName' in value) || value['firstName'] === undefined) return false;
     if (!('middleInitial' in value) || value['middleInitial'] === undefined) return false;
     if (!('lastName' in value) || value['lastName'] === undefined) return false;
@@ -204,7 +204,7 @@ export function ContactFromJSONTyped(json: any, ignoreDiscriminator: boolean): C
     return {
         
         'id': json['id'],
-        'externalId': json['externalId'],
+        'msExternalId': json['msExternalId'],
         'firstName': json['firstName'],
         'middleInitial': json['middleInitial'],
         'lastName': json['lastName'],
@@ -237,7 +237,7 @@ export function ContactToJSONTyped(value?: Contact | null, ignoreDiscriminator:
     return {
         
         'id': value['id'],
-        'externalId': value['externalId'],
+        'msExternalId': value['msExternalId'],
         'firstName': value['firstName'],
         'middleInitial': value['middleInitial'],
         'lastName': value['lastName'],

package/src/generated/models/customer.ts

@@ -180,7 +180,7 @@ export interface Customer {
      * @type {string}
      * @memberof Customer
      */
-    externalId: string | null;
+    msExternalId: string | null;
     /**
      * A URL to a customers avatar
      * @type {string}
@@ -268,7 +268,7 @@ export function instanceOfCustomer(value: object): value is Customer {
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     if (!('creationSiteId' in value) || value['creationSiteId'] === undefined) return false;
     if (!('orgId' in value) || value['orgId'] === undefined) return false;
-    if (!('externalId' in value) || value['externalId'] === undefined) return false;
+    if (!('msExternalId' in value) || value['msExternalId'] === undefined) return false;
     if (!('avatarUrl' in value) || value['avatarUrl'] === undefined) return false;
     if (!('metadata' in value) || value['metadata'] === undefined) return false;
     if (!('customerStatusId' in value) || value['customerStatusId'] === undefined) return false;
@@ -302,7 +302,7 @@ export function CustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'orgId': json['orgId'],
         'contacts': json['contacts'] == null ? undefined : ((json['contacts'] as Array<any>).map(ContactFromJSON)),
         'note': json['note'] == null ? undefined : ((json['note'] as Array<any>).map(NoteFromJSON)),
-        'externalId': json['externalId'],
+        'msExternalId': json['msExternalId'],
         'avatarUrl': json['avatarUrl'],
         'metadata': json['metadata'],
         'communications': json['communications'] == null ? undefined : ((json['communications'] as Array<any>).map(CommunicationFromJSON)),
@@ -343,7 +343,7 @@ export function CustomerToJSONTyped(value?: Customer | null, ignoreDiscriminator
         'orgId': value['orgId'],
         'contacts': value['contacts'] == null ? undefined : ((value['contacts'] as Array<any>).map(ContactToJSON)),
         'note': value['note'] == null ? undefined : ((value['note'] as Array<any>).map(NoteToJSON)),
-        'externalId': value['externalId'],
+        'msExternalId': value['msExternalId'],
         'avatarUrl': value['avatarUrl'],
         'metadata': value['metadata'],
         'communications': value['communications'] == null ? undefined : ((value['communications'] as Array<any>).map(CommunicationToJSON)),

package/src/generated/models/extension-org.ts

@@ -0,0 +1,119 @@
+// @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 { Extension } from './extension';
+import {
+    ExtensionFromJSON,
+    ExtensionFromJSONTyped,
+    ExtensionToJSON,
+    ExtensionToJSONTyped,
+} from './extension';
+
+/**
+ * 
+ * @export
+ * @interface ExtensionOrg
+ */
+export interface ExtensionOrg {
+    /**
+     * ExtensionOrg ID
+     * @type {string}
+     * @memberof ExtensionOrg
+     */
+    id: string;
+    /**
+     * Extension ID
+     * @type {string}
+     * @memberof ExtensionOrg
+     */
+    extensionId: string;
+    /**
+     * Organisation ID
+     * @type {string}
+     * @memberof ExtensionOrg
+     */
+    orgId: string;
+    /**
+     * Whether the extension is enabled for this org
+     * @type {boolean}
+     * @memberof ExtensionOrg
+     */
+    enabled: boolean;
+    /**
+     * When the record was created
+     * @type {Date}
+     * @memberof ExtensionOrg
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Extension}
+     * @memberof ExtensionOrg
+     */
+    extension?: Extension;
+}
+
+/**
+ * Check if a given object implements the ExtensionOrg interface.
+ */
+export function instanceOfExtensionOrg(value: object): value is ExtensionOrg {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('extensionId' in value) || value['extensionId'] === undefined) return false;
+    if (!('orgId' in value) || value['orgId'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function ExtensionOrgFromJSON(json: any): ExtensionOrg {
+    return ExtensionOrgFromJSONTyped(json, false);
+}
+
+export function ExtensionOrgFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExtensionOrg {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'extensionId': json['extensionId'],
+        'orgId': json['orgId'],
+        'enabled': json['enabled'],
+        'createdAt': (new Date(json['createdAt'])),
+        'extension': json['extension'] == null ? undefined : ExtensionFromJSON(json['extension']),
+    };
+}
+
+export function ExtensionOrgToJSON(json: any): ExtensionOrg {
+    return ExtensionOrgToJSONTyped(json, false);
+}
+
+export function ExtensionOrgToJSONTyped(value?: ExtensionOrg | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'extensionId': value['extensionId'],
+        'orgId': value['orgId'],
+        'enabled': value['enabled'],
+        'createdAt': ((value['createdAt']).toISOString()),
+        'extension': ExtensionToJSON(value['extension']),
+    };
+}
+