repzo 1.0.155 → 1.0.157

package/src/oas/activity-feedback.yaml

@@ -0,0 +1,645 @@
+openapi: 3.0.0
+info:
+  title: Activity Feedback API
+  description: API for managing activity feedback
+  version: 1.0.0
+servers:
+  - url: https://api.repzo.me/v1
+    description: Production server
+security:
+  - ApiKeyAuth: []
+tags:
+  - name: Activity Feedback
+    description: Activity feedback management operations
+paths:
+  /activity-feedback:
+    get:
+      tags:
+        - Activity Feedback
+      summary: Get all activity feedback
+      description: Retrieve a list of all activity feedback with optional filtering and pagination
+      parameters:
+        - name: page
+          in: query
+          description: Page number for pagination
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            default: 1
+        - name: per_page
+          in: query
+          description: Number of items per page
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 25
+        - name: sort
+          in: query
+          description: Sort field
+          required: false
+          schema:
+            type: string
+        - name: company_namespace
+          in: query
+          description: Company namespace for filtering
+          required: false
+          schema:
+            type: array
+            items:
+              type: string
+        - name: activity_type
+          in: query
+          description: Filter by activity type
+          required: false
+          schema:
+            type: string
+        - name: rep
+          in: query
+          description: Filter by representative ID
+          required: false
+          schema:
+            type: string
+        - name: client
+          in: query
+          description: Filter by client ID
+          required: false
+          schema:
+            type: string
+        - name: rating
+          in: query
+          description: Filter by rating
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 5
+        - name: _id
+          in: query
+          description: Filter by ID
+          required: false
+          schema:
+            type: array
+            items:
+              type: string
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/ActivityFeedback"
+                  paging:
+                    $ref: "#/components/schemas/PagingInfo"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+    post:
+      tags:
+        - Activity Feedback
+      summary: Create new activity feedback
+      description: Create a new activity feedback entry
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateActivityFeedbackRequest"
+      responses:
+        "201":
+          description: Activity feedback created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ActivityFeedback"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "422":
+          $ref: "#/components/responses/ValidationError"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+  /activity-feedback/{id}:
+    get:
+      tags:
+        - Activity Feedback
+      summary: Get activity feedback by ID
+      description: Retrieve a specific activity feedback by its ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Activity feedback ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ActivityFeedback"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+    patch:
+      tags:
+        - Activity Feedback
+      summary: Update activity feedback
+      description: Update an existing activity feedback
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Activity feedback ID
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateActivityFeedbackRequest"
+      responses:
+        "200":
+          description: Activity feedback updated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ActivityFeedback"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "422":
+          $ref: "#/components/responses/ValidationError"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+    delete:
+      tags:
+        - Activity Feedback
+      summary: Delete activity feedback
+      description: Delete an activity feedback by ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Activity feedback ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Activity feedback deleted successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+  /activity-feedback/analytics:
+    get:
+      tags:
+        - Activity Feedback
+      summary: Get feedback analytics
+      description: Get analytics and statistics for activity feedback
+      parameters:
+        - name: date_from
+          in: query
+          description: Start date for analytics
+          required: false
+          schema:
+            type: string
+            format: date
+        - name: date_to
+          in: query
+          description: End date for analytics
+          required: false
+          schema:
+            type: string
+            format: date
+        - name: activity_type
+          in: query
+          description: Filter by activity type
+          required: false
+          schema:
+            type: string
+        - name: rep
+          in: query
+          description: Filter by representative ID
+          required: false
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Analytics data retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: object
+                    properties:
+                      total_feedback:
+                        type: integer
+                        description: Total feedback count
+                      average_rating:
+                        type: number
+                        format: float
+                        description: Average rating
+                      rating_distribution:
+                        type: object
+                        properties:
+                          "1":
+                            type: integer
+                          "2":
+                            type: integer
+                          "3":
+                            type: integer
+                          "4":
+                            type: integer
+                          "5":
+                            type: integer
+                      by_activity_type:
+                        type: object
+                        additionalProperties:
+                          type: object
+                          properties:
+                            count:
+                              type: integer
+                            average_rating:
+                              type: number
+                              format: float
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+components:
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: Authorization
+      description: "Use format: Bearer {api_key}"
+  schemas:
+    ActivityFeedback:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier
+          example: "507f1f77bcf86cd799439011"
+        activity_type:
+          type: string
+          description: Type of activity this feedback is for
+          example: "sales_visit"
+        activity_id:
+          type: string
+          description: ID of the related activity
+          example: "507f1f77bcf86cd799439012"
+        rep:
+          type: string
+          description: Representative ID
+          example: "507f1f77bcf86cd799439013"
+        client:
+          type: string
+          description: Client ID
+          example: "507f1f77bcf86cd799439014"
+        rating:
+          type: integer
+          description: Feedback rating (1-5 scale)
+          minimum: 1
+          maximum: 5
+          example: 4
+        feedback_text:
+          type: string
+          description: Detailed feedback text
+          example: "Great service, very professional"
+        feedback_categories:
+          type: array
+          items:
+            type: string
+          description: Categories of feedback
+          example: ["service_quality", "timeliness", "professionalism"]
+        sentiment:
+          type: string
+          description: Overall sentiment of the feedback
+          enum: ["positive", "neutral", "negative"]
+          example: "positive"
+        is_anonymous:
+          type: boolean
+          description: Whether the feedback is anonymous
+          example: false
+        source:
+          type: string
+          description: Source of the feedback
+          enum: ["mobile_app", "web_portal", "email", "sms", "phone"]
+          example: "mobile_app"
+        response_time:
+          type: integer
+          description: Time taken to provide feedback (in seconds)
+          example: 120
+        attachments:
+          type: array
+          items:
+            type: object
+            properties:
+              file_url:
+                type: string
+                description: URL to attached file
+              file_type:
+                type: string
+                description: Type of attached file
+              file_size:
+                type: integer
+                description: Size of attached file in bytes
+        follow_up_required:
+          type: boolean
+          description: Whether follow-up is required
+          example: false
+        follow_up_notes:
+          type: string
+          description: Notes for follow-up actions
+        company_namespace:
+          type: array
+          items:
+            type: string
+          description: Company namespace
+        createdAt:
+          type: string
+          format: date-time
+          description: Creation timestamp
+        modifiedAt:
+          type: string
+          format: date-time
+          description: Last modification timestamp
+        SVClient:
+          type: integer
+          description: Client version
+        __v:
+          type: integer
+          description: Document version
+      required:
+        - activity_type
+        - rep
+        - rating
+    CreateActivityFeedbackRequest:
+      type: object
+      properties:
+        activity_type:
+          type: string
+          description: Type of activity this feedback is for
+          example: "sales_visit"
+        activity_id:
+          type: string
+          description: ID of the related activity
+          example: "507f1f77bcf86cd799439012"
+        rep:
+          type: string
+          description: Representative ID
+          example: "507f1f77bcf86cd799439013"
+        client:
+          type: string
+          description: Client ID
+          example: "507f1f77bcf86cd799439014"
+        rating:
+          type: integer
+          description: Feedback rating (1-5 scale)
+          minimum: 1
+          maximum: 5
+          example: 4
+        feedback_text:
+          type: string
+          description: Detailed feedback text
+          example: "Great service, very professional"
+        feedback_categories:
+          type: array
+          items:
+            type: string
+          description: Categories of feedback
+        is_anonymous:
+          type: boolean
+          description: Whether the feedback is anonymous
+          default: false
+        source:
+          type: string
+          description: Source of the feedback
+          enum: ["mobile_app", "web_portal", "email", "sms", "phone"]
+          default: "mobile_app"
+        response_time:
+          type: integer
+          description: Time taken to provide feedback (in seconds)
+        attachments:
+          type: array
+          items:
+            type: object
+            properties:
+              file_url:
+                type: string
+              file_type:
+                type: string
+              file_size:
+                type: integer
+        follow_up_required:
+          type: boolean
+          description: Whether follow-up is required
+          default: false
+        follow_up_notes:
+          type: string
+          description: Notes for follow-up actions
+        company_namespace:
+          type: array
+          items:
+            type: string
+          description: Company namespace
+      required:
+        - activity_type
+        - rep
+        - rating
+    UpdateActivityFeedbackRequest:
+      type: object
+      properties:
+        rating:
+          type: integer
+          description: Feedback rating (1-5 scale)
+          minimum: 1
+          maximum: 5
+        feedback_text:
+          type: string
+          description: Detailed feedback text
+        feedback_categories:
+          type: array
+          items:
+            type: string
+          description: Categories of feedback
+        follow_up_required:
+          type: boolean
+          description: Whether follow-up is required
+        follow_up_notes:
+          type: string
+          description: Notes for follow-up actions
+        company_namespace:
+          type: array
+          items:
+            type: string
+          description: Company namespace
+    PagingInfo:
+      type: object
+      properties:
+        total:
+          type: integer
+          description: Total number of items
+        page:
+          type: integer
+          description: Current page number
+        per_page:
+          type: integer
+          description: Items per page
+        pages:
+          type: integer
+          description: Total number of pages
+  responses:
+    BadRequest:
+      description: Bad request
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: false
+              error:
+                type: string
+                example: "Invalid request parameters"
+    Unauthorized:
+      description: Unauthorized
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: false
+              error:
+                type: string
+                example: "Authentication required"
+    Forbidden:
+      description: Forbidden
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: false
+              error:
+                type: string
+                example: "Insufficient permissions"
+    NotFound:
+      description: Resource not found
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: false
+              error:
+                type: string
+                example: "Resource not found"
+    ValidationError:
+      description: Validation error
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: false
+              error:
+                type: string
+                example: "Validation failed"
+    InternalServerError:
+      description: Internal server error
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: false
+              error:
+                type: string
+                example: "Internal server error"