repzo 1.0.289 → 1.0.291

package/changelog.md

@@ -18,6 +18,11 @@
 - add: apps-management, reset-company-namespace & test-reset-company-namespace @maramalshen
 - add: `rep_can_edit_invoice_discount` & `rep_can_edit_sales_order_discount` to RepPermissions and the Rep find-params filters — gate the header discount overwrite (`overwriteDeductionFixed`/`overwriteDeductionRatio`) on invoices and Sales Orders @mkhamis
 - add: header total `total_before_deduction_and_tax` (+ `pre_`/`return_` legs) on FullInvoice, Proforma and Cart (Schema, CreateBody, UpdateBody) — `total_before_tax + totalDeductionBeforeTax`, i.e. the net-of-tax subtotal before the cart (header) deduction; net of tax for inclusive-tax lines too, unlike `taxable_subtotal`. The Proforma types were also missing the `total_before_tax` / `pre_` / `return_` trio the backend has stored all along, so those are added alongside @mkhamis
+- add: geo-zone (GeoZone) service and types — `find`/`get`/`create`/`update`/`remove`, `inject_assigned_reps` on find/get, GeoJSON `Polygon` (`{ type: "Polygon"; coordinates }`) with server-side ring validation, soft-delete via `disabled`, and the server-stamped `editor` audit object; `NotificationsCenter.Command` gains `update-geo-zone`; OAS `geo-zone.yaml`
+- add: Rep `assigned_geo_zones` (RepSchema, RepBody, find-params filter, populated keys, RepWithPopulatedKeysSchema) — links a rep to geo zone(s) (currently at most one); OAS `rep.yaml`
+- add: `rep_can_start_visit_out_of_geofence` & `rep_can_create_approval_request_to_start_visit_out_of_geofence` to RepPermissions and the Rep find-params filters — gate starting a visit while outside the geofence / assigned geo zone
+- add: Settings geo-zone enforcement fields — `start_day_outside_active_zone_action` / `start_visit_outside_active_zone_action` / `work_outside_active_zone_action` (`monitor`/`warning`/`block`), `no_active_zone_action` (`allow`/`block`), `use_accuracy_radius_near_zone_boundary`, `zone_boundary_grace_minutes` (Settings.Data + UpdateBody); OAS `settings.yaml`
+- add: bulkExport (BulkExport) service + types — `find` (list export jobs) and `create` (start an Excel/Parquet export job for ~50 entity types, keyed by `type`); mirrors `bulkImport` (the backend rejects get/update/patch/remove with 400); OAS `bulk-export.yaml`
 
 ### Changed
 

package/lib/index.d.ts

