chore: update disputes examples and descriptions

dist/paystack.yaml

@@ -3710,7 +3710,7 @@
         default:
           description: Server error
   /storefront:
     post:
       tags:
         - Storefront
       summary: Create Storefront
@@ -3730,7 +3730,7 @@
           $ref: '#/components/responses/Unauthorized'
         default:
           description: Server error
     get:
       tags:
         - Storefront
       summary: List Storefronts
@@ -3767,7 +3767,7 @@
         required: true
         schema:
           type: string
     get:
       tags:
         - Storefront
       summary: Fetch Storefront
@@ -3781,7 +3781,7 @@
           $ref: '#/components/responses/NotFound'
         default:
           description: Server error
     put:
       tags:
         - Storefront
       summary: Update Storefront
@@ -3803,7 +3803,7 @@
           $ref: '#/components/responses/NotFound'
         default:
           description: Server error
     delete:
       tags:
         - Storefront
       summary: Delete Storefront
@@ -3824,7 +3824,7 @@
         required: true
         schema:
           type: string
     get:
       tags:
         - Storefront
       summary: Verify Storefront Slug
@@ -3866,7 +3866,7 @@
         required: true
         schema:
           type: string
     post:
       tags:
         - Storefront
       summary: Add Products to Storefront
@@ -3888,7 +3888,7 @@
           $ref: '#/components/responses/NotFound'
         default:
           description: Server error
     get:
       tags:
         - Storefront
       summary: List Products in Storefront
@@ -3909,7 +3909,7 @@
         required: true
         schema:
           type: string
     post:
       tags:
         - Storefront
       summary: Publish Storefront
@@ -3930,7 +3930,7 @@
         required: true
         schema:
           type: string
     post:
       tags:
         - Storefront
       summary: Duplicate Storefront
@@ -3945,7 +3945,7 @@
         default:
           description: Server error
   /order:
     post:
       tags:
         - Order
       summary: Create Order
@@ -3965,7 +3965,7 @@
           $ref: '#/components/responses/Unauthorized'
         default:
           description: Server error
     get:
       tags:
         - Order
       summary: List Orders
@@ -4009,7 +4009,7 @@
         required: true
         schema:
           type: string
     get:
       tags:
         - Order
       summary: Fetch Order
@@ -4030,7 +4030,7 @@
         required: true
         schema:
           type: string
     get:
       tags:
         - Order
       summary: Fetch Products Order
@@ -4051,7 +4051,7 @@
         required: true
         schema:
           type: string
     get:
       tags:
         - Order
       summary: Validate pay for me order
@@ -4412,8 +4412,8 @@
               $ref: '#/components/schemas/RefundRetry'
       responses:
         '200':
-          $ref: '#/components/responses/RefundCreateSuccess'
-        '401':
+          $ref: '#/components/responses/RefundRetrySuccess'
+        '422':
           $ref: '#/components/responses/Unauthorized'
         default:
           description: Server error
@@ -4446,6 +4446,7 @@
       tags:
         - Dispute
       summary: List Disputes
+      description: List transaction disputes filed by customers
       operationId: dispute_list
       parameters:
         - in: query
@@ -4460,9 +4461,15 @@
             type: integer
         - in: query
           name: status
-          description: Dispute Status. Acceptable values are awaiting-merchant-feedback, awaiting-bank-feedback, pending, resolved
+          description: Dispute status
           schema:
             type: string
+            enum:
+              - awaiting-merchant-feedback
+              - awaiting-bank-feedback
+              - pending
+              - resolved
+          example: awaiting-merchant-feedback
         - in: query
           name: transaction
           description: Transaction ID
@@ -4492,15 +4499,17 @@
   /dispute/{id}:
     parameters:
       - name: id
-        description: Dispute ID
+        description: The unique identifier of the dispute
         in: path
         required: true
         schema:
-          type: string
+          type: integer
+        example: 1801929
     get:
       tags:
         - Dispute
       summary: Fetch Dispute
+      description: Fetch a transaction dispute
       operationId: dispute_fetch
       responses:
         '200':
@@ -4515,6 +4524,7 @@
       tags:
         - Dispute
       summary: Update Dispute
+      description: Update a transaction dispute
       operationId: dispute_update
       requestBody:
         content:
