@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Finance/FinancePlatformValidator.d.ts

@@ -1,16 +1,124 @@
-export = FinanceValidator;
-declare class FinanceValidator {
-    static creditlineDataplatform(): any;
-    static downloadCreditDebitNote(): any;
-    static downloadReport(): any;
-    static generateReport(): any;
-    static getAffiliate(): any;
-    static getData(): any;
-    static getReason(): any;
-    static getReportList(): any;
-    static invoiceListing(): any;
-    static invoicePDF(): any;
-    static invoiceType(): any;
-    static isCreditlinePlatform(): any;
-    static paymentProcess(): any;
+export = FinancePlatformValidator;
+/**
+ * @typedef CreditlineDataplatformParam
+ * @property {FinancePlatformModel.CreditlineDataPlatformRequest} body
+ */
+/**
+ * @typedef DownloadCreditDebitNoteParam
+ * @property {FinancePlatformModel.DownloadCreditDebitNoteRequest} body
+ */
+/**
+ * @typedef DownloadReportParam
+ * @property {FinancePlatformModel.DownloadReport} body
+ */
+/**
+ * @typedef GenerateReportParam
+ * @property {FinancePlatformModel.GenerateReportRequest} body
+ */
+/**
+ * @typedef GetAffiliateParam
+ * @property {FinancePlatformModel.GetAffiliate} body
+ */
+/**
+ * @typedef GetDataParam
+ * @property {FinancePlatformModel.GetEngineRequest} body
+ */
+/**
+ * @typedef GetReasonParam
+ * @property {FinancePlatformModel.GetReasonRequest} body
+ */
+/**
+ * @typedef GetReportListParam
+ * @property {FinancePlatformModel.GetReportListRequest} body
+ */
+/**
+ * @typedef InvoiceListingParam
+ * @property {FinancePlatformModel.InvoiceListingRequest} body
+ */
+/**
+ * @typedef InvoicePDFParam
+ * @property {FinancePlatformModel.InvoicePdfRequest} body
+ */
+/**
+ * @typedef InvoiceTypeParam
+ * @property {FinancePlatformModel.InvoiceTypeRequest} body
+ */
+/**
+ * @typedef IsCreditlinePlatformParam
+ * @property {FinancePlatformModel.IsCreditlinePlatformRequest} body
+ */
+/**
+ * @typedef PaymentProcessParam
+ * @property {FinancePlatformModel.PaymentProcessRequest} body
+ */
+declare class FinancePlatformValidator {
+    /** @returns {CreditlineDataplatformParam} */
+    static creditlineDataplatform(): CreditlineDataplatformParam;
+    /** @returns {DownloadCreditDebitNoteParam} */
+    static downloadCreditDebitNote(): DownloadCreditDebitNoteParam;
+    /** @returns {DownloadReportParam} */
+    static downloadReport(): DownloadReportParam;
+    /** @returns {GenerateReportParam} */
+    static generateReport(): GenerateReportParam;
+    /** @returns {GetAffiliateParam} */
+    static getAffiliate(): GetAffiliateParam;
+    /** @returns {GetDataParam} */
+    static getData(): GetDataParam;
+    /** @returns {GetReasonParam} */
+    static getReason(): GetReasonParam;
+    /** @returns {GetReportListParam} */
+    static getReportList(): GetReportListParam;
+    /** @returns {InvoiceListingParam} */
+    static invoiceListing(): InvoiceListingParam;
+    /** @returns {InvoicePDFParam} */
+    static invoicePDF(): InvoicePDFParam;
+    /** @returns {InvoiceTypeParam} */
+    static invoiceType(): InvoiceTypeParam;
+    /** @returns {IsCreditlinePlatformParam} */
+    static isCreditlinePlatform(): IsCreditlinePlatformParam;
+    /** @returns {PaymentProcessParam} */
+    static paymentProcess(): PaymentProcessParam;
 }
+declare namespace FinancePlatformValidator {
+    export { CreditlineDataplatformParam, DownloadCreditDebitNoteParam, DownloadReportParam, GenerateReportParam, GetAffiliateParam, GetDataParam, GetReasonParam, GetReportListParam, InvoiceListingParam, InvoicePDFParam, InvoiceTypeParam, IsCreditlinePlatformParam, PaymentProcessParam };
+}
+type CreditlineDataplatformParam = {
+    body: FinancePlatformModel.CreditlineDataPlatformRequest;
+};
+type DownloadCreditDebitNoteParam = {
+    body: FinancePlatformModel.DownloadCreditDebitNoteRequest;
+};
+type DownloadReportParam = {
+    body: FinancePlatformModel.DownloadReport;
+};
+type GenerateReportParam = {
+    body: FinancePlatformModel.GenerateReportRequest;
+};
+type GetAffiliateParam = {
+    body: FinancePlatformModel.GetAffiliate;
+};
+type GetDataParam = {
+    body: FinancePlatformModel.GetEngineRequest;
+};
+type GetReasonParam = {
+    body: FinancePlatformModel.GetReasonRequest;
+};
+type GetReportListParam = {
+    body: FinancePlatformModel.GetReportListRequest;
+};
+type InvoiceListingParam = {
+    body: FinancePlatformModel.InvoiceListingRequest;
+};
+type InvoicePDFParam = {
+    body: FinancePlatformModel.InvoicePdfRequest;
+};
+type InvoiceTypeParam = {
+    body: FinancePlatformModel.InvoiceTypeRequest;
+};
+type IsCreditlinePlatformParam = {
+    body: FinancePlatformModel.IsCreditlinePlatformRequest;
+};
+type PaymentProcessParam = {
+    body: FinancePlatformModel.PaymentProcessRequest;
+};
+import FinancePlatformModel = require("./FinancePlatformModel");

package/sdk/platform/Finance/FinancePlatformValidator.js

@@ -1,84 +1,163 @@
 const Joi = require("joi");
 
-const FinanceModel = require("./FinancePlatformModel");
-class FinanceValidator {
+const FinancePlatformModel = require("./FinancePlatformModel");
+
+/**
+ * @typedef CreditlineDataplatformParam
+ * @property {FinancePlatformModel.CreditlineDataPlatformRequest} body
+ */
+
+/**
+ * @typedef DownloadCreditDebitNoteParam
+ * @property {FinancePlatformModel.DownloadCreditDebitNoteRequest} body
+ */
+
+/**
+ * @typedef DownloadReportParam
+ * @property {FinancePlatformModel.DownloadReport} body
+ */
+
+/**
+ * @typedef GenerateReportParam
+ * @property {FinancePlatformModel.GenerateReportRequest} body
+ */
+
+/**
+ * @typedef GetAffiliateParam
+ * @property {FinancePlatformModel.GetAffiliate} body
+ */
+
+/**
+ * @typedef GetDataParam
+ * @property {FinancePlatformModel.GetEngineRequest} body
+ */
+
+/**
+ * @typedef GetReasonParam
+ * @property {FinancePlatformModel.GetReasonRequest} body
+ */
+
+/**
+ * @typedef GetReportListParam
+ * @property {FinancePlatformModel.GetReportListRequest} body
+ */
+
+/**
+ * @typedef InvoiceListingParam
+ * @property {FinancePlatformModel.InvoiceListingRequest} body
+ */
+
+/**
+ * @typedef InvoicePDFParam
+ * @property {FinancePlatformModel.InvoicePdfRequest} body
+ */
+
+/**
+ * @typedef InvoiceTypeParam
+ * @property {FinancePlatformModel.InvoiceTypeRequest} body
+ */
+
+/**
+ * @typedef IsCreditlinePlatformParam
+ * @property {FinancePlatformModel.IsCreditlinePlatformRequest} body
+ */
+
+/**
+ * @typedef PaymentProcessParam
+ * @property {FinancePlatformModel.PaymentProcessRequest} body
+ */
+
+class FinancePlatformValidator {
+  /** @returns {CreditlineDataplatformParam} */
   static creditlineDataplatform() {
     return Joi.object({
-      body: FinanceModel.CreditlineDataPlatformRequest().required(),
+      body: FinancePlatformModel.CreditlineDataPlatformRequest().required(),
     }).required();
   }
 
+  /** @returns {DownloadCreditDebitNoteParam} */
   static downloadCreditDebitNote() {
     return Joi.object({
-      body: FinanceModel.DownloadCreditDebitNoteRequest().required(),
+      body: FinancePlatformModel.DownloadCreditDebitNoteRequest().required(),
     }).required();
   }
 
+  /** @returns {DownloadReportParam} */
   static downloadReport() {
     return Joi.object({
-      body: FinanceModel.DownloadReport().required(),
+      body: FinancePlatformModel.DownloadReport().required(),
     }).required();
   }
 
+  /** @returns {GenerateReportParam} */
   static generateReport() {
     return Joi.object({
-      body: FinanceModel.GenerateReportRequest().required(),
+      body: FinancePlatformModel.GenerateReportRequest().required(),
     }).required();
   }
 
+  /** @returns {GetAffiliateParam} */
   static getAffiliate() {
     return Joi.object({
-      body: FinanceModel.GetAffiliate().required(),
+      body: FinancePlatformModel.GetAffiliate().required(),
     }).required();
   }
 
+  /** @returns {GetDataParam} */
   static getData() {
     return Joi.object({
-      body: FinanceModel.GetEngineRequest().required(),
+      body: FinancePlatformModel.GetEngineRequest().required(),
     }).required();
   }
 
+  /** @returns {GetReasonParam} */
   static getReason() {
     return Joi.object({
-      body: FinanceModel.GetReasonRequest().required(),
+      body: FinancePlatformModel.GetReasonRequest().required(),
     }).required();
   }
 
+  /** @returns {GetReportListParam} */
   static getReportList() {
     return Joi.object({
-      body: FinanceModel.GetReportListRequest().required(),
+      body: FinancePlatformModel.GetReportListRequest().required(),
     }).required();
   }
 
+  /** @returns {InvoiceListingParam} */
   static invoiceListing() {
     return Joi.object({
-      body: FinanceModel.InvoiceListingRequest().required(),
+      body: FinancePlatformModel.InvoiceListingRequest().required(),
     }).required();
   }
 
+  /** @returns {InvoicePDFParam} */
   static invoicePDF() {
     return Joi.object({
-      body: FinanceModel.InvoicePdfRequest().required(),
+      body: FinancePlatformModel.InvoicePdfRequest().required(),
     }).required();
   }
 
+  /** @returns {InvoiceTypeParam} */
   static invoiceType() {
     return Joi.object({
-      body: FinanceModel.InvoiceTypeRequest().required(),
+      body: FinancePlatformModel.InvoiceTypeRequest().required(),
     }).required();
   }
 
+  /** @returns {IsCreditlinePlatformParam} */
   static isCreditlinePlatform() {
     return Joi.object({
-      body: FinanceModel.IsCreditlinePlatformRequest().required(),
+      body: FinancePlatformModel.IsCreditlinePlatformRequest().required(),
     }).required();
   }
 
+  /** @returns {PaymentProcessParam} */
   static paymentProcess() {
     return Joi.object({
-      body: FinanceModel.PaymentProcessRequest().required(),
+      body: FinancePlatformModel.PaymentProcessRequest().required(),
     }).required();
   }
 }
 
-module.exports = FinanceValidator;
+module.exports = FinancePlatformValidator;

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

@@ -3,136 +3,138 @@ 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 {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 }?: InventoryPlatformValidator.CreateJobParam, { headers }?: import("../PlatformAPIClient").Options): 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 {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 }?: InventoryPlatformValidator.DisableParam, { headers }?: import("../PlatformAPIClient").Options): Promise<InventoryPlatformModel.ResponseEnvelopeString>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<ResponseEnvelopeListSlingshotConfigurationDetail>} -
-     *   Success response
+     * @param {InventoryPlatformValidator.GetConfigByCompanyParam} arg - Arg object
+     * @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({ headers }?: any): 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 {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 }?: InventoryPlatformValidator.GetJobByCodeParam, { headers }?: import("../PlatformAPIClient").Options): 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 {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 }?: InventoryPlatformValidator.GetJobByCompanyAndIntegrationParam, { headers }?: import("../PlatformAPIClient").Options): 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 {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 }?: InventoryPlatformValidator.GetJobCodeMetricsParam, { headers }?: import("../PlatformAPIClient").Options): 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 {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 }?: InventoryPlatformValidator.GetJobCodesByCompanyAndIntegrationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigListDTO>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
+     * @param {InventoryPlatformValidator.GetJobConfigDefaultsParam} arg - Arg object
+     * @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({ headers }?: any): 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 {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 }?: InventoryPlatformValidator.GetJobStepsParam, { headers }?: import("../PlatformAPIClient").Options): 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 {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 }?: InventoryPlatformValidator.GetJobsByCompanyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigRawDTO>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {SuppressStorePayload} arg.body
-     * @returns {Promise<ResponseEnvelopeKafkaResponse>} - Success response
+     * @param {InventoryPlatformValidator.SuppressStoresParam} arg - Arg object
+     * @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 }?: InventoryPlatformValidator.SuppressStoresParam, { headers }?: import("../PlatformAPIClient").Options): Promise<InventoryPlatformModel.ResponseEnvelopeKafkaResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {JobConfigDTO} arg.body
-     * @returns {Promise<ResponseEnvelopeString>} - Success response
+     * @param {InventoryPlatformValidator.UpdateJobParam} arg - Arg object
+     * @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 }?: InventoryPlatformValidator.UpdateJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<InventoryPlatformModel.ResponseEnvelopeString>;
 }
+import InventoryPlatformValidator = require("./InventoryPlatformValidator");
+import InventoryPlatformModel = require("./InventoryPlatformModel");