@gofynd/fdk-client-javascript 1.0.3 → 1.1.0

package/sdk/partner/OAuthClient.js

@@ -0,0 +1,112 @@
+const { fdkAxios } = require("../common/AxiosHelper");
+const { FDKTokenIssueError } = require("../common/FDKError");
+const { Logger } = require("../common/Logger");
+const BaseOAuthClient = require("../common/BaseOAuthClient");
+const querystring = require("querystring");
+const { sign } = require("../common/RequestSigner");
+
+class OAuthClient extends BaseOAuthClient {
+  constructor(config) {
+    super(config);
+  }
+
+  startAuthorization(options) {
+    Logger({ type: "DEBUG", message: "Starting Authorization" });
+    let query = {
+      client_id: this.config.apiKey,
+      scope: options.scope.join(","),
+      redirect_uri: options.redirectUri,
+      state: options.state,
+      access_mode: options.access_mode,
+      response_type: "code",
+      extension_id: this.config.extensionId,
+    };
+    const queryString = querystring.stringify(query);
+
+    let reqPath = `/service/panel/authentication/v1.0/organization/${this.config.organizationId}/oauth/authorize?${queryString}`;
+    let signingOptions = {
+      method: "GET",
+      host: new URL(this.config.domain).host,
+      path: reqPath,
+      body: null,
+      headers: {},
+      signQuery: true,
+    };
+    signingOptions = sign(signingOptions);
+    Logger({ type: "DEBUG", message: "Authorization successful" });
+
+    return `${this.config.domain}${signingOptions.path}`;
+  }
+
+  async verifyCallback(query) {
+    if (query.error) {
+      throw new FDKOAuthCodeError(query.error_description, {
+        error: query.error,
+      });
+    }
+
+    try {
+      let res = await this.getAccesstokenObj({
+        grant_type: "authorization_code",
+        code: query.code,
+      });
+      res.expires_at =
+        res.expires_at || new Date().getTime() + res.expires_in * 1000;
+      this.setToken(res);
+    } catch (error) {
+      if (error.isAxiosError) {
+        throw new FDKTokenIssueError(error.message);
+      }
+      throw error;
+    }
+  }
+
+  async renewAccessToken(isOfflineToken = true) {
+    if (isOfflineToken) {
+      await this.getNewAccessToken();
+    } else {
+      res = await this.getAccesstokenObj({
+        grant_type: "refresh_token",
+        refresh_token: this.refreshToken,
+      });
+      res.expires_at =
+        res.expires_at || new Date().getTime() + res.expires_in * 1000;
+      this.setToken(res);
+      return res;
+    }
+  }
+
+  async getNewAccessToken() {
+    try {
+      let res = await this.getAccesstokenObj({
+        grant_type: "client_credentials",
+        client_id: this.config.apiKey,
+        client_secret: this.config.apiSecret,
+        scope: this.config.scope,
+      });
+      res.expires_at =
+        res.expires_at || new Date().getTime() + res.expires_in * 1000;
+      this.setToken(res);
+      return this.token;
+    } catch (error) {
+      if (error.isAxiosError) {
+        throw new FDKTokenIssueError(error.message);
+      }
+      throw error;
+    }
+  }
+
+  async getAccesstokenObj({ grant_type, client_id, client_secret, scope }) {
+    Logger({ type: "DEBUG", message: "Processing Access token object..." });
+    let reqData = {
+      grant_type: grant_type,
+      client_id,
+      client_secret,
+      scope,
+    };
+    let url = `${this.config.domain}/service/panel/authentication/v1.0/organization/${this.config.organizationId}/oauth/token`;
+    return fdkAxios.post(url, reqData);
+  }
+}
+
+module.exports = OAuthClient;

package/sdk/partner/PartnerAPIClient.d.ts

@@ -0,0 +1,12 @@
+export = APIClient;
+declare class APIClient {
+    /**
+     * @param {object} conf
+     * @param {string} method
+     * @param {string} url
+     * @param {object} query
+     * @param {object} body
+     */
+    static execute(conf: object, method: string, url: string, query: object, body: object): Promise<any>;
+    get(url: any, config: any): Promise<any>;
+}

package/sdk/partner/PartnerAPIClient.js

