@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts

@@ -1,19 +1,19 @@
 export = ServiceabilityPlatformValidator;
 /**
  * @typedef BulkServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
  */
 /**
  * @typedef BulkTatParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
  */
 /**
  * @typedef CreateCourierPartnerAccountParam
- * @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
  */
 /**
  * @typedef CreatePackageMaterialParam
@@ -30,8 +30,8 @@ export = ServiceabilityPlatformValidator;
 /** @typedef GetAllStoresParam */
 /**
  * @typedef GetBulkServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [batchId] - Unique identifier of bulk job
@@ -44,8 +44,8 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef GetBulkTatParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [batchId] - Unique identifier of bulk job
@@ -59,7 +59,7 @@ export = ServiceabilityPlatformValidator;
 /** @typedef GetCompanyConfigurationParam */
 /**
  * @typedef GetCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier account
+ * @property {string} accountId - Unique ID of courier partner account
  */
 /**
  * @typedef GetCourierPartnerAccountsParam
@@ -71,7 +71,7 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef GetOptimalLocationsParam
- * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
+ * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
  */
 /**
  * @typedef GetPackageMaterialListParam
@@ -94,13 +94,12 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef GetPackageMaterialsParam
- * @property {string} packageMaterialId - A `package_material_id` is a unique
- *   identifier for a Package Material
+ * @property {string} packageMaterialId - Unique identifier for a Package. Material
  */
 /**
  * @typedef GetServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
  * @property {string} regionId - Unique identifier of a region
  */
 /**
@@ -126,8 +125,8 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef UpdateCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier account
- * @property {ServiceabilityPlatformModel.CourierAccount} body
+ * @property {string} accountId - Unique ID of courier partner account
+ * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
  */
 /**
  * @typedef UpdatePackageMaterialRuleParam
@@ -137,14 +136,13 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef UpdatePackageMaterialsParam
- * @property {string} packageMaterialId - A `package_material_id` is a unique
- *   identifier for a Package Material
+ * @property {string} packageMaterialId - Unique identifier for a Package. Material
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 /**
  * @typedef UpdateServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
  * @property {string} regionId - Unique identifier of a region
  * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
  */
