repzo 1.0.289 → 1.0.290

package/src/oas/rep.yaml

@@ -106,6 +106,13 @@ paths:
                     items:
                       type: string
                   - type: string
+              assigned_geo_zones:
+                description: Filter by assigned geo-zone `_id`s.
+                oneOf:
+                  - type: array
+                    items:
+                      type: string
+                  - type: string
               lines:
                 oneOf:
                   - type: array
@@ -164,6 +171,7 @@ paths:
                       "cover_photo",
                       "assigned_plan",
                       "assigned_retail_execution_templates",
+                      "assigned_geo_zones",
                       "warehouse",
                     ]
               withProductLines:
@@ -285,6 +293,10 @@ paths:
                 type: boolean
               "permissions.rep_can_create_skip_geofence_at_visit_end_approval_request":
                 type: boolean
+              "permissions.rep_can_start_visit_out_of_geofence":
+                type: boolean
+              "permissions.rep_can_create_approval_request_to_start_visit_out_of_geofence":
+                type: boolean
               "permissions.rep_can_create_credit_invoice_for_cash_client":
                 type: boolean
               "permissions.rep_can_view_client_credit_limit":
@@ -672,6 +684,12 @@ components:
             rep_can_create_skip_geofence_at_visit_end_approval_request:
               type: boolean
               description: Can rep create skip geofence at visit end approval request
+            rep_can_start_visit_out_of_geofence:
+              type: boolean
+              description: Can rep start a visit while outside their geofence / geo zone
+            rep_can_create_approval_request_to_start_visit_out_of_geofence:
+              type: boolean
+              description: Can rep create an approval request to start a visit while out of geofence
             rep_can_create_credit_invoice_for_cash_client:
               type: boolean
               description: Can rep create credit invoice for cash client
@@ -785,6 +803,11 @@ components:
           items:
             type: string
           description: Assigned targets
+        assigned_geo_zones:
+          type: array
+          items:
+            type: string
+          description: "`_id`s of the geo zones assigned to this rep (ref `geo-zone`) — currently at most one."
         lines:
           type: array
           items:
@@ -1122,6 +1145,12 @@ components:
             rep_can_create_skip_geofence_at_visit_end_approval_request:
               type: boolean
               description: Can rep create skip geofence at visit end approval request
+            rep_can_start_visit_out_of_geofence:
+              type: boolean
+              description: Can rep start a visit while outside their geofence / geo zone
+            rep_can_create_approval_request_to_start_visit_out_of_geofence:
+              type: boolean
+              description: Can rep create an approval request to start a visit while out of geofence
             rep_can_create_credit_invoice_for_cash_client:
               type: boolean
               description: Can rep create credit invoice for cash client
@@ -1235,6 +1264,11 @@ components:
           items:
             type: string
           description: Assigned targets
+        assigned_geo_zones:
+          type: array
+          items:
+            type: string
+          description: "`_id`s of the geo zones assigned to this rep (ref `geo-zone`) — currently at most one."
         lines:
           type: array
           items:
@@ -1562,6 +1596,12 @@ components:
             rep_can_create_skip_geofence_at_visit_end_approval_request:
               type: boolean
               description: Can rep create skip geofence at visit end approval request
+            rep_can_start_visit_out_of_geofence:
+              type: boolean
+              description: Can rep start a visit while outside their geofence / geo zone
+            rep_can_create_approval_request_to_start_visit_out_of_geofence:
+              type: boolean
+              description: Can rep create an approval request to start a visit while out of geofence
             rep_can_create_credit_invoice_for_cash_client:
               type: boolean
               description: Can rep create credit invoice for cash client
@@ -1675,6 +1715,11 @@ components:
           items:
             type: string
           description: Assigned targets
+        assigned_geo_zones:
+          type: array
+          items:
+            type: string
+          description: "`_id`s of the geo zones assigned to this rep (ref `geo-zone`) — currently at most one."
         lines:
           type: array
           items:

package/src/oas/settings.yaml

@@ -93,6 +93,36 @@ components:
           type: string
         description:
           type: string
