@gofynd/fdk-client-javascript 1.1.3 → 1.1.4

package/README.md

@@ -184,6 +184,7 @@ import { ApplicationConfig, ApplicationClient } from "fdk-client-javascript";
 ### Documentation
 
 - [Application Front](documentation/application/README.md)
+- [Partner Front](documentation/partner/README.md)
 - [Platform Front](documentation/platform/README.md)
 - [Public Front](documentation/public/README.md)
 

package/index.d.ts

@@ -1,6 +1,9 @@
 import { ApplicationConfig } from "./sdk/application";
 import { ApplicationClient } from "./sdk/application";
 import { ApplicationModel } from "./sdk/application";
+import { PartnerConfig } from "./sdk/partner";
+import { PartnerClient } from "./sdk/partner";
+import { PartnerModel } from "./sdk/partner";
 import { PlatformConfig } from "./sdk/platform";
 import { PlatformClient } from "./sdk/platform";
 import { PlatformModel } from "./sdk/platform";
@@ -10,4 +13,4 @@ import { PublicModel } from "./sdk/public";
 import { fdkAxios } from "./sdk/common/AxiosHelper";
 import Utility = require("./sdk/common/Utility");
 import Constant = require("./sdk/common/Constant");
-export { ApplicationConfig, ApplicationClient, ApplicationModel, PlatformConfig, PlatformClient, PlatformModel, PublicConfig, PublicClient, PublicModel, fdkAxios as FdkAxios, Utility, Constant };
+export { ApplicationConfig, ApplicationClient, ApplicationModel, PartnerConfig, PartnerClient, PartnerModel, PlatformConfig, PlatformClient, PlatformModel, PublicConfig, PublicClient, PublicModel, fdkAxios as FdkAxios, Utility, Constant };

package/index.js

@@ -1,6 +1,7 @@
 
 
 const { ApplicationConfig, ApplicationClient, ApplicationModel } = require('./sdk/application'); 
+const { PartnerConfig, PartnerClient, PartnerModel } = require('./sdk/partner'); 
 const { PlatformConfig, PlatformClient, PlatformModel } = require('./sdk/platform'); 
 const { PublicConfig, PublicClient, PublicModel } = require('./sdk/public'); 
 const {fdkAxios} = require('./sdk/common/AxiosHelper');
@@ -18,6 +19,12 @@ module.exports = {
     
     
     
+    PartnerConfig,
+    PartnerClient,
+    PartnerModel,
+    
+    
+    
     PlatformConfig,
     PlatformClient,
     PlatformModel,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "",
   "main": "index.js",
   "scripts": {

package/partner.d.ts

@@ -0,0 +1,4 @@
+import { PartnerConfig } from "./sdk/partner";
+import { PartnerClient } from "./sdk/partner";
+import { PartnerModel } from "./sdk/partner";
+export { PartnerConfig, PartnerClient, PartnerModel };

package/partner.js

@@ -0,0 +1,7 @@
+const {PartnerConfig, PartnerClient, PartnerModel } = require('./sdk/partner');
+
+module.exports = {
+    PartnerConfig: PartnerConfig,
+    PartnerClient: PartnerClient,
+    PartnerModel: PartnerModel
+};

package/sdk/application/Common/CommonApplicationModel.js

@@ -96,14 +96,18 @@ class CommonModel {
       __v: Joi.number(),
       _id: Joi.string().allow(""),
       capital: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
       currency: Joi.string().allow(""),
       default_currency: CommonModel.LocationDefaultCurrency(),
       default_language: CommonModel.LocationDefaultLanguage(),
       iso2: Joi.string().allow(""),
       iso3: Joi.string().allow(""),
+      latitude: Joi.string().allow(""),
+      longitude: Joi.string().allow(""),
       name: Joi.string().allow(""),
       parent: Joi.string().allow(""),
       phone_code: Joi.string().allow(""),
+      state_code: Joi.string().allow(""),
       type: Joi.string().allow(""),
       uid: Joi.number(),
     });

package/sdk/application/Configuration/ConfigurationApplicationModel.js

@@ -93,13 +93,13 @@ class ConfigurationModel {
   static ApplicationDetail() {
     return Joi.object({
       _id: Joi.string().allow(""),
-      banner: ConfigurationModel.SecureUrl().required(),
-      description: Joi.string().allow("").required(),
+      banner: ConfigurationModel.SecureUrl(),
+      description: Joi.string().allow(""),
       domain: ConfigurationModel.Domain(),
       domains: Joi.array().items(ConfigurationModel.Domain()),
-      favicon: ConfigurationModel.SecureUrl().required(),
-      logo: ConfigurationModel.SecureUrl().required(),
-      mobile_logo: ConfigurationModel.SecureUrl().required(),
+      favicon: ConfigurationModel.SecureUrl(),
+      logo: ConfigurationModel.SecureUrl(),
+      mobile_logo: ConfigurationModel.SecureUrl(),
       name: Joi.string().allow("").required(),
     });
   }

package/sdk/application/Lead/LeadApplicationModel.js

@@ -9,6 +9,7 @@ class LeadModel {
       created_by: Joi.any(),
       priority: LeadModel.PriorityEnum(),
       status: Joi.string().allow(""),
+      subscribers: Joi.array().items(Joi.string().allow("")),
     });
   }
   static AgentChangePayload() {
@@ -409,7 +410,9 @@ class LeadModel {
 
       "log",
 
-      "comment"
+      "comment",
+
+      "thread"
     );
   }
 