@@ -4537,15 +4547,17 @@
     get:
       tags:
         - Dispute
-      summary: Get Upload URL
+      summary: Fetch Upload URL
+      description: Get the URL to upload a dispute evidence
       operationId: dispute_uploadUrl
       parameters:
         - name: id
-          description: Dispute ID
+          description: The unique identifier of the dispute
           in: path
           required: true
           schema:
-            type: string
+            type: integer
+          example: 4734583785
       responses:
         '200':
           $ref: '#/components/responses/DisputeUploadURLSuccess'
@@ -4560,6 +4572,7 @@
       tags:
         - Dispute
       summary: Export Disputes
+      description: Export the disputes available on your integration
       operationId: dispute_download
       parameters:
         - in: query
@@ -4576,6 +4589,12 @@
           name: status
           schema:
             type: string
+            enum:
+              - awaiting-merchant-feedback
+              - awaiting-bank-feedback
+              - pending
+              - resolved
+          example: awaiting-merchant-feedback
         - in: query
           name: from
           schema:
@@ -4602,14 +4621,16 @@
       tags:
         - Dispute
       summary: List Transaction Disputes
+      description: List all disputes filed for a transaction
       operationId: dispute_transaction
       parameters:
         - name: id
-          description: Transaction ID
+          description: The unique identifier of the transaction
           in: path
           required: true
           schema:
-            type: string
+            type: integer
+          example: 4734583785
       responses:
         '200':
           $ref: '#/components/responses/DisputeListTransactionSuccess'
@@ -4623,15 +4644,17 @@
     put:
       tags:
         - Dispute
-      summary: Resolve a Dispute
+      summary: Resolve Dispute
+      description: Resolve a transaction dispute
       operationId: dispute_resolve
       parameters:
         - name: id
-          description: Dispute ID
+          description: The unique identifier of the dispute
           in: path
           required: true
           schema:
-            type: string
+            type: integer
+          example: 4734583785
       requestBody:
         content:
           application/json:
@@ -4654,6 +4677,7 @@
       tags:
         - Dispute
       summary: Add Evidence
+      description: Provide evidence for a dispute
       operationId: dispute_evidence
       requestBody:
         content:
@@ -4665,11 +4689,12 @@
               $ref: '#/components/schemas/DisputeEvidence'
       parameters:
         - name: id
-          description: Dispute ID
+          description: The unique identifier of the dispute
           in: path
           required: true
           schema:
-            type: string
+            type: integer
+          example: 4734583785
       responses:
         '200':
           $ref: '#/components/responses/DisputeAddEvidenceSuccess'
@@ -16549,6 +16574,95 @@
       properties:
         refund_account_details:
           $ref: '#/components/schemas/RefundRetryAccountDetails'
+    RefundRetryResponse:
+      title: Generated schema for Root
+      type: object
+      properties:
+        status:
+          type: boolean
+        message:
+          type: string
+        data:
+          type: object
+          properties:
+            integration:
+              type: number
+            transaction:
+              type: number
+            dispute:
+              type: object
+            settlement:
+              type: object
+            id:
+              type: number
+            domain:
+              type: string
+            currency:
+              type: string
+            amount:
+              type: number
+            status:
+              type: string
+            refunded_at:
+              type: string
+              nullable: true
+            expected_at:
+              type: string
+            channel:
+              type: string
+            refunded_by:
+              type: string
+            customer_note:
+              type: string
+            merchant_note:
+              type: string
+            deducted_amount:
+              type: number
+            fully_deducted:
+              type: boolean
+            bank_reference:
+              type: string
+              nullable: true
+            reason:
+              type: string
+            customer:
+              type: object
+            initiated_by:
+              type: string
+            reversed_at:
+              type: string
+              nullable: true
+            session_id:
+              type: string
+              nullable: true
+          required:
+            - integration
+            - transaction
+            - dispute
+            - settlement
+            - id
+            - domain
+            - currency
+            - amount
+            - status
+            - refunded_at
+            - expected_at
+            - channel
+            - refunded_by
+            - customer_note
+            - merchant_note
+            - deducted_amount
+            - fully_deducted
+            - bank_reference
+            - reason
+            - customer
+            - initiated_by
+            - reversed_at
+            - session_id
+      required:
+        - status
+        - message
+        - data
     RefundFetchResponse:
       type: object
       properties:
