@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

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

@@ -24,7 +24,7 @@ export = ServiceabilityPlatformModel;
  */
 /**
  * @typedef ApplicationSelfShipConfig
- * @property {SelfShipResponse} [self_ship]
+ * @property {Object} [self_ship]
  */
 /**
  * @typedef ApplicationSelfShipConfigResponse
@@ -573,6 +573,10 @@ export = ServiceabilityPlatformModel;
  * @property {number} [size]
  * @property {string} [type]
  */
+/**
+ * @typedef ServiceabilityPayloadSchema
+ * @property {string} serviceability_type
+ */
 /**
  * @typedef TimmingResponse
  * @property {OpeningClosing} [closing]
@@ -652,7 +656,7 @@ export = ServiceabilityPlatformModel;
 declare class ServiceabilityPlatformModel {
 }
 declare namespace ServiceabilityPlatformModel {
-    export { AddressResponse, ApplicationCompanyDpViewRequest, ApplicationCompanyDpViewResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, CommonError, CompanyDpAccountListResponse, CompanyDpAccountRequest, CompanyDpAccountResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, ContactNumberResponse, CreatedByResponse, CreateZoneData, DocumentsResponse, Dp, Dp1, DpAccountFailureResponse, DPApplicationRuleRequest, DPApplicationRuleResponse, DPCompanyRuleRequest, DPCompanyRuleResponse, DpIds, DpMultipleRuleSuccessResponse, DpRule, DpRuleRequest, DpRuleResponse, DpRuleSuccessResponse, DpRulesUpdateRequest, DpRuleUpdateSuccessResponse, DpSchemaInRuleListing, EinvoiceResponse, EntityRegionView_Error, EntityRegionView_Items, EntityRegionView_page, EntityRegionView_Request, EntityRegionView_Response, Error, ErrorResponse, EwayBillResponse, FailureResponse, GetSingleZoneDataViewResponse, GetStoresViewResponse, GetZoneDataViewChannels, GetZoneDataViewItems, GetZoneFromApplicationIdViewResponse, GetZoneFromPincodeViewRequest, GetZoneFromPincodeViewResponse, GstCredentialsResponse, IntegrationTypeResponse, ItemResponse, ListViewChannels, ListViewItems, ListViewProduct, ListViewResponse, ListViewSummary, LogisticsResponse, ManagerResponse, MobileNo, ModifiedByResponse, OpeningClosing, Page, PincodeBulkViewResponse, PincodeCodStatusListingPage, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, PincodeCodStatusListingSummary, PincodeMopBulkData, PincodeMopData, PincodeMOPresponse, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, PincodeMopUpdateResponse, ProductReturnConfigResponse, ReAssignStoreRequest, ReAssignStoreResponse, SelfShipResponse, ServiceabilityErrorResponse, ServiceabilityPageResponse, TimmingResponse, UpdateZoneData, WarningsResponse, Zone, ZoneDataItem, ZoneMappingType, ZoneProductTypes, ZoneRequest, ZoneResponse, ZoneSuccessResponse, ZoneUpdateRequest };
+    export { AddressResponse, ApplicationCompanyDpViewRequest, ApplicationCompanyDpViewResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, CommonError, CompanyDpAccountListResponse, CompanyDpAccountRequest, CompanyDpAccountResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, ContactNumberResponse, CreatedByResponse, CreateZoneData, DocumentsResponse, Dp, Dp1, DpAccountFailureResponse, DPApplicationRuleRequest, DPApplicationRuleResponse, DPCompanyRuleRequest, DPCompanyRuleResponse, DpIds, DpMultipleRuleSuccessResponse, DpRule, DpRuleRequest, DpRuleResponse, DpRuleSuccessResponse, DpRulesUpdateRequest, DpRuleUpdateSuccessResponse, DpSchemaInRuleListing, EinvoiceResponse, EntityRegionView_Error, EntityRegionView_Items, EntityRegionView_page, EntityRegionView_Request, EntityRegionView_Response, Error, ErrorResponse, EwayBillResponse, FailureResponse, GetSingleZoneDataViewResponse, GetStoresViewResponse, GetZoneDataViewChannels, GetZoneDataViewItems, GetZoneFromApplicationIdViewResponse, GetZoneFromPincodeViewRequest, GetZoneFromPincodeViewResponse, GstCredentialsResponse, IntegrationTypeResponse, ItemResponse, ListViewChannels, ListViewItems, ListViewProduct, ListViewResponse, ListViewSummary, LogisticsResponse, ManagerResponse, MobileNo, ModifiedByResponse, OpeningClosing, Page, PincodeBulkViewResponse, PincodeCodStatusListingPage, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, PincodeCodStatusListingSummary, PincodeMopBulkData, PincodeMopData, PincodeMOPresponse, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, PincodeMopUpdateResponse, ProductReturnConfigResponse, ReAssignStoreRequest, ReAssignStoreResponse, SelfShipResponse, ServiceabilityErrorResponse, ServiceabilityPageResponse, ServiceabilityPayloadSchema, TimmingResponse, UpdateZoneData, WarningsResponse, Zone, ZoneDataItem, ZoneMappingType, ZoneProductTypes, ZoneRequest, ZoneResponse, ZoneSuccessResponse, ZoneUpdateRequest };
 }
 /** @returns {AddressResponse} */
 declare function AddressResponse(): AddressResponse;
