@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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

@@ -1,14 +1,186 @@
-export = DiscountValidator;
-declare class DiscountValidator {
-    static cancelDownloadJob(): any;
-    static cancelValidationJob(): any;
-    static createDiscount(): any;
-    static downloadDiscountFile(): any;
-    static getDiscount(): any;
-    static getDiscounts(): any;
-    static getDownloadJob(): any;
-    static getValidationJob(): any;
-    static updateDiscount(): any;
-    static upsertDiscountItems(): any;
-    static validateDiscountFile(): any;
+export = DiscountPlatformValidator;
+/**
+ * @typedef CancelDownloadJobParam
+ * @property {string} id - Id
+ */
+/**
+ * @typedef CancelValidationJobParam
+ * @property {string} id - Id
+ */
+/**
+ * @typedef CreateDiscountParam
+ * @property {DiscountPlatformModel.CreateUpdateDiscount} body
+ */
+/**
+ * @typedef DownloadDiscountFileParam
+ * @property {string} type - Type
+ * @property {DiscountPlatformModel.DownloadFileJob} body
+ */
+/**
+ * @typedef GetDiscountParam
+ * @property {string} id - Unique id.
+ */
+/**
+ * @typedef GetDiscountsParam
+ * @property {string} [view] - Listing or calender. Default is listing.
+ * @property {string} [q] - The search query. This can be a partial or complete
+ *   name of a discount.
+ * @property {number} [pageNo] - Page number. Default is 1.
+ * @property {number} [pageSize] - Page size. Default is 12.
+ * @property {boolean} [archived] - Archived. Default is false.
+ * @property {number} [month] - Month. Default is current month.
+ * @property {number} [year] - Year. Default is current year.
+ * @property {string} [type] - Basic or custom.
+ * @property {string[]} [appIds] - Application ids.
+ */
+/**
+ * @typedef GetDownloadJobParam
+ * @property {string} id - Id
+ */
+/**
+ * @typedef GetValidationJobParam
+ * @property {string} id - Id
+ */
+/**
+ * @typedef UpdateDiscountParam
+ * @property {string} id - Id
+ * @property {DiscountPlatformModel.CreateUpdateDiscount} body
+ */
+/**
+ * @typedef UpsertDiscountItemsParam
+ * @property {string} id - Job ID of the discount.
+ * @property {DiscountPlatformModel.BulkDiscount} body
+ */
+/**
+ * @typedef ValidateDiscountFileParam
+ * @property {string} [discount] - Discount
+ * @property {DiscountPlatformModel.FileJobRequest} body
+ */
+declare class DiscountPlatformValidator {
+    /** @returns {CancelDownloadJobParam} */
+    static cancelDownloadJob(): CancelDownloadJobParam;
+    /** @returns {CancelValidationJobParam} */
+    static cancelValidationJob(): CancelValidationJobParam;
+    /** @returns {CreateDiscountParam} */
+    static createDiscount(): CreateDiscountParam;
+    /** @returns {DownloadDiscountFileParam} */
+    static downloadDiscountFile(): DownloadDiscountFileParam;
+    /** @returns {GetDiscountParam} */
+    static getDiscount(): GetDiscountParam;
+    /** @returns {GetDiscountsParam} */
+    static getDiscounts(): GetDiscountsParam;
+    /** @returns {GetDownloadJobParam} */
+    static getDownloadJob(): GetDownloadJobParam;
+    /** @returns {GetValidationJobParam} */
+    static getValidationJob(): GetValidationJobParam;
+    /** @returns {UpdateDiscountParam} */
+    static updateDiscount(): UpdateDiscountParam;
+    /** @returns {UpsertDiscountItemsParam} */
+    static upsertDiscountItems(): UpsertDiscountItemsParam;
+    /** @returns {ValidateDiscountFileParam} */
+    static validateDiscountFile(): ValidateDiscountFileParam;
 }
+declare namespace DiscountPlatformValidator {
+    export { CancelDownloadJobParam, CancelValidationJobParam, CreateDiscountParam, DownloadDiscountFileParam, GetDiscountParam, GetDiscountsParam, GetDownloadJobParam, GetValidationJobParam, UpdateDiscountParam, UpsertDiscountItemsParam, ValidateDiscountFileParam };
+}
+type CancelDownloadJobParam = {
+    /**
+     * - Id
+     */
+    id: string;
+};
+type CancelValidationJobParam = {
+    /**
+     * - Id
+     */
+    id: string;
+};
+type CreateDiscountParam = {
+    body: DiscountPlatformModel.CreateUpdateDiscount;
+};
+type DownloadDiscountFileParam = {
+    /**
+     * - Type
+     */
+    type: string;
+    body: DiscountPlatformModel.DownloadFileJob;
+};
+type GetDiscountParam = {
+    /**
+     * - Unique id.
+     */
+    id: string;
+};
+type GetDiscountsParam = {
+    /**
+     * - Listing or calender. Default is listing.
+     */
+    view?: string;
+    /**
+     * - The search query. This can be a partial or complete
+     * name of a discount.
+     */
+    q?: string;
+    /**
+     * - Page number. Default is 1.
+     */
+    pageNo?: number;
+    /**
+     * - Page size. Default is 12.
+     */
+    pageSize?: number;
+    /**
+     * - Archived. Default is false.
+     */
+    archived?: boolean;
+    /**
+     * - Month. Default is current month.
+     */
+    month?: number;
+    /**
+     * - Year. Default is current year.
+     */
+    year?: number;
+    /**
+     * - Basic or custom.
+     */
+    type?: string;
+    /**
+     * - Application ids.
+     */
+    appIds?: string[];
+};
+type GetDownloadJobParam = {
+    /**
+     * - Id
+     */
+    id: string;
+};
+type GetValidationJobParam = {
+    /**
+     * - Id
+     */
+    id: string;
+};
+type UpdateDiscountParam = {
+    /**
+     * - Id
+     */
+    id: string;
+    body: DiscountPlatformModel.CreateUpdateDiscount;
+};
+type UpsertDiscountItemsParam = {
+    /**
+     * - Job ID of the discount.
+     */
+    id: string;
+    body: DiscountPlatformModel.BulkDiscount;
+};
+type ValidateDiscountFileParam = {
+    /**
+     * - Discount
+     */
+    discount?: string;
+    body: DiscountPlatformModel.FileJobRequest;
+};
+import DiscountPlatformModel = require("./DiscountPlatformModel");

package/sdk/platform/Discount/DiscountPlatformValidator.js

@@ -1,38 +1,113 @@
 const Joi = require("joi");
 
-const DiscountModel = require("./DiscountPlatformModel");
-class DiscountValidator {
+const DiscountPlatformModel = require("./DiscountPlatformModel");
+
+/**
+ * @typedef CancelDownloadJobParam
+ * @property {string} id - Id
+ */
+
+/**
+ * @typedef CancelValidationJobParam
+ * @property {string} id - Id
+ */
+
+/**
+ * @typedef CreateDiscountParam
+ * @property {DiscountPlatformModel.CreateUpdateDiscount} body
+ */
+
+/**
+ * @typedef DownloadDiscountFileParam
+ * @property {string} type - Type
+ * @property {DiscountPlatformModel.DownloadFileJob} body
+ */
+
+/**
+ * @typedef GetDiscountParam
+ * @property {string} id - Unique id.
+ */
+
+/**
+ * @typedef GetDiscountsParam
+ * @property {string} [view] - Listing or calender. Default is listing.
+ * @property {string} [q] - The search query. This can be a partial or complete
+ *   name of a discount.
+ * @property {number} [pageNo] - Page number. Default is 1.
+ * @property {number} [pageSize] - Page size. Default is 12.
+ * @property {boolean} [archived] - Archived. Default is false.
+ * @property {number} [month] - Month. Default is current month.
+ * @property {number} [year] - Year. Default is current year.
+ * @property {string} [type] - Basic or custom.
+ * @property {string[]} [appIds] - Application ids.
+ */
+
+/**
+ * @typedef GetDownloadJobParam
+ * @property {string} id - Id
+ */
+
+/**
+ * @typedef GetValidationJobParam
+ * @property {string} id - Id
+ */
+
+/**
+ * @typedef UpdateDiscountParam
+ * @property {string} id - Id
+ * @property {DiscountPlatformModel.CreateUpdateDiscount} body
+ */
+
+/**
+ * @typedef UpsertDiscountItemsParam
+ * @property {string} id - Job ID of the discount.
+ * @property {DiscountPlatformModel.BulkDiscount} body
+ */
+
+/**
+ * @typedef ValidateDiscountFileParam
+ * @property {string} [discount] - Discount
+ * @property {DiscountPlatformModel.FileJobRequest} body
+ */
+
+class DiscountPlatformValidator {
+  /** @returns {CancelDownloadJobParam} */
   static cancelDownloadJob() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {CancelValidationJobParam} */
   static cancelValidationJob() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {CreateDiscountParam} */
   static createDiscount() {
     return Joi.object({
-      body: DiscountModel.CreateUpdateDiscount().required(),
+      body: DiscountPlatformModel.CreateUpdateDiscount().required(),
     }).required();
   }
 
+  /** @returns {DownloadDiscountFileParam} */
   static downloadDiscountFile() {
     return Joi.object({
       type: Joi.string().allow("").required(),
-      body: DiscountModel.DownloadFileJob().required(),
+      body: DiscountPlatformModel.DownloadFileJob().required(),
     }).required();
   }
 
+  /** @returns {GetDiscountParam} */
   static getDiscount() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetDiscountsParam} */
   static getDiscounts() {
     return Joi.object({
       view: Joi.string().allow(""),
@@ -47,38 +122,43 @@ class DiscountValidator {
     }).required();
   }
 
+  /** @returns {GetDownloadJobParam} */
   static getDownloadJob() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetValidationJobParam} */
   static getValidationJob() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {UpdateDiscountParam} */
   static updateDiscount() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: DiscountModel.CreateUpdateDiscount().required(),
+      body: DiscountPlatformModel.CreateUpdateDiscount().required(),
     }).required();
   }
 
