@managespace/sdk 0.1.10 → 0.1.11-4.paul.dev

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

@@ -29,14 +29,42 @@ import {
     CreateSubscription as _CreateSubscription,
     SubscriptionPreview,
     UpdateSubscription as _UpdateSubscription,
+    UpdatePlan as _UpdatePlan,
+    PaymentMethod,
+    CreatePaymentMethod as _CreatePaymentMethod,
+    ProductTaxGroup,
+    CreateProductTaxGroup as _CreateProductTaxGroup,
+    GetInvoicesQuery,
+    UpdateProduct as _UpdateProduct,
+    UpdateProductTaxGroup as _UpdateProductTaxGroup,
+    Refund,
+    UpdatePayment as _UpdatePayment,
+    UpdateOrder as _UpdateOrder,
+    RefundInvoice as _RefundInvoice,
+    ProductType,
+    OrderType,
+    CustomerBalance,
+    CreateCredit as _CreateCredit,
+    Credit,
+    GetCreditsRequest,
 } 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 { GetSubscriptionsQuery } from '../../../generated/models/get-subscriptions-query';
+import { GetPaymentsQuery } from '../../../generated/models/get-payments-query';
+import { GetOrdersQuery } from '../../../generated/models/get-orders-query';
+import { GetRefundsQuery } from '../../../generated/models/get-refunds-query';
 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;
@@ -75,6 +103,14 @@ export namespace Billing {
         };
     }
 
+    export class UpdateContact implements ExtPlugin {
+        responseType!: Pick<Contact, 'id' | 'externalId'>;
+        payload!: CustomUpdateContact & {
+            externalId: string;
+            customerId: string;
+        };
+    }
+
     export class ContactCreated implements ExtPlugin {
         responseType!: any;
         payload!: any;
@@ -124,14 +160,19 @@ export namespace Billing {
         payload!: BasePaginationQuery & { tenantId?: string; active?: boolean };
     }
 
-    // export class GetCustomer implements ExtPlugin {
-    //     responseType!: Omit<CustomCustomerResponse, 'org' | 'orgId'>;
-    //     payload!: { customerId: string };
-    // }
+    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!: BasePaginationQuery;
+        payload!: GetInvoicesQuery;
     }
 
     export class GetInvoice implements ExtPlugin {
@@ -141,6 +182,13 @@ export namespace Billing {
         };
     }
 