@@ -683,7 +687,7 @@ type ApplicationCompanyDpViewResponse = {
 /** @returns {ApplicationSelfShipConfig} */
 declare function ApplicationSelfShipConfig(): ApplicationSelfShipConfig;
 type ApplicationSelfShipConfig = {
-    self_ship?: SelfShipResponse;
+    self_ship?: any;
 };
 /** @returns {ApplicationSelfShipConfigResponse} */
 declare function ApplicationSelfShipConfigResponse(): ApplicationSelfShipConfigResponse;
@@ -1311,6 +1315,11 @@ type ServiceabilityPageResponse = {
     size?: number;
     type?: string;
 };
+/** @returns {ServiceabilityPayloadSchema} */
+declare function ServiceabilityPayloadSchema(): ServiceabilityPayloadSchema;
+type ServiceabilityPayloadSchema = {
+    serviceability_type: string;
+};
 /** @returns {TimmingResponse} */
 declare function TimmingResponse(): TimmingResponse;
 type TimmingResponse = {

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -28,7 +28,7 @@ const Joi = require("joi");
 
 /**
  * @typedef ApplicationSelfShipConfig
- * @property {SelfShipResponse} [self_ship]
+ * @property {Object} [self_ship]
  */
 
 /**
@@ -657,6 +657,11 @@ const Joi = require("joi");
  * @property {string} [type]
  */
 
+/**
+ * @typedef ServiceabilityPayloadSchema
+ * @property {string} serviceability_type
+ */
+
 /**
  * @typedef TimmingResponse
  * @property {OpeningClosing} [closing]
@@ -780,7 +785,7 @@ class ServiceabilityPlatformModel {
   /** @returns {ApplicationSelfShipConfig} */
   static ApplicationSelfShipConfig() {
     return Joi.object({
-      self_ship: ServiceabilityPlatformModel.SelfShipResponse(),
+      self_ship: Joi.any().allow(null),
     });
   }
 
@@ -1612,6 +1617,13 @@ class ServiceabilityPlatformModel {
     });
   }
 
