Merge pull request #54 from PaystackOSS/patch-transfer-recipient

chore: update transfer recipient examples and descriptions

Author: damilola-paystack

dist/paystack.yaml

@@ -2756,6 +2756,7 @@ paths:
       tags:
         - Transfer Recipient
       summary: Create Transfer Recipient
+      description: Creates a new recipient. A duplicate account number will lead to the retrieval of the existing record.
       operationId: transferrecipient_create
       requestBody:
         content:
@@ -2780,6 +2781,7 @@ paths:
       tags:
         - Transfer Recipient
       summary: List Transfer Recipients
+      description: List transfer recipients available on your integration
       operationId: transferrecipient_list
       parameters:
         - in: query
@@ -2827,6 +2829,8 @@ paths:
       tags:
         - Transfer Recipient
       summary: Bulk Create Transfer Recipient
+      description: |
+        Create multiple transfer recipients in batches. A duplicate account number will lead to the retrieval of the existing record.
       operationId: transferrecipient_bulk
       requestBody:
         content:
@@ -2838,7 +2842,7 @@ paths:
               $ref: '#/components/schemas/TransferRecipientBulk'
       responses:
         '200':
-          description: ''
+          description: Sucessful response
           content:
             application/json:
               schema:
@@ -2855,14 +2859,16 @@ paths:
         required: true
         schema:
           type: string
+        example: RCP_5ap8rcimmcj8lbi
     get:
       tags:
         - Transfer Recipient
       summary: Fetch Transfer recipient
+      description: Fetch the details of a transfer recipient
       operationId: transferrecipient_fetch
       responses:
         '200':
-          description: ''
+          description: Successful response
           content:
             application/json:
               schema:
@@ -2876,7 +2882,8 @@ paths:
     put:
       tags:
         - Transfer Recipient
-      summary: Update Transfer recipient
+      summary: Update Transfer Recipient
+      description: Update the details of a transfer recipient
       operationId: transferrecipient_update
       requestBody:
         content:
@@ -2888,7 +2895,7 @@ paths:
               $ref: '#/components/schemas/TransferRecipientUpdate'
       responses:
         '200':
-          description: ''
+          description: Successful response
           content:
             application/json:
               schema:
@@ -2903,10 +2910,11 @@ paths:
       tags:
         - Transfer Recipient
       summary: Delete Transfer Recipient
+      description: Delete a transfer recipient (sets the transfer recipient to inactive)
       operationId: transferrecipient_delete
       responses:
         '200':
-          description: ''
+          description: Successful response
           content:
             application/json:
               schema:
@@ -11526,10 +11534,15 @@ components:
       properties:
         type:
           description: Recipient Type
-          default: nuban
           type: string
+          enum:
+            - nuban
+            - ghipss
+            - mobile_money
+            - basa
+            - authorization
         name:
-          description: Recipient's name
+          description: The recipient's name according to their account registration.
           type: string
         account_number:
           description: Recipient's bank account number
@@ -11549,6 +11562,11 @@ components:
         metadata:
           description: JSON object of custom data
           type: object
+      example:
+        type: nuban
+        name: Smith Taplo
+        account_number: '01000000010'
+        bank_code: '058'
     TransferRecipientCreateResponse:
       type: object
       properties:

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

@@ -7,10 +7,15 @@ required:
 properties:
   type:
     description: Recipient Type
-    default: nuban
     type: string
+    enum: 
+      - nuban
+      - ghipss
+      - mobile_money
+      - basa
+      - authorization
   name:
-    description: Recipient's name
+    description: The recipient's name according to their account registration.
     type: string
   account_number:
     description: Recipient's bank account number
@@ -32,3 +37,8 @@ properties:
   metadata:
     description: JSON object of custom data
     type: object
+example: 
+  type: nuban
+  name: Smith Taplo
+  account_number: '01000000010'
+  bank_code: '058'

src/assets/openapi/paths/transferrecipient.yaml

@@ -2,6 +2,7 @@ post:
   tags:
     - Transfer Recipient
   summary: Create Transfer Recipient
+  description: Creates a new recipient. A duplicate account number will lead to the retrieval of the existing record.
   operationId: transferrecipient_create
   requestBody:
     content:
@@ -26,6 +27,7 @@ get:
   tags:
     - Transfer Recipient
   summary: List Transfer Recipients
+  description: List transfer recipients available on your integration
   operationId: transferrecipient_list
   parameters:
     - in: query

src/assets/openapi/paths/transferrecipient_bulk.yaml

@@ -2,6 +2,8 @@ post:
   tags:
     - Transfer Recipient
   summary: Bulk Create Transfer Recipient
+  description: | 
+    Create multiple transfer recipients in batches. A duplicate account number will lead to the retrieval of the existing record.
   operationId: transferrecipient_bulk
   requestBody:
     content:
@@ -13,7 +15,7 @@ post:
           $ref: ../components/schemas/TransferRecipientBulk.yaml
   responses:
     '200':
-      description: ''
+      description: 'Sucessful response'
       content:
         application/json:
           schema:

src/assets/openapi/paths/transferrecipient_{code}.yaml

@@ -5,14 +5,16 @@ parameters:
     required: true
     schema:
       type: string
+    example: RCP_5ap8rcimmcj8lbi
 get:
   tags:
     - Transfer Recipient
   summary: Fetch Transfer recipient
+  description: Fetch the details of a transfer recipient
   operationId: transferrecipient_fetch
   responses:
     '200':
-      description: ''
+      description: 'Successful response'
       content:
         application/json:
           schema:
@@ -26,7 +28,8 @@ get:
 put:
   tags:
     - Transfer Recipient
-  summary: Update Transfer recipient
+  summary: Update Transfer Recipient
+  description: Update the details of a transfer recipient
   operationId: transferrecipient_update
   requestBody:
     content:
@@ -38,7 +41,7 @@ put:
           $ref: ../components/schemas/TransferRecipientUpdate.yaml
   responses:
     '200':
-      description: ''
+      description: 'Successful response'
       content:
         application/json:
           schema:
@@ -53,10 +56,11 @@ delete:
   tags:
     - Transfer Recipient
   summary: Delete Transfer Recipient
+  description: Delete a transfer recipient (sets the transfer recipient to inactive)
   operationId: transferrecipient_delete
   responses:
     '200':
-      description: ''
+      description: 'Successful response'
       content:
         application/json:
           schema: