@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -3,136 +3,150 @@ declare class Inventory {
     constructor(config: any);
     config: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {JobConfigDTO} arg.body
-     * @returns {Promise<ResponseEnvelopeString>} - Success response
+     * @param {InventoryPlatformValidator.CreateJobParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
+     *   Success response
+     * @name createJob
      * @summary: Creates A New Job Config
-     * @description: REST Endpoint that creates a new job config
+     * @description: REST Endpoint that creates a new job config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/createJob/).
      */
-    createJob({ body }?: {
-        body: JobConfigDTO;
-    }): Promise<ResponseEnvelopeString>;
+    createJob({ body, requestHeaders }?: InventoryPlatformValidator.CreateJobParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeString>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.integrationId - IntegrationId
-     * @returns {Promise<ResponseEnvelopeString>} - Success response
+     * @param {InventoryPlatformValidator.DisableParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
+     *   Success response
+     * @name disable
      * @summary: Disable Job Config
-     * @description: REST Endpoint that disables Inventory Job Config
+     * @description: REST Endpoint that disables Inventory Job Config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/disable/).
      */
-    disable({ integrationId }?: {
-        integrationId: string;
-    }): Promise<ResponseEnvelopeString>;
+    disable({ integrationId, requestHeaders }?: InventoryPlatformValidator.DisableParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeString>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<ResponseEnvelopeListSlingshotConfigurationDetail>} -
-     *   Success response
+     * @param {InventoryPlatformValidator.GetConfigByCompanyParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListSlingshotConfigurationDetail>}
+     *   - Success response
+     *
+     * @name getConfigByCompany
      * @summary: Get Slingshot Configuration Of  A Company
-     * @description: REST Endpoint that returns all configuration detail of a company
+     * @description: REST Endpoint that returns all configuration detail of a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getConfigByCompany/).
      */
-    getConfigByCompany({}?: any): Promise<ResponseEnvelopeListSlingshotConfigurationDetail>;
+    getConfigByCompany({ requestHeaders }?: any, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListSlingshotConfigurationDetail>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.code - Job Code
-     * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
+     * @param {InventoryPlatformValidator.GetJobByCodeParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>}
+     *   - Success response
+     *
+     * @name getJobByCode
      * @summary: Get Job Config By Code
-     * @description: REST Endpoint that returns job config by code
+     * @description: REST Endpoint that returns job config by code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobByCode/).
      */
-    getJobByCode({ code }?: {
-        code: string;
-    }): Promise<ResponseEnvelopeJobConfigDTO>;
+    getJobByCode({ code, requestHeaders }?: InventoryPlatformValidator.GetJobByCodeParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.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
+     * @param {InventoryPlatformValidator.GetJobByCompanyAndIntegrationParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigDTO>}
+     *   - Success response
+     *
+     * @name getJobByCompanyAndIntegration
      * @summary: Get Job Configs By Company And Integration
-     * @description: REST Endpoint that returns all job configs by company And integration
+     * @description: REST Endpoint that returns all job configs by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobByCompanyAndIntegration/).
      */
-    getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize, }?: {
-        integrationId: string;
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<ResponseEnvelopeListJobConfigDTO>;
+    getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize, requestHeaders }?: InventoryPlatformValidator.GetJobByCompanyAndIntegrationParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigDTO>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.code - Code
-     * @param {number} [arg.pageNo] - Page Number
-     * @param {number} [arg.pageSize] - Page Size
-     * @param {string} [arg.status] - Status
-     * @param {string} [arg.date] - From Date
-     * @returns {Promise<ResponseEnvelopeJobMetricsDto>} - Success response
+     * @param {InventoryPlatformValidator.GetJobCodeMetricsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobMetricsDto>}
+     *   - Success response
+     *
+     * @name getJobCodeMetrics
      * @summary: Get Job Metrics
-     * @description: REST Endpoint that returns Inventory Run History For A Job Code
+     * @description: REST Endpoint that returns Inventory Run History For A Job Code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobCodeMetrics/).
      */
