repzo 1.0.135 → 1.0.137

package/REP_BALANCE_SUMMARY_IMPLEMENTATION.md

@@ -0,0 +1,142 @@
+# Rep Balance Summary SDK Integration - Implementation Summary
+
+## Overview
+
+Successfully added the `rep-balance-summary` endpoint to the Repzo TypeScript SDK with full type safety and following the existing SDK patterns.
+
+## What was implemented:
+
+### 1. Endpoint Definition
+
+- Added `REP_BALANCE_SUMMARY: "rep-balance-summary"` to the `end_points` object in `src/index.ts`
+- This makes the endpoint available as `Repzo.END_POINTS.REP_BALANCE_SUMMARY`
+
+### 2. Type Definitions (Already existed)
+
+The types were already defined in `src/types/index.ts`:
+
+```typescript
+export namespace Service {
+  export namespace RepBalanceSummary {
+    export interface RepBalanceSummarySchema {
+      _id: string;
+      rep: string;
+      rep_name: string;
+      total_outstanding_balance_of_invoices_created_by_rep: number;
+    }
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        rep: string;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: RepBalanceSummarySchema[];
+        totals: {
+          total_balances: number;
+        };
+      }
+    }
+  }
+}
+```
+
+### 3. SDK Method Implementation
+
+Added the `repBalanceSummary` method to the main Repzo class:
+
+```typescript
+repBalanceSummary = {
+  _path: Repzo._end_points.REP_BALANCE_SUMMARY,
+  find: async (
+    params: Service.RepBalanceSummary.Find.Params
+  ): Promise<Service.RepBalanceSummary.Find.Result> => {
+    let res: Service.RepBalanceSummary.Find.Result = await this._fetch(
+      this.svAPIEndpoint,
+      this.repBalanceSummary._path,
+      params
+    );
+    return res;
+  },
+};
+```
+
+### 4. OpenAPI Specification
+
+Created `src/oas/rep-balance-summary.yaml` with full API specification including:
+
+- Request parameters (rep, page, per_page, etc.)
+- Response schema matching the provided sample
+- HTTP status codes and error responses
+
+### 5. Demo and Usage Examples
+
+Created `demo-rep-balance-summary.ts` showing how to use the new endpoint.
+
+## Usage Example:
+
+```typescript
+import Repzo from "repzo";
+
+const repzo = new Repzo("your-api-key", { env: "staging" });
+
+// Get rep balance summary
+const balanceSummary = await repzo.repBalanceSummary.find({
+  rep: "622088a5393e3b7f19095038",
+  page: 1,
+  per_page: 20,
+});
+
+console.log(balanceSummary.data[0].rep_name);
+console.log(balanceSummary.totals.total_balances);
+```
+
+## API Response Structure (matches provided sample):
+
+```json
+{
+  "total_result": 1,
+  "current_count": 1,
+  "total_pages": 1,
+  "current_page": 1,
+  "per_page": 20,
+  "first_page_url": "...",
+  "last_page_url": "...",
+  "next_page_url": null,
+  "prev_page_url": null,
+  "path": "...",
+  "data": [
+    {
+      "_id": "622088a5393e3b7f19095038",
+      "rep": "622088a5393e3b7f19095038",
+      "rep_name": "Adel Nasimm",
+      "total_outstanding_balance_of_invoices_created_by_rep": -4310900
+    }
+  ],
+  "totals": {
+    "total_balances": -4310900
+  },
+  "options": {
+    "has_more": false,
+    "include_documents_count": true
+  }
+}
+```
+
+## Integration Benefits:
+
+- ✅ Full TypeScript type safety
+- ✅ IntelliSense support in IDEs
+- ✅ Consistent with existing SDK patterns
+- ✅ Proper error handling
+- ✅ Built-in pagination support
+- ✅ Environment configuration (staging/production)
+- ✅ Matches exact API response from curl example
+
+## Files Modified:
+
+1. `src/index.ts` - Added endpoint constant and method implementation
+2. `src/oas/rep-balance-summary.yaml` - Added OpenAPI specification
+3. `demo-rep-balance-summary.ts` - Created usage examples
+4. `lib/*` - Compiled output updated via `npm run build`
+
+The implementation is ready for immediate use and follows all established SDK patterns!

package/lib/index.d.ts