@@ -0,0 +1,42 @@
+const { fdkAxios } = require("../common/AxiosHelper");
+
+class APIClient {
+  /**
+   * @param {object} conf
+   * @param {string} method
+   * @param {string} url
+   * @param {object} query
+   * @param {object} body
+   */
+  static async execute(conf, method, url, query, body) {
+    const token = await conf.oauthClient.getNewAccessToken();
+
+    const extraHeaders = conf.extraHeaders.reduce((acc, curr) => {
+      acc = { ...acc, ...curr };
+      return acc;
+    }, {});
+
+    const rawRequest = {
+      baseURL: conf.domain,
+      method: method,
+      url: url,
+      params: query,
+      data: body,
+      headers: {
+        Authorization: "Bearer " + token,
+        ...extraHeaders,
+      },
+    };
+
+    return fdkAxios.request(rawRequest);
+  }
+
+  async get(url, config) {
+    let access_token = await this.configuration.getAccessToken();
+    config = config || {};
+    config.headers = config.headers || {};
+    config.headers.Authorization = "Bearer " + access_token;
+    return axios.get(url);
+  }
+}
+module.exports = APIClient;

package/sdk/partner/PartnerClient.d.ts

@@ -0,0 +1,6 @@
+export = PartnerClient;
+declare class PartnerClient {
+    constructor(config: any);
+    config: any;
+    setExtraHeaders(header: any): void;
+}

package/sdk/partner/PartnerClient.js

@@ -0,0 +1,17 @@
+const { FDKClientValidationError } = require("../common/FDKError");
+
+class PartnerClient {
+  constructor(config) {
+    this.config = config;
+  }
+
+  setExtraHeaders(header) {
+    if (typeof header === "object") {
+      this.config.extraHeaders.push(header);
+    } else {
+      throw new FDKClientValidationError("Context value should be an object");
+    }
+  }
+}
+
+module.exports = PartnerClient;

package/sdk/partner/PartnerConfig.d.ts

@@ -0,0 +1,30 @@
+export = PartnerConfig;
+declare class PartnerConfig {
+    /**
+     * @param {Object} config
+     * @param {string} config.companyId
+     * @param {string} config.domain
+     * @param {string} config.apiKey
+     * @param {string} config.apiSecret
+     * @param {boolean} config.useAutoRenewTimer
+     */
+    constructor(config: {
+        companyId: string;
+        domain: string;
+        apiKey: string;
+        apiSecret: string;
+        useAutoRenewTimer: boolean;
+    });
+    organizationId: any;
+    domain: string;
+    apiKey: string;
+    apiSecret: string;
+    scope: any;
+    useAutoRenewTimer: boolean;
+    oauthClient: OauthClient;
+    logLevel: any;
+    extraHeaders: any[];
+    setLogLevel(level: any): void;
+    getAccessToken(): Promise<any>;
+}
+import OauthClient = require("./OAuthClient");

package/sdk/partner/PartnerConfig.js

@@ -0,0 +1,39 @@
+const OauthClient = require("./OAuthClient");
+const { setLoggerLevel } = require("../common/Logger");
+
+class PartnerConfig {
+  /**
+   * @param {Object} config
+   * @param {string} config.companyId
+   * @param {string} config.domain
+   * @param {string} config.apiKey
+   * @param {string} config.apiSecret
+   * @param {boolean} config.useAutoRenewTimer
+   */
+  constructor(config) {
+    this.organizationId = config.organizationId;
+    this.domain = config.domain || "https://api.fynd.com";
+    this.apiKey = config.apiKey;
+    this.apiSecret = config.apiSecret;
+    (this.scope = config.scope),
+      (this.useAutoRenewTimer =
+        config.useAutoRenewTimer !== undefined
+          ? config.useAutoRenewTimer
+          : true);
+    this.oauthClient = new OauthClient(this);
+    this.logLevel = config.logLevel || "ERROR";
+    this.setLogLevel(this.logLevel);
+    this.extraHeaders = [];
+  }
+
+  setLogLevel(level) {
+    setLoggerLevel(level);
+  }
+
+  async getAccessToken() {
+    let token = await this.oauthClient.getAccessToken();
+    return token.access_token;
+  }
+}
+
+module.exports = PartnerConfig;

package/sdk/partner/index.d.ts

@@ -0,0 +1,3 @@
+export const PartnerConfig: typeof import("./PartnerConfig");
+export const PartnerClient: typeof import("./PartnerClient");
+export const PartnerModel: {};

