@gofynd/fdk-client-javascript 3.13.0 → 3.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
234
234
  The above code will log the curl command in the console
235
235
 
236
236
  ```bash
237
- curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: v3.13.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
237
+ curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.15.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
238
238
  Active Theme: Emerge
239
239
  ```
240
240
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gofynd/fdk-client-javascript",
3
- "version": "v3.13.0",
3
+ "version": "3.15.0",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -27,8 +27,8 @@ export namespace AVAILABLE_PAGE_TYPE {
27
27
  const PROFILE_ORDER_SHIPMENT: string;
28
28
  const PROFILE_BASIC: string;
29
29
  const PROFILE_COMPANY: string;
30
- const PROFILE_EMAILS: string;
31
- const PROFILE_PHONES: string;
30
+ const PROFILE_EMAIL: string;
31
+ const PROFILE_PHONE: string;
32
32
  const RATE_US: string;
33
33
  const REFER_EARN: string;
34
34
  const SETTINGS: string;
@@ -48,6 +48,7 @@ export namespace AVAILABLE_PAGE_TYPE {
48
48
  const ORDER_STATUS: string;
49
49
  const LOCATE_US: string;
50
50
  const SINGLE_PAGE_CHECKOUT: string;
51
+ const REQUEST_REATTEMPT: string;
51
52
  }
52
53
  export const NAVIGATORS: {
53
54
  "about-us": {
@@ -206,11 +207,11 @@ export const NAVIGATORS: {
206
207
  name: string;
207
208
  link: string;
208
209
  };
209
- "profile-emails": {
210
+ "profile-email": {
210
211
  name: string;
211
212
  link: string;
212
213
  };
213
- "profile-phones": {
214
+ "profile-phone": {
214
215
  name: string;
215
216
  link: string;
216
217
  };
@@ -306,4 +307,12 @@ export const NAVIGATORS: {
306
307
  name: string;
307
308
  link: string;
308
309
  };
310
+ "request-reattempt": {
311
+ name: string;
312
+ link: string;
313
+ params: {
314
+ key: string;
315
+ required: boolean;
316
+ }[];
317
+ };
309
318
  };
@@ -27,8 +27,8 @@ const AVAILABLE_PAGE_TYPE = {
27
27
  PROFILE_ORDER_SHIPMENT: "profile-order-shipment",
28
28
  PROFILE_BASIC: "profile-basic",
29
29
  PROFILE_COMPANY: "profile-company",
30
- PROFILE_EMAILS: "profile-emails",
31
- PROFILE_PHONES: "profile-phones",
30
+ PROFILE_EMAIL: "profile-email",
31
+ PROFILE_PHONE: "profile-phone",
32
32
  RATE_US: "rate-us",
33
33
  REFER_EARN: "refer-earn",
34
34
  SETTINGS: "settings",
@@ -48,6 +48,7 @@ const AVAILABLE_PAGE_TYPE = {
48
48
  ORDER_STATUS: "order-status",
49
49
  LOCATE_US: "locate-us",
50
50
  SINGLE_PAGE_CHECKOUT: "single-page-checkout",
51
+ REQUEST_REATTEMPT: "request-reattempt",
51
52
  };
52
53
 
53
54
  Object.freeze(AVAILABLE_PAGE_TYPE);
@@ -231,12 +232,12 @@ const NAVIGATORS = {
231
232
  name: "Profile Company",
232
233
  link: "/profile/company",
233
234
  },
234
- "profile-emails": {
235
- name: "Profile Emails",
235
+ "profile-email": {
236
+ name: "Profile Email",
236
237
  link: "/profile/email",
237
238
  },
238
- "profile-phones": {
239
- name: "Profile Phones",
239
+ "profile-phone": {
240
+ name: "Profile Phone",
240
241
  link: "/profile/phone",
241
242
  },
242
243
  "rate-us": {
@@ -339,6 +340,16 @@ const NAVIGATORS = {
339
340
  name: "Single Page Checkout",
340
341
  link: "/cart/checkout",
341
342
  },
343
+ "request-reattempt": {
344
+ name: "Request Reattempt",
345
+ link: "/reattempt/shipment/:shipmentId",
346
+ params: [
347
+ {
348
+ key: "shipmentId",
349
+ required: true,
350
+ },
351
+ ],
352
+ },
342
353
  };
343
354
 
344
355
  module.exports = {
@@ -654,8 +654,8 @@ export = ThemePartnerModel;
654
654
  * | "profile-order-shipment"
655
655
  * | "profile-basic"
656
656
  * | "profile-company"
657
- * | "profile-emails"
658
- * | "profile-phones"
657
+ * | "profile-email"
658
+ * | "profile-phone"
659
659
  * | "rate-us"
660
660
  * | "refer-earn"
661
661
  * | "settings"
@@ -674,7 +674,8 @@ export = ThemePartnerModel;
674
674
  * | "return-policy"
675
675
  * | "order-status"
676
676
  * | "locate-us"
677
- * | "single-page-checkout"} PageType
677
+ * | "single-page-checkout"
678
+ * | "request-reattempt"} PageType
678
679
  */
679
680
  declare class ThemePartnerModel {
680
681
  }
@@ -1896,4 +1897,4 @@ type ActionPage = {
1896
1897
  * @returns {PageType}
1897
1898
  */
1898
1899
  declare function PageType(): PageType;
1899
- 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" | "locate-us" | "single-page-checkout";
1900
+ 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-email" | "profile-phone" | "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" | "locate-us" | "single-page-checkout" | "request-reattempt";
@@ -746,8 +746,8 @@ const Joi = require("joi");
746
746
  * | "profile-order-shipment"
747
747
  * | "profile-basic"
748
748
  * | "profile-company"
749
- * | "profile-emails"
750
- * | "profile-phones"
749
+ * | "profile-email"
750
+ * | "profile-phone"
751
751
  * | "rate-us"
752
752
  * | "refer-earn"
753
753
  * | "settings"
@@ -766,7 +766,8 @@ const Joi = require("joi");
766
766
  * | "return-policy"
767
767
  * | "order-status"
768
768
  * | "locate-us"
769
- * | "single-page-checkout"} PageType
769
+ * | "single-page-checkout"
770
+ * | "request-reattempt"} PageType
770
771
  */
771
772
 
772
773
  class ThemePartnerModel {
@@ -1737,9 +1738,9 @@ class ThemePartnerModel {
1737
1738
 
1738
1739
  "profile-company",
1739
1740
 
1740
- "profile-emails",
1741
+ "profile-email",
1741
1742
 
1742
- "profile-phones",
1743
+ "profile-phone",
1743
1744
 
1744
1745
  "rate-us",
1745
1746
 
@@ -1777,7 +1778,9 @@ class ThemePartnerModel {
1777
1778
 
1778
1779
  "locate-us",
1779
1780
 
1780
- "single-page-checkout"
1781
+ "single-page-checkout",
1782
+
1783
+ "request-reattempt"
1781
1784
  );
1782
1785
  }
1783
1786
  }
@@ -434,7 +434,7 @@ declare class Cart {
434
434
  * @returns {Promise<CartPlatformModel.AddCartDetailResult>} - Success response
435
435
  * @name platformAddItems
436
436
  * @summary: Add items to cart
437
- * @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
437
+ * @description: Adds product items to a customer's shopping cart. If the customer does not have an existing cart, a new one is created automatically. - The `new_cart` flag forces creation of a new cart even if one already exists. - The `default_cart` flag determines whether the item is added to the user's default storefront-visible cart. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
438
438
  */
439
439
  platformAddItems({ body, xOrderingSource, i, b, buyNow, orderType, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResult>;
440
440
  /**
@@ -3558,7 +3558,7 @@ class Cart {
3558
3558
  * @returns {Promise<CartPlatformModel.AddCartDetailResult>} - Success response
3559
3559
  * @name platformAddItems
3560
3560
  * @summary: Add items to cart
3561
- * @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
3561
+ * @description: Adds product items to a customer's shopping cart. If the customer does not have an existing cart, a new one is created automatically. - The `new_cart` flag forces creation of a new cart even if one already exists. - The `default_cart` flag determines whether the item is added to the user's default storefront-visible cart. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
3562
3562
  */
3563
3563
  async platformAddItems(
3564
3564
  { body, xOrderingSource, i, b, buyNow, orderType, id, requestHeaders } = {
@@ -1884,10 +1884,15 @@ export = CartPlatformModel;
1884
1884
  */
1885
1885
  /**
1886
1886
  * @typedef PlatformAddCartDetails
1887
- * @property {string} [user_id] - The user id of user, for which we need to add
1888
- * item into cart
1889
- * @property {boolean} [new_cart] - Field to create to new cart whille user adds
1890
- * item to cart
1887
+ * @property {string} [user_id] - The unique identifier of the user for whom
1888
+ * items are being added to the cart
1889
+ * @property {boolean} [new_cart] - Indicates whether a new cart should be
1890
+ * created. If `true`, a new cart is created even if one already exists.
1891
+ * @property {boolean} [default_cart] - Determines whether the item is added to
1892
+ * the user's default visible cart on the storefront. If `true`, the item is
1893
+ * added to the user's default cart that is accessible via the storefront. If
1894
+ * `false`, an existing active cart is fetched if available; otherwise, a new
1895
+ * hidden cart is created. Defaults to `true`.
1891
1896
  * @property {AddProductCart[]} [items] - List of items detail which need to be
1892
1897
  * added to cart like item id, item size, and item quantity
1893
1898
  */
@@ -7278,15 +7283,23 @@ type UserCartMappingResult = {
7278
7283
  declare function PlatformAddCartDetails(): PlatformAddCartDetails;
7279
7284
  type PlatformAddCartDetails = {
7280
7285
  /**
7281
- * - The user id of user, for which we need to add
7282
- * item into cart
7286
+ * - The unique identifier of the user for whom
7287
+ * items are being added to the cart
7283
7288
  */
7284
7289
  user_id?: string;
7285
7290
  /**
7286
- * - Field to create to new cart whille user adds
7287
- * item to cart
7291
+ * - Indicates whether a new cart should be
7292
+ * created. If `true`, a new cart is created even if one already exists.
7288
7293
  */
7289
7294
  new_cart?: boolean;
7295
+ /**
7296
+ * - Determines whether the item is added to
7297
+ * the user's default visible cart on the storefront. If `true`, the item is
7298
+ * added to the user's default cart that is accessible via the storefront. If
7299
+ * `false`, an existing active cart is fetched if available; otherwise, a new
7300
+ * hidden cart is created. Defaults to `true`.
7301
+ */
7302
+ default_cart?: boolean;
7290
7303
  /**
7291
7304
  * - List of items detail which need to be
7292
7305
  * added to cart like item id, item size, and item quantity
@@ -2046,10 +2046,15 @@ const Joi = require("joi");
2046
2046
 
2047
2047
  /**
2048
2048
  * @typedef PlatformAddCartDetails
2049
- * @property {string} [user_id] - The user id of user, for which we need to add
2050
- * item into cart
2051
- * @property {boolean} [new_cart] - Field to create to new cart whille user adds
2052
- * item to cart
2049
+ * @property {string} [user_id] - The unique identifier of the user for whom
2050
+ * items are being added to the cart
2051
+ * @property {boolean} [new_cart] - Indicates whether a new cart should be
2052
+ * created. If `true`, a new cart is created even if one already exists.
2053
+ * @property {boolean} [default_cart] - Determines whether the item is added to
2054
+ * the user's default visible cart on the storefront. If `true`, the item is
2055
+ * added to the user's default cart that is accessible via the storefront. If
2056
+ * `false`, an existing active cart is fetched if available; otherwise, a new
2057
+ * hidden cart is created. Defaults to `true`.
2053
2058
  * @property {AddProductCart[]} [items] - List of items detail which need to be
2054
2059
  * added to cart like item id, item size, and item quantity
2055
2060
  */
@@ -4836,6 +4841,7 @@ class CartPlatformModel {
4836
4841
  return Joi.object({
4837
4842
  user_id: Joi.string().allow(""),
4838
4843
  new_cart: Joi.boolean(),
4844
+ default_cart: Joi.boolean(),
4839
4845
  items: Joi.array().items(CartPlatformModel.AddProductCart()),
4840
4846
  });
4841
4847
  }
@@ -4632,8 +4632,8 @@ export = CatalogPlatformModel;
4632
4632
  * | "profile-order-shipment"
4633
4633
  * | "profile-basic"
4634
4634
  * | "profile-company"
4635
- * | "profile-emails"
4636
- * | "profile-phones"
4635
+ * | "profile-email"
4636
+ * | "profile-phone"
4637
4637
  * | "rate-us"
4638
4638
  * | "refer-earn"
4639
4639
  * | "settings"
@@ -4652,7 +4652,8 @@ export = CatalogPlatformModel;
4652
4652
  * | "return-policy"
4653
4653
  * | "order-status"
4654
4654
  * | "locate-us"
4655
- * | "single-page-checkout"} PageType
4655
+ * | "single-page-checkout"
4656
+ * | "request-reattempt"} PageType
4656
4657
  */
4657
4658
  declare class CatalogPlatformModel {
4658
4659
  }
@@ -14549,4 +14550,4 @@ type HsTypeEnum = "HS" | "SAC";
14549
14550
  * @returns {PageType}
14550
14551
  */
14551
14552
  declare function PageType(): PageType;
14552
- 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" | "locate-us" | "single-page-checkout";
14553
+ 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-email" | "profile-phone" | "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" | "locate-us" | "single-page-checkout" | "request-reattempt";
@@ -5076,8 +5076,8 @@ const Joi = require("joi");
5076
5076
  * | "profile-order-shipment"
5077
5077
  * | "profile-basic"
5078
5078
  * | "profile-company"
5079
- * | "profile-emails"
5080
- * | "profile-phones"
5079
+ * | "profile-email"
5080
+ * | "profile-phone"
5081
5081
  * | "rate-us"
5082
5082
  * | "refer-earn"
5083
5083
  * | "settings"
@@ -5096,7 +5096,8 @@ const Joi = require("joi");
5096
5096
  * | "return-policy"
5097
5097
  * | "order-status"
5098
5098
  * | "locate-us"
5099
- * | "single-page-checkout"} PageType
5099
+ * | "single-page-checkout"
5100
+ * | "request-reattempt"} PageType
5100
5101
  */
5101
5102
 
5102
5103
  class CatalogPlatformModel {
@@ -6643,7 +6644,7 @@ class CatalogPlatformModel {
6643
6644
  departments: Joi.array().items(Joi.number()),
6644
6645
  description: Joi.string().allow(""),
6645
6646
  highlights: Joi.array().items(Joi.string().allow("")),
6646
- hs_code: Joi.string().allow(""),
6647
+ hs_code: Joi.string().allow("").allow(null),
6647
6648
  hsn_code: Joi.string().allow(""),
6648
6649
  id: Joi.string().allow(""),
6649
6650
  image_nature: Joi.string().allow(""),
@@ -8402,7 +8403,7 @@ class CatalogPlatformModel {
8402
8403
  departments: Joi.array().items(Joi.number()),
8403
8404
  description: Joi.string().allow(""),
8404
8405
  highlights: Joi.array().items(Joi.string().allow("")),
8405
- hs_code: Joi.string().allow(""),
8406
+ hs_code: Joi.string().allow("").allow(null),
8406
8407
  hsn_code: Joi.string().allow(""),
8407
8408
  id: Joi.string().allow(""),
8408
8409
  image_nature: Joi.string().allow(""),
@@ -8562,7 +8563,7 @@ class CatalogPlatformModel {
8562
8563
  variant_group: Joi.object().pattern(/\S/, Joi.any()),
8563
8564
  variant_media: Joi.object().pattern(/\S/, Joi.any()),
8564
8565
  variants: Joi.object().pattern(/\S/, Joi.any()),
8565
- hs_code: Joi.string().allow(""),
8566
+ hs_code: Joi.string().allow("").allow(null),
8566
8567
  bundle_details: Joi.array()
8567
8568
  .items(CatalogPlatformModel.BundleDetails())
8568
8569
  .allow(null, ""),
@@ -8609,7 +8610,7 @@ class CatalogPlatformModel {
8609
8610
  slug: Joi.string().allow("").required(),
8610
8611
  tags: Joi.array().items(Joi.string().allow("")),
8611
8612
  tax_identifier: CatalogPlatformModel.TaxIdentifierV3().required(),
8612
- hs_code: Joi.string().allow(""),
8613
+ hs_code: Joi.string().allow("").allow(null),
8613
8614
  teaser_tag: CatalogPlatformModel.TeaserTag(),
8614
8615
  template_tag: Joi.string().allow("").required(),
8615
8616
  trader: Joi.array().items(CatalogPlatformModel.Trader()).required(),
@@ -8645,7 +8646,7 @@ class CatalogPlatformModel {
8645
8646
  sizes: Joi.array().items(CatalogPlatformModel.ProductSizePatch()),
8646
8647
  tags: Joi.array().items(Joi.string().allow("")),
8647
8648
  tax_identifier: CatalogPlatformModel.TaxIdentifierV3(),
8648
- hs_code: Joi.string().allow(""),
8649
+ hs_code: Joi.string().allow("").allow(null),
8649
8650
  teaser_tag: CatalogPlatformModel.TeaserTag(),
8650
8651
  template_tag: Joi.string().allow(""),
8651
8652
  trader: Joi.array().items(CatalogPlatformModel.Trader()),
@@ -9140,7 +9141,7 @@ class CatalogPlatformModel {
9140
9141
  departments: Joi.array().items(Joi.number()),
9141
9142
  description: Joi.string().allow(""),
9142
9143
  highlights: Joi.array().items(Joi.string().allow("")),
9143
- hs_code: Joi.string().allow(""),
9144
+ hs_code: Joi.string().allow("").allow(null),
9144
9145
  hsn_code: Joi.string().allow(""),
9145
9146
  id: Joi.string().allow(""),
9146
9147
  image_nature: Joi.string().allow(""),
@@ -9343,7 +9344,7 @@ class CatalogPlatformModel {
9343
9344
  custom_order: Joi.object().pattern(/\S/, Joi.any()),
9344
9345
  description: Joi.object().pattern(/\S/, Joi.any()),
9345
9346
  highlights: Joi.object().pattern(/\S/, Joi.any()),
9346
- hs_code: Joi.object().pattern(/\S/, Joi.any()),
9347
+ hs_code: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
9347
9348
  hsn_code: Joi.object().pattern(/\S/, Joi.any()),
9348
9349
  is_active: Joi.object().pattern(/\S/, Joi.any()),
9349
9350
  is_dependent: Joi.object().pattern(/\S/, Joi.any()),
@@ -10538,9 +10539,9 @@ class CatalogPlatformModel {
10538
10539
 
10539
10540
  "profile-company",
10540
10541
 
10541
- "profile-emails",
10542
+ "profile-email",
10542
10543
 
10543
- "profile-phones",
10544
+ "profile-phone",
10544
10545
 
10545
10546
  "rate-us",
10546
10547
 
@@ -10578,7 +10579,9 @@ class CatalogPlatformModel {
10578
10579
 
10579
10580
  "locate-us",
10580
10581
 
10581
- "single-page-checkout"
10582
+ "single-page-checkout",
10583
+
10584
+ "request-reattempt"
10582
10585
  );
10583
10586
  }
10584
10587
  }
@@ -1533,8 +1533,8 @@ export = ContentPlatformModel;
1533
1533
  * | "profile-order-shipment"
1534
1534
  * | "profile-basic"
1535
1535
  * | "profile-company"
1536
- * | "profile-emails"
1537
- * | "profile-phones"
1536
+ * | "profile-email"
1537
+ * | "profile-phone"
1538
1538
  * | "rate-us"
1539
1539
  * | "refer-earn"
1540
1540
  * | "settings"
@@ -1553,7 +1553,8 @@ export = ContentPlatformModel;
1553
1553
  * | "return-policy"
1554
1554
  * | "order-status"
1555
1555
  * | "locate-us"
1556
- * | "single-page-checkout"} PageType
1556
+ * | "single-page-checkout"
1557
+ * | "request-reattempt"} PageType
1557
1558
  */
1558
1559
  declare class ContentPlatformModel {
1559
1560
  }
@@ -4410,4 +4411,4 @@ type GenerationEntityType = "title" | "description";
4410
4411
  * @returns {PageType}
4411
4412
  */
4412
4413
  declare function PageType(): PageType;
4413
- 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" | "locate-us" | "single-page-checkout";
4414
+ 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-email" | "profile-phone" | "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" | "locate-us" | "single-page-checkout" | "request-reattempt";
@@ -1728,8 +1728,8 @@ const Joi = require("joi");
1728
1728
  * | "profile-order-shipment"
1729
1729
  * | "profile-basic"
1730
1730
  * | "profile-company"
1731
- * | "profile-emails"
1732
- * | "profile-phones"
1731
+ * | "profile-email"
1732
+ * | "profile-phone"
1733
1733
  * | "rate-us"
1734
1734
  * | "refer-earn"
1735
1735
  * | "settings"
@@ -1748,7 +1748,8 @@ const Joi = require("joi");
1748
1748
  * | "return-policy"
1749
1749
  * | "order-status"
1750
1750
  * | "locate-us"
1751
- * | "single-page-checkout"} PageType
1751
+ * | "single-page-checkout"
1752
+ * | "request-reattempt"} PageType
1752
1753
  */
1753
1754
 
1754
1755
  class ContentPlatformModel {
@@ -3860,9 +3861,9 @@ class ContentPlatformModel {
3860
3861
 
3861
3862
  "profile-company",
3862
3863
 
3863
- "profile-emails",
3864
+ "profile-email",
3864
3865
 
3865
- "profile-phones",
3866
+ "profile-phone",
3866
3867
 
3867
3868
  "rate-us",
3868
3869
 
@@ -3900,7 +3901,9 @@ class ContentPlatformModel {
3900
3901
 
3901
3902
  "locate-us",
3902
3903
 
3903
- "single-page-checkout"
3904
+ "single-page-checkout",
3905
+
3906
+ "request-reattempt"
3904
3907
  );
3905
3908
  }
3906
3909
  }
@@ -2986,6 +2986,9 @@ export = OrderPlatformModel;
2986
2986
  * placed. Required when the order is placed from one company but fulfilled by another.
2987
2987
  * @property {boolean} [is_draft] - Indicates whether the order is a draft.
2988
2988
  * Draft orders will be moved to upcoming state instead of placed status.
2989
+ * @property {Object} [meta] - Metadata related to the order may include
2990
+ * additional, dynamic information that provides further context about the
2991
+ * order. This information can also be viewed on the Order or Shipment Details page.
2989
2992
  */
2990
2993
  /**
2991
2994
  * @typedef Page
@@ -11569,6 +11572,12 @@ type CreateOrderRequestSchema = {
11569
11572
  * Draft orders will be moved to upcoming state instead of placed status.
11570
11573
  */
11571
11574
  is_draft?: boolean;
11575
+ /**
11576
+ * - Metadata related to the order may include
11577
+ * additional, dynamic information that provides further context about the
11578
+ * order. This information can also be viewed on the Order or Shipment Details page.
11579
+ */
11580
+ meta?: any;
11572
11581
  };
11573
11582
  /** @returns {Page} */
11574
11583
  declare function Page(): Page;
@@ -3254,6 +3254,9 @@ const Joi = require("joi");
3254
3254
  * placed. Required when the order is placed from one company but fulfilled by another.
3255
3255
  * @property {boolean} [is_draft] - Indicates whether the order is a draft.
3256
3256
  * Draft orders will be moved to upcoming state instead of placed status.
3257
+ * @property {Object} [meta] - Metadata related to the order may include
3258
+ * additional, dynamic information that provides further context about the
3259
+ * order. This information can also be viewed on the Order or Shipment Details page.
3257
3260
  */
3258
3261
 
3259
3262
  /**
@@ -8932,6 +8935,7 @@ class OrderPlatformModel {
8932
8935
  b2b_gstin_number: Joi.string().allow(""),
8933
8936
  channel_company_id: Joi.string().allow(""),
8934
8937
  is_draft: Joi.boolean(),
8938
+ meta: Joi.object().pattern(/\S/, Joi.any()),
8935
8939
  });
8936
8940
  }
8937
8941
 
@@ -582,8 +582,8 @@ export = ThemePlatformModel;
582
582
  * | "profile-order-shipment"
583
583
  * | "profile-basic"
584
584
  * | "profile-company"
585
- * | "profile-emails"
586
- * | "profile-phones"
585
+ * | "profile-email"
586
+ * | "profile-phone"
587
587
  * | "rate-us"
588
588
  * | "refer-earn"
589
589
  * | "settings"
@@ -602,7 +602,8 @@ export = ThemePlatformModel;
602
602
  * | "return-policy"
603
603
  * | "order-status"
604
604
  * | "locate-us"
605
- * | "single-page-checkout"} PageType
605
+ * | "single-page-checkout"
606
+ * | "request-reattempt"} PageType
606
607
  */
607
608
  declare class ThemePlatformModel {
608
609
  }
@@ -1665,4 +1666,4 @@ type ActionPage = {
1665
1666
  * @returns {PageType}
1666
1667
  */
1667
1668
  declare function PageType(): PageType;
1668
- 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" | "locate-us" | "single-page-checkout";
1669
+ 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-email" | "profile-phone" | "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" | "locate-us" | "single-page-checkout" | "request-reattempt";
@@ -665,8 +665,8 @@ const Joi = require("joi");
665
665
  * | "profile-order-shipment"
666
666
  * | "profile-basic"
667
667
  * | "profile-company"
668
- * | "profile-emails"
669
- * | "profile-phones"
668
+ * | "profile-email"
669
+ * | "profile-phone"
670
670
  * | "rate-us"
671
671
  * | "refer-earn"
672
672
  * | "settings"
@@ -685,7 +685,8 @@ const Joi = require("joi");
685
685
  * | "return-policy"
686
686
  * | "order-status"
687
687
  * | "locate-us"
688
- * | "single-page-checkout"} PageType
688
+ * | "single-page-checkout"
689
+ * | "request-reattempt"} PageType
689
690
  */
690
691
 
691
692
  class ThemePlatformModel {
@@ -1555,9 +1556,9 @@ class ThemePlatformModel {
1555
1556
 
1556
1557
  "profile-company",
1557
1558
 
1558
- "profile-emails",
1559
+ "profile-email",
1559
1560
 
1560
- "profile-phones",
1561
+ "profile-phone",
1561
1562
 
1562
1563
  "rate-us",
1563
1564
 
@@ -1595,7 +1596,9 @@ class ThemePlatformModel {
1595
1596
 
1596
1597
  "locate-us",
1597
1598
 
1598
- "single-page-checkout"
1599
+ "single-page-checkout",
1600
+
1601
+ "request-reattempt"
1599
1602
  );
1600
1603
  }
1601
1604
  }
@@ -259,12 +259,13 @@ declare class User {
259
259
  *
260
260
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
261
261
  * @param {import("../PlatformAPIClient").Options} - Options
262
- * @returns {Promise<Object>} - Success response
262
+ * @returns {Promise<UserPlatformModel.UserAttributeDefinitionList>} -
263
+ * Success response
263
264
  * @name getUserAttributeDefinitions
264
265
  * @summary: Get User Attribute Definitions
265
266
  * @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
266
267
  */
267
- getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<any>;
268
+ getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionList>;
268
269
  /**
269
270
  * @param {UserPlatformApplicationValidator.GetUserAttributesForUserParam} arg
270
271
  * - Arg object
@@ -1836,7 +1836,8 @@ class User {
1836
1836
  *
1837
1837
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1838
1838
  * @param {import("../PlatformAPIClient").Options} - Options
1839
- * @returns {Promise<Object>} - Success response
1839
+ * @returns {Promise<UserPlatformModel.UserAttributeDefinitionList>} -
1840
+ * Success response
1840
1841
  * @name getUserAttributeDefinitions
1841
1842
  * @summary: Get User Attribute Definitions
1842
1843
  * @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
@@ -1934,7 +1935,9 @@ class User {
1934
1935
  responseData = response[0];
1935
1936
  }
1936
1937
 
1937
- const { error: res_error } = Joi.any().validate(responseData, {
1938
+ const {
1939
+ error: res_error,
1940
+ } = UserPlatformModel.UserAttributeDefinitionList().validate(responseData, {
1938
1941
  abortEarly: false,
1939
1942
  allowUnknown: true,
1940
1943
  });
@@ -428,7 +428,6 @@ class UserPlatformApplicationValidator {
428
428
  pinOrder: Joi.number(),
429
429
  isLocked: Joi.boolean(),
430
430
  name: Joi.string().allow(""),
431
-
432
431
  pageSize: Joi.number(),
433
432
  pageNo: Joi.number(),
434
433
  }).required();
@@ -3,6 +3,12 @@ export = UserPlatformModel;
3
3
  * @typedef SuccessMessage
4
4
  * @property {string} [success]
5
5
  */
6
+ /**
7
+ * @typedef UserAttributeDefinitionList
8
+ * @property {UserAttributeDefinition[]} [items] - Array of user attribute
9
+ * definition objects.
10
+ * @property {PaginationSchema} [page]
11
+ */
6
12
  /**
7
13
  * @typedef UserAttributeDefinition
8
14
  * @property {string} [_id] - The unique identifier for the attribute definition.
@@ -691,13 +697,23 @@ export = UserPlatformModel;
691
697
  declare class UserPlatformModel {
692
698
  }
693
699
  declare namespace UserPlatformModel {
694
- export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, AttributeMaskingProperties, AttributeRegistrationProperties, UserAttributeDefinitionValidation, BulkUserAttribute, UserAttribute, CreateBulkUserAttribute, BulkUserAttributeRequestBody, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, DeleteBulkUserAttribute, UserAttributeFilter, UserAttributeFilterQuery, UserAttributeFilterRequestConditions, UserAttributeFiltered, UserAttributeFilteredList, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email, UserConsent, PrivacyPolicyConsentSchema };
700
+ export { SuccessMessage, UserAttributeDefinitionList, UserAttributeDefinition, UserAttributeDefinitionDetails, AttributeMaskingProperties, AttributeRegistrationProperties, UserAttributeDefinitionValidation, BulkUserAttribute, UserAttribute, CreateBulkUserAttribute, BulkUserAttributeRequestBody, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, DeleteBulkUserAttribute, UserAttributeFilter, UserAttributeFilterQuery, UserAttributeFilterRequestConditions, UserAttributeFiltered, UserAttributeFilteredList, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email, UserConsent, PrivacyPolicyConsentSchema };
695
701
  }
696
702
  /** @returns {SuccessMessage} */
697
703
  declare function SuccessMessage(): SuccessMessage;
698
704
  type SuccessMessage = {
699
705
  success?: string;
700
706
  };
707
+ /** @returns {UserAttributeDefinitionList} */
708
+ declare function UserAttributeDefinitionList(): UserAttributeDefinitionList;
709
+ type UserAttributeDefinitionList = {
710
+ /**
711
+ * - Array of user attribute
712
+ * definition objects.
713
+ */
714
+ items?: UserAttributeDefinition[];
715
+ page?: PaginationSchema;
716
+ };
701
717
  /** @returns {UserAttributeDefinition} */
702
718
  declare function UserAttributeDefinition(): UserAttributeDefinition;
703
719
  type UserAttributeDefinition = {
@@ -5,6 +5,13 @@ const Joi = require("joi");
5
5
  * @property {string} [success]
6
6
  */
7
7
 
8
+ /**
9
+ * @typedef UserAttributeDefinitionList
10
+ * @property {UserAttributeDefinition[]} [items] - Array of user attribute
11
+ * definition objects.
12
+ * @property {PaginationSchema} [page]
13
+ */
14
+
8
15
  /**
9
16
  * @typedef UserAttributeDefinition
10
17
  * @property {string} [_id] - The unique identifier for the attribute definition.
@@ -780,6 +787,14 @@ class UserPlatformModel {
780
787
  });
781
788
  }
782
789
 
790
+ /** @returns {UserAttributeDefinitionList} */
791
+ static UserAttributeDefinitionList() {
792
+ return Joi.object({
793
+ items: Joi.array().items(UserPlatformModel.UserAttributeDefinition()),
794
+ page: UserPlatformModel.PaginationSchema(),
795
+ });
796
+ }
797
+
783
798
  /** @returns {UserAttributeDefinition} */
784
799
  static UserAttributeDefinition() {
785
800
  return Joi.object({