@@ -17240,11 +17354,13 @@
         - refund_amount
       properties:
         refund_amount:
-          description: The amount to refund, in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
-          type: string
+          description: The amount to refund, in the subunit of your currency
+          type: integer
         uploaded_filename:
           description: Filename of attachment returned via response from the Dispute upload URL
           type: string
+      example:
+        refund_amount: 50000
     DisputeUpdateResponse:
       type: object
       properties:
@@ -17810,14 +17926,19 @@
           description: Reason for resolving
           type: string
         refund_amount:
-          description: The amount to refund, in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
-          type: string
+          description: The amount to refund, in the subunit of your integration currency
+          type: integer
         uploaded_filename:
           description: Filename of attachment returned via response from the Dispute upload URL
           type: string
         evidence:
           description: Evidence Id for fraud claims
           type: integer
+      example:
+        resolution: merchant-accepted
+        message: Merchant accepted
+        refund_amount: 50000
+        uploaded_filename: qesp8a4df1xejihd9x5q
     DisputeResolveResponse:
       type: object
       properties:
@@ -17946,6 +18067,11 @@
           description: ISO 8601 representation of delivery date (YYYY-MM-DD)
           type: string
           format: date-time
+      example:
+        customer_email: customer@email.com
+        customer_name: Mensah King
+        customer_phone: '08012345678'
+        service_details: claim for buying cups
     DisputeAddEvidenceResponse:
       type: object
       properties:
@@ -18836,6 +18962,12 @@
         application/json:
           schema:
             $ref: '#/components/schemas/RefundCreateResponse'
+    RefundRetrySuccess:
+      description: Refund Create response
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/RefundRetryResponse'
     RefundFetchSuccess:
       description: Refund Fetch response
       content:
@@ -18861,7 +18993,7 @@
           schema:
             $ref: '#/components/schemas/DisputeUpdateResponse'
     DisputeUploadURLSuccess:
-      description: Dispute Upload U R L response
+      description: Dispute Upload URL response
       content:
         application/json:
           schema:

src/assets/openapi/components/responses/DisputeUploadURLSuccess.yaml

@@ -1,4 +1,4 @@
-description: Dispute Upload U R L response
+description: Dispute Upload URL response
 content:
   application/json:
     schema:

src/assets/openapi/components/responses/RefundRetrySuccess.yaml

@@ -0,0 +1,5 @@
+description: Refund Create response
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/RefundRetryResponse.yaml

src/assets/openapi/components/schemas/DisputeEvidence.yaml

@@ -24,3 +24,9 @@ properties:
     description: ISO 8601 representation of delivery date (YYYY-MM-DD)
     type: string
     format: date-time
+example:
+  customer_email: customer@email.com
+  customer_name: Mensah King
+  customer_phone: '08012345678'
+  service_details: claim for buying cups
+

src/assets/openapi/components/schemas/DisputeResolve.yaml

@@ -12,13 +12,16 @@ properties:
     description: Reason for resolving
     type: string
   refund_amount:
-    description: >-
-      The amount to refund, in kobo if currency is NGN, pesewas, if currency is
-      GHS, and cents, if currency is ZAR
-    type: string
+    description: The amount to refund, in the subunit of your integration currency
+    type: integer
   uploaded_filename:
     description: Filename of attachment returned via response from the Dispute upload URL
     type: string
   evidence:
     description: Evidence Id for fraud claims
     type: integer
+example:
+  resolution: 'merchant-accepted'
+  message: Merchant accepted
+  refund_amount: 50000
+  uploaded_filename: qesp8a4df1xejihd9x5q

src/assets/openapi/components/schemas/DisputeUpdate.yaml

@@ -3,10 +3,10 @@ required:
   - refund_amount
 properties:
   refund_amount:
-    description: >-
-      The amount to refund, in kobo if currency is NGN, pesewas, if currency is
-      GHS, and cents, if currency is ZAR
-    type: string
+    description: The amount to refund, in the subunit of your currency
+    type: integer
   uploaded_filename:
     description: Filename of attachment returned via response from the Dispute upload URL
     type: string
+example:
+  refund_amount: 50000