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

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -2,25 +2,76 @@ const Joi = require("joi");
 
 const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
+/**
+ * @typedef BulkServiceabilityParam
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
+ */
+
+/**
+ * @typedef BulkTatParam
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
+ */
+
 /**
  * @typedef CreateCourierPartnerAccountParam
- * @property {ServiceabilityPlatformModel.CourierAccount} body
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
+ */
+
+/**
+ * @typedef CreateCourierPartnerSchemeParam
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel} body
  */
 
 /**
  * @typedef CreatePackageMaterialParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 
 /**
  * @typedef CreatePackageMaterialRuleParam
- * @property {ServiceabilityPlatformModel.PackageRuleRequest} body
+ * @property {ServiceabilityPlatformModel.PackageRule} body
  */
 
-/** @typedef GetCompanyConfigurationParam */
+/**
+ * @typedef GetBulkServiceabilityParam
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [batchId] - Unique identifier of bulk job
+ * @property {string} [action] - Import or export bulk type
+ * @property {string} [status] - Status of the bulk actions
+ * @property {string} [country] - Country for which bulk job is initiated
+ * @property {string} [region] - Region for which bulk job is initiated
+ * @property {string} [startDate] - Fetch job history after a particule date
+ * @property {string} [endDate] - Fetch job history before a particule date
+ */
+
+/**
+ * @typedef GetBulkTatParam
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [batchId] - Unique identifier of bulk job
+ * @property {string} [action] - Import or export bulk type
+ * @property {string} [status] - Status of the bulk actions
+ * @property {string} [country] - Country for which bulk job is initiated
+ * @property {string} [region] - Region for which bulk job is initiated
+ * @property {string} [startDate] - Fetch job history after a particule date
+ * @property {string} [endDate] - Fetch job history before a particule date
+ */
 
-/** @typedef GetCompanySelfShipParam */
+/** @typedef GetCompanyConfigurationParam */
 
 /**
  * @typedef GetCountriesParam
@@ -35,12 +86,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  *   on their available hierarchy.
  */
 
-/**
- * @typedef GetCountryParam
- * @property {string} countryIsoCode - The `country_iso_code` is ISO-2 (alpha-2)
- *   code for the country.
- */
-
 /**
  * @typedef GetCourierPartnerAccountParam
  * @property {string} accountId - Unique ID of courier account
@@ -48,59 +93,40 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetCourierPartnerAccountsParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [stage] - Stage of the account. enabled/disabled
+ * @property {string} [stage] - Stage of the account.
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
  * @property {string} [transportType] - Filters dp accounts based on transport_type
  * @property {string[]} [accountIds] - Filters dp accounts based on their ids
  * @property {boolean} [selfShip] - To filter self ship/non self ship dp accounts
- * @property {boolean} [ownAccount] - Filters seller owned or admin owned dp accounts
+ * @property {boolean} [ownAccount] - Filters seller owned or Fynd Managed dp accounts
  * @property {string} [q] - Filters dp accounts based on case sensitive partial
  *   account name
  */
 
 /**
- * @typedef GetInstalledCourierPartnerExtensionsParam
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [isInstalled] - Filter to get installed extensions only
+ * @typedef GetCourierPartnerSchemeParam
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
  */
 
 /**
- * @typedef GetListPackageMaterialRuleDetailsParam
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [isActive] - Filters items based on given is_active
+ * @typedef GetCourierPartnerSchemesParam
+ * @property {string} [schemeType] - Indicates whether a scheme is created by an
+ *   admin for global purposes or customized for a specific company.
+ * @property {string} [paymentMode] - Indicates payment mode for a scheme.
+ * @property {string[]} [capabilities] - Indicates whether the scheme possesses
+ *   certain capabilities.
+ * @property {string[]} [schemeIds] - List of scheme ids which need to be
+ *   returned in the response.
  */
 
 /**
- * @typedef GetLocalitiesParam
- * @property {string} localityType - A `locality_type` contains unique
- *   geographical division.
- * @property {string} [country] - A `country` contains a specific value of the
- *   country iso2 code.
- * @property {string} [state] - A `state` contains a specific value of the
- *   state, province.
- * @property {string} [city] - A `city` contains a specific value of the city.
- * @property {number} [pageNo] - Page number.
- * @property {number} [pageSize] - Page size.
- * @property {string} [q] - Search.
- * @property {string} [name] - Search for localities. Either provide a full name
- *   or a search term.
- */
-
-/**
- * @typedef GetLocalityParam
- * @property {string} localityType - A `locality_type` contains value
- *   geographical division.
- * @property {string} localityValue - A `locality_value` contains a specific
- *   name of the locality.
- * @property {string} [country] - A `country` contains a specific value of the
- *   country iso2 code.
- * @property {string} [state] - A `state` contains a specific value of the
- *   state, province.
- * @property {string} [city] - A `city` contains a specific value of the city.
+ * @typedef GetInstalledCourierPartnerExtensionsParam
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [isInstalled] - Filter to get installed extensions only
  */
 
 /**
@@ -110,9 +136,10 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetPackageMaterialListParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [q] - Perform regex search on items matching name for given value
+ * @property {string} [q] - Used to search for matching results based on the
+ *   provided input.
  * @property {string} [size] - Filters items based on given size
  * @property {string} [packageType] - Filters items based on given package_type
  */
