@managespace/sdk 0.0.139 → 0.0.140

package/package.json

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

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

@@ -27,6 +27,7 @@ import {
     CreateOrder as _CreateOrder,
     PlanCustom,
     CreateSubscription as _CreateSubscription,
+    SubscriptionPreview,
     UpdateSubscription as _UpdateSubscription,
 } from '../../../generated';
 import { CustomCreateContact } from '../../../generated/models/custom-create-contact';
@@ -292,6 +293,14 @@ export namespace Billing {
         payload!: BasePaginationQuery & { status?: string };
     }
 
+    export class GetPreview implements ExtPlugin {
+        responseType!: SubscriptionPreview;
+        payload!: {
+            siteId: string;
+            id: string;
+        };
+    }
+
     export class ActivateSubscription implements ExtPlugin {
         responseType!: Subscription;
         payload!: {

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

@@ -166,6 +166,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

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

@@ -131,6 +131,7 @@ import type {
   Statement,
   StepData,
   Subscription,
+  SubscriptionPreview,
   Success,
   Task,
   TaskTemplate,
@@ -392,6 +393,8 @@ import {
     StepDataToJSON,
     SubscriptionFromJSON,
     SubscriptionToJSON,
+    SubscriptionPreviewFromJSON,
+    SubscriptionPreviewToJSON,
     SuccessFromJSON,
     SuccessToJSON,
     TaskFromJSON,
@@ -944,6 +947,11 @@ export interface GetSubscriptionRequest {
     subscriptionId: string;
 }
 
+export interface GetSubscriptionPreviewRequest {
+    siteId: string;
+    subscriptionId: string;
+}
+
 export interface GetSubscriptionsRequest {
     siteId: string;
     offset?: number;
@@ -5641,6 +5649,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>> {

package/src/generated/models/index.ts

@@ -165,6 +165,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';

package/src/generated/models/subscription-invoice-line.ts

@@ -0,0 +1,192 @@
+/* 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 SubscriptionInvoiceLine
+ */
+export interface SubscriptionInvoiceLine {
+    /**
+     * Product ID
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    productId: string;
+    /**
+     * Product name
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    productName: string;
+    /**
+     * Charge ID
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    chargeId: string;
+    /**
+     * Charge name
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    chargeName: string;
+    /**
+     * Charge type
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    chargeType: string;
+    /**
+     * Description of the line item
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    description: string;
+    /**
+     * Line item start date
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    startDate: string;
+    /**
+     * Line item start date
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    endDate: string;
+    /**
+     * Unit price of the line item
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    unitPrice: string;
+    /**
+     * The number of the items
+     * @type {number}
+     * @memberof SubscriptionInvoiceLine
+     */
+    quantity: number;
+    /**
+     * Charge ready date
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    chargeReadyDate: string;
+    /**
+     * The discount applied to product
+     * @type {number}
+     * @memberof SubscriptionInvoiceLine
+     */
+    discount: number;
+    /**
+     * If line item is invoiced
+     * @type {boolean}
+     * @memberof SubscriptionInvoiceLine
+     */
+    invoiced: boolean;
+    /**
+     * Charge effective price
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    chgEffectivePrice: string;
+    /**
+     * MRR
+     * @type {string}
+     * @memberof SubscriptionInvoiceLine
+     */
+    mrr: string;
+}
+
+/**
+ * Check if a given object implements the SubscriptionInvoiceLine interface.
+ */
+export function instanceOfSubscriptionInvoiceLine(value: object): value is SubscriptionInvoiceLine {
+    if (!('productId' in value) || value['productId'] === undefined) return false;
+    if (!('productName' in value) || value['productName'] === undefined) return false;
+    if (!('chargeId' in value) || value['chargeId'] === undefined) return false;
+    if (!('chargeName' in value) || value['chargeName'] === undefined) return false;
+    if (!('chargeType' in value) || value['chargeType'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('startDate' in value) || value['startDate'] === undefined) return false;
+    if (!('endDate' in value) || value['endDate'] === undefined) return false;
+    if (!('unitPrice' in value) || value['unitPrice'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    if (!('chargeReadyDate' in value) || value['chargeReadyDate'] === undefined) return false;
+    if (!('discount' in value) || value['discount'] === undefined) return false;
+    if (!('invoiced' in value) || value['invoiced'] === undefined) return false;
+    if (!('chgEffectivePrice' in value) || value['chgEffectivePrice'] === undefined) return false;
+    if (!('mrr' in value) || value['mrr'] === undefined) return false;
+    return true;
+}
+
+export function SubscriptionInvoiceLineFromJSON(json: any): SubscriptionInvoiceLine {
+    return SubscriptionInvoiceLineFromJSONTyped(json, false);
+}
+
+export function SubscriptionInvoiceLineFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionInvoiceLine {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'productId': json['productId'],
+        'productName': json['productName'],
+        'chargeId': json['chargeId'],
+        'chargeName': json['chargeName'],
+        'chargeType': json['chargeType'],
+        'description': json['description'],
+        'startDate': json['startDate'],
+        'endDate': json['endDate'],
+        'unitPrice': json['unitPrice'],
+        'quantity': json['quantity'],
+        'chargeReadyDate': json['chargeReadyDate'],
+        'discount': json['discount'],
+        'invoiced': json['invoiced'],
+        'chgEffectivePrice': json['chgEffectivePrice'],
+        'mrr': json['mrr'],
+    };
+}
+
+export function SubscriptionInvoiceLineToJSON(json: any): SubscriptionInvoiceLine {
+    return SubscriptionInvoiceLineToJSONTyped(json, false);
+}
+
+export function SubscriptionInvoiceLineToJSONTyped(value?: SubscriptionInvoiceLine | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'productId': value['productId'],
+        'productName': value['productName'],
+        'chargeId': value['chargeId'],
+        'chargeName': value['chargeName'],
+        'chargeType': value['chargeType'],
+        'description': value['description'],
+        'startDate': value['startDate'],
+        'endDate': value['endDate'],
+        'unitPrice': value['unitPrice'],
+        'quantity': value['quantity'],
+        'chargeReadyDate': value['chargeReadyDate'],
+        'discount': value['discount'],
+        'invoiced': value['invoiced'],
+        'chgEffectivePrice': value['chgEffectivePrice'],
+        'mrr': value['mrr'],
+    };
+}
+

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

@@ -0,0 +1,110 @@
+/* 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 { SubscriptionInvoiceLine } from './subscription-invoice-line';
+import {
+    SubscriptionInvoiceLineFromJSON,
+    SubscriptionInvoiceLineFromJSONTyped,
+    SubscriptionInvoiceLineToJSON,
+    SubscriptionInvoiceLineToJSONTyped,
+} from './subscription-invoice-line';
+
+/**
+ * 
+ * @export
+ * @interface SubscriptionInvoice
+ */
+export interface SubscriptionInvoice {
+    /**
+     * Subtotal of invoice
+     * @type {number}
+     * @memberof SubscriptionInvoice
+     */
+    substoal: number;
+    /**
+     * Invoice amount
+     * @type {number}
+     * @memberof SubscriptionInvoice
+     */
+    invoiceAmount: number;
+    /**
+     * Invioice date
+     * @type {string}
+     * @memberof SubscriptionInvoice
+     */
+    period: string;
+    /**
+     * Invoice line items
+     * @type {Array<SubscriptionInvoiceLine>}
+     * @memberof SubscriptionInvoice
+     */
+    invoiceLines: Array<SubscriptionInvoiceLine>;
+    /**
+     * Ready date of invoice
+     * @type {string}
+     * @memberof SubscriptionInvoice
+     */
+    readyDate: string;
+}
+
+/**
+ * Check if a given object implements the SubscriptionInvoice interface.
+ */
+export function instanceOfSubscriptionInvoice(value: object): value is SubscriptionInvoice {
+    if (!('substoal' in value) || value['substoal'] === undefined) return false;
+    if (!('invoiceAmount' in value) || value['invoiceAmount'] === undefined) return false;
+    if (!('period' in value) || value['period'] === undefined) return false;
+    if (!('invoiceLines' in value) || value['invoiceLines'] === undefined) return false;
+    if (!('readyDate' in value) || value['readyDate'] === undefined) return false;
+    return true;
+}
+
+export function SubscriptionInvoiceFromJSON(json: any): SubscriptionInvoice {
+    return SubscriptionInvoiceFromJSONTyped(json, false);
+}
+
+export function SubscriptionInvoiceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionInvoice {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'substoal': json['substoal'],
+        'invoiceAmount': json['invoiceAmount'],
+        'period': json['period'],
+        'invoiceLines': ((json['invoiceLines'] as Array<any>).map(SubscriptionInvoiceLineFromJSON)),
+        'readyDate': json['readyDate'],
+    };
+}
+
+export function SubscriptionInvoiceToJSON(json: any): SubscriptionInvoice {
+    return SubscriptionInvoiceToJSONTyped(json, false);
+}
+
+export function SubscriptionInvoiceToJSONTyped(value?: SubscriptionInvoice | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'substoal': value['substoal'],
+        'invoiceAmount': value['invoiceAmount'],
+        'period': value['period'],
+        'invoiceLines': ((value['invoiceLines'] as Array<any>).map(SubscriptionInvoiceLineToJSON)),
+        'readyDate': value['readyDate'],
+    };
+}
+