[Issue #3694] Add Sorting To Saved Opportunity

api/openapi.generated.yml

@@ -495,7 +495,7 @@ paths:
       security:
       - ApiJwtAuth: []
   /v1/users/{user_id}/saved-opportunities:
-    get:
+    post:
       parameters:
       - in: path
         name: user_id
@@ -507,8 +507,14 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UserSavedOpportunitiesResponse'
+                $ref: '#/components/schemas/UserSaveOpportunityResponse'
           description: Successful response
+        '422':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          description: Validation error
         '401':
           content:
             application/json:
@@ -523,9 +529,15 @@ paths:
           description: Not found
       tags:
       - User v1
-      summary: User Get Saved Opportunities
+      summary: User Save Opportunity
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserSaveOpportunityRequest'
       security:
       - ApiJwtAuth: []
+  /v1/users/{user_id}/saved-searches/list:
     post:
       parameters:
       - in: path
@@ -538,7 +550,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UserSaveOpportunityResponse'
+                $ref: '#/components/schemas/UserSavedSearchesResponse'
           description: Successful response
         '422':
           content:
@@ -560,15 +572,15 @@ paths:
           description: Not found
       tags:
       - User v1
-      summary: User Save Opportunity
+      summary: User Get Saved Searches
       requestBody:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/UserSaveOpportunityRequest'
+              $ref: '#/components/schemas/UserSavedSearchesRequest'
       security:
       - ApiJwtAuth: []
-  /v1/users/{user_id}/saved-searches/list:
+  /v1/users/{user_id}/saved-opportunities/list:
     post:
       parameters:
       - in: path
@@ -581,7 +593,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UserSavedSearchesResponse'
+                $ref: '#/components/schemas/UserSavedOpportunitiesResponse'
           description: Successful response
         '422':
           content:
@@ -603,12 +615,12 @@ paths:
           description: Not found
       tags:
       - User v1
-      summary: User Get Saved Searches
+      summary: User Get Saved Opportunities
       requestBody:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/UserSavedSearchesRequest'
+              $ref: '#/components/schemas/UserSavedOpportunitiesRequest'
       security:
       - ApiJwtAuth: []
   /v1/users/{user_id}/saved-searches/{saved_search_id}:
@@ -2176,71 +2188,6 @@ components:
           type: integer
           description: The HTTP status code
           example: 200
-    SavedOpportunitySummaryV1:
-      type: object
-      properties:
-        post_date:
-          type: string
-          format: date
-          description: The date the opportunity was posted
-          example: '2024-01-01'
-        close_date:
-          type: string
-          format: date
-          description: The date the opportunity will close
-          example: '2024-01-01'
-        is_forecast:
-          type: boolean
-          description: Whether the opportunity is forecasted
-          example: false
-    SavedOpportunityResponseV1:
-      type: object
-      properties:
-        opportunity_id:
-          type: integer
-          description: The ID of the saved opportunity
-          example: 1234
-        opportunity_title:
-          type:
-          - string
-          - 'null'
-          description: The title of the opportunity
-          example: my title
-        opportunity_status:
-          description: The current status of the opportunity
-          example: !!python/object/apply:src.constants.lookup_constants.OpportunityStatus
-          - posted
-          enum:
-          - forecasted
-          - posted
-          - closed
-          - archived
-          type:
-          - string
-        summary:
-          type:
-          - object
-          allOf:
-          - $ref: '#/components/schemas/SavedOpportunitySummaryV1'
-    UserSavedOpportunitiesResponse:
-      type: object
-      properties:
-        message:
-          type: string
-          description: The message to return
-          example: Success
-        data:
-          type: array
-          description: List of saved opportunities
-          items:
-            type:
-            - object
-            allOf:
-            - $ref: '#/components/schemas/SavedOpportunityResponseV1'
-        status_code:
-          type: integer
-          description: The HTTP status code
-          example: 200
     UserSaveOpportunityRequest:
       type: object
       properties:
@@ -2363,6 +2310,132 @@ components:
           type: integer
           description: The HTTP status code
           example: 200
+    SortOrderUserGetSavedOpportunityPaginationV1:
+      type: object
+      properties:
+        order_by:
+          type: string
+          enum:
+          - created_at
+          - updated_at
+          - opportunity_title
+          - close_date
+          description: The field to sort the response by
+        sort_direction:
+          description: Whether to sort the response ascending or descending
+          enum:
+          - ascending
+          - descending
+          type:
+          - string
+      required:
+      - order_by
+      - sort_direction
+    UserGetSavedOpportunityPaginationV1:
+      type: object
+      properties:
+        sort_order:
+          type: array
+          default:
+          - order_by: created_at
+            sort_direction: descending
+          minItems: 1
+          maxItems: 5
+          description: The list of sorting rules
+          items:
+            type:
+            - object
+            allOf:
+            - $ref: '#/components/schemas/SortOrderUserGetSavedOpportunityPaginationV1'
+        page_size:
+          type: integer
+          minimum: 1
+          maximum: 5000
+          description: The size of the page to fetch
+          example: 25
+        page_offset:
+          type: integer
+          minimum: 1
+          description: The page number to fetch, starts counting from 1
+          example: 1
+      required:
+      - page_offset
+      - page_size
+    UserSavedOpportunitiesRequest:
+      type: object
+      properties:
+        pagination:
+          type:
+          - object
+          allOf:
+          - $ref: '#/components/schemas/UserGetSavedOpportunityPaginationV1'
+      required:
+      - pagination
+    SavedOpportunitySummaryV1:
+      type: object
+      properties:
+        post_date:
+          type: string
+          format: date
+          description: The date the opportunity was posted
+          example: '2024-01-01'
+        close_date:
+          type: string
+          format: date
+          description: The date the opportunity will close
+          example: '2024-01-01'
+        is_forecast:
+          type: boolean
+          description: Whether the opportunity is forecasted
+          example: false
+    SavedOpportunityResponseV1:
+      type: object
+      properties:
+        opportunity_id:
+          type: integer
+          description: The ID of the saved opportunity
+          example: 1234
+        opportunity_title:
+          type:
+          - string
+          - 'null'
+          description: The title of the opportunity
+          example: my title
+        opportunity_status:
+          description: The current status of the opportunity
+          example: !!python/object/apply:src.constants.lookup_constants.OpportunityStatus
+          - posted
+          enum:
+          - forecasted
+          - posted
+          - closed
+          - archived
+          type:
+          - string
+        summary:
+          type:
+          - object
+          allOf:
+          - $ref: '#/components/schemas/SavedOpportunitySummaryV1'
+    UserSavedOpportunitiesResponse:
+      type: object
+      properties:
+        message:
+          type: string
+          description: The message to return
+          example: Success
+        data:
+          type: array
+          description: List of saved opportunities
+          items:
+            type:
+            - object
+            allOf:
+            - $ref: '#/components/schemas/SavedOpportunityResponseV1'
+        status_code:
+          type: integer
+          description: The HTTP status code
+          example: 200
     UserUpdateSavedSearchRequest:
       type: object
       properties:

api/src/api/users/user_routes.py

@@ -14,6 +14,7 @@
     UserDeleteSavedOpportunityResponseSchema,
     UserDeleteSavedSearchResponseSchema,
     UserGetResponseSchema,
+    UserSavedOpportunitiesRequestSchema,
     UserSavedOpportunitiesResponseSchema,
     UserSavedSearchesRequestSchema,
     UserSavedSearchesResponseSchema,
@@ -225,13 +226,16 @@ def user_delete_saved_opportunity(
     return response.ApiResponse(message="Success")
 
 
-@user_blueprint.get("/<uuid:user_id>/saved-opportunities")
+@user_blueprint.post("/<uuid:user_id>/saved-opportunities/list")
+@user_blueprint.input(UserSavedOpportunitiesRequestSchema, location="json")
 @user_blueprint.output(UserSavedOpportunitiesResponseSchema)
 @user_blueprint.doc(responses=[200, 401])
 @user_blueprint.auth_required(api_jwt_auth)
 @flask_db.with_db_session()
-def user_get_saved_opportunities(db_session: db.Session, user_id: UUID) -> response.ApiResponse:
-    logger.info("GET /v1/users/:user_id/saved-opportunities")
+def user_get_saved_opportunities(
+    db_session: db.Session, user_id: UUID, json_data: dict
+) -> response.ApiResponse:
+    logger.info("POST /v1/users/:user_id/saved-opportunities/list")
 
     user_token_session: UserTokenSession = api_jwt_auth.get_user_token_session()
 
@@ -240,9 +244,13 @@ def user_get_saved_opportunities(db_session: db.Session, user_id: UUID) -> respo
         raise_flask_error(401, "Unauthorized user")
 
     # Get all saved opportunities for the user with their related opportunity data
-    saved_opportunities = get_saved_opportunities(db_session, user_id)
+    saved_opportunities, pagination_info = get_saved_opportunities(db_session, user_id, json_data)
 
-    return response.ApiResponse(message="Success", data=saved_opportunities)
+    return response.ApiResponse(
+        message="Success",
+        data=saved_opportunities,
+        pagination_info=pagination_info,
+    )
 
 
 @user_blueprint.post("/<uuid:user_id>/saved-searches")

api/src/api/users/user_schemas.py

@@ -86,6 +86,17 @@ class UserDeleteSavedOpportunityResponseSchema(AbstractResponseSchema):
     data = fields.MixinField(metadata={"example": None})
 
 
+class UserSavedOpportunitiesRequestSchema(Schema):
+    pagination = fields.Nested(
+        generate_pagination_schema(
+            "UserGetSavedOpportunityPaginationV1Schema",
+            ["created_at", "updated_at", "opportunity_title", "close_date"],
+            default_sort_order=[{"order_by": "created_at", "sort_direction": "descending"}],
+        ),
+        required=True,
+    )
+
+
 class UserSavedOpportunitiesResponseSchema(AbstractResponseSchema):
     data = fields.List(
         fields.Nested(SavedOpportunityResponseV1Schema),