@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1

package/sdk/application/Logistic/LogisticApplicationClient.js

@@ -11,24 +11,21 @@ class Logistic {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
+      createShipments:
+        "/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipments",
       getAllCountries: "/service/application/logistics/v1.0/country-list",
       getCountries: "/service/application/logistics/v2.0/countries",
       getCountry:
         "/service/application/logistics/v1.0/countries/{country_iso_code}",
-      getCourierPartners:
-        "/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners",
-      getDeliveryPromise:
-        "/service/application/logistics/v1.0/delivery-promise",
+      getGeoAreas:
+        "/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas",
       getLocalities:
         "/service/application/logistics/v1.0/localities/{locality_type}",
       getLocality:
         "/service/application/logistics/v1.0/localities/{locality_type}/{locality_value}",
-      getLocations: "/service/application/logistics/v1.0/locations",
-      getOptimalLocations:
-        "/service/application/logistics/v1.0/reassign_stores",
       getPincodeCity: "/service/application/logistics/v1.0/pincode/{pincode}",
-      getPincodeZones: "/service/application/logistics/v1.0/pincode/zones",
-      getTatProduct: "/service/application/logistics/v1.0/",
+      getZones:
+        "/service/application/logistics/v2.0/company/{company_id}/application/{application_id}/zones",
       validateAddress:
         "/service/application/logistics/v1.0/country/{country_iso_code}/address/templates/{template_name}/validate",
     };
