@gofynd/fdk-client-javascript 1.6.4 → 2.0.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 (148) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +5 -5
  4. package/sdk/application/Cart/CartApplicationClient.js +26 -268
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +20 -20
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +98 -347
  7. package/sdk/application/Common/CommonApplicationClient.js +1 -16
  8. package/sdk/application/Communication/CommunicationApplicationClient.js +1 -24
  9. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +24 -2
  10. package/sdk/application/Configuration/ConfigurationApplicationClient.js +58 -137
  11. package/sdk/application/Content/ContentApplicationClient.d.ts +47 -7
  12. package/sdk/application/Content/ContentApplicationClient.js +222 -191
  13. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  14. package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
  15. package/sdk/application/Finance/FinanceApplicationClient.js +1 -16
  16. package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
  17. package/sdk/application/Lead/LeadApplicationClient.js +21 -52
  18. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -56
  19. package/sdk/application/Logistic/LogisticApplicationClient.js +57 -332
  20. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
  21. package/sdk/application/Order/OrderApplicationClient.js +68 -153
  22. package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -12
  23. package/sdk/application/Payment/PaymentApplicationClient.js +7 -487
  24. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  25. package/sdk/application/Rewards/RewardsApplicationClient.js +6 -59
  26. package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
  27. package/sdk/application/Share/ShareApplicationClient.js +21 -75
  28. package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
  29. package/sdk/application/Theme/ThemeApplicationClient.js +19 -47
  30. package/sdk/application/User/UserApplicationClient.js +1 -407
  31. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -8
  32. package/sdk/common/Utility.d.ts +1 -1
  33. package/sdk/common/Utility.js +10 -7
  34. package/sdk/common/Validator.d.ts +1 -0
  35. package/sdk/common/Validator.js +20 -0
  36. package/sdk/common/utils.d.ts +0 -1
  37. package/sdk/common/utils.js +0 -14
  38. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -55
  39. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +1 -408
  40. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -5
  41. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -37
  42. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -0
  43. package/sdk/partner/Lead/LeadPartnerModel.js +2 -0
  44. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +29 -25
  45. package/sdk/partner/Logistics/LogisticsPartnerClient.js +65 -42
  46. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1008 -794
  47. package/sdk/partner/Logistics/LogisticsPartnerModel.js +573 -460
  48. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +10 -5
  49. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
  50. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
  51. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  52. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +2 -0
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +67 -9
  54. package/sdk/platform/Cart/CartPlatformModel.js +38 -5
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -1
  56. package/sdk/platform/Catalog/CatalogPlatformClient.js +4 -4
  57. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +47 -13
  58. package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -7
  59. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +2 -2
  60. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +7 -4
  61. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +71 -7
  62. package/sdk/platform/Communication/CommunicationPlatformModel.js +70 -6
  63. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +0 -27
  64. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +8 -60
  65. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +31 -20
  66. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +18 -18
  67. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +1 -1
  68. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -3
  69. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +13 -0
  70. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -1
  71. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +68 -11
  72. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +49 -7
  73. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +169 -0
  74. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1279 -132
  75. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +156 -1
  76. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +180 -0
  77. package/sdk/platform/Content/ContentPlatformClient.d.ts +162 -0
  78. package/sdk/platform/Content/ContentPlatformClient.js +1697 -497
  79. package/sdk/platform/Content/ContentPlatformModel.d.ts +1053 -35
  80. package/sdk/platform/Content/ContentPlatformModel.js +717 -34
  81. package/sdk/platform/Content/ContentPlatformValidator.d.ts +127 -1
  82. package/sdk/platform/Content/ContentPlatformValidator.js +171 -0
  83. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +34 -0
  84. package/sdk/platform/Discount/DiscountPlatformClient.js +59 -0
  85. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +365 -93
  86. package/sdk/platform/Discount/DiscountPlatformModel.js +98 -93
  87. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +54 -34
  88. package/sdk/platform/Discount/DiscountPlatformValidator.js +27 -17
  89. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +0 -156
  90. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +0 -1072
  91. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -137
  92. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -173
  93. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +1 -1105
  94. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +0 -1125
  95. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -0
  96. package/sdk/platform/Lead/LeadPlatformModel.js +2 -0
  97. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
  98. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
  99. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  100. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  101. package/sdk/platform/Order/OrderPlatformClient.d.ts +212 -0
  102. package/sdk/platform/Order/OrderPlatformClient.js +397 -0
  103. package/sdk/platform/Order/OrderPlatformModel.d.ts +41 -9
  104. package/sdk/platform/Order/OrderPlatformModel.js +20 -7
  105. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
  106. package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
  107. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +58 -10
  108. package/sdk/platform/Partner/PartnerPlatformModel.js +19 -10
  109. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -2
  110. package/sdk/platform/Payment/PaymentPlatformModel.js +8 -2
  111. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +5 -0
  112. package/sdk/platform/Rewards/RewardsPlatformModel.js +2 -0
  113. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +240 -24
  114. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +1753 -277
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +320 -22
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +269 -19
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -104
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +201 -629
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +5720 -2891
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3414 -2181
  121. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +138 -216
  122. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +81 -148
  123. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
  124. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  125. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +10 -0
  126. package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
  127. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +13 -1
  128. package/sdk/platform/User/UserPlatformApplicationValidator.js +12 -0
  129. package/sdk/platform/User/UserPlatformModel.d.ts +52 -1
  130. package/sdk/platform/User/UserPlatformModel.js +36 -0
  131. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -0
  132. package/sdk/platform/Webhook/WebhookPlatformModel.js +2 -0
  133. package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
  134. package/sdk/public/Catalog/CatalogPublicClient.js +6 -11
  135. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -16
  136. package/sdk/public/Content/ContentPublicClient.d.ts +36 -3
  137. package/sdk/public/Content/ContentPublicClient.js +261 -104
  138. package/sdk/public/Content/ContentPublicModel.d.ts +155 -1
  139. package/sdk/public/Content/ContentPublicModel.js +102 -0
  140. package/sdk/public/Content/ContentPublicValidator.d.ts +18 -1
  141. package/sdk/public/Content/ContentPublicValidator.js +26 -0
  142. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  143. package/sdk/public/Partner/PartnerPublicClient.js +6 -11
  144. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  145. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  146. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  147. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  148. package/sdk/public/Webhook/WebhookPublicClient.js +1 -40
