@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,21 +1,283 @@
-export = ServiceabilityValidator;
-declare class ServiceabilityValidator {
-    static createZone(): any;
+export = ServiceabilityPlatformValidator;
+/**
+ * @typedef CreateZoneParam
+ * @property {ServiceabilityPlatformModel.ZoneRequest} body
+ */
+/** @typedef GetAllStoresParam */
+/**
+ * @typedef GetCompanyStoreViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ */
+/**
+ * @typedef GetDpAccountParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [stage] - Stage of the account. enabled/disabled
+ * @property {string} [paymentMode] - Filters dp accounts based on payment mode
+ * @property {string} [transportType] - Filters dp accounts based on transport_type
+ */
+/** @typedef GetDpCompanyRulesParam */
+/**
+ * @typedef GetDpRuleInsertParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ */
+/**
+ * @typedef GetDpRulesParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
+ */
+/**
+ * @typedef GetEntityRegionViewParam
+ * @property {ServiceabilityPlatformModel.EntityRegionView_Request} body
+ */
+/**
+ * @typedef GetListViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [name] - Name of particular zone in the seller account
+ * @property {boolean} [isActive] - Status of zone whether active or inactive
+ * @property {string} [channelIds] - Zones associated with the given channel ids'
+ * @property {string} [q] - Search with name as a free text
+ */
+/**
+ * @typedef GetOptimalLocationsParam
+ * @property {ServiceabilityPlatformModel.ReAssignStoreRequest} body
+ */
+/**
+ * @typedef GetStoreParam
+ * @property {number} storeUid - A `store_uid` contains a specific ID of a store.
+ */
+/**
+ * @typedef GetZoneDataViewParam
+ * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
+ */
+/**
+ * @typedef GetZoneListViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @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} [name] - Name of particular zone in the seller account
+ * @property {boolean} [isActive] - Status of zone whether active or inactive
+ * @property {string} [channelIds] - Zones associated with the given channel ids'
+ * @property {string} [q] - Search with name as a free text
+ * @property {string[]} [zoneId] - List of zones to query for
+ */
+/**
+ * @typedef UpdateDpRuleParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
+ * @property {ServiceabilityPlatformModel.DpRulesUpdateRequest} body
+ */
+/**
+ * @typedef UpdateZoneControllerViewParam
+ * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
+ * @property {ServiceabilityPlatformModel.ZoneUpdateRequest} body
+ */
+/**
+ * @typedef UpsertDpAccountParam
+ * @property {ServiceabilityPlatformModel.CompanyDpAccountRequest} body
+ */
+/**
+ * @typedef UpsertDpCompanyRulesParam
+ * @property {ServiceabilityPlatformModel.DPCompanyRuleRequest} body
+ */
+/**
+ * @typedef UpsertDpRulesParam
+ * @property {ServiceabilityPlatformModel.DpRuleRequest} body
+ */
+declare class ServiceabilityPlatformValidator {
+    /** @returns {CreateZoneParam} */
+    static createZone(): CreateZoneParam;
+    /** @returns {GetAllStoresParam} */
     static getAllStores(): any;
-    static getCompanyStoreView(): any;
-    static getDpAccount(): any;
+    /** @returns {GetCompanyStoreViewParam} */
+    static getCompanyStoreView(): GetCompanyStoreViewParam;
+    /** @returns {GetDpAccountParam} */
+    static getDpAccount(): GetDpAccountParam;
+    /** @returns {GetDpCompanyRulesParam} */
     static getDpCompanyRules(): any;
-    static getDpRuleInsert(): any;
-    static getDpRules(): any;
-    static getEntityRegionView(): any;
-    static getListView(): any;
-    static getOptimalLocations(): any;
-    static getStore(): any;
-    static getZoneDataView(): any;
-    static getZoneListView(): any;
-    static updateDpRule(): any;
-    static updateZoneControllerView(): any;
-    static upsertDpAccount(): any;
-    static upsertDpCompanyRules(): any;
-    static upsertDpRules(): any;
+    /** @returns {GetDpRuleInsertParam} */
+    static getDpRuleInsert(): GetDpRuleInsertParam;
+    /** @returns {GetDpRulesParam} */
+    static getDpRules(): GetDpRulesParam;
+    /** @returns {GetEntityRegionViewParam} */
+    static getEntityRegionView(): GetEntityRegionViewParam;
+    /** @returns {GetListViewParam} */
+    static getListView(): GetListViewParam;
+    /** @returns {GetOptimalLocationsParam} */
+    static getOptimalLocations(): GetOptimalLocationsParam;
+    /** @returns {GetStoreParam} */
+    static getStore(): GetStoreParam;
+    /** @returns {GetZoneDataViewParam} */
+    static getZoneDataView(): GetZoneDataViewParam;
+    /** @returns {GetZoneListViewParam} */
+    static getZoneListView(): GetZoneListViewParam;
+    /** @returns {UpdateDpRuleParam} */
+    static updateDpRule(): UpdateDpRuleParam;
+    /** @returns {UpdateZoneControllerViewParam} */
+    static updateZoneControllerView(): UpdateZoneControllerViewParam;
+    /** @returns {UpsertDpAccountParam} */
+    static upsertDpAccount(): UpsertDpAccountParam;
+    /** @returns {UpsertDpCompanyRulesParam} */
+    static upsertDpCompanyRules(): UpsertDpCompanyRulesParam;
+    /** @returns {UpsertDpRulesParam} */
+    static upsertDpRules(): UpsertDpRulesParam;
 }
+declare namespace ServiceabilityPlatformValidator {
+    export { CreateZoneParam, GetAllStoresParam, GetCompanyStoreViewParam, GetDpAccountParam, GetDpCompanyRulesParam, GetDpRuleInsertParam, GetDpRulesParam, GetEntityRegionViewParam, GetListViewParam, GetOptimalLocationsParam, GetStoreParam, GetZoneDataViewParam, GetZoneListViewParam, UpdateDpRuleParam, UpdateZoneControllerViewParam, UpsertDpAccountParam, UpsertDpCompanyRulesParam, UpsertDpRulesParam };
+}
+type CreateZoneParam = {
+    body: ServiceabilityPlatformModel.ZoneRequest;
+};
+type GetCompanyStoreViewParam = {
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNumber?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+};
+type GetDpAccountParam = {
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNumber?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - Stage of the account. enabled/disabled
+     */
+    stage?: string;
+    /**
+     * - Filters dp accounts based on payment mode
+     */
+    paymentMode?: string;
+    /**
+     * - Filters dp accounts based on transport_type
+     */
+    transportType?: string;
+};
+type GetDpRuleInsertParam = {
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNumber?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+};
+type GetDpRulesParam = {
+    /**
+     * - A `rule_uid` is a unique identifier for a particular Dp.
+     */
+    ruleUid: string;
+};
+type GetEntityRegionViewParam = {
+    body: ServiceabilityPlatformModel.EntityRegionView_Request;
+};
+type GetListViewParam = {
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNumber?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - Name of particular zone in the seller account
+     */
+    name?: string;
+    /**
+     * - Status of zone whether active or inactive
+     */
+    isActive?: boolean;
+    /**
+     * - Zones associated with the given channel ids'
+     */
+    channelIds?: string;
+    /**
+     * - Search with name as a free text
+     */
+    q?: string;
+};
+type GetOptimalLocationsParam = {
+    body: ServiceabilityPlatformModel.ReAssignStoreRequest;
+};
+type GetStoreParam = {
+    /**
+     * - A `store_uid` contains a specific ID of a store.
+     */
+    storeUid: number;
+};
+type GetZoneDataViewParam = {
+    /**
+     * - A `zone_id` is a unique identifier for a particular zone.
+     */
+    zoneId: string;
+};
+type GetZoneListViewParam = {
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNumber?: number;
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNo?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - Name of particular zone in the seller account
+     */
+    name?: string;
+    /**
+     * - Status of zone whether active or inactive
+     */
+    isActive?: boolean;
+    /**
+     * - Zones associated with the given channel ids'
+     */
+    channelIds?: string;
+    /**
+     * - Search with name as a free text
+     */
+    q?: string;
+    /**
+     * - List of zones to query for
+     */
+    zoneId?: string[];
+};
+type UpdateDpRuleParam = {
+    /**
+     * - A `rule_uid` is a unique identifier for a particular Dp.
+     */
+    ruleUid: string;
+    body: ServiceabilityPlatformModel.DpRulesUpdateRequest;
+};
+type UpdateZoneControllerViewParam = {
+    /**
+     * - A `zone_id` is a unique identifier for a particular zone.
+     */
+    zoneId: string;
+    body: ServiceabilityPlatformModel.ZoneUpdateRequest;
+};
+type UpsertDpAccountParam = {
+    body: ServiceabilityPlatformModel.CompanyDpAccountRequest;
+};
+type UpsertDpCompanyRulesParam = {
+    body: ServiceabilityPlatformModel.DPCompanyRuleRequest;
+};
+type UpsertDpRulesParam = {
+    body: ServiceabilityPlatformModel.DpRuleRequest;
+};
+type GetAllStoresParam = any;
+type GetDpCompanyRulesParam = any;
+import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -1,17 +1,125 @@
 const Joi = require("joi");
 
-const ServiceabilityModel = require("./ServiceabilityPlatformModel");
-class ServiceabilityValidator {
+const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
+
+/**
+ * @typedef CreateZoneParam
+ * @property {ServiceabilityPlatformModel.ZoneRequest} body
+ */
+
+/** @typedef GetAllStoresParam */
+
+/**
+ * @typedef GetCompanyStoreViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ */
+
+/**
+ * @typedef GetDpAccountParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [stage] - Stage of the account. enabled/disabled
+ * @property {string} [paymentMode] - Filters dp accounts based on payment mode
+ * @property {string} [transportType] - Filters dp accounts based on transport_type
+ */
+
+/** @typedef GetDpCompanyRulesParam */
+
+/**
+ * @typedef GetDpRuleInsertParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ */
+
+/**
+ * @typedef GetDpRulesParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
+ */
+
+/**
+ * @typedef GetEntityRegionViewParam
+ * @property {ServiceabilityPlatformModel.EntityRegionView_Request} body
+ */
+
+/**
+ * @typedef GetListViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [name] - Name of particular zone in the seller account
+ * @property {boolean} [isActive] - Status of zone whether active or inactive
+ * @property {string} [channelIds] - Zones associated with the given channel ids'
+ * @property {string} [q] - Search with name as a free text
+ */
+
+/**
+ * @typedef GetOptimalLocationsParam
+ * @property {ServiceabilityPlatformModel.ReAssignStoreRequest} body
+ */
+
+/**
+ * @typedef GetStoreParam
+ * @property {number} storeUid - A `store_uid` contains a specific ID of a store.
+ */
+
+/**
+ * @typedef GetZoneDataViewParam
+ * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
+ */
+
+/**
+ * @typedef GetZoneListViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @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} [name] - Name of particular zone in the seller account
+ * @property {boolean} [isActive] - Status of zone whether active or inactive
+ * @property {string} [channelIds] - Zones associated with the given channel ids'
+ * @property {string} [q] - Search with name as a free text
+ * @property {string[]} [zoneId] - List of zones to query for
+ */
+
+/**
+ * @typedef UpdateDpRuleParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
+ * @property {ServiceabilityPlatformModel.DpRulesUpdateRequest} body
+ */
+
+/**
+ * @typedef UpdateZoneControllerViewParam
+ * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
+ * @property {ServiceabilityPlatformModel.ZoneUpdateRequest} body
+ */
+
+/**
+ * @typedef UpsertDpAccountParam
+ * @property {ServiceabilityPlatformModel.CompanyDpAccountRequest} body
+ */
+
+/**
+ * @typedef UpsertDpCompanyRulesParam
+ * @property {ServiceabilityPlatformModel.DPCompanyRuleRequest} body
+ */
+
+/**
+ * @typedef UpsertDpRulesParam
+ * @property {ServiceabilityPlatformModel.DpRuleRequest} body
+ */
+
+class ServiceabilityPlatformValidator {
+  /** @returns {CreateZoneParam} */
   static createZone() {
     return Joi.object({
-      body: ServiceabilityModel.ZoneRequest().required(),
+      body: ServiceabilityPlatformModel.ZoneRequest().required(),
     }).required();
   }
 
+  /** @returns {GetAllStoresParam} */
   static getAllStores() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetCompanyStoreViewParam} */
   static getCompanyStoreView() {
     return Joi.object({
       pageNumber: Joi.number(),
@@ -19,6 +127,7 @@ class ServiceabilityValidator {
     }).required();
   }
 
+  /** @returns {GetDpAccountParam} */
   static getDpAccount() {
     return Joi.object({
       pageNumber: Joi.number(),
@@ -29,10 +138,12 @@ class ServiceabilityValidator {
     }).required();
   }
 
+  /** @returns {GetDpCompanyRulesParam} */
   static getDpCompanyRules() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetDpRuleInsertParam} */
   static getDpRuleInsert() {
     return Joi.object({
       pageNumber: Joi.number(),
@@ -40,18 +151,21 @@ class ServiceabilityValidator {
     }).required();
   }
 
+  /** @returns {GetDpRulesParam} */
   static getDpRules() {
     return Joi.object({
       ruleUid: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetEntityRegionViewParam} */
   static getEntityRegionView() {
     return Joi.object({
-      body: ServiceabilityModel.EntityRegionView_Request().required(),
+      body: ServiceabilityPlatformModel.EntityRegionView_Request().required(),
     }).required();
   }
 
+  /** @returns {GetListViewParam} */
   static getListView() {
     return Joi.object({
       pageNumber: Joi.number(),
@@ -63,24 +177,28 @@ class ServiceabilityValidator {
     }).required();
   }
 
+  /** @returns {GetOptimalLocationsParam} */
   static getOptimalLocations() {
     return Joi.object({
-      body: ServiceabilityModel.ReAssignStoreRequest().required(),
+      body: ServiceabilityPlatformModel.ReAssignStoreRequest().required(),
     }).required();
   }
 
+  /** @returns {GetStoreParam} */
   static getStore() {
     return Joi.object({
       storeUid: Joi.number().required(),
     }).required();
   }
 
+  /** @returns {GetZoneDataViewParam} */
   static getZoneDataView() {
     return Joi.object({
       zoneId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetZoneListViewParam} */
   static getZoneListView() {
     return Joi.object({
       pageNumber: Joi.number(),
@@ -94,37 +212,42 @@ class ServiceabilityValidator {
     }).required();
   }
 
+  /** @returns {UpdateDpRuleParam} */
   static updateDpRule() {
     return Joi.object({
       ruleUid: Joi.string().allow("").required(),
-      body: ServiceabilityModel.DpRulesUpdateRequest().required(),
+      body: ServiceabilityPlatformModel.DpRulesUpdateRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateZoneControllerViewParam} */
   static updateZoneControllerView() {
     return Joi.object({
       zoneId: Joi.string().allow("").required(),
-      body: ServiceabilityModel.ZoneUpdateRequest().required(),
+      body: ServiceabilityPlatformModel.ZoneUpdateRequest().required(),
     }).required();
   }
 
+  /** @returns {UpsertDpAccountParam} */
   static upsertDpAccount() {
     return Joi.object({
-      body: ServiceabilityModel.CompanyDpAccountRequest().required(),
+      body: ServiceabilityPlatformModel.CompanyDpAccountRequest().required(),
     }).required();
   }
 
+  /** @returns {UpsertDpCompanyRulesParam} */
   static upsertDpCompanyRules() {
     return Joi.object({
-      body: ServiceabilityModel.DPCompanyRuleRequest().required(),
+      body: ServiceabilityPlatformModel.DPCompanyRuleRequest().required(),
     }).required();
   }
 
+  /** @returns {UpsertDpRulesParam} */
   static upsertDpRules() {
     return Joi.object({
-      body: ServiceabilityModel.DpRuleRequest().required(),
+      body: ServiceabilityPlatformModel.DpRuleRequest().required(),
     }).required();
   }
 }
 
-module.exports = ServiceabilityValidator;
+module.exports = ServiceabilityPlatformValidator;

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

@@ -4,84 +4,59 @@ declare class Share {
     config: any;
     applicationId: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {ShortLinkReq} arg.body
-     * @returns {Promise<ShortLinkRes>} - Success response
+     * @param {SharePlatformApplicationValidator.CreateShortLinkParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
+     * @name createShortLink
      * @summary: Create short link
-     * @description: Create short link
+     * @description: Create short link - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
      */
-    createShortLink({ body }?: {
-        body: ShortLinkReq;
-    }): Promise<ShortLinkRes>;
+    createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.hash - Hash of short url
-     * @returns {Promise<ShortLinkRes>} - Success response
+     * @param {SharePlatformApplicationValidator.GetShortLinkByHashParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
+     * @name getShortLinkByHash
      * @summary: Get short link by hash
-     * @description: Get short link by hash
+     * @description: Get short link by hash - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
      */
-    getShortLinkByHash({ hash }?: {
-        hash: string;
-    }): Promise<ShortLinkRes>;
+    getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.surlId - Short link ID for which click statistics are
-     *   to be retrieved.
-     * @returns {Promise<ClickStatsResponse>} - Success response
+     * @param {SharePlatformApplicationValidator.GetShortLinkClickStatsParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
+     * @name getShortLinkClickStats
      * @summary: Get click statistics for a short link
-     * @description: Retrieve click statistics for a given short link ID.
+     * @description: Retrieve click statistics for a given short link ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
      */
-    getShortLinkClickStats({ surlId }?: {
-        surlId: string;
-    }): Promise<ClickStatsResponse>;
+    getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - Current page number
-     * @param {number} [arg.pageSize] - Current page size
-     * @param {string} [arg.createdBy] - Short link creator
-     * @param {string} [arg.active] - Short link active status
-     * @param {string} [arg.q] - Search text for original and short url
-     * @returns {Promise<ShortLinkList>} - Success response
+     * @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
+     * @name getShortLinks
      * @summary: Get short links
-     * @description: Get short links
+     * @description: Get short links - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
      */
-    getShortLinks({ pageNo, pageSize, createdBy, active, q }?: {
-        pageNo?: number;
-        pageSize?: number;
-        createdBy?: string;
-        active?: string;
-        q?: string;
-    }): Promise<ShortLinkList>;
+    getShortLinks({ pageNo, pageSize, createdBy, active, q, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.companyId - Company Id
-     * @param {string} arg.applicationId - Application Id
-     * @param {number} [arg.pageSize] - Current page size
-     * @param {string} [arg.createdBy] - Short link creator
-     * @param {string} [arg.active] - Short link active status
-     * @param {string} [arg.q] - Search text for original and short url
-     * @summary: Get short links
-     * @description: Get short links
-     */
-    getShortLinksPaginator({ companyId, applicationId, pageSize, createdBy, active, q, }?: {
-        companyId: string;
-        applicationId: string;
-        pageSize?: number;
-        createdBy?: string;
-        active?: string;
-        q?: string;
-    }): Paginator;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Short link document identifier
-     * @param {ShortLinkReq} arg.body
-     * @returns {Promise<ShortLinkRes>} - Success response
+     * @param {SharePlatformApplicationValidator.UpdateShortLinkByIdParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
+     * @name updateShortLinkById
      * @summary: Update short link by id
-     * @description: Update short link by id
+     * @description: Update short link by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
      */
-    updateShortLinkById({ id, body }?: {
-        id: string;
-        body: ShortLinkReq;
-    }): Promise<ShortLinkRes>;
+    updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
 }
-import Paginator = require("../../common/Paginator");
+import SharePlatformApplicationValidator = require("./SharePlatformApplicationValidator");
+import SharePlatformModel = require("./SharePlatformModel");