@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.8

package/sdk/platform/PlatformClient.d.ts

@@ -46,6 +46,14 @@ declare class PlatformClient {
      * @throws {FDKClientValidationError} When the provided header is not an object.
      */
     setExtraHeaders(header: object): void;
+    request({ method, url, query, body, headers, responseHeaders, }: {
+        method: any;
+        url: any;
+        query: any;
+        body: any;
+        headers: any;
+        responseHeaders?: boolean;
+    }): Promise<import("axios").AxiosResponse<any, any>>;
 }
 import AuditTrail = require("./AuditTrail/AuditTrailPlatformClient");
 import Billing = require("./Billing/BillingPlatformClient");

package/sdk/platform/PlatformClient.js

@@ -34,6 +34,7 @@ const Webhook = require("./Webhook/WebhookPlatformClient");
 
 const PlatformApplicationClient = require("./PlatformApplicationClient");
 const { FDKClientValidationError } = require("../common/FDKError");
+const { execute } = require("./PlatformAPIClient");
 
 /**
  * Represents the client for the platform.
@@ -115,6 +116,19 @@ class PlatformClient {
       throw new FDKClientValidationError("Context value should be an object");
     }
   }
+
+  async request({
+    method,
+    url,
+    query,
+    body,
+    headers,
+    responseHeaders = false,
+  }) {
+    return await execute(this.config, method, url, query, body, headers, {
+      responseHeaders,
+    });
+  }
 }
 
 module.exports = PlatformClient;

package/sdk/platform/Rewards/RewardsPlatformModel.d.ts

@@ -50,13 +50,13 @@ export = RewardsPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef Offer
@@ -226,12 +226,33 @@ type RewardsRule = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {Offer} */

package/sdk/platform/Rewards/RewardsPlatformModel.js

@@ -58,13 +58,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

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

@@ -9,13 +9,14 @@ declare class Serviceability {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
-     *   Success response
+     * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>}
+     *   - Success response
+     *
      * @name createCourierPartnerRule
      * @summary: Create rourier rule
      * @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerRule/).
      */