+    export class RefundInvoice implements ExtPlugin {
+        responseType!: Refund;
+        payload!: {
+            invoiceId: string;
+        } & _RefundInvoice;
+    }
+
     export class GetPaymentRuns implements ExtPlugin {
         responseType!: PaymentRun[];
         payload!: BasePaginationQuery;
@@ -153,7 +201,7 @@ export namespace Billing {
 
     export class GetPayments implements ExtPlugin {
         responseType!: Payment[];
-        payload!: BasePaginationQuery;
+        payload!: GetPaymentsQuery;
     }
 
     export class GetPayment implements ExtPlugin {
@@ -164,6 +212,7 @@ export namespace Billing {
     export class GetPlans implements ExtPlugin {
         responseType!: PlanCustom[];
         payload!: BasePaginationQuery & {
+            siteId: string;
             name?: string;
             active?: boolean;
             isDefault?: boolean;
@@ -172,7 +221,7 @@ export namespace Billing {
 
     export class GetPlan implements ExtPlugin {
         responseType!: PlanCustom;
-        payload!: { planId: string };
+        payload!: { siteId: string; planId: string };
     }
 
     export class GetProducts implements ExtPlugin {
@@ -183,33 +232,34 @@ export namespace Billing {
         payload!: BasePaginationQuery & {
             active?: boolean;
             name?: string;
-            isDefault?: boolean;
+            productType?: ProductType;
+            siteId: string;
         };
     }
 
     export class GetProduct implements ExtPlugin {
         responseType!: Omit<ProductCustom, 'org' | 'orgId' | 'site' | 'siteId'>;
-        payload!: { productId: string };
+        payload!: { siteId: string; productId: string };
     }
 
     export class GetSubscriptions implements ExtPlugin {
         responseType!: Subscription[];
-        payload!: BasePaginationQuery & { siteId: string; status?: string };
+        payload!: GetSubscriptionsQuery;
     }
 
     export class GetSubscription implements ExtPlugin {
         responseType!: Subscription;
-        payload!: { siteId: string; subscriptionId: string };
+        payload!: { subscriptionId: string };
     }
 
     export class CreateProduct implements ExtPlugin {
         responseType!: ProductCustom;
-        payload!: CreateProductCustom;
+        payload!: CreateProductCustom & { siteId: string };
     }
 
     export class CreatePlan implements ExtPlugin {
         responseType!: PlanCustom;
-        payload!: CustomCreatePlan;
+        payload!: CustomCreatePlan & { siteId: string };
     }
 
     export class UpdateCustomer implements ExtPlugin {
@@ -239,6 +289,22 @@ export namespace Billing {
         // payload!: any;
     }
 
+    export class UpdatePayment implements ExtPlugin {
+        responseType!: Payment;
+        payload!: _UpdatePayment & { paymentId: string };
+        // payload!: any;
+    }
+
+    export class GetCredits implements ExtPlugin {
+        responseType!: Credit[];
+        payload!: GetCreditsRequest;
+    }
+
+    export class CreateCredit implements ExtPlugin {
+        responseType!: Credit;
+        payload!: _CreateCredit;
+    }
+
     export class GetStatements implements ExtPlugin {
         responseType!: Statement[];
         payload!: BasePaginationQuery;
@@ -278,7 +344,7 @@ export namespace Billing {
 
     export class CreateOrder implements ExtPlugin {
         responseType!: Order;
-        payload!: { siteId: string } & _CreateOrder;
+        payload!: _CreateOrder;
     }
 
     export class GetOrder implements ExtPlugin {
@@ -290,14 +356,26 @@ export namespace Billing {
 
     export class GetOrders implements ExtPlugin {
         responseType!: Order[];
-        payload!: BasePaginationQuery & { status?: 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;
         };
     }
 
@@ -316,4 +394,72 @@ export namespace Billing {
             subscriptionId: string;
         } & _UpdateSubscription;
     }
+
+    export class UpdatePlan implements ExtPlugin {
+        responseType!: PlanCustom;
+        payload!: {
+            siteId: string;
+            planId: string;
+            updatePlanPayload: _UpdatePlan;
+        };
+    }
+
+    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 & { 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!: GetRefundsQuery;
+    }
+    
 }

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

@@ -10,7 +10,7 @@ export namespace CommunicationMethod {
             SendEmailPayload,
             'receiverEmail' | 'senderEmail' | 'contactId' | 'customerId'
         >;
-        payload!: SendEmailPayload;
+        payload!: Omit<SendEmailPayload, 'customerId' | 'contactId'>;
     }
     export class SendSms implements ExtPlugin {
         responseType!: Omit<

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

@@ -1,10 +1,9 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 import {
     CreateDocument,
-    DocumentSigned,
+    DocumentComplete,
     Success,
     Template,
-    DocumentUrl,
 } from '../../../generated';
 import { CreateTemplate as CreateTemplatePayload } from '../../../generated/models/create-template';
 import { ExtPlugin } from '../../types';
@@ -15,21 +14,13 @@ export namespace Document {
         responseType!: Success;
         payload!: CreateDocument & { siteId: string };
     }
-    export class GetDocuments implements ExtPlugin {
-        responseType!: DocumentUrl[];
-        payload!: { siteId: string } & BasePaginationQuery;
-    }
-    export class GetDocument implements ExtPlugin {
-        responseType!: DocumentUrl;
-        payload!: { siteId: string; documentId: string };
-    }
     export class CreateTemplate implements ExtPlugin {
         responseType!: Template;
         payload!: CreateTemplatePayload & { siteId?: string };
     }
     export class GetTemplate implements ExtPlugin {
         responseType!: Template;
-        payload!: { siteId?: string; templateId: string };
+        payload!: { templateId: string };
     }
     export class GetTemplates implements ExtPlugin {
         responseType!: Template[];
@@ -41,6 +32,6 @@ export namespace Document {
     }
     export class Signed implements ExtPlugin {
         responseType!: Success;
-        payload!: DocumentSigned;
+        payload!: DocumentComplete;
     }
 }

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

@@ -3,6 +3,7 @@ import {
     Customer,
     WorkflowStepInstance,
     WorkflowInstance,
+    // Asset,
 } from '../../../generated';
 import { ExtPlugin } from '../../types';
 
@@ -37,6 +38,11 @@ export namespace ManageSpace {
         payload!: any;
     }
 
+    export class CreatePrepayment implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
     export class CreateMoveOut implements ExtPlugin {
         responseType!: any;
         payload!: any;
@@ -49,7 +55,7 @@ export namespace ManageSpace {
 
     export class CustomerCreated implements ExtPlugin {
         responseType!: any;
-        payload!: { customerId: string };
+        payload!: Customer;
     }
 
     export class CustomerUpdated implements ExtPlugin {
@@ -76,4 +82,23 @@ export namespace ManageSpace {
         responseType!: any;
         payload!: { branch: string; commit: string };
     }
+
+    export class RentRollRequest implements ExtPlugin {
+        responseType!: any;
+        payload!: { userEmail: string };
+    }
+
+    export class UpdateChargesOnOrdway implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+    export class BillingWebhook implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class AssetUpdated implements ExtPlugin {
+        responseType!: any;
+        payload!: { asset: any };
+    }
 }

package/src/extensibility/functions/project/topics.enum.ts

@@ -11,4 +11,8 @@ export enum Topics {
     'ManageSpace.WorkflowStepReady' = 'ManageSpace.WorkflowStepReady',
     'ManageSpace.WorkflowInstanceCreated' = 'ManageSpace.WorkflowInstanceCreated',
     'ManageSpace.RepositoryUpdated' = 'ManageSpace.RepositoryUpdated',
+    'ManageSpace.RentRollRequest' = 'ManageSpace.RentRollRequest',
+    'ManageSpace.UpdateChargesOnOrdway' = 'ManageSpace.UpdateChargesOnOrdway',
+    'ManageSpace.BillingWebhook' = 'ManageSpace.BillingWebhook',
+    'ManageSpace.AssetUpdated' = 'ManageSpace.AssetUpdated',
 }

package/src/extensibility/types/control.ts

@@ -1,5 +1,4 @@
 // import { ApiFunctions } from '.';
-
 export type ControlValidation = {
     type: string;
     pattern: string;
@@ -18,6 +17,7 @@ export type BasePageControl = {
     placeholder?: string;
     validation?: ControlValidation;
     component?: string;
+    props?: Record<string, unknown>;
 };
 
 // Type for radio and checkbox controls
@@ -37,14 +37,14 @@ export type OtherPageControl = BasePageControl & {
         | 'customer'
         | 'contact'
         | 'user'
+        | 'insurance'
         | 'subscription'
         | 'document'
-        | 'payment'
-        | 'status'
-        | 'product'
-        | 'plan'
-        | 'boolean'
-        | 'charge';
+        | 'payment_method'
+        | 'manual_payment'
+        | 'status';
+    allowCreate?: boolean;
+    filterByStatus?: string | string[];
     options?: never;
 };
 
@@ -70,5 +70,6 @@ export type PageGroup = {
 export type UserIntervention = {
     formTitle: string;
     description: string;
+    exclusivePageGroups?: boolean;
     pageGroups: PageGroup[];
 };

package/src/extensibility/types/mapped-ports.ts

@@ -1,13 +1,6 @@
+import { DefinedWorkflowStep } from '../workflow/workflow-step';
 import { DefaultPorts } from './default-result';
-import { StepFunctionSignature } from './step-function-signature';
 
-export type MappedPorts<T extends string> = {
-    [K in T]?:
-        | StepFunctionSignature
-        | DefaultPorts
-        | undefined
-        | {
-              callback: StepFunctionSignature;
-              //   setDescription: (description: string) => void;
-          };
+export type MappedPorts<T extends string = DefaultPorts> = {
+    [K in T]?: DefaultPorts | undefined | DefinedWorkflowStep<any>;
 };

package/src/extensibility/types/step-function-signature.ts

@@ -1,11 +1,16 @@
 import { DefaultApi } from '../../generated';
+import { DefaultPorts } from './default-result';
 import {
     WorkflowStepBasePayload,
     WorkflowStepReturnType,
 } from './workflow-step';
 
-export type StepFunctionSignature = (
+export type StepFunctionSignature<T extends string = DefaultPorts> = (
     payload: WorkflowStepBasePayload & any,
-    api: DefaultApi,
+    api: DefaultApi & {
+        configurationSettings: {
+            [key: string]: string | number | boolean | Record<string, unknown>;
+        };
+    },
     state: any,
-) => Promise<WorkflowStepReturnType<string>>;
+) => Promise<WorkflowStepReturnType<T>>;

package/src/extensibility/types/workflow-step.ts

@@ -1,4 +1,5 @@
 import { UserIntervention } from './control';
+import { DefaultPorts } from './default-result';
 
 export type WorkflowStepBasePayload = {
     orgId: string;
@@ -6,33 +7,38 @@ export type WorkflowStepBasePayload = {
     instanceId: string;
 };
 
-export type WorkflowStepDelay =
-    | {
-          weeks: number;
-          days?: number;
-          hours?: number;
-          minutes?: number;
-      }
-    | {
-          weeks?: number;
-          days: number;
-          hours?: number;
-          minutes?: number;
-      }
-    | {
-          weeks?: number;
-          days?: number;
-          hours: number;
-          minutes?: number;
-      }
-    | {
-          weeks?: number;
-          days?: number;
-          hours?: number;
-          minutes: number;
-      };
+type AtLeastOne<T, Keys extends keyof T = keyof T> = Keys extends keyof T
+    ? Required<Pick<T, Keys>> & Partial<Omit<T, Keys>>
+    : never;
+
+type BaseTimeFields = {
+    weeks: number;
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+
+// When using relative time (hours/minutes)
+type RelativeDelay = AtLeastOne<BaseTimeFields> & {
+    setHour?: never;
+    setMinute?: never;
+};
+
+// When using absolute time (setHour/setMinute) - requires days or weeks
+type AbsoluteDelayWithDays = AtLeastOne<
+    Pick<BaseTimeFields, 'days' | 'weeks' | 'seconds'>,
+    'days' | 'weeks'
+> & {
+    setHour?: number;
+    setMinute?: number;
+    hours?: never;
+    minutes?: never;
+};
+
+type WorkflowStepDelay = RelativeDelay | AbsoluteDelayWithDays;
 
-export type WorkflowStepReturnType<T, A = null> =
+export type WorkflowStepReturnType<T extends string = DefaultPorts, A = null> =
     | ({
           result: T;
           state: any;

package/src/extensibility/workflow/workflow-step.ts

@@ -1,21 +1,17 @@
-import { DefaultApi } from '../../generated';
-import { DefaultPorts } from '../types';
-import {
-    WorkflowStepBasePayload,
-    WorkflowStepReturnType,
-} from '../types/workflow-step';
+import { DefaultPorts, StepFunctionSignature } from '../types';
 
-export const defineWorkflowStep = <T = DefaultPorts>(
-    callback: (
-        payload: WorkflowStepBasePayload & any,
-        api: DefaultApi,
-        state: any,
-    ) => Promise<WorkflowStepReturnType<T>>,
-) => {
+export type DefinedWorkflowStep<T extends string = DefaultPorts> = {
+    callback: StepFunctionSignature<T>;
+    setDescription: (description: string) => DefinedWorkflowStep<T>;
+};
+
+export const defineWorkflowStep = <T extends string = DefaultPorts>(
+    callback: StepFunctionSignature<T>,
+): DefinedWorkflowStep<T> => {
     const step = {
         callback,
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        setDescription: (description: string) => {
+        setDescription: (description: string): DefinedWorkflowStep<T> => {
             return step;
         },
     };

package/src/extensibility/workflow/workflow.ts

@@ -1,11 +1,8 @@
 import { DefaultPorts, ExtPlugin, MappedPorts } from '../types';
-import { StepFunctionSignature } from '../types/step-function-signature';
+import { DefinedWorkflowStep } from './workflow-step';
 
 export const define = <T extends string = DefaultPorts>(
-    fn: {
-        callback: StepFunctionSignature;
-        setDescription: (description: string) => void;
-    },
+    fn: DefinedWorkflowStep<T>,
     ports: MappedPorts<T>,
     maxRunCount?: number,
 ) => {
@@ -20,3 +17,44 @@ export const defineWorkflow = <T extends ExtPlugin>(...args: any[]) => {
         setDescription: (description: string) => {},
     };
 };
+
+// type OtherTestPorts = 'four' | 'five' | 'six';
+// const stepTestThree = defineWorkflowStep<testThree>(
+//     async (payload, api, state) => {
+//         const test3 = api.configurationSettings['test'];
+//         return {
+//             // result: 'Success',
+//             result: '4',
+//             state: {},
+//         };
+//     },
+// ).setDescription('test');
+
+// type TestPorts = 'one' | 'two' | 'three';
+
+// const stepTest = defineWorkflowStep<TestPorts>(async (payload, api, state) => {
+//     return {
+//         result: 'one',
+//         state: {},
+//     };
+// }).setDescription('test');
+
+// const stepTestTwo = defineWorkflowStep<DefaultPorts>(
+//     async (payload, api, state) => {
+//         return {
+//             result: 'Success',
+//             state: {},
+//         };
+//     },
+// ).setDescription('test');
+
+// const defineTest = defineWorkflow<CommunicationMethod.SendEmail>(
+//     define<TestPorts>(stepTest, {
+//         one: stepTestTwo,
+//         three: stepTest,
+//     }),
+//     define<DefaultPorts>(stepTestTwo, {
+//         ManualInputReceived: stepTest,
+//         Success: 'End',
+//     }),
+// );