@managespace/sdk 0.1.4 → 0.1.5-0.paul.dev

package/src/generated/models/update-subscription.ts

@@ -0,0 +1,299 @@
+/* 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 { UpdateSubscriptionCharge } from './update-subscription-charge';
+import {
+    UpdateSubscriptionChargeFromJSON,
+    UpdateSubscriptionChargeFromJSONTyped,
+    UpdateSubscriptionChargeToJSON,
+    UpdateSubscriptionChargeToJSONTyped,
+} from './update-subscription-charge';
+
+/**
+ * 
+ * @export
+ * @interface UpdateSubscription
+ */
+export interface UpdateSubscription {
+    /**
+     * Status of subscription contract
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    status?: string;
+    /**
+     * Billing start date for subscription contract
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    billingStartDate?: string;
+    /**
+     * Date order was placed
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    orderPlacedAt?: string;
+    /**
+     * Date subscription contract was terminated
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    cancellationDate?: string;
+    /**
+     * Cancel as of option
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    cancellationType?: string;
+    /**
+     * auto-renew subscription contract
+     * @type {boolean}
+     * @memberof UpdateSubscription
+     */
+    autoRenew?: boolean;
+    /**
+     * currency
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    currency?: string;
+    /**
+     * Calculate due date of invoice
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    paymentTerms?: string;
+    /**
+     * Contracted MRR per charge
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    cmrr?: string;
+    /**
+     * MRR calculated based on % discount
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    discountedCmrr?: string;
+    /**
+     * separate invoice generated
+     * @type {boolean}
+     * @memberof UpdateSubscription
+     */
+    separateInvoice?: boolean;
+    /**
+     * Miscellaneous notes
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    notes?: string;
+    /**
+     * Coupon Code
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    couponCode?: string;
+    /**
+     * Version of subscription contract
+     * @type {number}
+     * @memberof UpdateSubscription
+     */
+    version?: number;
+    /**
+     * Subscription contract version type
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    versionType?: string;
+    /**
+     * Subscription contract term
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    contractTerm?: string;
+    /**
+     * Length of time Subscription Contract will be renewed for
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    renewalTerm?: string;
+    /**
+     * Date Subscription Contract will start
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    currentTermStartDate?: string;
+    /**
+     * Date subscription contract will end
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    currentTermEndDate?: string;
+    /**
+     * Date subscription contract was terminated
+     * @type {number}
+     * @memberof UpdateSubscription
+     */
+    renewalIncrementPercent?: number;
+    /**
+     * Asset ID
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    assetId?: string;
+    /**
+     * The date the subscription is paid until.
+     * @type {Date}
+     * @memberof UpdateSubscription
+     */
+    paidThroughDate?: Date;
+    /**
+     * Id of billing contact
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    billContactId?: string;
+    /**
+     * Id of shipping contact
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    shippingContactId?: string;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof UpdateSubscription
+     */
+    customFields?: object;
+    /**
+     * Total contract value of the subsctiption contract
+     * @type {number}
+     * @memberof UpdateSubscription
+     */
+    tcv?: number;
+    /**
+     * Set to defer start date
+     * @type {boolean}
+     * @memberof UpdateSubscription
+     */
+    deferStartDate?: boolean;
+    /**
+     * Date subscription contract was signed and activated
+     * @type {string}
+     * @memberof UpdateSubscription
+     */
+    contractEffectiveDate: string;
+    /**
+     * Charges associated the subscription
+     * @type {Array<UpdateSubscriptionCharge>}
+     * @memberof UpdateSubscription
+     */
+    charges: Array<UpdateSubscriptionCharge>;
+}
+
+/**
+ * Check if a given object implements the UpdateSubscription interface.
+ */
+export function instanceOfUpdateSubscription(value: object): value is UpdateSubscription {
+    if (!('contractEffectiveDate' in value) || value['contractEffectiveDate'] === undefined) return false;
+    if (!('charges' in value) || value['charges'] === undefined) return false;
+    return true;
+}
+
+export function UpdateSubscriptionFromJSON(json: any): UpdateSubscription {
+    return UpdateSubscriptionFromJSONTyped(json, false);
+}
+
+export function UpdateSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubscription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'] == null ? undefined : json['status'],
+        'billingStartDate': json['billingStartDate'] == null ? undefined : json['billingStartDate'],
+        'orderPlacedAt': json['orderPlacedAt'] == null ? undefined : json['orderPlacedAt'],
+        'cancellationDate': json['cancellationDate'] == null ? undefined : json['cancellationDate'],
+        'cancellationType': json['cancellationType'] == null ? undefined : json['cancellationType'],
+        'autoRenew': json['autoRenew'] == null ? undefined : json['autoRenew'],
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'paymentTerms': json['paymentTerms'] == null ? undefined : json['paymentTerms'],
+        'cmrr': json['cmrr'] == null ? undefined : json['cmrr'],
+        'discountedCmrr': json['discountedCmrr'] == null ? undefined : json['discountedCmrr'],
+        'separateInvoice': json['separateInvoice'] == null ? undefined : json['separateInvoice'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'couponCode': json['couponCode'] == null ? undefined : json['couponCode'],
+        'version': json['version'] == null ? undefined : json['version'],
+        'versionType': json['versionType'] == null ? undefined : json['versionType'],
+        'contractTerm': json['contractTerm'] == null ? undefined : json['contractTerm'],
+        'renewalTerm': json['renewalTerm'] == null ? undefined : json['renewalTerm'],
+        'currentTermStartDate': json['currentTermStartDate'] == null ? undefined : json['currentTermStartDate'],
+        'currentTermEndDate': json['currentTermEndDate'] == null ? undefined : json['currentTermEndDate'],
+        'renewalIncrementPercent': json['renewalIncrementPercent'] == null ? undefined : json['renewalIncrementPercent'],
+        'assetId': json['assetId'] == null ? undefined : json['assetId'],
+        'paidThroughDate': json['paidThroughDate'] == null ? undefined : (new Date(json['paidThroughDate'])),
+        'billContactId': json['billContactId'] == null ? undefined : json['billContactId'],
+        'shippingContactId': json['shippingContactId'] == null ? undefined : json['shippingContactId'],
+        'customFields': json['customFields'] == null ? undefined : json['customFields'],
+        'tcv': json['tcv'] == null ? undefined : json['tcv'],
+        'deferStartDate': json['deferStartDate'] == null ? undefined : json['deferStartDate'],
+        'contractEffectiveDate': json['contractEffectiveDate'],
+        'charges': ((json['charges'] as Array<any>).map(UpdateSubscriptionChargeFromJSON)),
+    };
+}
+
+export function UpdateSubscriptionToJSON(json: any): UpdateSubscription {
+    return UpdateSubscriptionToJSONTyped(json, false);
+}
+
+export function UpdateSubscriptionToJSONTyped(value?: UpdateSubscription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'billingStartDate': value['billingStartDate'],
+        'orderPlacedAt': value['orderPlacedAt'],
+        'cancellationDate': value['cancellationDate'],
+        'cancellationType': value['cancellationType'],
+        'autoRenew': value['autoRenew'],
+        'currency': value['currency'],
+        'paymentTerms': value['paymentTerms'],
+        'cmrr': value['cmrr'],
+        'discountedCmrr': value['discountedCmrr'],
+        'separateInvoice': value['separateInvoice'],
+        'notes': value['notes'],
+        'couponCode': value['couponCode'],
+        'version': value['version'],
+        'versionType': value['versionType'],
+        'contractTerm': value['contractTerm'],
+        'renewalTerm': value['renewalTerm'],
+        'currentTermStartDate': value['currentTermStartDate'],
+        'currentTermEndDate': value['currentTermEndDate'],
+        'renewalIncrementPercent': value['renewalIncrementPercent'],
+        'assetId': value['assetId'],
+        'paidThroughDate': value['paidThroughDate'] == null ? undefined : ((value['paidThroughDate']).toISOString()),
+        'billContactId': value['billContactId'],
+        'shippingContactId': value['shippingContactId'],
+        'customFields': value['customFields'],
+        'tcv': value['tcv'],
+        'deferStartDate': value['deferStartDate'],
+        'contractEffectiveDate': value['contractEffectiveDate'],
+        'charges': ((value['charges'] as Array<any>).map(UpdateSubscriptionChargeToJSON)),
+    };
+}
+