@@ -22,6 +22,7 @@ export declare const end_points: {
     readonly TAG: "tag";
     readonly WAREHOUSE: "warehouse";
     readonly ROUTE: "route";
+    readonly GEO_ZONE: "geo-zone";
     readonly PRODUCT_MODIFIERS_GROUP: "product-modifiers-group";
     readonly CHANNEL: "client-channel";
     readonly SPECIALITY: "speciality";
@@ -50,6 +51,7 @@ export declare const end_points: {
     readonly VOID_SETTLEMENT: "void-settlement";
     readonly CHECK: "checks";
     readonly DAY: "day";
+    readonly DAY_SHIFT: "day-shift";
     readonly RECEIVING_MATERIAL: "receiving-material";
     readonly ADJUST_ACCOUNT: "adjust-account";
     readonly TRANSFER: "transfer";
@@ -145,11 +147,12 @@ export declare const end_points: {
     readonly CALENDAR: "calendar";
     readonly LINE_TARGET: "line-target";
     readonly BULK_IMPORT: "bulk-import";
+    readonly BULK_EXPORT: "bulk-export";
     readonly DELIVERY_NOTE: "delivery-note";
     readonly RESERVATION: "reservation";
 };
 export type EndPoints = (typeof end_points)[keyof typeof end_points];
-export declare const availableService: readonly ["client", "product", "variant", "category", "sub_category", "brand", "product_group", "tax", "measureunit", "measureunitFamily", "media", "priceList", "priceListItem", "team", "returnReason", "rep", "tag", "warehouse", "route", "productModifiersGroup", "channel", "speciality", "clientContact", "paymentTerm", "bank", "bank_list", "customStatus", "customList", "customListItem", "inventoryAdjustmentReason", "workorder", "workorderRequest", "supplier", "quickConvertToPdf", "visit", "activityFeedback", "activityFeedbackV2", "feedbackOption", "invoice", "proforma", "payment", "refund", "settlement", "voidSettlement", "check", "day", "receivingMaterial", "adjustAccount", "transfer", "msl", "mslProduct", "mediaStorage", "storecheckTemplate", "activityStorecheck", "activityItemStatus", "itemStatusType", "adjustInventory", "inventory", "integrationApp", "joinActionsWebHook", "patchAction", "updateIntegrationMeta", "assetPartType", "assetPart", "assetPartUnit", "assetPartReceival", "assetPartTransfer", "returnAssetPartUnit", "storeAssetPartUnit", "ocrInvoiceJobTemplate", "ocrInvoiceJobGroup", "activityAiSalesOrder", "ocrInvoiceJob", "ocrInvoiceJobPage", "settings", "mailUnsubscribe", "approvalRequest", "safeInvoiceSerialCounter", "clientLocation", "assetType", "asset", "assetUnit", "workorderPortal", "approval", "workorderCategory", "contract", "contractInstallment", "repBalanceSummary", "workorderPortalLink", "customField", "salesAnalyticsReport", "clmPresentation", "clmSequence", "clmSlide", "clmFetch", "pdfMergeField", "visitReason", "targetRule", "plan", "calendar", "lineTarget", "bulkImport"];
+export declare const availableService: readonly ["client", "product", "variant", "category", "sub_category", "brand", "product_group", "tax", "measureunit", "measureunitFamily", "media", "priceList", "priceListItem", "team", "returnReason", "rep", "tag", "warehouse", "route", "geoZone", "productModifiersGroup", "channel", "speciality", "clientContact", "paymentTerm", "bank", "bank_list", "customStatus", "customList", "customListItem", "inventoryAdjustmentReason", "workorder", "workorderRequest", "supplier", "quickConvertToPdf", "visit", "activityFeedback", "activityFeedbackV2", "feedbackOption", "invoice", "proforma", "payment", "refund", "settlement", "voidSettlement", "check", "day", "dayShift", "receivingMaterial", "adjustAccount", "transfer", "msl", "mslProduct", "mediaStorage", "storecheckTemplate", "activityStorecheck", "activityItemStatus", "itemStatusType", "adjustInventory", "inventory", "integrationApp", "joinActionsWebHook", "patchAction", "updateIntegrationMeta", "assetPartType", "assetPart", "assetPartUnit", "assetPartReceival", "assetPartTransfer", "returnAssetPartUnit", "storeAssetPartUnit", "ocrInvoiceJobTemplate", "ocrInvoiceJobGroup", "activityAiSalesOrder", "ocrInvoiceJob", "ocrInvoiceJobPage", "settings", "mailUnsubscribe", "approvalRequest", "safeInvoiceSerialCounter", "clientLocation", "assetType", "asset", "assetUnit", "workorderPortal", "approval", "workorderCategory", "contract", "contractInstallment", "repBalanceSummary", "workorderPortalLink", "customField", "salesAnalyticsReport", "clmPresentation", "clmSequence", "clmSlide", "clmFetch", "pdfMergeField", "visitReason", "targetRule", "plan", "calendar", "lineTarget", "bulkImport", "bulkExport"];
 export type AvailableService = (typeof availableService)[number];
 export default class Repzo {
     private svAPIEndpoint;
@@ -184,6 +187,7 @@ export default class Repzo {
         readonly TAG: "tag";
         readonly WAREHOUSE: "warehouse";
         readonly ROUTE: "route";
+        readonly GEO_ZONE: "geo-zone";
         readonly PRODUCT_MODIFIERS_GROUP: "product-modifiers-group";
         readonly CHANNEL: "client-channel";
         readonly SPECIALITY: "speciality";
@@ -212,6 +216,7 @@ export default class Repzo {
         readonly VOID_SETTLEMENT: "void-settlement";
         readonly CHECK: "checks";
         readonly DAY: "day";
+        readonly DAY_SHIFT: "day-shift";
         readonly RECEIVING_MATERIAL: "receiving-material";
         readonly ADJUST_ACCOUNT: "adjust-account";
         readonly TRANSFER: "transfer";
@@ -307,6 +312,7 @@ export default class Repzo {
         readonly CALENDAR: "calendar";
         readonly LINE_TARGET: "line-target";
         readonly BULK_IMPORT: "bulk-import";
+        readonly BULK_EXPORT: "bulk-export";
         readonly DELIVERY_NOTE: "delivery-note";
         readonly RESERVATION: "reservation";
     };
@@ -316,7 +322,7 @@ export default class Repzo {
     private _update;
     private _patch;
     private _delete;
-    available_services: readonly ["client", "product", "variant", "category", "sub_category", "brand", "product_group", "tax", "measureunit", "measureunitFamily", "media", "priceList", "priceListItem", "team", "returnReason", "rep", "tag", "warehouse", "route", "productModifiersGroup", "channel", "speciality", "clientContact", "paymentTerm", "bank", "bank_list", "customStatus", "customList", "customListItem", "inventoryAdjustmentReason", "workorder", "workorderRequest", "supplier", "quickConvertToPdf", "visit", "activityFeedback", "activityFeedbackV2", "feedbackOption", "invoice", "proforma", "payment", "refund", "settlement", "voidSettlement", "check", "day", "receivingMaterial", "adjustAccount", "transfer", "msl", "mslProduct", "mediaStorage", "storecheckTemplate", "activityStorecheck", "activityItemStatus", "itemStatusType", "adjustInventory", "inventory", "integrationApp", "joinActionsWebHook", "patchAction", "updateIntegrationMeta", "assetPartType", "assetPart", "assetPartUnit", "assetPartReceival", "assetPartTransfer", "returnAssetPartUnit", "storeAssetPartUnit", "ocrInvoiceJobTemplate", "ocrInvoiceJobGroup", "activityAiSalesOrder", "ocrInvoiceJob", "ocrInvoiceJobPage", "settings", "mailUnsubscribe", "approvalRequest", "safeInvoiceSerialCounter", "clientLocation", "assetType", "asset", "assetUnit", "workorderPortal", "approval", "workorderCategory", "contract", "contractInstallment", "repBalanceSummary", "workorderPortalLink", "customField", "salesAnalyticsReport", "clmPresentation", "clmSequence", "clmSlide", "clmFetch", "pdfMergeField", "visitReason", "targetRule", "plan", "calendar", "lineTarget", "bulkImport"];
+    available_services: readonly ["client", "product", "variant", "category", "sub_category", "brand", "product_group", "tax", "measureunit", "measureunitFamily", "media", "priceList", "priceListItem", "team", "returnReason", "rep", "tag", "warehouse", "route", "geoZone", "productModifiersGroup", "channel", "speciality", "clientContact", "paymentTerm", "bank", "bank_list", "customStatus", "customList", "customListItem", "inventoryAdjustmentReason", "workorder", "workorderRequest", "supplier", "quickConvertToPdf", "visit", "activityFeedback", "activityFeedbackV2", "feedbackOption", "invoice", "proforma", "payment", "refund", "settlement", "voidSettlement", "check", "day", "dayShift", "receivingMaterial", "adjustAccount", "transfer", "msl", "mslProduct", "mediaStorage", "storecheckTemplate", "activityStorecheck", "activityItemStatus", "itemStatusType", "adjustInventory", "inventory", "integrationApp", "joinActionsWebHook", "patchAction", "updateIntegrationMeta", "assetPartType", "assetPart", "assetPartUnit", "assetPartReceival", "assetPartTransfer", "returnAssetPartUnit", "storeAssetPartUnit", "ocrInvoiceJobTemplate", "ocrInvoiceJobGroup", "activityAiSalesOrder", "ocrInvoiceJob", "ocrInvoiceJobPage", "settings", "mailUnsubscribe", "approvalRequest", "safeInvoiceSerialCounter", "clientLocation", "assetType", "asset", "assetUnit", "workorderPortal", "approval", "workorderCategory", "contract", "contractInstallment", "repBalanceSummary", "workorderPortalLink", "customField", "salesAnalyticsReport", "clmPresentation", "clmSequence", "clmSlide", "clmFetch", "pdfMergeField", "visitReason", "targetRule", "plan", "calendar", "lineTarget", "bulkImport", "bulkExport"];
     generateUUID: ({ prefix, suffix, length, }: {
         prefix?: string;
         suffix?: string;
@@ -481,6 +487,14 @@ export default class Repzo {
         update: (id: Service.Route.Update.ID, body: Service.Route.Update.Body) => Promise<Service.Route.Update.Result>;
         remove: (id: Service.Route.Remove.ID) => Promise<Service.Route.Remove.Result>;
     };
+    geoZone: {
+        _path: "geo-zone";
+        find: (params?: Service.GeoZone.Find.Params) => Promise<Service.GeoZone.Find.Result>;
+        get: (id: Service.GeoZone.Get.ID, params?: Service.GeoZone.Get.Params) => Promise<Service.GeoZone.Get.Result>;
+        create: (body: Service.GeoZone.Create.Body) => Promise<Service.GeoZone.Create.Result>;
+        update: (id: Service.GeoZone.Update.ID, body: Service.GeoZone.Update.Body) => Promise<Service.GeoZone.Update.Result>;
+        remove: (id: Service.GeoZone.Remove.ID) => Promise<Service.GeoZone.Remove.Result>;
+    };
     productModifiersGroup: {
         _path: "product-modifiers-group";
         find: (params?: Service.ProductModifiersGroup.Find.Params) => Promise<Service.ProductModifiersGroup.Find.Result>;
@@ -675,6 +689,14 @@ export default class Repzo {
         get: (id: Service.Day.Get.ID, params?: Service.Day.Get.Params) => Promise<Service.Day.Get.Result>;
         create: (body: Service.Day.Create.Body) => Promise<Service.Day.Create.Result>;
     };
+    dayShift: {
+        _path: "day-shift";
+        find: (params?: Service.DayShift.Find.Params) => Promise<Service.DayShift.Find.Result>;
+        get: (id: Service.DayShift.Get.ID, params?: Service.DayShift.Get.Params) => Promise<Service.DayShift.Get.Result>;
+        create: (body: Service.DayShift.Create.Body) => Promise<Service.DayShift.Create.Result>;
+        update: (id: Service.DayShift.Update.ID, body: Service.DayShift.Update.Body) => Promise<Service.DayShift.Update.Result>;
+        remove: (id: Service.DayShift.Remove.ID) => Promise<Service.DayShift.Remove.Result>;
+    };
     receivingMaterial: {
         _path: "receiving-material";
         find: (params?: Service.ReceivingMaterial.Find.Params) => Promise<Service.ReceivingMaterial.Find.Result>;
@@ -1420,6 +1442,11 @@ export default class Repzo {
         create: (params: Service.BulkImport.Create.Params, body: Service.BulkImport.Create.Body) => Promise<Service.BulkImport.Create.Result>;
         update: (id: Service.BulkImport.Update.ID) => Promise<Service.BulkImport.Update.Result>;
     };
+    bulkExport: {
+        _path: "bulk-export";
+        find: (params?: Service.BulkExport.Find.Params) => Promise<Service.BulkExport.Find.Result>;
+        create: (params: Service.BulkExport.Create.Params, body: Service.BulkExport.Create.Body) => Promise<Service.BulkExport.Create.Result>;
+    };
     deliveryNote: {
         _path: "delivery-note";
         find: (params?: Service.DeliveryNote.Find.Params) => Promise<Service.DeliveryNote.Find.Result>;

package/lib/index.js

@@ -24,6 +24,7 @@ export const end_points = {
     TAG: "tag",
     WAREHOUSE: "warehouse",
     ROUTE: "route",
+    GEO_ZONE: "geo-zone",
     PRODUCT_MODIFIERS_GROUP: "product-modifiers-group",
     CHANNEL: "client-channel",
     SPECIALITY: "speciality",
@@ -52,6 +53,7 @@ export const end_points = {
     VOID_SETTLEMENT: "void-settlement",
     CHECK: "checks",
     DAY: "day",
+    DAY_SHIFT: "day-shift",
     RECEIVING_MATERIAL: "receiving-material",
     ADJUST_ACCOUNT: "adjust-account",
     TRANSFER: "transfer",
@@ -147,6 +149,7 @@ export const end_points = {
     CALENDAR: "calendar",
     LINE_TARGET: "line-target",
     BULK_IMPORT: "bulk-import",
+    BULK_EXPORT: "bulk-export",
     DELIVERY_NOTE: "delivery-note",
     RESERVATION: "reservation",
 };
@@ -170,6 +173,7 @@ export const availableService = [
     "tag",
     "warehouse",
     "route",
+    "geoZone",
     "productModifiersGroup",
     "channel",
     "speciality",
@@ -197,6 +201,7 @@ export const availableService = [
     "voidSettlement",
     "check",
     "day",
+    "dayShift",
     "receivingMaterial",
     "adjustAccount",
     "transfer",
@@ -253,6 +258,7 @@ export const availableService = [
     "calendar",
     "lineTarget",
     "bulkImport",
+    "bulkExport",
 ];
 class Repzo {
     constructor(apiKey, options) {
@@ -712,6 +718,28 @@ class Repzo {
                 return res;
             },
         };
+        this.geoZone = {
+            _path: Repzo._end_points.GEO_ZONE,
+            find: async (params) => {
+                let res = await this._fetch(this.svAPIEndpoint, this.geoZone._path, params);
+                return res;
+            },
+            get: async (id, params) => {
+                return await this._fetch(this.svAPIEndpoint, this.geoZone._path + `/${id}`, params);
+            },
+            create: async (body) => {
+                let res = await this._create(this.svAPIEndpoint, this.geoZone._path, body);
+                return res;
+            },
+            update: async (id, body) => {
+                let res = await this._update(this.svAPIEndpoint, this.geoZone._path + `/${id}`, body);
+                return res;
+            },
+            remove: async (id) => {
+                let res = await this._delete(this.svAPIEndpoint, this.geoZone._path + `/${id}`);
+                return res;
+            },
+        };
         this.productModifiersGroup = {
             _path: Repzo._end_points.PRODUCT_MODIFIERS_GROUP,
             find: async (params) => {
@@ -1219,6 +1247,28 @@ class Repzo {
                 return res;
             },
         };
+        this.dayShift = {
+            _path: Repzo._end_points.DAY_SHIFT,
+            find: async (params) => {
+                let res = await this._fetch(this.svAPIEndpoint, this.dayShift._path, params);
+                return res;
+            },
+            get: async (id, params) => {
+                return await this._fetch(this.svAPIEndpoint, this.dayShift._path + `/${id}`, params);
+            },
+            create: async (body) => {
+                let res = await this._create(this.svAPIEndpoint, this.dayShift._path, body);
+                return res;
+            },
+            update: async (id, body) => {
+                let res = await this._update(this.svAPIEndpoint, this.dayShift._path + `/${id}`, body);
+                return res;
+            },
+            remove: async (id) => {
+                let res = await this._delete(this.svAPIEndpoint, this.dayShift._path + `/${id}`);
+                return res;
+            },
+        };
         this.receivingMaterial = {
             _path: Repzo._end_points.RECEIVING_MATERIAL,
             find: async (params) => {
@@ -2955,6 +3005,17 @@ class Repzo {
                 return res;
             },
         };
+        this.bulkExport = {
+            _path: Repzo._end_points.BULK_EXPORT,
+            find: async (params) => {
+                let res = await this._fetch(this.svAPIEndpoint, this.bulkExport._path, params);
+                return res;
+            },
+            create: async (params, body) => {
+                let res = await this._create(this.svAPIEndpoint, this.bulkExport._path, body, params);
+                return res;
+            },
+        };
         this.deliveryNote = {
             _path: Repzo._end_points.DELIVERY_NOTE,
             find: async (params) => {