feat: Add spec for api to list archived cards in the statement upload (#801)

* feat: Add spec for api to list archived cards in the statement upload

* Auto generate API docs

Author: madangopal122

reference/admin.yaml

@@ -11606,6 +11606,61 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/404'
+  /admin/statements/archived_cards:
+    post:
+      tags:
+        - Statements
+      summary: Archived cards present in Sage Exp Mgmt
+      description: |
+        Returns archived cards present in Sage Exp Mgmt for cards in Statement
+      operationId: archived_cards
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data:
+                  $ref: '#/components/schemas/statement_archived_cards_in'
+              required:
+                - data
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/statement_archived_cards_out'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400'
+        '401':
+          description: Unauthorized request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401'
+        '403':
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/403'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404'
   /admin/expense_rules:
     post:
       tags:
@@ -30998,6 +31053,57 @@ components:
           description: |
             RTF Confidence percentage indicates what % of the transactions in last uploaded statement are already existing in Sage Exp Mgmt via RTF.
           example: 99.22
+    statement_archived_cards_in:
+      allOf:
+        - $ref: '#/components/schemas/summary_from_statement_in'
+        - type: object
+          properties:
+            card_mapping:
+              $ref: '#/components/schemas/card_mapping_in'
+          required:
+            - card_mapping
+    statement_archived_cards_out:
+      properties:
+        number_of_cards:
+          type: integer
+          description: |
+            Number of cards in the statement
+          example: 3
+        number_of_archived_cards:
+          type: integer
+          description: |
+            Number of cards in the statement that are archived in Sage Exp Mgmt
+          example: 1
+        archived_cards:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
+                allOf:
+                  - $ref: '#/components/schemas/id_string'
+                example: bawownwrng
+              card_number:
+                $ref: '#/components/schemas/card_number'
+              nickname:
+                type: string
+                maxLength: 25
+                nullable: true
+                description: |
+                  Unique nickname assigned to the card
+                example: Business Card
+              user:
+                $ref: '#/components/schemas/user_out_embed_nullable'
+              is_archived:
+                type: boolean
+                description: |
+                  If the card is archived in Sage Exp Mgmt
+                nullable: false
+              archived_at:
+                $ref: '#/components/schemas/timestamptz_utc'
+                description: |
+                  Timestamp when the card was archived in Sage Exp Mgmt
+                nullable: true
     expense_rule_if_out:
       type: object
       additionalProperties: false

src/admin/openapi.yaml

@@ -524,6 +524,8 @@ paths:
     $ref: paths/admin@statements@create_card_transactions.yaml
   /admin/statements/rtf_stats:
     $ref: paths/admin@statements@rtf_stats.yaml
+  /admin/statements/archived_cards:
+    $ref: paths/admin@statements@archived_cards.yaml
   /admin/expense_rules:
     $ref: paths/admin@expense_rules.yaml
   /admin/expense_rules/dismiss_suggestion:

src/admin/paths/admin@statements@archived_cards.yaml

@@ -0,0 +1,54 @@
+post:
+  tags:
+    - Statements
+  summary: Archived cards present in Sage Exp Mgmt
+  description: |
+    Returns archived cards present in Sage Exp Mgmt for cards in Statement
+  operationId: archived_cards
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            data:
+              $ref: '../../components/schemas/statements.yaml#/statement_archived_cards_in'
+          required:
+            - data
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              data:
+                type: array
+                items:
+                  $ref: '../../components/schemas/statements.yaml#/statement_archived_cards_out'
+    '400':
+      description: Bad request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/400.yaml'
+    '401':
+      description: Unauthorized request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/401.yaml'
+    '403':
+      description: Forbidden
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/403.yaml'
+    '404':
+      description: Not Found
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/404.yaml'

src/components/schemas/statements.yaml

@@ -1320,3 +1320,57 @@ unassigned_cards_from_statement_in:
       example: stmtwownwrng
   required:
     - statement_id
+
+statement_archived_cards_out:
+  properties:
+    number_of_cards:
+      type: integer
+      description: |
+        Number of cards in the statement
+      example: 3
+    number_of_archived_cards:
+      type: integer
+      description: |
+        Number of cards in the statement that are archived in Sage Exp Mgmt
+      example: 1
+    archived_cards:
+      type: array
+      items:
+        type: object
+        properties:
+          id:
+            allOf:
+              - $ref: './fields.yaml#/id_string'
+            example: bawownwrng
+          card_number:
+            $ref: './fields.yaml#/card_number'
+          nickname:
+            type: string
+            maxLength: 25
+            nullable: true
+            description: |
+              Unique nickname assigned to the card
+            example: 'Business Card'
+          user:
+            $ref: ./user.yaml#/user_out_embed_nullable
+          is_archived:
+            type: boolean
+            description: |
+              If the card is archived in Sage Exp Mgmt
+            nullable: false
+          archived_at:
+            $ref: './fields.yaml#/timestamptz_utc'
+            description: |
+              Timestamp when the card was archived in Sage Exp Mgmt
+            nullable: true
+
+
+statement_archived_cards_in:
+  allOf:
+    - $ref: '#/summary_from_statement_in'
+    - type: object
+      properties:
+        card_mapping:
+          $ref: '#/card_mapping_in'
+      required:
+        - card_mapping