@gofynd/fdk-client-javascript 1.0.4 → 1.1.1

package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts

@@ -86,6 +86,30 @@ declare class Payment {
     getUserOrderBeneficiaries({ orderId }?: {
         orderId: string;
     }): Promise<OrderBeneficiaryResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.aggregator - Aggregator
+     * @param {string} [arg.successRedirectUrl] -
+     * @param {string} [arg.failureRedirectUrl] -
+     * @returns {Promise<GetOauthUrlResponse>} - Success response
+     * @summary: API to Get the url to call for oauth
+     * @description: Use this API to Get the url to call for oauth.
+     */
+    oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, }?: {
+        aggregator: string;
+        successRedirectUrl?: string;
+        failureRedirectUrl?: string;
+    }): Promise<GetOauthUrlResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.aggregator - Aggregator_slug
+     * @returns {Promise<RevokeOAuthToken>} - Success response
+     * @summary: API to Revoke oauth for razorpay partnership
+     * @description: Use this API to Revoke oauth for razorpay partnership
+     */
+    revokeOauthToken({ aggregator }?: {
+        aggregator: string;
+    }): Promise<RevokeOAuthToken>;
     /**
      * @param {Object} arg - Arg object.
      * @param {PaymentGatewayConfigRequest} arg.body
@@ -106,14 +130,4 @@ declare class Payment {
     setUserCODlimitRoutes({ body }?: {
         body: SetCODForUserRequest;
     }): Promise<SetCODOptionResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {PaymentGatewayConfigRequest} arg.body
-     * @returns {Promise<PaymentGatewayToBeReviewed>} - Success response
-     * @summary: Save Config Secret For Brand Payment Gateway
-     * @description: Save Config Secret For Brand Payment Gateway
-     */
-    updateBrandPaymentGatewayConfig({ body }?: {
-        body: PaymentGatewayConfigRequest;
-    }): Promise<PaymentGatewayToBeReviewed>;
 }

package/sdk/platform/Payment/PaymentPlatformApplicationClient.js

@@ -532,15 +532,23 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {PaymentGatewayConfigRequest} arg.body
-   * @returns {Promise<PaymentGatewayToBeReviewed>} - Success response
-   * @summary: Save Config Secret For Brand Payment Gateway
-   * @description: Save Config Secret For Brand Payment Gateway
+   * @param {string} arg.aggregator - Aggregator
+   * @param {string} [arg.successRedirectUrl] -
+   * @param {string} [arg.failureRedirectUrl] -
+   * @returns {Promise<GetOauthUrlResponse>} - Success response
+   * @summary: API to Get the url to call for oauth
+   * @description: Use this API to Get the url to call for oauth.
    */