@@ -123,15 +150,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  *   identifier for a Package Material Rule
  */
 
-/**
- * @typedef GetPackageMaterialRuleDetailsParam
- * @property {string} ruleId - A `package_material_rule_id` is a unique
- *   identifier for a Package Material Rule
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [isActive] - Filters items based on given is_active
- */
-
 /**
  * @typedef GetPackageMaterialsParam
  * @property {string} packageMaterialId - A `package_material_id` is a unique
@@ -139,26 +157,42 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  */
 
 /**
- * @typedef UpdateCompanyConfigurationParam
- * @property {ServiceabilityPlatformModel.CompanyConfigurationShema} body
+ * @typedef GetSampleFileServiceabilityStatusParam
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [batchId] - Batch id of the execution
  */
 
+/** @typedef GetSelfShipDetailsParam */
+
 /**
- * @typedef UpdateCompanySelfShipParam
- * @property {ServiceabilityPlatformModel.CompanySelfShip} body
+ * @typedef SampleFileServiceabilityParam
+ * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
+ */
+
+/**
+ * @typedef UpdateCompanyConfigurationParam
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
  */
 
 /**
  * @typedef UpdateCourierPartnerAccountParam
  * @property {string} accountId - Unique ID of courier account
- * @property {ServiceabilityPlatformModel.CourierAccount} body
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
+ */
+
+/**
+ * @typedef UpdateCourierPartnerSchemeParam
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema} body
  */
 
 /**
  * @typedef UpdatePackageMaterialRuleParam
  * @property {string} ruleId - A `package_material_rule_id` is a unique
  *   identifier for a Package Material Rule
- * @property {ServiceabilityPlatformModel.PackageRuleRequest} body
+ * @property {ServiceabilityPlatformModel.PackageRule} body
  */
 
 /**
@@ -169,17 +203,40 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  */
 
 /**
- * @typedef ValidateAddressParam
- * @property {string} countryIsoCode - The ISO code of the country.
- * @property {string} templateName - The type of address form.
- * @property {ServiceabilityPlatformModel.ValidateAddressRequest} body
+ * @typedef UpdateSelfShipDetailsParam
+ * @property {ServiceabilityPlatformModel.SelfshipSchema} body
  */
 
 class ServiceabilityPlatformValidator {
+  /** @returns {BulkServiceabilityParam} */
+  static bulkServiceability() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
+    }).required();
+  }
+
+  /** @returns {BulkTatParam} */
+  static bulkTat() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
+    }).required();
+  }
+
   /** @returns {CreateCourierPartnerAccountParam} */
   static createCourierPartnerAccount() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CourierAccount().required(),
+      body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
+    }).required();
+  }
+
+  /** @returns {CreateCourierPartnerSchemeParam} */
+  static createCourierPartnerScheme() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel().required(),
     }).required();
   }
 
@@ -194,17 +251,46 @@ class ServiceabilityPlatformValidator {
   /** @returns {CreatePackageMaterialRuleParam} */
   static createPackageMaterialRule() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.PackageRuleRequest().required(),
+      body: ServiceabilityPlatformModel.PackageRule().required(),
     }).required();
   }
 
-  /** @returns {GetCompanyConfigurationParam} */
-  static getCompanyConfiguration() {
-    return Joi.object({}).required();
+  /** @returns {GetBulkServiceabilityParam} */
+  static getBulkServiceability() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      batchId: Joi.string().allow(""),
+      action: Joi.string().allow(""),
+      status: Joi.string().allow("").allow(null),
+      country: Joi.string().allow(""),
+      region: Joi.string().allow(""),
+      startDate: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetBulkTatParam} */
+  static getBulkTat() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      batchId: Joi.string().allow(""),
+      action: Joi.string().allow(""),
+      status: Joi.string().allow("").allow(null),
+      country: Joi.string().allow(""),
+      region: Joi.string().allow(""),
+      startDate: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+    }).required();
   }
 
