@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0

package/sdk/partner/Webhook/WebhookPartnerValidator.js

@@ -21,7 +21,7 @@ class WebhookValidator {
   static getDeliveryDetailInsights() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: WebhookModel.DeliveryDetailsRequest().required(),
+      body: WebhookModel.DeliveryDetailsPayload().required(),
     }).required();
   }
 
@@ -60,7 +60,7 @@ class WebhookValidator {
   static getInvalidEventList() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: WebhookModel.InvalidEventsRequest().required(),
+      body: WebhookModel.InvalidEventsPayload().required(),
     }).required();
   }
 
@@ -74,7 +74,7 @@ class WebhookValidator {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
       subscriberId: Joi.number().required(),
-      body: WebhookModel.UpdateSubscriberRequest().required(),
+      body: WebhookModel.SubscriberUpdate().required(),
     }).required();
   }
 }

package/sdk/partner/index.d.ts

@@ -1,12 +1,9 @@
 export const PartnerConfig: typeof import("./PartnerConfig");
 export const PartnerClient: typeof import("./PartnerClient");
 export namespace PartnerModel {
-    const AuthorizationPartnerModel: typeof import("./Authorization/AuthorizationPartnerModel");
-    const CatalogPartnerModel: typeof import("./Catalog/CatalogPartnerModel");
     const FileStoragePartnerModel: typeof import("./FileStorage/FileStoragePartnerModel");
     const LeadPartnerModel: typeof import("./Lead/LeadPartnerModel");
     const LogisticsPartnerModel: typeof import("./Logistics/LogisticsPartnerModel");
-    const PaymentPartnerModel: typeof import("./Payment/PaymentPartnerModel");
     const ThemePartnerModel: typeof import("./Theme/ThemePartnerModel");
     const WebhookPartnerModel: typeof import("./Webhook/WebhookPartnerModel");
 }

package/sdk/partner/index.js