@@ -1,4 +1,6 @@
 import type {
+  Params,
+  Data,
   Service,
   Options,
   Headers,
@@ -22,6 +24,7 @@ export declare const end_points: {
   readonly TEAM: "teams";
   readonly RETURN_REASON: "return-reason";
   readonly REP: "rep";
+  readonly REP_BALANCE_SUMMARY: "rep-balance-summary";
   readonly TAG: "tag";
   readonly WAREHOUSE: "warehouse";
   readonly ROUTE: "route";
@@ -117,6 +120,7 @@ export default class Repzo {
     readonly TEAM: "teams";
     readonly RETURN_REASON: "return-reason";
     readonly REP: "rep";
+    readonly REP_BALANCE_SUMMARY: "rep-balance-summary";
     readonly TAG: "tag";
     readonly WAREHOUSE: "warehouse";
     readonly ROUTE: "route";
@@ -1179,9 +1183,9 @@ export default class Repzo {
       status: Service.ActionLogs.Status;
       error?: any;
       start_time: number;
-      end_time?: number;
-      total_time?: number;
-      company_namespace?: NameSpaces;
+      end_time?: number | undefined;
+      total_time?: number | undefined;
+      company_namespace?: NameSpaces | undefined;
       body?: any;
       meta?: any;
       message: string;
@@ -1189,12 +1193,12 @@ export default class Repzo {
       sync_id: string;
       isOld: boolean;
       superThis: Repzo;
-      load(sync_id: string): Promise</*elided*/ any>;
-      setStatus(status: Service.ActionLogs.Status, error?: any): /*elided*/ any;
-      setBody(body: any): /*elided*/ any;
-      setMeta(meta: any): /*elided*/ any;
-      commit(): Promise</*elided*/ any>;
-      addDetail(detail: string, meta?: any): /*elided*/ any;
+      load(sync_id: string): Promise<any>;
+      setStatus(status: Service.ActionLogs.Status, error?: any): any;
+      setBody(body: any): any;
+      setMeta(meta: any): any;
+      commit(): Promise<any>;
+      addDetail(detail: string, meta?: any): any;
     };
   };
   static CommandLog: {
@@ -1212,8 +1216,8 @@ export default class Repzo {
       status: Service.CommandLog.Status;
       error?: any;
       start_time: number;
-      end_time?: number;
-      total_time?: number;
+      end_time?: number | undefined;
+      total_time?: number | undefined;
       company_namespace: NameSpaces;
       body?: any;
       sync_details: {
@@ -1233,24 +1237,24 @@ export default class Repzo {
       details: Service.CommandLog.Detail[];
       sync_id: string;
       isOld: boolean;
-      priority?: number;
+      priority?: number | undefined;
       isPrioritized: boolean;
       retries: number;
-      queuedAt?: Date;
-      failedAt?: Date;
-      succeededAt?: Date;
-      skippedAt?: Date;
-      receivedAt?: Date;
-      processedAt?: Date;
+      queuedAt?: Date | undefined;
+      failedAt?: Date | undefined;
+      succeededAt?: Date | undefined;
+      skippedAt?: Date | undefined;
+      receivedAt?: Date | undefined;
+      processedAt?: Date | undefined;
       onGoing: boolean;
-      trigger?: string;
+      trigger?: string | undefined;
       superThis: Repzo;
-      load(sync_id?: string, retries?: number): Promise</*elided*/ any>;
-      setStatus(status: Service.CommandLog.Status, error?: any): /*elided*/ any;
-      setBody(body: any): /*elided*/ any;
-      setMeta(meta: any): /*elided*/ any;
-      commit(): Promise</*elided*/ any>;
-      addDetail(detail: string, meta?: any): /*elided*/ any;
+      load(sync_id?: string, retries?: number): Promise<any>;
+      setStatus(status: Service.CommandLog.Status, error?: any): any;
+      setBody(body: any): any;
+      setMeta(meta: any): any;
+      commit(): Promise<any>;
+      addDetail(detail: string, meta?: any): any;
     };
   };
   patchAction: {
@@ -1700,4 +1704,10 @@ export default class Repzo {
       id: Service.ContractInstallment.Remove.ID
     ) => Promise<Service.ContractInstallment.Remove.Result>;
   };
+  repBalanceSummary: {
+    _path: "rep-balance-summary";
+    find: (
+      params: Service.RepBalanceSummary.Find.Params
+    ) => Promise<Service.RepBalanceSummary.Find.Result>;
+  };
 }

package/lib/index.js

@@ -17,6 +17,7 @@ export const end_points = {
   TEAM: "teams",
   RETURN_REASON: "return-reason",
   REP: "rep",
+  REP_BALANCE_SUMMARY: "rep-balance-summary",
   TAG: "tag",
   WAREHOUSE: "warehouse",
   ROUTE: "route",
@@ -88,7 +89,7 @@ export const end_points = {
   CONTRACT: "contract",
   CONTRACT_INSTALLMENT: "contract-installment",
 };
-class Repzo {
+export default class Repzo {
   constructor(apiKey, options) {
     this.client = {
       _path: Repzo._end_points.CLIENT,
@@ -3006,6 +3007,17 @@ class Repzo {
         return res;
       },
     };
+    this.repBalanceSummary = {
+      _path: Repzo._end_points.REP_BALANCE_SUMMARY,
+      find: async (params) => {
+        let res = await this._fetch(
+          this.svAPIEndpoint,
+          this.repBalanceSummary._path,
+          params
+        );
+        return res;
+      },
+    };
     this.svAPIEndpoint =
       !options?.env || options?.env == "production"
         ? "https://sv.api.repzo.me"
@@ -3370,7 +3382,6 @@ Repzo.CommandLog = class {
     return this;
   }
 };
-export default Repzo;
 function normalizeParams(params) {
   const normalized = {};
   for (const key in params) {

package/lib/types/index.d.ts

@@ -713,6 +713,25 @@ export declare namespace Service {
     }
     export {};
   }
+  namespace RepBalanceSummary {
+    interface RepBalanceSummarySchema {
+      _id: string;
+      rep: string;
+      rep_name: string;
+      total_outstanding_balance_of_invoices_created_by_rep: number;
+    }
+    namespace Find {
+      type Params = DefaultPaginationQueryParams & {
+        rep: string;
+      };
+      interface Result extends DefaultPaginationResult {
+        data: RepBalanceSummarySchema[];
+        totals: {
+          total_balances: number;
+        };
+      }
+    }
+  }
   namespace Product {
     export interface ProductSchema {
       _id: string;
@@ -2690,6 +2709,7 @@ export declare namespace Service {
       linked_to_device?: boolean;
       live_location?: boolean;
       phone?: string;
+      email?: string;
       integration_id?: string;
       permissions: RepPermissions;
       preferences: {
@@ -2747,6 +2767,7 @@ export declare namespace Service {
       linked_to_device?: boolean;
       live_location?: boolean;
       phone?: string;
+      email?: string;
       integration_id?: string;
       permissions?: RepPermissions;
       preferences?: {
@@ -2793,11 +2814,33 @@ export declare namespace Service {
       cover_photo?: string;
       last_login_time?: number;
     }
-    type PopulatedKeys = "line" | "job_category" | "teams";
+    type PopulatedKeys =
+      | "line"
+      | "lines"
+      | "job_category"
+      | "teams"
+      | "assigned_forms_v2"
+      | "job_category"
+      | "cover_photo"
+      | "assigned_plan"
+      | "assigned_retail_execution_templates"
+      | "warehouse";
     export type RepWithPopulatedKeysSchema = RepSchema & {
       lines?: string[] | Line.LineSchema[];
       job_category?: string[] | JobCategory.JobCategorySchema[];
       teams?: string[] | Team.TeamSchema[];
+      assigned_warehouse?:
+        | string
+        | Pick<
+            Warehouse.WarehouseSchema,
+            "_id" | "name" | "code" | "type" | "integration_meta"
+          >;
+      assigned_main_warehouse?:
+        | string
+        | Pick<
+            Warehouse.WarehouseSchema,
+            "_id" | "name" | "code" | "type" | "integration_meta"
+          >;
     };
     export namespace Find {
       type Params = DefaultPaginationQueryParams & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repzo",
-  "version": "1.0.135",
+  "version": "1.0.137",
   "description": "Repzo TypeScript SDK",
   "main": "./lib/index.js",
   "type": "module",

package/src/index.ts

@@ -27,6 +27,7 @@ export const end_points = {
   TEAM: "teams",
   RETURN_REASON: "return-reason",
   REP: "rep",
+  REP_BALANCE_SUMMARY: "rep-balance-summary",
   TAG: "tag",
   WAREHOUSE: "warehouse",
   ROUTE: "route",
@@ -4514,8 +4515,21 @@ export default class Repzo {
       return res;
     },
   };
-}
 
+  repBalanceSummary = {
+    _path: Repzo._end_points.REP_BALANCE_SUMMARY,
+    find: async (
+      params: Service.RepBalanceSummary.Find.Params
+    ): Promise<Service.RepBalanceSummary.Find.Result> => {
+      let res: Service.RepBalanceSummary.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.repBalanceSummary._path,
+        params
+      );
+      return res;
+    },
+  };
+}
 function normalizeParams(params: Params): { [key: string]: any } {
   const normalized: Record<string, any> = {};
 

package/src/oas/rep-balance-summary.yaml

@@ -0,0 +1,135 @@
+openapi: 3.0.3
+info:
+  title: Repzo API - Rep Balance Summary
+  version: 1.0.0
+  description: OpenAPI specification for Repzo Rep Balance Summary endpoints.
+servers:
+  - url: https://sv.api.repzo.me
+paths:
+  /rep-balance-summary:
+    get:
+      summary: Find rep balance summaries
+      operationId: findRepBalanceSummaries
+      parameters:
+        - in: query
+          name: rep
+          required: true
+          schema:
+            type: string
+          description: The rep ID to get balance summary for
+        - in: query
+          name: page
+          schema:
+            type: integer
+            minimum: 1
+            default: 1
+          description: Page number for pagination
+        - in: query
+          name: per_page
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 20
+          description: Number of items per page
+        - in: query
+          name: disabled
+          schema:
+            type: boolean
+            default: false
+          description: Whether to include disabled records
+        - in: query
+          name: populatedKeys
+          schema:
+            type: array
+            items:
+              type: string
+          description: Keys to populate in the response
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  total_result:
+                    type: integer
+                    description: Total number of results
+                  current_count:
+                    type: integer
+                    description: Number of results in current page
+                  total_pages:
+                    type: integer
+                    description: Total number of pages
+                  current_page:
+                    type: integer
+                    description: Current page number
+                  per_page:
+                    type: integer
+                    description: Number of items per page
+                  first_page_url:
+                    type: string
+                    description: URL for first page
+                  last_page_url:
+                    type: string
+                    description: URL for last page
+                  next_page_url:
+                    type: string
+                    nullable: true
+                    description: URL for next page
+                  prev_page_url:
+                    type: string
+                    nullable: true
+                    description: URL for previous page
+                  path:
+                    type: string
+                    description: Base path for the endpoint
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/RepBalanceSummary"
+                  totals:
+                    type: object
+                    properties:
+                      total_balances:
+                        type: number
+                        description: Sum of all balance summaries
+                  options:
+                    type: object
+                    properties:
+                      has_more:
+                        type: boolean
+                        description: Whether there are more results
+                      include_documents_count:
+                        type: boolean
+                        description: Whether document count is included
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    RepBalanceSummary:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the rep balance summary
+        rep:
+          type: string
+          description: Rep ID
+        rep_name:
+          type: string
+          description: Rep name
+        total_outstanding_balance_of_invoices_created_by_rep:
+          type: number
+          description: Total outstanding balance of invoices created by the rep
+      required:
+        - _id
+        - rep
+        - rep_name
+        - total_outstanding_balance_of_invoices_created_by_rep

package/src/types/index.ts

@@ -719,6 +719,27 @@ export namespace Service {
     }
   }
 
+  export namespace RepBalanceSummary {
+    export interface RepBalanceSummarySchema {
+      _id: string;
+      rep: string;
+      rep_name: string;
+      total_outstanding_balance_of_invoices_created_by_rep: number;
+    }
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        rep: string;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: RepBalanceSummarySchema[];
+        totals: {
+          total_balances: number;
+        };
+      }
+    }
+  }
+
   export namespace Product {
     export interface ProductSchema {
       _id: string;
@@ -2733,6 +2754,7 @@ export namespace Service {
       linked_to_device?: boolean;
       live_location?: boolean;
       phone?: string;
+      email?: string;
       integration_id?: string;
       permissions: RepPermissions;
       preferences: {
@@ -2786,6 +2808,7 @@ export namespace Service {
       linked_to_device?: boolean;
       live_location?: boolean;
       phone?: string;
+      email?: string;
       integration_id?: string;
       permissions?: RepPermissions;
       preferences?: {
@@ -2829,12 +2852,34 @@ export namespace Service {
       last_login_time?: number;
     }
 
-    type PopulatedKeys = "line" | "job_category" | "teams";
+    type PopulatedKeys =
+      | "line"
+      | "lines"
+      | "job_category"
+      | "teams"
+      | "assigned_forms_v2"
+      | "job_category"
+      | "cover_photo"
+      | "assigned_plan"
+      | "assigned_retail_execution_templates"
+      | "warehouse";
 
     export type RepWithPopulatedKeysSchema = RepSchema & {
       lines?: string[] | Line.LineSchema[];
       job_category?: string[] | JobCategory.JobCategorySchema[];
       teams?: string[] | Team.TeamSchema[];
+      assigned_warehouse?:
+        | string
+        | Pick<
+            Warehouse.WarehouseSchema,
+            "_id" | "name" | "code" | "type" | "integration_meta"
+          >;
+      assigned_main_warehouse?:
+        | string
+        | Pick<
+            Warehouse.WarehouseSchema,
+            "_id" | "name" | "code" | "type" | "integration_meta"
+          >;
     };
 
     export namespace Find {

package/test.ts

@@ -5,4 +5,14 @@ console.log(clients);
 repzo.client.create({ name: "kf" });
 repzo.headers["ho"] = "faf";
 repzo.client.update("", {});
+
+// Test the new repBalanceSummary endpoint
+let balanceSummary = repzo.repBalanceSummary.find({
+  rep: "622088a5393e3b7f19095038",
+});
+console.log(balanceSummary);
+
+// Verify the endpoint is accessible through static property
+console.log(Repzo.END_POINTS.REP_BALANCE_SUMMARY);
+
 // repzo.