@@ -212,7 +212,7 @@ const Joi = require("joi");
212
212
  * @typedef Author
213
213
  * @property {string} [designation]
214
214
  * @property {string} [id]
215
- * @property {string} [name]
215
+ * @property {string} [name] - Name of the author
216
216
  */
217
217
 
218
218
  /**
@@ -377,36 +377,70 @@ const Joi = require("joi");
377
377
 
378
378
  /**
379
379
  * @typedef HandpickedTagSchema
380
- * @property {string} [position]
381
- * @property {Object} [attributes]
382
- * @property {string} [name]
383
- * @property {string} [url]
384
- * @property {string} [type]
385
- * @property {string} [sub_type]
386
- * @property {string} [content]
380
+ * @property {string} [position] - The location in the page where the tag should
381
+ * be injected, such as 'head', 'body-top', or 'body-bottom'.
382
+ * @property {Object} [attributes] - Additional attributes for the tag to define
383
+ * its behavior or compatibility. Supported attributes may vary based on the
384
+ * tag type for example:
385
+ *
386
+ * - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
387
+ * - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
388
+ * - For `style` tags: `media`, `type`, `scoped`.
389
+ * - Custom data attributes like `data-*` can also be added.
390
+ *
391
+ * @property {string[]} [compatible_engines] - List of UI frameworks where this
392
+ * third-party tag can be injected or supported.
393
+ * @property {string} [name] - The name of the tag used to identify it in the
394
+ * system. Example: 'Google External Script' or 'Bootstrap CSS'.
395
+ * @property {string} [url] - The URL where the external tag resource (such as a
396
+ * script or stylesheet) is hosted.
397
+ * @property {string} [type] - The type of the tag, such as 'script' (for
398
+ * JavaScript) or 'link' (for CSS).
399
+ * @property {string} [sub_type] - Defines whether the tag is embedded within
400
+ * the HTML (inline) or linked externally (external).
401
+ * @property {string} [content] - The actual content of the inline tag, such as
402
+ * JavaScript or CSS code if the tag is inline.
387
403
  */
388
404
 
389
405
  /**
390
406
  * @typedef RemoveHandpickedSchema
391
- * @property {string[]} [tags]
407
+ * @property {string[]} [tags] - A list of tag IDs to remove from the system.
392
408
  */
393
409
 
394
410
  /**
395
411
  * @typedef CreateTagSchema
396
- * @property {string} [name]
397
- * @property {string} [sub_type]
398
- * @property {string} [_id]
399
- * @property {string} [type]
400
- * @property {string} [url]
401
- * @property {string} [position]
402
- * @property {Object} [attributes]
403
- * @property {Object[]} [pages]
404
- * @property {string} [content]
412
+ * @property {string} [name] - The name of the tag to be created, used for
413
+ * identification purposes.
414
+ * @property {string} [sub_type] - Indicates if the tag is external (linked) or
415
+ * inline (embedded within the page).
416
+ * @property {string} [_id] - The unique identifier for the tag.
417
+ * @property {string} [type] - The type of the tag, either JavaScript ('js') or
418
+ * CSS ('css').
419
+ * @property {string} [url] - The external URL pointing to the script or
420
+ * stylesheet resource.
421
+ * @property {string} [position] - The position on the webpage where the tag
422
+ * will be injected, such as 'head', 'body-top', or 'body-bottom'.
423
+ * @property {Object} [attributes] - Additional attributes for the tag to define
424
+ * its behavior or compatibility. Supported attributes may vary based on the
425
+ * tag type for example:
426
+ *
427
+ * - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
428
+ * - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
429
+ * - For `style` tags: `media`, `type`, `scoped`.
430
+ * - Custom data attributes like `data-*` can also be added.
431
+ *
432
+ * @property {string[]} [compatible_engines] - List of UI frameworks where this
433
+ * third-party tag can be injected or supported.
434
+ * @property {Object[]} [pages] - Pages or environments where the tag should be
435
+ * injected or active.
436
+ * @property {string} [content] - The inline content for tags of type 'inline'
437
+ * (e.g., JavaScript or CSS code).
405
438
  */
406
439
 
