@managespace/sdk 0.1.10 → 0.1.12

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/types/control.ts

@@ -18,6 +18,7 @@ export type BasePageControl = {
     placeholder?: string;
     validation?: ControlValidation;
     component?: string;
+    props?: Record<string, unknown>;
 };
 
 // Type for radio and checkbox controls
@@ -37,14 +38,11 @@ export type OtherPageControl = BasePageControl & {
         | 'customer'
         | 'contact'
         | 'user'
+        | 'insurance'
         | 'subscription'
         | 'document'
         | 'payment'
-        | 'status'
-        | 'product'
-        | 'plan'
-        | 'boolean'
-        | 'charge';
+        | 'status';
     options?: never;
 };
 

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;
@@ -32,7 +33,7 @@ export type WorkflowStepDelay =
           minutes: number;
       };
 
-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',
+//     }),
+// );

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

@@ -5,6 +5,7 @@ models/address.ts
 models/admin-sign-up.ts
 models/asset-category.ts
 models/asset-class.ts
+models/asset-details.ts
 models/asset-feature.ts
 models/asset.ts
 models/billing-run-filter-condition.ts
@@ -32,7 +33,6 @@ models/create-billing-run.ts
 models/create-calendar.ts
 models/create-charge.ts
 models/create-chart-of-accounts.ts
-models/create-checklist.ts
 models/create-communication.ts
 models/create-configuration-setting.ts
 models/create-document.ts
@@ -43,6 +43,7 @@ models/create-notification.ts
 models/create-order.ts
 models/create-org.ts
 models/create-payment-invoice.ts
+models/create-payment-method.ts
 models/create-payment-refund.ts
 models/create-payment-run.ts
 models/create-payment.ts
@@ -53,19 +54,20 @@ models/create-site-custom.ts
 models/create-smart-bar-prompt.ts
 models/create-subscription-charge.ts
 models/create-subscription.ts
-models/create-task-template.ts
-models/create-task.ts
+models/create-task-definition.ts
+models/create-task-instance.ts
 models/create-template.ts
+models/custom-create-checklist.ts
 models/custom-create-contact.ts
 models/custom-create-customer.ts
 models/custom-create-plan.ts
 models/custom-create-user.ts
 models/custom-update-customer.ts
 models/custom-update-extensibility-repo.ts
-models/custom-update-task-template.ts
 models/customer.ts
+models/document-complete.ts
 models/document-field.ts
-models/document-signed.ts
+models/document-hierarchy.ts
 models/document-signer.ts
 models/document-url.ts
 models/execute-by.ts
@@ -97,6 +99,7 @@ models/get-invoices200-response.ts
 models/get-notes200-response.ts
 models/get-notifications200-response.ts
 models/get-orders200-response.ts
+models/get-payment-methods200-response.ts
 models/get-payment-runs200-response.ts
 models/get-payments200-response.ts
 models/get-plans200-response.ts
@@ -106,8 +109,7 @@ models/get-revenue-rules200-response.ts
 models/get-sites200-response.ts
 models/get-statements200-response.ts
 models/get-subscriptions200-response.ts
-models/get-task-templates200-response.ts
-models/get-tasks200-response.ts
+models/get-task-definitions200-response.ts
 models/get-templates200-response.ts
 models/get-users200-response.ts
 models/get-workflow-definitions200-response.ts
@@ -131,6 +133,7 @@ models/page-meta.ts
 models/paginated.ts
 models/password-strength-check.ts
 models/password.ts
+models/payment-method.ts
 models/payment-run-filter-condition.ts
 models/payment-run-filter-options.ts
 models/payment-run.ts
@@ -144,22 +147,27 @@ models/plugin-version.ts
 models/plugin.ts
 models/product-custom.ts
 models/project-version.ts
+models/project-version1.ts
 models/project.ts
 models/project1.ts
+models/project2.ts
 models/revenue-rule.ts
 models/role.ts
 models/role1.ts
 models/role2.ts
+models/role3.ts
 models/roles.ts
 models/roles1.ts
 models/roles2.ts
 models/roles3.ts
+models/roles4.ts
 models/send-email.ts
 models/send-sms.ts
 models/site-type.ts
 models/site-type1.ts
 models/site-type2.ts
 models/site-type3.ts
+models/site-type4.ts
 models/site.ts
 models/smart-bar-prompt.ts
 models/statement.ts
@@ -172,8 +180,8 @@ models/subscription-preview.ts
 models/subscription.ts
 models/success.ts
 models/task-completion-status.ts
-models/task-template.ts
-models/task.ts
+models/task-definition.ts
+models/task-instance.ts
 models/tax-line.ts
 models/template-field.ts
 models/template-signer.ts
@@ -183,18 +191,19 @@ models/transaction-posting-entries.ts
 models/update-asset-category.ts
 models/update-asset-feature.ts
 models/update-asset.ts
-models/update-checklist-task-template.ts
 models/update-configuration-setting.ts
 models/update-map-feature.ts
 models/update-note.ts
 models/update-org.ts
+models/update-plan.ts
 models/update-smart-bar-prompt.ts
 models/update-subscription-charge.ts
 models/update-subscription.ts
+models/update-task-instance.ts
 models/update-user-properties.ts
+models/update-workflow-instance-description.ts
 models/upload-document.ts
 models/uploaded-document.ts
-models/uploaded-documents.ts
 models/user-id.ts
 models/user.ts
 models/workflow-definition.ts