@pgds/api-interface 1.6.1 → 1.6.3

package/api/notes/createNoteEndpoint.d.ts

@@ -0,0 +1,8 @@
+import { JsonResponse, Request } from "../..";
+declare const _default: {
+    (): void;
+    requestHandler: (req: Request<any, any>, res?: import("../..").Response<any>, next?: import("../..").Next) => Promise<JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/notes/getNoteByIdEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/notes/getNotesByReferenceIdEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/notes/removeNoteEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/notes/updateNoteEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/prescriptions/createPrescriptionEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/prescriptions/getAllPrescriptionsByOrganizationIdEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/prescriptions/getAllPrescriptionsEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/prescriptions/getPrescriptionByIdEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/prescriptions/removePrescriptionEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/prescriptions/updatePrescriptionEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/createProductTypeEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/customization/getThingProductTypeCustomizationEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../..").Request<any, any>, res?: import("../../..").Response<any>, next?: import("../../..").Next) => Promise<import("../../..").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/customization/updateOrganizationIdForProductTypeCustomizationsEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/customization/upsertProductTypeCustomizationEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/getAvailableProductTypesEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/getProductTypeByIdOrCodeEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/getProductTypeByThingIdEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/getProductTypesEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/internal/deleteProductTypeCustomizationsByQueryEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/internal/getProductTypesAndCustomizationsEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/removeProductTypeEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/sharing/createProductTypeSharingEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/sharing/getAllProductTypeSharingEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/sharing/getProductTypeAclsByShareIdEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/sharing/getProductTypeSharingByIdEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/sharing/removeProductTypeSharingEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../../").Request<any, any>, res?: import("../../../").Response<any>, next?: import("../../../").Next) => Promise<import("../../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/updateProductTypeCapabilitiesEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/productTypes/updateProductTypeEndpoint.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    (): void;
+    requestHandler: (req: import("../../").Request<any, any>, res?: import("../../").Response<any>, next?: import("../../").Next) => Promise<import("../../").JsonResponse<any> | void>;
+    PATH: string;
+    unregister(): void;
+};
+export default _default;

package/api/routes.d.ts

@@ -0,0 +1 @@
+export declare function registerEndpoints(): void;

package/api/schemas/notes/createNoteSchema.d.ts

