repzo 1.0.279 → 1.0.280

package/package.json

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

package/src/index.ts

@@ -149,6 +149,10 @@ export const end_points = {
   JOB_CATEGORY: "job-category",
   JOB_CATEGORY_AUTOSKIP_ANALYZE: "job-category-autoskip-analyze",
   VISIT_REASON: "visit-reason",
+  TARGET_RULE: "target-rule",
+  PLAN: "plan",
+  CALENDAR: "calendar",
+  LINE_TARGET: "line-target",
   BULK_IMPORT: "bulk-import",
 } as const;
 export type EndPoints = (typeof end_points)[keyof typeof end_points];
@@ -250,6 +254,11 @@ export const availableService = [
   "clmFetch",
   "pdfMergeField",
   "visitReason",
+  "targetRule",
+  "plan",
+  "calendar",
+  "lineTarget",
+  "bulkImport",
 ] as const;
 export type AvailableService = (typeof availableService)[number];
 
@@ -7007,6 +7016,220 @@ export default class Repzo {
     },
   };
 
+  targetRule = {
+    _path: Repzo._end_points.TARGET_RULE,
+    find: async (
+      params?: Service.TargetRule.Find.Params,
+    ): Promise<Service.TargetRule.Find.Result> => {
+      let res: Service.TargetRule.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.targetRule._path,
+        params,
+      );
+      return res;
+    },
+    get: async (
+      id: Service.TargetRule.Get.ID,
+    ): Promise<Service.TargetRule.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.targetRule._path + `/${id}`,
+      );
+    },
+    create: async (
+      body: Service.TargetRule.Create.Body,
+    ): Promise<Service.TargetRule.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.targetRule._path,
+        body,
+      );
+      return res;
+    },
+    update: async (
+      id: Service.TargetRule.Update.ID,
+      body: Service.TargetRule.Update.Body,
+    ): Promise<Service.TargetRule.Update.Result> => {
+      let res: Service.TargetRule.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.targetRule._path + `/${id}`,
+        body,
+      );
+      return res;
+    },
+    remove: async (
+      id: Service.TargetRule.Remove.ID,
+    ): Promise<Service.TargetRule.Remove.Result> => {
+      let res: Service.TargetRule.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.targetRule._path + `/${id}`,
+      );
+      return res;
+    },
+  };
+
+  plan = {
+    _path: Repzo._end_points.PLAN,
+    find: async (
+      params?: Service.Plan.Find.Params,
+    ): Promise<Service.Plan.Find.Result> => {
+      let res: Service.Plan.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.plan._path,
+        params,
+      );
+      return res;
+    },
+    get: async (
+      id: Service.Plan.Get.ID,
+      params?: Service.Plan.Get.Params,
+    ): Promise<Service.Plan.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.plan._path + `/${id}`,
+        params,
+      );
+    },
+    create: async (
+      body: Service.Plan.Create.Body,
+    ): Promise<Service.Plan.Create.Result> => {
+      let res = await this._create(this.svAPIEndpoint, this.plan._path, body);
+      return res;
+    },
+    update: async (
+      id: Service.Plan.Update.ID,
+      body: Service.Plan.Update.Body,
+    ): Promise<Service.Plan.Update.Result> => {
+      let res: Service.Plan.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.plan._path + `/${id}`,
+        body,
+      );
+      return res;
+    },
+    remove: async (
+      id: Service.Plan.Remove.ID,
+    ): Promise<Service.Plan.Remove.Result> => {
+      let res: Service.Plan.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.plan._path + `/${id}`,
+      );
+      return res;
+    },
+  };
+
+  calendar = {
+    _path: Repzo._end_points.CALENDAR,
+    find: async (
+      params?: Service.Calendar.Find.Params,
+    ): Promise<Service.Calendar.Find.Result> => {
+      let res: Service.Calendar.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.calendar._path,
+        params,
+      );
+      return res;
+    },
+    get: async (
+      id: Service.Calendar.Get.ID,
+      params?: Service.Calendar.Get.Params,
+    ): Promise<Service.Calendar.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.calendar._path + `/${id}`,
+        params,
+      );
+    },
+    create: async (
+      body: Service.Calendar.Create.Body,
+      params?: Service.Calendar.Create.Params,
+    ): Promise<Service.Calendar.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.calendar._path,
+        body,
+        params,
+      );
+      return res;
+    },
+    update: async (
+      id: Service.Calendar.Update.ID,
+      body: Service.Calendar.Update.Body,
+    ): Promise<Service.Calendar.Update.Result> => {
+      let res: Service.Calendar.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.calendar._path + `/${id}`,
+        body,
+      );
+      return res;
+    },
+    remove: async (
+      id: Service.Calendar.Remove.ID,
+    ): Promise<Service.Calendar.Remove.Result> => {
+      let res: Service.Calendar.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.calendar._path + `/${id}`,
+      );
+      return res;
+    },
+  };
+
+  lineTarget = {
+    _path: Repzo._end_points.LINE_TARGET,
+    find: async (
+      params?: Service.LineTarget.Find.Params,
+    ): Promise<Service.LineTarget.Find.Result> => {
+      let res: Service.LineTarget.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.lineTarget._path,
+        params,
+      );
+      return res;
+    },
+    get: async (
+      id: Service.LineTarget.Get.ID,
+      params?: Service.LineTarget.Get.Params,
+    ): Promise<Service.LineTarget.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.lineTarget._path + `/${id}`,
+        params,
+      );
+    },
+    create: async (
+      body: Service.LineTarget.Create.Body,
+    ): Promise<Service.LineTarget.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.lineTarget._path,
+        body,
+      );
+      return res;
+    },
+    update: async (
+      id: Service.LineTarget.Update.ID,
+      body: Service.LineTarget.Update.Body,
+    ): Promise<Service.LineTarget.Update.Result> => {
+      let res: Service.LineTarget.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.lineTarget._path + `/${id}`,
+        body,
+      );
+      return res;
+    },
+    remove: async (
+      id: Service.LineTarget.Remove.ID,
+      params?: Service.LineTarget.Remove.Params,
+    ): Promise<Service.LineTarget.Remove.Result> => {
+      let res: Service.LineTarget.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.lineTarget._path + (id ? `/${id}` : ""),
+        params,
+      );
+      return res;
+    },
+  };
+
   bulkImport = {
     _path: Repzo._end_points.BULK_IMPORT,
     find: async (

package/src/oas/calendar.yaml

@@ -0,0 +1,329 @@
+openapi: 3.0.3
+info:
+  title: Repzo API - Calendar
+  version: 1.0.0
+  description: OpenAPI specification for Repzo Calendar endpoints.
+servers:
+  - url: https://sv.api.repzo.me
+paths:
+  /calendar:
+    get:
+      summary: Find calendars
+      operationId: findCalendars
+      parameters:
+        - in: query
+          name: params
+          schema:
+            type: object
+          description: Query parameters for filtering calendars
+      responses:
+        "200":
+          description: A list of calendars
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CalendarFindResult"
+    post:
+      summary: Create a calendar
+      operationId: createCalendar
+      parameters:
+        - in: query
+          name: assignTo
+          schema:
+            type: string
+          description: Plan ID to assign the new calendar to
+        - in: query
+          name: assignedToMe
+          schema:
+            type: boolean
+          description: When true, assigns the new calendar to the current rep's assigned plan
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CalendarCreateBody"
+      responses:
+        "201":
+          description: Calendar created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CalendarCreateResult"
+  /calendar/{id}:
+    get:
+      summary: Get a calendar by ID
+      operationId: getCalendar
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Calendar details
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CalendarGetResult"
+    put:
+      summary: Update a calendar
+      operationId: updateCalendar
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CalendarUpdateBody"
+      responses:
+        "200":
+          description: Calendar updated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CalendarUpdateResult"
+    delete:
+      summary: Disable a calendar
+      operationId: removeCalendar
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Calendar disabled
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CalendarRemoveResult"
+components:
+  schemas:
+    CalendarType:
+      type: string
+      enum: [weekly, weeklyGroup]
+    CalendarDay:
+      type: string
+      enum: [Sun, Mon, Tue, Wed, Thu, Fri, Sat]
+    CalendarUser:
+      type: object
+      properties:
+        _id:
+          type: string
+        type:
+          type: string
+          enum: [admin, rep]
+        rep:
+          type: string
+        admin:
+          type: string
+        name:
+          type: string
+    CalendarClientEntry:
+      type: object
+      properties:
+        client:
+          type: string
+        from:
+          type: string
+        to:
+          type: string
+        visit_reason:
+          type: string
+        visit_note:
+          type: string
+    CalendarWeeklyDetails:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: [weekly]
+        days:
+          type: array
+          items:
+            $ref: "#/components/schemas/CalendarDay"
+        every:
+          type: number
+    CalendarDaysGroup:
+      type: object
+      properties:
+        days:
+          type: array
+          items:
+            $ref: "#/components/schemas/CalendarDay"
+    CalendarWeeklyGroupDetails:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: [weeklyGroup]
+        daysGroups:
+          type: array
+          items:
+            $ref: "#/components/schemas/CalendarDaysGroup"
+        groupSize:
+          type: number
+    CalendarDetails:
+      oneOf:
+        - $ref: "#/components/schemas/CalendarWeeklyDetails"
+        - $ref: "#/components/schemas/CalendarWeeklyGroupDetails"
+    CalendarFindResult:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/Calendar"
+        meta:
+          type: object
+    CalendarCreateBody:
+      type: object
+      required:
+        - name
+        - type
+        - details
+        - sync_id
+        - startsAt
+      properties:
+        name:
+          type: string
+        type:
+          $ref: "#/components/schemas/CalendarType"
+        details:
+          $ref: "#/components/schemas/CalendarDetails"
+        sync_id:
+          type: string
+        startsAt:
+          type: string
+          description: "Date in YYYY-MM-DD format"
+        endsAt:
+          type: string
+          description: "Date in YYYY-MM-DD format"
+        routes:
+          type: array
+          items:
+            type: string
+        clients:
+          type: array
+          items:
+            $ref: "#/components/schemas/CalendarClientEntry"
+        occurrences:
+          type: number
+        disabled:
+          type: boolean
+        note:
+          type: string
+        visit_reason:
+          type: string
+        visit_note:
+          type: string
+    CalendarCreateResult:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/Calendar"
+    CalendarGetResult:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/Calendar"
+    CalendarUpdateBody:
+      type: object
+      properties:
+        name:
+          type: string
+        type:
+          $ref: "#/components/schemas/CalendarType"
+        details:
+          $ref: "#/components/schemas/CalendarDetails"
+        sync_id:
+          type: string
+        startsAt:
+          type: string
+        endsAt:
+          type: string
+        routes:
+          type: array
+          items:
+            type: string
+        clients:
+          type: array
+          items:
+            $ref: "#/components/schemas/CalendarClientEntry"
+        occurrences:
+          type: number
+        disabled:
+          type: boolean
+        note:
+          type: string
+        visit_reason:
+          type: string
+        visit_note:
+          type: string
+    CalendarUpdateResult:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/Calendar"
+    CalendarRemoveResult:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/Calendar"
+    Calendar:
+      type: object
+      properties:
+        _id:
+          type: string
+        name:
+          type: string
+        type:
+          $ref: "#/components/schemas/CalendarType"
+        details:
+          $ref: "#/components/schemas/CalendarDetails"
+        creator:
+          $ref: "#/components/schemas/CalendarUser"
+        editor:
+          $ref: "#/components/schemas/CalendarUser"
+        routes:
+          type: array
+          items:
+            type: string
+        sync_id:
+          type: string
+        clients:
+          type: array
+          items:
+            $ref: "#/components/schemas/CalendarClientEntry"
+        occurrences:
+          type: number
+        startsAt:
+          type: string
+        endsAt:
+          type: string
+        disabled:
+          type: boolean
+        note:
+          type: string
+        visit_reason:
+          type: string
+        visit_note:
+          type: string
+        company_namespace:
+          type: array
+          items:
+            type: string
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time