-    getJobCodeMetrics({ code, pageNo, pageSize, status, date }?: {
-        code: string;
-        pageNo?: number;
-        pageSize?: number;
-        status?: string;
-        date?: string;
-    }): Promise<ResponseEnvelopeJobMetricsDto>;
+    getJobCodeMetrics({ code, pageNo, pageSize, status, date, requestHeaders }?: InventoryPlatformValidator.GetJobCodeMetricsParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.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
+     * @param {InventoryPlatformValidator.GetJobCodesByCompanyAndIntegrationParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigListDTO>}
+     *   - Success response
+     *
+     * @name getJobCodesByCompanyAndIntegration
      * @summary: Get Job Codes By Company And Integration
-     * @description: REST Endpoint that returns all job codes by company And integration
+     * @description: REST Endpoint that returns all job codes by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobCodesByCompanyAndIntegration/).
      */
-    getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize, }?: {
-        integrationId: string;
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<ResponseEnvelopeListJobConfigListDTO>;
+    getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize, requestHeaders }?: InventoryPlatformValidator.GetJobCodesByCompanyAndIntegrationParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigListDTO>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
+     * @param {InventoryPlatformValidator.GetJobConfigDefaultsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>}
+     *   - Success response
+     *
+     * @name getJobConfigDefaults
      * @summary: Get Job Configs Defaults
-     * @description: REST Endpoint that returns default fields job configs by company And integration
+     * @description: REST Endpoint that returns default fields job configs by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobConfigDefaults/).
      */
-    getJobConfigDefaults({}?: any): Promise<ResponseEnvelopeJobConfigDTO>;
+    getJobConfigDefaults({ requestHeaders }?: any, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {number} arg.jobId - Job Id
-     * @returns {Promise<ResponseEnvelopeListJobStepsDTO>} - Success response
+     * @param {InventoryPlatformValidator.GetJobStepsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobStepsDTO>}
+     *   - Success response
+     *
+     * @name getJobSteps
      * @summary: Get Job Code Steps
-     * @description: REST Endpoint that returns Inventory Job Steps
+     * @description: REST Endpoint that returns Inventory Job Steps - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobSteps/).
      */
-    getJobSteps({ jobId }?: {
-        jobId: number;
-    }): Promise<ResponseEnvelopeListJobStepsDTO>;
+    getJobSteps({ jobId, requestHeaders }?: InventoryPlatformValidator.GetJobStepsParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListJobStepsDTO>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - Page Number
-     * @param {number} [arg.pageSize] - Page Size
-     * @returns {Promise<ResponseEnvelopeListJobConfigRawDTO>} - Success response
+     * @param {InventoryPlatformValidator.GetJobsByCompanyParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigRawDTO>}
+     *   - Success response
+     *
+     * @name getJobsByCompany
      * @summary: Get Job Configs For A Company
-     * @description: REST Endpoint that returns all job configs for a company
+     * @description: REST Endpoint that returns all job configs for a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobsByCompany/).
      */
-    getJobsByCompany({ pageNo, pageSize }?: {
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<ResponseEnvelopeListJobConfigRawDTO>;
+    getJobsByCompany({ pageNo, pageSize, requestHeaders }?: InventoryPlatformValidator.GetJobsByCompanyParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigRawDTO>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {SuppressStorePayload} arg.body
-     * @returns {Promise<ResponseEnvelopeKafkaResponse>} - Success response
+     * @param {InventoryPlatformValidator.SuppressStoresParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeKafkaResponse>}
+     *   - Success response
+     *
+     * @name suppressStores
      * @summary: Get Slingshot Configuration Of  A Company
-     * @description: REST Endpoint that returns all configuration detail of a company
+     * @description: REST Endpoint that returns all configuration detail of a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/suppressStores/).
      */
-    suppressStores({ body }?: {
-        body: SuppressStorePayload;
-    }): Promise<ResponseEnvelopeKafkaResponse>;
+    suppressStores({ body, requestHeaders }?: InventoryPlatformValidator.SuppressStoresParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeKafkaResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {JobConfigDTO} arg.body
-     * @returns {Promise<ResponseEnvelopeString>} - Success response
+     * @param {InventoryPlatformValidator.UpdateJobParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
+     *   Success response
+     * @name updateJob
      * @summary: Updates An Existing Job Config
-     * @description: REST Endpoint that updates a job config
+     * @description: REST Endpoint that updates a job config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/updateJob/).
      */
-    updateJob({ body }?: {
-        body: JobConfigDTO;
-    }): Promise<ResponseEnvelopeString>;
+    updateJob({ body, requestHeaders }?: InventoryPlatformValidator.UpdateJobParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeString>;
 }
+import InventoryPlatformValidator = require("./InventoryPlatformValidator");
+import InventoryPlatformModel = require("./InventoryPlatformModel");