@managespace/sdk 0.1.11 → 0.1.13

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

@@ -0,0 +1,282 @@
+/* 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 { Site } from './site';
+import {
+    SiteFromJSON,
+    SiteFromJSONTyped,
+    SiteToJSON,
+    SiteToJSONTyped,
+} from './site';
+import type { TaskDefinition } from './task-definition';
+import {
+    TaskDefinitionFromJSON,
+    TaskDefinitionFromJSONTyped,
+    TaskDefinitionToJSON,
+    TaskDefinitionToJSONTyped,
+} from './task-definition';
+import type { User } from './user';
+import {
+    UserFromJSON,
+    UserFromJSONTyped,
+    UserToJSON,
+    UserToJSONTyped,
+} from './user';
+import type { Customer } from './customer';
+import {
+    CustomerFromJSON,
+    CustomerFromJSONTyped,
+    CustomerToJSON,
+    CustomerToJSONTyped,
+} from './customer';
+import type { Org } from './org';
+import {
+    OrgFromJSON,
+    OrgFromJSONTyped,
+    OrgToJSON,
+    OrgToJSONTyped,
+} from './org';
+import type { Checklist } from './checklist';
+import {
+    ChecklistFromJSON,
+    ChecklistFromJSONTyped,
+    ChecklistToJSON,
+    ChecklistToJSONTyped,
+} from './checklist';
+import type { TaskCompletionStatus } from './task-completion-status';
+import {
+    TaskCompletionStatusFromJSON,
+    TaskCompletionStatusFromJSONTyped,
+    TaskCompletionStatusToJSON,
+    TaskCompletionStatusToJSONTyped,
+} from './task-completion-status';
+
+/**
+ * 
+ * @export
+ * @interface TaskInstance
+ */
+export interface TaskInstance {
+    /**
+     * Task ID
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    id: string;
+    /**
+     * 
+     * @type {Org}
+     * @memberof TaskInstance
+     */
+    org?: Org;
+    /**
+     * Org ID
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    orgId: string;
+    /**
+     * 
+     * @type {Site}
+     * @memberof TaskInstance
+     */
+    site?: Site;
+    /**
+     * Site ID
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    siteId: string;
+    /**
+     * 
+     * @type {User}
+     * @memberof TaskInstance
+     */
+    assignedToUser?: User | null;
+    /**
+     * User who is assigned task
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    assignedToUserId: string | null;
+    /**
+     * 
+     * @type {Customer}
+     * @memberof TaskInstance
+     */
+    assignedToCustomer?: Customer | null;
+    /**
+     * Customer who is assigned task
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    assignedToCustomerId: string | null;
+    /**
+     * 
+     * @type {User}
+     * @memberof TaskInstance
+     */
+    completedByUser?: User | null;
+    /**
+     * User who is assigned task
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    completedByUserId: string | null;
+    /**
+     * Name of Task
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    name: string;
+    /**
+     * Any relevant information for the task
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    description: string | null;
+    /**
+     * When the task should be completed by
+     * @type {Date}
+     * @memberof TaskInstance
+     */
+    dueDate: Date;
+    /**
+     * 
+     * @type {TaskCompletionStatus}
+     * @memberof TaskInstance
+     */
+    status: TaskCompletionStatus;
+    /**
+     * 
+     * @type {Checklist}
+     * @memberof TaskInstance
+     */
+    checklist?: Checklist | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    checklistId: string | null;
+    /**
+     * 
+     * @type {TaskDefinition}
+     * @memberof TaskInstance
+     */
+    taskDefinition?: TaskDefinition | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TaskInstance
+     */
+    taskDefinitionId: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof TaskInstance
+     */
+    checklistRun: number | null;
+}
+
+
+
+/**
+ * Check if a given object implements the TaskInstance interface.
+ */
+export function instanceOfTaskInstance(value: object): value is TaskInstance {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('orgId' in value) || value['orgId'] === undefined) return false;
+    if (!('siteId' in value) || value['siteId'] === undefined) return false;
+    if (!('assignedToUserId' in value) || value['assignedToUserId'] === undefined) return false;
+    if (!('assignedToCustomerId' in value) || value['assignedToCustomerId'] === undefined) return false;
+    if (!('completedByUserId' in value) || value['completedByUserId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('dueDate' in value) || value['dueDate'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('checklistId' in value) || value['checklistId'] === undefined) return false;
+    if (!('taskDefinitionId' in value) || value['taskDefinitionId'] === undefined) return false;
+    if (!('checklistRun' in value) || value['checklistRun'] === undefined) return false;
+    return true;
+}
+
+export function TaskInstanceFromJSON(json: any): TaskInstance {
+    return TaskInstanceFromJSONTyped(json, false);
+}
+
+export function TaskInstanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaskInstance {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'org': json['org'] == null ? undefined : OrgFromJSON(json['org']),
+        'orgId': json['orgId'],
+        'site': json['site'] == null ? undefined : SiteFromJSON(json['site']),
+        'siteId': json['siteId'],
+        'assignedToUser': json['assignedToUser'] == null ? undefined : UserFromJSON(json['assignedToUser']),
+        'assignedToUserId': json['assignedToUserId'],
+        'assignedToCustomer': json['assignedToCustomer'] == null ? undefined : CustomerFromJSON(json['assignedToCustomer']),
+        'assignedToCustomerId': json['assignedToCustomerId'],
+        'completedByUser': json['completedByUser'] == null ? undefined : UserFromJSON(json['completedByUser']),
+        'completedByUserId': json['completedByUserId'],
+        'name': json['name'],
+        'description': json['description'],
+        'dueDate': (new Date(json['dueDate'])),
+        'status': TaskCompletionStatusFromJSON(json['status']),
+        'checklist': json['checklist'] == null ? undefined : ChecklistFromJSON(json['checklist']),
+        'checklistId': json['checklistId'],
+        'taskDefinition': json['taskDefinition'] == null ? undefined : TaskDefinitionFromJSON(json['taskDefinition']),
+        'taskDefinitionId': json['taskDefinitionId'],
+        'checklistRun': json['checklistRun'],
+    };
+}
+
+export function TaskInstanceToJSON(json: any): TaskInstance {
+    return TaskInstanceToJSONTyped(json, false);
+}
+
+export function TaskInstanceToJSONTyped(value?: TaskInstance | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'org': OrgToJSON(value['org']),
+        'orgId': value['orgId'],
+        'site': SiteToJSON(value['site']),
+        'siteId': value['siteId'],
+        'assignedToUser': UserToJSON(value['assignedToUser']),
+        'assignedToUserId': value['assignedToUserId'],
+        'assignedToCustomer': CustomerToJSON(value['assignedToCustomer']),
+        'assignedToCustomerId': value['assignedToCustomerId'],
+        'completedByUser': UserToJSON(value['completedByUser']),
+        'completedByUserId': value['completedByUserId'],
+        'name': value['name'],
+        'description': value['description'],
+        'dueDate': ((value['dueDate']).toISOString()),
+        'status': TaskCompletionStatusToJSON(value['status']),
+        'checklist': ChecklistToJSON(value['checklist']),
+        'checklistId': value['checklistId'],
+        'taskDefinition': TaskDefinitionToJSON(value['taskDefinition']),
+        'taskDefinitionId': value['taskDefinitionId'],
+        'checklistRun': value['checklistRun'],
+    };
+}
+

