@gofynd/fdk-client-javascript 1.4.16-beta.3 → 1.4.16-beta.4

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 (242) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
  6. package/sdk/application/Cart/CartApplicationClient.js +27 -117
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  10. package/sdk/application/Common/CommonApplicationClient.js +1 -1
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
  14. package/sdk/application/Content/ContentApplicationClient.js +56 -161
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
  18. package/sdk/application/Lead/LeadApplicationClient.js +1 -1
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
  22. package/sdk/application/Order/OrderApplicationClient.js +8 -56
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
  24. package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
  25. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  26. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  27. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  28. package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
  29. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  30. package/sdk/application/User/UserApplicationClient.js +6 -6
  31. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  32. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  33. package/sdk/common/Utility.js +6 -3
  34. package/sdk/common/utils.d.ts +0 -1
  35. package/sdk/common/utils.js +0 -14
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
  37. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
  38. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
  39. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
  40. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
  41. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
  42. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  43. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  44. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  45. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  46. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
  47. package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
  48. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
  49. package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
  50. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
  51. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
  52. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
  53. package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
  54. package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
  55. package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
  56. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  57. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
  58. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
  59. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
  60. package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
  61. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
  62. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
  64. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
  66. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
  71. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  72. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  73. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  74. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  75. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  76. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  77. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  78. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  79. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
  80. package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
  81. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
  82. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
  83. package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
  84. package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
  85. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
  86. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
  87. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
  88. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
  89. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
  90. package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
  91. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
  92. package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
  93. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
  94. package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
  95. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
  96. package/sdk/platform/Common/CommonPlatformClient.js +2 -3
  97. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  98. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  99. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
  100. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
  101. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  102. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  103. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
  104. package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
  105. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
  106. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
  107. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  108. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
  109. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  110. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  111. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
  112. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
  113. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  114. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  115. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
  116. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
  117. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
  118. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
  119. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
  120. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
  121. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -204
  122. package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
  123. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
  124. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
  125. package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
  126. package/sdk/platform/Content/ContentPlatformClient.js +336 -523
  127. package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
  128. package/sdk/platform/Content/ContentPlatformModel.js +394 -631
  129. package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
  130. package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
  131. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
  132. package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
  133. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  134. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  135. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  137. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
  141. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
  142. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
  144. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
  145. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  146. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  147. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  148. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  149. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
  150. package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
  151. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  152. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  153. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  154. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  155. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  156. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  157. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
  158. package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
  159. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
  160. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
  161. package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
  162. package/sdk/platform/Order/OrderPlatformClient.js +198 -416
  163. package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
  164. package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
  165. package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
  166. package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
  167. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  168. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  169. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  170. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  171. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
  172. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
  173. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  174. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  175. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  176. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  177. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
  178. package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
  179. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  180. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  181. package/sdk/platform/PlatformClient.d.ts +2 -0
  182. package/sdk/platform/PlatformClient.js +4 -0
  183. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  184. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  185. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  186. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  187. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  188. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
  199. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  200. package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
  201. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
  202. package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
  203. package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
  204. package/sdk/platform/Share/SharePlatformModel.js +6 -31
  205. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  206. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
  207. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
  208. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
  209. package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
  210. package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
  211. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  212. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  213. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  214. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  215. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  216. package/sdk/platform/User/UserPlatformModel.js +23 -23
  217. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  218. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  219. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
  220. package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
  221. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  222. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  223. package/sdk/platform/index.d.ts +1 -0
  224. package/sdk/platform/index.js +2 -0
  225. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
  226. package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
  227. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  228. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  229. package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
  230. package/sdk/public/Content/ContentPublicClient.js +6 -810
  231. package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
  232. package/sdk/public/Content/ContentPublicModel.js +3 -649
  233. package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
  234. package/sdk/public/Content/ContentPublicValidator.js +2 -88
  235. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  236. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  237. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  238. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  239. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  240. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  241. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  242. package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
@@ -1,7 +1,7 @@
1
1
  const Joi = require("joi");
2
2
 
