@gofynd/fdk-client-javascript 1.1.0 → 1.1.2

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 } = {}) {

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;

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(),

package/sdk/platform/Content/ContentPlatformModel.js

@@ -347,6 +347,7 @@ class ContentModel {
   static Detail() {
     return Joi.object({
       description: Joi.string().allow(""),
+      image_url: Joi.string().allow(""),
       title: Joi.string().allow(""),
     });
   }
@@ -911,10 +912,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/FileStoragePlatformApplicationClient.d.ts

@@ -5,7 +5,10 @@ declare class FileStorage {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
      * @param {StartResponse} arg.body
      * @returns {Promise<CompleteResponse>} - Success response
      * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
@@ -46,7 +49,10 @@ declare class FileStorage {
     }): Promise<BulkUploadResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
      * @param {StartRequest} arg.body
      * @returns {Promise<StartResponse>} - Success response
      * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
@@ -81,7 +87,7 @@ declare class FileStorage {
      * @summary: Browse Files
      * @description: Browse Files
      */
-    browse({ namespace, pageNo, }?: {
+    appbrowse({ namespace, pageNo, }?: {
         namespace: string;
         pageNo?: number;
     }): Promise<BrowseResponse>;
@@ -93,7 +99,7 @@ declare class FileStorage {
      * @summary: Browse Files
      * @description: Browse Files
      */
-    browsePaginator({ namespace, companyId, applicationId }?: {
+    appbrowsePaginator({ namespace, companyId, applicationId }?: {
         namespace: string;
         companyId: number;
         applicationId: number;

package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js

@@ -16,7 +16,10 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Bucket name
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
    * @param {StartResponse} arg.body
    * @returns {Promise<CompleteResponse>} - Success response
    * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
@@ -170,7 +173,10 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Bucket name
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
    * @param {StartRequest} arg.body
    * @returns {Promise<StartResponse>} - Success response
    * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
@@ -263,12 +269,12 @@ class FileStorage {
    * @summary: Browse Files
    * @description: Browse Files
    */
-  async browse({
+  async appbrowse({
     namespace,
 
     pageNo,
   } = {}) {
-    const { error } = FileStorageValidator.browse().validate(
+    const { error } = FileStorageValidator.appbrowse().validate(
       {
         namespace,
 
@@ -281,7 +287,7 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.browse().validate(
+    const { error: warrning } = FileStorageValidator.appbrowse().validate(
       {
         namespace,
 
@@ -292,7 +298,7 @@ class FileStorage {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for browse",
+        message: "Parameter Validation warrnings for appbrowse",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -318,7 +324,7 @@ class FileStorage {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for browse",
+        message: "Response Validation Warnnings for appbrowse",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -334,13 +340,13 @@ class FileStorage {
    * @summary: Browse Files
    * @description: Browse Files
    */
-  browsePaginator({ namespace, companyId, applicationId } = {}) {
+  appbrowsePaginator({ namespace, companyId, applicationId } = {}) {
     const paginator = new Paginator();
     const callback = async () => {
       const pageId = paginator.nextId;
       const pageNo = paginator.pageNo;
       const pageType = "number";
-      const data = await this.browse({
+      const data = await this.appbrowse({
         namespace: namespace,
         companyId: companyId,
         applicationId: applicationId,

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts

@@ -3,5 +3,5 @@ declare class FileStorageValidator {
     static appCompleteUpload(): any;
     static appCopyFiles(): any;
     static appStartUpload(): any;
-    static browse(): any;
+    static appbrowse(): any;
 }

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js

@@ -26,7 +26,7 @@ class FileStorageValidator {
     }).required();
   }
 
-  static browse() {
+  static appbrowse() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 

package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts

@@ -25,7 +25,10 @@ declare class FileStorage {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
      * @param {StartResponse} arg.body
      * @returns {Promise<CompleteResponse>} - Success response
      * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
@@ -86,7 +89,10 @@ declare class FileStorage {
     }): Promise<string>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
      * @param {StartRequest} arg.body
      * @returns {Promise<StartResponse>} - Success response
      * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.

package/sdk/platform/FileStorage/FileStoragePlatformClient.js

@@ -116,7 +116,10 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Bucket name
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
    * @param {StartResponse} arg.body
    * @returns {Promise<CompleteResponse>} - Success response
    * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
@@ -376,7 +379,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,
@@ -400,7 +403,10 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Bucket name
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
    * @param {StartRequest} arg.body
    * @returns {Promise<StartResponse>} - Success response
    * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.

package/sdk/platform/FileStorage/FileStoragePlatformModel.js

@@ -22,8 +22,8 @@ class FileStorageModel {
   }
   static CDN() {
     return Joi.object({
-      absolute_url: Joi.string().allow(""),
-      relative_url: Joi.string().allow(""),
+      absolute_url: Joi.string().allow("").required(),
+      relative_url: Joi.string().allow("").required(),
       url: Joi.string().allow("").required(),
     });
   }

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/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>;
 }