@gofynd/fdk-client-javascript 1.4.11 → 1.4.12-beta.1

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.
Files changed (43) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +8 -19
  4. package/sdk/application/Cart/CartApplicationClient.js +8 -89
  5. package/sdk/application/Cart/CartApplicationModel.d.ts +1 -178
  6. package/sdk/application/Cart/CartApplicationModel.js +0 -92
  7. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -20
  8. package/sdk/application/Cart/CartApplicationValidator.js +0 -16
  9. package/sdk/application/Content/ContentApplicationModel.d.ts +3 -2
  10. package/sdk/application/Content/ContentApplicationModel.js +5 -2
  11. package/sdk/application/Logistic/LogisticApplicationModel.js +3 -3
  12. package/sdk/application/Order/OrderApplicationModel.js +1 -1
  13. package/sdk/application/Payment/PaymentApplicationModel.js +2 -2
  14. package/sdk/application/Theme/ThemeApplicationModel.d.ts +3 -2
  15. package/sdk/application/Theme/ThemeApplicationModel.js +5 -2
  16. package/sdk/common/Clickstream.js +46 -15
  17. package/sdk/common/Constant.d.ts +5 -0
  18. package/sdk/common/Constant.js +5 -0
  19. package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -2
  20. package/sdk/partner/Theme/ThemePartnerModel.js +5 -2
  21. package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
  22. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +8 -20
  23. package/sdk/platform/Cart/CartPlatformApplicationClient.js +8 -92
  24. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -15
  25. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +0 -14
  26. package/sdk/platform/Cart/CartPlatformModel.d.ts +1 -87
  27. package/sdk/platform/Cart/CartPlatformModel.js +0 -88
  28. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
  29. package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
  30. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8 -242
  31. package/sdk/platform/Catalog/CatalogPlatformModel.js +8 -171
  32. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
  33. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
  34. package/sdk/platform/Content/ContentPlatformModel.d.ts +3 -2
  35. package/sdk/platform/Content/ContentPlatformModel.js +5 -2
  36. package/sdk/platform/Finance/FinancePlatformModel.js +1 -1
  37. package/sdk/platform/Order/OrderPlatformModel.d.ts +30 -0
  38. package/sdk/platform/Order/OrderPlatformModel.js +23 -9
  39. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +38 -4
  40. package/sdk/platform/Payment/PaymentPlatformModel.js +17 -7
  41. package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
  42. package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
  43. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
@@ -26,14 +26,6 @@ export = CatalogPlatformValidator;
26
26
  * @typedef CreateBulkProductUploadJobParam
27
27
  * @property {CatalogPlatformModel.BulkJob} body
28
28
  */
29
- /**
30
- * @typedef CreateCategoriesParam
31
- * @property {CatalogPlatformModel.CategoryRequestBody} body
32
- */
33
- /**
34
- * @typedef CreateDepartmentsParam
35
- * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
36
- */
37
29
  /**
38
30
  * @typedef CreateInventoryExportParam
39
31
  * @property {CatalogPlatformModel.InventoryCreateRequest} body
@@ -125,6 +117,11 @@ export = CatalogPlatformValidator;
125
117
  * @property {string} [q] - Search using hsn code, description, reporting_hsn
126
118
  * @property {string} [type] - Search using type
127
119
  */
120
+ /**
121
+ * @typedef GetAttributeParam
122
+ * @property {string} attributeSlug - Slug of the attribute for which you want
123
+ * to view the details
124
+ */
128
125
  /**
129
126
  * @typedef GetCategoryDataParam
130
127
  * @property {string} uid - Category unique id
@@ -145,11 +142,6 @@ export = CatalogPlatformValidator;
145
142
  * @typedef GetDepartmentDataParam
146
143
  * @property {string} uid - A `uid` is a unique identifier of a department.
147
144
  */
148
- /**
149
- * @typedef GetGenderAttributeParam
150
- * @property {string} attributeSlug - Slug of the attribute for which you want
151
- * to view the genders
152
- */
153
145
  /**
154
146
  * @typedef GetHsnCodeParam
155
147
  * @property {string} id - Unique id
@@ -409,16 +401,6 @@ export = CatalogPlatformValidator;
409
401
  * @property {string} [itemType] - A `item_type` is the identifier of the type
410
402
  * of template required.
411
403
  */
