@managespace/sdk 0.1.10 → 0.1.11-5.paul.dev

package/src/generated/models/create-credit-invoice.ts

@@ -0,0 +1,75 @@
+/* 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 CreateCreditInvoice
+ */
+export interface CreateCreditInvoice {
+    /**
+     * Invoice ID
+     * @type {string}
+     * @memberof CreateCreditInvoice
+     */
+    id: string;
+    /**
+     * Amount applied from credit to invoice
+     * @type {string}
+     * @memberof CreateCreditInvoice
+     */
+    amountApplied: string;
+}
+
+/**
+ * Check if a given object implements the CreateCreditInvoice interface.
+ */
+export function instanceOfCreateCreditInvoice(value: object): value is CreateCreditInvoice {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('amountApplied' in value) || value['amountApplied'] === undefined) return false;
+    return true;
+}
+
+export function CreateCreditInvoiceFromJSON(json: any): CreateCreditInvoice {
+    return CreateCreditInvoiceFromJSONTyped(json, false);
+}
+
+export function CreateCreditInvoiceFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCreditInvoice {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'amountApplied': json['amountApplied'],
+    };
+}
+
+export function CreateCreditInvoiceToJSON(json: any): CreateCreditInvoice {
+    return CreateCreditInvoiceToJSONTyped(json, false);
+}
+
+export function CreateCreditInvoiceToJSONTyped(value?: CreateCreditInvoice | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'amountApplied': value['amountApplied'],
+    };
+}
+

package/src/generated/models/create-credit.ts

@@ -0,0 +1,148 @@
+/* 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 { CreateCreditInvoice } from './create-credit-invoice';
+import {
+    CreateCreditInvoiceFromJSON,
+    CreateCreditInvoiceFromJSONTyped,
+    CreateCreditInvoiceToJSON,
+    CreateCreditInvoiceToJSONTyped,
+} from './create-credit-invoice';
+
+/**
+ * 
+ * @export
+ * @interface CreateCredit
+ */
+export interface CreateCredit {
+    /**
+     * Customer ID
+     * @type {string}
+     * @memberof CreateCredit
+     */
+    customerId: string;
+    /**
+     * Date of the credit
+     * @type {string}
+     * @memberof CreateCredit
+     */
+    creditDate: string;
+    /**
+     * Amount of credit
+     * @type {string}
+     * @memberof CreateCredit
+     */
+    creditAmount: string;
+    /**
+     * Notes about the credit
+     * @type {string}
+     * @memberof CreateCredit
+     */
+    notes?: string;
+    /**
+     * Amount applied to invoices
+     * @type {string}
+     * @memberof CreateCredit
+     */
+    appliedAmount?: string;
+    /**
+     * Unapplied credit amount
+     * @type {string}
+     * @memberof CreateCredit
+     */
+    unappliedAmount?: string;
+    /**
+     * Currency code
+     * @type {string}
+     * @memberof CreateCredit
+     */
+    currency?: string;
+    /**
+     * Automatically apply credit to most recent invoice
+     * @type {boolean}
+     * @memberof CreateCredit
+     */
+    autoApply?: boolean;
+    /**
+     * Subscription ID (custom field)
+     * @type {string}
+     * @memberof CreateCredit
+     */
+    subscriptionId?: string;
+    /**
+     * List of invoices to apply credit to
+     * @type {Array<CreateCreditInvoice>}
+     * @memberof CreateCredit
+     */
+    invoices?: Array<CreateCreditInvoice>;
+}
+
+/**
+ * Check if a given object implements the CreateCredit interface.
+ */
+export function instanceOfCreateCredit(value: object): value is CreateCredit {
+    if (!('customerId' in value) || value['customerId'] === undefined) return false;
+    if (!('creditDate' in value) || value['creditDate'] === undefined) return false;
+    if (!('creditAmount' in value) || value['creditAmount'] === undefined) return false;
+    return true;
+}
+
+export function CreateCreditFromJSON(json: any): CreateCredit {
+    return CreateCreditFromJSONTyped(json, false);
+}
+
+export function CreateCreditFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCredit {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'customerId': json['customerId'],
+        'creditDate': json['creditDate'],
+        'creditAmount': json['creditAmount'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'appliedAmount': json['appliedAmount'] == null ? undefined : json['appliedAmount'],
+        'unappliedAmount': json['unappliedAmount'] == null ? undefined : json['unappliedAmount'],
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'autoApply': json['autoApply'] == null ? undefined : json['autoApply'],
+        'subscriptionId': json['subscriptionId'] == null ? undefined : json['subscriptionId'],
+        'invoices': json['invoices'] == null ? undefined : ((json['invoices'] as Array<any>).map(CreateCreditInvoiceFromJSON)),
+    };
+}
+
+export function CreateCreditToJSON(json: any): CreateCredit {
+    return CreateCreditToJSONTyped(json, false);
+}
+
+export function CreateCreditToJSONTyped(value?: CreateCredit | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'customerId': value['customerId'],
+        'creditDate': value['creditDate'],
+        'creditAmount': value['creditAmount'],
+        'notes': value['notes'],
+        'appliedAmount': value['appliedAmount'],
+        'unappliedAmount': value['unappliedAmount'],
+        'currency': value['currency'],
+        'autoApply': value['autoApply'],
+        'subscriptionId': value['subscriptionId'],
+        'invoices': value['invoices'] == null ? undefined : ((value['invoices'] as Array<any>).map(CreateCreditInvoiceToJSON)),
+    };
+}
+

