Skip to content

Commit 8474ed7

Browse files
authored
jsdoc
1 parent a2298ec commit 8474ed7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/ApiPayloadConverter.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,9 @@ class ApiPayloadConverter {
9595

9696
/**
9797
* @description Converts the mail payload for the ZeptoMail.
98-
* @param {Object} originalPayload The original payload (provider agnostic). originalPayload has two components 1. api and 2. payload.
98+
* @param {Object} originalPayload The original payload
99+
* @param {String} originalPayload.api The provider API version.
100+
* @param {String} originalPayload.payload The payload to convert to be compatible with the provider API.
99101
* @returns {Object} The payload according to ZeptoMail SDK specification.
100102
*/
101103
static zeptomail(originalPayload) {

0 commit comments

Comments
 (0)