repzo 1.0.279 → 1.0.280

package/src/types/index.ts

@@ -21491,6 +21491,612 @@ export namespace Service {
     }
   }
 
+  export namespace TargetRule {
+    export type RuleType =
+      | "rep-visit"
+      | "time-clock"
+      | "rep-photo"
+      | "rep-invoice"
+      | "rep-proforma"
+      | "item-status"
+      | "rep-payment";
+
+    export type Period =
+      | "daily"
+      | "weekly"
+      | "monthly"
+      | "quarterly"
+      | "yearly";
+
+    export interface Point {
+      ratio: number;
+      points: number;
+    }
+
+    export 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;
+    }
+    export 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;
+      };
+    }
+
+    export 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;
+    }
+    export 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;
+      };
+    }
+
+    export interface RepPhotoFilter {
+      filter:
+        | "chain"
+        | "channel"
+        | "country"
+        | "city"
+        | "state"
+        | "client"
+        | "photoTag"
+        | "clientTag"
+        | "areaTag"
+        | "speciality";
+      value: any[];
+    }
+    export interface RepPhotoDetails {
+      type?: "rep-photo";
+      filter: RepPhotoFilter[];
+      limit?: number;
+      aggregation_key: "count" | "count-distinct";
+      period: Period;
+      required_target: {
+        type: "absolute" | "assigned_to";
+        value: number;
+      };
+    }
+
+    export 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[];
+    }
+    export interface ItemStatusDetails {
+      type?: "item-status";
+      filter: ItemStatusFilter[];
+      limit?: number;
+      aggregation_key: "count" | "prescriptions";
+      period: Period;
+      required_target: {
+        type: "absolute";
+        value: number;
+      };
+    }
+
+    export interface RepPaymentFilter {
+      filter:
+        | "route"
+        | "payment_type"
+        | "status"
+        | "client"
+        | "chain"
+        | "channel"
+        | "country"
+        | "city"
+        | "clientTag"
+        | "areaTag"
+        | "teams"
+        | "from_amount"
+        | "to_amount"
+        | "speciality"
+        | "custom_status";
+      value: any[];
+    }
+    export interface RepPaymentDetails {
+      type?: "rep-payment";
+      filter: RepPaymentFilter[];
+      limit?: number;
+      aggregation_key: "count" | "count-distinct" | "amount";
+      period: Period;
+      required_target: {
+        type: "absolute";
+        value: number;
+      };
+    }
+
+    export 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[];
+    }
+    export 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;
+      };
+    }
+    export 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;
+      };
+    }
+
+    export type Details =
+      | RepVisitDetails
+      | TimeClockDetails
+      | RepPhotoDetails
+      | ItemStatusDetails
+      | RepPaymentDetails
+      | RepInvoiceDetails
+      | RepProformaDetails;
+
+    export 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;
+    }
+    export interface CreateBody {
+      company_namespace?: string[];
+      name: string;
+      type: RuleType;
+      details: Details;
+      points?: Point[];
+      allowOverOne?: boolean;
+      targets_group?: StringId;
+      disabled?: boolean;
+    }
+    export type UpdateBody = Partial<CreateBody>;
+
+    export namespace Find {
+      export 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;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+    export namespace Get {
+      export type ID = StringId;
+      export type Result = Data;
+    }
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+    export namespace Update {
+      export type ID = StringId;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+    export namespace Remove {
+      export type ID = StringId;
+      export type Result = Data;
+    }
+  }
+
+  export namespace Plan {
+    export interface Editor {
+      _id: StringId;
+      type: "admin" | "rep";
+      rep?: StringId;
+      admin?: StringId;
+      name?: string;
+    }
+    export interface BuildListItem {
+      calendar?: StringId;
+      route?: StringId;
+      client?: StringId;
+      note?: string;
+      from?: string;
+      to?: string;
+      visit_reason?: StringId;
+      visit_note?: string;
+    }
+    export interface BuildEntry {
+      day: string;
+      list: BuildListItem[];
+    }
+    export 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;
+    }
+    export interface CreateBody {
+      company_namespace?: string[];
+      name: string;
+      startsAt?: string;
+      endsAt?: string;
+      build?: BuildEntry[];
+      sync_id: string;
+      calendars?: StringId[];
+      disabled?: boolean;
+      builtAt?: number;
+    }
+    export type UpdateBody = Partial<CreateBody>;
+
+    export namespace Find {
+      export 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[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+    export namespace Get {
+      export type ID = StringId;
+      export type Params = { populatedKeys?: string | string[] };
+      export type Result = Data;
+    }
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+    export namespace Update {
+      export type ID = StringId;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+    export namespace Remove {
+      export type ID = StringId;
+      export type Result = Data;
+    }
+  }
+
+  export namespace Calendar {
+    export type CalendarType = "weekly" | "weeklyGroup";
+
+    export interface User {
+      _id: StringId;
+      type: "admin" | "rep";
+      rep?: StringId;
+      admin?: StringId;
+      name?: string;
+    }
+    export interface ClientEntry {
+      client: StringId;
+      from?: string;
+      to?: string;
+      visit_reason?: StringId;
+      visit_note?: string;
+    }
+    export interface WeeklyDetails {
+      type?: "weekly";
+      days: Day[];
+      every: number;
+    }
+    export interface DaysGroup {
+      days: Day[];
+    }
+    export interface WeeklyGroupDetails {
+      type?: "weeklyGroup";
+      daysGroups: DaysGroup[];
+      groupSize: number;
+    }
+    export type Details = WeeklyDetails | WeeklyGroupDetails;
+
+    export 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;
+    }
+    export 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;
+    }
+    export type UpdateBody = Partial<CreateBody>;
+
+    export namespace Find {
+      export 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[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+    export namespace Get {
+      export type ID = StringId;
+      export type Params = { populatedKeys?: string | string[] };
+      export type Result = Data;
+    }
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Params = {
+        assignTo?: StringId;
+        assignedToMe?: boolean;
+      };
+      export type Result = Data;
+    }
+    export namespace Update {
+      export type ID = StringId;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+    export namespace Remove {
+      export type ID = StringId;
+      export type Result = Data;
+    }
+  }
+
+  export namespace 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 {
+      export 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;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+    export namespace Get {
+      export type ID = StringId;
+      export type Params = { populatedKeys?: PopulatedKeys | PopulatedKeys[] };
+      export type Result = Data;
+    }
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+    export namespace Update {
+      export type ID = StringId;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+    export namespace Remove {
+      export type ID = StringId | null;
+      export type Params = { all?: boolean };
+      export interface Result {
+        deletedCount: number;
+        success: number;
+      }
+    }
+  }
+
   export namespace BulkImport {
     type BulkImportType =
       | "insertTags"