412
- /**
413
- * @typedef UpdateCategoryParam
414
- * @property {string} uid - Category unique id
415
- * @property {CatalogPlatformModel.CategoryRequestBody} body
416
- */
417
- /**
418
- * @typedef UpdateDepartmentParam
419
- * @property {string} uid - A `uid` is a unique identifier of a department.
420
- * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
421
- */
422
404
  /**
423
405
  * @typedef UpdateHsnCodeParam
424
406
  * @property {string} id - Unique id
@@ -486,10 +468,6 @@ declare class CatalogPlatformValidator {
486
468
  static createBulkInventoryJob(): CreateBulkInventoryJobParam;
487
469
  /** @returns {CreateBulkProductUploadJobParam} */
488
470
  static createBulkProductUploadJob(): CreateBulkProductUploadJobParam;
489
- /** @returns {CreateCategoriesParam} */
490
- static createCategories(): CreateCategoriesParam;
491
- /** @returns {CreateDepartmentsParam} */
492
- static createDepartments(): CreateDepartmentsParam;
493
471
  /** @returns {CreateInventoryExportParam} */
494
472
  static createInventoryExport(): CreateInventoryExportParam;
495
473
  /** @returns {CreateInventoryExportJobParam} */
@@ -528,6 +506,8 @@ declare class CatalogPlatformValidator {
528
506
  static exportInventoryConfig(): ExportInventoryConfigParam;
529
507
  /** @returns {GetAllProductHsnCodesParam} */
530
508
  static getAllProductHsnCodes(): GetAllProductHsnCodesParam;
509
+ /** @returns {GetAttributeParam} */
510
+ static getAttribute(): GetAttributeParam;
531
511
  /** @returns {GetCategoryDataParam} */
532
512
  static getCategoryData(): GetCategoryDataParam;
533
513
  /** @returns {GetCompanyBrandDetailParam} */
@@ -538,8 +518,6 @@ declare class CatalogPlatformValidator {
538
518
  static getCompanyMetrics(): any;
539
519
  /** @returns {GetDepartmentDataParam} */
540
520
  static getDepartmentData(): GetDepartmentDataParam;
541
- /** @returns {GetGenderAttributeParam} */
542
- static getGenderAttribute(): GetGenderAttributeParam;
543
521
  /** @returns {GetHsnCodeParam} */
544
522
  static getHsnCode(): GetHsnCodeParam;
545
523
  /** @returns {GetInventoriesParam} */
@@ -608,10 +586,6 @@ declare class CatalogPlatformValidator {
608
586
  static listProductTemplateExportDetails(): any;
609
587
  /** @returns {ListTemplateBrandTypeValuesParam} */
610
588
  static listTemplateBrandTypeValues(): ListTemplateBrandTypeValuesParam;
611
- /** @returns {UpdateCategoryParam} */
612
- static updateCategory(): UpdateCategoryParam;
613
- /** @returns {UpdateDepartmentParam} */
614
- static updateDepartment(): UpdateDepartmentParam;
615
589
  /** @returns {UpdateHsnCodeParam} */
616
590
  static updateHsnCode(): UpdateHsnCodeParam;
617
591
  /** @returns {UpdateInventoriesParam} */
@@ -632,7 +606,7 @@ declare class CatalogPlatformValidator {
632
606
  static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
633
607
  }
634
608
  declare namespace CatalogPlatformValidator {
635
- export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateCategoriesParam, CreateDepartmentsParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetGenderAttributeParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateCategoryParam, UpdateDepartmentParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
609
+ export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
636
610
  }
637
611
  type AddInventoryParam = {
638
612
  /**
@@ -667,12 +641,6 @@ type CreateBulkInventoryJobParam = {
667
641
  type CreateBulkProductUploadJobParam = {
668
642
  body: CatalogPlatformModel.BulkJob;
669
643
  };
670
- type CreateCategoriesParam = {
671
- body: CatalogPlatformModel.CategoryRequestBody;
672
- };
673
- type CreateDepartmentsParam = {
674
- body: CatalogPlatformModel.DepartmentCreateUpdate;
675
- };
676
644
  type CreateInventoryExportParam = {
677
645
  body: CatalogPlatformModel.InventoryCreateRequest;
678
646
  };
@@ -802,6 +770,13 @@ type GetAllProductHsnCodesParam = {
802
770
  */
803
771
  type?: string;
804
772
  };
773
+ type GetAttributeParam = {
774
+ /**
775
+ * - Slug of the attribute for which you want
776
+ * to view the details
777
+ */
778
+ attributeSlug: string;
779
+ };
805
780
  type GetCategoryDataParam = {
806
781
  /**
807
782
  * - Category unique id
@@ -838,13 +813,6 @@ type GetDepartmentDataParam = {
838
813
  */
839
814
  uid: string;
840
815
  };
841
- type GetGenderAttributeParam = {
842
- /**
843
- * - Slug of the attribute for which you want
844
- * to view the genders
845
- */
846
- attributeSlug: string;
847
- };
848
816
  type GetHsnCodeParam = {
849
817
  /**
850
818
  * - Unique id
@@ -1409,20 +1377,6 @@ type ListTemplateBrandTypeValuesParam = {
1409
1377
  */
1410
1378
  itemType?: string;
1411
1379
  };
1412
- type UpdateCategoryParam = {
1413
- /**
1414
- * - Category unique id
1415
- */
1416
- uid: string;
1417
- body: CatalogPlatformModel.CategoryRequestBody;
1418
- };
1419
- type UpdateDepartmentParam = {
1420
- /**
1421
- * - A `uid` is a unique identifier of a department.
1422
- */
1423
- uid: string;
1424
- body: CatalogPlatformModel.DepartmentCreateUpdate;
1425
- };
1426
1380
  type UpdateHsnCodeParam = {
1427
1381
  /**
1428
1382
  * - Unique id
@@ -35,16 +35,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
35
35
  * @property {CatalogPlatformModel.BulkJob} body
36
36
  */
37
37
 
38
- /**
39
- * @typedef CreateCategoriesParam
40
- * @property {CatalogPlatformModel.CategoryRequestBody} body
41
- */
42
-
43
- /**
44
- * @typedef CreateDepartmentsParam
45
- * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
46
- */
47
-
48
38
  /**
49
39
  * @typedef CreateInventoryExportParam
50
40
  * @property {CatalogPlatformModel.InventoryCreateRequest} body
@@ -155,6 +145,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
155
145
  * @property {string} [type] - Search using type
156
146
  */
157
147
 
148
+ /**
149
+ * @typedef GetAttributeParam
150
+ * @property {string} attributeSlug - Slug of the attribute for which you want
151
+ * to view the details
152
+ */
153
+
158
154
  /**
159
155
  * @typedef GetCategoryDataParam
160
156
  * @property {string} uid - Category unique id
@@ -180,12 +176,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
180
176
  * @property {string} uid - A `uid` is a unique identifier of a department.
181
177
  */
182
178
 
183
- /**
184
- * @typedef GetGenderAttributeParam
185
- * @property {string} attributeSlug - Slug of the attribute for which you want
186
- * to view the genders
187
- */
188
-
189
179
  /**
190
180
  * @typedef GetHsnCodeParam
191
181
  * @property {string} id - Unique id
@@ -479,18 +469,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
479
469
  * of template required.
480
470
  */
481
471
 
482
- /**
483
- * @typedef UpdateCategoryParam
484
- * @property {string} uid - Category unique id
485
- * @property {CatalogPlatformModel.CategoryRequestBody} body
486
- */
487
-
488
- /**
489
- * @typedef UpdateDepartmentParam
490
- * @property {string} uid - A `uid` is a unique identifier of a department.
491
- * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
492
- */
493
-
494
472
  /**
495
473
  * @typedef UpdateHsnCodeParam
496
474
  * @property {string} id - Unique id
@@ -600,20 +578,6 @@ class CatalogPlatformValidator {
600
578
  }).required();
601
579
  }
602
580
 
603
- /** @returns {CreateCategoriesParam} */
604
- static createCategories() {
605
- return Joi.object({
606
- body: CatalogPlatformModel.CategoryRequestBody().required(),
607
- }).required();
608
- }
609
-
610
- /** @returns {CreateDepartmentsParam} */
611
- static createDepartments() {
612
- return Joi.object({
613
- body: CatalogPlatformModel.DepartmentCreateUpdate().required(),
614
- }).required();
615
- }
616
-
617
581
  /** @returns {CreateInventoryExportParam} */
618
582
  static createInventoryExport() {
619
583
  return Joi.object({
@@ -758,6 +722,13 @@ class CatalogPlatformValidator {
758
722
  }).required();
759
723
  }
760
724
 
725
+ /** @returns {GetAttributeParam} */
726
+ static getAttribute() {
727
+ return Joi.object({
728
+ attributeSlug: Joi.string().allow("").required(),
729
+ }).required();
730
+ }
731
+
761
732
  /** @returns {GetCategoryDataParam} */
762
733
  static getCategoryData() {
763
734
  return Joi.object({
@@ -793,13 +764,6 @@ class CatalogPlatformValidator {
793
764
  }).required();
794
765
  }
795
766
 
796
- /** @returns {GetGenderAttributeParam} */
797
- static getGenderAttribute() {
798
- return Joi.object({
799
- attributeSlug: Joi.string().allow("").required(),
800
- }).required();
801
- }
802
-
803
767
  /** @returns {GetHsnCodeParam} */
804
768
  static getHsnCode() {
805
769
  return Joi.object({
@@ -1111,22 +1075,6 @@ class CatalogPlatformValidator {
1111
1075
  }).required();
1112
1076
  }
1113
1077
 
1114
- /** @returns {UpdateCategoryParam} */
1115
- static updateCategory() {
1116
- return Joi.object({
1117
- uid: Joi.string().allow("").required(),
1118
- body: CatalogPlatformModel.CategoryRequestBody().required(),
1119
- }).required();
1120
- }
1121
-
1122
- /** @returns {UpdateDepartmentParam} */
1123
- static updateDepartment() {
1124
- return Joi.object({
1125
- uid: Joi.string().allow("").required(),
1126
- body: CatalogPlatformModel.DepartmentCreateUpdate().required(),
1127
- }).required();
1128
- }
1129
-
1130
1078
  /** @returns {UpdateHsnCodeParam} */
1131
1079
  static updateHsnCode() {
1132
1080
  return Joi.object({
@@ -1230,7 +1230,8 @@ export = ContentPlatformModel;
1230
1230
  * | "register"
1231
1231
  * | "shipping-policy"
1232
1232
  * | "return-policy"
1233
- * | "order-status"} PageType
1233
+ * | "order-status"
1234
+ * | "locate-us"} PageType
1234
1235
  */
1235
1236
  declare class ContentPlatformModel {
1236
1237
  }
@@ -2633,4 +2634,4 @@ type GenerationEntityType = "title" | "description";
2633
2634
  * @returns {PageType}
2634
2635
  */
2635
2636
  declare function PageType(): PageType;
2636
- 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";
2637
+ 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";
@@ -1387,7 +1387,8 @@ const Joi = require("joi");
1387
1387
  * | "register"
1388
1388
  * | "shipping-policy"
1389
1389
  * | "return-policy"
1390
- * | "order-status"} PageType
1390
+ * | "order-status"
1391
+ * | "locate-us"} PageType
1391
1392
  */
1392
1393
 
1393
1394
  class ContentPlatformModel {
@@ -3196,7 +3197,9 @@ class ContentPlatformModel {
3196
3197
 
3197
3198
  "return-policy",
3198
3199
 
3199
- "order-status"
3200
+ "order-status",
3201
+
3202
+ "locate-us"
3200
3203
  );
3201
3204
  }
3202
3205
  }
@@ -1064,7 +1064,7 @@ class FinancePlatformModel {
1064
1064
  code: Joi.string().allow(""),
1065
1065
  symbol: Joi.string().allow(""),
1066
1066
  name: Joi.string().allow(""),
1067
- });
1067
+ }).allow(null);
1068
1068
  }
1069
1069
 
1070
1070
  /** @returns {GenerateReportJson} */
@@ -642,6 +642,14 @@ export = OrderPlatformModel;
642
642
  * @property {OrderDetails} order_details
643
643
  * @property {string[]} [errors]
644
644
  * @property {ShipmentDetail[]} [shipment_details]
645
+ * @property {string} [text] - A label or description of the delivery status,
646
+ * such as 'Expected Delivery Date'.
647
+ * @property {string} [value] - The detailed delivery status or time
648
+ * information, such as 'Arriving on 24 Nov 2022 15:54:00'.
649
+ * @property {string} [color_code] - Hex code for the color representing the
650
+ * delivery status.
651
+ * @property {string} [expected_delivery_date] - The ISO 8601 formatted date and
652
+ * time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
645
653
  */
646
654
  /**
647
655
  * @typedef OrderStatusResult
@@ -2535,6 +2543,7 @@ export = OrderPlatformModel;
2535
2543
  * @property {InvoiceInfo} [invoice]
2536
2544
  * @property {string} [shipment_status]
2537
2545
  * @property {GSTDetailsData} [gst_details]
2546
+ * @property {OrderStatusData} [order_status]
2538
2547
  * @property {Object} [delivery_slot]
2539
2548
  * @property {OrderDetailsData} [order]
2540
2549
  * @property {UserDataInfo} [user]
@@ -4084,6 +4093,26 @@ type OrderStatusData = {
4084
4093
  order_details: OrderDetails;
4085
4094
  errors?: string[];
4086
4095
  shipment_details?: ShipmentDetail[];
4096
+ /**
4097
+ * - A label or description of the delivery status,
4098
+ * such as 'Expected Delivery Date'.
4099
+ */
4100
+ text?: string;
4101
+ /**
4102
+ * - The detailed delivery status or time
4103
+ * information, such as 'Arriving on 24 Nov 2022 15:54:00'.
4104
+ */
4105
+ value?: string;
4106
+ /**
4107
+ * - Hex code for the color representing the
4108
+ * delivery status.
4109
+ */
4110
+ color_code?: string;
4111
+ /**
4112
+ * - The ISO 8601 formatted date and
4113
+ * time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
4114
+ */
4115
+ expected_delivery_date?: string;
4087
4116
  };
