@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

package/sdk/platform/Payment/PaymentPlatformClient.js

@@ -12,15 +12,17 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} [arg.uniqueExternalId] - Fetch payouts using unique external id
-   * @returns {Promise<PayoutsResponse>} - Success response
-   * @summary: Get All Payouts
-   * @description: Get All Payouts
+   * @param {string} arg.uniqueTransferNo - Unique transfer id
+   * @param {UpdatePayoutRequest} arg.body
+   * @returns {Promise<UpdatePayoutResponse>} - Success response
+   * @summary: Partial Update Payout
+   * @description: Partial Update Payout
    */
-  async getAllPayouts({ uniqueExternalId } = {}) {
-    const { error } = PaymentValidator.getAllPayouts().validate(
+  async activateAndDectivatePayout({ uniqueTransferNo, body } = {}) {
+    const { error } = PaymentValidator.activateAndDectivatePayout().validate(
       {
-        uniqueExternalId,
+        uniqueTransferNo,
+        body,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -29,37 +31,40 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = PaymentValidator.getAllPayouts().validate(
+    const {
+      error: warrning,
+    } = PaymentValidator.activateAndDectivatePayout().validate(
       {
-        uniqueExternalId,
+        uniqueTransferNo,
+        body,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getAllPayouts",
+        message:
+          "Parameter Validation warrnings for activateAndDectivatePayout",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["unique_external_id"] = uniqueExternalId;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "get",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts`,
+      "patch",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = PaymentModel.PayoutsResponse().validate(response, {
+    } = PaymentModel.UpdatePayoutResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -67,7 +72,7 @@ class Payment {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getAllPayouts",
+        message: "Response Validation Warnnings for activateAndDectivatePayout",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -77,15 +82,15 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {PayoutRequest} arg.body
-   * @returns {Promise<PayoutResponse>} - Success response
-   * @summary: Save Payout
-   * @description: Save Payout
+   * @param {string} arg.uniqueTransferNo - Unique transfer id
+   * @returns {Promise<DeletePayoutResponse>} - Success response
+   * @summary: Delete Payout
+   * @description: Delete Payout
    */
-  async savePayout({ body } = {}) {
-    const { error } = PaymentValidator.savePayout().validate(
+  async deletePayout({ uniqueTransferNo } = {}) {
+    const { error } = PaymentValidator.deletePayout().validate(
       {
-        body,
+        uniqueTransferNo,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -94,16 +99,16 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = PaymentValidator.savePayout().validate(
+    const { error: warrning } = PaymentValidator.deletePayout().validate(
       {
-        body,
+        uniqueTransferNo,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for savePayout",
+        message: "Parameter Validation warrnings for deletePayout",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -114,16 +119,16 @@ class Payment {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "post",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts`,
+      "delete",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
       query_params,
-      body,
+      undefined,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = PaymentModel.PayoutResponse().validate(response, {
+    } = PaymentModel.DeletePayoutResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -131,7 +136,7 @@ class Payment {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for savePayout",
+        message: "Response Validation Warnnings for deletePayout",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -141,17 +146,22 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.uniqueTransferNo - Unique transfer id
-   * @param {PayoutRequest} arg.body
-   * @returns {Promise<UpdatePayoutResponse>} - Success response
-   * @summary: Update Payout
-   * @description: Update Payout
+   * @param {string} arg.uniqueExternalId -
+   * @param {string} arg.paymentMethodId -
+   * @returns {Promise<DeleteSubscriptionPaymentMethodResponse>} - Success response
+   * @summary: Delete Subscription Payment Method
+   * @description: Uses this api to Delete Subscription Payment Method
    */
-  async updatePayout({ uniqueTransferNo, body } = {}) {
-    const { error } = PaymentValidator.updatePayout().validate(
+  async deleteSubscriptionPaymentMethod({
+    uniqueExternalId,
+    paymentMethodId,
+  } = {}) {
+    const {
+      error,
+    } = PaymentValidator.deleteSubscriptionPaymentMethod().validate(
       {
-        uniqueTransferNo,
-        body,
+        uniqueExternalId,
+        paymentMethodId,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -160,45 +170,51 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = PaymentValidator.updatePayout().validate(
+    const {
+      error: warrning,
+    } = PaymentValidator.deleteSubscriptionPaymentMethod().validate(
       {
-        uniqueTransferNo,
-        body,
+        uniqueExternalId,
+        paymentMethodId,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for updatePayout",
+        message:
+          "Parameter Validation warrnings for deleteSubscriptionPaymentMethod",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["unique_external_id"] = uniqueExternalId;
+    query_params["payment_method_id"] = paymentMethodId;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "put",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
+      "delete",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/methods`,
       query_params,
-      body,
+      undefined,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = PaymentModel.UpdatePayoutResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = PaymentModel.DeleteSubscriptionPaymentMethodResponse().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for updatePayout",
+        message:
+          "Response Validation Warnnings for deleteSubscriptionPaymentMethod",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -208,17 +224,15 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.uniqueTransferNo - Unique transfer id
-   * @param {UpdatePayoutRequest} arg.body
-   * @returns {Promise<UpdatePayoutResponse>} - Success response
-   * @summary: Partial Update Payout
-   * @description: Partial Update Payout
+   * @param {string} [arg.uniqueExternalId] - Fetch payouts using unique external id
+   * @returns {Promise<PayoutsResponse>} - Success response
+   * @summary: Get All Payouts
+   * @description: Get All Payouts
    */
-  async activateAndDectivatePayout({ uniqueTransferNo, body } = {}) {
-    const { error } = PaymentValidator.activateAndDectivatePayout().validate(
+  async getAllPayouts({ uniqueExternalId } = {}) {
+    const { error } = PaymentValidator.getAllPayouts().validate(
       {
-        uniqueTransferNo,
-        body,
+        uniqueExternalId,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -227,40 +241,37 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = PaymentValidator.activateAndDectivatePayout().validate(
+    const { error: warrning } = PaymentValidator.getAllPayouts().validate(
       {
-        uniqueTransferNo,
-        body,
+        uniqueExternalId,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for activateAndDectivatePayout",
+        message: "Parameter Validation warrnings for getAllPayouts",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["unique_external_id"] = uniqueExternalId;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "patch",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
+      "get",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts`,
       query_params,
-      body,
+      undefined,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = PaymentModel.UpdatePayoutResponse().validate(response, {
+    } = PaymentModel.PayoutsResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -268,7 +279,7 @@ class Payment {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for activateAndDectivatePayout",
+        message: "Response Validation Warnnings for getAllPayouts",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -278,16 +289,13 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.uniqueTransferNo - Unique transfer id
-   * @returns {Promise<DeletePayoutResponse>} - Success response
-   * @summary: Delete Payout
-   * @description: Delete Payout
+   * @returns {Promise<SubscriptionConfigResponse>} - Success response
+   * @summary: List Subscription Config
+   * @description: Get all  Subscription Config details
    */
-  async deletePayout({ uniqueTransferNo } = {}) {
-    const { error } = PaymentValidator.deletePayout().validate(
-      {
-        uniqueTransferNo,
-      },
+  async getSubscriptionConfig({} = {}) {
+    const { error } = PaymentValidator.getSubscriptionConfig().validate(
+      {},
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -295,16 +303,16 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = PaymentValidator.deletePayout().validate(
-      {
-        uniqueTransferNo,
-      },
+    const {
+      error: warrning,
+    } = PaymentValidator.getSubscriptionConfig().validate(
+      {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for deletePayout",
+        message: "Parameter Validation warrnings for getSubscriptionConfig",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -315,8 +323,8 @@ class Payment {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "delete",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
+      "get",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/configs`,
       query_params,
       undefined,
       xHeaders
@@ -324,7 +332,7 @@ class Payment {
 
     const {
       error: res_error,
-    } = PaymentModel.DeletePayoutResponse().validate(response, {
+    } = PaymentModel.SubscriptionConfigResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -332,7 +340,7 @@ class Payment {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for deletePayout",
+        message: "Response Validation Warnnings for getSubscriptionConfig",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -411,22 +419,15 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.uniqueExternalId -
-   * @param {string} arg.paymentMethodId -
-   * @returns {Promise<DeleteSubscriptionPaymentMethodResponse>} - Success response
-   * @summary: Delete Subscription Payment Method
-   * @description: Uses this api to Delete Subscription Payment Method
+   * @param {PayoutRequest} arg.body
+   * @returns {Promise<PayoutResponse>} - Success response
+   * @summary: Save Payout
+   * @description: Save Payout
    */
-  async deleteSubscriptionPaymentMethod({
-    uniqueExternalId,
-    paymentMethodId,
-  } = {}) {
-    const {
-      error,
-    } = PaymentValidator.deleteSubscriptionPaymentMethod().validate(
+  async savePayout({ body } = {}) {
+    const { error } = PaymentValidator.savePayout().validate(
       {
-        uniqueExternalId,
-        paymentMethodId,
+        body,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -435,51 +436,44 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = PaymentValidator.deleteSubscriptionPaymentMethod().validate(
+    const { error: warrning } = PaymentValidator.savePayout().validate(
       {
-        uniqueExternalId,
-        paymentMethodId,
+        body,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for deleteSubscriptionPaymentMethod",
+        message: "Parameter Validation warrnings for savePayout",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["unique_external_id"] = uniqueExternalId;
-    query_params["payment_method_id"] = paymentMethodId;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "delete",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/methods`,
+      "post",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts`,
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = PaymentModel.DeleteSubscriptionPaymentMethodResponse().validate(
-      response,
-      { abortEarly: false, allowUnknown: false }
-    );
+    } = PaymentModel.PayoutResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message:
-          "Response Validation Warnnings for deleteSubscriptionPaymentMethod",
+        message: "Response Validation Warnnings for savePayout",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -489,13 +483,16 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @returns {Promise<SubscriptionConfigResponse>} - Success response
-   * @summary: List Subscription Config
-   * @description: Get all  Subscription Config details
+   * @param {SaveSubscriptionSetupIntentRequest} arg.body
+   * @returns {Promise<SaveSubscriptionSetupIntentResponse>} - Success response
+   * @summary: Save Subscription Setup Intent
+   * @description: Uses this api to Save Subscription Setup Intent
    */
-  async getSubscriptionConfig({} = {}) {
-    const { error } = PaymentValidator.getSubscriptionConfig().validate(
-      {},
+  async saveSubscriptionSetupIntent({ body } = {}) {
+    const { error } = PaymentValidator.saveSubscriptionSetupIntent().validate(
+      {
+        body,
+      },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -505,14 +502,17 @@ class Payment {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = PaymentValidator.getSubscriptionConfig().validate(
-      {},
+    } = PaymentValidator.saveSubscriptionSetupIntent().validate(
+      {
+        body,
+      },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getSubscriptionConfig",
+        message:
+          "Parameter Validation warrnings for saveSubscriptionSetupIntent",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -523,16 +523,16 @@ class Payment {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "get",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/configs`,
+      "post",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/setup/intent`,
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = PaymentModel.SubscriptionConfigResponse().validate(response, {
+    } = PaymentModel.SaveSubscriptionSetupIntentResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -540,7 +540,8 @@ class Payment {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getSubscriptionConfig",
+        message:
+          "Response Validation Warnnings for saveSubscriptionSetupIntent",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -550,14 +551,16 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {SaveSubscriptionSetupIntentRequest} arg.body
-   * @returns {Promise<SaveSubscriptionSetupIntentResponse>} - Success response
-   * @summary: Save Subscription Setup Intent
-   * @description: Uses this api to Save Subscription Setup Intent
+   * @param {string} arg.uniqueTransferNo - Unique transfer id
+   * @param {PayoutRequest} arg.body
+   * @returns {Promise<UpdatePayoutResponse>} - Success response
+   * @summary: Update Payout
+   * @description: Update Payout
    */
-  async saveSubscriptionSetupIntent({ body } = {}) {
-    const { error } = PaymentValidator.saveSubscriptionSetupIntent().validate(
+  async updatePayout({ uniqueTransferNo, body } = {}) {
+    const { error } = PaymentValidator.updatePayout().validate(
       {
+        uniqueTransferNo,
         body,
       },
       { abortEarly: false, allowUnknown: true }
@@ -567,10 +570,9 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = PaymentValidator.saveSubscriptionSetupIntent().validate(
+    const { error: warrning } = PaymentValidator.updatePayout().validate(
       {
+        uniqueTransferNo,
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -578,8 +580,7 @@ class Payment {
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for saveSubscriptionSetupIntent",
+        message: "Parameter Validation warrnings for updatePayout",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -590,8 +591,8 @@ class Payment {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "post",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/setup/intent`,
+      "put",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
       query_params,
       body,
       xHeaders
@@ -599,7 +600,7 @@ class Payment {
 
     const {
       error: res_error,
-    } = PaymentModel.SaveSubscriptionSetupIntentResponse().validate(response, {
+    } = PaymentModel.UpdatePayoutResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -607,8 +608,7 @@ class Payment {
     if (res_error) {
       Logger({
         level: "WARN",
-        message:
-          "Response Validation Warnnings for saveSubscriptionSetupIntent",
+        message: "Response Validation Warnnings for updatePayout",
       });
       Logger({ level: "WARN", message: res_error });
     }