@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

package/sdk/application/Logistic/LogisticApplicationClient.d.ts

@@ -3,18 +3,17 @@ declare class Logistic {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
+        createShipments: string;
         getAllCountries: string;
         getCountries: string;
         getCountry: string;
-        getCourierPartners: string;
         getDeliveryPromise: string;
+        getGeoAreas: string;
         getLocalities: string;
+        getLocalitiesByPrefix: string;
         getLocality: string;
-        getLocations: string;
-        getOptimalLocations: string;
         getPincodeCity: string;
-        getPincodeZones: string;
-        getTatProduct: string;
+        getZones: string;
         validateAddress: string;
     };
     _urls: {};
@@ -22,21 +21,50 @@ declare class Logistic {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<CountryListResult>} - Success response
+     * @returns {Promise<GenerateShipmentsAndCourierPartnerResponse>} - Success response
+     * @name createShipments
+     * @summary: Create and return shipments.
+     * @description: Create and return shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/createShipments/).
+     */
+    createShipments({ companyId, applicationId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GenerateShipmentsAndCourierPartnerResponse>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<CountryListResponse>} - Success response
      * @name getAllCountries
      * @summary: Get deliverable countries
      * @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
      */
-    getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CountryListResult>;
+    getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CountryListResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<GetCountries>} - Success response
      * @name getCountries
-     * @summary: Get countries
-     * @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
+     * @summary: Get all countries and associated data.
+     * @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
      */
-    getCountries({ onboarding, pageNo, pageSize, q, hierarchy, phoneCode, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
+    getCountries({ onboard, pageNo, pageSize, q, hierarchy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.onboard] - Only fetch countries which allowed for
+     *   onboard on Platform.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 12
+     * @param {string} [arg.q] - The search string to search in the list of
+     *   countries by name.
+     * @param {string} [arg.hierarchy] - The search filter to filter countries
+     *   based on their available hierarchy.
+     * @returns {Paginator<GetCountries>}
+     * @summary: Get all countries and associated data.
+     * @description: Retrieve a list of countries for logistical purposes.
+     */
+    getCountriesPaginator({ onboard, pageSize, q, hierarchy }?: {
+        onboard?: boolean;
+        pageSize?: number;
+        q?: string;
+        hierarchy?: string;
+    }): Paginator<GetCountries>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -46,15 +74,6 @@ declare class Logistic {
      * @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
      */
     getCountry({ countryIsoCode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountry>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ShipmentCourierPartnerResult>} - Success response
-     * @name getCourierPartners
-     * @summary: Serviceable Courier Partners.
-     * @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCourierPartners/).
-     */
-    getCourierPartners({ companyId, applicationId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentCourierPartnerResult>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -64,76 +83,106 @@ declare class Logistic {
      * @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getDeliveryPromise/).
      */
     getDeliveryPromise({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<GeoAreaGetResponseBody>} - Success response
+     * @name getGeoAreas
+     * @summary: Get all geoareas in the current application.
+     * @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getGeoAreas/).
+     */
+    getGeoAreas({ applicationId, companyId, pageSize, pageNo, type, isActive, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GeoAreaGetResponseBody>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<GetLocalities>} - Success response
      * @name getLocalities
-     * @summary: Get localities
+     * @summary: Get Localities
      * @description: Get geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
      */
-    getLocalities({ localityType, country, state, city, pageNo, pageSize, q, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetLocalities>;
+    getLocalities({ localityType, country, state, city, pageNo, pageSize, q, name, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetLocalities>;
     /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<GetLocality>} - Success response
-     * @name getLocality
-     * @summary: Get locality detail
-     * @description: Get detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.localityType - Unique geographical division.
+     * @param {string} [arg.country] - Country name.
+     * @param {string} [arg.state] - State or the province.
+     * @param {string} [arg.city] - City.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 12.
+     * @param {string} [arg.q] - This parameter is used to filter or search the records.
+     * @param {string} [arg.name] - Search for localities. Either provide a full
+     *   name or a search term.
+     * @returns {Paginator<GetLocalities>}
+     * @summary: Get Localities
+     * @description: Get geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state.
      */
-    getLocality({ localityType, localityValue, country, state, city, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetLocality>;
+    getLocalitiesPaginator({ localityType, country, state, city, pageSize, q, name, }?: {
+        localityType: string;
+        country?: string;
+        state?: string;
+        city?: string;
+        pageSize?: number;
+        q?: string;
+        name?: string;
+    }): Paginator<GetLocalities>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<GetStoreResult>} - Success response
-     * @name getLocations
-     * @summary: Get available selling locations
-     * @description: Get stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
+     * @returns {Promise<GetLocalities>} - Success response
+     * @name getLocalitiesByPrefix
+     * @summary: Get Localities by Name Prefix
+     * @description: Get localities that start with a specified prefix. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalitiesByPrefix/).
      */
-    getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetStoreResult>;
+    getLocalitiesByPrefix({ companyId, pageNo, pageSize, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetLocalities>;
     /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ReAssignStoreResult>} - Success response
-     * @name getOptimalLocations
-     * @summary: Get selling locations
-     * @description: Get optimal fulfillment centre for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - The unique identifier of the company.
+     * @param {number} [arg.pageSize] - Number of items per page.
+     * @param {string} [arg.q] - Localities starting with the specified prefix.
+     * @returns {Paginator<GetLocalities>}
+     * @summary: Get Localities by Name Prefix
+     * @description: Get localities that start with a specified prefix.
      */
-    getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReAssignStoreResult>;
+    getLocalitiesByPrefixPaginator({ companyId, pageSize, q }?: {
+        companyId: number;
+        pageSize?: number;
+        q?: string;
+    }): Paginator<GetLocalities>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<PincodeDetails>} - Success response
-     * @name getPincodeCity
-     * @summary: Get pincode details
-     * @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
+     * @returns {Promise<GetLocality>} - Success response
+     * @name getLocality
+     * @summary: Get locality detail
+     * @description: Get detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
      */
-    getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PincodeDetails>;
+    getLocality({ localityType, localityValue, country, state, city, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetLocality>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<GetZoneFromPincodeViewResult>} - Success response
-     * @name getPincodeZones
-     * @summary: Get zones
-     * @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
+     * @returns {Promise<PincodeApiResponse>} - Success response
+     * @name getPincodeCity
+     * @summary: Get Pincode API
+     * @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
      */
-    getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetZoneFromPincodeViewResult>;
+    getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PincodeApiResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<TATViewResult>} - Success response
-     * @name getTatProduct
-     * @summary: Get product's turnaround time
-     * @description: Get the estimated delivery time frame for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
+     * @returns {Promise<ListViewResponseV2>} - Success response
+     * @name getZones
+     * @summary: Shows zones defined at the application level
+     * @description: Displays the list of zones defined at the application level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getZones/).
      */
-    getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TATViewResult>;
+    getZones({ companyId, applicationId, stage, type, pageSize, pageNo, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ListViewResponseV2>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ValidateAddressDetails>} - Success response
+     * @returns {Promise<ValidateAddressRequest>} - Success response
      * @name validateAddress
      * @summary: Validate address
      * @description: Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/validateAddress/).
      */
-    validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ValidateAddressDetails>;
+    validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ValidateAddressRequest>;
 }
+import Paginator = require("../../common/Paginator");