@managespace/sdk 0.0.90 → 0.0.91

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

@@ -0,0 +1,216 @@
+/* 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 { OrderLineItem } from './order-line-item';
+import {
+    OrderLineItemFromJSON,
+    OrderLineItemFromJSONTyped,
+    OrderLineItemToJSON,
+    OrderLineItemToJSONTyped,
+} from './order-line-item';
+
+/**
+ * 
+ * @export
+ * @interface CreateOrder
+ */
+export interface CreateOrder {
+    /**
+     * If order status is invoiced, associated invoice id
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    invoiceId?: string;
+    /**
+     * Date order was placed
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    orderDate: string;
+    /**
+     * Customer ID associated with order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    customerId: string;
+    /**
+     * Order status
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    status: string;
+    /**
+     *  Total amount of order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    orderAmount: string;
+    /**
+     * Enable to create separate invoice for this order
+     * @type {boolean}
+     * @memberof CreateOrder
+     */
+    separateInvoice: boolean;
+    /**
+     * Currency of the order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    currency: string;
+    /**
+     * Billing contact ID
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    billContactId?: string;
+    /**
+     * Shipping contact ID
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    shippingContactId?: string;
+    /**
+     * Payment terms to calculate due date of invoice
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    paymentTerms?: string;
+    /**
+     * Misceallaneous notes on order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    notes?: string;
+    /**
+     * Coupon code applied to order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    couponCode?: string;
+    /**
+     * Invoice line items
+     * @type {Array<OrderLineItem>}
+     * @memberof CreateOrder
+     */
+    lineItems: Array<OrderLineItem>;
+    /**
+     * The date the order was created
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    createdAt?: string;
+    /**
+     * The date the order was updated
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    updatedAt?: string;
+    /**
+     * Who created the order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    createdBy?: string;
+    /**
+     * Who updated the order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    updatedBy?: string;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof CreateOrder
+     */
+    customFields?: object;
+}
+
+/**
+ * Check if a given object implements the CreateOrder interface.
+ */
+export function instanceOfCreateOrder(value: object): value is CreateOrder {
+    if (!('orderDate' in value) || value['orderDate'] === undefined) return false;
+    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;
+    return true;
+}
+
+export function CreateOrderFromJSON(json: any): CreateOrder {
+    return CreateOrderFromJSONTyped(json, false);
+}
+
+export function CreateOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrder {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'invoiceId': json['invoiceId'] == null ? undefined : json['invoiceId'],
+        'orderDate': json['orderDate'],
+        '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'],
+        'paymentTerms': json['paymentTerms'] == null ? undefined : json['paymentTerms'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'couponCode': json['couponCode'] == null ? undefined : json['couponCode'],
+        'lineItems': ((json['lineItems'] as Array<any>).map(OrderLineItemFromJSON)),
+        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
+        'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
+        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
+        'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
+        'customFields': json['customFields'] == null ? undefined : json['customFields'],
+    };
+}
+
+export function CreateOrderToJSON(json: any): CreateOrder {
+    return CreateOrderToJSONTyped(json, false);
+}
+
+export function CreateOrderToJSONTyped(value?: CreateOrder | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'invoiceId': value['invoiceId'],
+        'orderDate': value['orderDate'],
+        'customerId': value['customerId'],
+        'status': value['status'],
+        'orderAmount': value['orderAmount'],
+        'separateInvoice': value['separateInvoice'],
+        'currency': value['currency'],
+        'billContactId': value['billContactId'],
+        'shippingContactId': value['shippingContactId'],
+        'paymentTerms': value['paymentTerms'],
+        'notes': value['notes'],
+        'couponCode': value['couponCode'],
+        'lineItems': ((value['lineItems'] as Array<any>).map(OrderLineItemToJSON)),
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'customFields': value['customFields'],
+    };
+}
+

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

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { PaymentRunFilterOptionResponse } from './payment-run-filter-option-response';
+import type { PaymentRunFilterOptions } from './payment-run-filter-options';
 import {
-    PaymentRunFilterOptionResponseFromJSON,
-    PaymentRunFilterOptionResponseFromJSONTyped,
-    PaymentRunFilterOptionResponseToJSON,
-    PaymentRunFilterOptionResponseToJSONTyped,
-} from './payment-run-filter-option-response';
+    PaymentRunFilterOptionsFromJSON,
+    PaymentRunFilterOptionsFromJSONTyped,
+    PaymentRunFilterOptionsToJSON,
+    PaymentRunFilterOptionsToJSONTyped,
+} from './payment-run-filter-options';
 
 /**
  * 
@@ -29,10 +29,10 @@ import {
 export interface CreatePaymentRun {
     /**
      * Filter options for payment run
-     * @type {PaymentRunFilterOptionResponse}
+     * @type {PaymentRunFilterOptions}
      * @memberof CreatePaymentRun
      */