4088
4117
  /** @returns {OrderStatusResult} */
4089
4118
  declare function OrderStatusResult(): OrderStatusResult;
@@ -6534,6 +6563,7 @@ type PlatformShipment = {
6534
6563
  invoice?: InvoiceInfo;
6535
6564
  shipment_status?: string;
6536
6565
  gst_details?: GSTDetailsData;
6566
+ order_status?: OrderStatusData;
6537
6567
  delivery_slot?: any;
6538
6568
  order?: OrderDetailsData;
6539
6569
  user?: UserDataInfo;
@@ -723,6 +723,14 @@ const Joi = require("joi");
723
723
  * @property {OrderDetails} order_details
724
724
  * @property {string[]} [errors]
725
725
  * @property {ShipmentDetail[]} [shipment_details]
726
+ * @property {string} [text] - A label or description of the delivery status,
727
+ * such as 'Expected Delivery Date'.
728
+ * @property {string} [value] - The detailed delivery status or time
729
+ * information, such as 'Arriving on 24 Nov 2022 15:54:00'.
730
+ * @property {string} [color_code] - Hex code for the color representing the
731
+ * delivery status.
732
+ * @property {string} [expected_delivery_date] - The ISO 8601 formatted date and
733
+ * time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
726
734
  */
727
735
 
728
736
  /**
@@ -2806,6 +2814,7 @@ const Joi = require("joi");
2806
2814
  * @property {InvoiceInfo} [invoice]
2807
2815
  * @property {string} [shipment_status]
2808
2816
  * @property {GSTDetailsData} [gst_details]
2817
+ * @property {OrderStatusData} [order_status]
2809
2818
  * @property {Object} [delivery_slot]
2810
2819
  * @property {OrderDetailsData} [order]
2811
2820
  * @property {UserDataInfo} [user]
@@ -3836,7 +3845,7 @@ class OrderPlatformModel {
3836
3845
  dp_options: Joi.any().allow(null),
3837
3846
  lock_status: Joi.boolean().allow(null),
3838
3847
  action_to_status: Joi.any().allow(null),
3839
- });
3848
+ }).allow(null);
3840
3849
  }
3841
3850
 
3842
3851
  /** @returns {ShipmentConfig} */
@@ -4303,6 +4312,10 @@ class OrderPlatformModel {
4303
4312
  order_details: OrderPlatformModel.OrderDetails().required(),
4304
4313
  errors: Joi.array().items(Joi.string().allow("")),
4305
4314
  shipment_details: Joi.array().items(OrderPlatformModel.ShipmentDetail()),
4315
+ text: Joi.string().allow(""),
4316
+ value: Joi.string().allow(""),
4317
+ color_code: Joi.string().allow(""),
4318
+ expected_delivery_date: Joi.string().allow(""),
4306
4319
  });
