@managespace/sdk 0.0.1 → 0.0.2

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

@@ -0,0 +1,228 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace V2 Auth API
+ * ManageSpace Auth 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 PaymentRunResponse
+ */
+export interface PaymentRunResponse {
+    /**
+     * Payment Run ID
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    id: string;
+    /**
+     * Phase of payment run
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    status: string;
+    /**
+     * Filter options to identify customers
+     * @type {object}
+     * @memberof PaymentRunResponse
+     */
+    filterOptions: object;
+    /**
+     * Date of payment run
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    targetInvoiceDueDate: string;
+    /**
+     * Total payments successfully processed
+     * @type {number}
+     * @memberof PaymentRunResponse
+     */
+    successCount: number;
+    /**
+     * Total payments failed
+     * @type {number}
+     * @memberof PaymentRunResponse
+     */
+    failureCount: number;
+    /**
+     * currency
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    currency: string;
+    /**
+     * Total value of payments processed
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    paymentsTotalValue: string;
+    /**
+     * Total value of payments successfully processed
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    paymentsSuccessValue: string;
+    /**
+     * Total value of payments unsucessfuly processed
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    paymentsFailedValue: string;
+    /**
+     * Total value of payments refunded
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    refundsTotalValue: string;
+    /**
+     * Total value of payments successfully refunded
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    refundsSuccessValue: string;
+    /**
+     * Total value of payments unsucessfully refunded
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    refundsFailedValue: string;
+    /**
+     * Email of user who created this record
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    createdBy: string;
+    /**
+     * Email of user who last modified this record
+     * @type {string}
+     * @memberof PaymentRunResponse
+     */
+    updatedBy: string;
+    /**
+     * Payment per customer
+     * @type {boolean}
+     * @memberof PaymentRunResponse
+     */
+    paymentPerCustomer: boolean;
+    /**
+     * Perform refund for negative invoices
+     * @type {boolean}
+     * @memberof PaymentRunResponse
+     */
+    refundsForNegativeInvoices: boolean;
+    /**
+     * Send email on payment success
+     * @type {boolean}
+     * @memberof PaymentRunResponse
+     */
+    sendEmailOnPaymentsSuccess: boolean;
+    /**
+     * Send email on payment failure
+     * @type {boolean}
+     * @memberof PaymentRunResponse
+     */
+    sendEmailOnPaymentFail: boolean;
+}
+
+/**
+ * Check if a given object implements the PaymentRunResponse interface.
+ */
+export function instanceOfPaymentRunResponse(value: object): value is PaymentRunResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('filterOptions' in value) || value['filterOptions'] === undefined) return false;
+    if (!('targetInvoiceDueDate' in value) || value['targetInvoiceDueDate'] === undefined) return false;
+    if (!('successCount' in value) || value['successCount'] === undefined) return false;
+    if (!('failureCount' in value) || value['failureCount'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('paymentsTotalValue' in value) || value['paymentsTotalValue'] === undefined) return false;
+    if (!('paymentsSuccessValue' in value) || value['paymentsSuccessValue'] === undefined) return false;
+    if (!('paymentsFailedValue' in value) || value['paymentsFailedValue'] === undefined) return false;
+    if (!('refundsTotalValue' in value) || value['refundsTotalValue'] === undefined) return false;
+    if (!('refundsSuccessValue' in value) || value['refundsSuccessValue'] === undefined) return false;
+    if (!('refundsFailedValue' in value) || value['refundsFailedValue'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('updatedBy' in value) || value['updatedBy'] === undefined) return false;
+    if (!('paymentPerCustomer' in value) || value['paymentPerCustomer'] === undefined) return false;
+    if (!('refundsForNegativeInvoices' in value) || value['refundsForNegativeInvoices'] === undefined) return false;
+    if (!('sendEmailOnPaymentsSuccess' in value) || value['sendEmailOnPaymentsSuccess'] === undefined) return false;
+    if (!('sendEmailOnPaymentFail' in value) || value['sendEmailOnPaymentFail'] === undefined) return false;
+    return true;
+}
+
+export function PaymentRunResponseFromJSON(json: any): PaymentRunResponse {
+    return PaymentRunResponseFromJSONTyped(json, false);
+}
+
+export function PaymentRunResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentRunResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'filterOptions': json['filterOptions'],
+        'targetInvoiceDueDate': json['targetInvoiceDueDate'],
+        'successCount': json['successCount'],
+        'failureCount': json['failureCount'],
+        'currency': json['currency'],
+        'paymentsTotalValue': json['paymentsTotalValue'],
+        'paymentsSuccessValue': json['paymentsSuccessValue'],
+        'paymentsFailedValue': json['paymentsFailedValue'],
+        'refundsTotalValue': json['refundsTotalValue'],
+        'refundsSuccessValue': json['refundsSuccessValue'],
+        'refundsFailedValue': json['refundsFailedValue'],
+        'createdBy': json['createdBy'],
+        'updatedBy': json['updatedBy'],
+        'paymentPerCustomer': json['paymentPerCustomer'],
+        'refundsForNegativeInvoices': json['refundsForNegativeInvoices'],
+        'sendEmailOnPaymentsSuccess': json['sendEmailOnPaymentsSuccess'],
+        'sendEmailOnPaymentFail': json['sendEmailOnPaymentFail'],
+    };
+}
+
+export function PaymentRunResponseToJSON(json: any): PaymentRunResponse {
+    return PaymentRunResponseToJSONTyped(json, false);
+}
+
+export function PaymentRunResponseToJSONTyped(value?: PaymentRunResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'filterOptions': value['filterOptions'],
+        'targetInvoiceDueDate': value['targetInvoiceDueDate'],
+        'successCount': value['successCount'],
+        'failureCount': value['failureCount'],
+        'currency': value['currency'],
+        'paymentsTotalValue': value['paymentsTotalValue'],
+        'paymentsSuccessValue': value['paymentsSuccessValue'],
+        'paymentsFailedValue': value['paymentsFailedValue'],
+        'refundsTotalValue': value['refundsTotalValue'],
+        'refundsSuccessValue': value['refundsSuccessValue'],
+        'refundsFailedValue': value['refundsFailedValue'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'paymentPerCustomer': value['paymentPerCustomer'],
+        'refundsForNegativeInvoices': value['refundsForNegativeInvoices'],
+        'sendEmailOnPaymentsSuccess': value['sendEmailOnPaymentsSuccess'],
+        'sendEmailOnPaymentFail': value['sendEmailOnPaymentFail'],
+    };
+}
+

