repzo 1.0.183 → 1.0.185

package/lib/index.d.ts

@@ -93,6 +93,7 @@ export declare const end_points: {
     readonly RESET_COMPANY_NAMESPACE: "reset-company-namespace";
     readonly TEST_RESET_COMPANY_NAMESPACE: "test-reset-company-namespace";
     readonly TIMELINE_TIME_LIST: "timeline-time-list";
+    readonly SALES_ANALYTICS_REPORT: "sales-analytics-report";
     readonly WORKORDER_AGENDA: "workorder-agenda";
     readonly MODULE_CUSTOM_VALIDATOR: "module-custom-validator";
     readonly NOTIFICATIONS_CENTER: "notifications-center";
@@ -102,7 +103,7 @@ export declare const end_points: {
     readonly REPORT_FILTER: "report-filter";
 };
 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", "check", "day", "receivingMaterial", "adjustAccount", "transfer", "msl", "mslProduct", "mediaStorage", "storecheckTemplate", "activityStorecheck", "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"];
+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", "check", "day", "receivingMaterial", "adjustAccount", "transfer", "msl", "mslProduct", "mediaStorage", "storecheckTemplate", "activityStorecheck", "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"];
 export type AvailableService = (typeof availableService)[number];
 export default class Repzo {
     private svAPIEndpoint;
@@ -204,6 +205,7 @@ export default class Repzo {
         readonly RESET_COMPANY_NAMESPACE: "reset-company-namespace";
         readonly TEST_RESET_COMPANY_NAMESPACE: "test-reset-company-namespace";
         readonly TIMELINE_TIME_LIST: "timeline-time-list";
+        readonly SALES_ANALYTICS_REPORT: "sales-analytics-report";
         readonly WORKORDER_AGENDA: "workorder-agenda";
         readonly MODULE_CUSTOM_VALIDATOR: "module-custom-validator";
         readonly NOTIFICATIONS_CENTER: "notifications-center";
@@ -217,7 +219,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", "check", "day", "receivingMaterial", "adjustAccount", "transfer", "msl", "mslProduct", "mediaStorage", "storecheckTemplate", "activityStorecheck", "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"];
+    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", "check", "day", "receivingMaterial", "adjustAccount", "transfer", "msl", "mslProduct", "mediaStorage", "storecheckTemplate", "activityStorecheck", "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"];
     client: {
         _path: "client";
         find: (params?: Service.Client.Find.Params) => Promise<Service.Client.Find.Result>;
@@ -958,6 +960,10 @@ export default class Repzo {
         _path: "timeline-time-list";
         find: (params?: Service.TimelineTimeList.Find.Params) => Promise<Service.TimelineTimeList.Find.Result>;
     };
+    salesAnalyticsReport: {
+        _path: "sales-analytics-report";
+        find: (params?: Service.SalesAnalyticsReport.Find.Params) => Promise<Service.SalesAnalyticsReport.Find.Result>;
+    };
     workorderAgenda: {
         _path: "workorder-agenda";
         find: (params: Service.WorkorderAgenda.Find.Params) => Promise<Service.WorkorderAgenda.Find.Result>;

package/lib/index.js

@@ -94,6 +94,7 @@ export const end_points = {
     RESET_COMPANY_NAMESPACE: "reset-company-namespace",
     TEST_RESET_COMPANY_NAMESPACE: "test-reset-company-namespace",
     TIMELINE_TIME_LIST: "timeline-time-list",
+    SALES_ANALYTICS_REPORT: "sales-analytics-report",
     WORKORDER_AGENDA: "workorder-agenda",
     MODULE_CUSTOM_VALIDATOR: "module-custom-validator",
     NOTIFICATIONS_CENTER: "notifications-center",
@@ -190,6 +191,7 @@ export const availableService = [
     "repBalanceSummary",
     "workorderPortalLink",
     "customField",
+    "salesAnalyticsReport",
 ];
 class Repzo {
     constructor(apiKey, options) {
@@ -1940,6 +1942,13 @@ class Repzo {
                 return res;
             },
         };
+        this.salesAnalyticsReport = {
+            _path: Repzo._end_points.SALES_ANALYTICS_REPORT,
+            find: async (params) => {
+                let res = await this._fetch(this.svAPIEndpoint, this.salesAnalyticsReport._path, params);
+                return res;
+            },
+        };
         this.workorderAgenda = {
             _path: Repzo._end_points.WORKORDER_AGENDA,
             find: async (params) => {

package/lib/types/index.d.ts

@@ -2728,6 +2728,9 @@ export declare namespace Service {
                 name: string;
                 username: string;
                 password: string;
+                [key: `integration_meta.${string}`]: any;
+                [key: `customFields.${string}`]: any;
+                [key: `settings.${string}`]: any;
             }
             type Result = RepSchema;
         }
@@ -2738,6 +2741,9 @@ export declare namespace Service {
                 createdAt?: string;
                 updatedAt?: string;
                 __v?: number;
+                [key: `integration_meta.${string}`]: any;
+                [key: `customFields.${string}`]: any;
+                [key: `settings.${string}`]: any;
             }
             type Result = RepSchema;
         }
@@ -15648,6 +15654,94 @@ export declare namespace Service {
         }
         export {};
     }
+    namespace SalesAnalyticsReport {
+        const groupBy_options: readonly ["client", "rep", "issue_date", "due_date", "serial_number", "product", "variant", "brand", "category", "status", "promotion_type", "class", "measureunit", "promotion", "chain", "channel", "city", "region", "country", "route", "teams"];
+        type GroupByOption = (typeof groupBy_options)[number];
+        const promotion_type_options: readonly ["get", "buy"];
+        type PromotionTypeOption = (typeof promotion_type_options)[number];
+        const class_options: readonly ["invoice", "return"];
+        type ClassOption = (typeof class_options)[number];
+        const status_options: readonly ["unpaid", "partially_paid", "paid"];
+        type StatusOption = (typeof status_options)[number];
+        const sortBy_field_options: readonly ["_id", "time"];
+        type SortByFieldOption = (typeof sortBy_field_options)[number];
+        const sortBy_type_options: readonly ["asc", "desc"];
+        type SortByTypeOption = (typeof sortBy_type_options)[number];
+        interface SortByOption {
+            field: SortByFieldOption;
+            type: SortByTypeOption;
+        }
+        interface Data {
+            _id?: string;
+            [key: string]: any;
+        }
+        namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                from_issue_date?: string;
+                to_issue_date?: string;
+                from_due_date?: string;
+                to_due_date?: string;
+                from_createdAt?: string;
+                to_createdAt?: string;
+                from_updatedAt?: string;
+                to_updatedAt?: string;
+                client?: StringId | StringId[];
+                rep?: StringId | StringId[];
+                creator?: StringId | StringId[];
+                teams?: StringId | StringId[];
+                status?: StatusOption | StatusOption[];
+                promotion?: StringId | StringId[];
+                product?: StringId | StringId[];
+                variant?: StringId | StringId[];
+                category?: StringId | StringId[];
+                sub_category?: StringId | StringId[];
+                brand?: StringId | StringId[];
+                product_groups?: StringId | StringId[];
+                class?: ClassOption | ClassOption[];
+                with_brand?: boolean;
+                with_category?: boolean;
+                with_product_groups?: boolean;
+                with_sub_category?: boolean;
+                with_product_details?: boolean;
+                with_variant_details?: boolean;
+                with_teams?: boolean;
+                with_promotions?: boolean;
+                promotion_type?: PromotionTypeOption;
+                with_balance?: boolean;
+                groupBy?: GroupByOption | GroupByOption[];
+                from_price?: number;
+                to_price?: number;
+                export?: string;
+                chain?: StringId | StringId[];
+                channel?: StringId | StringId[];
+                CLIENT_TAGS?: StringId | StringId[];
+                AREA_TAGS?: StringId | StringId[];
+                tags?: StringId | StringId[];
+                country?: string | string[];
+                state?: string | string[];
+                city?: string | string[];
+                with_chain?: boolean;
+                with_channel?: boolean;
+                with_tags?: boolean;
+                with_client_details?: boolean;
+                admin?: StringId | StringId[];
+                tax?: StringId | StringId[];
+                with_original_price?: boolean;
+                with_route?: boolean;
+                route?: StringId | StringId[];
+                with_external_serial_number?: boolean;
+                with_workorder?: boolean;
+                with_client_customFields?: boolean;
+                with_rep_details?: boolean;
+                with_rep_customFields?: boolean;
+                sortBy?: SortByOption[];
+                includeDocumentsCount?: boolean;
+            };
+            interface Result extends DefaultPaginationResult {
+                data: Data[];
+            }
+        }
+    }
     namespace WorkorderAgenda {
         interface Workorder {
             name: string;

package/lib/types/index.js

@@ -133,4 +133,35 @@ export var Service;
             "cycle",
         ];
     })(TimelineTimeList = Service.TimelineTimeList || (Service.TimelineTimeList = {}));
+    let SalesAnalyticsReport;
+    (function (SalesAnalyticsReport) {
+        SalesAnalyticsReport.groupBy_options = [
+            "client",
+            "rep",
+            "issue_date",
+            "due_date",
+            "serial_number",
+            "product",
+            "variant",
+            "brand",
+            "category",
+            "status",
+            "promotion_type",
+            "class",
+            "measureunit",
+            "promotion",
+            "chain",
+            "channel",
+            "city",
+            "region",
+            "country",
+            "route",
+            "teams",
+        ];
+        SalesAnalyticsReport.promotion_type_options = ["get", "buy"];
+        SalesAnalyticsReport.class_options = ["invoice", "return"];
+        SalesAnalyticsReport.status_options = ["unpaid", "partially_paid", "paid"];
+        SalesAnalyticsReport.sortBy_field_options = ["_id", "time"];
+        SalesAnalyticsReport.sortBy_type_options = ["asc", "desc"];
+    })(SalesAnalyticsReport = Service.SalesAnalyticsReport || (Service.SalesAnalyticsReport = {}));
 })(Service || (Service = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repzo",
-  "version": "1.0.183",
+  "version": "1.0.185",
   "description": "Repzo TypeScript SDK",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

package/src/index.ts

@@ -104,6 +104,7 @@ export const end_points = {
   RESET_COMPANY_NAMESPACE: "reset-company-namespace",
   TEST_RESET_COMPANY_NAMESPACE: "test-reset-company-namespace",
   TIMELINE_TIME_LIST: "timeline-time-list",
+  SALES_ANALYTICS_REPORT: "sales-analytics-report",
   WORKORDER_AGENDA: "workorder-agenda",
   MODULE_CUSTOM_VALIDATOR: "module-custom-validator",
   NOTIFICATIONS_CENTER: "notifications-center",
@@ -202,6 +203,7 @@ export const availableService = [
   "repBalanceSummary",
   "workorderPortalLink",
   "customField",
+  "salesAnalyticsReport",
 ] as const;
 export type AvailableService = (typeof availableService)[number];
 
@@ -4943,6 +4945,20 @@ export default class Repzo {
     },
   };
 
+  salesAnalyticsReport = {
+    _path: Repzo._end_points.SALES_ANALYTICS_REPORT,
+    find: async (
+      params?: Service.SalesAnalyticsReport.Find.Params,
+    ): Promise<Service.SalesAnalyticsReport.Find.Result> => {
+      let res: Service.SalesAnalyticsReport.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.salesAnalyticsReport._path,
+        params,
+      );
+      return res;
+    },
+  };
+
   workorderAgenda = {
     _path: Repzo._end_points.WORKORDER_AGENDA,
     find: async (

package/src/types/index.ts

@@ -3148,6 +3148,9 @@ export namespace Service {
         name: string;
         username: string;
         password: string;
+        [key: `integration_meta.${string}`]: any;
+        [key: `customFields.${string}`]: any;
+        [key: `settings.${string}`]: any;
       }
       export type Result = RepSchema;
     }
@@ -3159,6 +3162,9 @@ export namespace Service {
         createdAt?: string;
         updatedAt?: string;
         __v?: number;
+        [key: `integration_meta.${string}`]: any;
+        [key: `customFields.${string}`]: any;
+        [key: `settings.${string}`]: any;
       }
       export type Result = RepSchema;
     }
@@ -17668,6 +17674,125 @@ export namespace Service {
     }
   }
 
+  export namespace SalesAnalyticsReport {
+    export const groupBy_options = [
+      "client",
+      "rep",
+      "issue_date",
+      "due_date",
+      "serial_number",
+      "product",
+      "variant",
+      "brand",
+      "category",
+      "status",
+      "promotion_type",
+      "class",
+      "measureunit",
+      "promotion",
+      "chain",
+      "channel",
+      "city",
+      "region",
+      "country",
+      "route",
+      "teams",
+    ] as const;
+    export type GroupByOption = (typeof groupBy_options)[number];
+
+    export const promotion_type_options = ["get", "buy"] as const;
+    export type PromotionTypeOption = (typeof promotion_type_options)[number];
+
+    export const class_options = ["invoice", "return"] as const;
+    export type ClassOption = (typeof class_options)[number];
+
+    export const status_options = ["unpaid", "partially_paid", "paid"] as const;
+    export type StatusOption = (typeof status_options)[number];
+
+    export const sortBy_field_options = ["_id", "time"] as const;
+    export type SortByFieldOption = (typeof sortBy_field_options)[number];
+
+    export const sortBy_type_options = ["asc", "desc"] as const;
+    export type SortByTypeOption = (typeof sortBy_type_options)[number];
+
+    export interface SortByOption {
+      field: SortByFieldOption;
+      type: SortByTypeOption;
+    }
+
+    export interface Data {
+      _id?: string;
+      [key: string]: any;
+    }
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        from_issue_date?: string;
+        to_issue_date?: string;
+        from_due_date?: string;
+        to_due_date?: string;
+        from_createdAt?: string;
+        to_createdAt?: string;
+        from_updatedAt?: string;
+        to_updatedAt?: string;
+        client?: StringId | StringId[];
+        rep?: StringId | StringId[];
+        creator?: StringId | StringId[];
+        teams?: StringId | StringId[];
+        status?: StatusOption | StatusOption[];
+        promotion?: StringId | StringId[];
+        product?: StringId | StringId[];
+        variant?: StringId | StringId[];
+        category?: StringId | StringId[];
+        sub_category?: StringId | StringId[];
+        brand?: StringId | StringId[];
+        product_groups?: StringId | StringId[];
+        class?: ClassOption | ClassOption[];
+        with_brand?: boolean;
+        with_category?: boolean;
+        with_product_groups?: boolean;
+        with_sub_category?: boolean;
+        with_product_details?: boolean;
+        with_variant_details?: boolean;
+        with_teams?: boolean;
+        with_promotions?: boolean;
+        promotion_type?: PromotionTypeOption;
+        with_balance?: boolean;
+        groupBy?: GroupByOption | GroupByOption[];
+        from_price?: number;
+        to_price?: number;
+        export?: string;
+        chain?: StringId | StringId[];
+        channel?: StringId | StringId[];
+        CLIENT_TAGS?: StringId | StringId[];
+        AREA_TAGS?: StringId | StringId[];
+        tags?: StringId | StringId[];
+        country?: string | string[];
+        state?: string | string[];
+        city?: string | string[];
+        with_chain?: boolean;
+        with_channel?: boolean;
+        with_tags?: boolean;
+        with_client_details?: boolean;
+        admin?: StringId | StringId[];
+        tax?: StringId | StringId[];
+        with_original_price?: boolean;
+        with_route?: boolean;
+        route?: StringId | StringId[];
+        with_external_serial_number?: boolean;
+        with_workorder?: boolean;
+        with_client_customFields?: boolean;
+        with_rep_details?: boolean;
+        with_rep_customFields?: boolean;
+        sortBy?: SortByOption[];
+        includeDocumentsCount?: boolean;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+  }
+
   export namespace WorkorderAgenda {
     export interface Workorder {
       name: string;