package/sdk/partner/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  PartnerConfig: require("./PartnerConfig"),
+  PartnerClient: require("./PartnerClient"),
+  PartnerModel: {},
+};

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const AnalyticsValidator = require("./AnalyticsPlatformApplicationValidator");
 const AnalyticsModel = require("./AnalyticsPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Analytics {
   constructor(config, applicationId) {
@@ -553,4 +554,5 @@ class Analytics {
     return response;
   }
 }
+
 module.exports = Analytics;

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const AnalyticsModel = require("./AnalyticsPlatformModel");
 
+const AnalyticsModel = require("./AnalyticsPlatformModel");
 class AnalyticsValidator {
   static getAbandonCartDetail() {
     return Joi.object({

package/sdk/platform/Analytics/AnalyticsPlatformClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const AnalyticsValidator = require("./AnalyticsPlatformValidator");
 const AnalyticsModel = require("./AnalyticsPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Analytics {
   constructor(config) {
@@ -247,7 +248,7 @@ class Analytics {
       });
       return data;
     };
-    paginator.setCallback(callback);
+    paginator.setCallback(callback.bind(this));
     return paginator;
   }
 
@@ -352,7 +353,7 @@ class Analytics {
       });
       return data;
     };
-    paginator.setCallback(callback);
+    paginator.setCallback(callback.bind(this));
     return paginator;
   }
 }

package/sdk/platform/Analytics/AnalyticsPlatformValidator.js

@@ -34,4 +34,5 @@ class AnalyticsValidator {
     }).required();
   }
 }
+
 module.exports = AnalyticsValidator;

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const AuditTrailValidator = require("./AuditTrailPlatformValidator");
 const AuditTrailModel = require("./AuditTrailPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class AuditTrail {
   constructor(config) {

package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js

@@ -24,4 +24,5 @@ class AuditTrailValidator {
     return Joi.object({}).required();
   }
 }
+
 module.exports = AuditTrailValidator;

package/sdk/platform/Billing/BillingPlatformClient.d.ts

@@ -46,6 +46,18 @@ declare class Billing {
         plan: string;
         couponCode: string;
     }): Promise<CheckValidityResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension _id
+     * @param {CreateOneTimeCharge} arg.body
+     * @returns {Promise<CreateOneTimeChargeResponse>} - Success response
+     * @summary: Create one time subscription charge
+     * @description: Register one time subscription charge for a seller of your extension.
+     */
+    createOneTimeCharge({ extensionId, body }?: {
+        extensionId: string;
+        body: CreateOneTimeCharge;
+    }): Promise<CreateOneTimeChargeResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.extensionId - Extension _id
@@ -58,6 +70,18 @@ declare class Billing {
         extensionId: string;
         body: CreateSubscriptionCharge;
     }): Promise<CreateSubscriptionResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension _id
+     * @param {string} arg.chargeId - Standalone charge _id
+     * @returns {Promise<OneTimeChargeEntity>} - Success response
+     * @summary: Get subscription charge details
+     * @description: Get created subscription charge details
+     */
+    getChargeDetails({ extensionId, chargeId }?: {
+        extensionId: string;
+        chargeId: string;
+    }): Promise<OneTimeChargeEntity>;
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<SubscriptionCustomer>} - Success response

