@managespace/sdk 0.0.125 → 0.0.126

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@managespace/sdk",
-    "version": "0.0.125",
+    "version": "0.0.126",
     "scripts": {
         "dev": "tsc -w --preserveWatchOutput",
         "build": "tsc",

package/src/extensibility/functions/project/billing.ts

@@ -27,7 +27,7 @@ import {
     CreateOrder as _CreateOrder,
     PlanCustom,
     CreateSubscription as _CreateSubscription,
-    UpdateSubscription as _UpdateSubscription,
+    SubscriptionPreview,
 } from '../../../generated';
 import { CustomCreateContact } from '../../../generated/models/custom-create-contact';
 import { CustomUpdateCustomer } from '../../../generated/models/custom-update-customer';
@@ -261,7 +261,7 @@ export namespace Billing {
     export class CancelSubscription implements ExtPlugin {
         responseType!: Subscription;
         payload!: {
-            siteId: string;
+            // siteId: string;
             subscriptionId: string;
             cancelSubscriptionPayload: _CancelSubscription;
         };
@@ -292,11 +292,10 @@ export namespace Billing {
         payload!: BasePaginationQuery & { status?: string };
     }
 
-    export class UpdateSubscription implements ExtPlugin {
-        responseType!: Subscription;
+    export class GetPreview implements ExtPlugin {
+        responseType!: SubscriptionPreview;
         payload!: {
-            siteId: string;
-            subscriptionId: string;
-        } & _UpdateSubscription;
+            id: string;
+        };
     }
 }

package/src/generated/.openapi-generator/FILES

@@ -164,6 +164,9 @@ models/statement.ts
 models/step-data.ts
 models/sub-total.ts
 models/subscription-charge.ts
+models/subscription-invoice-line.ts
+models/subscription-invoice.ts
+models/subscription-preview.ts
 models/subscription.ts
 models/success.ts
 models/task-completion-status.ts
@@ -184,8 +187,6 @@ models/update-map-feature.ts
 models/update-note.ts
 models/update-org.ts
 models/update-smart-bar-prompt.ts
-models/update-subscription-charge.ts
-models/update-subscription.ts
 models/update-user-properties.ts
 models/user-id.ts
 models/user.ts

package/src/generated/apis/default-api.ts

@@ -129,6 +129,7 @@ import type {
   Statement,
   StepData,
   Subscription,
+  SubscriptionPreview,
   Success,
   Task,
   TaskTemplate,
@@ -143,7 +144,6 @@ import type {
   UpdateNote,
   UpdateOrg,
   UpdateSmartBarPrompt,
-  UpdateSubscription,
   UpdateUserProperties,
   User,
   UserId,
@@ -383,6 +383,8 @@ import {
     StepDataToJSON,
     SubscriptionFromJSON,
     SubscriptionToJSON,
+    SubscriptionPreviewFromJSON,
+    SubscriptionPreviewToJSON,
     SuccessFromJSON,
     SuccessToJSON,
     TaskFromJSON,
@@ -411,8 +413,6 @@ import {
     UpdateOrgToJSON,
     UpdateSmartBarPromptFromJSON,
     UpdateSmartBarPromptToJSON,
-    UpdateSubscriptionFromJSON,
-    UpdateSubscriptionToJSON,
     UpdateUserPropertiesFromJSON,
     UpdateUserPropertiesToJSON,
     UserFromJSON,
@@ -912,6 +912,11 @@ export interface GetSubscriptionRequest {
     subscriptionId: string;
 }
 
+export interface GetSubscriptionPreviewRequest {
+    siteId: string;
+    subscriptionId: string;
+}
+
 export interface GetSubscriptionsRequest {
     siteId: string;
     offset?: number;
@@ -1129,12 +1134,6 @@ export interface UpdateSmartBarPromptRequest {
     updateSmartBarPrompt: UpdateSmartBarPrompt;
 }
 
-export interface UpdateSubscriptionRequest {
-    siteId: string;
-    subscriptionId: string;
-    updateSubscription: UpdateSubscription;
-}
-
 export interface UpdateTaskTemplateRequest {
     siteId: string;
     taskTemplateId: string;
@@ -1236,7 +1235,7 @@ export class DefaultApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/api/sites/{siteId}/subscriptions/{subscriptionId}/cancel`.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId']))).replace(`{${"subscriptionId"}}`, encodeURIComponent(String(requestParameters['subscriptionId']))),
+            path: `/api/sites/{siteId}/subscriptions/{subscriptionId}`.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId']))).replace(`{${"subscriptionId"}}`, encodeURIComponent(String(requestParameters['subscriptionId']))),
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
@@ -5450,6 +5449,52 @@ export class DefaultApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     */
+    async getSubscriptionPreviewRaw(requestParameters: GetSubscriptionPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionPreview>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling getSubscriptionPreview().'
+            );
+        }
+
+        if (requestParameters['subscriptionId'] == null) {
+            throw new runtime.RequiredError(
+                'subscriptionId',
+                'Required parameter "subscriptionId" was null or undefined when calling getSubscriptionPreview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/sites/{siteId}/subscriptions/{subscriptionId}/preview`.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId']))).replace(`{${"subscriptionId"}}`, encodeURIComponent(String(requestParameters['subscriptionId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SubscriptionPreviewFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async getSubscriptionPreview(requestParameters: GetSubscriptionPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionPreview> {
+        const response = await this.getSubscriptionPreviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      */
     async getSubscriptionsRaw(requestParameters: GetSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSubscriptions200Response>> {
@@ -7407,62 +7452,6 @@ export class DefaultApi extends runtime.BaseAPI {
         return await response.value();
     }
 
-    /**
-     */
-    async updateSubscriptionRaw(requestParameters: UpdateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>> {
-        if (requestParameters['siteId'] == null) {
-            throw new runtime.RequiredError(
-                'siteId',
-                'Required parameter "siteId" was null or undefined when calling updateSubscription().'
-            );
-        }
-
-        if (requestParameters['subscriptionId'] == null) {
-            throw new runtime.RequiredError(
-                'subscriptionId',
-                'Required parameter "subscriptionId" was null or undefined when calling updateSubscription().'
-            );
-        }
-
-        if (requestParameters['updateSubscription'] == null) {
-            throw new runtime.RequiredError(
-                'updateSubscription',
-                'Required parameter "updateSubscription" was null or undefined when calling updateSubscription().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("bearer", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/sites/{siteId}/subscriptions/{subscriptionId}`.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId']))).replace(`{${"subscriptionId"}}`, encodeURIComponent(String(requestParameters['subscriptionId']))),
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: UpdateSubscriptionToJSON(requestParameters['updateSubscription']),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => SubscriptionFromJSON(jsonValue));
-    }
-
-    /**
-     */
-    async updateSubscription(requestParameters: UpdateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription> {
-        const response = await this.updateSubscriptionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
     /**
      */
     async updateTaskTemplateRaw(requestParameters: UpdateTaskTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskTemplate>> {

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

@@ -99,12 +99,6 @@ export interface CreateProductCustom {
      * @memberof CreateProductCustom
      */
     incomeAccount?: string;
-    /**
-     * Select which tax group to be used
-     * @type {string}
-     * @memberof CreateProductCustom
-     */
-    productTaxGroupName?: string;
 }
 
 /**
@@ -141,7 +135,6 @@ export function CreateProductCustomFromJSONTyped(json: any, ignoreDiscriminator:
         'transactionPostingEntries': ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
         'customFields': json['customFields'] == null ? undefined : json['customFields'],
         'incomeAccount': json['incomeAccount'] == null ? undefined : json['incomeAccount'],
-        'productTaxGroupName': json['productTaxGroupName'] == null ? undefined : json['productTaxGroupName'],
     };
 }
 
@@ -168,7 +161,6 @@ export function CreateProductCustomToJSONTyped(value?: CreateProductCustom | nul
         'transactionPostingEntries': ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
         'customFields': value['customFields'],
         'incomeAccount': value['incomeAccount'],
-        'productTaxGroupName': value['productTaxGroupName'],
     };
 }
 

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

@@ -32,133 +32,25 @@ export interface CreateSubscription {
      * @type {string}
      * @memberof CreateSubscription
      */
-    status?: string;
+    status: string;
     /**
      * Billing start date for subscription contract
      * @type {string}
      * @memberof CreateSubscription
      */
-    billingStartDate?: string;
+    billingStartDate: string;
     /**
      * Service start date for subscription contract
      * @type {string}
      * @memberof CreateSubscription
      */
-    serviceStartDate?: string;
-    /**
-     * Date order was placed
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    orderPlacedAt?: string;
+    serviceStartDate: string;
     /**
      * Date subscription contract was signed and activated
      * @type {string}
      * @memberof CreateSubscription
      */
-    contractEffectiveDate?: string;
-    /**
-     * Date subscription contract was terminated
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    cancellationDate?: string;
-    /**
-     * Cancel as of option
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    cancellationType?: string;
-    /**
-     * auto-renew subscription contract
-     * @type {boolean}
-     * @memberof CreateSubscription
-     */
-    autoRenew?: boolean;
-    /**
-     * currency
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    currency?: string;
-    /**
-     * Calculate due date of invoice
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    paymentTerms?: string;
-    /**
-     * Contracted MRR per charge
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    cmrr?: string;
-    /**
-     * MRR calculated based on % discount
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    discountedCmrr?: string;
-    /**
-     * separate invoice generated
-     * @type {boolean}
-     * @memberof CreateSubscription
-     */
-    separateInvoice?: boolean;
-    /**
-     * Miscellaneous notes
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    notes?: string;
-    /**
-     * Coupon Code
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    couponCode?: string;
-    /**
-     * Version of subscription contract
-     * @type {number}
-     * @memberof CreateSubscription
-     */
-    version?: number;
-    /**
-     * Subscription contract version type
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    versionType?: string;
-    /**
-     * Term of contract in months
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    contractTerm?: string;
-    /**
-     * Length of time Subscription Contract will be renewed for
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    renewalTerm?: string;
-    /**
-     * Date Subscription Contract will start
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    currentTermStartDate?: string;
-    /**
-     * Date subscription contract will end
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    currentTermEndDate?: string;
-    /**
-     * Date subscription contract was terminated
-     * @type {number}
-     * @memberof CreateSubscription
-     */
-    renewalIncrementPercent?: number;
+    contractEffectiveDate: string;
     /**
      * Asset ID
      * @type {string}
@@ -171,66 +63,16 @@ export interface CreateSubscription {
      * @memberof CreateSubscription
      */
     charges: Array<CreateSubscriptionCharge>;
-    /**
-     * Id of billing contact
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    billContactId?: string;
-    /**
-     * Id of shipping contact
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    shippingContactId?: string;
-    /**
-     * Date record was created
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    updatedAt?: string;
-    /**
-     * Date record was created
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    createdAt?: string;
-    /**
-     * Email of user who created record
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    createdBy?: string;
-    /**
-     * Email of user who last modifed record
-     * @type {string}
-     * @memberof CreateSubscription
-     */
-    updatedBy?: string;
-    /**
-     * Custom fields on the invoice
-     * @type {object}
-     * @memberof CreateSubscription
-     */
-    customFields?: object;
-    /**
-     * Total contract value of the subsctiption contract
-     * @type {number}
-     * @memberof CreateSubscription
-     */
-    tcv?: number;
-    /**
-     * Set to defer start date
-     * @type {boolean}
-     * @memberof CreateSubscription
-     */
-    deferStartDate?: boolean;
 }
 
 /**
  * Check if a given object implements the CreateSubscription interface.
  */
 export function instanceOfCreateSubscription(value: object): value is CreateSubscription {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('billingStartDate' in value) || value['billingStartDate'] === undefined) return false;
+    if (!('serviceStartDate' in value) || value['serviceStartDate'] === undefined) return false;
+    if (!('contractEffectiveDate' in value) || value['contractEffectiveDate'] === undefined) return false;
     if (!('charges' in value) || value['charges'] === undefined) return false;
     return true;
 }
@@ -245,39 +87,12 @@ export function CreateSubscriptionFromJSONTyped(json: any, ignoreDiscriminator:
     }
     return {
         
-        'status': json['status'] == null ? undefined : json['status'],
-        'billingStartDate': json['billingStartDate'] == null ? undefined : json['billingStartDate'],
-        'serviceStartDate': json['serviceStartDate'] == null ? undefined : json['serviceStartDate'],
-        'orderPlacedAt': json['orderPlacedAt'] == null ? undefined : json['orderPlacedAt'],
-        'contractEffectiveDate': json['contractEffectiveDate'] == null ? undefined : json['contractEffectiveDate'],
-        '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'],
+        'status': json['status'],
+        'billingStartDate': json['billingStartDate'],
+        'serviceStartDate': json['serviceStartDate'],
+        'contractEffectiveDate': json['contractEffectiveDate'],
         'assetId': json['assetId'] == null ? undefined : json['assetId'],
         'charges': ((json['charges'] as Array<any>).map(CreateSubscriptionChargeFromJSON)),
-        'billContactId': json['billContactId'] == null ? undefined : json['billContactId'],
-        'shippingContactId': json['shippingContactId'] == null ? undefined : json['shippingContactId'],
-        'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
-        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
-        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
-        'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
-        'customFields': json['customFields'] == null ? undefined : json['customFields'],
-        'tcv': json['tcv'] == null ? undefined : json['tcv'],
-        'deferStartDate': json['deferStartDate'] == null ? undefined : json['deferStartDate'],
     };
 }
 
@@ -295,36 +110,9 @@ export function CreateSubscriptionToJSONTyped(value?: CreateSubscription | null,
         'status': value['status'],
         'billingStartDate': value['billingStartDate'],
         'serviceStartDate': value['serviceStartDate'],
-        'orderPlacedAt': value['orderPlacedAt'],
         'contractEffectiveDate': value['contractEffectiveDate'],
-        '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'],
         'charges': ((value['charges'] as Array<any>).map(CreateSubscriptionChargeToJSON)),
-        'billContactId': value['billContactId'],
-        'shippingContactId': value['shippingContactId'],
-        'updatedAt': value['updatedAt'],
-        'createdAt': value['createdAt'],
-        'createdBy': value['createdBy'],
-        'updatedBy': value['updatedBy'],
-        'customFields': value['customFields'],
-        'tcv': value['tcv'],
-        'deferStartDate': value['deferStartDate'],
     };
 }
 

package/src/generated/models/index.ts

@@ -163,6 +163,9 @@ export * from './step-data';
 export * from './sub-total';
 export * from './subscription';
 export * from './subscription-charge';
+export * from './subscription-invoice';
+export * from './subscription-invoice-line';
+export * from './subscription-preview';
 export * from './success';
 export * from './task';
 export * from './task-completion-status';
@@ -182,8 +185,6 @@ export * from './update-map-feature';
 export * from './update-note';
 export * from './update-org';
 export * from './update-smart-bar-prompt';
-export * from './update-subscription';
-export * from './update-subscription-charge';
 export * from './update-user-properties';
 export * from './user';
 export * from './user-id';

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

@@ -99,12 +99,6 @@ export interface ProductCustom {
      * @memberof ProductCustom
      */
     incomeAccount?: string;
-    /**
-     * Select which tax group to be used
-     * @type {string}
-     * @memberof ProductCustom
-     */
-    productTaxGroupName?: string;
     /**
      * Product ID
      * @type {string}
@@ -148,7 +142,6 @@ export function ProductCustomFromJSONTyped(json: any, ignoreDiscriminator: boole
         'transactionPostingEntries': ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
         'customFields': json['customFields'] == null ? undefined : json['customFields'],
         'incomeAccount': json['incomeAccount'] == null ? undefined : json['incomeAccount'],
-        'productTaxGroupName': json['productTaxGroupName'] == null ? undefined : json['productTaxGroupName'],
         'id': json['id'],
     };
 }
@@ -176,7 +169,6 @@ export function ProductCustomToJSONTyped(value?: ProductCustom | null, ignoreDis
         'transactionPostingEntries': ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
         'customFields': value['customFields'],
         'incomeAccount': value['incomeAccount'],
-        'productTaxGroupName': value['productTaxGroupName'],
         'id': value['id'],
     };
 }