+        start_day_outside_active_zone_action:
+          type: string
+          enum: [monitor, warning, block]
+          default: warning
+          description: "Action when a rep starts their day outside their active geo zone: `monitor` (allow and record silently), `warning` (allow but warn), or `block` (prevent)."
+        start_visit_outside_active_zone_action:
+          type: string
+          enum: [monitor, warning, block]
+          default: warning
+          description: "Action when a rep starts a visit outside their active geo zone (same `monitor`/`warning`/`block` semantics as `start_day_outside_active_zone_action`)."
+        work_outside_active_zone_action:
+          type: string
+          enum: [monitor, warning, block]
+          default: warning
+          description: "Action when a rep performs work outside their active geo zone (same `monitor`/`warning`/`block` semantics as `start_day_outside_active_zone_action`)."
+        no_active_zone_action:
+          type: string
+          enum: [allow, block]
+          default: allow
+          description: "Behavior when a rep has no active geo zone: `allow` (work unrestricted) or `block` (prevent working)."
+        use_accuracy_radius_near_zone_boundary:
+          type: boolean
+          default: true
+          description: "When true, the device GPS accuracy radius is considered near a zone boundary — a position whose accuracy circle overlaps the zone counts as inside it."
+        zone_boundary_grace_minutes:
+          type: integer
+          minimum: 0
+          maximum: 60
+          default: 5
+          description: "Grace period in minutes around zone-boundary transitions before the configured outside-zone action is enforced (integer 0-60)."
     SettingsUpdateResult:
       type: object
       properties:
@@ -115,6 +145,36 @@ components:
           type: string
         description:
           type: string
+        start_day_outside_active_zone_action:
+          type: string
+          enum: [monitor, warning, block]
+          default: warning
+          description: "Action when a rep starts their day outside their active geo zone: `monitor` (allow and record silently), `warning` (allow but warn), or `block` (prevent)."
+        start_visit_outside_active_zone_action:
+          type: string
+          enum: [monitor, warning, block]
+          default: warning
+          description: "Action when a rep starts a visit outside their active geo zone (same `monitor`/`warning`/`block` semantics as `start_day_outside_active_zone_action`)."
+        work_outside_active_zone_action:
+          type: string
+          enum: [monitor, warning, block]
+          default: warning
+          description: "Action when a rep performs work outside their active geo zone (same `monitor`/`warning`/`block` semantics as `start_day_outside_active_zone_action`)."
+        no_active_zone_action:
+          type: string
+          enum: [allow, block]
+          default: allow
+          description: "Behavior when a rep has no active geo zone: `allow` (work unrestricted) or `block` (prevent working)."
+        use_accuracy_radius_near_zone_boundary:
+          type: boolean
+          default: true
+          description: "When true, the device GPS accuracy radius is considered near a zone boundary — a position whose accuracy circle overlaps the zone counts as inside it."
+        zone_boundary_grace_minutes:
+          type: integer
+          minimum: 0
+          maximum: 60
+          default: 5
+          description: "Grace period in minutes around zone-boundary transitions before the configured outside-zone action is enforced (integer 0-60)."
         createdAt:
           type: string
           format: date-time

package/src/types/index.ts

@@ -2882,6 +2882,88 @@ export namespace Service {
     }
   }
 
