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

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

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

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

@@ -13,7 +13,7 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef CreateCourierPartnerAccountParam
- * @property {ServiceabilityPlatformModel.CourierAccount} body
+ * @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
  */
 /**
  * @typedef CreatePackageMaterialParam
@@ -114,7 +114,7 @@ export = ServiceabilityPlatformValidator;
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
  * @property {string} [channelId] - Zones filtered by an application
  * @property {string} [q] - Search with name as a free text
- * @property {string} [country] - ISO2 code of the country
+ * @property {string} [countryIsoCode] - ISO2 code of the country
  * @property {string} [state] - State name
  * @property {string} [city] - City name
  * @property {string} [pincode] - Pincode value to search zones
@@ -233,7 +233,7 @@ type BulkTatParam = {
     body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
 };
 type CreateCourierPartnerAccountParam = {
-    body: ServiceabilityPlatformModel.CourierAccount;
+    body: ServiceabilityPlatformModel.CourierAccountRequestBody;
 };
 type CreatePackageMaterialParam = {
     body: ServiceabilityPlatformModel.PackageMaterial;
@@ -461,7 +461,7 @@ type GetZonesParam = {
     /**
      * - ISO2 code of the country
      */
-    country?: string;
+    countryIsoCode?: string;
     /**
      * - State name
      */

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -18,7 +18,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef CreateCourierPartnerAccountParam
- * @property {ServiceabilityPlatformModel.CourierAccount} body
+ * @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
  */
 
 /**
@@ -136,7 +136,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
  * @property {string} [channelId] - Zones filtered by an application
  * @property {string} [q] - Search with name as a free text
- * @property {string} [country] - ISO2 code of the country
+ * @property {string} [countryIsoCode] - ISO2 code of the country
  * @property {string} [state] - State name
  * @property {string} [city] - City name
  * @property {string} [pincode] - Pincode value to search zones
@@ -204,7 +204,7 @@ class ServiceabilityPlatformValidator {
   /** @returns {CreateCourierPartnerAccountParam} */
   static createCourierPartnerAccount() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CourierAccount().required(),
+      body: ServiceabilityPlatformModel.CourierAccountRequestBody().required(),
     }).required();
   }
 