+  /** @returns {UpsertDiscountItemsParam} */
   static upsertDiscountItems() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: DiscountModel.BulkDiscount().required(),
+      body: DiscountPlatformModel.BulkDiscount().required(),
     }).required();
   }
 
+  /** @returns {ValidateDiscountFileParam} */
   static validateDiscountFile() {
     return Joi.object({
       discount: Joi.string().allow(""),
-      body: DiscountModel.FileJobRequest().required(),
+      body: DiscountPlatformModel.FileJobRequest().required(),
     }).required();
   }
 }
 
-module.exports = DiscountValidator;
+module.exports = DiscountPlatformValidator;

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

@@ -4,13 +4,12 @@ declare class FileStorage {
     config: any;
     applicationId: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @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
+     * @param {FileStoragePlatformApplicationValidator.AppCompleteUploadParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
+     * @name appCompleteUpload
      * @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.
      *
@@ -30,31 +29,25 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call `appCompleteUpload` api to complete the upload process.
      * This operation will return the url for the uploaded file.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
      */
-    appCompleteUpload({ namespace, body, }?: {
-        namespace: string;
-        body: StartResponse;
-    }): Promise<CompleteResponse>;
+    appCompleteUpload({ namespace, body }?: FileStoragePlatformApplicationValidator.AppCompleteUploadParam, { headers }?: import("../PlatformAPIClient").Options): Promise<FileStoragePlatformModel.CompleteResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {boolean} [arg.sync] - Sync
-     * @param {BulkRequest} arg.body
-     * @returns {Promise<BulkUploadResponse>} - Success response
+     * @param {FileStoragePlatformApplicationValidator.AppCopyFilesParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.BulkUploadResponse>} - Success response
+     * @name appCopyFiles
      * @summary: Copy Files
-     * @description: Copy Files
+     * @description: Copy Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
      */
-    appCopyFiles({ body, sync }?: {
-        sync?: boolean;
-        body: BulkRequest;
-    }): Promise<BulkUploadResponse>;
+    appCopyFiles({ body, sync }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<FileStoragePlatformModel.BulkUploadResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @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
+     * @param {FileStoragePlatformApplicationValidator.AppStartUploadParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
+     * @name appStartUpload
      * @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.
      *
@@ -74,28 +67,24 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call `appCompleteUpload` api to complete the upload process.
      * This operation will return the url for the uploaded file.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
      */
-    appStartUpload({ namespace, body, }?: {
-        namespace: string;
-        body: StartRequest;
-    }): Promise<StartResponse>;
+    appStartUpload({ namespace, body }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { headers }?: import("../PlatformAPIClient").Options): Promise<FileStoragePlatformModel.StartResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
-     * @param {number} [arg.pageNo] - Page no
-     * @returns {Promise<BrowseResponse>} - Success response
+     * @param {FileStoragePlatformApplicationValidator.AppbrowseParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.BrowseResponse>} - Success response
+     * @name appbrowse
      * @summary: Browse Files
-     * @description: Browse Files
+     * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appbrowse/).
      */
-    appbrowse({ namespace, pageNo, }?: {
-        namespace: string;
-        pageNo?: number;
-    }): Promise<BrowseResponse>;
+    appbrowse({ namespace, pageNo }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { headers }?: import("../PlatformAPIClient").Options): Promise<FileStoragePlatformModel.BrowseResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
      * @param {number} arg.companyId - Company_id
      * @param {number} arg.applicationId - Application_id
+     * @returns {Paginator<FileStoragePlatformModel.BrowseResponse>}
      * @summary: Browse Files
      * @description: Browse Files
      */
@@ -103,7 +92,7 @@ declare class FileStorage {
         namespace: string;
         companyId: number;
         applicationId: number;
-    }): Paginator;
+    }): Paginator<FileStoragePlatformModel.BrowseResponse>;
     /**
      * @param data
      * @param {string} file_name
@@ -121,4 +110,6 @@ declare class FileStorage {
         tags: any;
     }): Promise<any>;
 }
+import FileStoragePlatformApplicationValidator = require("./FileStoragePlatformApplicationValidator");
+import FileStoragePlatformModel = require("./FileStoragePlatformModel");
 import Paginator = require("../../common/Paginator");