-  async saveBrandPaymentGatewayConfig({ body } = {}) {
-    const { error } = PaymentValidator.saveBrandPaymentGatewayConfig().validate(
+  async oauthGetUrl({
+    aggregator,
+    successRedirectUrl,
+    failureRedirectUrl,
+  } = {}) {
+    const { error } = PaymentValidator.oauthGetUrl().validate(
       {
-        body,
+        aggregator,
+        successRedirectUrl,
+        failureRedirectUrl,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -549,36 +557,37 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = PaymentValidator.saveBrandPaymentGatewayConfig().validate(
+    const { error: warrning } = PaymentValidator.oauthGetUrl().validate(
       {
-        body,
+        aggregator,
+        successRedirectUrl,
+        failureRedirectUrl,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for saveBrandPaymentGatewayConfig",
+        message: "Parameter Validation warrnings for oauthGetUrl",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["success_redirect_url"] = successRedirectUrl;
+    query_params["failure_redirect_url"] = failureRedirectUrl;
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "post",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/aggregator/request`,
+      "get",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/onboard/${aggregator}/`,
       query_params,
-      body
+      undefined
     );
 
     const {
       error: res_error,
-    } = PaymentModel.PaymentGatewayToBeReviewed().validate(response, {
+    } = PaymentModel.GetOauthUrlResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -586,8 +595,7 @@ class Payment {
     if (res_error) {
       Logger({
         level: "WARN",
-        message:
-          "Response Validation Warnnings for saveBrandPaymentGatewayConfig",
+        message: "Response Validation Warnnings for oauthGetUrl",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -597,15 +605,15 @@ class Payment {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {SetCODForUserRequest} arg.body
-   * @returns {Promise<SetCODOptionResponse>} - Success response
-   * @summary: Set COD option for user for payment
-   * @description: Use this API to set cod option as true or false for the payment
+   * @param {string} arg.aggregator - Aggregator_slug
+   * @returns {Promise<RevokeOAuthToken>} - Success response
+   * @summary: API to Revoke oauth for razorpay partnership
+   * @description: Use this API to Revoke oauth for razorpay partnership
    */
-  async setUserCODlimitRoutes({ body } = {}) {
-    const { error } = PaymentValidator.setUserCODlimitRoutes().validate(
+  async revokeOauthToken({ aggregator } = {}) {
+    const { error } = PaymentValidator.revokeOauthToken().validate(
       {
-        body,
+        aggregator,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -614,18 +622,16 @@ class Payment {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = PaymentValidator.setUserCODlimitRoutes().validate(
+    const { error: warrning } = PaymentValidator.revokeOauthToken().validate(
       {
-        body,
+        aggregator,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for setUserCODlimitRoutes",
+        message: "Parameter Validation warrnings for revokeOauthToken",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -634,15 +640,15 @@ class Payment {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "put",
-      `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/payment/user-cod`,
+      "post",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/revoke/${aggregator}/`,
       query_params,
-      body
+      undefined
     );
 
     const {
       error: res_error,
-    } = PaymentModel.SetCODOptionResponse().validate(response, {
+    } = PaymentModel.RevokeOAuthToken().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -650,7 +656,7 @@ class Payment {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for setUserCODlimitRoutes",
+        message: "Response Validation Warnnings for revokeOauthToken",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -665,10 +671,8 @@ class Payment {
    * @summary: Save Config Secret For Brand Payment Gateway
    * @description: Save Config Secret For Brand Payment Gateway
    */
-  async updateBrandPaymentGatewayConfig({ body } = {}) {
-    const {
-      error,
-    } = PaymentValidator.updateBrandPaymentGatewayConfig().validate(
+  async saveBrandPaymentGatewayConfig({ body } = {}) {
+    const { error } = PaymentValidator.saveBrandPaymentGatewayConfig().validate(
       {
         body,
       },
@@ -681,7 +685,7 @@ class Payment {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = PaymentValidator.updateBrandPaymentGatewayConfig().validate(
+    } = PaymentValidator.saveBrandPaymentGatewayConfig().validate(
       {
         body,
       },
@@ -691,7 +695,7 @@ class Payment {
       Logger({
         level: "WARN",
         message:
-          "Parameter Validation warrnings for updateBrandPaymentGatewayConfig",
+          "Parameter Validation warrnings for saveBrandPaymentGatewayConfig",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -700,7 +704,7 @@ class Payment {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "put",
+      "post",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/aggregator/request`,
       query_params,
       body
@@ -717,7 +721,70 @@ class Payment {
       Logger({
         level: "WARN",
         message:
-          "Response Validation Warnnings for updateBrandPaymentGatewayConfig",
+          "Response Validation Warnnings for saveBrandPaymentGatewayConfig",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {SetCODForUserRequest} arg.body
+   * @returns {Promise<SetCODOptionResponse>} - Success response
+   * @summary: Set COD option for user for payment
+   * @description: Use this API to set cod option as true or false for the payment
+   */
+  async setUserCODlimitRoutes({ body } = {}) {
+    const { error } = PaymentValidator.setUserCODlimitRoutes().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentValidator.setUserCODlimitRoutes().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for setUserCODlimitRoutes",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/payment/user-cod`,
+      query_params,
+      body
+    );
+
+    const {
+      error: res_error,
+    } = PaymentModel.SetCODOptionResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for setUserCODlimitRoutes",
       });
       Logger({ level: "WARN", message: res_error });
     }

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts

@@ -8,7 +8,8 @@ declare class PaymentValidator {
     static getUserBeneficiaries(): any;
     static getUserCODlimitRoutes(): any;
     static getUserOrderBeneficiaries(): any;
+    static oauthGetUrl(): any;
+    static revokeOauthToken(): any;
     static saveBrandPaymentGatewayConfig(): any;
     static setUserCODlimitRoutes(): any;
-    static updateBrandPaymentGatewayConfig(): any;
 }

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js

@@ -51,23 +51,31 @@ class PaymentValidator {
     }).required();
   }
 
-  static saveBrandPaymentGatewayConfig() {
+  static oauthGetUrl() {
     return Joi.object({
-      body: PaymentModel.PaymentGatewayConfigRequest().required(),
+      aggregator: Joi.string().allow("").required(),
+      successRedirectUrl: Joi.string().allow(""),
+      failureRedirectUrl: Joi.string().allow(""),
     }).required();
   }
 
-  static setUserCODlimitRoutes() {
+  static revokeOauthToken() {
     return Joi.object({
-      body: PaymentModel.SetCODForUserRequest().required(),
+      aggregator: Joi.string().allow("").required(),
     }).required();
   }
 
-  static updateBrandPaymentGatewayConfig() {
+  static saveBrandPaymentGatewayConfig() {
     return Joi.object({
       body: PaymentModel.PaymentGatewayConfigRequest().required(),
     }).required();
   }
+
+  static setUserCODlimitRoutes() {
+    return Joi.object({
+      body: PaymentModel.SetCODForUserRequest().required(),
+    }).required();
+  }
 }
 
 module.exports = PaymentValidator;

package/sdk/platform/Payment/PaymentPlatformModel.d.ts

@@ -7,6 +7,7 @@ declare class PaymentModel {
     static DeleteSubscriptionPaymentMethodResponse(): any;
     static ErrorCodeAndDescription(): any;
     static ErrorCodeDescription(): any;
+    static GetOauthUrlResponse(): any;
     static GetUserCODLimitResponse(): any;
     static HttpErrorCodeAndResponse(): any;
     static IfscCodeResponse(): any;
@@ -32,6 +33,7 @@ declare class PaymentModel {
     static PayoutResponse(): any;
     static PayoutsResponse(): any;
     static RefundAccountResponse(): any;
+    static RevokeOAuthToken(): any;
     static RootPaymentMode(): any;
     static SaveSubscriptionSetupIntentRequest(): any;
     static SaveSubscriptionSetupIntentResponse(): any;

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -48,6 +48,12 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+  static GetOauthUrlResponse() {
+    return Joi.object({
+      success: Joi.boolean().required(),
+      url: Joi.string().allow("").required(),
+    });
+  }
   static GetUserCODLimitResponse() {
     return Joi.object({
       success: Joi.boolean().required(),
@@ -296,6 +302,12 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+  static RevokeOAuthToken() {
+    return Joi.object({
+      message: Joi.string().allow("").required(),
+      success: Joi.boolean().required(),
+    });
+  }
   static RootPaymentMode() {
     return Joi.object({
       add_card_enabled: Joi.boolean().allow(null),