package/sdk/platform/Billing/BillingPlatformClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const BillingValidator = require("./BillingPlatformValidator");
 const BillingModel = require("./BillingPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Billing {
   constructor(config) {
@@ -280,6 +281,73 @@ class Billing {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.extensionId - Extension _id
+   * @param {CreateOneTimeCharge} arg.body
+   * @returns {Promise<CreateOneTimeChargeResponse>} - Success response
+   * @summary: Create one time subscription charge
+   * @description: Register one time subscription charge for a seller of your extension.
+   */
+  async createOneTimeCharge({ extensionId, body } = {}) {
+    const { error } = BillingValidator.createOneTimeCharge().validate(
+      {
+        extensionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = BillingValidator.createOneTimeCharge().validate(
+      {
+        extensionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createOneTimeCharge",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/billing/v1.0/company/${this.config.companyId}/extension/${extensionId}/one_time_charge`,
+      query_params,
+      body,
+      xHeaders
+    );
+
+    const {
+      error: res_error,
+    } = BillingModel.CreateOneTimeChargeResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createOneTimeCharge",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.extensionId - Extension _id
@@ -349,6 +417,73 @@ class Billing {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.extensionId - Extension _id
+   * @param {string} arg.chargeId - Standalone charge _id
+   * @returns {Promise<OneTimeChargeEntity>} - Success response
+   * @summary: Get subscription charge details
+   * @description: Get created subscription charge details
+   */
+  async getChargeDetails({ extensionId, chargeId } = {}) {
+    const { error } = BillingValidator.getChargeDetails().validate(
+      {
+        extensionId,
+        chargeId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = BillingValidator.getChargeDetails().validate(
+      {
+        extensionId,
+        chargeId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getChargeDetails",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/billing/v1.0/company/${this.config.companyId}/extension/${extensionId}/charge/${chargeId}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+
+    const {
+      error: res_error,
+    } = BillingModel.OneTimeChargeEntity().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getChargeDetails",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<SubscriptionCustomer>} - Success response

package/sdk/platform/Billing/BillingPlatformModel.d.ts

@@ -5,6 +5,8 @@ declare class BillingModel {
     static CancelSubscriptionRes(): any;
     static ChargeLineItem(): any;
     static CheckValidityResponse(): any;
+    static CreateOneTimeCharge(): any;
+    static CreateOneTimeChargeResponse(): any;
     static CreateSubscriptionCharge(): any;
     static CreateSubscriptionResponse(): any;
     static CurrentPeriod(): any;
@@ -34,6 +36,8 @@ declare class BillingModel {
     static InvoicesDataClient(): any;
     static InvoicesDataPaymentMethod(): any;
     static InvoicesDataPeriod(): any;
+    static OneTimeChargeEntity(): any;
+    static OneTimeChargeItem(): any;
     static Page(): any;
     static Phone(): any;
     static Plan(): any;

package/sdk/platform/Billing/BillingPlatformModel.js

@@ -39,6 +39,20 @@ class BillingModel {
       is_valid: Joi.boolean(),
     });
   }
+  static CreateOneTimeCharge() {
+    return Joi.object({
+      charge: BillingModel.OneTimeChargeItem().required(),
+      is_test: Joi.boolean(),
+      name: Joi.string().allow("").required(),
+      return_url: Joi.string().allow("").required(),
+    });
+  }
+  static CreateOneTimeChargeResponse() {
+    return Joi.object({
+      charge: BillingModel.OneTimeChargeEntity(),
+      confirm_url: Joi.string().allow(""),
+    });
+  }
   static CreateSubscriptionCharge() {
     return Joi.object({
       is_test: Joi.boolean(),
@@ -340,6 +354,35 @@ class BillingModel {
       start: Joi.string().allow(""),
     });
   }
+  static OneTimeChargeEntity() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      activated_on: Joi.string().allow(""),
+      cancelled_on: Joi.string().allow(""),
+      entity_id: Joi.string().allow(""),
+      entity_type: Joi.string().allow(""),
+      is_test: Joi.boolean(),
+      meta: Joi.any(),
+      metadata: Joi.any(),
+      name: Joi.string().allow(""),
+      price: BillingModel.EntityChargePrice(),
+      pricing_type: Joi.string().allow(""),
+      return_url: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      subscriber_id: Joi.string().allow(""),
+    });
+  }
+  static OneTimeChargeItem() {
+    return Joi.object({
+      capped_amount: Joi.number(),
+      is_test: Joi.boolean(),
+      metadata: Joi.any(),
+      name: Joi.string().allow("").required(),
+      price: BillingModel.EntityChargePrice().required(),
+      pricing_type: Joi.string().allow("").required(),
+      term: Joi.string().allow(""),
+    });
+  }
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -551,6 +594,7 @@ class BillingModel {
   static SubscriptionStatus() {
     return Joi.object({
       is_enabled: Joi.boolean(),
+      mandate_amount: Joi.number(),
       subscription: BillingModel.Subscription(),
     });
   }

package/sdk/platform/Billing/BillingPlatformValidator.d.ts

@@ -4,7 +4,9 @@ declare class BillingValidator {
     static cancelSubscriptionCharge(): any;
     static cancelSubscriptionPlan(): any;
     static checkCouponValidity(): any;
+    static createOneTimeCharge(): any;
     static createSubscriptionCharge(): any;
+    static getChargeDetails(): any;
     static getCustomerDetail(): any;
     static getFeatureLimitConfig(): any;
     static getInvoiceById(): any;

package/sdk/platform/Billing/BillingPlatformValidator.js

@@ -28,6 +28,13 @@ class BillingValidator {
     }).required();
   }
 
+  static createOneTimeCharge() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      body: BillingModel.CreateOneTimeCharge().required(),
+    }).required();
+  }
+
   static createSubscriptionCharge() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
@@ -35,6 +42,13 @@ class BillingValidator {
     }).required();
   }
 
+  static getChargeDetails() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      chargeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static getCustomerDetail() {
     return Joi.object({}).required();
   }
@@ -70,4 +84,5 @@ class BillingValidator {
     }).required();
   }
 }
+
 module.exports = BillingValidator;