@erp-galoper/main-package 1.0.142 → 1.0.144

package/openapi.ts

@@ -574,6 +574,36 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/common/regions/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Regions
+         * @description Endpoint for  list regions
+         *     possible responses:
+         *     - 200:
+         *         - success
+         *     - 403:
+         *         - permissionDenied
+         *     - 400:
+         *         - branchesWithIds{missing_branch_ids}NotFound
+         *         - paginationError
+         *     - Permission Key:
+         *         - region : [ view ]
+         */
+        get: operations["common_views_list_regions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/common/transaction_types/": {
         parameters: {
             query?: never;
@@ -1364,6 +1394,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customers/export/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Export Customers
+         * @description Endpoint for export customers
+         *     Possible Responses:
+         *     - 200:
+         *         - success
+         *     - 403:
+         *         - permissionDenied
+         *         - noBranchAccess
+         *     - 400:
+         *         - branchesWithIds{missing_branch_ids}NotFound
+         *         - regionsWithIds{missing_region_ids}NotFound
+         *     - 500:
+         *         - internalServerError
+         *     - This function is responsible for export all customers within the selected region(s)
+         *     - Permission key :
+         *         - customer  : [ export ]
+         */
+        get: operations["customer_views_export_customers"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/accounting/journal_vouchers/": {
         parameters: {
             query?: never;
@@ -1870,6 +1934,42 @@ export interface components {
             /** Depth */
             depth: number;
         };
+        /** ListRegions */
+        ListRegions: {
+            info: components["schemas"]["PageInfoSchema"];
+            /** Results */
+            results: components["schemas"]["RetrieveRegion"][];
+        };
+        /** RetrieveRegion */
+        RetrieveRegion: {
+            /** Id */
+            id: number;
+            /** Name */
+            name: string;
+            /** Country */
+            country: string;
+            /** Branchnumber */
+            branchNumber: number;
+        };
+        /** ErrorMessageSchema */
+        ErrorMessageSchema: {
+            /** Message */
+            message?: string | null;
+            /** Code */
+            code: string;
+            /**
+             * Fields
+             * @default []
+             */
+            fields: string[] | null;
+            /** Index */
+            index?: number | null;
+        };
+        /** ErrorMessages */
+        ErrorMessages: {
+            /** Errors */
+            errors: components["schemas"]["ErrorMessageSchema"][];
+        };
         /** TransactionTypeOptionSchema */
         TransactionTypeOptionSchema: {
             option: components["schemas"]["TransactionTypesSchema"];
@@ -2019,25 +2119,6 @@ export interface components {
             /** Results */
             results: components["schemas"]["AccountInfoInDropDown"][];
         };
-        /** ErrorMessageSchema */
-        ErrorMessageSchema: {
-            /** Message */
-            message?: string | null;
-            /** Code */
-            code: string;
-            /**
-             * Fields
-             * @default []
-             */
-            fields: string[] | null;
-            /** Index */
-            index?: number | null;
-        };
-        /** ErrorMessages */
-        ErrorMessages: {
-            /** Errors */
-            errors: components["schemas"]["ErrorMessageSchema"][];
-        };
         /** BranchDetails */
         BranchDetails: {
             /** Id */
@@ -2589,7 +2670,7 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @example 4638280e-f087-459b-8c97-6438ff5ab504
+             * @example 17ac0842-1e4e-4e45-9a9b-e0d24234b9d9
              */
             id: string;
             /**
@@ -2806,6 +2887,13 @@ export interface components {
             /** Invoicerefunds */
             invoiceRefunds: components["schemas"]["PosRefundSchema"][];
         };
+        /** ExportSchema */
+        ExportSchema: {
+            /** Pdf */
+            pdf: string;
+            /** Excel */
+            excel: string;
+        };
         /** AccountInfo */
         AccountInfo: {
             /** Name */
@@ -4019,6 +4107,64 @@ export interface operations {
             };
         };
     };
+    common_views_list_regions: {
+        parameters: {
+            query: {
+                branchIds: number[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListRegions"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessages"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+        };
+    };
     common_views_get_transaction_types: {
         parameters: {
             query?: never;
@@ -5440,6 +5586,67 @@ export interface operations {
             };
         };
     };
+    customer_views_export_customers: {
+        parameters: {
+            query: {
+                /** @description to get regions use route /common/regions/ where branch ids same as selected branch ids in export route */
+                regionIds: number[];
+                /** @description get branches from /auth/user/me */
+                branchIds: number[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExportSchema"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessages"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+        };
+    };
     accounting_generalvoucher_views_list_journal_vouchers_in_export: {
         parameters: {
             query: {

package/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@erp-galoper/main-package",
-  "version": "1.0.142",
+  "version": "1.0.144",
   "main": "openapi.ts"
 }