package/src/generated/models/update-task-instance.ts

@@ -0,0 +1,131 @@
+/* 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 { TaskCompletionStatus } from './task-completion-status';
+import {
+    TaskCompletionStatusFromJSON,
+    TaskCompletionStatusFromJSONTyped,
+    TaskCompletionStatusToJSON,
+    TaskCompletionStatusToJSONTyped,
+} from './task-completion-status';
+
+/**
+ * 
+ * @export
+ * @interface UpdateTaskInstance
+ */
+export interface UpdateTaskInstance {
+    /**
+     * User who is assigned task
+     * @type {string}
+     * @memberof UpdateTaskInstance
+     */
+    assignedToUserId?: string | null;
+    /**
+     * Customer who is assigned task
+     * @type {string}
+     * @memberof UpdateTaskInstance
+     */
+    assignedToCustomerId?: string | null;
+    /**
+     * User who is assigned task
+     * @type {string}
+     * @memberof UpdateTaskInstance
+     */
+    completedByUserId?: string | null;
+    /**
+     * Name of Task
+     * @type {string}
+     * @memberof UpdateTaskInstance
+     */
+    name?: string;
+    /**
+     * Any relevant information for the task
+     * @type {string}
+     * @memberof UpdateTaskInstance
+     */
+    description?: string | null;
+    /**
+     * When the task should be completed by
+     * @type {Date}
+     * @memberof UpdateTaskInstance
+     */
+    dueDate?: Date;
+    /**
+     * 
+     * @type {TaskCompletionStatus}
+     * @memberof UpdateTaskInstance
+     */
+    status?: TaskCompletionStatus;
+    /**
+     * 
+     * @type {number}
+     * @memberof UpdateTaskInstance
+     */
+    checklistRun?: number | null;
+}
+
+
+
+/**
+ * Check if a given object implements the UpdateTaskInstance interface.
+ */
+export function instanceOfUpdateTaskInstance(value: object): value is UpdateTaskInstance {
+    return true;
+}
+
+export function UpdateTaskInstanceFromJSON(json: any): UpdateTaskInstance {
+    return UpdateTaskInstanceFromJSONTyped(json, false);
+}
+
+export function UpdateTaskInstanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateTaskInstance {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'assignedToUserId': json['assignedToUserId'] == null ? undefined : json['assignedToUserId'],
+        'assignedToCustomerId': json['assignedToCustomerId'] == null ? undefined : json['assignedToCustomerId'],
+        'completedByUserId': json['completedByUserId'] == null ? undefined : json['completedByUserId'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'dueDate': json['dueDate'] == null ? undefined : (new Date(json['dueDate'])),
+        'status': json['status'] == null ? undefined : TaskCompletionStatusFromJSON(json['status']),
+        'checklistRun': json['checklistRun'] == null ? undefined : json['checklistRun'],
+    };
+}
+
+export function UpdateTaskInstanceToJSON(json: any): UpdateTaskInstance {
+    return UpdateTaskInstanceToJSONTyped(json, false);
+}
+
+export function UpdateTaskInstanceToJSONTyped(value?: UpdateTaskInstance | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'assignedToUserId': value['assignedToUserId'],
+        'assignedToCustomerId': value['assignedToCustomerId'],
+        'completedByUserId': value['completedByUserId'],
+        'name': value['name'],
+        'description': value['description'],
+        'dueDate': value['dueDate'] == null ? undefined : ((value['dueDate']).toISOString()),
+        'status': TaskCompletionStatusToJSON(value['status']),
+        'checklistRun': value['checklistRun'],
+    };
+}
+