4307
4320
  }
4308
4321
 
@@ -5746,7 +5759,7 @@ class OrderPlatformModel {
5746
5759
  contact_person: Joi.string().allow("").allow(null),
5747
5760
  state: Joi.string().allow("").allow(null),
5748
5761
  city: Joi.string().allow("").allow(null),
5749
- });
5762
+ }).allow(null);
5750
5763
  }
5751
5764
 
5752
5765
  /** @returns {ShipmentListingChannel} */
@@ -6674,6 +6687,7 @@ class OrderPlatformModel {
6674
6687
  invoice: OrderPlatformModel.InvoiceInfo(),
6675
6688
  shipment_status: Joi.string().allow("").allow(null),
6676
6689
  gst_details: OrderPlatformModel.GSTDetailsData(),
6690
+ order_status: OrderPlatformModel.OrderStatusData(),
6677
6691
  delivery_slot: Joi.any().allow(null),
6678
6692
  order: OrderPlatformModel.OrderDetailsData(),
6679
6693
  user: OrderPlatformModel.UserDataInfo(),
@@ -7135,7 +7149,7 @@ class OrderPlatformModel {
7135
7149
  mall_name: Joi.string().allow("").allow(null),
7136
7150
  latitude: Joi.number().allow(null),
7137
7151
  address2: Joi.string().allow("").allow(null),
7138
- });
7152
+ }).allow(null);
7139
7153
  }