package/src/generated/models/create-customer-status.ts

@@ -0,0 +1,99 @@
+/* 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 CreateCustomerStatus
+ */
+export interface CreateCustomerStatus {
+    /**
+     * User-defined status name
+     * @type {string}
+     * @memberof CreateCustomerStatus
+     */
+    name: string;
+    /**
+     * Order in the status sequence
+     * @type {number}
+     * @memberof CreateCustomerStatus
+     */
+    sequence: number;
+    /**
+     * Internal status categorisation
+     * @type {string}
+     * @memberof CreateCustomerStatus
+     */
+    knownStatus?: string | null;
+    /**
+     * Description of the status
+     * @type {string}
+     * @memberof CreateCustomerStatus
+     */
+    description?: string | null;
+    /**
+     * Colour for UI representation
+     * @type {string}
+     * @memberof CreateCustomerStatus
+     */
+    colour?: string | null;
+}
+
+/**
+ * Check if a given object implements the CreateCustomerStatus interface.
+ */
+export function instanceOfCreateCustomerStatus(value: object): value is CreateCustomerStatus {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('sequence' in value) || value['sequence'] === undefined) return false;
+    return true;
+}
+
+export function CreateCustomerStatusFromJSON(json: any): CreateCustomerStatus {
+    return CreateCustomerStatusFromJSONTyped(json, false);
+}
+
+export function CreateCustomerStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCustomerStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'sequence': json['sequence'],
+        'knownStatus': json['knownStatus'] == null ? undefined : json['knownStatus'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'colour': json['colour'] == null ? undefined : json['colour'],
+    };
+}
+
+export function CreateCustomerStatusToJSON(json: any): CreateCustomerStatus {
+    return CreateCustomerStatusToJSONTyped(json, false);
+}
+
+export function CreateCustomerStatusToJSONTyped(value?: CreateCustomerStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'sequence': value['sequence'],
+        'knownStatus': value['knownStatus'],
+        'description': value['description'],
+        'colour': value['colour'],
+    };
+}
+

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