package/src/generated/models/update-user-properties.ts

@@ -28,7 +28,7 @@ import {
  */
 export interface UpdateUserProperties {
     /**
-     * List of site ids
+     * List of site IDs
      * @type {Array<string>}
      * @memberof UpdateUserProperties
      */

package/src/generated/models/update-workflow-instance-description.ts

@@ -0,0 +1,66 @@
+/* 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 UpdateWorkflowInstanceDescription
+ */
+export interface UpdateWorkflowInstanceDescription {
+    /**
+     * The description to display for the workflow instance
+     * @type {string}
+     * @memberof UpdateWorkflowInstanceDescription
+     */
+    description: string;
+}
+
+/**
+ * Check if a given object implements the UpdateWorkflowInstanceDescription interface.
+ */
+export function instanceOfUpdateWorkflowInstanceDescription(value: object): value is UpdateWorkflowInstanceDescription {
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function UpdateWorkflowInstanceDescriptionFromJSON(json: any): UpdateWorkflowInstanceDescription {
+    return UpdateWorkflowInstanceDescriptionFromJSONTyped(json, false);
+}
+
+export function UpdateWorkflowInstanceDescriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateWorkflowInstanceDescription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'],
+    };
+}
+
+export function UpdateWorkflowInstanceDescriptionToJSON(json: any): UpdateWorkflowInstanceDescription {
+    return UpdateWorkflowInstanceDescriptionToJSONTyped(json, false);
+}
+
+export function UpdateWorkflowInstanceDescriptionToJSONTyped(value?: UpdateWorkflowInstanceDescription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'description': value['description'],
+    };
+}
+

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