+  /** @returns {ServiceabilityPayloadSchema} */
+  static ServiceabilityPayloadSchema() {
+    return Joi.object({
+      serviceability_type: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {TimmingResponse} */
   static TimmingResponse() {
     return Joi.object({

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

@@ -5,74 +5,58 @@ declare class Share {
     applicationId: any;
     /**
      * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
      */
-    createShortLink({ body }?: SharePlatformApplicationValidator.CreateShortLinkParam, { headers }?: import("../PlatformAPIClient").Options): Promise<SharePlatformModel.ShortLinkRes>;
+    createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
     /**
      * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
      */
-    getShortLinkByHash({ hash }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { headers }?: import("../PlatformAPIClient").Options): Promise<SharePlatformModel.ShortLinkRes>;
+    getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
     /**
      * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
      */
-    getShortLinkClickStats({ surlId }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<SharePlatformModel.ClickStatsResponse>;
+    getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResponse>;
     /**
      * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
      */
-    getShortLinks({ pageNo, pageSize, createdBy, active, q }?: SharePlatformApplicationValidator.GetShortLinksParam, { headers }?: import("../PlatformAPIClient").Options): 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
-     * @returns {Paginator<SharePlatformModel.ShortLinkList>}
-     * @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<SharePlatformModel.ShortLinkList>;
+    getShortLinks({ pageNo, pageSize, createdBy, active, q, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
     /**
      * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
      */
-    updateShortLinkById({ id, body }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<SharePlatformModel.ShortLinkRes>;
+    updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
 }
 import SharePlatformApplicationValidator = require("./SharePlatformApplicationValidator");
 import SharePlatformModel = require("./SharePlatformModel");
-import Paginator = require("../../common/Paginator");

package/sdk/platform/Share/SharePlatformApplicationClient.js

@@ -14,13 +14,17 @@ class Share {
 
   /**
    * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
    */
-  async createShortLink({ body } = {}, { headers } = { headers: false }) {
+  async createShortLink(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const {
       error,
     } = SharePlatformApplicationValidator.createShortLink().validate(
@@ -57,12 +61,12 @@ class Share {
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
       query_params,
       body,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -85,13 +89,17 @@ class Share {
 
   /**
    * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
    */
-  async getShortLinkByHash({ hash } = {}, { headers } = { headers: false }) {
+  async getShortLinkByHash(
+    { hash, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const {
       error,
     } = SharePlatformApplicationValidator.getShortLinkByHash().validate(
@@ -128,12 +136,12 @@ class Share {
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
       query_params,
       undefined,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -158,6 +166,7 @@ class Share {
    * @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
@@ -165,8 +174,8 @@ class Share {
    * @description: Retrieve click statistics for a given short link ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
    */
   async getShortLinkClickStats(
-    { surlId } = {},
-    { headers } = { headers: false }
+    { surlId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -201,12 +210,12 @@ class Share {
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/click-stats`,
       query_params,
       undefined,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -229,6 +238,7 @@ class Share {
 
   /**
    * @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
@@ -236,8 +246,10 @@ class Share {
    * @description: Get short links - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
    */
   async getShortLinks(
-    { pageNo, pageSize, createdBy, active, q } = {},
-    { headers } = { headers: false }
+    { pageNo, pageSize, createdBy, active, q, requestHeaders } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -288,12 +300,12 @@ class Share {
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
       query_params,
       undefined,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -314,54 +326,11 @@ class Share {
     return response;
   }
 
-  /**
-   * @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
-   * @returns {Paginator<SharePlatformModel.ShortLinkList>}
-   * @summary: Get short links
-   * @description: Get short links
-   */
-  getShortLinksPaginator({
-    companyId,
-    applicationId,
-    pageSize,
-    createdBy,
-    active,
-    q,
-  } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "number";
-      const data = await this.getShortLinks({
-        companyId: companyId,
-        applicationId: applicationId,
-        pageNo: pageNo,
-        pageSize: pageSize,
-        createdBy: createdBy,
-        active: active,
-        q: q,
-      });
-      paginator.setPaginator({
-        hasNext: data.page.has_next ? true : false,
-        nextId: data.page.next_id,
-      });
-      return data;
-    };
-    paginator.setCallback(callback.bind(this));
-    return paginator;
-  }
-
   /**
    * @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
@@ -369,8 +338,8 @@ class Share {
    * @description: Update short link by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
    */
   async updateShortLinkById(
-    { id, body } = {},
-    { headers } = { headers: false }
+    { id, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -410,12 +379,12 @@ class Share {
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
       query_params,
       body,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 

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

@@ -10,8 +10,8 @@ export = SharePlatformModel;
  */
 /**
  * @typedef ClickStatsItem
- * @property {string} [display] - The display name of the click statistic.
- * @property {number} [total] - The total number of clicks for the statistic.
+ * @property {string} display - The display name of the click statistic.
+ * @property {number} total - The total number of clicks for the statistic.
  */
 /**
  * @typedef ClickStatsResponse
@@ -126,11 +126,11 @@ type ClickStatsItem = {
     /**
      * - The display name of the click statistic.
      */
-    display?: string;
+    display: string;
     /**
      * - The total number of clicks for the statistic.
      */
-    total?: number;
+    total: number;
 };
 /** @returns {ClickStatsResponse} */
 declare function ClickStatsResponse(): ClickStatsResponse;

package/sdk/platform/Share/SharePlatformModel.js

@@ -13,8 +13,8 @@ const Joi = require("joi");
 
 /**
  * @typedef ClickStatsItem
- * @property {string} [display] - The display name of the click statistic.
- * @property {number} [total] - The total number of clicks for the statistic.
+ * @property {string} display - The display name of the click statistic.
+ * @property {number} total - The total number of clicks for the statistic.
  */
 
 /**
@@ -138,8 +138,8 @@ class SharePlatformModel {
   /** @returns {ClickStatsItem} */
   static ClickStatsItem() {
     return Joi.object({
-      display: Joi.string().allow(""),
-      total: Joi.number(),
+      display: Joi.string().allow("").required(),
+      total: Joi.number().required(),
     });
   }