@@ -212,28 +210,28 @@ declare namespace ServiceabilityPlatformValidator {
 }
 type BulkServiceabilityParam = {
     /**
-     * - Unique Identifier of CP Extension
+     * - Unique Identifier of courier partner extension.
      */
     extensionId: string;
     /**
-     * - Unique identifier of a scheme
+     * - Unique identifier of courier partner scheme.
      */
     schemeId: string;
-    body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
+    body: ServiceabilityPlatformModel.BulkRegionJobDetails;
 };
 type BulkTatParam = {
     /**
-     * - Unique Identifier of CP Extension
+     * - Unique Identifier of courier partner extension.
      */
     extensionId: string;
     /**
-     * - Unique identifier of a scheme
+     * - Unique identifier of courier partner scheme.
      */
     schemeId: string;
-    body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
+    body: ServiceabilityPlatformModel.BulkRegionJobDetails;
 };
 type CreateCourierPartnerAccountParam = {
-    body: ServiceabilityPlatformModel.CourierAccountRequestBody;
+    body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
 };
 type CreatePackageMaterialParam = {
     body: ServiceabilityPlatformModel.PackageMaterial;
@@ -246,11 +244,11 @@ type CreateZoneParam = {
 };
 type GetBulkServiceabilityParam = {
     /**
-     * - Unique Identifier of CP Extension
+     * - Unique Identifier of courier partner extension.
      */
     extensionId: string;
     /**
-     * - Unique identifier of a scheme
+     * - Unique identifier of courier partner scheme.
      */
     schemeId: string;
     /**
@@ -292,11 +290,11 @@ type GetBulkServiceabilityParam = {
 };
 type GetBulkTatParam = {
     /**
-     * - Unique Identifier of CP Extension
+     * - Unique Identifier of courier partner extension.
      */
     extensionId: string;
     /**
-     * - Unique identifier of a scheme
+     * - Unique identifier of courier partner scheme.
      */
     schemeId: string;
     /**
@@ -338,7 +336,7 @@ type GetBulkTatParam = {
 };
 type GetCourierPartnerAccountParam = {
     /**
-     * - Unique ID of courier account
+     * - Unique ID of courier partner account
      */
     accountId: string;
 };
@@ -365,7 +363,7 @@ type GetCourierPartnerAccountsParam = {
     transportType?: string;
 };
 type GetOptimalLocationsParam = {
-    body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
+    body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema;
 };
 type GetPackageMaterialListParam = {
     /**
@@ -412,18 +410,17 @@ type GetPackageMaterialRulesParam = {
 };
 type GetPackageMaterialsParam = {
     /**
-     * - A `package_material_id` is a unique
-     * identifier for a Package Material
+     * - Unique identifier for a Package. Material
      */
     packageMaterialId: string;
 };
 type GetServiceabilityParam = {
     /**
-     * - Unique Identifier of CP Extension
+     * - Unique Identifier of courier partner extension.
      */
     extensionId: string;
     /**
-     * - Unique identifier of a scheme
+     * - Unique identifier of courier partner scheme.
      */
     schemeId: string;
     /**
@@ -484,10 +481,10 @@ type UpdateCompanyConfigurationParam = {
 };
 type UpdateCourierPartnerAccountParam = {
     /**
-     * - Unique ID of courier account
+     * - Unique ID of courier partner account
      */
     accountId: string;
-    body: ServiceabilityPlatformModel.CourierAccount;
+    body: ServiceabilityPlatformModel.CourierAccountUpdateDetails;
 };
 type UpdatePackageMaterialRuleParam = {
     /**
@@ -499,19 +496,18 @@ type UpdatePackageMaterialRuleParam = {
 };
 type UpdatePackageMaterialsParam = {
     /**
-     * - A `package_material_id` is a unique
-     * identifier for a Package Material
+     * - Unique identifier for a Package. Material
      */
     packageMaterialId: string;
     body: ServiceabilityPlatformModel.PackageMaterial;
 };
 type UpdateServiceabilityParam = {
     /**
-     * - Unique Identifier of CP Extension
+     * - Unique Identifier of courier partner extension.
      */
     extensionId: string;
     /**
-     * - Unique identifier of a scheme
+     * - Unique identifier of courier partner scheme.
      */
     schemeId: string;
     /**

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -4,21 +4,21 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef BulkServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
  */
 
 /**
  * @typedef BulkTatParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
  */
 
 /**
  * @typedef CreateCourierPartnerAccountParam
- * @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
  */
 
 /**
@@ -40,8 +40,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetBulkServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [batchId] - Unique identifier of bulk job
@@ -55,8 +55,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetBulkTatParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [batchId] - Unique identifier of bulk job
@@ -72,7 +72,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier account
+ * @property {string} accountId - Unique ID of courier partner account
  */
 
 /**
@@ -86,7 +86,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetOptimalLocationsParam
- * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
+ * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
  */
 
 /**
@@ -113,14 +113,13 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetPackageMaterialsParam
- * @property {string} packageMaterialId - A `package_material_id` is a unique
- *   identifier for a Package Material
+ * @property {string} packageMaterialId - Unique identifier for a Package. Material
  */
 
 /**
  * @typedef GetServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
  * @property {string} regionId - Unique identifier of a region
  */
 
@@ -150,8 +149,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdateCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier account
- * @property {ServiceabilityPlatformModel.CourierAccount} body
+ * @property {string} accountId - Unique ID of courier partner account
+ * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
  */
 
 /**
@@ -163,15 +162,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdatePackageMaterialsParam
- * @property {string} packageMaterialId - A `package_material_id` is a unique
- *   identifier for a Package Material
+ * @property {string} packageMaterialId - Unique identifier for a Package. Material
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 
 /**
  * @typedef UpdateServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier of courier partner scheme.
  * @property {string} regionId - Unique identifier of a region
  * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
  */
@@ -188,7 +186,7 @@ class ServiceabilityPlatformValidator {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
       schemeId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.BulkRegionJobSerializer().required(),
+      body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
     }).required();
   }
 
@@ -197,14 +195,14 @@ class ServiceabilityPlatformValidator {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
       schemeId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.BulkRegionJobSerializer().required(),
+      body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
     }).required();
   }
 
   /** @returns {CreateCourierPartnerAccountParam} */
   static createCourierPartnerAccount() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CourierAccountRequestBody().required(),
+      body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
     }).required();
   }
 
@@ -294,7 +292,7 @@ class ServiceabilityPlatformValidator {
   /** @returns {GetOptimalLocationsParam} */
   static getOptimalLocations() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema().required(),
+      body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema().required(),
     }).required();
   }
 