package/sdk/partner/OAuthClient.d.ts

@@ -0,0 +1,14 @@
+export = OAuthClient;
+declare class OAuthClient extends BaseOAuthClient {
+    startAuthorization(options: any): string;
+    verifyCallback(query: any): Promise<void>;
+    renewAccessToken(isOfflineToken?: boolean): Promise<any>;
+    getNewAccessToken(): Promise<any>;
+    getAccesstokenObj({ grant_type, client_id, client_secret, scope }: {
+        grant_type: any;
+        client_id: any;
+        client_secret: any;
+        scope: any;
+    }): Promise<any>;
+}
+import BaseOAuthClient = require("../common/BaseOAuthClient");

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("query-string");
+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/Cart/CartPlatformApplicationClient.d.ts

@@ -27,6 +27,16 @@ declare class Cart {
         b?: boolean;
         body: AddCartRequest;
     }): Promise<AddCartDetailResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PriceAdjustmentAdd} arg.body
+     * @returns {Promise<PriceAdjustmentResponse>} - Success response
+     * @summary: Create new price adjustment
+     * @description: Create new price adjustment
+     */
+    addPriceAdjustment({ body }?: {
+        body: PriceAdjustmentAdd;
+    }): Promise<PriceAdjustmentResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {boolean} [arg.i] -
@@ -611,6 +621,16 @@ declare class Cart {
         uid?: string;
         buyNow?: boolean;
     }): Promise<CartDetailResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id -
+     * @returns {Promise<SuccessMessage>} - Success response
+     * @summary: Remove price adjustment
+     * @description: Remove price adjustment
+     */
+    removePriceAdjustment({ id }?: {
+        id: string;
+    }): Promise<SuccessMessage>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.cartId] -
@@ -768,6 +788,18 @@ declare class Cart {
         id: string;
         body: CouponPartialUpdate;
     }): Promise<SuccessMessage>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id -
+     * @param {PriceAdjustmentUpdate} arg.body
+     * @returns {Promise<PriceAdjustmentResponse>} - Success response
+     * @summary: Update price adjustment configuration
+     * @description: Update price adjustment configuration
+     */
+    updatePriceAdjustment({ id, body }?: {
+        id: string;
+        body: PriceAdjustmentUpdate;
+    }): Promise<PriceAdjustmentResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -

package/sdk/platform/Cart/CartPlatformApplicationClient.js

@@ -141,6 +141,67 @@ class Cart {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {PriceAdjustmentAdd} arg.body
+   * @returns {Promise<PriceAdjustmentResponse>} - Success response
+   * @summary: Create new price adjustment
+   * @description: Create new price adjustment
+   */
+  async addPriceAdjustment({ body } = {}) {
+    const { error } = CartValidator.addPriceAdjustment().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 } = CartValidator.addPriceAdjustment().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for addPriceAdjustment",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/price-adjustment`,
+      query_params,
+      body
+    );
+
+    const {
+      error: res_error,
+    } = CartModel.PriceAdjustmentResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for addPriceAdjustment",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {boolean} [arg.i] -
@@ -2888,6 +2949,65 @@ class Cart {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id -
+   * @returns {Promise<SuccessMessage>} - Success response
+   * @summary: Remove price adjustment
+   * @description: Remove price adjustment
+   */
+  async removePriceAdjustment({ id } = {}) {
+    const { error } = CartValidator.removePriceAdjustment().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = CartValidator.removePriceAdjustment().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for removePriceAdjustment",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/price-adjustment/${id}`,
+      query_params,
+      undefined
+    );
+
+    const { error: res_error } = CartModel.SuccessMessage().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for removePriceAdjustment",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} [arg.cartId] -
@@ -3638,6 +3758,70 @@ class Cart {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id -
+   * @param {PriceAdjustmentUpdate} arg.body
+   * @returns {Promise<PriceAdjustmentResponse>} - Success response
+   * @summary: Update price adjustment configuration
+   * @description: Update price adjustment configuration
+   */
+  async updatePriceAdjustment({ id, body } = {}) {
+    const { error } = CartValidator.updatePriceAdjustment().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = CartValidator.updatePriceAdjustment().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updatePriceAdjustment",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/price-adjustment/${id}`,
+      query_params,
+      body
+    );
+
+    const {
+      error: res_error,
+    } = CartModel.PriceAdjustmentResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updatePriceAdjustment",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id -