407
440
  /**
408
441
  * @typedef CreateTagRequestSchema
409
- * @property {CreateTagSchema[]} [tags]
442
+ * @property {CreateTagSchema[]} [tags] - A list of tags to be created or
443
+ * updated, each containing details such as name, type, and attributes.
410
444
  */
411
445
 
412
446
  /**
@@ -434,7 +468,8 @@ const Joi = require("joi");
434
468
 
435
469
  /**
436
470
  * @typedef TagDeleteSuccessDetails
437
- * @property {boolean} [success]
471
+ * @property {boolean} [success] - Indicates whether the tag removal operation
472
+ * was successful.
438
473
  */
439
474
 
440
475
  /**
@@ -561,6 +596,7 @@ const Joi = require("joi");
561
596
  * @property {number} [current] - The current page number.
562
597
  * @property {string} type - The type of the page, such as 'PageType'.
563
598
  * @property {number} [size] - The number of items per page.
599
+ * @property {number} [page_size] - The number of items per page.
564
600
  */
565
601
 
566
602
  /**
@@ -761,29 +797,46 @@ const Joi = require("joi");
761
797
 
762
798
  /**
763
799
  * @typedef TagsSchema
764
- * @property {string} [application]
765
- * @property {string} [_id]
766
- * @property {TagSchema[]} [tags]
800
+ * @property {string} [application] - The ID of the application that owns the tags.
801
+ * @property {string} [_id] - The unique identifier for the tag set.
802
+ * @property {TagSchema[]} [tags] - A list of tags (HTML resources like scripts
803
+ * or stylesheets) that are configured for the application.
767
804
  */
768
805
 
769
806
  /**
770
807
  * @typedef TagSchema
771
- * @property {string} [name]
772
- * @property {string} [url]
773
- * @property {string} [type]
774
- * @property {string} [sub_type]
775
- * @property {string} [_id]
776
- * @property {string} [position]
777
- * @property {Object} [attributes]
778
- * @property {string} [content]
779
- * @property {Object[]} [pages]
808
+ * @property {string} [name] - The name of the tag used to identify it.
809
+ * @property {string} [url] - The URL where the external tag resource (such as a
810
+ * script or stylesheet) is located.
811
+ * @property {string} [type] - Specifies whether the tag is a JavaScript ('js')
812
+ * or CSS ('css') tag.
813
+ * @property {string} [sub_type] - Indicates whether the tag is an external
814
+ * resource (external) or inline content (inline).
815
+ * @property {string} [_id] - The unique identifier for the tag in the system.
816
+ * @property {string} [position] - The position within the page where the tag
817
+ * should be injected.
818
+ * @property {Object} [attributes] - Additional attributes for the tag to define
819
+ * its behavior or compatibility. Supported attributes may vary based on the
820
+ * tag type for example:
821
+ *
822
+ * - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
823
+ * - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
824
+ * - For `style` tags: `media`, `type`, `scoped`.
825
+ * - Custom data attributes like `data-*` can also be added.
826
+ *
827
+ * @property {string} [content] - Content of the tag if it is inline, such as
828
+ * JavaScript or CSS code.
829
+ * @property {string[]} [compatible_engines] - List of UI frameworks where this
830
+ * third-party tag can be injected or supported.
831
+ * @property {Object[]} [pages] - Pages or environments where the tag should be active.
780
832
  * @property {TagSourceSchema} [__source]
781
833
  */
782
834
 
783
835
  /**
784
836
  * @typedef TagSourceSchema
785
- * @property {string} [type]
786
- * @property {string} [id]
837
+ * @property {string} [type] - The type of source, such as 'extension'
838
+ * @property {string} [id] - The identifier of the source that created or
839
+ * provided the tag.
787
840
  */
788
841
 
789
842
  /**
@@ -1361,6 +1414,294 @@ const Joi = require("joi");
1361
1414
  * @property {PageType} type
1362
1415
  */
1363
1416
 