@@ -356,7 +356,7 @@ class ServiceabilityPlatformValidator {
       isActive: Joi.boolean(),
       channelId: Joi.string().allow(""),
       q: Joi.string().allow(""),
-      country: Joi.string().allow(""),
+      countryIsoCode: Joi.string().allow(""),
       state: Joi.string().allow(""),
       city: Joi.string().allow(""),
       pincode: Joi.string().allow(""),

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

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

package/sdk/platform/Share/SharePlatformModel.js

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

package/sdk/platform/Theme/ThemePlatformModel.d.ts

@@ -114,7 +114,7 @@ export = ThemePlatformModel;
  */
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -532,9 +532,9 @@ export = ThemePlatformModel;
  */
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 /**
@@ -549,6 +549,7 @@ export = ThemePlatformModel;
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -779,6 +780,9 @@ type SEObreadcrumb = {
 /** @returns {Action} */
 declare function Action(): Action;
 type Action = {
+    /**
+     * - Type of action to be taken e.g, page.
+     */
     type?: string;
     page?: ActionPage;
     popup?: ActionPage;
@@ -1593,8 +1597,17 @@ type CompanyPrivateTheme = {
 /** @returns {ActionPage} */
 declare function ActionPage(): ActionPage;
 type ActionPage = {
+    /**
+     * - Parameters that should be considered in path.
+     */
     params?: any;
+    /**
+     * - Query parameter if any to be added to the action.
+     */
     query?: any;
+    /**
+     * - The URL for the action.
+     */
     url?: string;
     type: PageType;
 };
@@ -1604,4 +1617,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -131,7 +131,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -612,9 +612,9 @@ const Joi = require("joi");
 
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 
@@ -630,6 +630,7 @@ const Joi = require("joi");
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -1480,6 +1481,8 @@ class ThemePlatformModel {
 
       "collections",
 
+      "custom",
+
       "contact-us",
 
       "external",

package/sdk/platform/User/UserPlatformModel.d.ts

@@ -223,7 +223,6 @@ export = UserPlatformModel;
 /**
  * @typedef CreateUserSessionRequestSchema
  * @property {string} [domain]
- * @property {number} [max_age]
  * @property {string} [user_id]
  */
 /**
@@ -458,18 +457,18 @@ export = UserPlatformModel;
  */
 /**
  * @typedef PhoneNumber
- * @property {string} [phone] - Phone number
- * @property {number} [country_code] - Country code
- * @property {boolean} [active] - Is the phone number active
- * @property {boolean} [primary] - Is it a primary phone number
- * @property {boolean} [verified] - Is the phone number verified
+ * @property {string} [phone] - Phone number of the user.
+ * @property {number} [country_code] - Country code for mobile number.
+ * @property {boolean} [active] - Is the phone number active.
+ * @property {boolean} [primary] - Is it a primary phone number.
+ * @property {boolean} [verified] - Is the phone number verified.
  */
 /**
  * @typedef Email
- * @property {string} [email] - Email address
- * @property {boolean} [active] - Is the email active
- * @property {boolean} [primary] - Is it a primary email
- * @property {boolean} [verified] - Is the email verified
+ * @property {string} [email] - Email address.
+ * @property {boolean} [active] - Is the email active.
+ * @property {boolean} [primary] - Is it a primary email.
+ * @property {boolean} [verified] - Is the email verified.
  */
 declare class UserPlatformModel {
 }
@@ -850,7 +849,6 @@ type CreateUserResponseSchema = {
 declare function CreateUserSessionRequestSchema(): CreateUserSessionRequestSchema;
 type CreateUserSessionRequestSchema = {
     domain?: string;
-    max_age?: number;
     user_id?: string;
 };
 /** @returns {CreateUserSessionResponseSchema} */
@@ -1133,23 +1131,23 @@ type UserSearchSchema = {
 declare function PhoneNumber(): PhoneNumber;
 type PhoneNumber = {
     /**
-     * - Phone number
+     * - Phone number of the user.
      */
     phone?: string;
     /**
-     * - Country code
+     * - Country code for mobile number.
      */
     country_code?: number;
     /**
-     * - Is the phone number active
+     * - Is the phone number active.
      */
     active?: boolean;
     /**
-     * - Is it a primary phone number
+     * - Is it a primary phone number.
      */
     primary?: boolean;
     /**
-     * - Is the phone number verified
+     * - Is the phone number verified.
      */
     verified?: boolean;
 };
@@ -1157,19 +1155,19 @@ type PhoneNumber = {
 declare function Email(): Email;
 type Email = {
     /**
-     * - Email address
+     * - Email address.
      */
     email?: string;
     /**
-     * - Is the email active
+     * - Is the email active.
      */
     active?: boolean;
     /**
-     * - Is it a primary email
+     * - Is it a primary email.
      */
     primary?: boolean;
     /**
-     * - Is the email verified
+     * - Is the email verified.
      */
     verified?: boolean;
 };

package/sdk/platform/User/UserPlatformModel.js

@@ -253,7 +253,6 @@ const Joi = require("joi");
 /**
  * @typedef CreateUserSessionRequestSchema
  * @property {string} [domain]
- * @property {number} [max_age]
  * @property {string} [user_id]
  */
 
@@ -517,19 +516,19 @@ const Joi = require("joi");
 
 /**
  * @typedef PhoneNumber
- * @property {string} [phone] - Phone number
- * @property {number} [country_code] - Country code
- * @property {boolean} [active] - Is the phone number active
- * @property {boolean} [primary] - Is it a primary phone number
- * @property {boolean} [verified] - Is the phone number verified
+ * @property {string} [phone] - Phone number of the user.
+ * @property {number} [country_code] - Country code for mobile number.
+ * @property {boolean} [active] - Is the phone number active.
+ * @property {boolean} [primary] - Is it a primary phone number.
+ * @property {boolean} [verified] - Is the phone number verified.
  */
 
 /**
  * @typedef Email
- * @property {string} [email] - Email address
- * @property {boolean} [active] - Is the email active
- * @property {boolean} [primary] - Is it a primary email
- * @property {boolean} [verified] - Is the email verified
+ * @property {string} [email] - Email address.
+ * @property {boolean} [active] - Is the email active.
+ * @property {boolean} [primary] - Is it a primary email.
+ * @property {boolean} [verified] - Is the email verified.
  */
 
 class UserPlatformModel {
@@ -846,7 +845,6 @@ class UserPlatformModel {
   static CreateUserSessionRequestSchema() {
     return Joi.object({
       domain: Joi.string().allow(""),
-      max_age: Joi.number(),
       user_id: Joi.string().allow(""),
     });
   }