repzo 1.0.279 → 1.0.281

package/lib/types/index.d.ts

@@ -19106,6 +19106,459 @@ export declare namespace Service {
             type Result = Data;
         }
     }
+    namespace TargetRule {
+        type RuleType = "rep-visit" | "time-clock" | "rep-photo" | "rep-invoice" | "rep-proforma" | "item-status" | "rep-payment";
+        type Period = "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
+        interface Point {
+            ratio: number;
+            points: number;
+        }
+        interface RepVisitFilter {
+            filter: "chain" | "channel" | "country" | "city" | "state" | "client" | "photoTag" | "clientTag" | "areaTag" | "from_total_time" | "to_total_time" | "from_call_total_time" | "to_call_total_time" | "feedback" | "activity" | "speciality";
+            value: any[];
+            photoCount?: number;
+        }
+        interface RepVisitDetails {
+            type?: "rep-visit";
+            filter: RepVisitFilter[];
+            limit?: number;
+            aggregation_key: "count" | "count-distinct" | "duration";
+            period: Period;
+            required_target: {
+                type: "absolute" | "assigned_to";
+                value: number;
+            };
+        }
+        interface TimeClockFilter {
+            filter: "from_startTime" | "to_startTime" | "from_endTime" | "to_endTime" | "from_timeOnDuty" | "to_timeOnDuty" | "from_breaksTime" | "to_breaksTime" | "from_timeInVisits" | "to_timeInVisits" | "from_totalTravelTime" | "to_totalTravelTime" | "from_travelTimeBetweenVisists" | "to_travelTimeBetweenVisists" | "from_scheduled" | "to_scheduled" | "from_unscheduled" | "to_unscheduled" | "from_missed" | "to_missed" | "closed_by_system";
+            value: any;
+        }
+        interface TimeClockDetails {
+            type?: "time-clock";
+            filter: TimeClockFilter[];
+            aggregation_key: "count" | "timeOnDuty" | "breaksTime" | "timeInVisits" | "totalTravelTime" | "travelTimeBetweenVisists" | "scheduled" | "unscheduled" | "missed";
+            period: Period;
+            limit?: number;
+            required_target: {
+                type: "absolute";
+                value: number;
+            };
+        }
+        interface RepPhotoFilter {
+            filter: "chain" | "channel" | "country" | "city" | "state" | "client" | "photoTag" | "clientTag" | "areaTag" | "speciality";
+            value: any[];
+        }
+        interface RepPhotoDetails {
+            type?: "rep-photo";
+            filter: RepPhotoFilter[];
+            limit?: number;
+            aggregation_key: "count" | "count-distinct";
+            period: Period;
+            required_target: {
+                type: "absolute" | "assigned_to";
+                value: number;
+            };
+        }
+        interface ItemStatusFilter {
+            filter: "teams" | "route" | "client" | "chain" | "channel" | "country" | "city" | "state" | "clientTag" | "areaTag" | "speciality" | "product" | "category" | "sub_category" | "brand" | "product_group" | "status" | "previous_status" | "item_status_type";
+            value: any[];
+        }
+        interface ItemStatusDetails {
+            type?: "item-status";
+            filter: ItemStatusFilter[];
+            limit?: number;
+            aggregation_key: "count" | "prescriptions";
+            period: Period;
+            required_target: {
+                type: "absolute";
+                value: number;
+            };
+        }
+        interface RepPaymentFilter {
+            filter: "route" | "payment_type" | "status" | "client" | "chain" | "channel" | "country" | "city" | "clientTag" | "areaTag" | "teams" | "from_amount" | "to_amount" | "speciality" | "custom_status";
+            value: any[];
+        }
+        interface RepPaymentDetails {
+            type?: "rep-payment";
+            filter: RepPaymentFilter[];
+            limit?: number;
+            aggregation_key: "count" | "count-distinct" | "amount";
+            period: Period;
+            required_target: {
+                type: "absolute";
+                value: number;
+            };
+        }
+        interface RepInvoiceFilter {
+            filter: "client" | "chain" | "channel" | "country" | "city" | "state" | "clientTag" | "areaTag" | "teams" | "product" | "variant" | "category" | "sub_category" | "brand" | "product_group" | "status" | "speciality" | "custom_status" | "from_base_unit_qty" | "to_base_unit_qty";
+            value: any[];
+        }
+        interface RepInvoiceDetails {
+            type?: "rep-invoice";
+            filter: RepInvoiceFilter[];
+            limit?: number;
+            aggregation_key: "count" | "total" | "pre_total" | "return_total" | "count-distinct" | "qty";
+            period: Period;
+            required_target: {
+                type: "absolute";
+                value: number;
+            };
+        }
+        interface RepProformaDetails {
+            type?: "rep-proforma";
+            filter: RepInvoiceFilter[];
+            limit?: number;
+            aggregation_key: "count" | "total" | "pre_total" | "return_total" | "count-distinct" | "qty";
+            period: Period;
+            required_target: {
+                type: "absolute";
+                value: number;
+            };
+        }
+        type Details = RepVisitDetails | TimeClockDetails | RepPhotoDetails | ItemStatusDetails | RepPaymentDetails | RepInvoiceDetails | RepProformaDetails;
+        interface Data {
+            _id: StringId;
+            name: string;
+            points: Point[];
+            allowOverOne?: boolean;
+            type: RuleType;
+            disabled: boolean;
+            targets_group?: StringId;
+            company_namespace: string[];
+            details: Details;
+            cycle?: any;
+            createdAt: string;
+            updatedAt: string;
+            __v?: number;
+        }
+        interface CreateBody {
+            company_namespace?: string[];
+            name: string;
+            type: RuleType;
+            details: Details;
+            points?: Point[];
+            allowOverOne?: boolean;
+            targets_group?: StringId;
+            disabled?: boolean;
+        }
+        type UpdateBody = Partial<CreateBody>;
+        namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                _id?: StringId | StringId[];
+                search?: string;
+                name?: string | string[];
+                type?: RuleType | RuleType[];
+                targets_group?: StringId | StringId[];
+                "details.period"?: Period | Period[];
+                disabled?: boolean;
+                from_updatedAt?: number;
+                to_updatedAt?: number;
+                from_createdAt?: number;
+                to_createdAt?: number;
+            };
+            interface Result extends DefaultPaginationResult {
+                data: Data[];
+            }
+        }
+        namespace Get {
+            type ID = StringId;
+            type Result = Data;
+        }
+        namespace Create {
+            type Body = CreateBody;
+            type Result = Data;
+        }
+        namespace Update {
+            type ID = StringId;
+            type Body = UpdateBody;
+            type Result = Data;
+        }
+        namespace Remove {
+            type ID = StringId;
+            type Result = Data;
+        }
+    }
+    namespace Plan {
+        interface Editor {
+            _id: StringId;
+            type: "admin" | "rep";
+            rep?: StringId;
+            admin?: StringId;
+            name?: string;
+        }
+        interface BuildListItem {
+            calendar?: StringId;
+            route?: StringId;
+            client?: StringId;
+            note?: string;
+            from?: string;
+            to?: string;
+            visit_reason?: StringId;
+            visit_note?: string;
+        }
+        interface BuildEntry {
+            day: string;
+            list: BuildListItem[];
+        }
+        interface Data {
+            _id: StringId;
+            name: string;
+            editor?: Editor;
+            startsAt?: string;
+            endsAt?: string;
+            build: BuildEntry[];
+            sync_id: string;
+            calendars?: StringId[];
+            disabled: boolean;
+            builtAt: number;
+            company_namespace: string[];
+            createdAt: string;
+            updatedAt: string;
+            __v?: number;
+        }
+        interface CreateBody {
+            company_namespace?: string[];
+            name: string;
+            startsAt?: string;
+            endsAt?: string;
+            build?: BuildEntry[];
+            sync_id: string;
+            calendars?: StringId[];
+            disabled?: boolean;
+            builtAt?: number;
+        }
+        type UpdateBody = Partial<CreateBody>;
+        namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                _id?: StringId | StringId[];
+                search?: string;
+                name?: string | string[];
+                disabled?: boolean;
+                myDailyPlan?: boolean;
+                timezone?: string;
+                from_updatedAt?: number;
+                to_updatedAt?: number;
+                from_createdAt?: number;
+                to_createdAt?: number;
+                populatedKeys?: string | string[];
+            };
+            interface Result extends DefaultPaginationResult {
+                data: Data[];
+            }
+        }
+        namespace Get {
+            type ID = StringId;
+            type Params = {
+                populatedKeys?: string | string[];
+            };
+            type Result = Data;
+        }
+        namespace Create {
+            type Body = CreateBody;
+            type Result = Data;
+        }
+        namespace Update {
+            type ID = StringId;
+            type Body = UpdateBody;
+            type Result = Data;
+        }
+        namespace Remove {
+            type ID = StringId;
+            type Result = Data;
+        }
+    }
+    namespace Calendar {
+        type CalendarType = "weekly" | "weeklyGroup";
+        interface User {
+            _id: StringId;
+            type: "admin" | "rep";
+            rep?: StringId;
+            admin?: StringId;
+            name?: string;
+        }
+        interface ClientEntry {
+            client: StringId;
+            from?: string;
+            to?: string;
+            visit_reason?: StringId;
+            visit_note?: string;
+        }
+        interface WeeklyDetails {
+            type?: "weekly";
+            days: Day[];
+            every: number;
+        }
+        interface DaysGroup {
+            days: Day[];
+        }
+        interface WeeklyGroupDetails {
+            type?: "weeklyGroup";
+            daysGroups: DaysGroup[];
+            groupSize: number;
+        }
+        type Details = WeeklyDetails | WeeklyGroupDetails;
+        interface Data {
+            _id: StringId;
+            name: string;
+            type: CalendarType;
+            details: Details;
+            creator: User;
+            editor: User;
+            routes?: StringId[];
+            sync_id: string;
+            clients?: ClientEntry[];
+            occurrences?: number;
+            startsAt: string;
+            endsAt?: string;
+            disabled: boolean;
+            note?: string;
+            visit_reason?: StringId;
+            visit_note?: string;
+            company_namespace: string[];
+            createdAt: string;
+            updatedAt: string;
+            __v?: number;
+        }
+        interface CreateBody {
+            company_namespace?: string[];
+            name: string;
+            type: CalendarType;
+            details: Details;
+            sync_id: string;
+            startsAt: string;
+            endsAt?: string;
+            routes?: StringId[];
+            clients?: ClientEntry[];
+            occurrences?: number;
+            disabled?: boolean;
+            note?: string;
+            visit_reason?: StringId;
+            visit_note?: string;
+        }
+        type UpdateBody = Partial<CreateBody>;
+        namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                _id?: StringId | StringId[];
+                search?: string;
+                name?: string | string[];
+                type?: CalendarType | CalendarType[];
+                rep?: StringId | StringId[];
+                plan?: StringId | StringId[];
+                visit_reason?: StringId | StringId[];
+                groupSize?: number;
+                from_groupSize?: number;
+                to_groupSize?: number;
+                disabled?: boolean;
+                from_updatedAt?: number;
+                to_updatedAt?: number;
+                from_createdAt?: number;
+                to_createdAt?: number;
+                populatedKeys?: string | string[];
+            };
+            interface Result extends DefaultPaginationResult {
+                data: Data[];
+            }
+        }
+        namespace Get {
+            type ID = StringId;
+            type Params = {
+                populatedKeys?: string | string[];
+            };
+            type Result = Data;
+        }
+        namespace Create {
+            type Body = CreateBody;
+            type Params = {
+                assignTo?: StringId;
+                assignedToMe?: boolean;
+            };
+            type Result = Data;
+        }
+        namespace Update {
+            type ID = StringId;
+            type Body = UpdateBody;
+            type Result = Data;
+        }
+        namespace Remove {
+            type ID = StringId;
+            type Result = Data;
+        }
+    }
+    namespace LineTarget {
+        export type UserType = "rep" | "client";
+        export interface User {
+            _id: StringId;
+            name?: string;
+            type?: UserType;
+            rep?: StringId;
+            client?: StringId;
+        }
+        export interface Data {
+            _id: StringId;
+            line: StringId;
+            target: number;
+            classification: StringId;
+            user?: User;
+            company_namespace: string[];
+            createdAt: string;
+            updatedAt: string;
+            __v?: number;
+        }
+        export interface CreateBody {
+            company_namespace?: string[];
+            line: StringId;
+            target: number;
+            classification: StringId;
+            user?: User;
+        }
+        export type UpdateBody = Partial<CreateBody>;
+        type PopulatedKeys = "client" | "rep" | "classification" | "line";
+        export namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                populatedKeys?: PopulatedKeys | PopulatedKeys[];
+                _id?: StringId | StringId[];
+                line?: StringId | StringId[];
+                classification?: StringId | StringId[];
+                "user._id"?: StringId | StringId[];
+                rep?: StringId | StringId[];
+                client?: StringId | StringId[];
+                from_updatedAt?: number;
+                to_updatedAt?: number;
+                from_createdAt?: number;
+                to_createdAt?: number;
+            };
+            interface Result extends DefaultPaginationResult {
+                data: Data[];
+            }
+        }
+        export namespace Get {
+            type ID = StringId;
+            type Params = {
+                populatedKeys?: PopulatedKeys | PopulatedKeys[];
+            };
+            type Result = Data;
+        }
+        export namespace Create {
+            type Body = CreateBody;
+            type Result = Data;
+        }
+        export namespace Update {
+            type ID = StringId;
+            type Body = UpdateBody;
+            type Result = Data;
+        }
+        export namespace Remove {
+            type ID = StringId | null;
+            type Params = {
+                all?: boolean;
+            };
+            interface Result {
+                deletedCount: number;
+                success: number;
+            }
+        }
+        export {};
+    }
     namespace BulkImport {
         type BulkImportType = "insertTags" | "insertClients" | "insertReps" | "updateReps" | "updateClients" | "insertProducts" | "insertVariants" | "updateProducts" | "updateVariants" | "updateCategories" | "updateSubCategories" | "insertCategories" | "insertSubCategories" | "insertAvailabilityMsl" | "updateAvailabilityMsl" | "updateAvailabilityMslWithProducts" | "updateMslWithVariants" | "insertJobCategories" | "updateJobCategories" | "updateJobs" | "insertJobs" | "updateTags" | "insertRoutes" | "updateRoutes" | "updateRoutesWithClients" | "insertPlans" | "updatePlans" | "updatePlansWithRules" | "weeklyGroupRules" | "weeklyRules" | "updateRulesWithRoutes" | "updateTargetRulesWithClients" | "updateTargetRulesWithReps" | "insertTransfers" | "adjustAccounts" | "insertRules" | "updateRules" | "insertInvoices" | "insertWarehouses" | "updateWarehouses" | "insertProductGroups" | "updateProductGroups" | "updatePriceListItems" | "updateMeasureunit" | "insertMeasureunit" | "insertMeasureunitFamily" | "updateMeasureunitFamily" | "insertLineTarget" | "clientLineClassification" | "updateLineTarget" | "insertReceivingMaterials" | "insertRetailExecutionPresets" | "updateRetailExecutionPresets" | "insertCustomListItems" | "updateCustomListItems" | "insertAssets" | "updateAssets" | "insertAssetUnits" | "updateAssetUnits" | "insertSpeciality" | "updateSpeciality" | "insertClientLocation" | "updateClientLocation" | "deleteLineTarget" | "updatePromotions" | "insertReminders" | "updateReminders" | "insertVariantBatch" | "updateVariantBatch" | "insertSettlements" | "updateClientUblInfo" | "insertSuppliers" | "updateSuppliers" | "insertTargetRules" | "insertContractInstallments" | "updateContractInstallments" | "insertContracts" | "updateContracts" | "insertAssetPartTypes" | "updateAssetPartTypes" | "insertAssetParts" | "updateAssetParts";
         interface ToBeInserted {

package/package.json

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