@@ -375,7 +373,7 @@ class ServiceabilityPlatformValidator {
   static updateCourierPartnerAccount() {
     return Joi.object({
       accountId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.CourierAccount().required(),
+      body: ServiceabilityPlatformModel.CourierAccountUpdateDetails().required(),
     }).required();
   }
 

package/sdk/platform/Share/SharePlatformApplicationClient.d.ts

@@ -9,7 +9,7 @@ declare class Share {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
      * @name createShortLink
-     * @summary: Create short link
+     * @summary: Create short link.
      * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
      */
     createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
@@ -19,7 +19,7 @@ declare class Share {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
      * @name getShortLinkByHash
-     * @summary: Get short link by hash
+     * @summary: Get short link by hash.
      * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
      */
     getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
@@ -29,12 +29,12 @@ declare class Share {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
+     * @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
      * @name getShortLinkClickStats
      * @summary: Get short link click statistics
      * @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
      */
-    getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResponse>;
+    getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResult>;
     /**
      * @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -53,7 +53,7 @@ declare class Share {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
      * @name updateShortLinkById
-     * @summary: Update short link
+     * @summary: Update short link by ID.
      * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
      */
     updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;

package/sdk/platform/Share/SharePlatformApplicationClient.js

@@ -21,7 +21,7 @@ class Share {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
    * @name createShortLink
-   * @summary: Create short link
+   * @summary: Create short link.
    * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
    */
   async createShortLink(
@@ -61,7 +61,7 @@ class Share {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link`,
       query_params,
       body,
       requestHeaders,
@@ -100,7 +100,7 @@ class Share {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
    * @name getShortLinkByHash
-   * @summary: Get short link by hash
+   * @summary: Get short link by hash.
    * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
    */
   async getShortLinkByHash(
@@ -140,7 +140,7 @@ class Share {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}`,
       query_params,
       undefined,
       requestHeaders,
@@ -179,7 +179,7 @@ class Share {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
+   * @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
    * @name getShortLinkClickStats
    * @summary: Get short link click statistics
    * @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
@@ -232,7 +232,7 @@ class Share {
 
     const {
       error: res_error,
-    } = SharePlatformModel.ClickStatsResponse().validate(responseData, {
+    } = SharePlatformModel.ClickStatsResult().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -325,7 +325,7 @@ class Share {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link`,
       query_params,
       undefined,
       requestHeaders,
@@ -366,7 +366,7 @@ class Share {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
    * @name updateShortLinkById
-   * @summary: Update short link
+   * @summary: Update short link by ID.
    * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
    */
   async updateShortLinkById(
@@ -408,7 +408,7 @@ class Share {
     const response = await PlatformAPIClient.execute(
       this.config,
       "patch",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}`,
       query_params,
       body,
       requestHeaders,

package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts

@@ -5,7 +5,7 @@ export = SharePlatformApplicationValidator;
  */
 /**
  * @typedef GetShortLinkByHashParam
- * @property {string} hash - Hash of short url
+ * @property {string} hash
  */
 /**
  * @typedef GetShortLinkClickStatsParam
@@ -24,7 +24,7 @@ export = SharePlatformApplicationValidator;
  */
 /**
  * @typedef UpdateShortLinkByIdParam
- * @property {string} id - Short link document identifier
+ * @property {string} id - Document Id
  * @property {SharePlatformModel.ShortLinkReq} body
  */
 declare class SharePlatformApplicationValidator {
@@ -46,9 +46,6 @@ type CreateShortLinkParam = {
     body: SharePlatformModel.ShortLinkReq;
 };
 type GetShortLinkByHashParam = {
-    /**
-     * - Hash of short url
-     */
     hash: string;
 };
 type GetShortLinkClickStatsParam = {
@@ -90,7 +87,7 @@ type GetShortLinksParam = {
 };
 type UpdateShortLinkByIdParam = {
     /**
-     * - Short link document identifier
+     * - Document Id
      */
     id: string;
     body: SharePlatformModel.ShortLinkReq;

package/sdk/platform/Share/SharePlatformApplicationValidator.js

@@ -9,7 +9,7 @@ const SharePlatformModel = require("./SharePlatformModel");
 
 /**
  * @typedef GetShortLinkByHashParam
- * @property {string} hash - Hash of short url
+ * @property {string} hash
  */
 
 /**
@@ -31,7 +31,7 @@ const SharePlatformModel = require("./SharePlatformModel");
 
 /**
  * @typedef UpdateShortLinkByIdParam
- * @property {string} id - Short link document identifier
+ * @property {string} id - Document Id
  * @property {SharePlatformModel.ShortLinkReq} body
  */