@@ -40,18 +40,6 @@ export interface CreateDocument {
      * @memberof CreateDocument
      */
     templateId: string;
-    /**
-     * The ID of the workflow that created the document.
-     * @type {string}
-     * @memberof CreateDocument
-     */
-    workflowId?: string;
-    /**
-     * The ID of the workflow step that created the document.
-     * @type {string}
-     * @memberof CreateDocument
-     */
-    workflowStepId?: string;
     /**
      * The signers of the template
      * @type {Array<DocumentSigner>}
@@ -64,6 +52,12 @@ export interface CreateDocument {
      * @memberof CreateDocument
      */
     fields?: Array<DocumentField>;
+    /**
+     * Metadata for the document
+     * @type {object}
+     * @memberof CreateDocument
+     */
+    metadata?: object;
 }
 
 /**
@@ -85,10 +79,9 @@ export function CreateDocumentFromJSONTyped(json: any, ignoreDiscriminator: bool
     return {
         
         'templateId': json['templateId'],
-        'workflowId': json['workflowId'] == null ? undefined : json['workflowId'],
-        'workflowStepId': json['workflowStepId'] == null ? undefined : json['workflowStepId'],
         'signers': json['signers'] == null ? undefined : ((json['signers'] as Array<any>).map(DocumentSignerFromJSON)),
         'fields': json['fields'] == null ? undefined : ((json['fields'] as Array<any>).map(DocumentFieldFromJSON)),
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
     };
 }
 
@@ -104,10 +97,9 @@ export function CreateDocumentToJSONTyped(value?: CreateDocument | null, ignoreD
     return {
         
         'templateId': value['templateId'],
-        'workflowId': value['workflowId'],
-        'workflowStepId': value['workflowStepId'],
         'signers': value['signers'] == null ? undefined : ((value['signers'] as Array<any>).map(DocumentSignerToJSON)),
         'fields': value['fields'] == null ? undefined : ((value['fields'] as Array<any>).map(DocumentFieldToJSON)),
+        'metadata': value['metadata'],
     };
 }
 

package/src/generated/models/create-notes.ts

@@ -0,0 +1,74 @@
+/* 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 { CreateNote } from './create-note';
+import {
+    CreateNoteFromJSON,
+    CreateNoteFromJSONTyped,
+    CreateNoteToJSON,
+    CreateNoteToJSONTyped,
+} from './create-note';
+
+/**
+ * 
+ * @export
+ * @interface CreateNotes
+ */
+export interface CreateNotes {
+    /**
+     * The notes to create.
+     * @type {Array<CreateNote>}
+     * @memberof CreateNotes
+     */
+    notes: Array<CreateNote>;
+}
+
+/**
+ * Check if a given object implements the CreateNotes interface.
+ */
+export function instanceOfCreateNotes(value: object): value is CreateNotes {
+    if (!('notes' in value) || value['notes'] === undefined) return false;
+    return true;
+}
+
+export function CreateNotesFromJSON(json: any): CreateNotes {
+    return CreateNotesFromJSONTyped(json, false);
+}
+
+export function CreateNotesFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateNotes {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'notes': ((json['notes'] as Array<any>).map(CreateNoteFromJSON)),
+    };
+}
+
+export function CreateNotesToJSON(json: any): CreateNotes {
+    return CreateNotesToJSONTyped(json, false);
+}
+
+export function CreateNotesToJSONTyped(value?: CreateNotes | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'notes': ((value['notes'] as Array<any>).map(CreateNoteToJSON)),
+    };
+}
+

package/src/generated/models/create-order.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { OrderType } from './order-type';
+import {
+    OrderTypeFromJSON,
+    OrderTypeFromJSONTyped,
+    OrderTypeToJSON,
+    OrderTypeToJSONTyped,
+} from './order-type';
 import type { OrderLineItem } from './order-line-item';
 import {
     OrderLineItemFromJSON,
@@ -57,12 +64,6 @@ export interface CreateOrder {
      * @memberof CreateOrder
      */
     orderAmount: string;
-    /**
-     * Enable to create separate invoice for this order
-     * @type {boolean}
-     * @memberof CreateOrder
-     */
-    separateInvoice: boolean;
     /**
      * Currency of the order
      * @type {string}
@@ -141,8 +142,22 @@ export interface CreateOrder {
      * @memberof CreateOrder
      */
     assetId?: string;
+    /**
+     * Subscription Id associated with order, if it is a fee
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    subscriptionId?: string;
+    /**
+     * 
+     * @type {OrderType}
+     * @memberof CreateOrder
+     */
+    orderType: OrderType;
 }
 
+
+
 /**
  * Check if a given object implements the CreateOrder interface.
  */
@@ -151,9 +166,9 @@ export function instanceOfCreateOrder(value: object): value is CreateOrder {
     if (!('customerId' in value) || value['customerId'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('orderAmount' in value) || value['orderAmount'] === undefined) return false;
-    if (!('separateInvoice' in value) || value['separateInvoice'] === undefined) return false;
     if (!('currency' in value) || value['currency'] === undefined) return false;
     if (!('lineItems' in value) || value['lineItems'] === undefined) return false;
+    if (!('orderType' in value) || value['orderType'] === undefined) return false;
     return true;
 }
 
@@ -172,7 +187,6 @@ export function CreateOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'customerId': json['customerId'],
         'status': json['status'],
         'orderAmount': json['orderAmount'],
-        'separateInvoice': json['separateInvoice'],
         'currency': json['currency'],
         'billContactId': json['billContactId'] == null ? undefined : json['billContactId'],
         'shippingContactId': json['shippingContactId'] == null ? undefined : json['shippingContactId'],
@@ -186,6 +200,8 @@ export function CreateOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
         'customFields': json['customFields'] == null ? undefined : json['customFields'],
         'assetId': json['assetId'] == null ? undefined : json['assetId'],
+        'subscriptionId': json['subscriptionId'] == null ? undefined : json['subscriptionId'],
+        'orderType': OrderTypeFromJSON(json['orderType']),
     };
 }
 
