@managespace/sdk 0.1.188 → 0.1.190-melissa.dev

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

@@ -52,7 +52,7 @@ export interface CreateSubscriptionCharge {
      * @type {string}
      * @memberof CreateSubscriptionCharge
      */
-    planId: string;
+    planId?: string;
     /**
      * Name of plan
      * @type {string}
@@ -64,13 +64,13 @@ export interface CreateSubscriptionCharge {
      * @type {string}
      * @memberof CreateSubscriptionCharge
      */
-    chargeId: string;
+    chargeId?: string;
     /**
      * Name of charge
      * @type {string}
      * @memberof CreateSubscriptionCharge
      */
-    chargeName: string;
+    chargeName?: string;
     /**
      * How charge will be priced
      * @type {string}
@@ -101,12 +101,6 @@ export interface CreateSubscriptionCharge {
      * @memberof CreateSubscriptionCharge
      */
     includedUnits?: number;
-    /**
-     * Discount applied to product
-     * @type {number}
-     * @memberof CreateSubscriptionCharge
-     */
-    discount?: number;
     /**
      * Effective price of product
      * @type {string}
@@ -312,9 +306,6 @@ export interface CreateSubscriptionCharge {
  */
 export function instanceOfCreateSubscriptionCharge(value: object): value is CreateSubscriptionCharge {
     if (!('productId' in value) || value['productId'] === undefined) return false;
-    if (!('planId' in value) || value['planId'] === undefined) return false;
-    if (!('chargeId' in value) || value['chargeId'] === undefined) return false;
-    if (!('chargeName' in value) || value['chargeName'] === undefined) return false;
     if (!('assetId' in value) || value['assetId'] === undefined) return false;
     return true;
 }
@@ -331,16 +322,15 @@ export function CreateSubscriptionChargeFromJSONTyped(json: any, ignoreDiscrimin
         
         'productId': json['productId'],
         'productName': json['productName'] == null ? undefined : json['productName'],
-        'planId': json['planId'],
+        'planId': json['planId'] == null ? undefined : json['planId'],
         'planName': json['planName'] == null ? undefined : json['planName'],
-        'chargeId': json['chargeId'],
-        'chargeName': json['chargeName'],
+        'chargeId': json['chargeId'] == null ? undefined : json['chargeId'],
+        'chargeName': json['chargeName'] == null ? undefined : json['chargeName'],
         'pricingModel': json['pricingModel'] == null ? undefined : json['pricingModel'],
         'listPrice': json['listPrice'] == null ? undefined : json['listPrice'],
         'priceBase': json['priceBase'] == null ? undefined : json['priceBase'],
         'quantity': json['quantity'] == null ? undefined : json['quantity'],
         'includedUnits': json['includedUnits'] == null ? undefined : json['includedUnits'],
-        'discount': json['discount'] == null ? undefined : json['discount'],
         'effectivePrice': json['effectivePrice'] == null ? undefined : json['effectivePrice'],
         'chargeType': json['chargeType'] == null ? undefined : json['chargeType'],
         'billingPeriod': json['billingPeriod'] == null ? undefined : json['billingPeriod'],
@@ -399,7 +389,6 @@ export function CreateSubscriptionChargeToJSONTyped(value?: CreateSubscriptionCh
         'priceBase': value['priceBase'],
         'quantity': value['quantity'],
         'includedUnits': value['includedUnits'],
-        'discount': value['discount'],
         'effectivePrice': value['effectivePrice'],
         'chargeType': value['chargeType'],
         'billingPeriod': value['billingPeriod'],

package/src/generated/models/credit-applies-to-product-type.ts

@@ -0,0 +1,57 @@
+// @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.
+ */
+
+
+/**
+ * The product type this credit is intended to apply against
+ * @export
+ */
+export const CreditAppliesToProductType = {
+    RENT: 'RENT',
+    RENT_TREATMENT: 'RENT_TREATMENT',
+    INSURANCE: 'INSURANCE',
+    FEE: 'FEE',
+    MERCHANDISE: 'MERCHANDISE'
+} as const;
+export type CreditAppliesToProductType = typeof CreditAppliesToProductType[keyof typeof CreditAppliesToProductType];
+
+
+export function instanceOfCreditAppliesToProductType(value: any): boolean {
+    for (const key in CreditAppliesToProductType) {
+        if (Object.prototype.hasOwnProperty.call(CreditAppliesToProductType, key)) {
+            if (CreditAppliesToProductType[key as keyof typeof CreditAppliesToProductType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function CreditAppliesToProductTypeFromJSON(json: any): CreditAppliesToProductType {
+    return CreditAppliesToProductTypeFromJSONTyped(json, false);
+}
+
+export function CreditAppliesToProductTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreditAppliesToProductType {
+    return json as CreditAppliesToProductType;
+}
+
+export function CreditAppliesToProductTypeToJSON(value?: CreditAppliesToProductType | null): any {
+    return value as any;
+}
+
+export function CreditAppliesToProductTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): CreditAppliesToProductType {
+    return value as CreditAppliesToProductType;
+}
+

package/src/generated/models/credit.ts

@@ -28,6 +28,13 @@ import {
     CreditLineItemsToJSON,
     CreditLineItemsToJSONTyped,
 } from './credit-line-items';
+import type { CreditAppliesToProductType } from './credit-applies-to-product-type';
+import {
+    CreditAppliesToProductTypeFromJSON,
+    CreditAppliesToProductTypeFromJSONTyped,
+    CreditAppliesToProductTypeToJSON,
+    CreditAppliesToProductTypeToJSONTyped,
+} from './credit-applies-to-product-type';
 
 /**
  * 
@@ -65,6 +72,12 @@ export interface Credit {
      * @memberof Credit
      */
     currency: string;
+    /**
+     * 
+     * @type {CreditAppliesToProductType}
+     * @memberof Credit
+     */
+    appliesToProductType?: CreditAppliesToProductType;
     /**
      * Notes about the credit
      * @type {string}
@@ -151,6 +164,8 @@ export interface Credit {
     updatedDate?: string;
 }
 
+
+
 /**
  * Check if a given object implements the Credit interface.
  */
@@ -178,6 +193,7 @@ export function CreditFromJSONTyped(json: any, ignoreDiscriminator: boolean): Cr
         'creditDate': json['creditDate'],
         'creditAmount': json['creditAmount'],
         'currency': json['currency'],
+        'appliesToProductType': json['appliesToProductType'] == null ? undefined : CreditAppliesToProductTypeFromJSON(json['appliesToProductType']),
         'notes': json['notes'] == null ? undefined : json['notes'],
         'appliedAmount': json['appliedAmount'] == null ? undefined : json['appliedAmount'],
         'unappliedAmount': json['unappliedAmount'] == null ? undefined : json['unappliedAmount'],
@@ -211,6 +227,7 @@ export function CreditToJSONTyped(value?: Credit | null, ignoreDiscriminator: bo
         'creditDate': value['creditDate'],
         'creditAmount': value['creditAmount'],
         'currency': value['currency'],
+        'appliesToProductType': CreditAppliesToProductTypeToJSON(value['appliesToProductType']),
         'notes': value['notes'],
         'appliedAmount': value['appliedAmount'],
         'unappliedAmount': value['unappliedAmount'],

package/src/generated/models/index.ts

@@ -81,6 +81,7 @@ export * from './create-task-definition';
 export * from './create-task-instance';
 export * from './create-template';
 export * from './credit';
+export * from './credit-applies-to-product-type';
 export * from './credit-line-items';
 export * from './custom-create-checklist';
 export * from './custom-create-contact';

package/src/generated/models/journal-entry-entries.ts

@@ -56,6 +56,18 @@ export interface JournalEntryEntries {
      * @memberof JournalEntryEntries
      */
     customerId: string;
+    /**
+     * Customer name associated with journal entry line
+     * @type {string}
+     * @memberof JournalEntryEntries
+     */
+    customerName: string;
+    /**
+     * Custom fields on the journal entry line
+     * @type {object}
+     * @memberof JournalEntryEntries
+     */
+    customFields: object;
 }
 
 /**
@@ -68,6 +80,8 @@ export function instanceOfJournalEntryEntries(value: object): value is JournalEn
     if (!('credit' in value) || value['credit'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
     if (!('customerId' in value) || value['customerId'] === undefined) return false;
+    if (!('customerName' in value) || value['customerName'] === undefined) return false;
+    if (!('customFields' in value) || value['customFields'] === undefined) return false;
     return true;
 }
 
@@ -87,6 +101,8 @@ export function JournalEntryEntriesFromJSONTyped(json: any, ignoreDiscriminator:
         'credit': json['credit'],
         'description': json['description'],
         'customerId': json['customerId'],
+        'customerName': json['customerName'],
+        'customFields': json['customFields'],
     };
 }
 
@@ -107,6 +123,8 @@ export function JournalEntryEntriesToJSONTyped(value?: JournalEntryEntries | nul
         'credit': value['credit'],
         'description': value['description'],
         'customerId': value['customerId'],
+        'customerName': value['customerName'],
+        'customFields': value['customFields'],
     };
 }
 

package/src/generated/models/journal-entry.ts

@@ -58,6 +58,24 @@ export interface JournalEntry {
      * @memberof JournalEntry
      */
     description: string;
+    /**
+     * The Ordway object that produced this journal entry. Used to join back to the source transaction when resolving sub-account labels in the accrual report.
+     * @type {string}
+     * @memberof JournalEntry
+     */
+    sourceType: JournalEntrySourceType;
+    /**
+     * Identifier of the object that produced this journal entry (e.g. INV-54921, CR-01287, PMT-13031, REF-00246).
+     * @type {string}
+     * @memberof JournalEntry
+     */
+    sourceId: string;
+    /**
+     * Total transaction amount for the journal entry in the transaction currency
+     * @type {string}
+     * @memberof JournalEntry
+     */
+    transactionAmount: string;
     /**
      * Journal entries
      * @type {Array<JournalEntryEntries>}
@@ -108,6 +126,22 @@ export interface JournalEntry {
     transactionConversionRate: number;
 }
 
+
+/**
+ * @export
+ */
+export const JournalEntrySourceType = {
+    Subscription: 'Subscription',
+    Order: 'Order',
+    Invoice: 'Invoice',
+    Payment: 'Payment',
+    Credit: 'Credit',
+    RevenueSchedule: 'RevenueSchedule',
+    Refund: 'Refund'
+} as const;
+export type JournalEntrySourceType = typeof JournalEntrySourceType[keyof typeof JournalEntrySourceType];
+
+
 /**
  * Check if a given object implements the JournalEntry interface.
  */
@@ -117,6 +151,9 @@ export function instanceOfJournalEntry(value: object): value is JournalEntry {
     if (!('customerId' in value) || value['customerId'] === undefined) return false;
     if (!('customerName' in value) || value['customerName'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('sourceType' in value) || value['sourceType'] === undefined) return false;
+    if (!('sourceId' in value) || value['sourceId'] === undefined) return false;
+    if (!('transactionAmount' in value) || value['transactionAmount'] === undefined) return false;
     if (!('entries' in value) || value['entries'] === undefined) return false;
     if (!('customFields' in value) || value['customFields'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
@@ -143,6 +180,9 @@ export function JournalEntryFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'customerId': json['customerId'],
         'customerName': json['customerName'],
         'description': json['description'],
+        'sourceType': json['sourceType'],
+        'sourceId': json['sourceId'],
+        'transactionAmount': json['transactionAmount'],
         'entries': ((json['entries'] as Array<any>).map(JournalEntryEntriesFromJSON)),
         'customFields': json['customFields'],
         'createdAt': json['createdAt'],
@@ -170,6 +210,9 @@ export function JournalEntryToJSONTyped(value?: JournalEntry | null, ignoreDiscr
         'customerId': value['customerId'],
         'customerName': value['customerName'],
         'description': value['description'],
+        'sourceType': value['sourceType'],
+        'sourceId': value['sourceId'],
+        'transactionAmount': value['transactionAmount'],
         'entries': ((value['entries'] as Array<any>).map(JournalEntryEntriesToJSON)),
         'customFields': value['customFields'],
         'createdAt': value['createdAt'],

package/src/generated/models/product-custom.ts

@@ -119,6 +119,12 @@ export interface ProductCustom {
      * @memberof ProductCustom
      */
     oneTimeCharge: boolean;
+    /**
+     * Product ID to use when writing off this product's charge
+     * @type {string}
+     * @memberof ProductCustom
+     */
+    writeOffProductId?: string;
     /**
      * Product ID
      * @type {string}
@@ -175,6 +181,7 @@ export function ProductCustomFromJSONTyped(json: any, ignoreDiscriminator: boole
         'incomeAccount': json['incomeAccount'] == null ? undefined : json['incomeAccount'],
         'productTaxGroupName': json['productTaxGroupName'] == null ? undefined : json['productTaxGroupName'],
         'oneTimeCharge': json['oneTimeCharge'],
+        'writeOffProductId': json['writeOffProductId'] == null ? undefined : json['writeOffProductId'],
         'id': json['id'],
         'msExternalId': json['msExternalId'],
     };
@@ -205,6 +212,7 @@ export function ProductCustomToJSONTyped(value?: ProductCustom | null, ignoreDis
         'incomeAccount': value['incomeAccount'],
         'productTaxGroupName': value['productTaxGroupName'],
         'oneTimeCharge': value['oneTimeCharge'],
+        'writeOffProductId': value['writeOffProductId'],
         'id': value['id'],
         'msExternalId': value['msExternalId'],
     };

package/src/generated/models/product-type.ts

@@ -24,7 +24,10 @@ export const ProductType = {
     RENT_TREATMENT: 'RENT_TREATMENT',
     INSURANCE: 'INSURANCE',
     FEE: 'FEE',
-    MERCHANDISE: 'MERCHANDISE'
+    MERCHANDISE: 'MERCHANDISE',
+    WRITE_OFF: 'WRITE_OFF',
+    CREDIT: 'CREDIT',
+    DISCOUNT: 'DISCOUNT'
 } as const;
 export type ProductType = typeof ProductType[keyof typeof ProductType];
 

package/src/generated/models/refund-invoice.ts

@@ -44,6 +44,12 @@ export interface RefundInvoice {
      * @memberof RefundInvoice
      */
     refundType: string;
+    /**
+     * Originating payment ID for Electronic refunds on credit invoices
+     * @type {string}
+     * @memberof RefundInvoice
+     */
+    paymentId?: string;
 }
 
 /**
@@ -71,6 +77,7 @@ export function RefundInvoiceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'refundDate': json['refundDate'],
         'refundAmount': json['refundAmount'],
         'refundType': json['refundType'],
+        'paymentId': json['paymentId'] == null ? undefined : json['paymentId'],
     };
 }
 
@@ -89,6 +96,7 @@ export function RefundInvoiceToJSONTyped(value?: RefundInvoice | null, ignoreDis
         'refundDate': value['refundDate'],
         'refundAmount': value['refundAmount'],
         'refundType': value['refundType'],
+        'paymentId': value['paymentId'],
     };
 }
 

package/src/generated/models/site.ts

@@ -309,6 +309,18 @@ export interface Site {
      * @memberof Site
      */
     division: string | null;
+    /**
+     * Merchant identifier for payment processing
+     * @type {string}
+     * @memberof Site
+     */
+    merchantId: string | null;
+    /**
+     * Account number for payment processing
+     * @type {string}
+     * @memberof Site
+     */
+    accountNumber: string | null;
     /**
      * When onboarding was completed for this site
      * @type {Date}
@@ -330,6 +342,8 @@ export function instanceOfSite(value: object): value is Site {
     if (!('addressId' in value) || value['addressId'] === undefined) return false;
     if (!('siteCode' in value) || value['siteCode'] === undefined) return false;
     if (!('division' in value) || value['division'] === undefined) return false;
+    if (!('merchantId' in value) || value['merchantId'] === undefined) return false;
+    if (!('accountNumber' in value) || value['accountNumber'] === undefined) return false;
     if (!('onboardCompletedAt' in value) || value['onboardCompletedAt'] === undefined) return false;
     return true;
 }
@@ -371,6 +385,8 @@ export function SiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): Site
         'siteRoles': json['siteRoles'] == null ? undefined : ((json['siteRoles'] as Array<any>).map(SiteRoleFromJSON)),
         'siteCode': json['siteCode'],
         'division': json['division'],
+        'merchantId': json['merchantId'],
+        'accountNumber': json['accountNumber'],
         'onboardCompletedAt': (json['onboardCompletedAt'] == null ? null : new Date(json['onboardCompletedAt'])),
     };
 }
@@ -413,6 +429,8 @@ export function SiteToJSONTyped(value?: Site | null, ignoreDiscriminator: boolea
         'siteRoles': value['siteRoles'] == null ? undefined : ((value['siteRoles'] as Array<any>).map(SiteRoleToJSON)),
         'siteCode': value['siteCode'],
         'division': value['division'],
+        'merchantId': value['merchantId'],
+        'accountNumber': value['accountNumber'],
         'onboardCompletedAt': (value['onboardCompletedAt'] == null ? null : (value['onboardCompletedAt'] as any).toISOString()),
     };
 }

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

@@ -52,7 +52,7 @@ export interface SubscriptionCharge {
      * @type {string}
      * @memberof SubscriptionCharge
      */
-    planId: string;
+    planId?: string;
     /**
      * Name of plan
      * @type {string}
@@ -64,13 +64,13 @@ export interface SubscriptionCharge {
      * @type {string}
      * @memberof SubscriptionCharge
      */
-    chargeId: string;
+    chargeId?: string;
     /**
      * Name of charge
      * @type {string}
      * @memberof SubscriptionCharge
      */
-    chargeName: string;
+    chargeName?: string;
     /**
      * How charge will be priced
      * @type {string}
@@ -101,12 +101,6 @@ export interface SubscriptionCharge {
      * @memberof SubscriptionCharge
      */
     includedUnits?: number;
-    /**
-     * Discount applied to product
-     * @type {number}
-     * @memberof SubscriptionCharge
-     */
-    discount?: number;
     /**
      * Effective price of product
      * @type {string}
@@ -305,12 +299,6 @@ export interface SubscriptionCharge {
      * @memberof SubscriptionCharge
      */
     assetId: string;
-    /**
-     * MRR calculated based on % discount
-     * @type {string}
-     * @memberof SubscriptionCharge
-     */
-    discountedCmrr: string;
 }
 
 /**
@@ -318,11 +306,7 @@ export interface SubscriptionCharge {
  */
 export function instanceOfSubscriptionCharge(value: object): value is SubscriptionCharge {
     if (!('productId' in value) || value['productId'] === undefined) return false;
-    if (!('planId' in value) || value['planId'] === undefined) return false;
-    if (!('chargeId' in value) || value['chargeId'] === undefined) return false;
-    if (!('chargeName' in value) || value['chargeName'] === undefined) return false;
     if (!('assetId' in value) || value['assetId'] === undefined) return false;
-    if (!('discountedCmrr' in value) || value['discountedCmrr'] === undefined) return false;
     return true;
 }
 
@@ -338,16 +322,15 @@ export function SubscriptionChargeFromJSONTyped(json: any, ignoreDiscriminator:
         
         'productId': json['productId'],
         'productName': json['productName'] == null ? undefined : json['productName'],
-        'planId': json['planId'],
+        'planId': json['planId'] == null ? undefined : json['planId'],
         'planName': json['planName'] == null ? undefined : json['planName'],
-        'chargeId': json['chargeId'],
-        'chargeName': json['chargeName'],
+        'chargeId': json['chargeId'] == null ? undefined : json['chargeId'],
+        'chargeName': json['chargeName'] == null ? undefined : json['chargeName'],
         'pricingModel': json['pricingModel'] == null ? undefined : json['pricingModel'],
         'listPrice': json['listPrice'] == null ? undefined : json['listPrice'],
         'priceBase': json['priceBase'] == null ? undefined : json['priceBase'],
         'quantity': json['quantity'] == null ? undefined : json['quantity'],
         'includedUnits': json['includedUnits'] == null ? undefined : json['includedUnits'],
-        'discount': json['discount'] == null ? undefined : json['discount'],
         'effectivePrice': json['effectivePrice'] == null ? undefined : json['effectivePrice'],
         'chargeType': json['chargeType'] == null ? undefined : json['chargeType'],
         'billingPeriod': json['billingPeriod'] == null ? undefined : json['billingPeriod'],
@@ -381,7 +364,6 @@ export function SubscriptionChargeFromJSONTyped(json: any, ignoreDiscriminator:
         'customRecognitionEndDate': json['customRecognitionEndDate'] == null ? undefined : json['customRecognitionEndDate'],
         'transactionPostingEntries': json['transactionPostingEntries'] == null ? undefined : ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
         'assetId': json['assetId'],
-        'discountedCmrr': json['discountedCmrr'],
     };
 }
 
@@ -407,7 +389,6 @@ export function SubscriptionChargeToJSONTyped(value?: SubscriptionCharge | null,
         'priceBase': value['priceBase'],
         'quantity': value['quantity'],
         'includedUnits': value['includedUnits'],
-        'discount': value['discount'],
         'effectivePrice': value['effectivePrice'],
         'chargeType': value['chargeType'],
         'billingPeriod': value['billingPeriod'],
@@ -441,7 +422,6 @@ export function SubscriptionChargeToJSONTyped(value?: SubscriptionCharge | null,
         'customRecognitionEndDate': value['customRecognitionEndDate'],
         'transactionPostingEntries': value['transactionPostingEntries'] == null ? undefined : ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
         'assetId': value['assetId'],
-        'discountedCmrr': value['discountedCmrr'],
     };
 }
 

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

@@ -119,6 +119,12 @@ export interface UpdateProduct {
      * @memberof UpdateProduct
      */
     oneTimeCharge: boolean;
+    /**
+     * Product ID to use when writing off this product's charge
+     * @type {string}
+     * @memberof UpdateProduct
+     */
+    writeOffProductId?: string;
 }
 
 
@@ -161,6 +167,7 @@ export function UpdateProductFromJSONTyped(json: any, ignoreDiscriminator: boole
         'incomeAccount': json['incomeAccount'] == null ? undefined : json['incomeAccount'],
         'productTaxGroupName': json['productTaxGroupName'] == null ? undefined : json['productTaxGroupName'],
         'oneTimeCharge': json['oneTimeCharge'],
+        'writeOffProductId': json['writeOffProductId'] == null ? undefined : json['writeOffProductId'],
     };
 }
 
@@ -189,6 +196,7 @@ export function UpdateProductToJSONTyped(value?: UpdateProduct | null, ignoreDis
         'incomeAccount': value['incomeAccount'],
         'productTaxGroupName': value['productTaxGroupName'],
         'oneTimeCharge': value['oneTimeCharge'],
+        'writeOffProductId': value['writeOffProductId'],
     };
 }