@erp-galoper/types 1.0.1861 → 1.0.1862

package/openapi.ts

@@ -2380,26 +2380,20 @@ export interface paths {
         };
         /**
          * Get Logs
-         * @description Endpoint to get logs from all models or filter by specific model.
-         *     Query Parameters:
-         *     - logModelName (optional): Filter by specific model name from LogModelName enum. If not provided, returns logs from all models in the enum.
-         *                                REQUIRED when documentId is provided.
-         *     - logType (optional): Filter by log type (Created, Changed, Deleted)
-         *     - startDate (optional): Filter from date (YYYY-MM-DD)
-         *     - endDate (optional): Filter to date (YYYY-MM-DD)
-         *     - user (optional): Filter by user ID
-         *     - documentId (optional): Filter by specific document ID (UUID). Requires logModelName to be specified.
-         *     - page (optional): Page number (default: 1)
-         *     - pageSize (optional): Number of items per page (default: 20, max: 500)
+         * @description Endpoint to get logs for a specific model.
          *
          *     Possible Responses:
          *     - 200: LogsResponseSchema
-         *     - 400: missingLogModelName (when documentId is provided without logModelName)
          *     - 403: permissionDenied
+         *     - 400:
+         *         - startDateAndEndDateAreRequiredForCustomPeriodType
+         *         - startDateShouldBeGreaterThanEndDate
+         *         - invalidFilterFormat
+         *         - paginationError
          *     - 500: internalServerError
          *
-         *      Permission Key:
-         *         logs : ["view"]'
+         *     Permission Key:
+         *         logs: ["view"]
          */
         get: operations["common_views_get_logs"];
         put?: never;
@@ -67522,17 +67516,21 @@ export interface operations {
     };
     common_views_get_logs: {
         parameters: {
-            query?: {
-                logModelName?: "item" | "customer" | "supplier" | "internalTransferHeader" | "transferRequest" | "stockAdjustment" | "openingQuantity" | "supplierPriceList" | "chartOfAccount" | "journalVoucher" | "requisition" | "requestForQuotation" | "advancePayment" | "paymentVoucher" | "purchaseInvoice" | "purchaseOrder" | "purchaseQuotation" | "purchaseReturnOrder" | "purchaseReturnInvoice" | "refundVoucher" | "purchaseCreditNote" | "project" | "warehouse" | "employeePosition" | "employee" | "accountingSetting" | "defaultGeneralAccounts" | "transactionalSubsidiaryAccounts" | "accountClassification" | "taxes" | "appointmentSettings" | "approvalSettings" | "approvalConfig" | "approvalCondition" | "approvalLevel" | "inventorySettings" | "itemVariantSettings" | "posSettings" | "purchaseSettings" | "salesSetting" | "city" | "zone" | "shippingMethod" | "systemSettings" | "transactionLocking" | "userSetting" | "department" | "company" | "branch" | "region" | "currency" | "facility" | "reason" | "emailSetting" | "bank" | "users" | "roles" | "appointment" | "offerAndPromotion" | "salesQuotation" | "salesOrder" | "downPayment" | "receiptVoucher" | "salesCreditNote" | "salesInvoice" | "salesReturnOrder" | "salesReturnInvoice" | "salesRefundVoucher" | "salesPriceList" | "goodsDeliveryNote" | "returnablePackageReconciliation" | "salesReturnPackage" | "package" | "packageType" | "itemPackage" | "goodsReceiptNote" | "transferRequest" | "salesPerson" | "commissionStructure" | "commissionPayout" | "closingCommission" | "posInvoice" | "onlineStoreSetting" | "onlineStorageSettings" | "task" | "event" | "dimension" | "expenseCategory" | "expenseVoucher" | "expensePaymentVoucher" | "whatsAppIntegration" | "onlineOrder";
+            query: {
+                logModelName: "item" | "customer" | "supplier" | "internalTransferHeader" | "transferRequest" | "stockAdjustment" | "openingQuantity" | "supplierPriceList" | "chartOfAccount" | "journalVoucher" | "requisition" | "requestForQuotation" | "advancePayment" | "paymentVoucher" | "purchaseInvoice" | "purchaseOrder" | "purchaseQuotation" | "purchaseReturnOrder" | "purchaseReturnInvoice" | "refundVoucher" | "purchaseCreditNote" | "project" | "warehouse" | "employeePosition" | "employee" | "accountingSetting" | "defaultGeneralAccounts" | "transactionalSubsidiaryAccounts" | "accountClassification" | "taxes" | "appointmentSettings" | "approvalSettings" | "approvalConfig" | "approvalCondition" | "approvalLevel" | "inventorySettings" | "itemVariantSettings" | "posSettings" | "purchaseSettings" | "salesSetting" | "city" | "zone" | "shippingMethod" | "systemSettings" | "transactionLocking" | "userSetting" | "department" | "company" | "branch" | "region" | "currency" | "facility" | "reason" | "emailSetting" | "bank" | "users" | "roles" | "appointment" | "offerAndPromotion" | "salesQuotation" | "salesOrder" | "downPayment" | "receiptVoucher" | "salesCreditNote" | "salesInvoice" | "salesReturnOrder" | "salesReturnInvoice" | "salesRefundVoucher" | "salesPriceList" | "goodsDeliveryNote" | "returnablePackageReconciliation" | "salesReturnPackage" | "package" | "packageType" | "itemPackage" | "goodsReceiptNote" | "transferRequest" | "salesPerson" | "commissionStructure" | "commissionPayout" | "closingCommission" | "posInvoice" | "onlineStoreSetting" | "onlineStorageSettings" | "task" | "event" | "dimension" | "expenseCategory" | "expenseVoucher" | "expensePaymentVoucher" | "whatsAppIntegration" | "onlineOrder";
                 logType?: "Created" | "Changed" | "Deleted";
-                startDate?: string;
-                endDate?: string;
+                /** @description by default periodType is set to date filtration in user settings, Period type: thisMonth, thisYear, lastMonth, custom, ... */
+                periodType?: "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisFiscalYear" | "lastFiscalYear" | "custom" | "today" | "all";
+                /** @description Start date for custom range (YYYY-MM-DD), this required if the period type is custom */
+                startDate?: string | null;
+                /** @description End date for custom range (YYYY-MM-DD), this required if the period type is custom */
+                endDate?: string | null;
+                /** @description Filter by user ID */
                 user?: string;
+                /** @description Filter by specific document ID */
                 documentId?: string;
-                /** @description Page number */
-                page?: number;
-                /** @description Page size */
-                pageSize?: number;
+                /** @description Search */
+                search?: string | null;
             };
             header?: never;
             path?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erp-galoper/types",
-  "version": "1.0.1861",
+  "version": "1.0.1862",
   "main": "openapi.ts",
   "types": "openapi.ts",
   "files": ["openapi.ts"],