@managespace/sdk 0.0.117 → 0.1.0

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

@@ -0,0 +1,394 @@
+/* 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 { InvoiceContact } from './invoice-contact';
+import {
+    InvoiceContactFromJSON,
+    InvoiceContactFromJSONTyped,
+    InvoiceContactToJSON,
+    InvoiceContactToJSONTyped,
+} from './invoice-contact';
+import type { SubTotalResponse } from './sub-total-response';
+import {
+    SubTotalResponseFromJSON,
+    SubTotalResponseFromJSONTyped,
+    SubTotalResponseToJSON,
+    SubTotalResponseToJSONTyped,
+} from './sub-total-response';
+import type { LineItemResponse } from './line-item-response';
+import {
+    LineItemResponseFromJSON,
+    LineItemResponseFromJSONTyped,
+    LineItemResponseToJSON,
+    LineItemResponseToJSONTyped,
+} from './line-item-response';
+
+/**
+ * 
+ * @export
+ * @interface InvoiceResponse
+ */
+export interface InvoiceResponse {
+    /**
+     * Invoice ID
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    id: string;
+    /**
+     * Customer ID in the billing system
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    externalCustomerId: string;
+    /**
+     * Customer name
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    customerName: string;
+    /**
+     * Invoice date
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    invoiceDate: string;
+    /**
+     * Invoice due date
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    dueDate: string;
+    /**
+     * Invoice start date
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    startDate: string;
+    /**
+     * Invoice end date
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    endDate: string;
+    /**
+     * Billing run ID
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    billingRunId: string;
+    /**
+     * Discount display name
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    discountDisplayName: string;
+    /**
+     * Invoice subtotal
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    subtotal: string;
+    /**
+     * Invoice tax
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    invoiceTax: string;
+    /**
+     * Invoice subtotal + tax
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    invoiceAmount: string;
+    /**
+     * Amount of the invoice currently paid
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    paidAmount: string;
+    /**
+     * Amount of the invoice left to pay
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    balance: string;
+    /**
+     * The status of the invoice
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    status: string;
+    /**
+     * Any notes about the invoice
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    notes: string;
+    /**
+     * URL to a PDF of the invoice
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    invoicePdfUrl: string;
+    /**
+     * The currency of the invoice
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    currency: string;
+    /**
+     * The exchange rate applied to the invoice
+     * @type {number}
+     * @memberof InvoiceResponse
+     */
+    exchangeRate: number;
+    /**
+     * Payment term ID
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    paymentTermId: string;
+    /**
+     * Payment terms
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    paymentTerms: string;
+    /**
+     * The date the invoice was created
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    createdAt: string;
+    /**
+     * The date the invoice was updated
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    updatedAt: string;
+    /**
+     * Whether the invoice has been emailed or not
+     * @type {boolean}
+     * @memberof InvoiceResponse
+     */
+    emailed: boolean;
+    /**
+     * Reversal email
+     * @type {boolean}
+     * @memberof InvoiceResponse
+     */
+    reversalEmail: boolean;
+    /**
+     * Who created the invoice
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    createdBy: string;
+    /**
+     * Who updated the invoice
+     * @type {string}
+     * @memberof InvoiceResponse
+     */
+    updatedBy: string;
+    /**
+     * The contact information for billing
+     * @type {InvoiceContact}
+     * @memberof InvoiceResponse
+     */
+    billingContact: InvoiceContact;
+    /**
+     * The contact information for shipping
+     * @type {InvoiceContact}
+     * @memberof InvoiceResponse
+     */
+    shippingContact: InvoiceContact;
+    /**
+     * Invoice line items
+     * @type {Array<LineItemResponse>}
+     * @memberof InvoiceResponse
+     */
+    lineItems: Array<LineItemResponse>;
+    /**
+     * Invoice subtotals
+     * @type {Array<SubTotalResponse>}
+     * @memberof InvoiceResponse
+     */
+    subtotals: Array<SubTotalResponse>;
+    /**
+     * Payments made against the invoice
+     * @type {Array<object>}
+     * @memberof InvoiceResponse
+     */
+    payments: Array<object>;
+    /**
+     * Credits applied to the invoice
+     * @type {Array<object>}
+     * @memberof InvoiceResponse
+     */
+    credits: Array<object>;
+    /**
+     * Refunds applied to the invoice
+     * @type {Array<object>}
+     * @memberof InvoiceResponse
+     */
+    refunds: Array<object>;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof InvoiceResponse
+     */
+    customFields: object;
+}
+
+/**
+ * Check if a given object implements the InvoiceResponse interface.
+ */
+export function instanceOfInvoiceResponse(value: object): value is InvoiceResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('externalCustomerId' in value) || value['externalCustomerId'] === undefined) return false;
+    if (!('customerName' in value) || value['customerName'] === undefined) return false;
+    if (!('invoiceDate' in value) || value['invoiceDate'] === undefined) return false;
+    if (!('dueDate' in value) || value['dueDate'] === undefined) return false;
+    if (!('startDate' in value) || value['startDate'] === undefined) return false;
+    if (!('endDate' in value) || value['endDate'] === undefined) return false;
+    if (!('billingRunId' in value) || value['billingRunId'] === undefined) return false;
+    if (!('discountDisplayName' in value) || value['discountDisplayName'] === undefined) return false;
+    if (!('subtotal' in value) || value['subtotal'] === undefined) return false;
+    if (!('invoiceTax' in value) || value['invoiceTax'] === undefined) return false;
+    if (!('invoiceAmount' in value) || value['invoiceAmount'] === undefined) return false;
+    if (!('paidAmount' in value) || value['paidAmount'] === undefined) return false;
+    if (!('balance' in value) || value['balance'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('notes' in value) || value['notes'] === undefined) return false;
+    if (!('invoicePdfUrl' in value) || value['invoicePdfUrl'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('exchangeRate' in value) || value['exchangeRate'] === undefined) return false;
+    if (!('paymentTermId' in value) || value['paymentTermId'] === undefined) return false;
+    if (!('paymentTerms' in value) || value['paymentTerms'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('emailed' in value) || value['emailed'] === undefined) return false;
+    if (!('reversalEmail' in value) || value['reversalEmail'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('updatedBy' in value) || value['updatedBy'] === undefined) return false;
+    if (!('billingContact' in value) || value['billingContact'] === undefined) return false;
+    if (!('shippingContact' in value) || value['shippingContact'] === undefined) return false;
+    if (!('lineItems' in value) || value['lineItems'] === undefined) return false;
+    if (!('subtotals' in value) || value['subtotals'] === undefined) return false;
+    if (!('payments' in value) || value['payments'] === undefined) return false;
+    if (!('credits' in value) || value['credits'] === undefined) return false;
+    if (!('refunds' in value) || value['refunds'] === undefined) return false;
+    if (!('customFields' in value) || value['customFields'] === undefined) return false;
+    return true;
+}
+
+export function InvoiceResponseFromJSON(json: any): InvoiceResponse {
+    return InvoiceResponseFromJSONTyped(json, false);
+}
+
+export function InvoiceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'externalCustomerId': json['externalCustomerId'],
+        'customerName': json['customerName'],
+        'invoiceDate': json['invoiceDate'],
+        'dueDate': json['dueDate'],
+        'startDate': json['startDate'],
+        'endDate': json['endDate'],
+        'billingRunId': json['billingRunId'],
+        'discountDisplayName': json['discountDisplayName'],
+        'subtotal': json['subtotal'],
+        'invoiceTax': json['invoiceTax'],
+        'invoiceAmount': json['invoiceAmount'],
+        'paidAmount': json['paidAmount'],
+        'balance': json['balance'],
+        'status': json['status'],
+        'notes': json['notes'],
+        'invoicePdfUrl': json['invoicePdfUrl'],
+        'currency': json['currency'],
+        'exchangeRate': json['exchangeRate'],
+        'paymentTermId': json['paymentTermId'],
+        'paymentTerms': json['paymentTerms'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+        'emailed': json['emailed'],
+        'reversalEmail': json['reversalEmail'],
+        'createdBy': json['createdBy'],
+        'updatedBy': json['updatedBy'],
+        'billingContact': InvoiceContactFromJSON(json['billingContact']),
+        'shippingContact': InvoiceContactFromJSON(json['shippingContact']),
+        'lineItems': ((json['lineItems'] as Array<any>).map(LineItemResponseFromJSON)),
+        'subtotals': ((json['subtotals'] as Array<any>).map(SubTotalResponseFromJSON)),
+        'payments': json['payments'],
+        'credits': json['credits'],
+        'refunds': json['refunds'],
+        'customFields': json['customFields'],
+    };
+}
+
+export function InvoiceResponseToJSON(json: any): InvoiceResponse {
+    return InvoiceResponseToJSONTyped(json, false);
+}
+
+export function InvoiceResponseToJSONTyped(value?: InvoiceResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'externalCustomerId': value['externalCustomerId'],
+        'customerName': value['customerName'],
+        'invoiceDate': value['invoiceDate'],
+        'dueDate': value['dueDate'],
+        'startDate': value['startDate'],
+        'endDate': value['endDate'],
+        'billingRunId': value['billingRunId'],
+        'discountDisplayName': value['discountDisplayName'],
+        'subtotal': value['subtotal'],
+        'invoiceTax': value['invoiceTax'],
+        'invoiceAmount': value['invoiceAmount'],
+        'paidAmount': value['paidAmount'],
+        'balance': value['balance'],
+        'status': value['status'],
+        'notes': value['notes'],
+        'invoicePdfUrl': value['invoicePdfUrl'],
+        'currency': value['currency'],
+        'exchangeRate': value['exchangeRate'],
+        'paymentTermId': value['paymentTermId'],
+        'paymentTerms': value['paymentTerms'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        'emailed': value['emailed'],
+        'reversalEmail': value['reversalEmail'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'billingContact': InvoiceContactToJSON(value['billingContact']),
+        'shippingContact': InvoiceContactToJSON(value['shippingContact']),
+        'lineItems': ((value['lineItems'] as Array<any>).map(LineItemResponseToJSON)),
+        'subtotals': ((value['subtotals'] as Array<any>).map(SubTotalResponseToJSON)),
+        'payments': value['payments'],
+        'credits': value['credits'],
+        'refunds': value['refunds'],
+        'customFields': value['customFields'],
+    };
+}
+

package/src/generated/models/line-item-response.ts

@@ -0,0 +1,308 @@
+/* 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 { TaxLineResponse } from './tax-line-response';
+import {
+    TaxLineResponseFromJSON,
+    TaxLineResponseFromJSONTyped,
+    TaxLineResponseToJSON,
+    TaxLineResponseToJSONTyped,
+} from './tax-line-response';
+
+/**
+ * 
+ * @export
+ * @interface LineItemResponse
+ */
+export interface LineItemResponse {
+    /**
+     * Line item number
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    lineNo: string;
+    /**
+     * Subscription ID
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    subscriptionId: string;
+    /**
+     * Customer ID in the billing system
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    externalCustomerId: string;
+    /**
+     * Customer name
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    customerName: string;
+    /**
+     * Product ID
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    productId: string;
+    /**
+     * Product name
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    productName: string;
+    /**
+     * Plan ID
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    planId: string;
+    /**
+     * Plan name
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    planName: string;
+    /**
+     * Charge ID
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    chargeId: string;
+    /**
+     * Subscription line ID
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    subscriptionLineId: string;
+    /**
+     * Charge name
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    chargeName: string;
+    /**
+     * Charge type
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    chargeType: string;
+    /**
+     * Description of the line item
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    description: string;
+    /**
+     * Line item start date
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    startDate: string;
+    /**
+     * Line item start date
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    endDate: string;
+    /**
+     * Unit price of the line item
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    unitPrice: string;
+    /**
+     * List price of the line item
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    listPrice: string;
+    /**
+     * List price base
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    listPriceBase: string;
+    /**
+     * Whether the line item is taxable or not
+     * @type {boolean}
+     * @memberof LineItemResponse
+     */
+    taxable: boolean;
+    /**
+     * The number of the items
+     * @type {number}
+     * @memberof LineItemResponse
+     */
+    quantity: number;
+    /**
+     * The number of the items included
+     * @type {number}
+     * @memberof LineItemResponse
+     */
+    includedQuantity: number;
+    /**
+     * The discount applied to the line item
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    discount: string;
+    /**
+     * The price of the item after discounts
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    effectivePrice: string;
+    /**
+     * The tax applied to the line item
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    lineTax: string;
+    /**
+     * Invoice tax lines
+     * @type {Array<TaxLineResponse>}
+     * @memberof LineItemResponse
+     */
+    taxLines: Array<TaxLineResponse>;
+    /**
+     * Tiers applied to the line item
+     * @type {string}
+     * @memberof LineItemResponse
+     */
+    appliedTiers: string;
+    /**
+     * Custom fields on the line item
+     * @type {object}
+     * @memberof LineItemResponse
+     */
+    customFields: object;
+}
+
+/**
+ * Check if a given object implements the LineItemResponse interface.
+ */
+export function instanceOfLineItemResponse(value: object): value is LineItemResponse {
+    if (!('lineNo' in value) || value['lineNo'] === undefined) return false;
+    if (!('subscriptionId' in value) || value['subscriptionId'] === undefined) return false;
+    if (!('externalCustomerId' in value) || value['externalCustomerId'] === undefined) return false;
+    if (!('customerName' in value) || value['customerName'] === undefined) return false;
+    if (!('productId' in value) || value['productId'] === undefined) return false;
+    if (!('productName' in value) || value['productName'] === undefined) return false;
+    if (!('planId' in value) || value['planId'] === undefined) return false;
+    if (!('planName' in value) || value['planName'] === undefined) return false;
+    if (!('chargeId' in value) || value['chargeId'] === undefined) return false;
+    if (!('subscriptionLineId' in value) || value['subscriptionLineId'] === 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 (!('listPrice' in value) || value['listPrice'] === undefined) return false;
+    if (!('listPriceBase' in value) || value['listPriceBase'] === undefined) return false;
+    if (!('taxable' in value) || value['taxable'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    if (!('includedQuantity' in value) || value['includedQuantity'] === undefined) return false;
+    if (!('discount' in value) || value['discount'] === undefined) return false;
+    if (!('effectivePrice' in value) || value['effectivePrice'] === undefined) return false;
+    if (!('lineTax' in value) || value['lineTax'] === undefined) return false;
+    if (!('taxLines' in value) || value['taxLines'] === undefined) return false;
+    if (!('appliedTiers' in value) || value['appliedTiers'] === undefined) return false;
+    if (!('customFields' in value) || value['customFields'] === undefined) return false;
+    return true;
+}
+
+export function LineItemResponseFromJSON(json: any): LineItemResponse {
+    return LineItemResponseFromJSONTyped(json, false);
+}
+
+export function LineItemResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LineItemResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'lineNo': json['lineNo'],
+        'subscriptionId': json['subscriptionId'],
+        'externalCustomerId': json['externalCustomerId'],
+        'customerName': json['customerName'],
+        'productId': json['productId'],
+        'productName': json['productName'],
+        'planId': json['planId'],
+        'planName': json['planName'],
+        'chargeId': json['chargeId'],
+        'subscriptionLineId': json['subscriptionLineId'],
+        'chargeName': json['chargeName'],
+        'chargeType': json['chargeType'],
+        'description': json['description'],
+        'startDate': json['startDate'],
+        'endDate': json['endDate'],
+        'unitPrice': json['unitPrice'],
+        'listPrice': json['listPrice'],
+        'listPriceBase': json['listPriceBase'],
+        'taxable': json['taxable'],
+        'quantity': json['quantity'],
+        'includedQuantity': json['includedQuantity'],
+        'discount': json['discount'],
+        'effectivePrice': json['effectivePrice'],
+        'lineTax': json['lineTax'],
+        'taxLines': ((json['taxLines'] as Array<any>).map(TaxLineResponseFromJSON)),
+        'appliedTiers': json['appliedTiers'],
+        'customFields': json['customFields'],
+    };
+}
+
+export function LineItemResponseToJSON(json: any): LineItemResponse {
+    return LineItemResponseToJSONTyped(json, false);
+}
+
+export function LineItemResponseToJSONTyped(value?: LineItemResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'lineNo': value['lineNo'],
+        'subscriptionId': value['subscriptionId'],
+        'externalCustomerId': value['externalCustomerId'],
+        'customerName': value['customerName'],
+        'productId': value['productId'],
+        'productName': value['productName'],
+        'planId': value['planId'],
+        'planName': value['planName'],
+        'chargeId': value['chargeId'],
+        'subscriptionLineId': value['subscriptionLineId'],
+        'chargeName': value['chargeName'],
+        'chargeType': value['chargeType'],
+        'description': value['description'],
+        'startDate': value['startDate'],
+        'endDate': value['endDate'],
+        'unitPrice': value['unitPrice'],
+        'listPrice': value['listPrice'],
+        'listPriceBase': value['listPriceBase'],
+        'taxable': value['taxable'],
+        'quantity': value['quantity'],
+        'includedQuantity': value['includedQuantity'],
+        'discount': value['discount'],
+        'effectivePrice': value['effectivePrice'],
+        'lineTax': value['lineTax'],
+        'taxLines': ((value['taxLines'] as Array<any>).map(TaxLineResponseToJSON)),
+        'appliedTiers': value['appliedTiers'],
+        'customFields': value['customFields'],
+    };
+}
+