1417
+ /**
1418
+ * @typedef TranslateUiLabels
1419
+ * @property {string} [_id] - Unique MongoDB identifier assigned to the
1420
+ * Translate Ui Labels entry
1421
+ * @property {string} [company_id] - Identifier linking the resource to a
1422
+ * specific company within the platform
1423
+ * @property {string} [application_id] - Reference to the application where this
1424
+ * Translate Ui Labels is utilized
1425
+ * @property {string} [template_theme_id] - Links the resource to a specific
1426
+ * template theme configuration
1427
+ * @property {string} [theme_id] - Associates the resource with a particular
1428
+ * theme implementation
1429
+ * @property {string} [locale] - Specifies the language and region format for
1430
+ * the resource content
1431
+ * @property {Object} [resource] - Contains the actual resource data and
1432
+ * configuration settings
1433
+ * @property {string} [type] - Categorizes the resource type for proper handling
1434
+ * and processing
1435
+ */
1436
+
1437
+ /**
1438
+ * @typedef TranslateUiLabelsCreate
1439
+ * @property {string} [template_theme_id] - Unique identifier for the template theme
1440
+ * @property {string} [theme_id] - Unique identifier for the theme
1441
+ * @property {string} [locale] - Locale
1442
+ * @property {Object} [resource] - Translate Ui Labels json object
1443
+ * @property {string} [type] - Resource type
1444
+ */
1445
+
1446
+ /**
1447
+ * @typedef StaticResourceUpdate
1448
+ * @property {string} [template_theme_id] - Unique identifier for the template theme
1449
+ * @property {string} [theme_id] - Unique identifier for the theme
1450
+ * @property {string} [locale] - Locale
1451
+ * @property {Object} [resource] - Translate Ui Labels json object
1452
+ * @property {string} [type] - Resource type
1453
+ */
1454
+
1455
+ /**
1456
+ * @typedef TranslateUiLabelsPage
1457
+ * @property {TranslateUiLabels[]} [items] - List of items containing all the
1458
+ * static info data.
1459
+ * @property {Page} [page]
1460
+ */
1461
+
1462
+ /**
1463
+ * @typedef Error
1464
+ * @property {string} [error] - Detailed message explaining the error that occurred
1465
+ */
1466
+
1467
+ /**
1468
+ * @typedef Meta
1469
+ * @property {string} [created_by] - Identifier of the user who created this resource
1470
+ * @property {string} [modified_by] - Identifier of the user who last modified
1471
+ * this resource
1472
+ * @property {string} [created_on] - Timestamp when this resource was initially created
1473
+ * @property {string} [modified_on] - Timestamp when this resource was last modified
1474
+ */
1475
+
1476
+ /**
1477
+ * @typedef CompanyLanguage
1478
+ * @property {string} [_id] - Unique identifier for the company language setting
1479
+ * @property {string} company_id - Identifier of the company this language
1480
+ * configuration belongs to
1481
+ * @property {string} [locale] - Language code following ISO standards for this
1482
+ * company setting
1483
+ * @property {string} [name] - Display name of the language for company usage
1484
+ * @property {string} [direction] - Text direction setting for company content
1485
+ * in this language
1486
+ * @property {boolean} [is_default] - Indicates if this is the default language
1487
+ * for the company
1488
+ * @property {string} [display_name] - Translated name of the language in
1489
+ * English for easy reference and display at the website.
1490
+ */
1491
+
1492
+ /**
1493
+ * @typedef CompanyLanguageCreate
1494
+ * @property {string[]} locales - List of language codes to be added to company
1495
+ * configuration
1496
+ */
1497
+
1498
+ /**
1499
+ * @typedef CompanyLanguageUpdate
1500
+ * @property {boolean} is_default - Sets the specified language as the company default
1501
+ */
1502
+
1503
+ /**
1504
+ * @typedef ApplicationLanguage
1505
+ * @property {string} [_id] - Unique identifier for the application language setting
1506
+ * @property {string} company_id - Identifier of the company this application belongs to
1507
+ * @property {string} application_id - Unique identifier of the application
1508
+ * using this language
1509
+ * @property {string} locale - Language code following ISO standards for this application
1510
+ * @property {string} name - Display name of the language for application usage
1511
+ * @property {string} direction - Specifies the text direction for displaying
1512
+ * application content, either left-to-right (ltr) or right-to-left (rtl)
1513
+ * @property {boolean} is_default - Indicates if this is the default language
1514
+ * for the application
1515
+ * @property {boolean} published - Indicates whether this language is currently
1516
+ * active and visible within the storefront.
1517
+ * @property {string} [display_name] - Translated name of the language in
1518
+ * English for easy reference and display at the website.
1519
+ */
1520
+
1521
+ /**
1522
+ * @typedef unPublishApplicationLanguage
1523
+ * @property {boolean} published - Updates the publication status of the language
1524
+ */
1525
+
1526
+ /**
1527
+ * @typedef ApplicationLanguageCreate
1528
+ * @property {string[]} locales - List of language codes to be added to
1529
+ * application configuration
1530
+ */
1531
+
1532
+ /**
1533
+ * @typedef ApplicationLanguageUpdate
1534
+ * @property {boolean} is_default - Sets the specified language as the application default
1535
+ * @property {boolean} published - Updates the publication status of the language
1536
+ */
1537
+
1538
+ /**
1539
+ * @typedef TranslatableResource
1540
+ * @property {string} [_id] - Unique identifier for the translatable resource
1541
+ * @property {string} type - Categorizes the type of content that can be translated
1542
+ * @property {string} name - Display name of the translatable resource
1543
+ * @property {string} description - Detailed explanation of the translatable resource
1544
+ * @property {string} schema_type - Defines the processing type for the
1545
+ * translation schema static (fixed), dynamic (flexible), or partial_dynamic (mixed).
1546
+ * @property {string} [created_by] - Identifier of the user who created this resource
1547
+ * @property {string} [modified_by] - Identifier of the user who last modified
1548
+ * this resource
1549
+ * @property {string} [created_on] - Timestamp when this resource was initially created
1550
+ * @property {string} [modified_on] - Timestamp when this resource was last modified
1551
+ * @property {TranslatableSection} [section_id]
1552
+ */
1553
+
1554
+ /**
1555
+ * @typedef ResourceDefinition
1556
+ * @property {string} [_id] - Unique identifier for the resource definition
1557
+ * @property {string} translatable_resource_id - Reference to the associated
1558
+ * translatable resource
1559
+ * @property {ResourceJsonSchema} [json_schema]
1560
+ * @property {ResourceUISchema} [ui_schema]
1561
+ * @property {ResourceBulkDetails} [bulk_details]
1562
+ */
1563
+
1564
+ /**
1565
+ * @typedef ResourceJsonSchema
1566
+ * @property {string} [schema]
1567
+ * @property {ResourceJsonSchemaType} [type]
1568
+ */
1569
+
1570
+ /**
1571
+ * @typedef ResourceJsonSchemaType
1572
+ * @property {Author} [author]
1573
+ * @property {Title} [title]
1574
+ * @property {FeatureImage} [feature_image]
1575
+ */
1576
+
1577
+ /**
1578
+ * @typedef ResourceUISchema
1579
+ * @property {Author} [author]
1580
+ * @property {Title} [title]
1581
+ * @property {FeatureImage} [feature_image]
1582
+ * @property {Seo} [seo]
1583
+ */
1584
+
1585
+ /**
1586
+ * @typedef ResourceBulkDetails
1587
+ * @property {string[]} [fields]
1588
+ */
1589
+
1590
+ /**
1591
+ * @typedef Title
1592
+ * @property {string} [ui_widget]
1593
+ * @property {boolean} [ui_description]
1594
+ */
1595
+
1596
+ /**
1597
+ * @typedef FeatureImage
1598
+ * @property {string} [secure_url] - URL of the secure image
1599
+ */
1600
+
1601
+ /**
1602
+ * @typedef Seo
1603
+ * @property {Title} [title]
1604
+ * @property {string} [description]
1605
+ * @property {string} [canonical_url]
1606
+ * @property {MetaTag[]} [meta_tags]
1607
+ */
1608
+
1609
+ /**
1610
+ * @typedef MetaTag
1611
+ * @property {string} [title] - Title of the meta tag
1612
+ * @property {MetaTagItem[]} [items]
1613
+ */
1614
+
1615
+ /**
1616
+ * @typedef MetaTagItem
1617
+ * @property {string} [key] - Key of the meta tag item
1618
+ * @property {string} [value] - Value of the meta tag item
1619
+ */
1620
+
1621
+ /**
1622
+ * @typedef ResourceTranslation
1623
+ * @property {string} [_id] - Unique identifier for the translation entry
1624
+ * @property {string} [locale] - Language code for this translation
1625
+ * @property {TranslationValue} [value]
1626
+ */
1627
+
1628
+ /**
1629
+ * @typedef TranslationValue
1630
+ * @property {string} [name] - Translated name
1631
+ * @property {TranslationSeo} [seo]
1632
+ */
1633
+
1634
+ /**
1635
+ * @typedef TranslationSeo
1636
+ * @property {string} [title] - Translated SEO title
1637
+ * @property {string[]} [breadcrumbs] - List of translated breadcrumbs
1638
+ * @property {string[]} [meta_tags] - List of translated meta tags
1639
+ * @property {string} [canonical_url] - Translated canonical URL
1640
+ * @property {string} [description] - Translated SEO description
1641
+ */
1642
+
1643
+ /**
1644
+ * @typedef DeletedResource
1645
+ * @property {string} [message] - Confirmation message for successful deletion
1646
+ */
1647
+
1648
+ /**
1649
+ * @typedef ResourceTranslationList
1650
+ * @property {ResourceTranslationCreate[]} [items]
1651
+ */
1652
+
1653
+ /**
1654
+ * @typedef ResourceTranslationCreate
1655
+ * @property {string} [type] - Type of content being translated
1656
+ * @property {string} [resource_id] - Identifier of the resource requiring translation
1657
+ * @property {string} [locale] - Target language code for the translation
1658
+ * @property {TranslationValue} [value]
1659
+ */
1660
+
1661
+ /**
1662
+ * @typedef ResourceTranslationUpdate
1663
+ * @property {TranslationValue} [value]
1664
+ */
1665
+
1666
+ /**
1667
+ * @typedef TranslatableSection
1668
+ * @property {string} [_id] - Unique identifier for the translatable section
1669
+ * @property {string} [name] - Display name of the section
1670
+ * @property {string} [description] - Detailed explanation of the section's purpose
1671
+ * @property {string} [created_by] - Identifier of the user who created this resource
1672
+ * @property {string} [modified_by] - Identifier of the user who last modified
1673
+ * this resource
1674
+ * @property {string} [created_on] - Timestamp when this resource was initially created
1675
+ * @property {string} [modified_on] - Timestamp when this resource was last modified
1676
+ */
1677
+
1678
+ /**
1679
+ * @typedef Metrics
1680
+ * @property {number} [total] - Total number of translation operations attempted
1681
+ * @property {number} [success] - Number of successful translation operations
1682
+ * @property {number} [failed] - Number of failed translation operations
1683
+ */
1684
+
1685
+ /**
1686
+ * @typedef ResourceTranslationUpsertItem
1687
+ * @property {string} [message] - Status message for the translation operation
1688
+ * @property {ResourceTranslationCreate} [data]
1689
+ */
1690
+
1691
+ /**
1692
+ * @typedef ResourceTranslationBulkUpsert
1693
+ * @property {Metrics} [metrics]
1694
+ * @property {ResourceTranslationUpsertItem[]} [failed_items] - List of failed
1695
+ * translation operations
1696
+ * @property {ResourceTranslationUpsertItem[]} [updated_items] - List of
1697
+ * successful translation operations
1698
+ */
1699
+
1700
+ /**
1701
+ * @typedef StandardError
1702
+ * @property {string} message - A brief description of the error.
1703
+ */
1704
+
1364
1705
  /** @typedef {"title" | "description"} GenerationEntityType */