-    createCourierPartnerRule({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRule>;
+    createCourierPartnerRule({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam} arg
      *   - Arg object
@@ -76,13 +77,14 @@ declare class Serviceability {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
-     *   Success response
+     * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>}
+     *   - Success response
+     *
      * @name getCourierPartnerRule
      * @summary: Get courier rule
      * @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRule/).
      */
-    getCourierPartnerRule({ ruleId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRule>;
+    getCourierPartnerRule({ ruleId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.GetCourierPartnerRulesParam} arg
      *   - Arg object
@@ -183,13 +185,14 @@ declare class Serviceability {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
-     *   Success response
+     * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>}
+     *   - Success response
+     *
      * @name updateCourierRule
      * @summary: Update courier rule
      * @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierRule/).
      */
-    updateCourierRule({ ruleId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRule>;
+    updateCourierRule({ ruleId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js

@@ -21,8 +21,9 @@ class Serviceability {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
-   *   Success response
+   * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>}
+   *   - Success response
+   *
    * @name createCourierPartnerRule
    * @summary: Create rourier rule
    * @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerRule/).
@@ -78,7 +79,7 @@ class Serviceability {
 
     const {
       error: res_error,
-    } = ServiceabilityPlatformModel.CourierPartnerRule().validate(
+    } = ServiceabilityPlatformModel.CourierPartnerRuleResponse().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -421,8 +422,9 @@ class Serviceability {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
-   *   Success response
+   * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>}
+   *   - Success response
+   *
    * @name getCourierPartnerRule
    * @summary: Get courier rule
    * @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRule/).
@@ -478,7 +480,7 @@ class Serviceability {
 
     const {
       error: res_error,
-    } = ServiceabilityPlatformModel.CourierPartnerRule().validate(
+    } = ServiceabilityPlatformModel.CourierPartnerRuleResponse().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -1094,8 +1096,9 @@ class Serviceability {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
-   *   Success response
+   * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResponse>}
+   *   - Success response
+   *
    * @name updateCourierRule
    * @summary: Update courier rule
    * @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierRule/).
@@ -1153,7 +1156,7 @@ class Serviceability {
 
     const {
       error: res_error,
-    } = ServiceabilityPlatformModel.CourierPartnerRule().validate(
+    } = ServiceabilityPlatformModel.CourierPartnerRuleResponse().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );

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

@@ -92,14 +92,18 @@ export = ServiceabilityPlatformModel;
  */
 /**
  * @typedef ListViewItems
- * @property {string} zone_id
- * @property {string} name
- * @property {string} slug
- * @property {number} stores_count
- * @property {boolean} is_active
- * @property {number} regions_count
- * @property {number} company_id
- * @property {ListViewChannels[]} channels
+ * @property {string} zone_id - The unique identifier for the zone.
+ * @property {string} name - The name of the zone.
+ * @property {string} slug - A human-readable and unique identifier for the
+ *   zone, derived from the name.
+ * @property {number} stores_count - The number of stores within the zone.
+ * @property {boolean} is_active - A flag indicating whether the zone is active.
+ * @property {number} regions_count - The number of regions within the zone.
+ * @property {number} company_id - The unique identifier for the company to
+ *   which the zone belongs.
+ * @property {number[]} [store_ids] - A list of store identifiers associated
+ *   with the zone.
+ * @property {ListViewChannels[]} channels - The name of the zone.
  */
 /**
  * @typedef ListViewResponse
@@ -543,20 +547,40 @@ export = ServiceabilityPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
+ */
+/**
+ * @typedef CourierPartnerRuleCPListResponse
+ * @property {string} [account_id]
+ * @property {string} [extension_id]
+ * @property {boolean} [is_self_ship]
+ * @property {Object} [scheme_rules]
+ */
+/**
+ * @typedef CourierPartnerRuleResponse
+ * @property {boolean} [is_active]
+ * @property {string} [application_id]
+ * @property {number} [company_id]
+ * @property {CourierPartnerRuleConditions} [conditions]
+ * @property {string[]} [sort]
+ * @property {Object} [created_by]
+ * @property {string} [id]
+ * @property {Object} [modified_by]
+ * @property {string} [modified_on]
+ * @property {string} [name]
+ * @property {string} [type]
+ * @property {CourierPartnerRuleCPListResponse[]} [cp_list]
  */
 /**
  * @typedef CourierPartnerList
  * @property {string} extension_id
  * @property {string} account_id
- * @property {string} name
- * @property {boolean} is_self_ship
  */
 /**
  * @typedef LocationRuleValues
@@ -614,7 +638,7 @@ export = ServiceabilityPlatformModel;
  */
 /**
  * @typedef CourierPartnerRulesListResponse
- * @property {CourierPartnerRule[]} items
+ * @property {CourierPartnerRuleResponse[]} items
  * @property {Page} page
  */
 /**
@@ -1003,7 +1027,7 @@ export = ServiceabilityPlatformModel;
 declare class ServiceabilityPlatformModel {
 }
 declare namespace ServiceabilityPlatformModel {
-    export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
+    export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerRuleCPListResponse, CourierPartnerRuleResponse, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
 }
 /** @returns {UpdateZoneConfigRequest} */
 declare function UpdateZoneConfigRequest(): UpdateZoneConfigRequest;
@@ -1114,13 +1138,44 @@ type ListViewChannels = {
 /** @returns {ListViewItems} */
 declare function ListViewItems(): ListViewItems;
 type ListViewItems = {
+    /**
+     * - The unique identifier for the zone.
+     */
     zone_id: string;
+    /**
+     * - The name of the zone.
+     */
     name: string;
+    /**
+     * - A human-readable and unique identifier for the
+     * zone, derived from the name.
+     */
     slug: string;
+    /**
+     * - The number of stores within the zone.
+     */
     stores_count: number;
+    /**
+     * - A flag indicating whether the zone is active.
+     */
     is_active: boolean;
+    /**
+     * - The number of regions within the zone.
+     */
     regions_count: number;
+    /**
+     * - The unique identifier for the company to
+     * which the zone belongs.
+     */
     company_id: number;
+    /**
+     * - A list of store identifiers associated
+     * with the zone.
+     */
+    store_ids?: number[];
+    /**
+     * - The name of the zone.
+     */
     channels: ListViewChannels[];
 };
 /** @returns {ListViewResponse} */
@@ -1626,21 +1681,64 @@ type CourierPartnerAccountFailureResponse = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
+/** @returns {CourierPartnerRuleCPListResponse} */
+declare function CourierPartnerRuleCPListResponse(): CourierPartnerRuleCPListResponse;
+type CourierPartnerRuleCPListResponse = {
+    account_id?: string;
+    extension_id?: string;
+    is_self_ship?: boolean;
+    scheme_rules?: any;
+};
+/** @returns {CourierPartnerRuleResponse} */
+declare function CourierPartnerRuleResponse(): CourierPartnerRuleResponse;
+type CourierPartnerRuleResponse = {
+    is_active?: boolean;
+    application_id?: string;
+    company_id?: number;
+    conditions?: CourierPartnerRuleConditions;
+    sort?: string[];
+    created_by?: any;
+    id?: string;
+    modified_by?: any;
+    modified_on?: string;
+    name?: string;
+    type?: string;
+    cp_list?: CourierPartnerRuleCPListResponse[];
+};
 /** @returns {CourierPartnerList} */
 declare function CourierPartnerList(): CourierPartnerList;
 type CourierPartnerList = {
     extension_id: string;
     account_id: string;
-    name: string;
-    is_self_ship: boolean;
 };
 /** @returns {LocationRuleValues} */
 declare function LocationRuleValues(): LocationRuleValues;
@@ -1706,7 +1804,7 @@ type FailureResponse = {
 /** @returns {CourierPartnerRulesListResponse} */
 declare function CourierPartnerRulesListResponse(): CourierPartnerRulesListResponse;
 type CourierPartnerRulesListResponse = {
-    items: CourierPartnerRule[];
+    items: CourierPartnerRuleResponse[];
     page: Page;
 };
 /** @returns {CompanyConfig} */

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -108,14 +108,18 @@ const Joi = require("joi");
 
 /**
  * @typedef ListViewItems
- * @property {string} zone_id
- * @property {string} name
- * @property {string} slug
- * @property {number} stores_count
- * @property {boolean} is_active
- * @property {number} regions_count
- * @property {number} company_id
- * @property {ListViewChannels[]} channels
+ * @property {string} zone_id - The unique identifier for the zone.
+ * @property {string} name - The name of the zone.
+ * @property {string} slug - A human-readable and unique identifier for the
+ *   zone, derived from the name.
+ * @property {number} stores_count - The number of stores within the zone.
+ * @property {boolean} is_active - A flag indicating whether the zone is active.
+ * @property {number} regions_count - The number of regions within the zone.
+ * @property {number} company_id - The unique identifier for the company to
+ *   which the zone belongs.
+ * @property {number[]} [store_ids] - A list of store identifiers associated
+ *   with the zone.
+ * @property {ListViewChannels[]} channels - The name of the zone.
  */
 
 /**
@@ -620,21 +624,43 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
+ */
+
+/**
+ * @typedef CourierPartnerRuleCPListResponse
+ * @property {string} [account_id]
+ * @property {string} [extension_id]
+ * @property {boolean} [is_self_ship]
+ * @property {Object} [scheme_rules]
+ */
+
+/**
+ * @typedef CourierPartnerRuleResponse
+ * @property {boolean} [is_active]
+ * @property {string} [application_id]
+ * @property {number} [company_id]
+ * @property {CourierPartnerRuleConditions} [conditions]
+ * @property {string[]} [sort]
+ * @property {Object} [created_by]
+ * @property {string} [id]
+ * @property {Object} [modified_by]
+ * @property {string} [modified_on]
+ * @property {string} [name]
+ * @property {string} [type]
+ * @property {CourierPartnerRuleCPListResponse[]} [cp_list]
  */
 
 /**
  * @typedef CourierPartnerList
  * @property {string} extension_id
  * @property {string} account_id
- * @property {string} name
- * @property {boolean} is_self_ship
  */
 
 /**
@@ -700,7 +726,7 @@ const Joi = require("joi");
 
 /**
  * @typedef CourierPartnerRulesListResponse
- * @property {CourierPartnerRule[]} items
+ * @property {CourierPartnerRuleResponse[]} items
  * @property {Page} page
  */
 
@@ -1285,6 +1311,7 @@ class ServiceabilityPlatformModel {
       is_active: Joi.boolean().required(),
       regions_count: Joi.number().required(),
       company_id: Joi.number().required(),
+      store_ids: Joi.array().items(Joi.number()),
       channels: Joi.array()
         .items(ServiceabilityPlatformModel.ListViewChannels())
         .required(),
@@ -1962,13 +1989,41 @@ class ServiceabilityPlatformModel {
     });
   }
 
+  /** @returns {CourierPartnerRuleCPListResponse} */
+  static CourierPartnerRuleCPListResponse() {
+    return Joi.object({
+      account_id: Joi.string().allow(""),
+      extension_id: Joi.string().allow(""),
+      is_self_ship: Joi.boolean(),
+      scheme_rules: Joi.any(),
+    });
+  }
+
+  /** @returns {CourierPartnerRuleResponse} */
+  static CourierPartnerRuleResponse() {
+    return Joi.object({
+      is_active: Joi.boolean(),
+      application_id: Joi.string().allow(""),
+      company_id: Joi.number(),
+      conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions(),
+      sort: Joi.array().items(Joi.string().allow("")),
+      created_by: Joi.any().allow(null),
+      id: Joi.string().allow(""),
+      modified_by: Joi.any().allow(null),
+      modified_on: Joi.string().allow("").allow(null),
+      name: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      cp_list: Joi.array().items(
+        ServiceabilityPlatformModel.CourierPartnerRuleCPListResponse()
+      ),
+    });
+  }
+
   /** @returns {CourierPartnerList} */
   static CourierPartnerList() {
     return Joi.object({
       extension_id: Joi.string().allow("").required(),
       account_id: Joi.string().allow("").required(),
-      name: Joi.string().allow("").required(),
-      is_self_ship: Joi.boolean().required(),
     });
   }
 
@@ -2057,7 +2112,7 @@ class ServiceabilityPlatformModel {
   static CourierPartnerRulesListResponse() {
     return Joi.object({
       items: Joi.array()
-        .items(ServiceabilityPlatformModel.CourierPartnerRule())
+        .items(ServiceabilityPlatformModel.CourierPartnerRuleResponse())
         .required(),
       page: ServiceabilityPlatformModel.Page().required(),
     });

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

@@ -87,13 +87,13 @@ export = SharePlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef ShortLinkList
@@ -230,12 +230,33 @@ type ShortLinkRes = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {ShortLinkList} */