repzo 1.0.267 → 1.0.268

package/lib/index.d.ts

@@ -1045,6 +1045,7 @@ export default class Repzo {
     salesAnalyticsReport: {
         _path: "sales-analytics-report";
         find: (params?: Service.SalesAnalyticsReport.Find.Params) => Promise<Service.SalesAnalyticsReport.Find.Result>;
+        create: (body: Service.SalesAnalyticsReport.CreateBody, params?: Service.SalesAnalyticsReport.Create.Params) => Promise<Service.SalesAnalyticsReport.Create.Result>;
     };
     workorderAgenda: {
         _path: "workorder-agenda";

package/lib/index.js

@@ -2028,6 +2028,10 @@ class Repzo {
                 let res = await this._fetch(this.svAPIEndpoint, this.salesAnalyticsReport._path, params);
                 return res;
             },
+            create: async (body, params) => {
+                let res = await this._create(this.svAPIEndpoint, this.salesAnalyticsReport._path, body, params);
+                return res;
+            },
         };
         this.workorderAgenda = {
             _path: Repzo._end_points.WORKORDER_AGENDA,

package/lib/types/index.d.ts

@@ -1,4 +1,5 @@
 import { EndPoints } from "../index.js";
+import { SalesAnalyticsFieldAccumulators, SalesAnalyticsReportProjectionKey, SalesAnalyticsReportFilter, SalesAnalyticsGroupByIDs, SalesAnalyticsReportSortedKey } from "./report-type.js";
 export interface Params {
     [key: string]: any;
 }
@@ -17,6 +18,80 @@ export interface Options {
     refresh_token?: string;
     reauthCallBackFn?: (res: Service.Reauth.Result) => void;
 }
+interface ReportColumn {
+    _id?: string;
+    disabled: boolean;
+    key: string;
+    name: string;
+    report_types: ReportType[];
+    default_show: boolean;
+    selectable: boolean;
+    position: number;
+    show: "default" | "hide" | "show";
+    column_group?: StringId | string;
+    totals_key?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+type QueryCriteriaCondition = {
+    [key: string]: any;
+};
+type QueryCriteriaValue = boolean | string | number | QueryCriteriaElement | QueryCriteriaLogical | null | Date;
+type LogicalOperators = "and" | "or";
+export type QueryCriteriaOperators = "gt" | "lt" | "gte" | "lte" | "in" | "nin" | "eq" | "between" | "last_seven_days" | "today" | "yesterday" | "last_thirty_days" | "last_month" | "last_three_months" | "last_six_months" | "last_twelve_months";
+type QueryCriteriaElement = {
+    key: string;
+    operator: QueryCriteriaOperators;
+    value: QueryCriteriaValue;
+    conditions?: QueryCriteriaCondition[];
+};
+type QueryCriteriaLogical = {
+    operator: LogicalOperators;
+    value: QueryCriteriaValue[];
+};
+type BaseKey = string;
+type BaseValue = any;
+type FilterMap = SalesAnalyticsReportFilter;
+type GroupByKeys = SalesAnalyticsGroupByIDs;
+type FieldAccumulators = SalesAnalyticsFieldAccumulators;
+type SortValue<Keys extends BaseKey> = {
+    field: Keys;
+    type: "asc" | "desc" | -1 | 1;
+};
+interface EnhancedQueryCriteriaElement<TKeys extends keyof FilterMap, TValue extends BaseValue = QueryCriteriaValue, TCondition = QueryCriteriaCondition> {
+    key: TKeys;
+    operator: FilterMap[TKeys][number];
+    value: TValue;
+    conditions?: TCondition[];
+}
+type GroupByType<TGroupID extends keyof GroupByKeys, TFieldAccumulators> = {
+    _id: TGroupID;
+    fields: {
+        [K in GroupByKeys[TGroupID]]: {
+            key: K;
+            acc: K extends keyof TFieldAccumulators ? TFieldAccumulators[K] : never;
+        };
+    }[GroupByKeys[TGroupID]][];
+};
+interface GenericQuery<TSortKey extends BaseKey, TFilterMap extends FilterMap, TGroupKey extends GroupByKeys, TFieldAccumulators extends FieldAccumulators, TProjectionKeys extends BaseKey, TMaxAnyOfLength extends number = 1> {
+    maxAnyOfLength: TMaxAnyOfLength;
+    anyOf: {
+        criteria: {
+            [K in keyof TFilterMap]: EnhancedQueryCriteriaElement<K & keyof FilterMap>;
+        }[keyof TFilterMap][];
+    }[];
+    options?: {
+        sort?: SortValue<TSortKey>[];
+        limit?: number;
+        page?: number;
+        totals_summary?: "none" | "all" | "page";
+        without_currency?: boolean;
+    };
+    group?: GroupByType<keyof TGroupKey & keyof GroupByKeys, TFieldAccumulators>[];
+    projection?: TProjectionKeys[];
+    columns?: ReportColumn[];
+    metadata?: any;
+}
 export interface Headers {
     "api-key": string;
     "Content-Type": string;
@@ -174,6 +249,8 @@ export interface DefaultPaginationResult {
     prev_page_url: string | null;
     path: string;
     data: any[];
+    columns?: ReportColumn[];
+    keys?: ReportKey[];
 }
 export interface AgendaPaginationResult extends DefaultPaginationResult {
     meta?: {
@@ -15297,6 +15374,7 @@ export declare namespace Service {
             _id?: string;
             [key: string]: any;
         }
+        type CreateBody = GenericQuery<SalesAnalyticsReportSortedKey, SalesAnalyticsReportFilter, SalesAnalyticsGroupByIDs, SalesAnalyticsFieldAccumulators, SalesAnalyticsReportProjectionKey, 1>;
         namespace Find {
             type Params = DefaultPaginationQueryParams & {
                 from_issue_date?: string;
@@ -15363,6 +15441,75 @@ export declare namespace Service {
                 data: Data[];
             }
         }
+        namespace Create {
+            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;
+            };
+            type Body = CreateBody;
+            interface Result extends DefaultPaginationResult {
+                data: Data[];
+                columns: ReportColumn[];
+                keys: ReportKey[];
+            }
+        }
     }
     namespace WorkorderAgenda {
         interface Workorder {

package/lib/types/report-type.d.ts

@@ -0,0 +1,207 @@
+import type { QueryCriteriaOperators } from "./index";
+type SalesAnalyticsReportFilterKeys = "is_void" | "client_id" | "rep" | "admin" | "creator._id" | "status" | "time" | "issue_date" | "due_date" | "createdAt" | "updatedAt" | "client.chain" | "client.channel" | "client.city" | "client.state" | "client.country" | "client.tags" | "client.CLIENT_TAGS" | "client.AREA_TAGS" | "product.brand" | "product.category" | "product.sub_category" | "product.product_groups" | "promotions._id" | "items.measureunit._id" | "items.return_reason" | "items.variant.variant_id" | "items.variant.product_id" | "items.promotion_type" | "items.class" | "items.discounted_price" | "items.tax._id" | "items.tax.name" | "items.tax.type" | "return_items.tax.name" | "return_items.tax.type" | "return_items.measureunit._id" | "return_items.return_reason" | "return_items.variant.variant_id" | "return_items.variant.product_id" | "return_items.promotion_type" | "return_items.class" | "return_items.discounted_price" | "return_items.tax._id" | "teams" | "route" | "custom_status";
+interface SalesAnalyticsReportFilter extends Record<SalesAnalyticsReportFilterKeys, QueryCriteriaOperators[]> {
+    is_void: ["in"];
+    client_id: ["in", "nin"];
+    rep: ["in", "nin"];
+    admin: ["in", "nin"];
+    "creator._id": ["in", "nin"];
+    status: ["in", "nin"];
+    time: [
+        "between",
+        "last_seven_days",
+        "last_thirty_days",
+        "last_month",
+        "last_three_months",
+        "last_six_months",
+        "last_twelve_months",
+        "yesterday",
+        "today",
+        "gte",
+        "lte",
+        "lt",
+        "gt"
+    ];
+    issue_date: [
+        "between",
+        "last_seven_days",
+        "last_thirty_days",
+        "last_month",
+        "last_three_months",
+        "last_six_months",
+        "last_twelve_months",
+        "yesterday",
+        "today",
+        "gte",
+        "lte",
+        "lt",
+        "gt"
+    ];
+    due_date: [
+        "between",
+        "last_seven_days",
+        "last_thirty_days",
+        "last_month",
+        "last_three_months",
+        "last_six_months",
+        "last_twelve_months",
+        "yesterday",
+        "today",
+        "gte",
+        "lte",
+        "lt",
+        "gt"
+    ];
+    createdAt: [
+        "between",
+        "last_seven_days",
+        "last_thirty_days",
+        "last_month",
+        "last_three_months",
+        "last_six_months",
+        "last_twelve_months",
+        "yesterday",
+        "today",
+        "gte",
+        "lte",
+        "lt",
+        "gt"
+    ];
+    updatedAt: [
+        "between",
+        "last_seven_days",
+        "last_thirty_days",
+        "last_month",
+        "last_three_months",
+        "last_six_months",
+        "last_twelve_months",
+        "yesterday",
+        "today",
+        "gte",
+        "lte",
+        "lt",
+        "gt"
+    ];
+    "client.chain": ["in", "nin"];
+    "client.channel": ["in", "nin"];
+    "client.city": ["in", "nin"];
+    "client.state": ["in", "nin"];
+    "client.country": ["in", "nin"];
+    "client.tags": ["in", "nin"];
+    "client.CLIENT_TAGS": ["in", "nin"];
+    "client.AREA_TAGS": ["in", "nin"];
+    "product.brand": ["in", "nin"];
+    "product.category": ["in", "nin"];
+    "product.sub_category": ["in", "nin"];
+    "product.product_groups": ["in", "nin"];
+    "promotions._id": ["in", "nin"];
+    "items.promos": ["in", "nin"];
+    "items.measureunit._id": ["in", "nin"];
+    "items.return_reason": ["in", "nin"];
+    "items.variant.variant_id": ["in", "nin"];
+    "items.variant.product_id": ["in", "nin"];
+    "items.promotion_type": ["in", "nin"];
+    "items.class": ["in", "nin"];
+    "items.discounted_price": ["between"];
+    "items.tax._id": ["in", "nin"];
+    "items.tax.name": ["in", "nin"];
+    "items.tax.type": ["in", "nin"];
+    "return_items.tax.name": ["in", "nin"];
+    "return_items.tax.type": ["in", "nin"];
+    "return_items.measureunit._id": ["in", "nin"];
+    "return_items.return_reason": ["in", "nin"];
+    "return_items.variant.variant_id": ["in", "nin"];
+    "return_items.variant.product_id": ["in", "nin"];
+    "return_items.promotion_type": ["in", "nin"];
+    "return_items.class": ["in", "nin"];
+    "return_items.discounted_price": ["between"];
+    "return_items.tax._id": ["in", "nin"];
+    teams: ["in", "nin"];
+    route: ["in", "nin"];
+    custom_status: ["in", "nin"];
+}
+type SalesAnalyticsReportProjectionKey = "issue_date" | "due_date" | "serial_number" | "advanced_serial_number" | "external_serial_number" | "return_serial_number" | "client" | "client_code" | "creator" | "rep_username" | "teams" | "route" | "custom_status" | "workorder_serial_number" | "line_number" | "lines" | "status" | "product" | "product_local_name" | "product_sku" | "product_barcode" | "variant" | "variant_local_name" | "variant_sku" | "variant_barcode" | "category" | "sub_category" | "brand" | "product_groups" | "promotion" | "promotion_ref" | "promotion_type" | "class" | "class" | "return_reason" | "chain" | "channel" | "country" | "state" | "city" | "area_tags" | "client_tags" | "original_price" | "tax" | "visit_uuid" | "base_unit_qty" | "qty" | "measureunit" | "price" | "tax" | "line_total" | "lineTotalAfterDeduction" | "deduction" | "total_before_tax" | "discount_amount" | "tax_total" | "tax_total_after_deduction" | "pre_total" | "return_total" | "total" | "balance" | "tax_total_after_deduction" | `client_customFields.${string}` | `rep_customFields.${string}`;
+type SalesAnalyticsReportSortedKey = "issue_date" | "due_date" | "createdAt" | "updatedAt" | "time" | "line_total" | "pre_total" | "return_total" | "total" | "balance" | "items.tax_total_after_deduction" | "items.lineTotalAfterDeduction" | "items.price" | "discount_amount" | "tax_total" | "items.base_unit_qty" | "items.qty" | "items.deduction";
+type SalesAnalyticsGroupByIDs = {
+    client: "client_name" | "client_id" | "client_code" | "client_local_name" | "chain" | "channel" | "client_customFields" | "tags" | "country" | "state" | "city";
+    user: "creator_id" | "creator_type" | "creator_name" | "creator_customFields" | "creator_username";
+    issue_date: "issue_date";
+    due_date: "due_date";
+    serial_number: "serial_number" | "external_serial_number" | "return_serial_number";
+    product: "product_name" | "product_local_name" | "product" | "price" | "measureunit" | "base_unit_qty" | "qty" | "discount_amount" | "tax" | "return_reason" | "line_total" | "tax_total" | "total_before_tax" | "lineTotalAfterDeduction" | "deduction" | "tax_total_after_deduction" | "original_price" | "product_sku" | "product_barcode" | "sub_category" | "product_groups" | "category" | "brand";
+    variant: "variant_name" | "variant_local_name" | "variant_sku" | "variant_barcode" | "price" | "measureunit" | "base_unit_qty" | "qty" | "discount_amount" | "tax" | "return_reason" | "line_total" | "tax_total" | "total_before_tax" | "lineTotalAfterDeduction" | "deduction" | "tax_total_after_deduction" | "original_price";
+    brand: "brand" | "price" | "measureunit" | "base_unit_qty" | "qty" | "discount_amount" | "tax" | "return_reason" | "line_total" | "tax_total" | "total_before_tax" | "lineTotalAfterDeduction" | "deduction" | "tax_total_after_deduction" | "original_price";
+    category: "category" | "price" | "measureunit" | "base_unit_qty" | "qty" | "discount_amount" | "tax" | "return_reason" | "line_total" | "tax_total" | "total_before_tax" | "lineTotalAfterDeduction" | "deduction" | "tax_total_after_deduction" | "original_price";
+    status: "status";
+    promotion_type: "promotion_type" | "price" | "measureunit" | "base_unit_qty" | "qty" | "discount_amount" | "tax" | "return_reason" | "line_total" | "tax_total" | "total_before_tax" | "lineTotalAfterDeduction" | "deduction" | "tax_total_after_deduction" | "original_price";
+    class: "class" | "price" | "measureunit" | "base_unit_qty" | "qty" | "discount_amount" | "tax" | "return_reason" | "line_total" | "tax_total" | "total_before_tax" | "lineTotalAfterDeduction" | "deduction" | "tax_total_after_deduction" | "original_price";
+    measureunit: "measureunit" | "price" | "base_unit_qty" | "qty" | "discount_amount" | "tax" | "return_reason" | "line_total" | "tax_total" | "total_before_tax" | "lineTotalAfterDeduction" | "deduction" | "tax_total_after_deduction" | "original_price";
+    promotion: "promotions" | "promotion_ref" | "promotion_type" | "price" | "measureunit" | "base_unit_qty" | "qty" | "discount_amount" | "tax" | "return_reason" | "line_total" | "tax_total" | "total_before_tax" | "lineTotalAfterDeduction" | "deduction" | "tax_total_after_deduction" | "original_price";
+    chain: "client_name" | "chain";
+    channel: "client_name" | "channel";
+    city: "client_name" | "city";
+    state: "client_name" | "state";
+    country: "client_name" | "country";
+    route: "route";
+    custom_status: "custom_status";
+    teams: "teams";
+};
+type SalesAnalyticsFieldAccumulators = {
+    client_name: "first" | "last";
+    client_id: "first" | "last";
+    client_code: "first" | "last";
+    client_local_name: "first" | "last";
+    chain: "first" | "last";
+    channel: "first" | "last";
+    client_customFields: "first" | "last";
+    tags: "first" | "last";
+    country: "first" | "last";
+    state: "first" | "last";
+    city: "first" | "last";
+    creator_id: "first" | "last";
+    creator_type: "first" | "last";
+    creator_name: "first" | "last";
+    creator_customFields: "first" | "last";
+    creator_username: "first" | "last";
+    issue_date: "first" | "last";
+    due_date: "first" | "last";
+    serial_number: "first" | "last";
+    external_serial_number: "first" | "last";
+    return_serial_number: "first" | "last";
+    price: "sum" | "avg" | "max" | "min";
+    base_unit_qty: "sum" | "avg" | "max" | "min";
+    qty: "sum" | "avg" | "max" | "min";
+    discount_amount: "sum" | "avg" | "max" | "min";
+    line_total: "sum" | "avg" | "max" | "min";
+    tax_total: "sum" | "avg" | "max" | "min";
+    total_before_tax: "sum" | "avg" | "ma" | "min";
+    lineTotalAfterDeduction: "sum" | "avg" | "max" | "min";
+    deduction: "sum" | "avg" | "max" | "min";
+    tax_total_after_deduction: "sum" | "avg" | "max" | "min";
+    original_price: "avg" | "max" | "min" | "sum";
+    measureunit: "addToSet" | "first" | "last";
+    tax: "addToSet" | "first" | "last";
+    return_reason: "addToSet" | "first" | "last";
+    promotion_type: "addToSet" | "first" | "last";
+    product_name: "first" | "last";
+    product_local_name: "first" | "last";
+    product: "first" | "last";
+    product_sku: "first" | "last";
+    product_barcode: "first" | "last";
+    sub_category: "first" | "last";
+    product_groups: "first" | "last";
+    category: "first" | "last";
+    brand: "first" | "last";
+    variant_name: "first" | "last";
+    variant_local_name: "first" | "last";
+    variant_sku: "first" | "last";
+    variant_barcode: "first" | "last";
+    status: "first" | "last";
+    class: "first" | "last";
+    promotions: "first" | "last";
+    promotion_ref: "first" | "last";
+    route: "first" | "last";
+    custom_status: "first" | "last";
+    teams: "first" | "last";
+};
+export { SalesAnalyticsReportSortedKey, SalesAnalyticsGroupByIDs, SalesAnalyticsFieldAccumulators, SalesAnalyticsReportFilter, SalesAnalyticsReportProjectionKey, };

package/lib/types/report-type.js

@@ -0,0 +1 @@
+export {};

package/package.json

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

package/src/index.ts

@@ -5116,6 +5116,19 @@ export default class Repzo {
       );
       return res;
     },
+
+    create: async (
+      body: Service.SalesAnalyticsReport.CreateBody,
+      params?: Service.SalesAnalyticsReport.Create.Params,
+    ): Promise<Service.SalesAnalyticsReport.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.salesAnalyticsReport._path,
+        body,
+        params,
+      );
+      return res;
+    },
   };
 
   workorderAgenda = {

package/src/types/index.ts

@@ -1,4 +1,11 @@
 import { EndPoints } from "../index.js";
+import {
+  SalesAnalyticsFieldAccumulators,
+  SalesAnalyticsReportProjectionKey,
+  SalesAnalyticsReportFilter,
+  SalesAnalyticsGroupByIDs,
+  SalesAnalyticsReportSortedKey,
+} from "./report-type.js";
 
 export interface Params {
   [key: string]: any;
@@ -19,6 +26,121 @@ export interface Options {
   refresh_token?: string;
   reauthCallBackFn?: (res: Service.Reauth.Result) => void;
 }
+interface ReportColumn {
+  _id?: string;
+  disabled: boolean;
+  key: string;
+  name: string;
+  report_types: ReportType[];
+  default_show: boolean;
+  selectable: boolean;
+  position: number;
+  show: "default" | "hide" | "show";
+  column_group?: StringId | string;
+  totals_key?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+type QueryCriteriaCondition = { [key: string]: any };
+type QueryCriteriaValue =
+  | boolean
+  | string
+  | number
+  | QueryCriteriaElement
+  | QueryCriteriaLogical
+  | null
+  | Date;
+type LogicalOperators = "and" | "or";
+export type QueryCriteriaOperators =
+  | "gt"
+  | "lt"
+  | "gte"
+  | "lte"
+  | "in"
+  | "nin"
+  | "eq"
+  | "between"
+  | "last_seven_days"
+  | "today"
+  | "yesterday"
+  | "last_thirty_days"
+  | "last_month"
+  | "last_three_months"
+  | "last_six_months"
+  | "last_twelve_months";
+
+type QueryCriteriaElement = {
+  key: string;
+  operator: QueryCriteriaOperators;
+  value: QueryCriteriaValue;
+  conditions?: QueryCriteriaCondition[];
+};
+type QueryCriteriaLogical = {
+  operator: LogicalOperators;
+  value: QueryCriteriaValue[];
+};
+type BaseKey = string;
+type BaseValue = any;
+type FilterMap = SalesAnalyticsReportFilter;
+type GroupByKeys = SalesAnalyticsGroupByIDs;
+type FieldAccumulators = SalesAnalyticsFieldAccumulators;
+type SortValue<Keys extends BaseKey> = {
+  field: Keys;
+  type: "asc" | "desc" | -1 | 1;
+};
+interface EnhancedQueryCriteriaElement<
+  TKeys extends keyof FilterMap,
+  TValue extends BaseValue = QueryCriteriaValue,
+  TCondition = QueryCriteriaCondition,
+> {
+  key: TKeys;
+  operator: FilterMap[TKeys][number];
+  value: TValue;
+  conditions?: TCondition[];
+}
+
+type GroupByType<TGroupID extends keyof GroupByKeys, TFieldAccumulators> = {
+  _id: TGroupID;
+  fields: {
+    [K in GroupByKeys[TGroupID]]: {
+      key: K;
+      acc: K extends keyof TFieldAccumulators ? TFieldAccumulators[K] : never;
+    };
+  }[GroupByKeys[TGroupID]][];
+};
+
+interface GenericQuery<
+  TSortKey extends BaseKey,
+  TFilterMap extends FilterMap,
+  TGroupKey extends GroupByKeys,
+  TFieldAccumulators extends FieldAccumulators,
+  TProjectionKeys extends BaseKey,
+  TMaxAnyOfLength extends number = 1,
+> {
+  maxAnyOfLength: TMaxAnyOfLength;
+  anyOf: {
+    criteria: {
+      [K in keyof TFilterMap]: EnhancedQueryCriteriaElement<
+        K & keyof FilterMap
+      >;
+    }[keyof TFilterMap][];
+  }[];
+  options?: {
+    sort?: SortValue<TSortKey>[];
+    limit?: number;
+    page?: number;
+    totals_summary?: "none" | "all" | "page";
+    without_currency?: boolean;
+  };
+  group?: GroupByType<
+    keyof TGroupKey & keyof GroupByKeys,
+    TFieldAccumulators
+  >[];
+  projection?: TProjectionKeys[];
+  columns?: ReportColumn[];
+  metadata?: any;
+}
+
 export interface Headers {
   "api-key": string;
   "Content-Type": string;
@@ -205,6 +327,8 @@ export interface DefaultPaginationResult {
   prev_page_url: string | null;
   path: string;
   data: any[];
+  columns?: ReportColumn[];
+  keys?: ReportKey[];
 }
 export interface AgendaPaginationResult extends DefaultPaginationResult {
   meta?: {
@@ -17118,6 +17242,15 @@ export namespace Service {
       [key: string]: any;
     }
 
+    export type CreateBody = GenericQuery<
+      SalesAnalyticsReportSortedKey,
+      SalesAnalyticsReportFilter,
+      SalesAnalyticsGroupByIDs,
+      SalesAnalyticsFieldAccumulators,
+      SalesAnalyticsReportProjectionKey,
+      1
+    >;
+
     export namespace Find {
       export type Params = DefaultPaginationQueryParams & {
         from_issue_date?: string;
@@ -17184,6 +17317,77 @@ export namespace Service {
         data: Data[];
       }
     }
+
+    export namespace Create {
+      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 type Body = CreateBody;
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+        columns: ReportColumn[];
+        keys: ReportKey[];
+      }
+    }
   }
 
   export namespace WorkorderAgenda {

package/src/types/report-type.ts

@@ -0,0 +1,503 @@
+import type { QueryCriteriaOperators } from "./index";
+
+type SalesAnalyticsReportFilterKeys =
+  | "is_void"
+  | "client_id"
+  | "rep"
+  | "admin"
+  | "creator._id"
+  | "status"
+  | "time"
+  | "issue_date"
+  | "due_date"
+  | "createdAt"
+  | "updatedAt"
+  | "client.chain"
+  | "client.channel"
+  | "client.city"
+  | "client.state"
+  | "client.country"
+  | "client.tags"
+  | "client.CLIENT_TAGS"
+  | "client.AREA_TAGS"
+  | "product.brand"
+  | "product.category"
+  | "product.sub_category"
+  | "product.product_groups"
+  | "promotions._id"
+  | "items.measureunit._id"
+  | "items.return_reason"
+  | "items.variant.variant_id"
+  | "items.variant.product_id"
+  | "items.promotion_type"
+  | "items.class"
+  | "items.discounted_price"
+  | "items.tax._id"
+  | "items.tax.name"
+  | "items.tax.type"
+  | "return_items.tax.name"
+  | "return_items.tax.type"
+  | "return_items.measureunit._id"
+  | "return_items.return_reason"
+  | "return_items.variant.variant_id"
+  | "return_items.variant.product_id"
+  | "return_items.promotion_type"
+  | "return_items.class"
+  | "return_items.discounted_price"
+  | "return_items.tax._id"
+  | "teams"
+  | "route"
+  | "custom_status";
+
+interface SalesAnalyticsReportFilter extends Record<
+  SalesAnalyticsReportFilterKeys,
+  QueryCriteriaOperators[]
+> {
+  is_void: ["in"];
+  client_id: ["in", "nin"];
+  rep: ["in", "nin"];
+  admin: ["in", "nin"];
+  "creator._id": ["in", "nin"];
+  status: ["in", "nin"];
+  time: [
+    "between",
+    "last_seven_days",
+    "last_thirty_days",
+    "last_month",
+    "last_three_months",
+    "last_six_months",
+    "last_twelve_months",
+    "yesterday",
+    "today",
+    "gte",
+    "lte",
+    "lt",
+    "gt",
+  ];
+  issue_date: [
+    "between",
+    "last_seven_days",
+    "last_thirty_days",
+    "last_month",
+    "last_three_months",
+    "last_six_months",
+    "last_twelve_months",
+    "yesterday",
+    "today",
+    "gte",
+    "lte",
+    "lt",
+    "gt",
+  ];
+  due_date: [
+    "between",
+    "last_seven_days",
+    "last_thirty_days",
+    "last_month",
+    "last_three_months",
+    "last_six_months",
+    "last_twelve_months",
+    "yesterday",
+    "today",
+    "gte",
+    "lte",
+    "lt",
+    "gt",
+  ];
+  createdAt: [
+    "between",
+    "last_seven_days",
+    "last_thirty_days",
+    "last_month",
+    "last_three_months",
+    "last_six_months",
+    "last_twelve_months",
+    "yesterday",
+    "today",
+    "gte",
+    "lte",
+    "lt",
+    "gt",
+  ];
+  updatedAt: [
+    "between",
+    "last_seven_days",
+    "last_thirty_days",
+    "last_month",
+    "last_three_months",
+    "last_six_months",
+    "last_twelve_months",
+    "yesterday",
+    "today",
+    "gte",
+    "lte",
+    "lt",
+    "gt",
+  ];
+  "client.chain": ["in", "nin"];
+  "client.channel": ["in", "nin"];
+  "client.city": ["in", "nin"];
+  "client.state": ["in", "nin"];
+  "client.country": ["in", "nin"];
+  "client.tags": ["in", "nin"];
+  "client.CLIENT_TAGS": ["in", "nin"];
+  "client.AREA_TAGS": ["in", "nin"];
+  "product.brand": ["in", "nin"];
+  "product.category": ["in", "nin"];
+  "product.sub_category": ["in", "nin"];
+  "product.product_groups": ["in", "nin"];
+  "promotions._id": ["in", "nin"];
+  "items.promos": ["in", "nin"];
+  "items.measureunit._id": ["in", "nin"];
+  "items.return_reason": ["in", "nin"];
+  "items.variant.variant_id": ["in", "nin"];
+  "items.variant.product_id": ["in", "nin"];
+  "items.promotion_type": ["in", "nin"];
+  "items.class": ["in", "nin"];
+  "items.discounted_price": ["between"];
+  "items.tax._id": ["in", "nin"];
+  "items.tax.name": ["in", "nin"];
+  "items.tax.type": ["in", "nin"];
+  "return_items.tax.name": ["in", "nin"];
+  "return_items.tax.type": ["in", "nin"];
+  "return_items.measureunit._id": ["in", "nin"];
+  "return_items.return_reason": ["in", "nin"];
+  "return_items.variant.variant_id": ["in", "nin"];
+  "return_items.variant.product_id": ["in", "nin"];
+  "return_items.promotion_type": ["in", "nin"];
+  "return_items.class": ["in", "nin"];
+  "return_items.discounted_price": ["between"];
+  "return_items.tax._id": ["in", "nin"];
+  teams: ["in", "nin"];
+  route: ["in", "nin"];
+  custom_status: ["in", "nin"];
+}
+
+type SalesAnalyticsReportProjectionKey =
+  | "issue_date"
+  | "due_date"
+  | "serial_number"
+  | "advanced_serial_number"
+  | "external_serial_number"
+  | "return_serial_number"
+  | "client"
+  | "client_code"
+  | "creator"
+  | "rep_username"
+  | "teams"
+  | "route"
+  | "custom_status"
+  | "workorder_serial_number"
+  | "line_number"
+  | "lines"
+  | "status"
+  | "product"
+  | "product_local_name"
+  | "product_sku"
+  | "product_barcode"
+  | "variant"
+  | "variant_local_name"
+  | "variant_sku"
+  | "variant_barcode"
+  | "category"
+  | "sub_category"
+  | "brand"
+  | "product_groups"
+  | "promotion"
+  | "promotion_ref"
+  | "promotion_type"
+  | "class"
+  | "class"
+  | "return_reason"
+  | "chain"
+  | "channel"
+  | "country"
+  | "state"
+  | "city"
+  | "area_tags"
+  | "client_tags"
+  | "original_price"
+  | "tax"
+  | "visit_uuid"
+  | "base_unit_qty"
+  | "qty"
+  | "measureunit"
+  | "price"
+  | "tax"
+  | "line_total"
+  | "lineTotalAfterDeduction"
+  | "deduction"
+  | "total_before_tax"
+  | "discount_amount"
+  | "tax_total"
+  | "tax_total_after_deduction"
+  | "pre_total"
+  | "return_total"
+  | "total"
+  | "balance"
+  | "tax_total_after_deduction"
+  | `client_customFields.${string}`
+  | `rep_customFields.${string}`;
+
+type SalesAnalyticsReportSortedKey =
+  | "issue_date"
+  | "due_date"
+  | "createdAt"
+  | "updatedAt"
+  | "time"
+  | "line_total"
+  | "pre_total"
+  | "return_total"
+  | "total"
+  | "balance"
+  | "items.tax_total_after_deduction"
+  | "items.lineTotalAfterDeduction"
+  | "items.price"
+  | "discount_amount"
+  | "tax_total"
+  | "items.base_unit_qty"
+  | "items.qty"
+  | "items.deduction";
+
+type SalesAnalyticsGroupByIDs = {
+  client:
+    | "client_name"
+    | "client_id"
+    | "client_code"
+    | "client_local_name"
+    | "chain"
+    | "channel"
+    | "client_customFields"
+    | "tags"
+    | "country"
+    | "state"
+    | "city";
+  user:
+    | "creator_id"
+    | "creator_type"
+    | "creator_name"
+    | "creator_customFields"
+    | "creator_username";
+  issue_date: "issue_date";
+  due_date: "due_date";
+  serial_number:
+    | "serial_number"
+    | "external_serial_number"
+    | "return_serial_number";
+  product:
+    | "product_name"
+    | "product_local_name"
+    | "product"
+    | "price"
+    | "measureunit"
+    | "base_unit_qty"
+    | "qty"
+    | "discount_amount"
+    | "tax"
+    | "return_reason"
+    | "line_total"
+    | "tax_total"
+    | "total_before_tax"
+    | "lineTotalAfterDeduction"
+    | "deduction"
+    | "tax_total_after_deduction"
+    | "original_price"
+    | "product_sku"
+    | "product_barcode"
+    | "sub_category"
+    | "product_groups"
+    | "category"
+    | "brand";
+  variant:
+    | "variant_name"
+    | "variant_local_name"
+    | "variant_sku"
+    | "variant_barcode"
+    | "price"
+    | "measureunit"
+    | "base_unit_qty"
+    | "qty"
+    | "discount_amount"
+    | "tax"
+    | "return_reason"
+    | "line_total"
+    | "tax_total"
+    | "total_before_tax"
+    | "lineTotalAfterDeduction"
+    | "deduction"
+    | "tax_total_after_deduction"
+    | "original_price";
+  brand:
+    | "brand"
+    | "price"
+    | "measureunit"
+    | "base_unit_qty"
+    | "qty"
+    | "discount_amount"
+    | "tax"
+    | "return_reason"
+    | "line_total"
+    | "tax_total"
+    | "total_before_tax"
+    | "lineTotalAfterDeduction"
+    | "deduction"
+    | "tax_total_after_deduction"
+    | "original_price";
+  category:
+    | "category"
+    | "price"
+    | "measureunit"
+    | "base_unit_qty"
+    | "qty"
+    | "discount_amount"
+    | "tax"
+    | "return_reason"
+    | "line_total"
+    | "tax_total"
+    | "total_before_tax"
+    | "lineTotalAfterDeduction"
+    | "deduction"
+    | "tax_total_after_deduction"
+    | "original_price";
+  status: "status";
+  promotion_type:
+    | "promotion_type"
+    | "price"
+    | "measureunit"
+    | "base_unit_qty"
+    | "qty"
+    | "discount_amount"
+    | "tax"
+    | "return_reason"
+    | "line_total"
+    | "tax_total"
+    | "total_before_tax"
+    | "lineTotalAfterDeduction"
+    | "deduction"
+    | "tax_total_after_deduction"
+    | "original_price";
+  class:
+    | "class"
+    | "price"
+    | "measureunit"
+    | "base_unit_qty"
+    | "qty"
+    | "discount_amount"
+    | "tax"
+    | "return_reason"
+    | "line_total"
+    | "tax_total"
+    | "total_before_tax"
+    | "lineTotalAfterDeduction"
+    | "deduction"
+    | "tax_total_after_deduction"
+    | "original_price";
+  measureunit:
+    | "measureunit"
+    | "price"
+    | "base_unit_qty"
+    | "qty"
+    | "discount_amount"
+    | "tax"
+    | "return_reason"
+    | "line_total"
+    | "tax_total"
+    | "total_before_tax"
+    | "lineTotalAfterDeduction"
+    | "deduction"
+    | "tax_total_after_deduction"
+    | "original_price";
+  promotion:
+    | "promotions"
+    | "promotion_ref"
+    | "promotion_type"
+    | "price"
+    | "measureunit"
+    | "base_unit_qty"
+    | "qty"
+    | "discount_amount"
+    | "tax"
+    | "return_reason"
+    | "line_total"
+    | "tax_total"
+    | "total_before_tax"
+    | "lineTotalAfterDeduction"
+    | "deduction"
+    | "tax_total_after_deduction"
+    | "original_price";
+  chain: "client_name" | "chain";
+  channel: "client_name" | "channel";
+  city: "client_name" | "city";
+  state: "client_name" | "state";
+  country: "client_name" | "country";
+  route: "route";
+  custom_status: "custom_status";
+  teams: "teams";
+};
+
+type SalesAnalyticsFieldAccumulators = {
+  client_name: "first" | "last";
+  client_id: "first" | "last";
+  client_code: "first" | "last";
+  client_local_name: "first" | "last";
+  chain: "first" | "last";
+  channel: "first" | "last";
+  client_customFields: "first" | "last";
+  tags: "first" | "last";
+  country: "first" | "last";
+  state: "first" | "last";
+  city: "first" | "last";
+  creator_id: "first" | "last";
+  creator_type: "first" | "last";
+  creator_name: "first" | "last";
+  creator_customFields: "first" | "last";
+  creator_username: "first" | "last";
+  issue_date: "first" | "last";
+  due_date: "first" | "last";
+  serial_number: "first" | "last";
+  external_serial_number: "first" | "last";
+  return_serial_number: "first" | "last";
+  price: "sum" | "avg" | "max" | "min";
+  base_unit_qty: "sum" | "avg" | "max" | "min";
+  qty: "sum" | "avg" | "max" | "min";
+  discount_amount: "sum" | "avg" | "max" | "min";
+  line_total: "sum" | "avg" | "max" | "min";
+  tax_total: "sum" | "avg" | "max" | "min";
+  total_before_tax: "sum" | "avg" | "ma" | "min";
+  lineTotalAfterDeduction: "sum" | "avg" | "max" | "min";
+  deduction: "sum" | "avg" | "max" | "min";
+  tax_total_after_deduction: "sum" | "avg" | "max" | "min";
+  original_price: "avg" | "max" | "min" | "sum";
+  measureunit: "addToSet" | "first" | "last";
+  tax: "addToSet" | "first" | "last";
+  return_reason: "addToSet" | "first" | "last";
+  promotion_type: "addToSet" | "first" | "last";
+  product_name: "first" | "last";
+  product_local_name: "first" | "last";
+  product: "first" | "last";
+  product_sku: "first" | "last";
+  product_barcode: "first" | "last";
+  sub_category: "first" | "last";
+  product_groups: "first" | "last";
+  category: "first" | "last";
+  brand: "first" | "last";
+  variant_name: "first" | "last";
+  variant_local_name: "first" | "last";
+  variant_sku: "first" | "last";
+  variant_barcode: "first" | "last";
+  status: "first" | "last";
+  class: "first" | "last";
+  promotions: "first" | "last";
+  promotion_ref: "first" | "last";
+  route: "first" | "last";
+  custom_status: "first" | "last";
+  teams: "first" | "last";
+};
+
+export {
+  SalesAnalyticsReportSortedKey,
+  SalesAnalyticsGroupByIDs,
+  SalesAnalyticsFieldAccumulators,
+  SalesAnalyticsReportFilter,
+  SalesAnalyticsReportProjectionKey,
+};