+  export namespace GeoZone {
+    export interface Polygon {
+      type: "Polygon";
+      coordinates: [number, number][][];
+    }
+
+    export interface AssignedRep {
+      _id: StringId;
+      name: string;
+    }
+
+    export interface Data {
+      _id: StringId;
+      name: string;
+      description?: string;
+      polygon: Polygon;
+      disabled: boolean;
+      editor: AdminOrRepOrTenantOrClient;
+      assigned_reps?: AssignedRep[];
+      company_namespace: string[];
+      createdAt: string;
+      updatedAt: string;
+      __v: number;
+    }
+
+    export interface CreateBody {
+      name: string;
+      description?: string;
+      polygon: Polygon;
+      company_namespace?: string[];
+    }
+
+    export interface UpdateBody {
+      name?: string;
+      description?: string;
+      polygon?: Polygon;
+      disabled?: boolean;
+      editor?: AdminOrRepOrTenantOrClient;
+    }
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        _id?: StringId | StringId[];
+        name?: string | string[];
+        search?: string;
+        disabled?: boolean;
+        inject_assigned_reps?: boolean;
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+        from_createdAt?: number;
+        to_createdAt?: number;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+
+    export namespace Get {
+      export type ID = StringId;
+      export type Params = {
+        inject_assigned_reps?: boolean;
+      };
+      export type Result = Data;
+    }
+
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+
+    export namespace Update {
+      export type ID = StringId;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+
+    export namespace Remove {
+      export type ID = StringId;
+      export type Result = Data;
+    }
+  }
+
   export namespace Rep {
     interface RepPermissions {
       rep_can_print_payment_after_allowance_period?: boolean;
@@ -2974,6 +3056,8 @@ export namespace Service {
       rep_can_create_client_line_approval_request?: boolean;
       rep_can_enter_client_code_at_create_client?: boolean;
       rep_can_edit_client_location_at_create_client?: boolean;
+      rep_can_start_visit_out_of_geofence?: boolean;
+      rep_can_create_approval_request_to_start_visit_out_of_geofence?: boolean;
     }
     interface TargetResults {
       totalPoints: number;
@@ -3035,6 +3119,7 @@ export namespace Service {
       integration_meta?: { [key: string]: any };
       force_online_connectivity?: boolean;
       assigned_targets?: string[];
+      assigned_geo_zones?: (string | GeoZone.Data)[];
       lines?: string[];
       targetResults?: TargetResults;
       previously_assigned_clients?: string[];
@@ -3092,6 +3177,7 @@ export namespace Service {
       integration_meta?: { [key: string]: any };
       force_online_connectivity?: boolean;
       assigned_targets?: string[];
+      assigned_geo_zones?: string[] | null;
       lines?: string[];
       targetResults?: TargetResults;
       previously_assigned_clients?: string[];
@@ -3127,6 +3213,7 @@ export namespace Service {
       | "assigned_plan"
       | "assigned_retail_execution_templates"
       | "assigned_clm_presentations"
+      | "assigned_geo_zones"
       | "warehouse";
 
     export type RepWithPopulatedKeysSchema = RepSchema & {
@@ -3145,6 +3232,7 @@ export namespace Service {
             Warehouse.WarehouseSchema,
             "_id" | "name" | "code" | "type" | "integration_meta"
           >;
+      assigned_geo_zones?: (string | GeoZone.Data)[];
     };
 
     export namespace Find {
@@ -3167,6 +3255,7 @@ export namespace Service {
         assigned_plan?: string | string[];
         force_online_connectivity?: boolean;
         assigned_targets?: string | string[];
+        assigned_geo_zones?: string | string[];
         lines?: string | string[];
         job_option?: JobOption | JobOption[];
         "permissions.rep_can_add_client"?: boolean;
@@ -3255,6 +3344,8 @@ export namespace Service {
         "permissions.rep_can_create_client_line_approval_request"?: boolean;
         "permissions.rep_can_enter_client_code_at_create_client"?: boolean;
         "permissions.rep_can_edit_client_location_at_create_client"?: boolean;
+        "permissions.rep_can_start_visit_out_of_geofence"?: boolean;
+        "permissions.rep_can_create_approval_request_to_start_visit_out_of_geofence"?: boolean;
         "permissions.rep_can_view_stock_on_transfers"?: boolean;
         "permissions.rep_must_invoice_items_from_cross_inventory_and_msl"?: boolean;
         "settings.rep_must_end_day_after"?: `${number}:${number}`;
@@ -13563,6 +13654,12 @@ export namespace Service {
       enable_whatsapp_mfa: boolean;
       enable_authenticator_mfa: boolean;
       minimum_accepted_mfa: number;
+      start_day_outside_active_zone_action: "monitor" | "warning" | "block";
+      start_visit_outside_active_zone_action: "monitor" | "warning" | "block";
+      work_outside_active_zone_action: "monitor" | "warning" | "block";
+      no_active_zone_action: "allow" | "block";
+      use_accuracy_radius_near_zone_boundary: boolean;
+      zone_boundary_grace_minutes: number;
       createdAt: Date;
       updatedAt: Date;
     }
@@ -13725,6 +13822,12 @@ export namespace Service {
       enable_whatsapp_mfa: boolean;
       enable_authenticator_mfa: boolean;
       minimum_accepted_mfa: number;
+      start_day_outside_active_zone_action?: "monitor" | "warning" | "block";
+      start_visit_outside_active_zone_action?: "monitor" | "warning" | "block";
+      work_outside_active_zone_action?: "monitor" | "warning" | "block";
+      no_active_zone_action?: "allow" | "block";
+      use_accuracy_radius_near_zone_boundary?: boolean;
+      zone_boundary_grace_minutes?: number;
     }
 
     export namespace Update {
@@ -18084,6 +18187,7 @@ export namespace Service {
       | "update-rep"
       | "update-salesmsl"
       | "update-settings"
+      | "update-geo-zone"
       | "update-tags"
       | "update-taxes"
       | "update-transfer"
@@ -22454,6 +22558,112 @@ export namespace Service {
     }
   }
 
+  export namespace BulkExport {
+    export type BulkExportType =
+      | "clients"
+      | "products"
+      | "variants"
+      | "categories"
+      | "subCategories"
+      | "availabilityMsl"
+      | "availabilityMslWithProducts"
+      | "reps"
+      | "mslWithVariants"
+      | "jobCategories"
+      | "jobs"
+      | "tags"
+      | "routes"
+      | "routesWithClients"
+      | "plans"
+      | "planWithRules"
+      | "targetRulesWithClients"
+      | "rulesWithRoutes"
+      | "targetRulesWithReps"
+      | "adjustAccount"
+      | "rules"
+      | "warehouses"
+      | "productGroups"
+      | "priceListItems"
+      | "measureunit"
+      | "measureunitFamily"
+      | "lineTarget"
+      | "clientLineClassification"
+      | "retailExecutionPresets"
+      | "promotions"
+      | "customListItems"
+      | "assets"
+      | "assetUnits"
+      | "speciality"
+      | "clientLocation"
+      | "reminders"
+      | "admins"
+      | "companyGroup"
+      | "company"
+      | "variantBatch"
+      | "banksList"
+      | "clientUblInfo"
+      | "supplier"
+      | "contractInstallment"
+      | "targetRule"
+      | "contracts"
+      | "assetPartTypes"
+      | "assetParts"
+      | "clientUblInfo_JO"
+      | "clientUblInfo_SA"
+      | "nameSpaceFreshnessWindowCodes";
+
+    export interface Data {
+      _id: StringId;
+      creator: AdminOrRepOrTenantOrClient;
+      type: BulkExportType;
+      status: "processing" | "success" | "fail";
+      messages: any[];
+      _errors: any[];
+      start_time: number;
+      end_time?: number;
+      bucket_name?: string;
+      region?: string;
+      key?: string;
+      link?: string;
+      media?: StringId[];
+      teams: string[];
+      export_type: "excel" | "parquet";
+      row_count?: number;
+      company_namespace: string[];
+      createdAt: Date;
+      updatedAt: Date;
+    }
+
+    export interface CreateBody {
+      export_type?: "excel" | "parquet";
+      columns?: { [key: string]: any };
+      name?: string;
+      creator?: AdminOrRepOrTenantOrClient;
+      company_namespace?: string[];
+    }
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        _id?: StringId | StringId[];
+        type?: BulkExportType;
+        status?: Data["status"] | Data["status"][];
+        export?: boolean;
+        export_type?: "excel" | "parquet";
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+
+    export namespace Create {
+      export type Params = { type: BulkExportType; [key: string]: any };
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+  }
+
   export namespace DeliveryNote {
     interface User {
       _id: string;