@@ -205,7 +221,6 @@ export function CreateOrderToJSONTyped(value?: CreateOrder | null, ignoreDiscrim
         'customerId': value['customerId'],
         'status': value['status'],
         'orderAmount': value['orderAmount'],
-        'separateInvoice': value['separateInvoice'],
         'currency': value['currency'],
         'billContactId': value['billContactId'],
         'shippingContactId': value['shippingContactId'],
@@ -219,6 +234,8 @@ export function CreateOrderToJSONTyped(value?: CreateOrder | null, ignoreDiscrim
         'updatedBy': value['updatedBy'],
         'customFields': value['customFields'],
         'assetId': value['assetId'],
+        'subscriptionId': value['subscriptionId'],
+        'orderType': OrderTypeToJSON(value['orderType']),
     };
 }
 

package/src/generated/models/create-payment-method.ts

@@ -0,0 +1,155 @@
+/* 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 CreatePaymentMethod
+ */
+export interface CreatePaymentMethod {
+    /**
+     * Customers payment gateway id
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    customerPaymentGatewayId?: string;
+    /**
+     * Payment type
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    paymentType: string;
+    /**
+     * Type of card
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    type?: string;
+    /**
+     * Credit card or bank account number
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    accountNumber: string;
+    /**
+     * Routing number for bank accounts
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    routingNumber?: string;
+    /**
+     * Name on card or account
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    accountHolderName?: string;
+    /**
+     * Type of acccount owner
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    accountHolderType?: string;
+    /**
+     * Country of the account holder
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    country?: string;
+    /**
+     * Credit card expiration date
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    expiry?: string;
+    /**
+     * Account status for bank accounts
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    status?: string;
+    /**
+     * Enable defaule payment method
+     * @type {boolean}
+     * @memberof CreatePaymentMethod
+     */
+    _default?: boolean;
+    /**
+     * CVC, security code for payment method
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    cvc?: string;
+}
+
+/**
+ * Check if a given object implements the CreatePaymentMethod interface.
+ */
+export function instanceOfCreatePaymentMethod(value: object): value is CreatePaymentMethod {
+    if (!('paymentType' in value) || value['paymentType'] === undefined) return false;
+    if (!('accountNumber' in value) || value['accountNumber'] === undefined) return false;
+    return true;
+}
+
+export function CreatePaymentMethodFromJSON(json: any): CreatePaymentMethod {
+    return CreatePaymentMethodFromJSONTyped(json, false);
+}
+
+export function CreatePaymentMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePaymentMethod {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'customerPaymentGatewayId': json['customerPaymentGatewayId'] == null ? undefined : json['customerPaymentGatewayId'],
+        'paymentType': json['paymentType'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'accountNumber': json['accountNumber'],
+        'routingNumber': json['routingNumber'] == null ? undefined : json['routingNumber'],
+        'accountHolderName': json['accountHolderName'] == null ? undefined : json['accountHolderName'],
+        'accountHolderType': json['accountHolderType'] == null ? undefined : json['accountHolderType'],
+        'country': json['country'] == null ? undefined : json['country'],
+        'expiry': json['expiry'] == null ? undefined : json['expiry'],
+        'status': json['status'] == null ? undefined : json['status'],
+        '_default': json['default'] == null ? undefined : json['default'],
+        'cvc': json['cvc'] == null ? undefined : json['cvc'],
+    };
+}
+
+export function CreatePaymentMethodToJSON(json: any): CreatePaymentMethod {
+    return CreatePaymentMethodToJSONTyped(json, false);
+}
+
+export function CreatePaymentMethodToJSONTyped(value?: CreatePaymentMethod | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'customerPaymentGatewayId': value['customerPaymentGatewayId'],
+        'paymentType': value['paymentType'],
+        'type': value['type'],
+        'accountNumber': value['accountNumber'],
+        'routingNumber': value['routingNumber'],
+        'accountHolderName': value['accountHolderName'],
+        'accountHolderType': value['accountHolderType'],
+        'country': value['country'],
+        'expiry': value['expiry'],
+        'status': value['status'],
+        'default': value['_default'],
+        'cvc': value['cvc'],
+    };
+}
+