@gofynd/fdk-client-javascript 1.0.4 → 1.1.1

package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts

@@ -311,6 +311,17 @@ declare class Content {
         applicationId: string;
         pageSize?: number;
     }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.slug - A short, human-readable, URL-friendly
+     *   identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
+     * @returns {Promise<BlogSchema>} - Success response
+     * @summary: Get blog by slug
+     * @description: Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc.
+     */
+    getBlogBySlug({ slug }?: {
+        slug: string;
+    }): Promise<BlogSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -512,7 +523,7 @@ declare class Content {
      * @param {string} arg.slug - A short, human-readable, URL-friendly
      *   identifier of a page. You can get slug value of a page from `getPages` API.
      * @returns {Promise<PageSchema>} - Success response
-     * @summary: Get pages by component Id
+     * @summary: Get page by slug
      * @description: Use this API to retrieve the components of a page, such as its title, seo, publish status, feature image, tags, schedule, etc.
      */
     getPageBySlug({ slug }?: {
@@ -826,6 +837,16 @@ declare class Content {
         pathId: string;
         body: PathMappingSchema;
     }): Promise<PathMappingSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SeoComponent} arg.body
+     * @returns {Promise<SeoSchema>} - Success response
+     * @summary: Update SEO of application
+     * @description: Use this API to edit the SEO details of an application. This includes the sitemap, robot.txt, custom meta tags, etc.
+     */
+    updateSEOConfiguration({ body }?: {
+        body: SeoComponent;
+    }): Promise<SeoSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - ID allotted to the slideshow.

package/sdk/platform/Content/ContentPlatformApplicationClient.js

@@ -114,7 +114,7 @@ class Content {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/content/v1.0/company/${this.config.companyId}/application/${this.applicationId}/faq/category/${categoryId}/faqs`,
+      `/service/platform/content/v1.0/company/${this.config.companyId}/application/${this.applicationId}/faq/category/${categoryId}/faq`,
       query_params,
       body
     );
@@ -1760,6 +1760,66 @@ class Content {
     return paginator;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.slug - A short, human-readable, URL-friendly
+   *   identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
+   * @returns {Promise<BlogSchema>} - Success response
+   * @summary: Get blog by slug
+   * @description: Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc.
+   */
+  async getBlogBySlug({ slug } = {}) {
+    const { error } = ContentValidator.getBlogBySlug().validate(
+      {
+        slug,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ContentValidator.getBlogBySlug().validate(
+      {
+        slug,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getBlogBySlug",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/content/v2.0/company/${this.config.companyId}/application/${this.applicationId}/blogs/${slug}`,
+      query_params,
+      undefined
+    );
+
+    const { error: res_error } = ContentModel.BlogSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getBlogBySlug",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -2683,7 +2743,7 @@ class Content {
    * @param {string} arg.slug - A short, human-readable, URL-friendly
    *   identifier of a page. You can get slug value of a page from `getPages` API.
    * @returns {Promise<PageSchema>} - Success response
-   * @summary: Get pages by component Id
+   * @summary: Get page by slug
    * @description: Use this API to retrieve the components of a page, such as its title, seo, publish status, feature image, tags, schedule, etc.
    */
   async getPageBySlug({ slug } = {}) {
@@ -4326,6 +4386,67 @@ class Content {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {SeoComponent} arg.body
+   * @returns {Promise<SeoSchema>} - Success response
+   * @summary: Update SEO of application
+   * @description: Use this API to edit the SEO details of an application. This includes the sitemap, robot.txt, custom meta tags, etc.
+   */
+  async updateSEOConfiguration({ body } = {}) {
+    const { error } = ContentValidator.updateSEOConfiguration().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,
+    } = ContentValidator.updateSEOConfiguration().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updateSEOConfiguration",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/content/v1.0/company/${this.config.companyId}/application/${this.applicationId}/seo`,
+      query_params,
+      body
+    );
+
+    const { error: res_error } = ContentModel.SeoSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updateSEOConfiguration",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - ID allotted to the slideshow.

package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts

@@ -28,6 +28,7 @@ declare class ContentValidator {
     static generateSEOTitle(): any;
     static getAnnouncementById(): any;
     static getAnnouncementsList(): any;
+    static getBlogBySlug(): any;
     static getBlogs(): any;
     static getComponentById(): any;
     static getDataLoaders(): any;
@@ -66,6 +67,7 @@ declare class ContentValidator {
     static updatePage(): any;
     static updatePagePreview(): any;
     static updatePathRedirectionRules(): any;
+    static updateSEOConfiguration(): any;
     static updateSlideshow(): any;
     static updateSupportInformation(): any;
 }

package/sdk/platform/Content/ContentPlatformApplicationValidator.js

@@ -174,6 +174,12 @@ class ContentValidator {
     }).required();
   }
 
+  static getBlogBySlug() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static getBlogs() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -406,6 +412,12 @@ class ContentValidator {
     }).required();
   }
 