1365
1706
 
1366
1707
  /**
@@ -1889,6 +2230,7 @@ class ContentPlatformModel {
1889
2230
  return Joi.object({
1890
2231
  position: Joi.string().allow(""),
1891
2232
  attributes: Joi.object().pattern(/\S/, Joi.any()),
2233
+ compatible_engines: Joi.array().items(Joi.string().allow("")),
1892
2234
  name: Joi.string().allow(""),
1893
2235
  url: Joi.string().allow(""),
1894
2236
  type: Joi.string().allow(""),
@@ -1914,6 +2256,7 @@ class ContentPlatformModel {
1914
2256
  url: Joi.string().allow(""),
1915
2257
  position: Joi.string().allow(""),
1916
2258
  attributes: Joi.object().pattern(/\S/, Joi.any()),
2259
+ compatible_engines: Joi.array().items(Joi.string().allow("")),
1917
2260
  pages: Joi.array().items(Joi.any()),
1918
2261
  content: Joi.string().allow(""),
1919
2262
  });
@@ -2119,6 +2462,7 @@ class ContentPlatformModel {
2119
2462
  current: Joi.number(),
2120
2463
  type: Joi.string().allow("").required(),
2121
2464
  size: Joi.number(),
2465
+ page_size: Joi.number(),
2122
2466
  });
2123
2467
  }
2124
2468
 
@@ -2383,6 +2727,7 @@ class ContentPlatformModel {
2383
2727
  position: Joi.string().allow(""),
2384
2728
  attributes: Joi.object().pattern(/\S/, Joi.any()),
2385
2729
  content: Joi.string().allow(""),
2730
+ compatible_engines: Joi.array().items(Joi.string().allow("")),
2386
2731
  pages: Joi.array().items(Joi.any()),
2387
2732
  __source: ContentPlatformModel.TagSourceSchema(),
2388
2733
  });
@@ -3112,6 +3457,344 @@ class ContentPlatformModel {
3112
3457
  });
3113
3458
  }
3114
3459
 
3460
+ /** @returns {TranslateUiLabels} */
3461
+ static TranslateUiLabels() {
3462
+ return Joi.object({
3463
+ _id: Joi.string().allow(""),
3464
+ company_id: Joi.string().allow(""),
3465
+ application_id: Joi.string().allow(""),
3466
+ template_theme_id: Joi.string().allow(""),
3467
+ theme_id: Joi.string().allow(""),
3468
+ locale: Joi.string().allow(""),
3469
+ resource: Joi.object().pattern(/\S/, Joi.any()),
3470
+ type: Joi.string().allow(""),
3471
+ });
3472
+ }
3473
+
3474
+ /** @returns {TranslateUiLabelsCreate} */
3475
+ static TranslateUiLabelsCreate() {
3476
+ return Joi.object({
3477
+ template_theme_id: Joi.string().allow(""),
3478
+ theme_id: Joi.string().allow(""),
3479
+ locale: Joi.string().allow(""),
3480
+ resource: Joi.object().pattern(/\S/, Joi.any()),
3481
+ type: Joi.string().allow(""),
3482
+ });
3483
+ }
3484
+
3485
+ /** @returns {StaticResourceUpdate} */
3486
+ static StaticResourceUpdate() {
3487
+ return Joi.object({
3488
+ template_theme_id: Joi.string().allow(""),
3489
+ theme_id: Joi.string().allow(""),
3490
+ locale: Joi.string().allow(""),
3491
+ resource: Joi.object().pattern(/\S/, Joi.any()),
3492
+ type: Joi.string().allow(""),
3493
+ });
3494
+ }
3495
+
3496
+ /** @returns {TranslateUiLabelsPage} */
3497
+ static TranslateUiLabelsPage() {
3498
+ return Joi.object({
3499
+ items: Joi.array().items(ContentPlatformModel.TranslateUiLabels()),
3500
+ page: ContentPlatformModel.Page(),
3501
+ });
3502
+ }
3503
+
3504
+ /** @returns {Error} */
3505
+ static Error() {
3506
+ return Joi.object({
3507
+ error: Joi.string().allow(""),
3508
+ });
3509
+ }
3510
+
3511
+ /** @returns {Meta} */
3512
+ static Meta() {
3513
+ return Joi.object({
3514
+ created_by: Joi.string().allow(""),
3515
+ modified_by: Joi.string().allow(""),
3516
+ created_on: Joi.string().allow(""),
3517
+ modified_on: Joi.string().allow(""),
3518
+ });
3519
+ }
3520
+
3521
+ /** @returns {CompanyLanguage} */
3522
+ static CompanyLanguage() {
3523
+ return Joi.object({
3524
+ _id: Joi.string().allow(""),
3525
+ company_id: Joi.string().allow("").required(),
3526
+ locale: Joi.string().allow(""),
3527
+ name: Joi.string().allow(""),
3528
+ direction: Joi.string().allow(""),
3529
+ is_default: Joi.boolean(),
3530
+ display_name: Joi.string().allow(""),
3531
+ });
3532
+ }
3533
+
3534
+ /** @returns {CompanyLanguageCreate} */
3535
+ static CompanyLanguageCreate() {
3536
+ return Joi.object({
3537
+ locales: Joi.array().items(Joi.string().allow("")).required(),
3538
+ });
3539
+ }
3540
+
3541
+ /** @returns {CompanyLanguageUpdate} */
3542
+ static CompanyLanguageUpdate() {
3543
+ return Joi.object({
3544
+ is_default: Joi.boolean().required(),
3545
+ });
3546
+ }
3547
+
3548
+ /** @returns {ApplicationLanguage} */
3549
+ static ApplicationLanguage() {
3550
+ return Joi.object({
3551
+ _id: Joi.string().allow(""),
3552
+ company_id: Joi.string().allow("").required(),
3553
+ application_id: Joi.string().allow("").required(),
3554
+ locale: Joi.string().allow("").required(),
3555
+ name: Joi.string().allow("").required(),
3556
+ direction: Joi.string().allow("").required(),
3557
+ is_default: Joi.boolean().required(),
3558
+ published: Joi.boolean().required(),
3559
+ display_name: Joi.string().allow(""),
3560
+ });
3561
+ }
3562
+
3563
+ /** @returns {unPublishApplicationLanguage} */
3564
+ static unPublishApplicationLanguage() {
3565
+ return Joi.object({
3566
+ published: Joi.boolean().required(),
3567
+ });
3568
+ }
3569
+
3570
+ /** @returns {ApplicationLanguageCreate} */
3571
+ static ApplicationLanguageCreate() {
3572
+ return Joi.object({
3573
+ locales: Joi.array().items(Joi.string().allow("")).required(),
3574
+ });
3575
+ }
3576
+
3577
+ /** @returns {ApplicationLanguageUpdate} */
3578
+ static ApplicationLanguageUpdate() {
3579
+ return Joi.object({
3580
+ is_default: Joi.boolean().required(),
3581
+ published: Joi.boolean().required(),
3582
+ });
3583
+ }
3584
+
3585
+ /** @returns {TranslatableResource} */
3586
+ static TranslatableResource() {
3587
+ return Joi.object({
3588
+ _id: Joi.string().allow(""),
3589
+ type: Joi.string().allow("").required(),
3590
+ name: Joi.string().allow("").required(),
3591
+ description: Joi.string().allow("").required(),
3592
+ schema_type: Joi.string().allow("").required(),
3593
+ created_by: Joi.string().allow(""),
3594
+ modified_by: Joi.string().allow(""),
3595
+ created_on: Joi.string().allow(""),
3596
+ modified_on: Joi.string().allow(""),
3597
+ section_id: ContentPlatformModel.TranslatableSection(),
3598
+ });
3599
+ }
3600
+
3601
+ /** @returns {ResourceDefinition} */
3602
+ static ResourceDefinition() {
3603
+ return Joi.object({
3604
+ _id: Joi.string().allow(""),
3605
+ translatable_resource_id: Joi.string().allow("").required(),
3606
+ json_schema: ContentPlatformModel.ResourceJsonSchema(),
3607
+ ui_schema: ContentPlatformModel.ResourceUISchema(),
3608
+ bulk_details: ContentPlatformModel.ResourceBulkDetails(),
3609
+ });
3610
+ }
3611
+
3612
+ /** @returns {ResourceJsonSchema} */
3613
+ static ResourceJsonSchema() {
3614
+ return Joi.object({
3615
+ schema: Joi.string().allow(""),
3616
+ type: ContentPlatformModel.ResourceJsonSchemaType(),
3617
+ });
3618
+ }
3619
+
3620
+ /** @returns {ResourceJsonSchemaType} */
3621
+ static ResourceJsonSchemaType() {
3622
+ return Joi.object({
3623
+ author: ContentPlatformModel.Author(),
3624
+ title: ContentPlatformModel.Title(),
3625
+ feature_image: ContentPlatformModel.FeatureImage(),
3626
+ });
3627
+ }
3628
+
3629
+ /** @returns {ResourceUISchema} */
3630
+ static ResourceUISchema() {
3631
+ return Joi.object({
3632
+ author: ContentPlatformModel.Author(),
3633
+ title: ContentPlatformModel.Title(),
3634
+ feature_image: ContentPlatformModel.FeatureImage(),
3635
+ seo: ContentPlatformModel.Seo(),
3636
+ });
3637
+ }
3638
+
3639
+ /** @returns {ResourceBulkDetails} */
3640
+ static ResourceBulkDetails() {
3641
+ return Joi.object({
3642
+ fields: Joi.array().items(Joi.string().allow("")),
3643
+ });
3644
+ }
3645
+
3646
+ /** @returns {Title} */
3647
+ static Title() {
3648
+ return Joi.object({
3649
+ ui_widget: Joi.string().allow(""),
3650
+ ui_description: Joi.boolean(),
3651
+ });
3652
+ }
3653
+
3654
+ /** @returns {FeatureImage} */
3655
+ static FeatureImage() {
3656
+ return Joi.object({
3657
+ secure_url: Joi.string().allow(""),
3658
+ });
3659
+ }
3660
+
3661
+ /** @returns {Seo} */
3662
+ static Seo() {
3663
+ return Joi.object({
3664
+ title: ContentPlatformModel.Title(),
3665
+ description: Joi.string().allow(""),
3666
+ canonical_url: Joi.string().allow(""),
3667
+ meta_tags: Joi.array().items(ContentPlatformModel.MetaTag()),
3668
+ });
3669
+ }
3670
+
3671
+ /** @returns {MetaTag} */
3672
+ static MetaTag() {
3673
+ return Joi.object({
3674
+ title: Joi.string().allow(""),
3675
+ items: Joi.array().items(ContentPlatformModel.MetaTagItem()),
3676
+ });
3677
+ }
3678
+
3679
+ /** @returns {MetaTagItem} */
3680
+ static MetaTagItem() {
3681
+ return Joi.object({
3682
+ key: Joi.string().allow(""),
3683
+ value: Joi.string().allow(""),
3684
+ });
3685
+ }
3686
+
3687
+ /** @returns {ResourceTranslation} */
3688
+ static ResourceTranslation() {
3689
+ return Joi.object({
3690
+ _id: Joi.string().allow(""),
3691
+ locale: Joi.string().allow(""),
3692
+ value: ContentPlatformModel.TranslationValue(),
3693
+ });
3694
+ }
3695
+
3696
+ /** @returns {TranslationValue} */
3697
+ static TranslationValue() {
3698
+ return Joi.object({
3699
+ name: Joi.string().allow(""),
3700
+ seo: ContentPlatformModel.TranslationSeo(),
3701
+ });
3702
+ }
3703
+
3704
+ /** @returns {TranslationSeo} */
3705
+ static TranslationSeo() {
3706
+ return Joi.object({
3707
+ title: Joi.string().allow(""),
3708
+ breadcrumbs: Joi.array().items(Joi.string().allow("")),
3709
+ meta_tags: Joi.array().items(Joi.string().allow("")),
3710
+ canonical_url: Joi.string().allow(""),
3711
+ description: Joi.string().allow(""),
3712
+ });
3713
+ }
3714
+
3715
+ /** @returns {DeletedResource} */
3716
+ static DeletedResource() {
3717
+ return Joi.object({
3718
+ message: Joi.string().allow(""),
3719
+ });
3720
+ }
3721
+
3722
+ /** @returns {ResourceTranslationList} */
3723
+ static ResourceTranslationList() {
3724
+ return Joi.object({
3725
+ items: Joi.array().items(
3726
+ ContentPlatformModel.ResourceTranslationCreate()
3727
+ ),
3728
+ });
3729
+ }
3730
+
3731
+ /** @returns {ResourceTranslationCreate} */
3732
+ static ResourceTranslationCreate() {
3733
+ return Joi.object({
3734
+ type: Joi.string().allow(""),
3735
+ resource_id: Joi.string().allow(""),
3736
+ locale: Joi.string().allow(""),
3737
+ value: ContentPlatformModel.TranslationValue(),
3738
+ });
3739
+ }
3740
+
3741
+ /** @returns {ResourceTranslationUpdate} */
3742
+ static ResourceTranslationUpdate() {
3743
+ return Joi.object({
3744
+ value: ContentPlatformModel.TranslationValue(),
3745
+ });
3746
+ }
3747
+
3748
+ /** @returns {TranslatableSection} */
3749
+ static TranslatableSection() {
3750
+ return Joi.object({
3751
+ _id: Joi.string().allow(""),
3752
+ name: Joi.string().allow(""),
3753
+ description: Joi.string().allow(""),
3754
+ created_by: Joi.string().allow(""),
3755
+ modified_by: Joi.string().allow(""),
3756
+ created_on: Joi.string().allow(""),
3757
+ modified_on: Joi.string().allow(""),
3758
+ });
3759
+ }
3760
+
3761
+ /** @returns {Metrics} */
3762
+ static Metrics() {
3763
+ return Joi.object({
3764
+ total: Joi.number(),
3765
+ success: Joi.number(),
3766
+ failed: Joi.number(),
3767
+ });
3768
+ }
3769
+
3770
+ /** @returns {ResourceTranslationUpsertItem} */
3771
+ static ResourceTranslationUpsertItem() {
3772
+ return Joi.object({
3773
+ message: Joi.string().allow(""),
3774
+ data: ContentPlatformModel.ResourceTranslationCreate(),
3775
+ });
3776
+ }
3777
+
3778
+ /** @returns {ResourceTranslationBulkUpsert} */
3779
+ static ResourceTranslationBulkUpsert() {
3780
+ return Joi.object({
3781
+ metrics: ContentPlatformModel.Metrics(),
3782
+ failed_items: Joi.array().items(
3783
+ ContentPlatformModel.ResourceTranslationUpsertItem()
3784
+ ),
3785
+ updated_items: Joi.array().items(
3786
+ ContentPlatformModel.ResourceTranslationUpsertItem()
3787
+ ),
3788
+ });
3789
+ }
3790
+
3791
+ /** @returns {StandardError} */
3792
+ static StandardError() {
3793
+ return Joi.object({
3794
+ message: Joi.string().allow("").required(),
3795
+ });
3796
+ }
3797
+
3115
3798
  /**
3116
3799
  * Enum: GenerationEntityType Used By: Content
3117
3800
  *