7140
7154
 
7141
7155
  /** @returns {Brand} */
@@ -7219,7 +7233,7 @@ class OrderPlatformModel {
7219
7233
  brand_calculated_amount: Joi.number().allow(null),
7220
7234
  tax_collected_at_source: Joi.number().allow(null),
7221
7235
  gstin_code: Joi.string().allow("").allow(null),
7222
- });
7236
+ }).allow(null);
7223
7237
  }
7224
7238
 
7225
7239
  /** @returns {DeliverySlotDetails} */
@@ -7230,7 +7244,7 @@ class OrderPlatformModel {
7230
7244
  lower_bound: Joi.string().allow("").allow(null),
7231
7245
  date: Joi.string().allow("").allow(null),
7232
7246
  type: Joi.string().allow("").allow(null),
7233
- });
7247
+ }).allow(null);
7234
7248
  }
7235
7249
 
7236
7250
  /** @returns {InvoiceDetails} */
@@ -7240,7 +7254,7 @@ class OrderPlatformModel {
7240
7254
  store_invoice_id: Joi.string().allow("").allow(null),
7241
7255
  invoice_url: Joi.string().allow("").allow(null),
7242
7256
  label_url: Joi.string().allow("").allow(null),
7243
- });
7257
+ }).allow(null);
7244
7258
  }