package/src/generated/models/plan-charge-response.ts

@@ -0,0 +1,272 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace V2 Auth API
+ * ManageSpace Auth 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 { ProductTransactionPostingEntries } from './product-transaction-posting-entries';
+import {
+    ProductTransactionPostingEntriesFromJSON,
+    ProductTransactionPostingEntriesFromJSONTyped,
+    ProductTransactionPostingEntriesToJSON,
+    ProductTransactionPostingEntriesToJSONTyped,
+} from './product-transaction-posting-entries';
+
+/**
+ * 
+ * @export
+ * @interface PlanChargeResponse
+ */
+export interface PlanChargeResponse {
+    /**
+     * Charge ID
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    id: string;
+    /**
+     * Product ID
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    productId: string;
+    /**
+     * Charge name
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    name: string;
+    /**
+     * Description of charge
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    description: string;
+    /**
+     * Type of charge
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    type: string;
+    /**
+     * Line number
+     * @type {number}
+     * @memberof PlanChargeResponse
+     */
+    lineNumber: number;
+    /**
+     * Timing of charge
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    chargeTiming: string;
+    /**
+     * How Charge will be priced
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    pricingModel: string;
+    /**
+     * Original unit price of Charge
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    listPrice: string;
+    /**
+     * List price of charge
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    listPriceBase: string;
+    /**
+     * Billing period for recurring and usage based Charges
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    billingPeriod: string;
+    /**
+     * Determine boundary of Charge period
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    billingPeriodStartAlignment: string;
+    /**
+     * Which day of the month or week Charge is invoiced
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    billingDay: string;
+    /**
+     * Date after which the One time charges should be processed
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    billingDate: string;
+    /**
+     * Charge for partial periods
+     * @type {boolean}
+     * @memberof PlanChargeResponse
+     */
+    proratePartialPeriods: boolean;
+    /**
+     * Determines proration logic
+     * @type {boolean}
+     * @memberof PlanChargeResponse
+     */
+    backchargeCurrentPeriod: boolean;
+    /**
+     * Number of periods/units to charge
+     * @type {number}
+     * @memberof PlanChargeResponse
+     */
+    prepaymentPeriods: number;
+    /**
+     * Determines account information for charge
+     * @type {boolean}
+     * @memberof PlanChargeResponse
+     */
+    defaultFromProduct: boolean;
+    /**
+     * Revenue rule ID
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    revenueRuleId: string;
+    /**
+     * Date when revenue recognition will begin
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    recognitionStartDate: string;
+    /**
+     * Date when revenue recognition will end
+     * @type {string}
+     * @memberof PlanChargeResponse
+     */
+    recognitionEndDate: string;
+    /**
+     * Product transaction posting entries
+     * @type {Array<ProductTransactionPostingEntries>}
+     * @memberof PlanChargeResponse
+     */
+    transactionPostingEntries: Array<ProductTransactionPostingEntries>;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof PlanChargeResponse
+     */
+    customFields: object;
+}
+
+/**
+ * Check if a given object implements the PlanChargeResponse interface.
+ */
+export function instanceOfPlanChargeResponse(value: object): value is PlanChargeResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('productId' in value) || value['productId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('lineNumber' in value) || value['lineNumber'] === undefined) return false;
+    if (!('chargeTiming' in value) || value['chargeTiming'] === undefined) return false;
+    if (!('pricingModel' in value) || value['pricingModel'] === undefined) return false;
+    if (!('listPrice' in value) || value['listPrice'] === undefined) return false;
+    if (!('listPriceBase' in value) || value['listPriceBase'] === undefined) return false;
+    if (!('billingPeriod' in value) || value['billingPeriod'] === undefined) return false;
+    if (!('billingPeriodStartAlignment' in value) || value['billingPeriodStartAlignment'] === undefined) return false;
+    if (!('billingDay' in value) || value['billingDay'] === undefined) return false;
+    if (!('billingDate' in value) || value['billingDate'] === undefined) return false;
+    if (!('proratePartialPeriods' in value) || value['proratePartialPeriods'] === undefined) return false;
+    if (!('backchargeCurrentPeriod' in value) || value['backchargeCurrentPeriod'] === undefined) return false;
+    if (!('prepaymentPeriods' in value) || value['prepaymentPeriods'] === undefined) return false;
+    if (!('defaultFromProduct' in value) || value['defaultFromProduct'] === undefined) return false;
+    if (!('revenueRuleId' in value) || value['revenueRuleId'] === undefined) return false;
+    if (!('recognitionStartDate' in value) || value['recognitionStartDate'] === undefined) return false;
+    if (!('recognitionEndDate' in value) || value['recognitionEndDate'] === undefined) return false;
+    if (!('transactionPostingEntries' in value) || value['transactionPostingEntries'] === undefined) return false;
+    if (!('customFields' in value) || value['customFields'] === undefined) return false;
+    return true;
+}
+
+export function PlanChargeResponseFromJSON(json: any): PlanChargeResponse {
+    return PlanChargeResponseFromJSONTyped(json, false);
+}
+
+export function PlanChargeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlanChargeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'productId': json['productId'],
+        'name': json['name'],
+        'description': json['description'],
+        'type': json['type'],
+        'lineNumber': json['lineNumber'],
+        'chargeTiming': json['chargeTiming'],
+        'pricingModel': json['pricingModel'],
+        'listPrice': json['listPrice'],
+        'listPriceBase': json['listPriceBase'],
+        'billingPeriod': json['billingPeriod'],
+        'billingPeriodStartAlignment': json['billingPeriodStartAlignment'],
+        'billingDay': json['billingDay'],
+        'billingDate': json['billingDate'],
+        'proratePartialPeriods': json['proratePartialPeriods'],
+        'backchargeCurrentPeriod': json['backchargeCurrentPeriod'],
+        'prepaymentPeriods': json['prepaymentPeriods'],
+        'defaultFromProduct': json['defaultFromProduct'],
+        'revenueRuleId': json['revenueRuleId'],
+        'recognitionStartDate': json['recognitionStartDate'],
+        'recognitionEndDate': json['recognitionEndDate'],
+        'transactionPostingEntries': ((json['transactionPostingEntries'] as Array<any>).map(ProductTransactionPostingEntriesFromJSON)),
+        'customFields': json['customFields'],
+    };
+}
+
+export function PlanChargeResponseToJSON(json: any): PlanChargeResponse {
+    return PlanChargeResponseToJSONTyped(json, false);
+}
+
+export function PlanChargeResponseToJSONTyped(value?: PlanChargeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'productId': value['productId'],
+        'name': value['name'],
+        'description': value['description'],
+        'type': value['type'],
+        'lineNumber': value['lineNumber'],
+        'chargeTiming': value['chargeTiming'],
+        'pricingModel': value['pricingModel'],
+        'listPrice': value['listPrice'],
+        'listPriceBase': value['listPriceBase'],
+        'billingPeriod': value['billingPeriod'],
+        'billingPeriodStartAlignment': value['billingPeriodStartAlignment'],
+        'billingDay': value['billingDay'],
+        'billingDate': value['billingDate'],
+        'proratePartialPeriods': value['proratePartialPeriods'],
+        'backchargeCurrentPeriod': value['backchargeCurrentPeriod'],
+        'prepaymentPeriods': value['prepaymentPeriods'],
+        'defaultFromProduct': value['defaultFromProduct'],
+        'revenueRuleId': value['revenueRuleId'],
+        'recognitionStartDate': value['recognitionStartDate'],
+        'recognitionEndDate': value['recognitionEndDate'],
+        'transactionPostingEntries': ((value['transactionPostingEntries'] as Array<any>).map(ProductTransactionPostingEntriesToJSON)),
+        'customFields': value['customFields'],
+    };
+}
+

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