-  /** @returns {GetCompanySelfShipParam} */
-  static getCompanySelfShip() {
+  /** @returns {GetCompanyConfigurationParam} */
+  static getCompanyConfiguration() {
     return Joi.object({}).required();
   }
 
@@ -219,13 +305,6 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetCountryParam} */
-  static getCountry() {
-    return Joi.object({
-      countryIsoCode: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetCourierPartnerAccountParam} */
   static getCourierPartnerAccount() {
     return Joi.object({
@@ -248,46 +327,29 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetInstalledCourierPartnerExtensionsParam} */
-  static getInstalledCourierPartnerExtensions() {
+  /** @returns {GetCourierPartnerSchemeParam} */
+  static getCourierPartnerScheme() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      isInstalled: Joi.string().allow(""),
+      schemeId: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetListPackageMaterialRuleDetailsParam} */
-  static getListPackageMaterialRuleDetails() {
+  /** @returns {GetCourierPartnerSchemesParam} */
+  static getCourierPartnerSchemes() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      isActive: Joi.string().allow(""),
+      schemeType: Joi.string().allow(""),
+      paymentMode: Joi.string().allow(""),
+      capabilities: Joi.array().items(Joi.string().allow("")),
+      schemeIds: Joi.array().items(Joi.string().allow("")),
     }).required();
   }
 
-  /** @returns {GetLocalitiesParam} */
-  static getLocalities() {
+  /** @returns {GetInstalledCourierPartnerExtensionsParam} */
+  static getInstalledCourierPartnerExtensions() {
     return Joi.object({
-      localityType: Joi.string().allow("").required(),
-      country: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      city: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      q: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetLocalityParam} */
-  static getLocality() {
-    return Joi.object({
-      localityType: Joi.string().allow("").required(),
-      localityValue: Joi.string().allow("").required(),
-      country: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      city: Joi.string().allow(""),
+      isInstalled: Joi.string().allow(""),
     }).required();
   }
 
@@ -316,42 +378,54 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetPackageMaterialRuleDetailsParam} */
-  static getPackageMaterialRuleDetails() {
+  /** @returns {GetPackageMaterialsParam} */
+  static getPackageMaterials() {
+    return Joi.object({
+      packageMaterialId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetSampleFileServiceabilityStatusParam} */
+  static getSampleFileServiceabilityStatus() {
     return Joi.object({
-      ruleId: Joi.string().allow("").required(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      isActive: Joi.string().allow(""),
+      batchId: Joi.string().allow(""),
     }).required();
   }
 
-  /** @returns {GetPackageMaterialsParam} */
-  static getPackageMaterials() {
+  /** @returns {GetSelfShipDetailsParam} */
+  static getSelfShipDetails() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {SampleFileServiceabilityParam} */
+  static sampleFileServiceability() {
     return Joi.object({
-      packageMaterialId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails().required(),
     }).required();
   }
 
   /** @returns {UpdateCompanyConfigurationParam} */
   static updateCompanyConfiguration() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CompanyConfigurationShema().required(),
+      body: ServiceabilityPlatformModel.CompanyConfigurationSchema().required(),
     }).required();
   }
 
-  /** @returns {UpdateCompanySelfShipParam} */
-  static updateCompanySelfShip() {
+  /** @returns {UpdateCourierPartnerAccountParam} */
+  static updateCourierPartnerAccount() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CompanySelfShip().required(),
+      accountId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
     }).required();
   }
 
-  /** @returns {UpdateCourierPartnerAccountParam} */
-  static updateCourierPartnerAccount() {
+  /** @returns {UpdateCourierPartnerSchemeParam} */
+  static updateCourierPartnerScheme() {
     return Joi.object({
-      accountId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.CourierAccount().required(),
+      schemeId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema().required(),
     }).required();
   }
 
@@ -359,7 +433,7 @@ class ServiceabilityPlatformValidator {
   static updatePackageMaterialRule() {
     return Joi.object({
       ruleId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.PackageRuleRequest().required(),
+      body: ServiceabilityPlatformModel.PackageRule().required(),
     }).required();
   }
 
@@ -371,12 +445,10 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {ValidateAddressParam} */
-  static validateAddress() {
+  /** @returns {UpdateSelfShipDetailsParam} */
+  static updateSelfShipDetails() {
     return Joi.object({
-      countryIsoCode: Joi.string().allow("").required(),
-      templateName: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.ValidateAddressRequest().required(),
+      body: ServiceabilityPlatformModel.SelfshipSchema().required(),
     }).required();
   }
 }

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

@@ -9,7 +9,7 @@ declare class Share {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
      * @name createShortLink
-     * @summary: Create short link.
+     * @summary: Create short link
      * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
      */
     createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
@@ -19,17 +19,29 @@ declare class Share {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
      * @name getShortLinkByHash
-     * @summary: Get short link by hash.
+     * @summary: Get short link by hash
      * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
      */
     getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
+    /**
+     * @param {SharePlatformApplicationValidator.GetShortLinkClickStatsParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
+     * @name getShortLinkClickStats
+     * @summary: Get short link click statistics
+     * @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
+     */
+    getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResult>;
     /**
      * @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
      * @name getShortLinks
-     * @summary: Get short links.
+     * @summary: Get short links
      * @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
      */
     getShortLinks({ pageNo, pageSize, createdBy, active, shortUrl, originalUrl, title, requestHeaders, }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
@@ -41,7 +53,7 @@ declare class Share {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
      * @name updateShortLinkById
-     * @summary: Update short link by ID.
+     * @summary: Update short link
      * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
      */
     updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;