@@ -0,0 +1,28 @@
+import { NoteReferenceType } from "../../../constants/constants";
+export declare const createNoteSchema: {
+    type: string;
+    properties: {
+        reference: {
+            type: string;
+            properties: {
+                referenceId: {
+                    type: string;
+                    minLength: number;
+                };
+                referenceType: {
+                    type: string;
+                    enum: NoteReferenceType[];
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+        content: {
+            type: string;
+            description: string;
+            minLength: number;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/api/schemas/notes/getNotesByReferenceIdSchema.d.ts

@@ -0,0 +1,36 @@
+import { NoteReferenceType } from "../../../constants/constants";
+export declare const getNotesByReferenceIdSchema: {
+    type: string;
+    properties: {
+        q: {
+            type: string;
+        };
+        page: {
+            type: string;
+        };
+        size: {
+            type: string;
+        };
+        sortBy: {
+            type: string;
+            enum: string[];
+            default: string;
+        };
+        sortOrder: {
+            type: string;
+            enum: string[];
+            default: string;
+        };
+        referenceId: {
+            type: string;
+        };
+        referenceType: {
+            type: string;
+            enum: NoteReferenceType[];
+        };
+        createdBy: {
+            type: string;
+        };
+    };
+    additionalProperties: boolean;
+};

package/api/schemas/notes/getNotesByUserIdSchema.d.ts

@@ -0,0 +1,40 @@
+import { NoteReferenceType } from "../../../constants/constants";
+export declare const getNotesByUserIdSchema: {
+    type: string;
+    properties: {
+        userId: {
+            type: string;
+            minLength: number;
+        };
+        q: {
+            type: string;
+        };
+        page: {
+            type: string;
+        };
+        size: {
+            type: string;
+        };
+        sortBy: {
+            type: string;
+            enum: string[];
+            default: string;
+        };
+        sortOrder: {
+            type: string;
+            enum: string[];
+            default: string;
+        };
+        referenceId: {
+            type: string;
+        };
+        referenceType: {
+            type: string;
+            enum: NoteReferenceType[];
+        };
+        createdBy: {
+            type: string;
+        };
+    };
+    additionalProperties: boolean;
+};

package/api/schemas/notes/notesSchemasShared.d.ts

@@ -0,0 +1,5 @@
+export declare const noteContentSchema: {
+    type: string;
+    description: string;
+    minLength: number;
+};

package/api/schemas/notes/updateNoteSchema.d.ts

@@ -0,0 +1,12 @@
+export declare const updateNoteSchema: {
+    type: string;
+    properties: {
+        content: {
+            type: string;
+            description: string;
+            minLength: number;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/api/schemas/notes/updateOrganizationIdRequestSchema.d.ts

@@ -0,0 +1,15 @@
+export declare const UpdateOrganizationIdRequestBodySchema: {
+    type: string;
+    properties: {
+        referenceIds: {
+            type: string;
+            items: {
+                type: string;
+            };
+        };
+        newOrganizationId: {
+            type: string;
+        };
+    };
+    required: string[];
+};

package/api/schemas/prescriptions/createPrescriptionSchema.d.ts

@@ -0,0 +1,36 @@
+export declare const createPrescriptionSchema: {
+    type: string;
+    properties: {
+        organization: {
+            type: string;
+        };
+        showForCustomer: {
+            type: string;
+        };
+        imageUrl: {
+            type: string;
+            maxLength: number;
+        };
+        stack: {
+            type: string;
+        };
+        name: {
+            type: string;
+            minLength: number;
+        };
+        status: {
+            type: string;
+            maxLength: number;
+        };
+        products: {
+            type: string;
+            default: never[];
+        };
+        language: {
+            type: string;
+            maxLength: number;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/api/schemas/prescriptions/prescriptionIdSchema.d.ts

@@ -0,0 +1,11 @@
+export declare const prescriptionIdSchema: {
+    type: string;
+    properties: {
+        prescriptionId: {
+            type: string;
+            minLength: number;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/api/schemas/prescriptions/updatePrescriptionSchema.d.ts

@@ -0,0 +1,39 @@
+export declare const updatePrescriptionSchema: {
+    type: string;
+    properties: {
+        organization: {
+            type: string;
+        };
+        name: {
+            type: string;
+            minLength: number;
+        };
+        showForCustomer: {
+            type: string;
+        };
+        imageUrl: {
+            type: string;
+            maxLength: number;
+        };
+        status: {
+            type: string;
+            maxLength: number;
+        };
+        owner: {
+            type: string;
+        };
+        stack: {
+            type: string;
+        };
+        products: {
+            type: string;
+            default: never[];
+        };
+        language: {
+            type: string;
+            maxLength: number;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/api/schemas/productTypes/createProductTypeSchema.d.ts

@@ -0,0 +1,63 @@
+import { ThingVersion } from "../../../constants/constants";
+export declare const createProductTypeSchema: {
+    type: string;
+    properties: {
+        name: {
+            type: string;
+            minLength: number;
+        };
+        owner: {
+            type: string;
+        };
+        productCode: {
+            type: string;
+        };
+        dashboardUri: {
+            type: string;
+        };
+        productImageUrl: {
+            type: string;
+        };
+        category: {
+            enum: readonly ["sensor", "property", "health", "other", "waterSwitch", "waterMeter", "waterSensor", "weatherSensor"];
+            default: string;
+        };
+        manufacturer: {
+            type: string;
+        };
+        description: {
+            type: string;
+        };
+        heartbeat: {
+            type: string;
+            properties: {
+                interval: {
+                    type: string[];
+                    default: number;
+                };
+                timeout: {
+                    type: string[];
+                    default: number;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        canOnlyBeAddedByGlobal: {
+            type: string;
+        };
+        serialNumberPrefix: {
+            type: string;
+            maxLength: number;
+        };
+        supportedThingVersions: {
+            type: string;
+            items: {
+                type: string;
+                enum: ThingVersion[];
+            };
+            default: ThingVersion[];
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/api/schemas/productTypes/createProductTypeSharingSchema.d.ts

@@ -0,0 +1,31 @@
+export declare const createProductTypeSharingSchema: {
+    type: string;
+    properties: {
+        type: {
+            type: string;
+            pattern: string;
+        };
+        shareTo: {
+            type: string;
+            minLength: number;
+        };
+        allowRead: {
+            type: string;
+        };
+        allowWrite: {
+            type: string;
+        };
+        allowDelete: {
+            type: string;
+        };
+        productTypeIdOrCode: {
+            type: string;
+            items: {
+                type: string;
+            };
+            minItems: number;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/api/schemas/productTypes/customization/productTypeCustomizationSchema.d.ts

@@ -0,0 +1,59 @@
+export declare const productTypeCustomizationSchema: {
+    type: string;
+    properties: {
+        productTypeCustomizationId: {
+            type: string;
+        };
+        productCode: {
+            type: string;
+        };
+        organizationId: {
+            type: string;
+        };
+        customization: {
+            type: string;
+            properties: {
+                name: {
+                    type: string;
+                    minLength: number;
+                };
+                heartbeat: {
+                    type: string;
+                    properties: {
+                        interval: {
+                            type: string[];
+                            default: number;
+                        };
+                        timeout: {
+                            type: string[];
+                            default: number;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        metadata: {
+            type: string;
+            properties: {
+                createdBy: {
+                    type: string;
+                };
+                createdAt: {
+                    type: string;
+                };
+                modifiedBy: {
+                    type: string;
+                };
+                modifiedAt: {
+                    type: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};