@@ -51,7 +48,65 @@ 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/).
+   */
+  async createShipments(
+    { companyId, applicationId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+
+    if (!companyId) {
+      invalidInput.push({
+        message: `The 'companyId' field is required.`,
+        path: ["companyId"],
+      });
+    }
+    if (!applicationId) {
+      invalidInput.push({
+        message: `The 'applicationId' field is required.`,
+        path: ["applicationId"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["createShipments"],
+        params: { companyId, applicationId },
+      }),
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
+  /**
+   * @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/).
@@ -98,19 +153,13 @@ class Logistic {
    * @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/).
    */
   async getCountries(
-    {
-      onboarding,
-      pageNo,
-      pageSize,
-      q,
-      hierarchy,
-      phoneCode,
-      requestHeaders,
-    } = { requestHeaders: {} },
+    { onboard, pageNo, pageSize, q, hierarchy, requestHeaders } = {
+      requestHeaders: {},
+    },
     { responseHeaders } = { responseHeaders: false }
   ) {
     let invalidInput = [];
@@ -122,12 +171,11 @@ class Logistic {
     }
 
     const query_params = {};
-    query_params["onboarding"] = onboarding;
+    query_params["onboard"] = onboard;
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
     query_params["q"] = q;
     query_params["hierarchy"] = hierarchy;
-    query_params["phone_code"] = phoneCode;
 
     const xHeaders = {};
 
@@ -152,6 +200,43 @@ class Logistic {
     return response;
   }
 
+  /**
+   * @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 } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getCountries({
+        onboard: onboard,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        q: q,
+        hierarchy: hierarchy,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
@@ -207,74 +292,43 @@ class Logistic {
   /**
    * @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/).
+   * @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/).
    */
-  async getCourierPartners(
-    { companyId, applicationId, body, requestHeaders } = { requestHeaders: {} },
+  async getGeoAreas(
+    {
+      applicationId,
+      companyId,
+      pageSize,
+      pageNo,
+      type,
+      isActive,
+      q,
+      countryIsoCode,
+      state,
+      city,
+      pincode,
+      sector,
+      requestHeaders,
+    } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     let invalidInput = [];
 
-    if (!companyId) {
-      invalidInput.push({
-        message: `The 'companyId' field is required.`,
-        path: ["companyId"],
-      });
-    }
     if (!applicationId) {
       invalidInput.push({
         message: `The 'applicationId' field is required.`,
         path: ["applicationId"],
       });
     }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["getCourierPartners"],
-        params: { companyId, applicationId },
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
+    if (!companyId) {
+      invalidInput.push({
+        message: `The 'companyId' field is required.`,
+        path: ["companyId"],
+      });
     }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<GetPromiseDetails>} - Success response
-   * @name getDeliveryPromise
-   * @summary: Get delivery promise
-   * @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/).
-   */
-  async getDeliveryPromise(
-    { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
     if (invalidInput.length) {
       const error = new Error();
       error.message = "Missing required field";
@@ -283,8 +337,16 @@ class Logistic {
     }
 
     const query_params = {};
-    query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
+    query_params["page_no"] = pageNo;
+    query_params["type"] = type;
+    query_params["is_active"] = isActive;
+    query_params["q"] = q;
+    query_params["country_iso_code"] = countryIsoCode;
+    query_params["state"] = state;
+    query_params["city"] = city;
+    query_params["pincode"] = pincode;
+    query_params["sector"] = sector;
 
     const xHeaders = {};
 
@@ -292,8 +354,8 @@ class Logistic {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getDeliveryPromise"],
-        params: {},
+        url: this._urls["getGeoAreas"],
+        params: { applicationId, companyId },
       }),
       query_params,
       undefined,
@@ -314,7 +376,7 @@ class Logistic {
    * @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/).
    */
   async getLocalities(
@@ -326,7 +388,7 @@ class Logistic {
       pageNo,
       pageSize,
       q,
-      sector,
+      name,
       requestHeaders,
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
@@ -353,7 +415,7 @@ class Logistic {
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
     query_params["q"] = q;
-    query_params["sector"] = sector;
+    query_params["name"] = name;
 
     const xHeaders = {};
 
@@ -378,6 +440,55 @@ class Logistic {
     return response;
   }
 
+  /**
+   * @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.
+   */
+  getLocalitiesPaginator({
+    localityType,
+    country,
+    state,
+    city,
+    pageSize,
+    q,
+    name,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getLocalities({
+        localityType: localityType,
+        country: country,
+        state: state,
+        city: city,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        q: q,
+        name: name,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
@@ -444,132 +555,9 @@ class Logistic {
   /**
    * @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/).
-   */
-  async getLocations(
-    {
-      xApplicationId,
-      xApplicationData,
-      country,
-      state,
-      city,
-      pincode,
-      sector,
-      pageNo,
-      pageSize,
-      requestHeaders,
-    } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-
-    if (!xApplicationId) {
-      invalidInput.push({
-        message: `The 'xApplicationId' field is required.`,
-        path: ["xApplicationId"],
-      });
-    }
-    if (!xApplicationData) {
-      invalidInput.push({
-        message: `The 'xApplicationData' field is required.`,
-        path: ["xApplicationData"],
-      });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-    query_params["x-application-id"] = xApplicationId;
-    query_params["x-application-data"] = xApplicationData;
-    query_params["country"] = country;
-    query_params["state"] = state;
-    query_params["city"] = city;
-    query_params["pincode"] = pincode;
-    query_params["sector"] = sector;
-    query_params["page_no"] = pageNo;
-    query_params["page_size"] = pageSize;
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getLocations"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @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/).
-   */
-  async getOptimalLocations(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["getOptimalLocations"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PincodeDetails>} - Success response
+   * @returns {Promise<PincodeApiResponse>} - Success response
    * @name getPincodeCity
-   * @summary: Get pincode details
+   * @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/).
    */
   async getPincodeCity(
@@ -619,61 +607,44 @@ class Logistic {
   /**
    * @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<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/).
    */
-  async getPincodeZones(
-    { body, requestHeaders } = { requestHeaders: {} },
+  async getZones(
+    {
+      companyId,
+      applicationId,
+      stage,
+      type,
+      pageSize,
+      pageNo,
+      isActive,
+      q,
+      countryIsoCode,
+      pincode,
+      state,
+      city,
+      sector,
+      requestHeaders,
+    } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["getPincodeZones"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
 
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
+    if (!companyId) {
+      invalidInput.push({
+        message: `The 'companyId' field is required.`,
+        path: ["companyId"],
+      });
+    }
+    if (!applicationId) {
+      invalidInput.push({
+        message: `The 'applicationId' field is required.`,
+        path: ["applicationId"],
+      });
     }
-
-    return response;
-  }
-
-  /**
-   * @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/).
-   */
-  async getTatProduct(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
     if (invalidInput.length) {
       const error = new Error();
       error.message = "Missing required field";
@@ -682,18 +653,29 @@ class Logistic {
     }
 
     const query_params = {};
+    query_params["stage"] = stage;
+    query_params["type"] = type;
+    query_params["page_size"] = pageSize;
+    query_params["page_no"] = pageNo;
+    query_params["is_active"] = isActive;
+    query_params["q"] = q;
+    query_params["country_iso_code"] = countryIsoCode;
+    query_params["pincode"] = pincode;
+    query_params["state"] = state;
+    query_params["city"] = city;
+    query_params["sector"] = sector;
 
     const xHeaders = {};
 
     const response = await ApplicationAPIClient.execute(
       this._conf,
-      "post",
+      "get",
       constructUrl({
-        url: this._urls["getTatProduct"],
-        params: {},
+        url: this._urls["getZones"],
+        params: { companyId, applicationId },
       }),
       query_params,
-      body,
+      undefined,
       { ...xHeaders, ...requestHeaders },
       { responseHeaders }
     );
@@ -709,7 +691,7 @@ class Logistic {
   /**
    * @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/).