@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/platform/FileStorage/FileStoragePlatformModel.js

@@ -1,243 +1,160 @@
 const Joi = require("joi");
 
 class FileStorageModel {
-  static FailedResponse() {
-    return Joi.object({
-      message: Joi.string().allow("").required(),
-    });
-  }
-
-  static CDN() {
+  static BrowseResponse() {
     return Joi.object({
-      url: Joi.string().allow("").required(),
-
-      absolute_url: Joi.string().allow(""),
-
-      relative_url: Joi.string().allow(""),
+      items: Joi.array().items(FileStorageModel.DbRecord()).required(),
+      page: FileStorageModel.Page().required(),
     });
   }
-
-  static Upload() {
+  static BulkRequest() {
     return Joi.object({
-      expiry: Joi.number().required(),
-
-      url: Joi.string().allow("").required(),
+      configuration: FileStorageModel.ReqConfiguration(),
+      destination: FileStorageModel.Destination().required(),
+      urls: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
-
-  static StartResponse() {
+  static BulkUploadResponse() {
     return Joi.object({
-      file_name: Joi.string().allow("").required(),
-
-      file_path: Joi.string().allow("").required(),
-
-      content_type: Joi.string().allow("").required(),
-
-      method: Joi.string().allow(""),
-
-      namespace: Joi.string().allow("").required(),
-
-      operation: Joi.string().allow("").required(),
-
-      size: Joi.number().required(),
-
-      upload: FileStorageModel.Upload().required(),
-
-      cdn: FileStorageModel.CDN().required(),
-
-      tags: Joi.array().items(Joi.string().allow("")),
+      task: FileStorageModel.CopyFileTask().required(),
+      tracking_url: Joi.string().allow("").required(),
     });
   }
-
-  static StartRequest() {
+  static CDN() {
     return Joi.object({
-      file_name: Joi.string().allow("").required(),
-
-      content_type: Joi.string().allow("").required(),
-
-      size: Joi.number().required(),
-
-      tags: Joi.array().items(Joi.string().allow("")),
-
-      params: Joi.any(),
+      absolute_url: Joi.string().allow(""),
+      relative_url: Joi.string().allow(""),
+      url: Joi.string().allow("").required(),
     });
   }
-
   static CompleteResponse() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
-
+      cdn: FileStorageModel.CDN().required(),
+      content_type: Joi.string().allow("").required(),
+      created_on: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
-
       file_path: Joi.string().allow("").required(),
-
-      content_type: Joi.string().allow("").required(),
-
+      modified_on: Joi.string().allow("").required(),
       namespace: Joi.string().allow("").required(),
-
       operation: Joi.string().allow("").required(),
-
       size: Joi.number().required(),
-
-      upload: FileStorageModel.Upload().required(),
-
-      cdn: FileStorageModel.CDN().required(),
-
       success: Joi.boolean().required(),
-
       tags: Joi.array().items(Joi.string().allow("")),
-
-      created_on: Joi.string().allow("").required(),
-
-      modified_on: Joi.string().allow("").required(),
-    });
-  }
-
-  static Opts() {
-    return Joi.object({
-      attempts: Joi.number(),
-
-      timestamp: Joi.number(),
-
-      delay: Joi.number(),
+      upload: FileStorageModel.Upload().required(),
     });
   }
-
   static CopyFileTask() {
     return Joi.object({
+      attempts_made: Joi.number().required(),
+      data: FileStorageModel.BulkRequest().required(),
+      delay: Joi.number().required(),
+      finished_on: Joi.number().required(),
       id: Joi.string().allow("").required(),
-
       name: Joi.string().allow("").required(),
-
-      data: FileStorageModel.BulkRequest().required(),
-
       opts: FileStorageModel.Opts().required(),
-
+      processed_on: Joi.number().required(),
       progress: Joi.number().required(),
-
-      delay: Joi.number().required(),
-
-      timestamp: Joi.number().required(),
-
-      attempts_made: Joi.number().required(),
-
       stacktrace: Joi.array().items(Joi.string().allow("")),
-
-      finished_on: Joi.number().required(),
-
-      processed_on: Joi.number().required(),
-    });
-  }
-
-  static BulkUploadResponse() {
-    return Joi.object({
-      tracking_url: Joi.string().allow("").required(),
-
-      task: FileStorageModel.CopyFileTask().required(),
+      timestamp: Joi.number().required(),
     });
   }
-
-  static ReqConfiguration() {
+  static DbRecord() {
     return Joi.object({
-      concurrency: Joi.number(),
+      _id: Joi.string().allow("").required(),
+      cdn: FileStorageModel.CDN().required(),
+      content_type: Joi.string().allow("").required(),
+      created_on: Joi.string().allow("").required(),
+      file_name: Joi.string().allow("").required(),
+      file_path: Joi.string().allow("").required(),
+      modified_on: Joi.string().allow("").required(),
+      namespace: Joi.string().allow("").required(),
+      operation: Joi.string().allow(""),
+      success: Joi.boolean().required(),
+      tags: Joi.array().items(Joi.string().allow("")).required(),
+      upload: FileStorageModel.Upload().required(),
     });
   }
-
   static Destination() {
     return Joi.object({
+      basepath: Joi.string().allow(""),
       namespace: Joi.string().allow("").required(),
-
       rewrite: Joi.string().allow("").required(),
-
-      basepath: Joi.string().allow(""),
     });
   }
-
-  static BulkRequest() {
+  static FailedResponse() {
     return Joi.object({
-      urls: Joi.array().items(Joi.string().allow("")).required(),
-
-      destination: FileStorageModel.Destination().required(),
-
-      configuration: FileStorageModel.ReqConfiguration(),
+      message: Joi.string().allow("").required(),
     });
   }
-
-  static Urls() {
+  static Opts() {
     return Joi.object({
-      url: Joi.string().allow("").required(),
-
-      signed_url: Joi.string().allow("").required(),
-
-      expiry: Joi.number().required(),
+      attempts: Joi.number(),
+      delay: Joi.number(),
+      timestamp: Joi.number(),
     });
   }
-
-  static SignUrlResponse() {
+  static Page() {
     return Joi.object({
-      urls: Joi.array().items(FileStorageModel.Urls()).required(),
+      current: Joi.number(),
+      has_next: Joi.boolean(),
+      has_previous: Joi.boolean(),
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      size: Joi.number(),
+      type: Joi.string().allow("").required(),
+    });
+  }
+  static ReqConfiguration() {
+    return Joi.object({
+      concurrency: Joi.number(),
     });
   }
-
   static SignUrlRequest() {
     return Joi.object({
       expiry: Joi.number().required(),
-
       urls: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
-
-  static Page() {
+  static SignUrlResponse() {
     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(),
+      urls: Joi.array().items(FileStorageModel.Urls()).required(),
     });
   }
-
-  static DbRecord() {
+  static StartRequest() {
     return Joi.object({
-      success: Joi.boolean().required(),
-
-      tags: Joi.array().items(Joi.string().allow("")).required(),
-
-      _id: Joi.string().allow("").required(),
-
+      content_type: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
-
-      operation: Joi.string().allow(""),
-
-      namespace: Joi.string().allow("").required(),
-
+      params: Joi.any(),
+      size: Joi.number().required(),
+      tags: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+  static StartResponse() {
+    return Joi.object({
+      cdn: FileStorageModel.CDN().required(),
       content_type: Joi.string().allow("").required(),
-
+      file_name: Joi.string().allow("").required(),
       file_path: Joi.string().allow("").required(),
-
+      method: Joi.string().allow(""),
+      namespace: Joi.string().allow("").required(),
+      operation: Joi.string().allow("").required(),
+      size: Joi.number().required(),
+      tags: Joi.array().items(Joi.string().allow("")),
       upload: FileStorageModel.Upload().required(),
-
-      cdn: FileStorageModel.CDN().required(),
-
-      created_on: Joi.string().allow("").required(),
-
-      modified_on: Joi.string().allow("").required(),
     });
   }
-
-  static BrowseResponse() {
+  static Upload() {
     return Joi.object({
-      items: Joi.array().items(FileStorageModel.DbRecord()).required(),
-
-      page: FileStorageModel.Page().required(),
+      expiry: Joi.number().required(),
+      url: Joi.string().allow("").required(),
+    });
+  }
+  static Urls() {
+    return Joi.object({
+      expiry: Joi.number().required(),
+      signed_url: Joi.string().allow("").required(),
+      url: Joi.string().allow("").required(),
     });
   }
 }

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

@@ -1,9 +1,9 @@
 export = FileStorageValidator;
 declare class FileStorageValidator {
-    static startUpload(): any;
+    static browse(): any;
     static completeUpload(): any;
-    static getSignUrls(): any;
     static copyFiles(): any;
-    static browse(): any;
+    static getSignUrls(): any;
     static proxy(): any;
+    static startUpload(): any;
 }

package/sdk/platform/FileStorage/FileStoragePlatformValidator.js

@@ -2,10 +2,10 @@ const Joi = require("joi");
 
 const FileStorageModel = require("./FileStoragePlatformModel");
 class FileStorageValidator {
-  static startUpload() {
+  static browse() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStorageModel.StartRequest().required(),
+      pageNo: Joi.number(),
     }).required();
   }
 
@@ -16,12 +16,6 @@ class FileStorageValidator {
     }).required();
   }
 
-  static getSignUrls() {
-    return Joi.object({
-      body: FileStorageModel.SignUrlRequest().required(),
-    }).required();
-  }
-
   static copyFiles() {
     return Joi.object({
       sync: Joi.boolean(),
@@ -29,10 +23,9 @@ class FileStorageValidator {
     }).required();
   }
 
-  static browse() {
+  static getSignUrls() {
     return Joi.object({
-      namespace: Joi.string().allow("").required(),
-      pageNo: Joi.number(),
+      body: FileStorageModel.SignUrlRequest().required(),
     }).required();
   }
 
@@ -41,5 +34,12 @@ class FileStorageValidator {
       url: Joi.string().allow("").required(),
     }).required();
   }
+
+  static startUpload() {
+    return Joi.object({
+      namespace: Joi.string().allow("").required(),
+      body: FileStorageModel.StartRequest().required(),
+    }).required();
+  }
 }
 module.exports = FileStorageValidator;

package/sdk/platform/Inventory/InventoryPlatformClient.d.ts

@@ -2,96 +2,58 @@ export = Inventory;
 declare class Inventory {
     constructor(config: any);
     config: any;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - Page Number
-     * @param {number} [arg.pageSize] - Page Size
-     * @summary: Get Job Configs For A Company
-     * @description: REST Endpoint that returns all job configs for a company
-     */
-    getJobsByCompany({ pageNo, pageSize }?: {
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {JobConfigDTO} arg.body
-     * @summary: Updates An Existing Job Config
-     * @description: REST Endpoint that updates a job config
-     */
-    updateJob({ body }?: {
-        body: JobConfigDTO;
-    }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {JobConfigDTO} arg.body
+     * @returns {Promise<ResponseEnvelopeString>} - Success response
      * @summary: Creates A New Job Config
      * @description: REST Endpoint that creates a new job config
      */
     createJob({ body }?: {
         body: JobConfigDTO;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeString>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {SuppressStorePayload} arg.body
-     * @summary: Get Slingshot Configuration Of  A Company
-     * @description: REST Endpoint that returns all configuration detail of a company
+     * @param {string} arg.integrationId - IntegrationId
+     * @returns {Promise<ResponseEnvelopeString>} - Success response
+     * @summary: Disable Job Config
+     * @description: REST Endpoint that disables Inventory Job Config
      */
-    suppressStores({ body }?: {
-        body: SuppressStorePayload;
-    }): Promise<any>;
+    disable({ integrationId }?: {
+        integrationId: string;
+    }): Promise<ResponseEnvelopeString>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<ResponseEnvelopeListSlingshotConfigurationDetail>} -
+     *   Success response
      * @summary: Get Slingshot Configuration Of  A Company
      * @description: REST Endpoint that returns all configuration detail of a company
      */
-    getConfigByCompany({}?: any): Promise<any>;
+    getConfigByCompany({}?: any): Promise<ResponseEnvelopeListSlingshotConfigurationDetail>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} arg.jobId - Job Id
-     * @summary: Get Job Code Steps
-     * @description: REST Endpoint that returns Inventory Job Steps
+     * @param {string} arg.code - Job Code
+     * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
+     * @summary: Get Job Config By Code
+     * @description: REST Endpoint that returns job config by code
      */
-    getJobSteps({ jobId }?: {
-        jobId: number;
-    }): Promise<any>;
+    getJobByCode({ code }?: {
+        code: string;
+    }): Promise<ResponseEnvelopeJobConfigDTO>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.integrationId - Integration Id
      * @param {number} [arg.pageNo] - Page Number
      * @param {number} [arg.pageSize] - Page Size
+     * @returns {Promise<ResponseEnvelopeListJobConfigDTO>} - Success response
      * @summary: Get Job Configs By Company And Integration
      * @description: REST Endpoint that returns all job configs by company And integration
      */
-    getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize }?: {
+    getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize, }?: {
         integrationId: string;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.integrationId - IntegrationId
-     * @summary: Disable Job Config
-     * @description: REST Endpoint that disables Inventory Job Config
-     */
-    disable({ integrationId }?: {
-        integrationId: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get Job Configs Defaults
-     * @description: REST Endpoint that returns default fields job configs by company And integration
-     */
-    getJobConfigDefaults({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.code - Job Code
-     * @summary: Get Job Config By Code
-     * @description: REST Endpoint that returns job config by code
-     */
-    getJobByCode({ code }?: {
-        code: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeListJobConfigDTO>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.code - Code
@@ -99,6 +61,7 @@ declare class Inventory {
      * @param {number} [arg.pageSize] - Page Size
      * @param {string} [arg.status] - Status
      * @param {string} [arg.date] - From Date
+     * @returns {Promise<ResponseEnvelopeJobMetricsDto>} - Success response
      * @summary: Get Job Metrics
      * @description: REST Endpoint that returns Inventory Run History For A Job Code
      */
@@ -108,18 +71,68 @@ declare class Inventory {
         pageSize?: number;
         status?: string;
         date?: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeJobMetricsDto>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.integrationId - Integration Id
      * @param {number} [arg.pageNo] - Page Number
      * @param {number} [arg.pageSize] - Page Size
+     * @returns {Promise<ResponseEnvelopeListJobConfigListDTO>} - Success response
      * @summary: Get Job Codes By Company And Integration
      * @description: REST Endpoint that returns all job codes by company And integration
      */
-    getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize }?: {
+    getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize, }?: {
         integrationId: string;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeListJobConfigListDTO>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
+     * @summary: Get Job Configs Defaults
+     * @description: REST Endpoint that returns default fields job configs by company And integration
+     */
+    getJobConfigDefaults({}?: any): Promise<ResponseEnvelopeJobConfigDTO>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.jobId - Job Id
+     * @returns {Promise<ResponseEnvelopeListJobStepsDTO>} - Success response
+     * @summary: Get Job Code Steps
+     * @description: REST Endpoint that returns Inventory Job Steps
+     */
+    getJobSteps({ jobId }?: {
+        jobId: number;
+    }): Promise<ResponseEnvelopeListJobStepsDTO>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Page Number
+     * @param {number} [arg.pageSize] - Page Size
+     * @returns {Promise<ResponseEnvelopeListJobConfigRawDTO>} - Success response
+     * @summary: Get Job Configs For A Company
+     * @description: REST Endpoint that returns all job configs for a company
+     */
+    getJobsByCompany({ pageNo, pageSize }?: {
+        pageNo?: number;
+        pageSize?: number;
+    }): Promise<ResponseEnvelopeListJobConfigRawDTO>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SuppressStorePayload} arg.body
+     * @returns {Promise<ResponseEnvelopeKafkaResponse>} - Success response
+     * @summary: Get Slingshot Configuration Of  A Company
+     * @description: REST Endpoint that returns all configuration detail of a company
+     */
+    suppressStores({ body }?: {
+        body: SuppressStorePayload;
+    }): Promise<ResponseEnvelopeKafkaResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {JobConfigDTO} arg.body
+     * @returns {Promise<ResponseEnvelopeString>} - Success response
+     * @summary: Updates An Existing Job Config
+     * @description: REST Endpoint that updates a job config
+     */
+    updateJob({ body }?: {
+        body: JobConfigDTO;
+    }): Promise<ResponseEnvelopeString>;
 }