-    filterOptions?: PaymentRunFilterOptionResponse;
+    filterOptions?: PaymentRunFilterOptions;
     /**
      * The last Date included in the Payment Run
      * @type {string}
@@ -59,7 +59,7 @@ export function CreatePaymentRunFromJSONTyped(json: any, ignoreDiscriminator: bo
     }
     return {
         
-        'filterOptions': json['filterOptions'] == null ? undefined : PaymentRunFilterOptionResponseFromJSON(json['filterOptions']),
+        'filterOptions': json['filterOptions'] == null ? undefined : PaymentRunFilterOptionsFromJSON(json['filterOptions']),
         'targetDate': json['targetDate'],
     };
 }
@@ -75,7 +75,7 @@ export function CreatePaymentRunToJSONTyped(value?: CreatePaymentRun | null, ign
 
     return {
         
-        'filterOptions': PaymentRunFilterOptionResponseToJSON(value['filterOptions']),
+        'filterOptions': PaymentRunFilterOptionsToJSON(value['filterOptions']),
         'targetDate': value['targetDate'],
     };
 }

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

@@ -46,6 +46,12 @@ export interface CreatePayment {
      * @memberof CreatePayment
      */
     paymentDate: string;
+    /**
+     * Miscellaneous notes
+     * @type {string}
+     * @memberof CreatePayment
+     */
+    notes?: string;
     /**
      * Status of payment
      * @type {string}
@@ -63,7 +69,7 @@ export interface CreatePayment {
      * @type {string}
      * @memberof CreatePayment
      */
-    feeAmount: string;
+    feeAmount?: string;
     /**
      * Amount of payment applied to invoices
      * @type {string}
@@ -76,6 +82,12 @@ export interface CreatePayment {
      * @memberof CreatePayment
      */
     unappliedAmount: string;
+    /**
+     * Refunded amount
+     * @type {string}
+     * @memberof CreatePayment
+     */
+    refundedAmount?: string;
     /**
      * External or Electronic payments
      * @type {string}
@@ -87,19 +99,31 @@ export interface CreatePayment {
      * @type {string}
      * @memberof CreatePayment
      */
-    paymentMethod: string;
+    paymentMethod?: string;
+    /**
+     * Payment token
+     * @type {string}
+     * @memberof CreatePayment
+     */
+    paymentToken?: string;
     /**
      * Payment method saved and used for future billing
      * @type {boolean}
      * @memberof CreatePayment
      */
-    saveForLater: boolean;
+    saveForLater?: boolean;
     /**
      * Currency
      * @type {string}
      * @memberof CreatePayment
      */
     currency: string;
+    /**
+     * Reference number for payment transaction
+     * @type {string}
+     * @memberof CreatePayment
+     */
+    referenceNumber?: string;
     /**
      * Automatically apply unapplied amount to next invoice
      * @type {boolean}
@@ -107,59 +131,65 @@ export interface CreatePayment {
      */
     autoApply: boolean;
     /**
-     * General Ledger account
+     * Date of record created
      * @type {string}
      * @memberof CreatePayment
      */
-    glAccount: string;
+    createdAt?: string;
     /**
-     * Generate email
-     * @type {boolean}
+     * Date record was last modified
+     * @type {string}
      * @memberof CreatePayment
      */
-    emailStatus: boolean;
+    updatedAt?: string;
     /**
-     * Custom fields on the invoice
-     * @type {object}
+     * Email of user who created record
+     * @type {string}
      * @memberof CreatePayment
      */