7245
7259
 
7246
7260
  /** @returns {UserDetails} */
@@ -7256,7 +7270,7 @@ class OrderPlatformModel {
7256
7270
  gender: Joi.string().allow("").allow(null),
7257
7271
  mongo_user_id: Joi.string().allow("").allow(null),
7258
7272
  meta: Joi.any().allow(null),
7259
- });
7273
+ }).allow(null);
7260
7274
  }
7261
7275
 
7262
7276
  /** @returns {WeightData} */
@@ -7264,7 +7278,7 @@ class OrderPlatformModel {
7264
7278
  return Joi.object({
7265
7279
  value: Joi.number().allow(null),
7266
7280
  unit: Joi.string().allow("").allow(null),
7267
- });
7281
+ }).allow(null);
7268
7282
  }
7269
7283
 
7270
7284
  /** @returns {BagDetails} */
@@ -7371,7 +7385,7 @@ class OrderPlatformModel {
7371
7385
  return Joi.object({
7372
7386
  items: Joi.array().items(OrderPlatformModel.BagDetails()),
7373
7387
  page: OrderPlatformModel.BagsPage(),
7374
- });
7388
+ }).allow(null);
7375
7389
  }
7376
7390
 
7377
7391
  /** @returns {GetBagsPlatformResponse} */