3
3
  /**
4
- * @typedef GeneralConfigDetails
4
+ * @typedef GeneralConfigResponse
5
5
  * @property {string} [_id]
6
6
  * @property {SupportCommunicationSchema[]} [support_communication]
7
7
  * @property {boolean} [show_communication_info]
@@ -325,8 +325,8 @@ const Joi = require("joi");
325
325
  /** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
326
326
 
327
327
  class LeadPlatformModel {
328
- /** @returns {GeneralConfigDetails} */
329
- static GeneralConfigDetails() {
328
+ /** @returns {GeneralConfigResponse} */
329
+ static GeneralConfigResponse() {
330
330
  return Joi.object({
331
331
  _id: Joi.string().allow(""),
332
332
  support_communication: Joi.array().items(
@@ -474,7 +474,7 @@ class LeadPlatformModel {
474
474
  /** @returns {TicketHistoryPayload} */
475
475
  static TicketHistoryPayload() {
476
476
  return Joi.object({
477
- value: Joi.object().pattern(/\S/, Joi.any()).required(),
477
+ value: Joi.any().required(),
478
478
  type: LeadPlatformModel.HistoryTypeEnum().required(),
479
479
  });
480
480
  }
@@ -515,12 +515,12 @@ class LeadPlatformModel {
515
515
  /** @returns {AddTicketPayload} */
516
516
  static AddTicketPayload() {
517
517
  return Joi.object({
518
- created_by: Joi.object().pattern(/\S/, Joi.any()),
518
+ created_by: Joi.any(),
519
519
  status: Joi.string().allow(""),
520
520
  priority: LeadPlatformModel.PriorityEnum(),
521
521
  category: Joi.string().allow("").required(),
522
522
  content: LeadPlatformModel.TicketContent().required(),
523
- _custom_json: Joi.object().pattern(/\S/, Joi.any()),
523
+ _custom_json: Joi.any(),
524
524
  });
525
525
  }
526
526
 
@@ -559,7 +559,7 @@ class LeadPlatformModel {
559
559
  /** @returns {TicketFeedbackPayload} */
560
560
  static TicketFeedbackPayload() {
561
561
  return Joi.object({
562
- form_response: Joi.object().pattern(/\S/, Joi.any()),
562
+ form_response: Joi.any(),
563
563
  });
564
564
  }
565
565
 
@@ -605,9 +605,9 @@ class LeadPlatformModel {
605
605
  /** @returns {FeedbackForm} */
606
606
  static FeedbackForm() {
607
607
  return Joi.object({
608
- inputs: Joi.object().pattern(/\S/, Joi.any()),
608
+ inputs: Joi.any(),
609
609
  title: Joi.string().allow(""),
610
- timestamps: Joi.object().pattern(/\S/, Joi.any()),
610
+ timestamps: Joi.any(),
611
611
  });
612
612
  }
613
613
 
@@ -641,7 +641,7 @@ class LeadPlatformModel {
641
641
  .items(LeadPlatformModel.FeedbackResponseItem())
642
642
  .required(),
643
643
  category: Joi.string().allow(""),
644
- user: Joi.object().pattern(/\S/, Joi.any()),
644
+ user: Joi.any(),
645
645
  updated_at: Joi.string().allow(""),
646
646
  created_at: Joi.string().allow(""),
647
647
  });
@@ -651,10 +651,10 @@ class LeadPlatformModel {
651
651
  static TicketHistory() {
652
652
  return Joi.object({
653
653
  type: Joi.string().allow("").required(),
654
- value: Joi.object().pattern(/\S/, Joi.any()).required(),
654
+ value: Joi.any().required(),
655
655
  ticket_id: Joi.string().allow("").required(),
656
656
  created_on: LeadPlatformModel.CreatedOn(),
657
- created_by: Joi.object().pattern(/\S/, Joi.any()),
657
+ created_by: Joi.any(),
658
658
  _id: Joi.string().allow("").required(),
659
659
  updated_at: Joi.string().allow(""),
660
660
  created_at: Joi.string().allow(""),
@@ -674,12 +674,12 @@ class LeadPlatformModel {
674
674
  status: LeadPlatformModel.Status().required(),
675
675
  priority: LeadPlatformModel.Priority().required(),
676
676
  sla: LeadPlatformModel.SLA(),
677
- created_by: Joi.object().pattern(/\S/, Joi.any()),
678
- assigned_to: Joi.object().pattern(/\S/, Joi.any()),
677
+ created_by: Joi.any(),
678
+ assigned_to: Joi.any(),
679
679
  tags: Joi.array().items(Joi.string().allow("")),
680
- _custom_json: Joi.object().pattern(/\S/, Joi.any()),
680
+ _custom_json: Joi.any(),
681
681
  is_feedback_pending: Joi.boolean(),
682
- integration: Joi.object().pattern(/\S/, Joi.any()),
682
+ integration: Joi.any(),
683
683
  _id: Joi.string().allow("").required(),
684
684
  updated_at: Joi.string().allow(""),
685
685
  created_at: Joi.string().allow(""),
@@ -9,37 +9,26 @@ declare class Order {
9
9
  *
10
10
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
11
11
  * @param {import("../PlatformAPIClient").Options} - Options
12
- * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
12
+ * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
13
13
  * - Success response
14
14
  *
15
15
  * @name getApplicationShipments
16
16
  * @summary: List sales channel shipments
17
17
  * @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
18
18
  */
19
- getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
19
+ getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
20
20
  /**
21
21
  * @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
22
22
  * - Arg object
23
23
  *
24
24
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
25
25
  * @param {import("../PlatformAPIClient").Options} - Options
26
- * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
27
- * Success response
26
+ * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
28
27
  * @name getPlatformShipmentReasons
29
28
  * @summary: List shipment cancellation reasons
30
29
  * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
31
30
  */
32
- getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>;
33
- /**
34
- * @param {OrderPlatformApplicationValidator.GetRulesParam} arg - Arg object
35
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
36
- * @param {import("../PlatformAPIClient").Options} - Options
37
- * @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
38
- * @name getRules
39
- * @summary: List of RMA rules based on the given input conditions.
40
- * @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRules/).
41
- */
42
- getRules({ body, requestHeaders }?: OrderPlatformApplicationValidator.GetRulesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleListResponseSchema>;
31
+ getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
43
32
  /**
44
33
  * @param {OrderPlatformApplicationValidator.GetShipmentBagReasonsParam} arg
45
34
  * - Arg object
@@ -48,8 +37,8 @@ declare class Order {
48
37
  * @param {import("../PlatformAPIClient").Options} - Options
49
38
  * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
50
39
  * @name getShipmentBagReasons
51
- * @summary: Retrieve Reasons for Cancellation and Return journey
52
- * @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
40
+ * @summary: List bag cancellation reasons
41
+ * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
53
42
  */
54
43
  getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
55
44
  /**
@@ -21,7 +21,7 @@ class Order {
21
21
  *
22
22
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
23
23
  * @param {import("../PlatformAPIClient").Options} - Options
24
- * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
24
+ * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
25
25
  * - Success response
26
26
  *
27
27
  * @name getApplicationShipments
@@ -139,7 +139,7 @@ class Order {
139
139
 
140
140
  const {
141
141
  error: res_error,
142
- } = OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema().validate(
142
+ } = OrderPlatformModel.ShipmentInternalPlatformViewResponse().validate(
143
143
  responseData,
144
144
  { abortEarly: false, allowUnknown: true }
145
145
  );
@@ -164,8 +164,7 @@ class Order {
164
164
  *
165
165
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
166
166
  * @param {import("../PlatformAPIClient").Options} - Options
167
- * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
168
- * Success response
167
+ * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
169
168
  * @name getPlatformShipmentReasons
170
169
  * @summary: List shipment cancellation reasons
171
170
  * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
@@ -221,84 +220,7 @@ class Order {
221
220
 
222
221
  const {
223
222
  error: res_error,
224
- } = OrderPlatformModel.ShipmentReasonsResponseSchema().validate(
225
- responseData,
226
- { abortEarly: false, allowUnknown: true }
227
- );
228
-
229
- if (res_error) {
230
- if (this.config.options.strictResponseCheck === true) {
231
- return Promise.reject(new FDKResponseValidationError(res_error));
232
- } else {
233
- Logger({
234
- level: "WARN",
235
- message: `Response Validation Warnings for platform > Order > getPlatformShipmentReasons \n ${res_error}`,
236
- });
237
- }
238
- }
239
-
240
- return response;
241
- }
242
-
243
- /**
244
- * @param {OrderPlatformApplicationValidator.GetRulesParam} arg - Arg object
245
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
246
- * @param {import("../PlatformAPIClient").Options} - Options
247
- * @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
248
- * @name getRules
249
- * @summary: List of RMA rules based on the given input conditions.
250
- * @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRules/).
251
- */
252
- async getRules(
253
- { body, requestHeaders } = { requestHeaders: {} },
254
- { responseHeaders } = { responseHeaders: false }
255
- ) {
256
- const { error } = OrderPlatformApplicationValidator.getRules().validate(
257
- {
258
- body,
259
- },
260
- { abortEarly: false, allowUnknown: true }
261
- );
262
- if (error) {
263
- return Promise.reject(new FDKClientValidationError(error));
264
- }
265
-
266
- // Showing warrnings if extra unknown parameters are found
267
- const {
268
- error: warrning,
269
- } = OrderPlatformApplicationValidator.getRules().validate(
270
- {
271
- body,
272
- },
273
- { abortEarly: false, allowUnknown: false }
274
- );
275
- if (warrning) {
276
- Logger({
277
- level: "WARN",
278
- message: `Parameter Validation warrnings for platform > Order > getRules \n ${warrning}`,
279
- });
280
- }
281
-
282
- const query_params = {};
283
-
284
- const response = await PlatformAPIClient.execute(
285
- this.config,
286
- "post",
287
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/application/${this.applicationId}/rule_list`,
288
- query_params,
289
- body,
290
- requestHeaders,
291
- { responseHeaders }
292
- );
293
-
294
- let responseData = response;
295
- if (responseHeaders) {
296
- responseData = response[0];
297
- }
298
-
299
- const {
300
- error: res_error,
301
- } = OrderPlatformModel.RuleListResponseSchema().validate(responseData, {
223
+ } = OrderPlatformModel.ShipmentReasonsResponse().validate(responseData, {
302
224
  abortEarly: false,
303
225
  allowUnknown: true,
304
226
  });
@@ -309,7 +231,7 @@ class Order {
309
231
  } else {
310
232
  Logger({
311
233
  level: "WARN",
312
- message: `Response Validation Warnings for platform > Order > getRules \n ${res_error}`,
234
+ message: `Response Validation Warnings for platform > Order > getPlatformShipmentReasons \n ${res_error}`,
313
235
  });
314
236
  }
315
237
  }
@@ -325,8 +247,8 @@ class Order {
325
247
  * @param {import("../PlatformAPIClient").Options} - Options
326
248
  * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
327
249
  * @name getShipmentBagReasons
328
- * @summary: Retrieve Reasons for Cancellation and Return journey
329
- * @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
250
+ * @summary: List bag cancellation reasons
251
+ * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
330
252
  */
331
253
  async getShipmentBagReasons(
332
254
  { shipmentId, lineNumber, requestHeaders } = { requestHeaders: {} },
@@ -1,154 +1,83 @@
1
1
  export = OrderPlatformApplicationValidator;
2
2
  /**
3
3
  * @typedef GetApplicationShipmentsParam
4
- * @property {string} [lane] - Optional parameter to specify the lane for
5
- * filtering results.
6
- * @property {string} [searchType] - Search_type refers to the field that will
7
- * be used as the target for the search operation
8
- * @property {string} [searchId] - Identifier used for the search operation
9
- * based on the selected search type.
10
- * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
11
- * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
12
- * @property {string} [dpIds] - Comma-separated list of delivery partner IDs to
13
- * filter results.
14
- * @property {string} [orderingCompanyId] - ID of the company placing the order,
15
- * used for filtering results.
16
- * @property {string} [stores] - Comma-separated list of store IDs to filter results.
17
- * @property {string} [salesChannel] - The sales channel to filter results.
18
- * @property {string} [requestByExt] - Identifier for external requests.
19
- * @property {number} [pageNo] - The page number for pagination of results.
20
- * @property {number} [pageSize] - The number of results to return per page for
21
- * pagination.
22
- * @property {string} [customerId] - ID of the customer to filter results
23
- * related to specific customer.
24
- * @property {boolean} [isPrioritySort] - Flag to determine if results should be
25
- * sorted by priority. Defaults to true.
26
- * @property {boolean} [excludeLockedShipments] - Flag to exclude shipments that
27
- * are currently locked from the results.
4
+ * @property {string} [lane]
5
+ * @property {string} [searchType]
6
+ * @property {string} [searchId]
7
+ * @property {string} [fromDate]
8
+ * @property {string} [toDate]
9
+ * @property {string} [dpIds]
10
+ * @property {string} [orderingCompanyId]
11
+ * @property {string} [stores]
12
+ * @property {string} [salesChannel]
13
+ * @property {string} [requestByExt]
14
+ * @property {number} [pageNo]
15
+ * @property {number} [pageSize]
16
+ * @property {string} [customerId]
17
+ * @property {boolean} [isPrioritySort]
18
+ * @property {boolean} [excludeLockedShipments]
28
19
  */
29
20
  /**
30
21
  * @typedef GetPlatformShipmentReasonsParam
31
22
  * @property {string} action
32
23
  */
33
- /**
34
- * @typedef GetRulesParam
35
- * @property {OrderPlatformModel.RuleListRequestSchema} body
36
- */
37
24
  /**
38
25
  * @typedef GetShipmentBagReasonsParam
39
- * @property {string} shipmentId - The unique identifier for the shipment
40
- * @property {number} lineNumber - A unique identifier of the bag's line number.
26
+ * @property {string} shipmentId - ID of the bag. An order may contain multiple
27
+ * items and may get divided into one or more shipment, each having its own ID.
28
+ * @property {number} lineNumber - Line number of bag.
41
29
  */
42
30
  /**
43
31
  * @typedef TrackShipmentPlatformParam
44
- * @property {string} shipmentId - The unique identifier for the shipment
32
+ * @property {string} shipmentId - Shipment Id
45
33
  */
46
34
  declare class OrderPlatformApplicationValidator {
47
35
  /** @returns {GetApplicationShipmentsParam} */
48
36
  static getApplicationShipments(): GetApplicationShipmentsParam;
49
37
  /** @returns {GetPlatformShipmentReasonsParam} */
50
38
  static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam;
51
- /** @returns {GetRulesParam} */
52
- static getRules(): GetRulesParam;
53
39
  /** @returns {GetShipmentBagReasonsParam} */
54
40
  static getShipmentBagReasons(): GetShipmentBagReasonsParam;
55
41
  /** @returns {TrackShipmentPlatformParam} */
56
42
  static trackShipmentPlatform(): TrackShipmentPlatformParam;
57
43
  }
58
44
  declare namespace OrderPlatformApplicationValidator {
59
- export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
45
+ export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
60
46
  }
61
47
  type GetApplicationShipmentsParam = {
62
- /**
63
- * - Optional parameter to specify the lane for
64
- * filtering results.
65
- */
66
48
  lane?: string;
67
- /**
68
- * - Search_type refers to the field that will
69
- * be used as the target for the search operation
70
- */
71
49
  searchType?: string;
72
- /**
73
- * - Identifier used for the search operation
74
- * based on the selected search type.
75
- */
76
50
  searchId?: string;
77
- /**
78
- * - Date time in UTC timezone as per ISO format.
79
- */
80
51
  fromDate?: string;
81
- /**
82
- * - Date time in UTC timezone as per ISO format.
83
- */
84
52
  toDate?: string;
85
- /**
86
- * - Comma-separated list of delivery partner IDs to
87
- * filter results.
88
- */
89
53
  dpIds?: string;
90
- /**
91
- * - ID of the company placing the order,
92
- * used for filtering results.
93
- */
94
54
  orderingCompanyId?: string;
95
- /**
96
- * - Comma-separated list of store IDs to filter results.
97
- */
98
55
  stores?: string;
99
- /**
100
- * - The sales channel to filter results.
101
- */
102
56
  salesChannel?: string;
103
- /**
104
- * - Identifier for external requests.
105
- */
106
57
  requestByExt?: string;
107
- /**
108
- * - The page number for pagination of results.
109
- */
110
58
  pageNo?: number;
111
- /**
112
- * - The number of results to return per page for
113
- * pagination.
114
- */
115
59
  pageSize?: number;
116
- /**
117
- * - ID of the customer to filter results
118
- * related to specific customer.
119
- */
120
60
  customerId?: string;
121
- /**
122
- * - Flag to determine if results should be
123
- * sorted by priority. Defaults to true.
124
- */
125
61
  isPrioritySort?: boolean;
126
- /**
127
- * - Flag to exclude shipments that
128
- * are currently locked from the results.
129
- */
130
62
  excludeLockedShipments?: boolean;
131
63
  };
132
64
  type GetPlatformShipmentReasonsParam = {
133
65
  action: string;
134
66
  };
135
- type GetRulesParam = {
136
- body: OrderPlatformModel.RuleListRequestSchema;
137
- };
138
67
  type GetShipmentBagReasonsParam = {
139
68
  /**
140
- * - The unique identifier for the shipment
69
+ * - ID of the bag. An order may contain multiple
70
+ * items and may get divided into one or more shipment, each having its own ID.
141
71
  */
142
72
  shipmentId: string;
143
73
  /**
144
- * - A unique identifier of the bag's line number.
74
+ * - Line number of bag.
145
75
  */
146
76
  lineNumber: number;
147
77
  };
148
78
  type TrackShipmentPlatformParam = {
149
79
  /**
150
- * - The unique identifier for the shipment
80
+ * - Shipment Id
151
81
  */
152
82
  shipmentId: string;
153
83
  };
154
- import OrderPlatformModel = require("./OrderPlatformModel");
@@ -4,30 +4,21 @@ const OrderPlatformModel = require("./OrderPlatformModel");
4
4
 
5
5
  /**
6
6
  * @typedef GetApplicationShipmentsParam
7
- * @property {string} [lane] - Optional parameter to specify the lane for
8
- * filtering results.
9
- * @property {string} [searchType] - Search_type refers to the field that will
10
- * be used as the target for the search operation
11
- * @property {string} [searchId] - Identifier used for the search operation
12
- * based on the selected search type.
13
- * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
14
- * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
15
- * @property {string} [dpIds] - Comma-separated list of delivery partner IDs to
16
- * filter results.
17
- * @property {string} [orderingCompanyId] - ID of the company placing the order,
18
- * used for filtering results.
19
- * @property {string} [stores] - Comma-separated list of store IDs to filter results.
20
- * @property {string} [salesChannel] - The sales channel to filter results.
21
- * @property {string} [requestByExt] - Identifier for external requests.
22
- * @property {number} [pageNo] - The page number for pagination of results.
23
- * @property {number} [pageSize] - The number of results to return per page for
24
- * pagination.
25
- * @property {string} [customerId] - ID of the customer to filter results
26
- * related to specific customer.
27
- * @property {boolean} [isPrioritySort] - Flag to determine if results should be
28
- * sorted by priority. Defaults to true.
29
- * @property {boolean} [excludeLockedShipments] - Flag to exclude shipments that
30
- * are currently locked from the results.
7
+ * @property {string} [lane]
8
+ * @property {string} [searchType]
9
+ * @property {string} [searchId]
10
+ * @property {string} [fromDate]
11
+ * @property {string} [toDate]
12
+ * @property {string} [dpIds]
13
+ * @property {string} [orderingCompanyId]
14
+ * @property {string} [stores]
15
+ * @property {string} [salesChannel]
16
+ * @property {string} [requestByExt]
17
+ * @property {number} [pageNo]
18
+ * @property {number} [pageSize]
19
+ * @property {string} [customerId]
20
+ * @property {boolean} [isPrioritySort]
21
+ * @property {boolean} [excludeLockedShipments]
31
22
  */
32
23
 
33
24
  /**
@@ -35,20 +26,16 @@ const OrderPlatformModel = require("./OrderPlatformModel");
35
26
  * @property {string} action
36
27
  */
37
28
 
38
- /**
39
- * @typedef GetRulesParam
40
- * @property {OrderPlatformModel.RuleListRequestSchema} body
41
- */
42
-
43
29
  /**
44
30
  * @typedef GetShipmentBagReasonsParam
45
- * @property {string} shipmentId - The unique identifier for the shipment
46
- * @property {number} lineNumber - A unique identifier of the bag's line number.
31
+ * @property {string} shipmentId - ID of the bag. An order may contain multiple
32
+ * items and may get divided into one or more shipment, each having its own ID.
33
+ * @property {number} lineNumber - Line number of bag.
47
34
  */
48
35
 
49
36
  /**
50
37
  * @typedef TrackShipmentPlatformParam
51
- * @property {string} shipmentId - The unique identifier for the shipment
38
+ * @property {string} shipmentId - Shipment Id
52
39
  */
53
40
 
54
41
  class OrderPlatformApplicationValidator {
@@ -80,13 +67,6 @@ class OrderPlatformApplicationValidator {
80
67
  }).required();
81
68
  }
82
69
 
83
- /** @returns {GetRulesParam} */
84
- static getRules() {
85
- return Joi.object({
86
- body: OrderPlatformModel.RuleListRequestSchema().required(),
87
- }).required();
88
- }
89
-
90
70
  /** @returns {GetShipmentBagReasonsParam} */
91
71
  static getShipmentBagReasons() {
92
72
  return Joi.object({