@@ -2,18 +2,12 @@ module.exports = {
   PartnerConfig: require("./PartnerConfig"),
   PartnerClient: require("./PartnerClient"),
   PartnerModel: {
-    AuthorizationPartnerModel: require("./Authorization/AuthorizationPartnerModel"),
-
-    CatalogPartnerModel: require("./Catalog/CatalogPartnerModel"),
-
     FileStoragePartnerModel: require("./FileStorage/FileStoragePartnerModel"),
 
     LeadPartnerModel: require("./Lead/LeadPartnerModel"),
 
     LogisticsPartnerModel: require("./Logistics/LogisticsPartnerModel"),
 
-    PaymentPartnerModel: require("./Payment/PaymentPartnerModel"),
-
     ThemePartnerModel: require("./Theme/ThemePartnerModel"),
 
     WebhookPartnerModel: require("./Webhook/WebhookPartnerModel"),

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts

@@ -9,7 +9,7 @@ export = AnalyticsPlatformApplicationValidator;
  */
 /**
  * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType
+ * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
  * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
  */
 declare class AnalyticsPlatformApplicationValidator {
@@ -33,6 +33,9 @@ type ExecuteJobForProvidedParametersV2Param = {
     body: AnalyticsPlatformModel.JobExecute;
 };
 type StartDownloadForQueryV2Param = {
+    /**
+     * - Format in which to be exported(eg. CSV or excel).
+     */
     exportType: string;
     body: AnalyticsPlatformModel.FileDownloadRequestBody;
 };

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -14,7 +14,7 @@ const AnalyticsPlatformModel = require("./AnalyticsPlatformModel");
 
 /**
  * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType
+ * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
  * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
  */
 

package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts

@@ -8,7 +8,7 @@ export = AnalyticsPlatformModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
- * @property {number} [total] - Total number of items.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef FileDownloadRequestBody
@@ -73,9 +73,9 @@ type Page = {
      */
     size?: number;
     /**
-     * - Total number of items.
+     * - The number of items per page.
      */
-    total?: number;
+    page_size?: number;
 };
 /** @returns {FileDownloadRequestBody} */
 declare function FileDownloadRequestBody(): FileDownloadRequestBody;

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -9,7 +9,7 @@ const Joi = require("joi");
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
- * @property {number} [total] - Total number of items.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -53,7 +53,7 @@ class AnalyticsPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
-      total: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 
@@ -85,7 +85,7 @@ class AnalyticsPlatformModel {
   static JobStatus() {
     return Joi.object({
       start_date: Joi.string().allow(""),
-      end_date: Joi.string().allow(""),
+      end_date: Joi.string().allow("").allow(null),
       status: Joi.string().allow(""),
       message: Joi.string().allow(""),
       file_metadata: Joi.array().items(Joi.any()).allow(null, ""),

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts

@@ -6,42 +6,12 @@ declare class AuditTrail {
      * @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
+     * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
      * @name createAuditLog
      * @summary: Create an audit log
      * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
      */
-    createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResponse>;
-    /**
-     * @param {AuditTrailPlatformValidator.GetAuditLogParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
-     * @name getAuditLog
-     * @summary: Get an audit log
-     * @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
-     */
-    getAuditLog({ id, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
-    /**
-     * @param {AuditTrailPlatformValidator.GetAuditLogsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
-     * @name getAuditLogs
-     * @summary: Get audit logs
-     * @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
-     */
-    getAuditLogs({ qs, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
-    /**
-     * @param {AuditTrailPlatformValidator.GetEntityTypesParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
-     * @name getEntityTypes
-     * @summary: List entity types
-     * @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
-     */
-    getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
+    createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResp>;
 }
 import AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
 import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -18,7 +18,7 @@ class AuditTrail {
    * @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
+   * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
    * @name createAuditLog
    * @summary: Create an audit log
    * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
@@ -60,7 +60,7 @@ class AuditTrail {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs`,
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/audit/logs/create`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -74,7 +74,7 @@ class AuditTrail {
 
     const {
       error: res_error,
-    } = AuditTrailPlatformModel.CreateLogResponse().validate(responseData, {
+    } = AuditTrailPlatformModel.CreateLogResp().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -92,246 +92,6 @@ class AuditTrail {
 
     return response;
   }
-
-  /**
-   * @param {AuditTrailPlatformValidator.GetAuditLogParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
-   * @name getAuditLog
-   * @summary: Get an audit log
-   * @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
-   */
-  async getAuditLog(
-    { id, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = AuditTrailPlatformValidator.getAuditLog().validate(
-      {
-        id,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AuditTrailPlatformValidator.getAuditLog().validate(
-      {
-        id,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > AuditTrail > getAuditLog \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > AuditTrail > getAuditLog \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {AuditTrailPlatformValidator.GetAuditLogsParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
-   * @name getAuditLogs
-   * @summary: Get audit logs
-   * @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
-   */
-  async getAuditLogs(
-    { qs, limit, sort, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = AuditTrailPlatformValidator.getAuditLogs().validate(
-      {
-        qs,
-        limit,
-        sort,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AuditTrailPlatformValidator.getAuditLogs().validate(
-      {
-        qs,
-        limit,
-        sort,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > AuditTrail > getAuditLogs \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["qs"] = qs;
-    query_params["limit"] = limit;
-    query_params["sort"] = sort;
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > AuditTrail > getAuditLogs \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {AuditTrailPlatformValidator.GetEntityTypesParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
-   * @name getEntityTypes
-   * @summary: List entity types
-   * @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
-   */
-  async getEntityTypes(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = AuditTrailPlatformValidator.getEntityTypes().validate(
-      {},
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AuditTrailPlatformValidator.getEntityTypes().validate(
-      {},
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > AuditTrail > getEntityTypes \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AuditTrailPlatformModel.EntityTypesResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > AuditTrail > getEntityTypes \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
 }
 
 module.exports = AuditTrail;