package/src/generated/models/template-field.ts

@@ -53,6 +53,12 @@ export interface TemplateField {
      * @memberof TemplateField
      */
     type: FieldType;
+    /**
+     * Whether the field is required or not
+     * @type {boolean}
+     * @memberof TemplateField
+     */
+    required: boolean;
     /**
      * The locations in the document the field appears
      * @type {Array<FieldArea>}
@@ -75,6 +81,7 @@ export interface TemplateField {
 export function instanceOfTemplateField(value: object): value is TemplateField {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('required' in value) || value['required'] === undefined) return false;
     if (!('areas' in value) || value['areas'] === undefined) return false;
     return true;
 }
@@ -91,6 +98,7 @@ export function TemplateFieldFromJSONTyped(json: any, ignoreDiscriminator: boole
         
         'name': json['name'],
         'type': FieldTypeFromJSON(json['type']),
+        'required': json['required'],
         'areas': ((json['areas'] as Array<any>).map(FieldAreaFromJSON)),
         'preferences': json['preferences'] == null ? undefined : FieldPreferencesFromJSON(json['preferences']),
     };
@@ -109,6 +117,7 @@ export function TemplateFieldToJSONTyped(value?: TemplateField | null, ignoreDis
         
         'name': value['name'],
         'type': FieldTypeToJSON(value['type']),
+        'required': value['required'],
         'areas': ((value['areas'] as Array<any>).map(FieldAreaToJSON)),
         'preferences': FieldPreferencesToJSON(value['preferences']),
     };

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

@@ -262,12 +262,6 @@ export interface UpdateSubscriptionCharge {
      * @memberof UpdateSubscriptionCharge
      */
     customRecognitionEndDate?: string;
-    /**
-     * Transaction type
-     * @type {Array<TransactionPostingEntries>}
-     * @memberof UpdateSubscriptionCharge
-     */
-    transactionPostingEntries?: Array<TransactionPostingEntries>;
     /**
      * Charge ID
      * @type {string}
@@ -298,6 +292,12 @@ export interface UpdateSubscriptionCharge {
      * @memberof UpdateSubscriptionCharge
      */
     assetId?: string;
+    /**
+     * Transaction type
+     * @type {Array<TransactionPostingEntries>}
+     * @memberof UpdateSubscriptionCharge
+     */
+    transactionPostingEntries?: Array<TransactionPostingEntries>;
 }
 
 /**
@@ -361,12 +361,12 @@ export function UpdateSubscriptionChargeFromJSONTyped(json: any, ignoreDiscrimin
         'recognitionStartDate': json['recognitionStartDate'] == null ? undefined : json['recognitionStartDate'],
         'customRecognitionStartDate': json['customRecognitionStartDate'] == null ? undefined : json['customRecognitionStartDate'],
         'customRecognitionEndDate': json['customRecognitionEndDate'] == null ? undefined : json['customRecognitionEndDate'],
-        'transactionPostingEntries': json['transactionPostingEntries'] == null ? undefined : ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
         'chargeId': json['chargeId'] == null ? undefined : json['chargeId'],
         'chargeType': json['chargeType'],
         'billingPeriod': json['billingPeriod'],
         'listPrice': json['listPrice'],
         'assetId': json['assetId'] == null ? undefined : json['assetId'],
+        'transactionPostingEntries': json['transactionPostingEntries'] == null ? undefined : ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
     };
 }
 
@@ -419,12 +419,12 @@ export function UpdateSubscriptionChargeToJSONTyped(value?: UpdateSubscriptionCh
         'recognitionStartDate': value['recognitionStartDate'],
         'customRecognitionStartDate': value['customRecognitionStartDate'],
         'customRecognitionEndDate': value['customRecognitionEndDate'],
-        'transactionPostingEntries': value['transactionPostingEntries'] == null ? undefined : ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
         'chargeId': value['chargeId'],
         'chargeType': value['chargeType'],
         'billingPeriod': value['billingPeriod'],
         'listPrice': value['listPrice'],
         'assetId': value['assetId'],
+        'transactionPostingEntries': value['transactionPostingEntries'] == null ? undefined : ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
     };
 }
 

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

@@ -159,6 +159,12 @@ export interface UpdateSubscription {
      * @memberof UpdateSubscription
      */
     assetId?: string;
+    /**
+     * The date the subscription is paid until.
+     * @type {Date}
+     * @memberof UpdateSubscription
+     */
+    paidThroughDate?: Date;
     /**
      * Id of billing contact
      * @type {string}
@@ -268,6 +274,7 @@ export function UpdateSubscriptionFromJSONTyped(json: any, ignoreDiscriminator:
         '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'],
         'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
@@ -315,6 +322,7 @@ export function UpdateSubscriptionToJSONTyped(value?: UpdateSubscription | null,
         'currentTermEndDate': value['currentTermEndDate'],
         'renewalIncrementPercent': value['renewalIncrementPercent'],
         'assetId': value['assetId'],
+        'paidThroughDate': value['paidThroughDate'] == null ? undefined : ((value['paidThroughDate']).toISOString()),
         'billContactId': value['billContactId'],
         'shippingContactId': value['shippingContactId'],
         'updatedAt': value['updatedAt'],

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

@@ -0,0 +1,113 @@
+/* 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 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 {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'])),
+        '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()),
+        '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'],
+    };
+}
+