@@ -0,0 +1,115 @@
+/* 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 UploadDocument
+ */
+export interface UploadDocument {
+    /**
+     * Unique document name or external document ID
+     * @type {string}
+     * @memberof UploadDocument
+     */
+    externalId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UploadDocument
+     */
+    siteId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UploadDocument
+     */
+    customerId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UploadDocument
+     */
+    contactId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UploadDocument
+     */
+    userId?: string | null;
+    /**
+     * Metadata for the note
+     * @type {object}
+     * @memberof UploadDocument
+     */
+    metadata?: object | null;
+    /**
+     * Base64 encoded document
+     * @type {string}
+     * @memberof UploadDocument
+     */
+    file: string;
+}
+
+/**
+ * Check if a given object implements the UploadDocument interface.
+ */
+export function instanceOfUploadDocument(value: object): value is UploadDocument {
+    if (!('externalId' in value) || value['externalId'] === undefined) return false;
+    if (!('file' in value) || value['file'] === undefined) return false;
+    return true;
+}
+
+export function UploadDocumentFromJSON(json: any): UploadDocument {
+    return UploadDocumentFromJSONTyped(json, false);
+}
+
+export function UploadDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadDocument {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'externalId': json['externalId'],
+        'siteId': json['siteId'] == null ? undefined : json['siteId'],
+        'customerId': json['customerId'] == null ? undefined : json['customerId'],
+        'contactId': json['contactId'] == null ? undefined : json['contactId'],
+        'userId': json['userId'] == null ? undefined : json['userId'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        'file': json['file'],
+    };
+}
+
+export function UploadDocumentToJSON(json: any): UploadDocument {
+    return UploadDocumentToJSONTyped(json, false);
+}
+
+export function UploadDocumentToJSONTyped(value?: UploadDocument | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'externalId': value['externalId'],
+        'siteId': value['siteId'],
+        'customerId': value['customerId'],
+        'contactId': value['contactId'],
+        'userId': value['userId'],
+        'metadata': value['metadata'],
+        'file': value['file'],
+    };
+}
+