@@ -387,10 +387,16 @@ export = PaymentPlatformModel;
387
387
  /**
388
388
  * @typedef MultiTenderPaymentMeta
389
389
  * @property {Object} [extra_meta]
390
- * @property {string} [order_id]
391
- * @property {string} [payment_id]
392
- * @property {string} [current_status]
393
- * @property {string} [payment_gateway]
390
+ * @property {string} [order_id] - Fynd Platform order ID
391
+ * @property {string} [payment_id] - A unique identifier associated with a
392
+ * specific payment transaction
393
+ * @property {string} [current_status] - Represents the current state or
394
+ * condition of an object, such as an order or payment.
395
+ * @property {string} [payment_gateway] - Specifies the name or identifier of
396
+ * the payment gateway. This will deprecated in future version. We recommend
397
+ * switching to `payment_gateway_slug` to ensure uninterrupted payment processing.
398
+ * @property {string} [payment_gateway_slug] - A simplified, URL-friendly string
399
+ * that represents the name of the payment gateway and it will used for refund PG.
394
400
  */
395
401
  /**
396
402
  * @typedef MultiTenderPaymentMethod
@@ -1003,6 +1009,8 @@ export = PaymentPlatformModel;
1003
1009
  * @property {Object[]} articles - List of articles that are added in cart
1004
1010
  * @property {number} cart_value - Total cart value i.e. amount to be paid
1005
1011
  * @property {number} [total_quantity] - Total number of items in cart
1012
+ * @property {Object} [custom_cart_meta] - This field is used to add and
1013
+ * retrieve custom data fields to cart items.
1006
1014
  */
1007
1015
  /**
1008
1016
  * @typedef RefundDetailsSerializer
@@ -2193,10 +2201,31 @@ type OrderBeneficiaryResponse = {
2193
2201
  declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
2194
2202
  type MultiTenderPaymentMeta = {
2195
2203
  extra_meta?: any;
2204
+ /**
2205
+ * - Fynd Platform order ID
2206
+ */
2196
2207
  order_id?: string;
2208
+ /**
2209
+ * - A unique identifier associated with a
2210
+ * specific payment transaction
2211
+ */
2197
2212
  payment_id?: string;
2213
+ /**
2214
+ * - Represents the current state or
2215
+ * condition of an object, such as an order or payment.
2216
+ */
2198
2217
  current_status?: string;
2218
+ /**
2219
+ * - Specifies the name or identifier of
2220
+ * the payment gateway. This will deprecated in future version. We recommend
2221
+ * switching to `payment_gateway_slug` to ensure uninterrupted payment processing.
2222
+ */
2199
2223
  payment_gateway?: string;
2224
+ /**
2225
+ * - A simplified, URL-friendly string
2226
+ * that represents the name of the payment gateway and it will used for refund PG.
2227
+ */
2228
+ payment_gateway_slug?: string;
2200
2229
  };
2201
2230
  /** @returns {MultiTenderPaymentMethod} */
2202
2231
  declare function MultiTenderPaymentMethod(): MultiTenderPaymentMethod;
