@gofynd/fdk-client-javascript 0.1.37 → 1.0.0

package/sdk/platform/{client → Discount}/DiscountPlatformClient.d.ts

@@ -57,6 +57,17 @@ declare class Discount {
         id: string;
         body: CreateUpdateDiscount;
     }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Job ID of the discount.
+     * @param {BulkDiscount} arg.body
+     * @summary: Create custom discount from bulk.
+     * @description: Create custom discounts through API.
+     */
+    upsertDiscountItems({ id, body }?: {
+        id: string;
+        body: BulkDiscount;
+    }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.discount] - Discount

package/sdk/platform/{client → Discount}/DiscountPlatformClient.js

@@ -1,7 +1,7 @@
 const Paginator = require("../../common/Paginator");
-const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const DiscountValidator = require("../models/DiscountValidator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const DiscountValidator = require("./DiscountPlatformValidator");
 class Discount {
   constructor(config) {
     this.config = config;
@@ -169,6 +169,39 @@ class Discount {
     );
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id - Job ID of the discount.
+   * @param {BulkDiscount} arg.body
+   * @summary: Create custom discount from bulk.
+   * @description: Create custom discounts through API.
+   */
+  upsertDiscountItems({ id, body } = {}) {
+    const { error } = DiscountValidator.upsertDiscountItems().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/discount/v1.0/company/${this.config.companyId}/job/${id}/items/`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} [arg.discount] - Discount

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

@@ -0,0 +1,15 @@
+export = DiscountModel;
+declare class DiscountModel {
+    static ValidityObject(): any;
+    static CreateUpdateDiscount(): any;
+    static DiscountJob(): any;
+    static ListOrCalender(): any;
+    static DiscountItems(): any;
+    static BulkDiscount(): any;
+    static FileJobResponse(): any;
+    static DownloadFileJob(): any;
+    static CancelJobResponse(): any;
+    static Page(): any;
+    static UserDetails(): any;
+    static BadRequestObject(): any;
+}

package/sdk/platform/Discount/DiscountPlatformModel.js

@@ -0,0 +1,176 @@
+const Joi = require("joi");
+
+class DiscountModel {
+  static ValidityObject() {
+    return Joi.object({
+      start: Joi.string().allow("").required(),
+
+      end: Joi.string().allow("").required(),
+    });
+  }
+
+  static CreateUpdateDiscount() {
+    return Joi.object({
+      name: Joi.string().allow("").required(),
+
+      company_id: Joi.number().required(),
+
+      is_active: Joi.boolean().required(),
+
+      app_ids: Joi.array().items(Joi.string().allow("")).required(),
+
+      extension_ids: Joi.array().items(Joi.string().allow("")).required(),
+
+      job_type: Joi.string().allow("").required(),
+
+      discount_type: Joi.string().allow("").required(),
+
+      discount_level: Joi.string().allow("").required(),
+
+      value: Joi.number(),
+
+      file_path: Joi.string().allow(""),
+
+      brand_ids: Joi.array().items(Joi.number()),
+
+      store_ids: Joi.array().items(Joi.number()),
+
+      validity: DiscountModel.ValidityObject().required(),
+    });
+  }
+
+  static DiscountJob() {
+    return Joi.object({
+      _id: Joi.string().allow("").required(),
+
+      name: Joi.string().allow("").required(),
+
+      company_id: Joi.number().required(),
+
+      is_active: Joi.boolean().required(),
+
+      app_ids: Joi.array().items(Joi.string().allow("")),
+
+      job_type: Joi.string().allow(""),
+
+      discount_type: Joi.string().allow(""),
+
+      discount_level: Joi.string().allow(""),
+
+      value: Joi.number(),
+
+      file_path: Joi.string().allow(""),
+
+      brand_ids: Joi.array().items(Joi.number()),
+
+      store_ids: Joi.array().items(Joi.number()),
+
+      validity: DiscountModel.ValidityObject().required(),
+
+      created_on: Joi.string().allow("").required(),
+
+      modified_on: Joi.string().allow("").required(),
+
+      created_by: DiscountModel.UserDetails().required(),
+
+      modified_by: DiscountModel.UserDetails().required(),
+
+      meta: Joi.any(),
+    });
+  }
+
+  static ListOrCalender() {
+    return Joi.object({
+      items: Joi.array().items(DiscountModel.DiscountJob()).required(),
+
+      page: DiscountModel.Page().required(),
+    });
+  }
+
+  static DiscountItems() {
+    return Joi.object({
+      item_code: Joi.string().allow(""),
+
+      brand_uid: Joi.number(),
+
+      seller_identifier: Joi.string().allow(""),
+
+      discount_type: Joi.string().allow("").required(),
+
+      value: Joi.number().required(),
+    });
+  }
+
+  static BulkDiscount() {
+    return Joi.object({
+      company_id: Joi.number().required(),
+
+      items: Joi.array().items(DiscountModel.DiscountItems()).required(),
+    });
+  }
+
+  static FileJobResponse() {
+    return Joi.object({
+      stage: Joi.string().allow("").required(),
+
+      total: Joi.number().required(),
+
+      failed: Joi.number().required(),
+
+      company_id: Joi.number().required(),
+
+      body: Joi.any(),
+
+      type: Joi.string().allow("").required(),
+
+      file_type: Joi.string().allow("").required(),
+    });
+  }
+
+  static DownloadFileJob() {
+    return Joi.object({
+      brand_ids: Joi.array().items(Joi.number()),
+
+      store_ids: Joi.array().items(Joi.number()),
+    });
+  }
+
+  static CancelJobResponse() {
+    return Joi.object({
+      success: Joi.boolean().required(),
+    });
+  }
+
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+
+      has_next: Joi.boolean(),
+
+      current: Joi.number(),
+
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+    });
+  }
+
+  static UserDetails() {
+    return Joi.object({
+      username: Joi.string().allow("").required(),
+
+      user_id: Joi.string().allow("").required(),
+    });
+  }
+
+  static BadRequestObject() {
+    return Joi.object({
+      message: Joi.string().allow("").required(),
+    });
+  }
+}
+module.exports = DiscountModel;

package/sdk/platform/{models/DiscountValidator.d.ts → Discount/DiscountPlatformValidator.d.ts}

@@ -4,6 +4,7 @@ declare class DiscountValidator {
     static createDiscount(): any;
     static getDiscount(): any;
     static updateDiscount(): any;
+    static upsertDiscountItems(): any;
     static validateDiscountFile(): any;
     static downloadDiscountFile(): any;
     static getValidationJob(): any;

package/sdk/platform/{models/DiscountValidator.js → Discount/DiscountPlatformValidator.js}

@@ -1,5 +1,6 @@
 const Joi = require("joi");
-const Validator = require("../PlatformModels");
+
+const DiscountModel = require("./DiscountPlatformModel");
 class DiscountValidator {
   static getDiscounts() {
     return Joi.object({
@@ -17,7 +18,7 @@ class DiscountValidator {
 
   static createDiscount() {
     return Joi.object({
-      body: Validator.CreateUpdateDiscount().required(),
+      body: DiscountModel.CreateUpdateDiscount().required(),
     }).required();
   }
 
@@ -30,21 +31,28 @@ class DiscountValidator {
   static updateDiscount() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: Validator.CreateUpdateDiscount().required(),
+      body: DiscountModel.CreateUpdateDiscount().required(),
+    }).required();
+  }
+
+  static upsertDiscountItems() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: DiscountModel.BulkDiscount().required(),
     }).required();
   }
 
   static validateDiscountFile() {
     return Joi.object({
       discount: Joi.string().allow(""),
-      body: Validator.DiscountJob().required(),
+      body: DiscountModel.DiscountJob().required(),
     }).required();
   }
 
   static downloadDiscountFile() {
     return Joi.object({
       type: Joi.string().allow("").required(),
-      body: Validator.DownloadFileJob().required(),
+      body: DiscountModel.DownloadFileJob().required(),
     }).required();
   }
 

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

@@ -0,0 +1,114 @@
+export = FileStorage;
+declare class FileStorage {
+    constructor(config: any, applicationId: any);
+    config: any;
+    applicationId: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Bucket name
+     * @param {StartRequest} arg.body
+     * @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.
+     * @description: Uploads an arbitrarily sized buffer or blob.
+     *
+     * It has three Major Steps:
+     * Start
+     * Upload
+     * Complete
+     *
+     * ### Start
+     * Initiates the assets upload using `appStartUpload`.
+     * It returns the storage link in response.
+     *
+     * ### Upload
+     * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+     * Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
+     *
+     * ### Complete
+     * After successfully upload, call `appCompleteUpload` api to complete the upload process.
+     * This operation will return the url for the uploaded file.
+     */
+    appStartUpload({ namespace, body }?: {
+        namespace: string;
+        body: StartRequest;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Bucket name
+     * @param {StartResponse} arg.body
+     * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
+     * @description: Uploads an arbitrarily sized buffer or blob.
+     *
+     * It has three Major Steps:
+     * Start
+     * Upload
+     * Complete
+     *
+     * ### Start
+     * Initiates the assets upload using `appStartUpload`.
+     * It returns the storage link in response.
+     *
+     * ### Upload
+     * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+     * Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
+     *
+     * ### Complete
+     * After successfully upload, call `appCompleteUpload` api to complete the upload process.
+     * This operation will return the url for the uploaded file.
+     */
+    appCompleteUpload({ namespace, body }?: {
+        namespace: string;
+        body: StartResponse;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.sync] - Sync
+     * @param {BulkRequest} arg.body
+     * @summary: Copy Files
+     * @description: Copy Files
+     */
+    appCopyFiles({ body, sync }?: {
+        sync?: boolean;
+        body: BulkRequest;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Bucket name
+     * @param {number} [arg.pageNo] - Page no
+     * @summary: Browse Files
+     * @description: Browse Files
+     */
+    browse({ namespace, pageNo }?: {
+        namespace: string;
+        pageNo?: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Bucket name
+     * @param {number} arg.companyId - Company_id
+     * @param {number} arg.applicationId - Application_id
+     * @summary: Browse Files
+     * @description: Browse Files
+     */
+    browsePaginator({ namespace, companyId, applicationId }?: {
+        namespace: string;
+        companyId: number;
+        applicationId: number;
+    }): Paginator;
+    /**
+     * @param data
+     * @param {string} file_name
+     * @param {string} content_type
+     * @param {string} namespace
+     * @param {number} size
+     * @param {number} tags
+     */
+    upload({ data, file_name, content_type, namespace, size, tags, }?: {
+        data: any;
+        file_name: any;
+        content_type: any;
+        namespace: any;
+        size: any;
+        tags: any;
+    }): Promise<any>;
+}
+import Paginator = require("../../common/Paginator");

package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js

@@ -0,0 +1,247 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const FileStorageValidator = require("./FileStoragePlatformApplicationValidator");
+
+class FileStorage {
+  constructor(config, applicationId) {
+    this.config = config;
+    this.applicationId = applicationId;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {StartRequest} arg.body
+   * @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.
+   * @description: Uploads an arbitrarily sized buffer or blob.
+   *
+   * It has three Major Steps:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `appStartUpload`.
+   * It returns the storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
+   *
+   * ### Complete
+   * After successfully upload, call `appCompleteUpload` api to complete the upload process.
+   * This operation will return the url for the uploaded file.
+   */
+  appStartUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.appStartUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/start/`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {StartResponse} arg.body
+   * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
+   * @description: Uploads an arbitrarily sized buffer or blob.
+   *
+   * It has three Major Steps:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `appStartUpload`.
+   * It returns the storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
+   *
+   * ### Complete
+   * After successfully upload, call `appCompleteUpload` api to complete the upload process.
+   * This operation will return the url for the uploaded file.
+   */
+  appCompleteUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.appCompleteUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/complete/`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {boolean} [arg.sync] - Sync
+   * @param {BulkRequest} arg.body
+   * @summary: Copy Files
+   * @description: Copy Files
+   */
+  appCopyFiles({ body, sync } = {}) {
+    const { error } = FileStorageValidator.appCopyFiles().validate(
+      {
+        body,
+        sync,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["sync"] = sync;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/uploads/copy/`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {number} [arg.pageNo] - Page no
+   * @summary: Browse Files
+   * @description: Browse Files
+   */
+  browse({ namespace, pageNo } = {}) {
+    const { error } = FileStorageValidator.browse().validate(
+      {
+        namespace,
+        pageNo,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/browse/`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {number} arg.companyId - Company_id
+   * @param {number} arg.applicationId - Application_id
+   * @summary: Browse Files
+   * @description: Browse Files
+   */
+  browsePaginator({ 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({
+        namespace: namespace,
+        companyId: companyId,
+        applicationId: applicationId,
+        pageNo: pageNo,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+}
+module.exports = FileStorage;
+
+/**
+ * @param data
+ * @param {string} file_name
+ * @param {string} content_type
+ * @param {string} namespace
+ * @param {number} size
+ * @param {number} tags
+ */
+FileStorage.prototype.upload = function ({
+  data,
+  file_name,
+  content_type,
+  namespace,
+  size,
+  tags,
+} = {}) {
+  return new Promise(async (resolve, reject) => {
+    try {
+      const dataObj = await this.appStartUpload({
+        namespace,
+        body: {
+          file_name,
+          content_type,
+          size: size,
+          tags: tags,
+        },
+      });
+      if (dataObj.upload && dataObj.upload.url) {
+        await axios.put(dataObj.upload.url, data, {
+          withCredentials: false,
+          headers: { "Content-Type": content_type },
+        });
+      } else {
+        reject({ message: "Failed to upload file" });
+      }
+      delete dataObj.tags;
+
+      const completeRes = await this.appCompleteUpload({
+        namespace,
+        body: dataObj,
+      });
+
+      resolve(completeRes);
+    } catch (err) {
+      reject(err);
+    }
+  });
+};

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

@@ -0,0 +1,7 @@
+export = FileStorageValidator;
+declare class FileStorageValidator {
+    static appStartUpload(): any;
+    static appCompleteUpload(): any;
+    static appCopyFiles(): any;
+    static browse(): any;
+}