-    customFields: object;
+    createdBy?: string;
     /**
-     * Miscellaneous notes
+     * Email of user who last modifed record
      * @type {string}
      * @memberof CreatePayment
      */
-    notes?: string;
+    updatedBy?: string;
     /**
-     * Payment token
-     * @type {string}
+     * List of invoices paid by payment
+     * @type {Array<CreatePaymentInvoice>}
      * @memberof CreatePayment
      */
-    paymentToken?: string;
+    invoices?: Array<CreatePaymentInvoice>;
     /**
-     * Reference number for payment transaction
-     * @type {string}
+     * List of refunds associated with payment
+     * @type {Array<CreatePaymentRefund>}
      * @memberof CreatePayment
      */
-    referenceNumber?: string;
+    refunds?: Array<CreatePaymentRefund>;
     /**
-     * Gateway Name for electronic payment
+     * General Ledger account
      * @type {string}
      * @memberof CreatePayment
      */
-    gatewayName?: string;
+    glAccount: string;
     /**
-     * List of invoices paid by payment
-     * @type {Array<CreatePaymentInvoice>}
+     * Number of retry attempts made
+     * @type {number}
      * @memberof CreatePayment
      */
-    invoices: Array<CreatePaymentInvoice>;
+    retriedAttempts?: number;
     /**
-     * List of refunds associated with payment
-     * @type {Array<CreatePaymentRefund>}
+     * Gateway Name for electronic payment
+     * @type {string}
      * @memberof CreatePayment
      */
