@gofynd/fdk-client-javascript 1.3.3-beta.2 → 1.3.3

package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts

@@ -235,6 +235,19 @@ declare class Configuration {
      * @description: Fetch the details of the deployment stores (the selling locations where the application will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
      */
     getOrderingStoreConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoreConfig>;
+    /**
+     * @param {ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
+     *   Success response
+     * @name getOrderingStoreCookie
+     * @summary: Get an Ordering Store signed cookie on selection of ordering store.
+     * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
+     */
+    getOrderingStoreCookie({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
     /**
      * @param {ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam} arg
      *   - Arg object
@@ -349,6 +362,19 @@ declare class Configuration {
      * @description: Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
      */
     removeDomainById({ id, requestHeaders }?: ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
+    /**
+     * @param {ConfigurationPlatformApplicationValidator.RemoveOrderingStoreCookieParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
+     *   Success response
+     * @name removeOrderingStoreCookie
+     * @summary: Unset the Ordering Store signed cookie.
+     * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
+     */
+    removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
     /**
      * @param {ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam} arg
      *   - Arg object

package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js

@@ -1289,6 +1289,84 @@ class Configuration {
     return response;
   }
 
+  /**
+   * @param {ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
+   *   Success response
+   * @name getOrderingStoreCookie
+   * @summary: Get an Ordering Store signed cookie on selection of ordering store.
+   * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
+   */
+  async getOrderingStoreCookie(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ConfigurationPlatformApplicationValidator.getOrderingStoreCookie().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ConfigurationPlatformApplicationValidator.getOrderingStoreCookie().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Configuration > getOrderingStoreCookie \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/configuration/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-store/select`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ConfigurationPlatformModel.SuccessMessageResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Configuration > getOrderingStoreCookie \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam} arg
    *   - Arg object
@@ -1850,6 +1928,80 @@ class Configuration {
     return response;
   }
 
+  /**
+   * @param {ConfigurationPlatformApplicationValidator.RemoveOrderingStoreCookieParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
+   *   Success response
+   * @name removeOrderingStoreCookie
+   * @summary: Unset the Ordering Store signed cookie.
+   * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
+   */
+  async removeOrderingStoreCookie(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ConfigurationPlatformApplicationValidator.removeOrderingStoreCookie().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ConfigurationPlatformApplicationValidator.removeOrderingStoreCookie().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Configuration > removeOrderingStoreCookie \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/configuration/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-store/select`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ConfigurationPlatformModel.SuccessMessageResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Configuration > removeOrderingStoreCookie \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam} arg
    *   - Arg object

package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts

@@ -41,6 +41,10 @@ export = ConfigurationPlatformApplicationValidator;
 /** @typedef GetDomainsParam */
 /** @typedef GetInventoryConfigParam */
 /** @typedef GetOrderingStoreConfigParam */
+/**
+ * @typedef GetOrderingStoreCookieParam
+ * @property {ConfigurationPlatformModel.OrderingStoreSelectRequest} body
+ */
 /**
  * @typedef GetOrderingStoresByFilterParam
  * @property {number} [pageNo] - The page number to navigate through the given
@@ -74,6 +78,7 @@ export = ConfigurationPlatformApplicationValidator;
  * @typedef RemoveDomainByIdParam
  * @property {string} id - The unique identifier (24-digit Mongo Object ID) of the domain
  */
+/** @typedef RemoveOrderingStoreCookieParam */
 /**
  * @typedef UpdateAppApiTokensParam
  * @property {ConfigurationPlatformModel.TokenResponse} body
@@ -141,6 +146,8 @@ declare class ConfigurationPlatformApplicationValidator {
     static getInventoryConfig(): any;
     /** @returns {GetOrderingStoreConfigParam} */
     static getOrderingStoreConfig(): any;
+    /** @returns {GetOrderingStoreCookieParam} */
+    static getOrderingStoreCookie(): GetOrderingStoreCookieParam;
     /** @returns {GetOrderingStoresByFilterParam} */
     static getOrderingStoresByFilter(): GetOrderingStoresByFilterParam;
     /** @returns {GetPreviousVersionsParam} */
@@ -153,6 +160,8 @@ declare class ConfigurationPlatformApplicationValidator {
     static partiallyUpdateInventoryConfig(): PartiallyUpdateInventoryConfigParam;
     /** @returns {RemoveDomainByIdParam} */
     static removeDomainById(): RemoveDomainByIdParam;
+    /** @returns {RemoveOrderingStoreCookieParam} */
+    static removeOrderingStoreCookie(): any;
     /** @returns {UpdateAppApiTokensParam} */
     static updateAppApiTokens(): UpdateAppApiTokensParam;
     /** @returns {UpdateAppBasicDetailsParam} */
@@ -171,7 +180,7 @@ declare class ConfigurationPlatformApplicationValidator {
     static updateOrderingStoreConfig(): UpdateOrderingStoreConfigParam;
 }
 declare namespace ConfigurationPlatformApplicationValidator {
-    export { AddDomainParam, ChangeDomainTypeParam, GetAppApiTokensParam, GetAppBasicDetailsParam, GetAppCompaniesParam, GetAppContactInfoParam, GetAppCurrencyConfigParam, GetAppFeaturesParam, GetAppStoresParam, GetAppSupportedCurrencyParam, GetApplicationByIdParam, GetBuildConfigParam, GetDomainStatusParam, GetDomainsParam, GetInventoryConfigParam, GetOrderingStoreConfigParam, GetOrderingStoresByFilterParam, GetPreviousVersionsParam, GetStaffOrderingStoresParam, ModifyAppFeaturesParam, PartiallyUpdateInventoryConfigParam, RemoveDomainByIdParam, UpdateAppApiTokensParam, UpdateAppBasicDetailsParam, UpdateAppContactInfoParam, UpdateAppCurrencyConfigParam, UpdateAppFeaturesParam, UpdateBuildConfigParam, UpdateInventoryConfigParam, UpdateOrderingStoreConfigParam };
+    export { AddDomainParam, ChangeDomainTypeParam, GetAppApiTokensParam, GetAppBasicDetailsParam, GetAppCompaniesParam, GetAppContactInfoParam, GetAppCurrencyConfigParam, GetAppFeaturesParam, GetAppStoresParam, GetAppSupportedCurrencyParam, GetApplicationByIdParam, GetBuildConfigParam, GetDomainStatusParam, GetDomainsParam, GetInventoryConfigParam, GetOrderingStoreConfigParam, GetOrderingStoreCookieParam, GetOrderingStoresByFilterParam, GetPreviousVersionsParam, GetStaffOrderingStoresParam, ModifyAppFeaturesParam, PartiallyUpdateInventoryConfigParam, RemoveDomainByIdParam, RemoveOrderingStoreCookieParam, UpdateAppApiTokensParam, UpdateAppBasicDetailsParam, UpdateAppContactInfoParam, UpdateAppCurrencyConfigParam, UpdateAppFeaturesParam, UpdateBuildConfigParam, UpdateInventoryConfigParam, UpdateOrderingStoreConfigParam };
 }
 type AddDomainParam = {
     body: ConfigurationPlatformModel.DomainAddRequest;
@@ -217,6 +226,9 @@ type GetBuildConfigParam = {
 type GetDomainStatusParam = {
     body: ConfigurationPlatformModel.DomainStatusRequest;
 };
+type GetOrderingStoreCookieParam = {
+    body: ConfigurationPlatformModel.OrderingStoreSelectRequest;
+};
 type GetOrderingStoresByFilterParam = {
     /**
      * - The page number to navigate through the given
@@ -304,4 +316,5 @@ type GetApplicationByIdParam = any;
 type GetDomainsParam = any;
 type GetInventoryConfigParam = any;
 type GetOrderingStoreConfigParam = any;
+type RemoveOrderingStoreCookieParam = any;
 import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");

package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js

@@ -60,6 +60,11 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
 
 /** @typedef GetOrderingStoreConfigParam */
 
+/**
+ * @typedef GetOrderingStoreCookieParam
+ * @property {ConfigurationPlatformModel.OrderingStoreSelectRequest} body
+ */
+
 /**
  * @typedef GetOrderingStoresByFilterParam
  * @property {number} [pageNo] - The page number to navigate through the given
@@ -99,6 +104,8 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
  * @property {string} id - The unique identifier (24-digit Mongo Object ID) of the domain
  */
 
+/** @typedef RemoveOrderingStoreCookieParam */
+
 /**
  * @typedef UpdateAppApiTokensParam
  * @property {ConfigurationPlatformModel.TokenResponse} body
@@ -237,6 +244,13 @@ class ConfigurationPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetOrderingStoreCookieParam} */
+  static getOrderingStoreCookie() {
+    return Joi.object({
+      body: ConfigurationPlatformModel.OrderingStoreSelectRequest().required(),
+    }).required();
+  }
+
   /** @returns {GetOrderingStoresByFilterParam} */
   static getOrderingStoresByFilter() {
     return Joi.object({
@@ -283,6 +297,11 @@ class ConfigurationPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {RemoveOrderingStoreCookieParam} */
+  static removeOrderingStoreCookie() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {UpdateAppApiTokensParam} */
   static updateAppApiTokens() {
     return Joi.object({

package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts

@@ -1127,6 +1127,14 @@ export = ConfigurationPlatformModel;
  * @property {string} [type] - For hard type delivery, store selection is
  *   compulsory. For soft type, delivery store selection is optional.
  */
+/**
+ * @typedef OrderingStoreSelect
+ * @property {number} uid - Ordering store unique uid. It is required.
+ */
+/**
+ * @typedef OrderingStoreSelectRequest
+ * @property {OrderingStoreSelect} ordering_store
+ */
 /**
  * @typedef OrderingStoresResponse
  * @property {OrderingStore[]} [items]
@@ -1431,7 +1439,7 @@ export = ConfigurationPlatformModel;
 declare class ConfigurationPlatformModel {
 }
 declare namespace ConfigurationPlatformModel {
-    export { Android, App, AppCartConfig, AppCurrencyResponse, AppDomain, AppFeature, AppFeatureRequest, AppFeatureResponse, AppInventory, AppInventoryCompanies, AppInventoryConfig, AppInventoryPartialUpdate, AppInventoryStores, Application, ApplicationAuth, ApplicationCors, ApplicationDetail, ApplicationInformation, ApplicationInventory, ApplicationMeta, ApplicationRedirections, ApplicationsResponse, ApplicationWebsite, AppLogisticsConfig, AppOrderConfig, AppPaymentConfig, AppStoreRules, AppSupportedCurrency, ArticleAssignmentConfig, ArticleAssignmentRule, ArticleAssignmentRules, AuthenticationConfig, BlogLink, BrandCompanyInfo, BrandsByCompanyResponse, BrandStoreInfo, BuildVersion, BuildVersionHistory, BusinessHighlights, CallbackUrl, CartFeature, Charges, CommonFeature, CommsConfig, CommunicationConfig, CommunicationOptinDialogFeature, CompaniesResponse, CompanyBrandInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, CompanyValidator, CompareProductsFeature, CreateApplicationRequest, CreateAppResponse, Credentials, Credit, CurrenciesResponse, Currency, CurrencyFeature, Debit, DefaultCurrency, DeliveryCharges, DeploymentMeta, DeploymentStoreSelectionFeature, Domain, DomainAdd, DomainAddRequest, DomainsResponse, DomainStatus, DomainStatusRequest, DomainStatusResponse, DomainSuggestion, DomainSuggestionsRequest, DomainSuggestionsResponse, FacebookLink, FeedbackFeature, FilterOrderingStoreRequest, Firebase, Freshchat, FreshchatCredentials, FyndRewards, FyndRewardsCredentials, GetIntegrationsOptInsResponse, GoogleMap, GoogleMapCredentials, GooglePlusLink, Gtm, GtmCredentials, HomePageFeature, InformationAddress, InformationPhone, InformationSupport, InstagramLink, Integration, IntegrationConfigResponse, IntegrationLevel, IntegrationMeta, IntegrationOptIn, InvalidPayloadRequest, InventoryArticleAssignment, InventoryBrand, InventoryBrandRule, InventoryCategory, InventoryDiscount, InventoryPaymentConfig, InventoryPrice, InventoryStore, InventoryStoreRule, InventoryValidator, Ios, JsonSchema, LandingImage, LandingPageFeature, LastPatch, LaunchPage, LinkedInLink, Links, ListingPriceFeature, LoyaltyPointsConfig, Methods, MobileAppConfigRequest, MobileAppConfiguration, Moengage, MoengageCredentials, NotFound, OptedApplicationResponse, OptedCompany, OptedInventory, OptedStore, OptedStoreAddress, OptedStoreIntegration, OptOutInventory, OptType, OrderFeature, OrderingStore, OrderingStoreConfig, OrderingStores, OrderingStoresResponse, OrderValidator, OtherEntity, OtherEntityData, OtherSellerApplication, OtherSellerApplications, OtherSellerCompany, Page, PanCardConfig, PaymentModeConfig, PaymentSelectionLock, PcrFeature, PinterestLink, ProductDetailFeature, QrFeature, RegistrationPageFeature, RevenueEngineFeature, RewardPointsConfig, Safetynet, SafetynetCredentials, SecureUrl, Segment, SegmentCredentials, SocialLinks, SplashImage, StoreByBrandsRequest, StoreByBrandsResponse, StoreCriteriaRule, StoreLatLong, StorePriority, StorePriorityRule, StoresResponse, StoreValidator, SuccessMessageResponse, TokenResponse, Tokens, TwitterLink, UpdateDomain, UpdateDomainTypeRequest, UpdateIntegrationLevelRequest, ValidationFailedResponse, Validators, VimeoLink, YoutubeLink };
+    export { Android, App, AppCartConfig, AppCurrencyResponse, AppDomain, AppFeature, AppFeatureRequest, AppFeatureResponse, AppInventory, AppInventoryCompanies, AppInventoryConfig, AppInventoryPartialUpdate, AppInventoryStores, Application, ApplicationAuth, ApplicationCors, ApplicationDetail, ApplicationInformation, ApplicationInventory, ApplicationMeta, ApplicationRedirections, ApplicationsResponse, ApplicationWebsite, AppLogisticsConfig, AppOrderConfig, AppPaymentConfig, AppStoreRules, AppSupportedCurrency, ArticleAssignmentConfig, ArticleAssignmentRule, ArticleAssignmentRules, AuthenticationConfig, BlogLink, BrandCompanyInfo, BrandsByCompanyResponse, BrandStoreInfo, BuildVersion, BuildVersionHistory, BusinessHighlights, CallbackUrl, CartFeature, Charges, CommonFeature, CommsConfig, CommunicationConfig, CommunicationOptinDialogFeature, CompaniesResponse, CompanyBrandInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, CompanyValidator, CompareProductsFeature, CreateApplicationRequest, CreateAppResponse, Credentials, Credit, CurrenciesResponse, Currency, CurrencyFeature, Debit, DefaultCurrency, DeliveryCharges, DeploymentMeta, DeploymentStoreSelectionFeature, Domain, DomainAdd, DomainAddRequest, DomainsResponse, DomainStatus, DomainStatusRequest, DomainStatusResponse, DomainSuggestion, DomainSuggestionsRequest, DomainSuggestionsResponse, FacebookLink, FeedbackFeature, FilterOrderingStoreRequest, Firebase, Freshchat, FreshchatCredentials, FyndRewards, FyndRewardsCredentials, GetIntegrationsOptInsResponse, GoogleMap, GoogleMapCredentials, GooglePlusLink, Gtm, GtmCredentials, HomePageFeature, InformationAddress, InformationPhone, InformationSupport, InstagramLink, Integration, IntegrationConfigResponse, IntegrationLevel, IntegrationMeta, IntegrationOptIn, InvalidPayloadRequest, InventoryArticleAssignment, InventoryBrand, InventoryBrandRule, InventoryCategory, InventoryDiscount, InventoryPaymentConfig, InventoryPrice, InventoryStore, InventoryStoreRule, InventoryValidator, Ios, JsonSchema, LandingImage, LandingPageFeature, LastPatch, LaunchPage, LinkedInLink, Links, ListingPriceFeature, LoyaltyPointsConfig, Methods, MobileAppConfigRequest, MobileAppConfiguration, Moengage, MoengageCredentials, NotFound, OptedApplicationResponse, OptedCompany, OptedInventory, OptedStore, OptedStoreAddress, OptedStoreIntegration, OptOutInventory, OptType, OrderFeature, OrderingStore, OrderingStoreConfig, OrderingStores, OrderingStoreSelect, OrderingStoreSelectRequest, OrderingStoresResponse, OrderValidator, OtherEntity, OtherEntityData, OtherSellerApplication, OtherSellerApplications, OtherSellerCompany, Page, PanCardConfig, PaymentModeConfig, PaymentSelectionLock, PcrFeature, PinterestLink, ProductDetailFeature, QrFeature, RegistrationPageFeature, RevenueEngineFeature, RewardPointsConfig, Safetynet, SafetynetCredentials, SecureUrl, Segment, SegmentCredentials, SocialLinks, SplashImage, StoreByBrandsRequest, StoreByBrandsResponse, StoreCriteriaRule, StoreLatLong, StorePriority, StorePriorityRule, StoresResponse, StoreValidator, SuccessMessageResponse, TokenResponse, Tokens, TwitterLink, UpdateDomain, UpdateDomainTypeRequest, UpdateIntegrationLevelRequest, ValidationFailedResponse, Validators, VimeoLink, YoutubeLink };
 }
 /** @returns {Android} */
 declare function Android(): Android;
@@ -3760,6 +3768,19 @@ type OrderingStores = {
      */
     type?: string;
 };
+/** @returns {OrderingStoreSelect} */
+declare function OrderingStoreSelect(): OrderingStoreSelect;
+type OrderingStoreSelect = {
+    /**
+     * - Ordering store unique uid. It is required.
+     */
+    uid: number;
+};
+/** @returns {OrderingStoreSelectRequest} */
+declare function OrderingStoreSelectRequest(): OrderingStoreSelectRequest;
+type OrderingStoreSelectRequest = {
+    ordering_store: OrderingStoreSelect;
+};
 /** @returns {OrderingStoresResponse} */
 declare function OrderingStoresResponse(): OrderingStoresResponse;
 type OrderingStoresResponse = {

package/sdk/platform/Configuration/ConfigurationPlatformModel.js

@@ -1265,6 +1265,16 @@ const Joi = require("joi");
  *   compulsory. For soft type, delivery store selection is optional.
  */
 
+/**
+ * @typedef OrderingStoreSelect
+ * @property {number} uid - Ordering store unique uid. It is required.
+ */
+
+/**
+ * @typedef OrderingStoreSelectRequest
+ * @property {OrderingStoreSelect} ordering_store
+ */
+
 /**
  * @typedef OrderingStoresResponse
  * @property {OrderingStore[]} [items]
@@ -2976,6 +2986,20 @@ class ConfigurationPlatformModel {
     });
   }
 
+  /** @returns {OrderingStoreSelect} */
+  static OrderingStoreSelect() {
+    return Joi.object({
+      uid: Joi.number().required(),
+    });
+  }
+
+  /** @returns {OrderingStoreSelectRequest} */
+  static OrderingStoreSelectRequest() {
+    return Joi.object({
+      ordering_store: ConfigurationPlatformModel.OrderingStoreSelect().required(),
+    });
+  }
+
   /** @returns {OrderingStoresResponse} */
   static OrderingStoresResponse() {
     return Joi.object({

package/sdk/platform/Order/OrderPlatformClient.d.ts

@@ -211,7 +211,7 @@ declare class Order {
      * @summary:
      * @description: Get lane config for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
      */
-    getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponse>;
+    getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponse>;
     /**
      * @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -231,7 +231,60 @@ declare class Order {
      * @summary:
      * @description: Get Orders Listing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
      */
-    getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
+    getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.lane] - Lane refers to a section where orders are
+     *   assigned, indicating its grouping
+     * @param {string} [arg.searchType] - Search_type refers to the field that
+     *   will be used as the target for the search operation
+     * @param {string} [arg.bagStatus] - Bag_status refers to status of the
+     *   entity. Filters orders based on the status.
+     * @param {string} [arg.timeToDispatch] - Time_to_dispatch refers to
+     *   estimated SLA time.
+     * @param {string} [arg.paymentMethods] -
+     * @param {string} [arg.tags] - Tags refers to additional descriptive labels
+     *   associated with the order
+     * @param {string} [arg.searchValue] - Search_value is matched against the
+     *   field specified by the search_type
+     * @param {string} [arg.fromDate] -
+     * @param {string} [arg.toDate] -
+     * @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
+     * @param {string} [arg.stores] -
+     * @param {string} [arg.salesChannels] -
+     * @param {number} [arg.pageSize] -
+     * @param {boolean} [arg.isPrioritySort] -
+     * @param {string} [arg.customMeta] -
+     * @param {boolean} [arg.myOrders] -
+     * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
+     *   non-cross company order
+     * @param {string} [arg.customerId] -
+     * @param {string} [arg.orderType] -
+     * @returns {Paginator<OrderPlatformModel.OrderListingResponse>}
+     * @summary:
+     * @description: Get Orders Listing
+     */
+    getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, }?: {
+        lane?: string;
+        searchType?: string;
+        bagStatus?: string;
+        timeToDispatch?: string;
+        paymentMethods?: string;
+        tags?: string;
+        searchValue?: string;
+        fromDate?: string;
+        toDate?: string;
+        dpIds?: string;
+        stores?: string;
+        salesChannels?: string;
+        pageSize?: number;
+        isPrioritySort?: boolean;
+        customMeta?: string;
+        myOrders?: boolean;
+        showCrossCompanyData?: boolean;
+        customerId?: string;
+        orderType?: string;
+    }): Paginator<OrderPlatformModel.OrderListingResponse>;
     /**
      * @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -284,7 +337,71 @@ declare class Order {
      * @summary:
      * @description: Get Shipments Listing for the company id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
      */
-    getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
+    getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.lane] - Name of lane for which data is to be fetched
+     * @param {string} [arg.bagStatus] - Comma separated values of bag statuses
+     * @param {boolean} [arg.statusOverrideLane] - Use this flag to fetch by
+     *   bag_status and override lane
+     * @param {number} [arg.timeToDispatch] -
+     * @param {string} [arg.searchType] - Search type key
+     * @param {string} [arg.searchValue] - Search type value
+     * @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
+     * @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
+     * @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
+     * @param {string} [arg.stores] - Comma separated values of store ids
+     * @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
+     * @param {number} [arg.pageSize] - Page size of data received per page
+     * @param {boolean} [arg.fetchActiveShipment] - Flag to fetch active shipments
+     * @param {boolean} [arg.excludeLockedShipments] - Flag to fetch locked shipments
+     * @param {string} [arg.paymentMethods] - Comma separated values of payment methods
+     * @param {string} [arg.channelShipmentId] - App Shipment Id
+     * @param {string} [arg.channelOrderId] - App Order Id
+     * @param {string} [arg.customMeta] -
+     * @param {string} [arg.orderingChannel] -
+     * @param {string} [arg.companyAffiliateTag] -
+     * @param {boolean} [arg.myOrders] -
+     * @param {string} [arg.platformUserId] -
+     * @param {string} [arg.sortType] - Sort the result data on basis of input
+     * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
+     *   non-cross company order
+     * @param {string} [arg.tags] - Comma separated values of tags
+     * @param {string} [arg.customerId] -
+     * @param {string} [arg.orderType] -
+     * @returns {Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
+     * @summary:
+     * @description: Get Shipments Listing for the company id
+     */
+    getShipmentsPaginator({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, }?: {
+        lane?: string;
+        bagStatus?: string;
+        statusOverrideLane?: boolean;
+        timeToDispatch?: number;
+        searchType?: string;
+        searchValue?: string;
+        fromDate?: string;
+        toDate?: string;
+        dpIds?: string;
+        stores?: string;
+        salesChannels?: string;
+        pageSize?: number;
+        fetchActiveShipment?: boolean;
+        excludeLockedShipments?: boolean;
+        paymentMethods?: string;
+        channelShipmentId?: string;
+        channelOrderId?: string;
+        customMeta?: string;
+        orderingChannel?: string;
+        companyAffiliateTag?: string;
+        myOrders?: boolean;
+        platformUserId?: string;
+        sortType?: string;
+        showCrossCompanyData?: boolean;
+        tags?: string;
+        customerId?: string;
+        orderType?: string;
+    }): Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
     /**
      * @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -466,3 +583,4 @@ declare class Order {
 }
 import OrderPlatformValidator = require("./OrderPlatformValidator");
 import OrderPlatformModel = require("./OrderPlatformModel");
+import Paginator = require("../../common/Paginator");