+  static updateSEOConfiguration() {
+    return Joi.object({
+      body: ContentModel.SeoComponent().required(),
+    }).required();
+  }
+
   static updateSlideshow() {
     return Joi.object({
       id: Joi.string().allow("").required(),

package/sdk/platform/Content/ContentPlatformModel.js

@@ -347,7 +347,6 @@ class ContentModel {
   static Detail() {
     return Joi.object({
       description: Joi.string().allow(""),
-      image_url: Joi.string().allow(""),
       title: Joi.string().allow(""),
     });
   }
@@ -912,10 +911,6 @@ class ContentModel {
 
       "product",
 
-      "product-reviews",
-
-      "add-product-review",
-
       "product-request",
 
       "products",

package/sdk/platform/Discount/DiscountPlatformClient.d.ts

@@ -128,13 +128,13 @@ declare class Discount {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.discount] - Discount
-     * @param {DiscountJob} arg.body
+     * @param {FileJobRequest} arg.body
      * @returns {Promise<FileJobResponse>} - Success response
      * @summary: Validate File.
      * @description: Validate File.
      */
     validateDiscountFile({ body, discount }?: {
         discount?: string;
-        body: DiscountJob;
+        body: FileJobRequest;
     }): Promise<FileJobResponse>;
 }

package/sdk/platform/Discount/DiscountPlatformClient.js

@@ -705,7 +705,7 @@ class Discount {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} [arg.discount] - Discount
-   * @param {DiscountJob} arg.body
+   * @param {FileJobRequest} arg.body
    * @returns {Promise<FileJobResponse>} - Success response
    * @summary: Validate File.
    * @description: Validate File.

package/sdk/platform/Discount/DiscountPlatformModel.d.ts

@@ -7,6 +7,7 @@ declare class DiscountModel {
     static DiscountItems(): any;
     static DiscountJob(): any;
     static DownloadFileJob(): any;
+    static FileJobRequest(): any;
     static FileJobResponse(): any;
     static ListOrCalender(): any;
     static Page(): any;

package/sdk/platform/Discount/DiscountPlatformModel.js

@@ -71,6 +71,21 @@ class DiscountModel {
       store_ids: Joi.array().items(Joi.number()),
     });
   }
+  static FileJobRequest() {
+    return Joi.object({
+      app_ids: Joi.array().items(Joi.string().allow("")),
+      brand_ids: Joi.array().items(Joi.number()),
+      discount_level: Joi.string().allow(""),
+      discount_type: Joi.string().allow(""),
+      file_path: Joi.string().allow(""),
+      is_active: Joi.boolean().required(),
+      job_type: Joi.string().allow(""),
+      meta: Joi.any(),
+      name: Joi.string().allow("").required(),
+      store_ids: Joi.array().items(Joi.number()),
+      validity: DiscountModel.ValidityObject().required(),
+    });
+  }
   static FileJobResponse() {
     return Joi.object({
       body: Joi.any(),

package/sdk/platform/Discount/DiscountPlatformValidator.js

@@ -76,7 +76,7 @@ class DiscountValidator {
   static validateDiscountFile() {
     return Joi.object({
       discount: Joi.string().allow(""),
-      body: DiscountModel.DiscountJob().required(),
+      body: DiscountModel.FileJobRequest().required(),
     }).required();
   }
 }

package/sdk/platform/FileStorage/FileStoragePlatformClient.js

@@ -376,7 +376,7 @@ class FileStorage {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "post",
+      "get",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/proxy/`,
       query_params,
       undefined,

package/sdk/platform/Lead/LeadPlatformModel.js

@@ -258,6 +258,7 @@ class LeadModel {
       support_email: LeadModel.CommunicationDetails(),
       support_faq: LeadModel.CommunicationDetails(),
       support_phone: LeadModel.CommunicationDetails(),
+      type: Joi.string().allow(""),
     });
   }
   static Ticket() {

package/sdk/platform/OAuthClient.js

@@ -3,6 +3,7 @@ const { fdkAxios } = require("../common/AxiosHelper");
 const { sign } = require("../common/RequestSigner");
 const { FDKTokenIssueError, FDKOAuthCodeError } = require("../common/FDKError");
 const { Logger } = require("../common/Logger");
+const { btoa } = require("isomorphic-base64");
 
 const refreshTokenRequestCache = {};
 class OAuthClient {
@@ -158,11 +159,7 @@ class OAuthClient {
     } else if (grant_type === "authorization_code") {
       reqData = { ...reqData, code };
     }
-
-    const token = Buffer.from(
-      `${this.config.apiKey}:${this.config.apiSecret}`,
-      "utf8"
-    ).toString("base64");
+    const token = btoa(`${this.config.apiKey}:${this.config.apiSecret}`);
     let url = `${this.config.domain}/service/panel/authentication/v1.0/company/${this.config.companyId}/oauth/token`;
     const rawRequest = {
       method: "post",
@@ -201,10 +198,7 @@ class OAuthClient {
       scope: scopes,
       code: code,
     };
-    const token = Buffer.from(
-      `${this.config.apiKey}:${this.config.apiSecret}`,
-      "utf8"
-    ).toString("base64");
+    const token = btoa(`${this.config.apiKey}:${this.config.apiSecret}`);
     const rawRequest = {
       method: "post",
       url: url,

package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts

@@ -3,52 +3,6 @@ declare class Order {
     constructor(config: any, applicationId: any);
     config: any;
     applicationId: any;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.orderId -
-     * @returns {Promise<ShipmentDetailsResponse>} - Success response
-     * @summary:
-     * @description:
-     */
-    getAppOrderShipmentDetails({ orderId }?: {
-        orderId: string;
-    }): Promise<ShipmentDetailsResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.lane] -
-     * @param {string} [arg.searchType] -
-     * @param {string} [arg.searchId] -
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @param {string} [arg.dpIds] -
-     * @param {string} [arg.orderingCompanyId] -
-     * @param {string} [arg.stores] -
-     * @param {string} [arg.salesChannel] -
-     * @param {string} [arg.requestByExt] -
-     * @param {number} [arg.pageNo] -
-     * @param {number} [arg.pageSize] -
-     * @param {string} [arg.customerId] -
-     * @param {boolean} [arg.isPrioritySort] -
-     * @returns {Promise<ShipmentInternalPlatformViewResponse>} - Success response
-     * @summary:
-     * @description:
-     */
-    getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
-        lane?: string;
-        searchType?: string;
-        searchId?: string;
-        fromDate?: string;
-        toDate?: string;
-        dpIds?: string;
-        orderingCompanyId?: string;
-        stores?: string;
-        salesChannel?: string;
-        requestByExt?: string;
-        pageNo?: number;
-        pageSize?: number;
-        customerId?: string;
-        isPrioritySort?: boolean;
-    }): Promise<ShipmentInternalPlatformViewResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.shipmentId -
@@ -56,7 +10,7 @@ declare class Order {
      * @summary: Track shipment
      * @description: Track Shipment by shipment id, for application based on application Id
      */
-    trackPlatformShipment({ shipmentId }?: {
+    trackShipmentPlatform({ shipmentId }?: {
         shipmentId: string;
     }): Promise<PlatformShipmentTrack>;
 }

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -12,202 +12,6 @@ class Order {
     this.applicationId = applicationId;
   }
 
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.orderId -
-   * @returns {Promise<ShipmentDetailsResponse>} - Success response
-   * @summary:
-   * @description:
-   */
-  async getAppOrderShipmentDetails({ orderId } = {}) {
-    const { error } = OrderValidator.getAppOrderShipmentDetails().validate(
-      {
-        orderId,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = OrderValidator.getAppOrderShipmentDetails().validate(
-      {
-        orderId,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message:
-          "Parameter Validation warrnings for getAppOrderShipmentDetails",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-    query_params["order_id"] = orderId;
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/order-details`,
-      query_params,
-      undefined
-    );
-
-    const {
-      error: res_error,
-    } = OrderModel.ShipmentDetailsResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for getAppOrderShipmentDetails",
-      });
-      Logger({ level: "WARN", message: res_error });
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.lane] -
-   * @param {string} [arg.searchType] -
-   * @param {string} [arg.searchId] -
-   * @param {string} [arg.fromDate] -
-   * @param {string} [arg.toDate] -
-   * @param {string} [arg.dpIds] -
-   * @param {string} [arg.orderingCompanyId] -
-   * @param {string} [arg.stores] -
-   * @param {string} [arg.salesChannel] -
-   * @param {string} [arg.requestByExt] -
-   * @param {number} [arg.pageNo] -
-   * @param {number} [arg.pageSize] -
-   * @param {string} [arg.customerId] -
-   * @param {boolean} [arg.isPrioritySort] -
-   * @returns {Promise<ShipmentInternalPlatformViewResponse>} - Success response
-   * @summary:
-   * @description:
-   */
-  async getApplicationShipments({
-    lane,
-    searchType,
-    searchId,
-    fromDate,
-    toDate,
-    dpIds,
-    orderingCompanyId,
-    stores,
-    salesChannel,
-    requestByExt,
-    pageNo,
-    pageSize,
-    customerId,
-    isPrioritySort,
-  } = {}) {
-    const { error } = OrderValidator.getApplicationShipments().validate(
-      {
-        lane,
-        searchType,
-        searchId,
-        fromDate,
-        toDate,
-        dpIds,
-        orderingCompanyId,
-        stores,
-        salesChannel,
-        requestByExt,
-        pageNo,
-        pageSize,
-        customerId,
-        isPrioritySort,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = OrderValidator.getApplicationShipments().validate(
-      {
-        lane,
-        searchType,
-        searchId,
-        fromDate,
-        toDate,
-        dpIds,
-        orderingCompanyId,
-        stores,
-        salesChannel,
-        requestByExt,
-        pageNo,
-        pageSize,
-        customerId,
-        isPrioritySort,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for getApplicationShipments",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-    query_params["lane"] = lane;
-    query_params["search_type"] = searchType;
-    query_params["search_id"] = searchId;
-    query_params["from_date"] = fromDate;
-    query_params["to_date"] = toDate;
-    query_params["dp_ids"] = dpIds;
-    query_params["ordering_company_id"] = orderingCompanyId;
-    query_params["stores"] = stores;
-    query_params["sales_channel"] = salesChannel;
-    query_params["request_by_ext"] = requestByExt;
-    query_params["page_no"] = pageNo;
-    query_params["page_size"] = pageSize;
-    query_params["customer_id"] = customerId;
-    query_params["is_priority_sort"] = isPrioritySort;
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/shipments/`,
-      query_params,
-      undefined
-    );
-
-    const {
-      error: res_error,
-    } = OrderModel.ShipmentInternalPlatformViewResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for getApplicationShipments",
-      });
-      Logger({ level: "WARN", message: res_error });
-    }
-
-    return response;
-  }
-
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.shipmentId -
@@ -215,8 +19,8 @@ class Order {
    * @summary: Track shipment
    * @description: Track Shipment by shipment id, for application based on application Id
    */
-  async trackPlatformShipment({ shipmentId } = {}) {
-    const { error } = OrderValidator.trackPlatformShipment().validate(
+  async trackShipmentPlatform({ shipmentId } = {}) {
+    const { error } = OrderValidator.trackShipmentPlatform().validate(
       {
         shipmentId,
       },
@@ -227,7 +31,7 @@ class Order {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = OrderValidator.trackPlatformShipment().validate(
+    const { error: warrning } = OrderValidator.trackShipmentPlatform().validate(
       {
         shipmentId,
       },
@@ -236,7 +40,7 @@ class Order {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for trackPlatformShipment",
+        message: "Parameter Validation warrnings for trackShipmentPlatform",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -261,7 +65,7 @@ class Order {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for trackPlatformShipment",
+        message: "Response Validation Warnnings for trackShipmentPlatform",
       });
       Logger({ level: "WARN", message: res_error });
     }

package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts

@@ -1,6 +1,4 @@
 export = OrderValidator;
 declare class OrderValidator {
-    static getAppOrderShipmentDetails(): any;
-    static getApplicationShipments(): any;
-    static trackPlatformShipment(): any;
+    static trackShipmentPlatform(): any;
 }