@m6d/cortex-server 1.7.0 → 1.8.0

package/src/sample/domains/servicing/endpoints/listServiceRequests.endpoint.ts

@@ -0,0 +1,292 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { serviceRequestConcept } from "../concepts/serviceRequest.concept";
+import { filterServiceRequestsByStateRule } from "../rules/filterServiceRequestsByState.rule";
+import { getServiceStatesEndpoint } from "./getServiceStates.endpoint";
+
+export const listServiceRequestsEndpoint = defineEndpoint({
+    name: "List service requests",
+    path: "/servicing/requests",
+    method: "GET",
+    description:
+        "List service requests with filtering by user ids (not employee), service type, and status.",
+    queries: [serviceRequestConcept],
+    returns: [{ concept: serviceRequestConcept }],
+    dependsOn: [
+        {
+            endpoint: getServiceStatesEndpoint,
+            paramName: "states",
+            fromField: "value",
+        },
+    ],
+    paramDescriptions: {
+        serviceIds: "The service UUID or built-in id ",
+    },
+    governedBy: [filterServiceRequestsByStateRule],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "serviceIds", required: false, type: "string", isArray: true },
+            { name: "userIds", required: false, type: "uuid", isArray: true },
+            { name: "applyingUserIds", required: false, type: "uuid", isArray: true },
+            { name: "from", required: false, type: "datetime" },
+            { name: "to", required: false, type: "datetime" },
+            { name: "scope", required: false, type: "'all' | 'own' | 'act'" },
+            { name: "states", required: false, type: "string", isArray: true },
+            { name: "pageNumber", required: false, type: "number" },
+            { name: "pageSize", required: false, type: "number" },
+            {
+                name: "orderByProperties",
+                required: false,
+                type: "object",
+                isArray: true,
+                properties: [
+                    { name: "property", required: false, type: "string" },
+                    { name: "direction", required: false, type: "'asc' | 'desc'" },
+                ],
+            },
+            { name: "filterCountExclusions", required: false, type: "'user_id'", isArray: true },
+            { name: "customFilter", required: false, type: "object" },
+        ] as const,
+        body: [] as const,
+        response: [
+            {
+                name: "items",
+                required: false,
+                type: "object",
+                isArray: true,
+                properties: [
+                    { name: "id", required: false, type: "uuid" },
+                    { name: "createdTime", required: false, type: "datetime" },
+                    {
+                        name: "service",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            { name: "builtInId", required: false, type: "string" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "description",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "subcategory",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                    {
+                                        name: "description",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                    {
+                                        name: "category",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            { name: "isProxyApplicationEnabled", required: false, type: "boolean" },
+                            { name: "isArchived", required: false, type: "boolean" },
+                            { name: "isSystemManaged", required: false, type: "boolean" },
+                            {
+                                name: "states",
+                                required: false,
+                                type: "object",
+                                isArray: true,
+                                properties: [
+                                    { name: "value", required: false, type: "string" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                    {
+                                        name: "description",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "actions",
+                                required: false,
+                                type: "object",
+                                isArray: true,
+                                properties: [
+                                    { name: "key", required: false, type: "string" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "requirements",
+                                required: false,
+                                type: "object",
+                                isArray: true,
+                                properties: [
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        name: "user",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            { name: "globalExtraData", required: false, type: "unknown" },
+                        ],
+                    },
+                    {
+                        name: "applyingUser",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            { name: "globalExtraData", required: false, type: "unknown" },
+                        ],
+                    },
+                    {
+                        name: "state",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "value", required: false, type: "string" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "description",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        name: "lastAction",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "key", required: false, type: "string" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                        ],
+                    },
+                    { name: "data", required: false, type: "object" },
+                    { name: "transactionCount", required: false, type: "number" },
+                    { name: "latestTransactionCreatedTime", required: false, type: "datetime" },
+                    {
+                        name: "ability",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "canWrite", required: false, type: "boolean" },
+                            { name: "canDelete", required: false, type: "boolean" },
+                            { name: "canCancel", required: false, type: "boolean" },
+                        ],
+                    },
+                    { name: "isUserSuspended", required: false, type: "boolean" },
+                    { name: "globalExtraData", required: false, type: "unknown" },
+                ],
+            },
+            { name: "count", required: false, type: "number" },
+            { name: "filteredCount", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

package/src/sample/domains/servicing/endpoints/listServices.endpoint.ts

@@ -0,0 +1,108 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { serviceConcept } from "../concepts/service.concept";
+
+export const listServicesEndpoint = defineEndpoint({
+    name: "List services",
+    path: "/servicing/services",
+    method: "GET",
+    description:
+        "List all available services (used to look up the real UUID for a service by its builtInId)",
+    queries: [serviceConcept],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "keyword", required: false, type: "string" },
+            { name: "categoryIds", required: false, type: "uuid", isArray: true },
+            { name: "subcategoryIds", required: false, type: "uuid", isArray: true },
+            { name: "tags", required: false, type: "string", isArray: true },
+            { name: "attributes", required: false, type: "string", isArray: true },
+            { name: "pageNumber", required: false, type: "number" },
+            { name: "pageSize", required: false, type: "number" },
+        ] as const,
+        body: [] as const,
+        response: [
+            {
+                name: "items",
+                required: false,
+                type: "object",
+                isArray: true,
+                properties: [
+                    { name: "id", required: false, type: "uuid" },
+                    { name: "builtInId", required: false, type: "string" },
+                    {
+                        name: "name",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    {
+                        name: "description",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    {
+                        name: "subcategory",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "description",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "category",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    { name: "isArchived", required: false, type: "boolean" },
+                    { name: "isSystemManaged", required: false, type: "boolean" },
+                    { name: "isFavorite", required: false, type: "boolean" },
+                    { name: "pendingRequestCount", required: false, type: "number" },
+                ],
+            },
+            { name: "count", required: false, type: "number" },
+            { name: "filteredCount", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});