@gofynd/fdk-client-javascript 1.5.2 → 1.6.1

package/sdk/application/Webhook/WebhookApplicationClient.js

@@ -1,3 +1,8 @@
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+
 const ApplicationAPIClient = require("../ApplicationAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
@@ -37,6 +42,14 @@ class Webhook {
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const query_params = {};
 
     const xHeaders = {};

package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts

@@ -142,5 +142,15 @@ declare class FileStorage {
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveProxyDetails/).
      */
     saveProxyDetails({ body, requestHeaders }?: FileStoragePartnerValidator.SaveProxyDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SaveProxy>;
+    /**
+     * @param {FileStoragePartnerValidator.SignUrlsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePartnerModel.SignUrlResult>} - Success response
+     * @name signUrls
+     * @summary: Signs file URLs
+     * @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/signUrls/).
+     */
+    signUrls({ body, requestHeaders }?: FileStoragePartnerValidator.SignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SignUrlResult>;
 }
 import FileStoragePartnerModel = require("./FileStoragePartnerModel");

package/sdk/partner/FileStorage/FileStoragePartnerClient.js

@@ -853,5 +853,80 @@ class FileStorage {
 
     return response;
   }
+
+  /**
+   * @param {FileStoragePartnerValidator.SignUrlsParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PartnerAPIClient").Options} - Options
+   * @returns {Promise<FileStoragePartnerModel.SignUrlResult>} - Success response
+   * @name signUrls
+   * @summary: Signs file URLs
+   * @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/signUrls/).
+   */
+  async signUrls(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = FileStoragePartnerValidator.signUrls().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStoragePartnerValidator.signUrls().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for partner > FileStorage > signUrls \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PartnerAPIClient.execute(
+      this.config,
+      "post",
+      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/sign-urls`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = FileStoragePartnerModel.SignUrlResult().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 partner > FileStorage > signUrls \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
 }
 module.exports = FileStorage;

package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts

@@ -95,10 +95,26 @@ export = FileStoragePartnerModel;
  * @typedef FailedBrowseFilesResult
  * @property {string} message
  */
+/**
+ * @typedef SignedUrl
+ * @property {string} url - This is the original asset URL provided in the
+ *   request. This is the URL for which a signed URL has been generated.
+ * @property {string} signed_url - Generated signed URL.
+ * @property {number} expiry - The expiration time for the signed URL in seconds.
+ */
+/**
+ * @typedef SignUrlResult
+ * @property {SignedUrl[]} urls - Signed URL object.
+ */
+/**
+ * @typedef SignUrl
+ * @property {number} expiry - The expiration time for the signed URL.
+ * @property {string[]} urls - List of asset URLs to be signed.
+ */
 declare class FileStoragePartnerModel {
 }
 declare namespace FileStoragePartnerModel {
-    export { SizeConstraints, SaveProxy, ProxyFileData, ProxyFile, FetchProxyDetails, NamespaceDetails, AllNamespaceDetails, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, FailedBrowseFilesResult };
+    export { SizeConstraints, SaveProxy, ProxyFileData, ProxyFile, FetchProxyDetails, NamespaceDetails, AllNamespaceDetails, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, FailedBrowseFilesResult, SignedUrl, SignUrlResult, SignUrl };
 }
 /** @returns {SizeConstraints} */
 declare function SizeConstraints(): SizeConstraints;
@@ -222,3 +238,40 @@ declare function FailedBrowseFilesResult(): FailedBrowseFilesResult;
 type FailedBrowseFilesResult = {
     message: string;
 };
+/** @returns {SignedUrl} */
+declare function SignedUrl(): SignedUrl;
+type SignedUrl = {
+    /**
+     * - This is the original asset URL provided in the
+     * request. This is the URL for which a signed URL has been generated.
+     */
+    url: string;
+    /**
+     * - Generated signed URL.
+     */
+    signed_url: string;
+    /**
+     * - The expiration time for the signed URL in seconds.
+     */
+    expiry: number;
+};
+/** @returns {SignUrlResult} */
+declare function SignUrlResult(): SignUrlResult;
+type SignUrlResult = {
+    /**
+     * - Signed URL object.
+     */
+    urls: SignedUrl[];
+};
+/** @returns {SignUrl} */
+declare function SignUrl(): SignUrl;
+type SignUrl = {
+    /**
+     * - The expiration time for the signed URL.
+     */
+    expiry: number;
+    /**
+     * - List of asset URLs to be signed.
+     */
+    urls: string[];
+};

package/sdk/partner/FileStorage/FileStoragePartnerModel.js

@@ -110,6 +110,25 @@ const Joi = require("joi");
  * @property {string} message
  */
 
+/**
+ * @typedef SignedUrl
+ * @property {string} url - This is the original asset URL provided in the
+ *   request. This is the URL for which a signed URL has been generated.
+ * @property {string} signed_url - Generated signed URL.
+ * @property {number} expiry - The expiration time for the signed URL in seconds.
+ */
+
+/**
+ * @typedef SignUrlResult
+ * @property {SignedUrl[]} urls - Signed URL object.
+ */
+
+/**
+ * @typedef SignUrl
+ * @property {number} expiry - The expiration time for the signed URL.
+ * @property {string[]} urls - List of asset URLs to be signed.
+ */
+
 class FileStoragePartnerModel {
   /** @returns {SizeConstraints} */
   static SizeConstraints() {
@@ -249,5 +268,29 @@ class FileStoragePartnerModel {
       message: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {SignedUrl} */
+  static SignedUrl() {
+    return Joi.object({
+      url: Joi.string().allow("").required(),
+      signed_url: Joi.string().allow("").required(),
+      expiry: Joi.number().required(),
+    });
+  }
+
+  /** @returns {SignUrlResult} */
+  static SignUrlResult() {
+    return Joi.object({
+      urls: Joi.array().items(FileStoragePartnerModel.SignedUrl()).required(),
+    });
+  }
+
+  /** @returns {SignUrl} */
+  static SignUrl() {
+    return Joi.object({
+      expiry: Joi.number().required(),
+      urls: Joi.array().items(Joi.string().allow("")).required(),
+    });
+  }
 }
 module.exports = FileStoragePartnerModel;

package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts

@@ -10,4 +10,5 @@ declare class FileStorageValidator {
     static saveOrganizationLevelProxy(): any;
     static fetchProxy(): any;
     static saveProxyDetails(): any;
+    static signUrls(): any;
 }

package/sdk/partner/FileStorage/FileStoragePartnerValidator.js

@@ -75,6 +75,12 @@ class FileStorageValidator {
       body: FileStorageModel.ProxyFile().required(),
     }).required();
   }
+
+  static signUrls() {
+    return Joi.object({
+      body: FileStorageModel.SignUrl().required(),
+    }).required();
+  }
 }
 
 module.exports = FileStorageValidator;

package/sdk/partner/Webhook/WebhookPartnerModel.d.ts

@@ -171,7 +171,7 @@ export = WebhookPartnerModel;
  */
 /**
  * @typedef DeliveryTsResult
- * @property {DeliveryTsSchema[]} [delivery_ts]
+ * @property {DeliveryTsSchema[]} [delivery_ts] - List of delivery timestamps.
  */
 /**
  * @typedef DeliveryTsSchema
@@ -251,7 +251,8 @@ export = WebhookPartnerModel;
  */
 /**
  * @typedef ResponseTimeTs
- * @property {AvgResponseTime[]} [avg_response_time_ts]
+ * @property {AvgResponseTime[]} [avg_response_time_ts] - List of average
+ *   response time timestamps.
  */
 /**
  * @typedef AvgResponseTime
@@ -266,7 +267,8 @@ export = WebhookPartnerModel;
  */
 /**
  * @typedef DeliverySummaryResult
- * @property {DeliveryEventLevelSchema[]} [delivery_event_level]
+ * @property {DeliveryEventLevelSchema[]} [delivery_event_level] - List of
+ *   delivery event levels.
  * @property {DeliverySummarySchema} [delivery_summary]
  */
 /**
@@ -694,6 +696,9 @@ type FilterReportResult = {
 /** @returns {DeliveryTsResult} */
 declare function DeliveryTsResult(): DeliveryTsResult;
 type DeliveryTsResult = {
+    /**
+     * - List of delivery timestamps.
+     */
     delivery_ts?: DeliveryTsSchema[];
 };
 /** @returns {DeliveryTsSchema} */
@@ -908,6 +913,10 @@ type DeliveryEventLevelSchema = {
 /** @returns {ResponseTimeTs} */
 declare function ResponseTimeTs(): ResponseTimeTs;
 type ResponseTimeTs = {
+    /**
+     * - List of average
+     * response time timestamps.
+     */
     avg_response_time_ts?: AvgResponseTime[];
 };
 /** @returns {AvgResponseTime} */
@@ -940,6 +949,10 @@ type AvgResponseTime = {
 /** @returns {DeliverySummaryResult} */
 declare function DeliverySummaryResult(): DeliverySummaryResult;
 type DeliverySummaryResult = {
+    /**
+     * - List of
+     * delivery event levels.
+     */
     delivery_event_level?: DeliveryEventLevelSchema[];
     delivery_summary?: DeliverySummarySchema;
 };

package/sdk/partner/Webhook/WebhookPartnerModel.js

@@ -192,7 +192,7 @@ const Joi = require("joi");
 
 /**
  * @typedef DeliveryTsResult
- * @property {DeliveryTsSchema[]} [delivery_ts]
+ * @property {DeliveryTsSchema[]} [delivery_ts] - List of delivery timestamps.
  */
 
 /**
@@ -280,7 +280,8 @@ const Joi = require("joi");
 
 /**
  * @typedef ResponseTimeTs
- * @property {AvgResponseTime[]} [avg_response_time_ts]
+ * @property {AvgResponseTime[]} [avg_response_time_ts] - List of average
+ *   response time timestamps.
  */
 
 /**
@@ -297,7 +298,8 @@ const Joi = require("joi");
 
 /**
  * @typedef DeliverySummaryResult
- * @property {DeliveryEventLevelSchema[]} [delivery_event_level]
+ * @property {DeliveryEventLevelSchema[]} [delivery_event_level] - List of
+ *   delivery event levels.
  * @property {DeliverySummarySchema} [delivery_summary]
  */
 

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/AuditTrail/AuditTrailPlatformModel.d.ts

@@ -2,71 +2,94 @@ export = AuditTrailPlatformModel;
 /**
  * @typedef RequestBodyAuditLog
  * @property {LogMetaObj} log_meta
- * @property {Object} log_payload
+ * @property {Object} log_payload - Detailed information about payload.
  */
 /**
  * @typedef CreateLogResp
- * @property {string} [message]
- * @property {string} [internal_message]
+ * @property {string} [message] - Acknowledgement about success or failure of audit log.
+ * @property {string} [internal_message] - Status of audit log in internal system.
  */
 /**
  * @typedef LogMetaObj
- * @property {Object} [modifier]
- * @property {string} [application]
+ * @property {Object} [modifier] - Details about user responsible for modifying events.
+ * @property {string} [application] - The application id generating the log event.
  * @property {EntityObject} [entity]
- * @property {Object} [device_info]
- * @property {Object} [location]
- * @property {string} [sessions]
+ * @property {Object} [device_info] - Contains device-specific information for
+ *   the log event.
+ * @property {Object} [location] - Holds location-related data for the event context.
+ * @property {string} [sessions] - Identifies the session associated with the log event.
  */
 /**
  * @typedef EntityObject
- * @property {string} [id]
- * @property {string} [type]
- * @property {string} [action]
- */
-/**
- * @typedef BadRequestSchema
- * @property {string} [message] - Failure message.
+ * @property {string} [id] - Unique identifier for the entity.
+ * @property {string} [type] - The type/category of the entity.
+ * @property {string} [action] - The action performed on or by the entity.
  */
 declare class AuditTrailPlatformModel {
 }
 declare namespace AuditTrailPlatformModel {
-    export { RequestBodyAuditLog, CreateLogResp, LogMetaObj, EntityObject, BadRequestSchema };
+    export { RequestBodyAuditLog, CreateLogResp, LogMetaObj, EntityObject };
 }
 /** @returns {RequestBodyAuditLog} */
 declare function RequestBodyAuditLog(): RequestBodyAuditLog;
 type RequestBodyAuditLog = {
     log_meta: LogMetaObj;
+    /**
+     * - Detailed information about payload.
+     */
     log_payload: any;
 };
 /** @returns {CreateLogResp} */
 declare function CreateLogResp(): CreateLogResp;
 type CreateLogResp = {
+    /**
+     * - Acknowledgement about success or failure of audit log.
+     */
     message?: string;
+    /**
+     * - Status of audit log in internal system.
+     */
     internal_message?: string;
 };
 /** @returns {LogMetaObj} */
 declare function LogMetaObj(): LogMetaObj;
 type LogMetaObj = {
+    /**
+     * - Details about user responsible for modifying events.
+     */
     modifier?: any;
+    /**
+     * - The application id generating the log event.
+     */
     application?: string;
     entity?: EntityObject;
+    /**
+     * - Contains device-specific information for
+     * the log event.
+     */
     device_info?: any;
+    /**
+     * - Holds location-related data for the event context.
+     */
     location?: any;
+    /**
+     * - Identifies the session associated with the log event.
+     */
     sessions?: string;
 };
 /** @returns {EntityObject} */
 declare function EntityObject(): EntityObject;
 type EntityObject = {
+    /**
+     * - Unique identifier for the entity.
+     */
     id?: string;
+    /**
+     * - The type/category of the entity.
+     */
     type?: string;
-    action?: string;
-};
-/** @returns {BadRequestSchema} */
-declare function BadRequestSchema(): BadRequestSchema;
-type BadRequestSchema = {
     /**
-     * - Failure message.
+     * - The action performed on or by the entity.
      */
-    message?: string;
+    action?: string;
 };

package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js

@@ -3,35 +3,31 @@ const Joi = require("joi");
 /**
  * @typedef RequestBodyAuditLog
  * @property {LogMetaObj} log_meta
- * @property {Object} log_payload
+ * @property {Object} log_payload - Detailed information about payload.
  */
 
 /**
  * @typedef CreateLogResp
- * @property {string} [message]
- * @property {string} [internal_message]
+ * @property {string} [message] - Acknowledgement about success or failure of audit log.
+ * @property {string} [internal_message] - Status of audit log in internal system.
  */
 
 /**
  * @typedef LogMetaObj
- * @property {Object} [modifier]
- * @property {string} [application]
+ * @property {Object} [modifier] - Details about user responsible for modifying events.
+ * @property {string} [application] - The application id generating the log event.
  * @property {EntityObject} [entity]
- * @property {Object} [device_info]
- * @property {Object} [location]
- * @property {string} [sessions]
+ * @property {Object} [device_info] - Contains device-specific information for
+ *   the log event.
+ * @property {Object} [location] - Holds location-related data for the event context.
+ * @property {string} [sessions] - Identifies the session associated with the log event.
  */
 
 /**
  * @typedef EntityObject
- * @property {string} [id]
- * @property {string} [type]
- * @property {string} [action]
- */
-
-/**
- * @typedef BadRequestSchema
- * @property {string} [message] - Failure message.
+ * @property {string} [id] - Unique identifier for the entity.
+ * @property {string} [type] - The type/category of the entity.
+ * @property {string} [action] - The action performed on or by the entity.
  */
 
 class AuditTrailPlatformModel {
@@ -71,12 +67,5 @@ class AuditTrailPlatformModel {
       action: Joi.string().allow(""),
     });
   }
-
-  /** @returns {BadRequestSchema} */
-  static BadRequestSchema() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
 }
 module.exports = AuditTrailPlatformModel;