@@ -0,0 +1,173 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace V2 Auth API
+ * ManageSpace Auth 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 { PlanChargeResponse } from './plan-charge-response';
+import {
+    PlanChargeResponseFromJSON,
+    PlanChargeResponseFromJSONTyped,
+    PlanChargeResponseToJSON,
+    PlanChargeResponseToJSONTyped,
+} from './plan-charge-response';
+
+/**
+ * 
+ * @export
+ * @interface PlanResponse
+ */
+export interface PlanResponse {
+    /**
+     * Plan ID
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    id: string;
+    /**
+     * Name of plan
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    name: string;
+    /**
+     * Plan status
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    status: string;
+    /**
+     * Description of plan
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    description: string;
+    /**
+     * Show ssp
+     * @type {boolean}
+     * @memberof PlanResponse
+     */
+    showSsp: boolean;
+    /**
+     * Email of user who created record
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    createdBy: string;
+    /**
+     * Email of user who last modified record
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    updatedBy: string;
+    /**
+     * Date record created
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    createdAt: string;
+    /**
+     * Date record modified
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    updatedAt: string;
+    /**
+     * Charges associated with plan
+     * @type {Array<PlanChargeResponse>}
+     * @memberof PlanResponse
+     */
+    charges: Array<PlanChargeResponse>;
+    /**
+     * URL used for self sign up
+     * @type {string}
+     * @memberof PlanResponse
+     */
+    publicUrl: string;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof PlanResponse
+     */
+    customFields: object;
+}
+
+/**
+ * Check if a given object implements the PlanResponse interface.
+ */
+export function instanceOfPlanResponse(value: object): value is PlanResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('showSsp' in value) || value['showSsp'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('updatedBy' in value) || value['updatedBy'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('charges' in value) || value['charges'] === undefined) return false;
+    if (!('publicUrl' in value) || value['publicUrl'] === undefined) return false;
+    if (!('customFields' in value) || value['customFields'] === undefined) return false;
+    return true;
+}
+
+export function PlanResponseFromJSON(json: any): PlanResponse {
+    return PlanResponseFromJSONTyped(json, false);
+}
+
+export function PlanResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlanResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'status': json['status'],
+        'description': json['description'],
+        'showSsp': json['showSsp'],
+        'createdBy': json['createdBy'],
+        'updatedBy': json['updatedBy'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+        'charges': ((json['charges'] as Array<any>).map(PlanChargeResponseFromJSON)),
+        'publicUrl': json['publicUrl'],
+        'customFields': json['customFields'],
+    };
+}
+
+export function PlanResponseToJSON(json: any): PlanResponse {
+    return PlanResponseToJSONTyped(json, false);
+}
+
+export function PlanResponseToJSONTyped(value?: PlanResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'status': value['status'],
+        'description': value['description'],
+        'showSsp': value['showSsp'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        'charges': ((value['charges'] as Array<any>).map(PlanChargeResponseToJSON)),
+        'publicUrl': value['publicUrl'],
+        'customFields': value['customFields'],
+    };
+}
+