@managespace/sdk 0.1.53 → 0.1.54-melissa.dev

package/src/extensibility/functions/extensibility-function.ts

@@ -1,22 +1,14 @@
-import { DefaultApi } from '../../generated';
-import { ExtReturnType } from '../types';
-import { ExtPlugin, ExtBasePayload } from '../types';
+import {
+    ExtBasePayload,
+    ExtensibilityApi,
+    ExtPlugin,
+    ExtReturnType,
+} from '../types';
 
 export const defineExFn = <T extends ExtPlugin>(
     callback: (
         payload: ExtBasePayload & T['payload'],
-        api: DefaultApi & {
-            configurationSettings: {
-                [key: string]:
-                    | string
-                    | number
-                    | boolean
-                    | Record<string, unknown>;
-            };
-            secrets: {
-                [key: string]: any;
-            };
-        },
+        api: ExtensibilityApi,
     ) => Promise<ExtReturnType<T['responseType']>>,
 ) => {
     // let fnDescription = 'some default description';

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

@@ -1,102 +1,146 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 import {
-    BillingRun,
-    Charge,
-    Invoice,
+    CancelSubscription as _CancelSubscription,
     CreateBillingRun as _CreateBillingRun,
-    CreatePaymentRun as _CreatePaymentRun,
-    // SubscriptionResponse,
-    PaymentRun,
-    CustomCreatePlan,
-    ChartOfAccounts,
+    CreateCharge as _CreateCharge,
     CreateChartOfAccounts as _CreateChartOfAccounts,
-    RevenueRule,
-    CreateRevenueRule as _CreateRevenueRule,
+    CreateCredit as _CreateCredit,
+    CreateOrder as _CreateOrder,
     CreatePayment as _CreatePayment,
-    Payment,
-    Statement,
-    CancelSubscription as _CancelSubscription,
-    ProductCustom,
+    CreatePaymentMethod as _CreatePaymentMethod,
+    CreatePaymentRun as _CreatePaymentRun,
+    CreateProductTaxGroup as _CreateProductTaxGroup,
+    CreateRevenueRule as _CreateRevenueRule,
+    CreateSubscription as _CreateSubscription,
+    RefundInvoice as _RefundInvoice,
+    RefundPayment as _RefundPayment,
+    UpdateOrder as _UpdateOrder,
+    UpdatePayment as _UpdatePayment,
+    UpdatePlan as _UpdatePlan,
+    UpdateProduct as _UpdateProduct,
+    UpdateProductTaxGroup as _UpdateProductTaxGroup,
+    UpdateSubscription as _UpdateSubscription,
+    BillingRun,
+    Charge,
+    ChartOfAccounts,
+    Contact,
     CreateProductCustom,
+    Credit,
     CustomCreateCustomer,
+    CustomCreatePlan,
     Customer,
-    Contact,
-    Subscription,
-    CreateCharge as _CreateCharge,
+    CustomerBalance,
+    GetInvoicesQuery,
+    Invoice,
     Order,
-    CreateOrder as _CreateOrder,
-    PlanCustom,
-    CreateSubscription as _CreateSubscription,
-    SubscriptionPreview,
-    UpdateSubscription as _UpdateSubscription,
-    UpdatePlan as _UpdatePlan,
+    Payment,
     PaymentMethod,
-    CreatePaymentMethod as _CreatePaymentMethod,
+    // SubscriptionResponse,
+    PaymentRun,
+    PlanCustom,
+    ProductCustom,
     ProductTaxGroup,
-    CreateProductTaxGroup as _CreateProductTaxGroup,
-    GetInvoicesQuery,
-    UpdateProduct as _UpdateProduct,
+    ProductType,
     Refund,
+    RevenueRule,
+    Statement,
+    Subscription,
+    SubscriptionPreview,
+    Success,
 } from '../../../generated';
 import { CustomCreateContact } from '../../../generated/models/custom-create-contact';
+import { CustomUpdateContact } from '../../../generated/models/custom-update-contact';
 import { CustomUpdateCustomer } from '../../../generated/models/custom-update-customer';
+import { GetCreditsQuery } from '../../../generated/models/get-credits-query';
+import { GetOrdersQuery } from '../../../generated/models/get-orders-query';
+import { GetPaymentsQuery } from '../../../generated/models/get-payments-query';
+import { GetRefundsQuery } from '../../../generated/models/get-refunds-query';
 import { GetSubscriptionsQuery } from '../../../generated/models/get-subscriptions-query';
+import { JournalEntry } from '../../../generated/models/journal-entry';
 import { ExtPlugin } from '../../types';
 // TODO: import this from common, import it all from common ideally
 type BasePaginationQuery = { offset?: number; limit?: number };
 
 export namespace Billing {
+    export class ProcessWebhook implements ExtPlugin {
+        responseType!: any;
+
+        payload!: any;
+    }
+
     export class CreateRevenueRule implements ExtPlugin {
         responseType!: RevenueRule;
-        payload!: _CreateRevenueRule;
+
+        payload!: _CreateRevenueRule & {
+            msExternalId: string;
+        };
     }
 
     export class GetRevenueRule implements ExtPlugin {
         responseType!: RevenueRule;
+
         payload!: { revenueRuleId: string };
     }
 
     export class GetRevenueRules implements ExtPlugin {
         responseType!: RevenueRule[];
+
         payload!: BasePaginationQuery;
     }
 
     export class CreateBillingRun implements ExtPlugin {
         responseType!: BillingRun;
-        payload!: _CreateBillingRun;
+
+        payload!: _CreateBillingRun & {
+            idempotencyKey?: string;
+        };
     }
 
     export class CreatePaymentRun implements ExtPlugin {
         responseType!: PaymentRun;
+
         payload!: _CreatePaymentRun;
     }
 
     export class CreateChartOfAccounts implements ExtPlugin {
         responseType!: ChartOfAccounts;
+
         payload!: _CreateChartOfAccounts;
     }
 
     export class CreateContact implements ExtPlugin {
-        responseType!: Pick<Contact, 'id' | 'externalId'>;
+        responseType!: Pick<Contact, 'id' | 'msExternalId'>;
+
         payload!: CustomCreateContact & {
-            externalId: string;
+            msExternalId: string;
+            customerId: string;
+        };
+    }
+
+    export class UpdateContact implements ExtPlugin {
+        responseType!: Pick<Contact, 'id' | 'msExternalId'>;
+
+        payload!: CustomUpdateContact & {
+            msExternalId: string;
             customerId: string;
         };
     }
 
     export class ContactCreated implements ExtPlugin {
         responseType!: any;
+
         payload!: any;
     }
 
     export class CreateCustomer implements ExtPlugin {
-        responseType!: Pick<Customer, 'id' | 'externalId'> & {
-            contacts: Pick<Contact, 'id' | 'externalId'>[];
+        responseType!: Pick<Customer, 'id' | 'msExternalId'> & {
+            contacts: Pick<Contact, 'id' | 'msExternalId'>[];
         };
+
         payload!: Omit<CustomCreateCustomer, 'contacts'> & {
-            externalId: string;
+            msExternalId: string;
             contacts: (CustomCreateContact & {
-                externalId: string;
+                msExternalId: string;
             })[];
         };
     }
@@ -108,75 +152,97 @@ export namespace Billing {
 
     export class GetBillingRuns implements ExtPlugin {
         responseType!: BillingRun[];
+
         payload!: BasePaginationQuery;
     }
 
     export class GetBillingRun implements ExtPlugin {
         responseType!: BillingRun;
+
         payload!: { billingRunId: string };
     }
 
     export class GetCharges implements ExtPlugin {
         responseType!: Charge[];
+
         payload!: { planId: string } & BasePaginationQuery;
     }
 
     export class GetCharge implements ExtPlugin {
         responseType!: Charge;
+
         payload!: { planId: string; chargeId: string };
     }
 
     export class GetCustomers implements ExtPlugin {
-        responseType!: (Pick<Customer, 'id' | 'externalId'> & {
-            contacts: Pick<Contact, 'id' | 'externalId'>[];
+        responseType!: (Pick<Customer, 'id' | 'msExternalId'> & {
+            contacts: Pick<Contact, 'id' | 'msExternalId'>[];
         })[];
+
         payload!: BasePaginationQuery & { tenantId?: string; active?: boolean };
     }
 
     export class GetCustomer implements ExtPlugin {
         responseType!: any;
+
+        payload!: { customerId: string };
+    }
+
+    export class GetCustomerBalance implements ExtPlugin {
+        responseType!: CustomerBalance;
+
         payload!: { customerId: string };
     }
 
     export class GetInvoices implements ExtPlugin {
         responseType!: Invoice[];
+
         payload!: GetInvoicesQuery;
     }
 
     export class GetInvoice implements ExtPlugin {
         responseType!: Invoice;
+
         payload!: {
             invoiceId: string;
         };
     }
 
+    export class RefundInvoice implements ExtPlugin {
+        responseType!: Refund;
+
+        payload!: {
+            invoiceId: string;
+        } & _RefundInvoice;
+    }
+
     export class GetPaymentRuns implements ExtPlugin {
         responseType!: PaymentRun[];
+
         payload!: BasePaginationQuery;
     }
 
     export class GetPaymentRun implements ExtPlugin {
         responseType!: PaymentRun;
+
         payload!: { paymentRunId: string };
     }
 
     export class GetPayments implements ExtPlugin {
         responseType!: Payment[];
-        payload!: BasePaginationQuery & {
-            status?: string;
-            customerId?: string;
-            sort?: string;
-            paymentRunId?: string;
-        };
+
+        payload!: GetPaymentsQuery;
     }
 
     export class GetPayment implements ExtPlugin {
         responseType!: Payment;
+
         payload!: { paymentId: string };
     }
 
     export class GetPlans implements ExtPlugin {
         responseType!: PlanCustom[];
+
         payload!: BasePaginationQuery & {
             siteId: string;
             name?: string;
@@ -187,6 +253,7 @@ export namespace Billing {
 
     export class GetPlan implements ExtPlugin {
         responseType!: PlanCustom;
+
         payload!: { siteId: string; planId: string };
     }
 
@@ -195,89 +262,145 @@ export namespace Billing {
             ProductCustom,
             'org' | 'orgId' | 'site' | 'siteId'
         >[];
+
         payload!: BasePaginationQuery & {
             active?: boolean;
             name?: string;
-            isDefault?: boolean;
-            rentRelated?: boolean;
+            productType?: ProductType;
             siteId: string;
         };
     }
 
     export class GetProduct implements ExtPlugin {
         responseType!: Omit<ProductCustom, 'org' | 'orgId' | 'site' | 'siteId'>;
+
         payload!: { siteId: string; productId: string };
     }
 
     export class GetSubscriptions implements ExtPlugin {
         responseType!: Subscription[];
+
         payload!: GetSubscriptionsQuery;
     }
 
     export class GetSubscription implements ExtPlugin {
         responseType!: Subscription;
+
         payload!: { subscriptionId: string };
     }
 
     export class CreateProduct implements ExtPlugin {
         responseType!: ProductCustom;
-        payload!: CreateProductCustom & { siteId: string };
+
+        payload!: CreateProductCustom & {
+            siteId: string;
+            msExternalId: string;
+        };
     }
 
     export class CreatePlan implements ExtPlugin {
         responseType!: PlanCustom;
+
         payload!: CustomCreatePlan & { siteId: string };
     }
 
     export class UpdateCustomer implements ExtPlugin {
-        responseType!: Pick<Customer, 'id' | 'externalId'>;
-        payload!: CustomUpdateCustomer & { externalId: string };
+        responseType!: Pick<Customer, 'id' | 'msExternalId'>;
+
+        payload!: CustomUpdateCustomer & { msExternalId: string };
     }
 
     export class GetChartOfAccount implements ExtPlugin {
         responseType!: ChartOfAccounts;
+
         payload!: { chartOfAccountsId: string };
     }
 
     export class GetChartOfAccounts implements ExtPlugin {
         responseType!: ChartOfAccounts[];
+
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetJournalEntries implements ExtPlugin {
+        responseType!: JournalEntry[];
+
         payload!: BasePaginationQuery;
     }
 
     export class CreateSubscription implements ExtPlugin {
         responseType!: Subscription;
+
         payload!: { customerId: string; siteId: string } & _CreateSubscription;
         // payload!: any;
     }
 
     export class CreatePayment implements ExtPlugin {
         responseType!: Payment;
+
         payload!: _CreatePayment;
         // payload!: any;
     }
 
+    export class UpdatePayment implements ExtPlugin {
+        responseType!: Payment;
+
+        payload!: _UpdatePayment & { paymentId: string };
+        // payload!: any;
+    }
+
+    export class GetCredit implements ExtPlugin {
+        responseType!: Credit;
+
+        payload!: { creditId: string };
+    }
+    export class RefundPayment implements ExtPlugin {
+        responseType!: Refund;
+
+        payload!: {
+            paymentId: string;
+        } & _RefundPayment;
+    }
+
+    export class GetCredits implements ExtPlugin {
+        responseType!: Credit[];
+
+        payload!: GetCreditsQuery;
+    }
+
+    export class CreateCredit implements ExtPlugin {
+        responseType!: Credit;
+
+        payload!: _CreateCredit;
+    }
+
     export class GetStatements implements ExtPlugin {
         responseType!: Statement[];
+
         payload!: BasePaginationQuery;
     }
 
     export class GetStatement implements ExtPlugin {
         responseType!: Statement;
+
         payload!: { statementId: string };
     }
 
     export class PaymentCreated implements ExtPlugin {
         responseType!: any;
+
         payload!: any;
     }
 
     export class InvoiceCreated implements ExtPlugin {
         responseType!: any;
+
         payload!: any;
     }
 
     export class CancelSubscription implements ExtPlugin {
         responseType!: Subscription;
+
         payload!: {
             siteId: string;
             subscriptionId: string;
@@ -287,6 +410,7 @@ export namespace Billing {
 
     export class CreateCharge implements ExtPlugin {
         responseType!: Charge;
+
         payload!: {
             planId: string;
             chargePayload: _CreateCharge;
@@ -295,11 +419,13 @@ export namespace Billing {
 
     export class CreateOrder implements ExtPlugin {
         responseType!: Order;
+
         payload!: _CreateOrder;
     }
 
     export class GetOrder implements ExtPlugin {
         responseType!: Order;
+
         payload!: {
             orderId: string;
         };
@@ -307,23 +433,45 @@ export namespace Billing {
 
     export class GetOrders implements ExtPlugin {
         responseType!: Order[];
-        payload!: BasePaginationQuery & {
-            status?: string;
-            customerId?: string;
-            invoiceId?: string;
-        };
+
+        payload!: GetOrdersQuery;
     }
 
-    export class GetPreview implements ExtPlugin {
+    export class UpdateOrder implements ExtPlugin {
+        responseType!: Order;
+
+        payload!: _UpdateOrder & { orderId: string };
+    }
+
+    export class CancelOrder implements ExtPlugin {
+        responseType!: Order;
+
+        payload!: { customerId: string; orderId: string };
+    }
+
+    export class CreatePreview implements ExtPlugin {
         responseType!: SubscriptionPreview;
+
         payload!: {
             siteId: string;
             id: string;
+            customerId: string;
+            subscription?: _UpdateSubscription;
         };
     }
 
     export class ActivateSubscription implements ExtPlugin {
         responseType!: Subscription;
+
+        payload!: {
+            siteId: string;
+            subscriptionId: string;
+        };
+    }
+
+    export class DeleteSubscription implements ExtPlugin {
+        responseType!: Success;
+
         payload!: {
             siteId: string;
             subscriptionId: string;
@@ -332,14 +480,23 @@ export namespace Billing {
 
     export class UpdateSubscription implements ExtPlugin {
         responseType!: Subscription;
+
         payload!: {
             siteId: string;
             subscriptionId: string;
+            moveOutDate?: string;
         } & _UpdateSubscription;
     }
 
+    export class RefreshPaidThroughDate implements ExtPlugin {
+        responseType!: Subscription;
+
+        payload!: { subscriptionId: string };
+    }
+
     export class UpdatePlan implements ExtPlugin {
         responseType!: PlanCustom;
+
         payload!: {
             siteId: string;
             planId: string;
@@ -349,54 +506,76 @@ export namespace Billing {
 
     export class CreatePaymentMethod implements ExtPlugin {
         responseType!: PaymentMethod;
+
         payload!: _CreatePaymentMethod & { customerId: string };
     }
 
     export class GetPaymentMethods implements ExtPlugin {
         responseType!: PaymentMethod[];
+
         payload!: BasePaginationQuery & { customerId: string };
     }
 
     export class GetPaymentMethod implements ExtPlugin {
         responseType!: PaymentMethod;
+
+        payload!: { customerId: string; paymentMethodId: string };
+    }
+
+    export class UpdateDefaultPaymentMethod implements ExtPlugin {
+        responseType!: PaymentMethod;
+
         payload!: { customerId: string; paymentMethodId: string };
     }
 
     export class CreateProductTaxGroup implements ExtPlugin {
         responseType!: ProductTaxGroup;
+
         payload!: _CreateProductTaxGroup;
     }
 
     export class GetProductTaxGroup implements ExtPlugin {
         responseType!: ProductTaxGroup;
+
         payload!: {
             productTaxGroupId: string;
         };
     }
 
+    export class UpdateProductTaxGroup implements ExtPlugin {
+        responseType!: ProductTaxGroup;
+
+        payload!: _UpdateProductTaxGroup & {
+            productTaxGroupId: string;
+        };
+    }
+
     export class GetProductTaxGroups implements ExtPlugin {
         responseType!: ProductTaxGroup[];
-        payload!: BasePaginationQuery & { status?: string };
+
+        payload!: BasePaginationQuery & { active?: boolean };
     }
 
     export class UpdateProduct implements ExtPlugin {
         responseType!: ProductCustom;
+
         payload!: _UpdateProduct & { siteId: string; productId: string };
     }
 
     export class GetRefund implements ExtPlugin {
         responseType!: Refund;
+
         payload!: { refundId: string };
     }
-
     export class GetRefunds implements ExtPlugin {
         responseType!: Refund[];
-        payload!: BasePaginationQuery & {
-            status?: string;
-            customerId?: string;
-            paymentId?: string;
-            invoiceId?: string;
-            paymentRunId?: string;
-        };
+
+        payload!: GetRefundsQuery;
+    }
+
+    export class GetClientToken implements ExtPlugin {
+        responseType!: { gateway: 'braintree' | 'stripe'; clientToken: string };
+
+        payload!: Record<string, never>;
     }
 }

package/src/extensibility/functions/project/communication-method.ts

@@ -1,22 +1,31 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 
-import { ExtPlugin } from '../../types';
 import { SendEmail as SendEmailPayload } from '../../../generated/models/send-email';
 import { SendSms as SendSmsPayload } from '../../../generated/models/send-sms';
+import { ExtPlugin } from '../../types';
 
 export namespace CommunicationMethod {
     export class SendEmail implements ExtPlugin {
         responseType!: Omit<
             SendEmailPayload,
-            'receiverEmail' | 'senderEmail' | 'contactId' | 'customerId'
+            | 'receiverEmail'
+            | 'senderEmail'
+            | 'contactId'
+            | 'customerId'
+            | 'documentIds'
         >;
-        payload!: Omit<SendEmailPayload, 'customerId' | 'contactId'>;
+
+        payload!: Omit<
+            SendEmailPayload,
+            'customerId' | 'contactId' | 'documentIds'
+        > & { attachmentUrls?: string[] };
     }
     export class SendSms implements ExtPlugin {
         responseType!: Omit<
             SendSmsPayload,
             'senderNumber' | 'receiverNumber' | 'contactId' | 'customerId'
         >;
+
         payload!: SendSmsPayload;
     }
 }