@@ -3849,6 +3878,11 @@ type CartDetailsSerializer = {
3849
3878
  * - Total number of items in cart
3850
3879
  */
3851
3880
  total_quantity?: number;
3881
+ /**
3882
+ * - This field is used to add and
3883
+ * retrieve custom data fields to cart items.
3884
+ */
3885
+ custom_cart_meta?: any;
3852
3886
  };
3853
3887
  /** @returns {RefundDetailsSerializer} */
3854
3888
  declare function RefundDetailsSerializer(): RefundDetailsSerializer;
@@ -435,10 +435,16 @@ const Joi = require("joi");
435
435
  /**
436
436
  * @typedef MultiTenderPaymentMeta
437
437
  * @property {Object} [extra_meta]
438
- * @property {string} [order_id]
439
- * @property {string} [payment_id]
440
- * @property {string} [current_status]
441
- * @property {string} [payment_gateway]
438
+ * @property {string} [order_id] - Fynd Platform order ID
439
+ * @property {string} [payment_id] - A unique identifier associated with a
440
+ * specific payment transaction
441
+ * @property {string} [current_status] - Represents the current state or
442
+ * condition of an object, such as an order or payment.
443
+ * @property {string} [payment_gateway] - Specifies the name or identifier of
444
+ * the payment gateway. This will deprecated in future version. We recommend
445
+ * switching to `payment_gateway_slug` to ensure uninterrupted payment processing.
446
+ * @property {string} [payment_gateway_slug] - A simplified, URL-friendly string
447
+ * that represents the name of the payment gateway and it will used for refund PG.
442
448
  */
443
449
 
444
450
  /**
@@ -1116,6 +1122,8 @@ const Joi = require("joi");
1116
1122
  * @property {Object[]} articles - List of articles that are added in cart
1117
1123
  * @property {number} cart_value - Total cart value i.e. amount to be paid
1118
1124
  * @property {number} [total_quantity] - Total number of items in cart
1125
+ * @property {Object} [custom_cart_meta] - This field is used to add and
1126
+ * retrieve custom data fields to cart items.
1119
1127
  */
1120
1128
 
1121
1129
  /**
@@ -1506,7 +1514,7 @@ class PaymentPlatformModel {
1506
1514
  payment_flow_data: Joi.any().allow(null),
1507
1515
  payment_flow: Joi.string().allow("").allow(null),
1508
1516
  api_link: Joi.string().allow("").allow(null),
1509
- });
1517
+ }).allow(null);
1510
1518
  }
1511
1519
 
1512
1520
  /** @returns {PaymentDefaultSelection} */
@@ -1564,7 +1572,7 @@ class PaymentPlatformModel {
1564
1572
  .items(Joi.string().allow("").allow(null))
1565
1573
  .allow(null, ""),
1566
1574
  allow_custom_advance_amount: Joi.boolean().allow(null),
1567
- });
1575
+ }).allow(null);
1568
1576
  }
1569
1577
 
1570
1578
  /** @returns {SplitObject} */
@@ -1573,7 +1581,7 @@ class PaymentPlatformModel {
1573
1581
  total_number_of_splits: Joi.number().allow(null),
1574
1582
  splits_remaining: Joi.number().allow(null),
1575
1583
  amount_remaining: Joi.number().allow(null),
1576
- });
1584
+ }).allow(null);
1577
1585
  }
1578
1586
 
1579
1587
  /** @returns {AdvancePaymentObject} */
@@ -1868,6 +1876,7 @@ class PaymentPlatformModel {
1868
1876
  payment_id: Joi.string().allow(""),
1869
1877
  current_status: Joi.string().allow(""),
1870
1878
  payment_gateway: Joi.string().allow(""),
1879
+ payment_gateway_slug: Joi.string().allow(""),
1871
1880
  });
1872
1881
  }
1873
1882
 
@@ -2642,6 +2651,7 @@ class PaymentPlatformModel {
2642
2651
  articles: Joi.array().items(Joi.any()).required(),
2643
2652
  cart_value: Joi.number().required(),
2644
2653
  total_quantity: Joi.number(),
2654
+ custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
2645
2655
  });
2646
2656
  }
2647
2657