-    refunds?: Array<CreatePaymentRefund>;
+    gatewayName?: string;
+    /**
+     * Generate email
+     * @type {boolean}
+     * @memberof CreatePayment
+     */
+    emailStatus: boolean;
 }
 
 /**
@@ -170,18 +200,13 @@ export function instanceOfCreatePayment(value: object): value is CreatePayment {
     if (!('paymentDate' in value) || value['paymentDate'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('paymentAmount' in value) || value['paymentAmount'] === undefined) return false;
-    if (!('feeAmount' in value) || value['feeAmount'] === undefined) return false;
     if (!('appliedAmount' in value) || value['appliedAmount'] === undefined) return false;
     if (!('unappliedAmount' in value) || value['unappliedAmount'] === undefined) return false;
     if (!('paymentType' in value) || value['paymentType'] === undefined) return false;
-    if (!('paymentMethod' in value) || value['paymentMethod'] === undefined) return false;
-    if (!('saveForLater' in value) || value['saveForLater'] === undefined) return false;
     if (!('currency' in value) || value['currency'] === undefined) return false;
     if (!('autoApply' in value) || value['autoApply'] === undefined) return false;
     if (!('glAccount' in value) || value['glAccount'] === undefined) return false;
     if (!('emailStatus' in value) || value['emailStatus'] === undefined) return false;
-    if (!('customFields' in value) || value['customFields'] === undefined) return false;
-    if (!('invoices' in value) || value['invoices'] === undefined) return false;
     return true;
 }
 
@@ -197,25 +222,30 @@ export function CreatePaymentFromJSONTyped(json: any, ignoreDiscriminator: boole
         
         'customerId': json['customerId'],
         'paymentDate': json['paymentDate'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
         'status': json['status'],
         'paymentAmount': json['paymentAmount'],
-        'feeAmount': json['feeAmount'],
+        'feeAmount': json['feeAmount'] == null ? undefined : json['feeAmount'],
         'appliedAmount': json['appliedAmount'],
         'unappliedAmount': json['unappliedAmount'],
+        'refundedAmount': json['refundedAmount'] == null ? undefined : json['refundedAmount'],
         'paymentType': json['paymentType'],
-        'paymentMethod': json['paymentMethod'],
-        'saveForLater': json['saveForLater'],
+        'paymentMethod': json['paymentMethod'] == null ? undefined : json['paymentMethod'],
+        'paymentToken': json['paymentToken'] == null ? undefined : json['paymentToken'],
+        'saveForLater': json['saveForLater'] == null ? undefined : json['saveForLater'],
         'currency': json['currency'],
+        'referenceNumber': json['referenceNumber'] == null ? undefined : json['referenceNumber'],
         'autoApply': json['autoApply'],
+        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
+        'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
+        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
+        'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
+        'invoices': json['invoices'] == null ? undefined : ((json['invoices'] as Array<any>).map(CreatePaymentInvoiceFromJSON)),
+        'refunds': json['refunds'] == null ? undefined : ((json['refunds'] as Array<any>).map(CreatePaymentRefundFromJSON)),
         'glAccount': json['glAccount'],
-        'emailStatus': json['emailStatus'],
-        'customFields': json['customFields'],
-        'notes': json['notes'] == null ? undefined : json['notes'],
-        'paymentToken': json['paymentToken'] == null ? undefined : json['paymentToken'],
-        'referenceNumber': json['referenceNumber'] == null ? undefined : json['referenceNumber'],
+        'retriedAttempts': json['retriedAttempts'] == null ? undefined : json['retriedAttempts'],
         'gatewayName': json['gatewayName'] == null ? undefined : json['gatewayName'],
-        'invoices': ((json['invoices'] as Array<any>).map(CreatePaymentInvoiceFromJSON)),
-        'refunds': json['refunds'] == null ? undefined : ((json['refunds'] as Array<any>).map(CreatePaymentRefundFromJSON)),
+        'emailStatus': json['emailStatus'],
     };
 }
 
@@ -232,25 +262,30 @@ export function CreatePaymentToJSONTyped(value?: CreatePayment | null, ignoreDis
         
         'customerId': value['customerId'],
         'paymentDate': value['paymentDate'],
+        'notes': value['notes'],
         'status': value['status'],
         'paymentAmount': value['paymentAmount'],
         'feeAmount': value['feeAmount'],
         'appliedAmount': value['appliedAmount'],
         'unappliedAmount': value['unappliedAmount'],
+        'refundedAmount': value['refundedAmount'],
         'paymentType': value['paymentType'],
         'paymentMethod': value['paymentMethod'],
+        'paymentToken': value['paymentToken'],
         'saveForLater': value['saveForLater'],
         'currency': value['currency'],
+        'referenceNumber': value['referenceNumber'],
         'autoApply': value['autoApply'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'invoices': value['invoices'] == null ? undefined : ((value['invoices'] as Array<any>).map(CreatePaymentInvoiceToJSON)),
+        'refunds': value['refunds'] == null ? undefined : ((value['refunds'] as Array<any>).map(CreatePaymentRefundToJSON)),
         'glAccount': value['glAccount'],
-        'emailStatus': value['emailStatus'],
-        'customFields': value['customFields'],
-        'notes': value['notes'],
-        'paymentToken': value['paymentToken'],
-        'referenceNumber': value['referenceNumber'],
+        'retriedAttempts': value['retriedAttempts'],
         'gatewayName': value['gatewayName'],
-        'invoices': ((value['invoices'] as Array<any>).map(CreatePaymentInvoiceToJSON)),
-        'refunds': value['refunds'] == null ? undefined : ((value['refunds'] as Array<any>).map(CreatePaymentRefundToJSON)),
+        'emailStatus': value['emailStatus'],
     };
 }
 

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

@@ -46,17 +46,17 @@ export interface CustomCreateCustomer {
      */
     balance?: number;
     /**
-     * Contact information.
-     * @type {Array<CustomCreateContact>}
+     * Any relevant metadata for the customer
+     * @type {object}
      * @memberof CustomCreateCustomer
      */
-    contacts: Array<CustomCreateContact>;
+    metadata: object;
     /**
-     * Tennant ID.
-     * @type {string}
+     * Contact information.
+     * @type {Array<CustomCreateContact>}
      * @memberof CustomCreateCustomer
      */
-    tenantId?: string;
+    contacts: Array<CustomCreateContact>;
     /**
      * autoPay
      * @type {boolean}
@@ -142,6 +142,7 @@ export interface CustomCreateCustomer {
  */
 export function instanceOfCustomCreateCustomer(value: object): value is CustomCreateCustomer {
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('metadata' in value) || value['metadata'] === undefined) return false;
     if (!('contacts' in value) || value['contacts'] === undefined) return false;
     return true;
 }
@@ -159,8 +160,8 @@ export function CustomCreateCustomerFromJSONTyped(json: any, ignoreDiscriminator
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'balance': json['balance'] == null ? undefined : json['balance'],
+        'metadata': json['metadata'],
         'contacts': ((json['contacts'] as Array<any>).map(CustomCreateContactFromJSON)),
-        'tenantId': json['tenantId'] == null ? undefined : json['tenantId'],
         'autoPay': json['autoPay'] == null ? undefined : json['autoPay'],
         'billingCycleDay': json['billingCycleDay'] == null ? undefined : json['billingCycleDay'],
         'currency': json['currency'] == null ? undefined : json['currency'],
@@ -191,8 +192,8 @@ export function CustomCreateCustomerToJSONTyped(value?: CustomCreateCustomer | n
         'name': value['name'],
         'description': value['description'],
         'balance': value['balance'],
+        'metadata': value['metadata'],
         'contacts': ((value['contacts'] as Array<any>).map(CustomCreateContactToJSON)),
-        'tenantId': value['tenantId'],
         'autoPay': value['autoPay'],
         'billingCycleDay': value['billingCycleDay'],
         'currency': value['currency'],

package/src/generated/models/custom-update-customer.ts

@@ -37,6 +37,12 @@ export interface CustomUpdateCustomer {
      * @memberof CustomUpdateCustomer
      */
     balance?: number;
+    /**
+     * Any relevant metadata for the customer
+     * @type {object}
+     * @memberof CustomUpdateCustomer
+     */
+    metadata?: object;
     /**
      * Tennant ID.
      * @type {string}
@@ -143,6 +149,7 @@ export function CustomUpdateCustomerFromJSONTyped(json: any, ignoreDiscriminator
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'balance': json['balance'] == null ? undefined : json['balance'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
         'tenantId': json['tenantId'] == null ? undefined : json['tenantId'],
         'autoPay': json['autoPay'] == null ? undefined : json['autoPay'],
         'billingCycleDay': json['billingCycleDay'] == null ? undefined : json['billingCycleDay'],
@@ -174,6 +181,7 @@ export function CustomUpdateCustomerToJSONTyped(value?: CustomUpdateCustomer | n
         'name': value['name'],
         'description': value['description'],
         'balance': value['balance'],
+        'metadata': value['metadata'],
         'tenantId': value['tenantId'],
         'autoPay': value['autoPay'],
         'billingCycleDay': value['billingCycleDay'],

package/src/generated/models/customer-response.ts

@@ -114,6 +114,12 @@ export interface CustomerResponse {
      * @memberof CustomerResponse
      */
     balance: number;
+    /**
+     * Any relevant metadata for the customer
+     * @type {object}
+     * @memberof CustomerResponse
+     */
+    metadata: object;
     /**
      * 
      * @type {Array<CommunicationResponse>}
@@ -134,6 +140,7 @@ export function instanceOfCustomerResponse(value: object): value is CustomerResp
     if (!('orgId' in value) || value['orgId'] === undefined) return false;
     if (!('externalId' in value) || value['externalId'] === undefined) return false;
     if (!('balance' in value) || value['balance'] === undefined) return false;
+    if (!('metadata' in value) || value['metadata'] === undefined) return false;
     return true;
 }
 
@@ -158,6 +165,7 @@ export function CustomerResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         'note': json['note'] == null ? undefined : ((json['note'] as Array<any>).map(NoteResponseFromJSON)),
         'externalId': json['externalId'],
         'balance': json['balance'],
+        'metadata': json['metadata'],
         'communications': json['communications'] == null ? undefined : ((json['communications'] as Array<any>).map(CommunicationResponseFromJSON)),
     };
 }
@@ -184,6 +192,7 @@ export function CustomerResponseToJSONTyped(value?: CustomerResponse | null, ign
         'note': value['note'] == null ? undefined : ((value['note'] as Array<any>).map(NoteResponseToJSON)),
         'externalId': value['externalId'],
         'balance': value['balance'],
+        'metadata': value['metadata'],
         'communications': value['communications'] == null ? undefined : ((value['communications'] as Array<any>).map(CommunicationResponseToJSON)),
     };
 }