@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.3.11-beta.8

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 (229) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
  4. package/sdk/application/Cart/CartApplicationClient.js +5 -3
  5. package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
  6. package/sdk/application/Cart/CartApplicationModel.js +74 -0
  7. package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
  8. package/sdk/application/Cart/CartApplicationValidator.js +4 -0
  9. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
  10. package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
  11. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
  12. package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
  13. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
  14. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
  15. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
  16. package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
  17. package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
  18. package/sdk/application/Content/ContentApplicationClient.js +246 -0
  19. package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
  20. package/sdk/application/Content/ContentApplicationModel.js +252 -0
  21. package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
  22. package/sdk/application/Content/ContentApplicationValidator.js +41 -0
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
  25. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
  26. package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
  27. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
  28. package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
  29. package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
  30. package/sdk/application/Order/OrderApplicationClient.js +32 -8
  31. package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
  32. package/sdk/application/Order/OrderApplicationModel.js +6 -0
  33. package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
  34. package/sdk/application/Order/OrderApplicationValidator.js +8 -0
  35. package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
  36. package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
  37. package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
  38. package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
  39. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
  40. package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
  41. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
  42. package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
  43. package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
  44. package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
  45. package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
  46. package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
  47. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
  48. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
  49. package/sdk/application/User/UserApplicationClient.d.ts +33 -0
  50. package/sdk/application/User/UserApplicationClient.js +239 -0
  51. package/sdk/application/User/UserApplicationModel.d.ts +28 -13
  52. package/sdk/application/User/UserApplicationModel.js +36 -12
  53. package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
  54. package/sdk/application/User/UserApplicationValidator.js +36 -0
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
  56. package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
  58. package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
  59. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
  60. package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
  61. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
  62. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
  63. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
  64. package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
  65. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
  66. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
  67. package/sdk/partner/PartnerClient.d.ts +6 -0
  68. package/sdk/partner/PartnerClient.js +9 -0
  69. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
  70. package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
  71. package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
  72. package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
  73. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
  74. package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
  75. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
  76. package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
  77. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
  78. package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
  79. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
  80. package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
  81. package/sdk/partner/index.d.ts +3 -0
  82. package/sdk/partner/index.js +6 -0
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
  84. package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
  85. package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
  86. package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
  87. package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
  88. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
  89. package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
  90. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
  91. package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
  92. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
  93. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
  94. package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
  95. package/sdk/platform/Cart/CartPlatformModel.js +71 -4
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
  97. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
  98. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
  100. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
  101. package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
  102. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
  103. package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
  104. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
  105. package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
  106. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
  110. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
  111. package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
  112. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
  113. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
  114. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
  118. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
  119. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
  120. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
  121. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
  122. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
  123. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
  124. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
  125. package/sdk/platform/Content/ContentPlatformApplicationClient.js +3630 -1059
  126. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +342 -1
  127. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +401 -0
  128. package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
  129. package/sdk/platform/Content/ContentPlatformClient.js +2000 -0
  130. package/sdk/platform/Content/ContentPlatformModel.d.ts +1094 -1
  131. package/sdk/platform/Content/ContentPlatformModel.js +1356 -46
  132. package/sdk/platform/Content/ContentPlatformValidator.d.ts +238 -0
  133. package/sdk/platform/Content/ContentPlatformValidator.js +310 -0
  134. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
  137. package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
  141. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -5
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +18 -4
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
  145. package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
  147. package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
  148. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
  149. package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
  150. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
  151. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
  152. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
  153. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
  154. package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
  155. package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
  156. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
  157. package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
  158. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
  159. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
  160. package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
  161. package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
  162. package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
  163. package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
  164. package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
  165. package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
  166. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
  167. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
  168. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
  169. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
  170. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
  171. package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
  172. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
  173. package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
  174. package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
  175. package/sdk/platform/PlatformApplicationClient.js +4 -4
  176. package/sdk/platform/PlatformClient.d.ts +4 -2
  177. package/sdk/platform/PlatformClient.js +8 -4
  178. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
  179. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
  180. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
  181. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
  182. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
  183. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
  188. package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
  189. package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
  190. package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
  191. package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
  192. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
  193. package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
  194. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
  195. package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
  196. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
  197. package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
  198. package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
  199. package/sdk/platform/User/UserPlatformModel.js +256 -5
  200. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
  201. package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
  202. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
  203. package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
  204. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
  205. package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
  206. package/sdk/platform/index.d.ts +1 -1
  207. package/sdk/platform/index.js +2 -2
  208. package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
  209. package/sdk/public/Billing/BillingPublicClient.js +116 -0
  210. package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
  211. package/sdk/public/Billing/BillingPublicModel.js +96 -0
  212. package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
  213. package/sdk/public/Billing/BillingPublicValidator.js +19 -0
  214. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  215. package/sdk/public/Content/ContentPublicClient.js +114 -0
  216. package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
  217. package/sdk/public/Content/ContentPublicModel.js +60 -0
  218. package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
  219. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  220. package/sdk/public/PublicClient.d.ts +4 -0
  221. package/sdk/public/PublicClient.js +8 -0
  222. package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
  223. package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
  224. package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
  225. package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
  226. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
  227. package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
  228. package/sdk/public/index.d.ts +2 -0
  229. package/sdk/public/index.js +4 -0
@@ -1,149 +1,352 @@
1
1
  export = ServiceabilityPlatformValidator;
2
+ /**
3
+ * @typedef BulkServiceabilityParam
4
+ * @property {string} extensionId - Unique Identifier of CP Extension
5
+ * @property {string} schemeId - Unique identifier of a scheme
6
+ * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
7
+ */
8
+ /**
9
+ * @typedef BulkTatParam
10
+ * @property {string} extensionId - Unique Identifier of CP Extension
11
+ * @property {string} schemeId - Unique identifier of a scheme
12
+ * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
13
+ */
14
+ /**
15
+ * @typedef CreateCourierPartnerAccountParam
16
+ * @property {ServiceabilityPlatformModel.CourierAccount} body
17
+ */
18
+ /**
19
+ * @typedef CreatePackageMaterialParam
20
+ * @property {ServiceabilityPlatformModel.PackageMaterial} body
21
+ */
22
+ /**
23
+ * @typedef CreatePackageMaterialRuleParam
24
+ * @property {ServiceabilityPlatformModel.PackageRule} body
25
+ */
2
26
  /**
3
27
  * @typedef CreateZoneParam
4
- * @property {ServiceabilityPlatformModel.ZoneRequest} body
28
+ * @property {ServiceabilityPlatformModel.CreateZoneData} body
5
29
  */
6
30
  /** @typedef GetAllStoresParam */
7
31
  /**
8
- * @typedef GetCompanyStoreViewParam
9
- * @property {number} [pageNumber] - Index of the item to start returning with
32
+ * @typedef GetBulkServiceabilityParam
33
+ * @property {string} extensionId - Unique Identifier of CP Extension
34
+ * @property {string} schemeId - Unique identifier of a scheme
35
+ * @property {number} [pageNo] - Index of the item to start returning with
10
36
  * @property {number} [pageSize] - Determines the items to be displayed in a page
37
+ * @property {string} [batchId] - Unique identifier of bulk job
38
+ * @property {string} [action] - Import or export bulk type
39
+ * @property {string} [status] - Status of the bulk actions
40
+ * @property {string} [country] - Country for which bulk job is initiated
41
+ * @property {string} [region] - Region for which bulk job is initiated
42
+ * @property {string} [startDate] - Fetch job history after a particule date
43
+ * @property {string} [endDate] - Fetch job history before a particule date
11
44
  */
12
45
  /**
13
- * @typedef GetDpAccountParam
14
- * @property {number} [pageNumber] - Index of the item to start returning with
46
+ * @typedef GetBulkTatParam
47
+ * @property {string} extensionId - Unique Identifier of CP Extension
48
+ * @property {string} schemeId - Unique identifier of a scheme
49
+ * @property {number} [pageNo] - Index of the item to start returning with
50
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
51
+ * @property {string} [batchId] - Unique identifier of bulk job
52
+ * @property {string} [action] - Import or export bulk type
53
+ * @property {string} [status] - Status of the bulk actions
54
+ * @property {string} [country] - Country for which bulk job is initiated
55
+ * @property {string} [region] - Region for which bulk job is initiated
56
+ * @property {string} [startDate] - Fetch job history after a particule date
57
+ * @property {string} [endDate] - Fetch job history before a particule date
58
+ */
59
+ /** @typedef GetCompanyConfigurationParam */
60
+ /**
61
+ * @typedef GetCourierPartnerAccountParam
62
+ * @property {string} accountId - Unique ID of courier account
63
+ */
64
+ /**
65
+ * @typedef GetCourierPartnerAccountsParam
66
+ * @property {number} [pageNo] - Index of the item to start returning with
15
67
  * @property {number} [pageSize] - Determines the items to be displayed in a page
16
68
  * @property {string} [stage] - Stage of the account. enabled/disabled
17
69
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
18
70
  * @property {string} [transportType] - Filters dp accounts based on transport_type
19
71
  */
20
- /** @typedef GetDpCompanyRulesParam */
21
72
  /**
22
- * @typedef GetDpRuleInsertParam
23
- * @property {number} [pageNumber] - Index of the item to start returning with
24
- * @property {number} [pageSize] - Determines the items to be displayed in a page
73
+ * @typedef GetOptimalLocationsParam
74
+ * @property {ServiceabilityPlatformModel.ReAssignStoreRequest} body
25
75
  */
26
76
  /**
27
- * @typedef GetDpRulesParam
28
- * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
77
+ * @typedef GetPackageMaterialListParam
78
+ * @property {number} [pageNo] - Index of the item to start returning with
79
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
80
+ * @property {string} [q] - Perform regex search on items matching name for given value
81
+ * @property {string} [size] - Filters items based on given size
82
+ * @property {string} [packageType] - Filters items based on given package_type
29
83
  */
30
84
  /**
31
- * @typedef GetEntityRegionViewParam
32
- * @property {ServiceabilityPlatformModel.EntityRegionView_Request} body
85
+ * @typedef GetPackageMaterialRuleParam
86
+ * @property {string} ruleId - A `package_material_rule_id` is a unique
87
+ * identifier for a Package Material Rule
33
88
  */
34
89
  /**
35
- * @typedef GetListViewParam
36
- * @property {number} [pageNumber] - Index of the item to start returning with
90
+ * @typedef GetPackageMaterialRulesParam
91
+ * @property {number} [pageNo] - Index of the item to start returning with
37
92
  * @property {number} [pageSize] - Determines the items to be displayed in a page
38
- * @property {string} [name] - Name of particular zone in the seller account
39
- * @property {boolean} [isActive] - Status of zone whether active or inactive
40
- * @property {string} [channelIds] - Zones associated with the given channel ids'
41
- * @property {string} [q] - Search with name as a free text
93
+ * @property {string} [isActive] - Filters items based on given is_active
42
94
  */
43
95
  /**
44
- * @typedef GetOptimalLocationsParam
45
- * @property {ServiceabilityPlatformModel.ReAssignStoreRequest} body
96
+ * @typedef GetPackageMaterialsParam
97
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
98
+ * identifier for a Package Material
46
99
  */
47
100
  /**
48
- * @typedef GetStoreParam
49
- * @property {number} storeUid - A `store_uid` contains a specific ID of a store.
101
+ * @typedef GetServiceabilityParam
102
+ * @property {string} extensionId - Unique Identifier of CP Extension
103
+ * @property {string} schemeId - Unique identifier of a scheme
104
+ * @property {string} regionId - Unique identifier of a region
50
105
  */
51
106
  /**
52
- * @typedef GetZoneDataViewParam
107
+ * @typedef GetZoneByIdParam
53
108
  * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
54
109
  */
55
110
  /**
56
- * @typedef GetZoneListViewParam
57
- * @property {number} [pageNumber] - Index of the item to start returning with
111
+ * @typedef GetZonesParam
58
112
  * @property {number} [pageNo] - Index of the item to start returning with
59
113
  * @property {number} [pageSize] - Determines the items to be displayed in a page
60
- * @property {string} [name] - Name of particular zone in the seller account
61
- * @property {boolean} [isActive] - Status of zone whether active or inactive
62
- * @property {string} [channelIds] - Zones associated with the given channel ids'
114
+ * @property {boolean} [isActive] - Status of Zone (either active or inactive)
115
+ * @property {string} [channelId] - Zones filtered by an application
63
116
  * @property {string} [q] - Search with name as a free text
64
- * @property {string[]} [zoneId] - List of zones to query for
117
+ * @property {string} [country] - ISO2 code of the country
118
+ * @property {string} [state] - State name
119
+ * @property {string} [city] - City name
120
+ * @property {string} [pincode] - Pincode value to search zones
121
+ * @property {string} [sector] - Sector value to search zones
65
122
  */
66
123
  /**
67
- * @typedef UpdateDpRuleParam
68
- * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
69
- * @property {ServiceabilityPlatformModel.DpRulesUpdateRequest} body
124
+ * @typedef UpdateCompanyConfigurationParam
125
+ * @property {ServiceabilityPlatformModel.CompanyConfig} body
70
126
  */
71
127
  /**
72
- * @typedef UpdateZoneControllerViewParam
73
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
74
- * @property {ServiceabilityPlatformModel.ZoneUpdateRequest} body
128
+ * @typedef UpdateCourierPartnerAccountParam
129
+ * @property {string} accountId - Unique ID of courier account
130
+ * @property {ServiceabilityPlatformModel.CourierAccount} body
75
131
  */
76
132
  /**
77
- * @typedef UpsertDpAccountParam
78
- * @property {ServiceabilityPlatformModel.CompanyDpAccountRequest} body
133
+ * @typedef UpdatePackageMaterialRuleParam
134
+ * @property {string} ruleId - A `package_material_rule_id` is a unique
135
+ * identifier for a Package Material Rule
136
+ * @property {ServiceabilityPlatformModel.PackageRule} body
79
137
  */
80
138
  /**
81
- * @typedef UpsertDpCompanyRulesParam
82
- * @property {ServiceabilityPlatformModel.DPCompanyRuleRequest} body
139
+ * @typedef UpdatePackageMaterialsParam
140
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
141
+ * identifier for a Package Material
142
+ * @property {ServiceabilityPlatformModel.PackageMaterial} body
83
143
  */
84
144
  /**
85
- * @typedef UpsertDpRulesParam
86
- * @property {ServiceabilityPlatformModel.DpRuleRequest} body
145
+ * @typedef UpdateServiceabilityParam
146
+ * @property {string} extensionId - Unique Identifier of CP Extension
147
+ * @property {string} schemeId - Unique identifier of a scheme
148
+ * @property {string} regionId - Unique identifier of a region
149
+ * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
150
+ */
151
+ /**
152
+ * @typedef UpdateZoneByIdParam
153
+ * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
154
+ * @property {ServiceabilityPlatformModel.UpdateZoneData} body
87
155
  */
88
156
  declare class ServiceabilityPlatformValidator {
157
+ /** @returns {BulkServiceabilityParam} */
158
+ static bulkServiceability(): BulkServiceabilityParam;
159
+ /** @returns {BulkTatParam} */
160
+ static bulkTat(): BulkTatParam;
161
+ /** @returns {CreateCourierPartnerAccountParam} */
162
+ static createCourierPartnerAccount(): CreateCourierPartnerAccountParam;
163
+ /** @returns {CreatePackageMaterialParam} */
164
+ static createPackageMaterial(): CreatePackageMaterialParam;
165
+ /** @returns {CreatePackageMaterialRuleParam} */
166
+ static createPackageMaterialRule(): CreatePackageMaterialRuleParam;
89
167
  /** @returns {CreateZoneParam} */
90
168
  static createZone(): CreateZoneParam;
91
169
  /** @returns {GetAllStoresParam} */
92
170
  static getAllStores(): any;
93
- /** @returns {GetCompanyStoreViewParam} */
94
- static getCompanyStoreView(): GetCompanyStoreViewParam;
95
- /** @returns {GetDpAccountParam} */
96
- static getDpAccount(): GetDpAccountParam;
97
- /** @returns {GetDpCompanyRulesParam} */
98
- static getDpCompanyRules(): any;
99
- /** @returns {GetDpRuleInsertParam} */
100
- static getDpRuleInsert(): GetDpRuleInsertParam;
101
- /** @returns {GetDpRulesParam} */
102
- static getDpRules(): GetDpRulesParam;
103
- /** @returns {GetEntityRegionViewParam} */
104
- static getEntityRegionView(): GetEntityRegionViewParam;
105
- /** @returns {GetListViewParam} */
106
- static getListView(): GetListViewParam;
171
+ /** @returns {GetBulkServiceabilityParam} */
172
+ static getBulkServiceability(): GetBulkServiceabilityParam;
173
+ /** @returns {GetBulkTatParam} */
174
+ static getBulkTat(): GetBulkTatParam;
175
+ /** @returns {GetCompanyConfigurationParam} */
176
+ static getCompanyConfiguration(): any;
177
+ /** @returns {GetCourierPartnerAccountParam} */
178
+ static getCourierPartnerAccount(): GetCourierPartnerAccountParam;
179
+ /** @returns {GetCourierPartnerAccountsParam} */
180
+ static getCourierPartnerAccounts(): GetCourierPartnerAccountsParam;
107
181
  /** @returns {GetOptimalLocationsParam} */
108
182
  static getOptimalLocations(): GetOptimalLocationsParam;
109
- /** @returns {GetStoreParam} */
110
- static getStore(): GetStoreParam;
111
- /** @returns {GetZoneDataViewParam} */
112
- static getZoneDataView(): GetZoneDataViewParam;
113
- /** @returns {GetZoneListViewParam} */
114
- static getZoneListView(): GetZoneListViewParam;
115
- /** @returns {UpdateDpRuleParam} */
116
- static updateDpRule(): UpdateDpRuleParam;
117
- /** @returns {UpdateZoneControllerViewParam} */
118
- static updateZoneControllerView(): UpdateZoneControllerViewParam;
119
- /** @returns {UpsertDpAccountParam} */
120
- static upsertDpAccount(): UpsertDpAccountParam;
121
- /** @returns {UpsertDpCompanyRulesParam} */
122
- static upsertDpCompanyRules(): UpsertDpCompanyRulesParam;
123
- /** @returns {UpsertDpRulesParam} */
124
- static upsertDpRules(): UpsertDpRulesParam;
183
+ /** @returns {GetPackageMaterialListParam} */
184
+ static getPackageMaterialList(): GetPackageMaterialListParam;
185
+ /** @returns {GetPackageMaterialRuleParam} */
186
+ static getPackageMaterialRule(): GetPackageMaterialRuleParam;
187
+ /** @returns {GetPackageMaterialRulesParam} */
188
+ static getPackageMaterialRules(): GetPackageMaterialRulesParam;
189
+ /** @returns {GetPackageMaterialsParam} */
190
+ static getPackageMaterials(): GetPackageMaterialsParam;
191
+ /** @returns {GetServiceabilityParam} */
192
+ static getServiceability(): GetServiceabilityParam;
193
+ /** @returns {GetZoneByIdParam} */
194
+ static getZoneById(): GetZoneByIdParam;
195
+ /** @returns {GetZonesParam} */
196
+ static getZones(): GetZonesParam;
197
+ /** @returns {UpdateCompanyConfigurationParam} */
198
+ static updateCompanyConfiguration(): UpdateCompanyConfigurationParam;
199
+ /** @returns {UpdateCourierPartnerAccountParam} */
200
+ static updateCourierPartnerAccount(): UpdateCourierPartnerAccountParam;
201
+ /** @returns {UpdatePackageMaterialRuleParam} */
202
+ static updatePackageMaterialRule(): UpdatePackageMaterialRuleParam;
203
+ /** @returns {UpdatePackageMaterialsParam} */
204
+ static updatePackageMaterials(): UpdatePackageMaterialsParam;
205
+ /** @returns {UpdateServiceabilityParam} */
206
+ static updateServiceability(): UpdateServiceabilityParam;
207
+ /** @returns {UpdateZoneByIdParam} */
208
+ static updateZoneById(): UpdateZoneByIdParam;
125
209
  }
126
210
  declare namespace ServiceabilityPlatformValidator {
127
- export { CreateZoneParam, GetAllStoresParam, GetCompanyStoreViewParam, GetDpAccountParam, GetDpCompanyRulesParam, GetDpRuleInsertParam, GetDpRulesParam, GetEntityRegionViewParam, GetListViewParam, GetOptimalLocationsParam, GetStoreParam, GetZoneDataViewParam, GetZoneListViewParam, UpdateDpRuleParam, UpdateZoneControllerViewParam, UpsertDpAccountParam, UpsertDpCompanyRulesParam, UpsertDpRulesParam };
211
+ export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
128
212
  }
213
+ type BulkServiceabilityParam = {
214
+ /**
215
+ * - Unique Identifier of CP Extension
216
+ */
217
+ extensionId: string;
218
+ /**
219
+ * - Unique identifier of a scheme
220
+ */
221
+ schemeId: string;
222
+ body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
223
+ };
224
+ type BulkTatParam = {
225
+ /**
226
+ * - Unique Identifier of CP Extension
227
+ */
228
+ extensionId: string;
229
+ /**
230
+ * - Unique identifier of a scheme
231
+ */
232
+ schemeId: string;
233
+ body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
234
+ };
235
+ type CreateCourierPartnerAccountParam = {
236
+ body: ServiceabilityPlatformModel.CourierAccount;
237
+ };
238
+ type CreatePackageMaterialParam = {
239
+ body: ServiceabilityPlatformModel.PackageMaterial;
240
+ };
241
+ type CreatePackageMaterialRuleParam = {
242
+ body: ServiceabilityPlatformModel.PackageRule;
243
+ };
129
244
  type CreateZoneParam = {
130
- body: ServiceabilityPlatformModel.ZoneRequest;
245
+ body: ServiceabilityPlatformModel.CreateZoneData;
246
+ };
247
+ type GetBulkServiceabilityParam = {
248
+ /**
249
+ * - Unique Identifier of CP Extension
250
+ */
251
+ extensionId: string;
252
+ /**
253
+ * - Unique identifier of a scheme
254
+ */
255
+ schemeId: string;
256
+ /**
257
+ * - Index of the item to start returning with
258
+ */
259
+ pageNo?: number;
260
+ /**
261
+ * - Determines the items to be displayed in a page
262
+ */
263
+ pageSize?: number;
264
+ /**
265
+ * - Unique identifier of bulk job
266
+ */
267
+ batchId?: string;
268
+ /**
269
+ * - Import or export bulk type
270
+ */
271
+ action?: string;
272
+ /**
273
+ * - Status of the bulk actions
274
+ */
275
+ status?: string;
276
+ /**
277
+ * - Country for which bulk job is initiated
278
+ */
279
+ country?: string;
280
+ /**
281
+ * - Region for which bulk job is initiated
282
+ */
283
+ region?: string;
284
+ /**
285
+ * - Fetch job history after a particule date
286
+ */
287
+ startDate?: string;
288
+ /**
289
+ * - Fetch job history before a particule date
290
+ */
291
+ endDate?: string;
131
292
  };
132
- type GetCompanyStoreViewParam = {
293
+ type GetBulkTatParam = {
294
+ /**
295
+ * - Unique Identifier of CP Extension
296
+ */
297
+ extensionId: string;
298
+ /**
299
+ * - Unique identifier of a scheme
300
+ */
301
+ schemeId: string;
133
302
  /**
134
303
  * - Index of the item to start returning with
135
304
  */
136
- pageNumber?: number;
305
+ pageNo?: number;
137
306
  /**
138
307
  * - Determines the items to be displayed in a page
139
308
  */
140
309
  pageSize?: number;
310
+ /**
311
+ * - Unique identifier of bulk job
312
+ */
313
+ batchId?: string;
314
+ /**
315
+ * - Import or export bulk type
316
+ */
317
+ action?: string;
318
+ /**
319
+ * - Status of the bulk actions
320
+ */
321
+ status?: string;
322
+ /**
323
+ * - Country for which bulk job is initiated
324
+ */
325
+ country?: string;
326
+ /**
327
+ * - Region for which bulk job is initiated
328
+ */
329
+ region?: string;
330
+ /**
331
+ * - Fetch job history after a particule date
332
+ */
333
+ startDate?: string;
334
+ /**
335
+ * - Fetch job history before a particule date
336
+ */
337
+ endDate?: string;
141
338
  };
142
- type GetDpAccountParam = {
339
+ type GetCourierPartnerAccountParam = {
340
+ /**
341
+ * - Unique ID of courier account
342
+ */
343
+ accountId: string;
344
+ };
345
+ type GetCourierPartnerAccountsParam = {
143
346
  /**
144
347
  * - Index of the item to start returning with
145
348
  */
146
- pageNumber?: number;
349
+ pageNo?: number;
147
350
  /**
148
351
  * - Determines the items to be displayed in a page
149
352
  */
@@ -161,71 +364,80 @@ type GetDpAccountParam = {
161
364
  */
162
365
  transportType?: string;
163
366
  };
164
- type GetDpRuleInsertParam = {
367
+ type GetOptimalLocationsParam = {
368
+ body: ServiceabilityPlatformModel.ReAssignStoreRequest;
369
+ };
370
+ type GetPackageMaterialListParam = {
165
371
  /**
166
372
  * - Index of the item to start returning with
167
373
  */
168
- pageNumber?: number;
374
+ pageNo?: number;
169
375
  /**
170
376
  * - Determines the items to be displayed in a page
171
377
  */
172
378
  pageSize?: number;
173
- };
174
- type GetDpRulesParam = {
175
379
  /**
176
- * - A `rule_uid` is a unique identifier for a particular Dp.
380
+ * - Perform regex search on items matching name for given value
177
381
  */
178
- ruleUid: string;
382
+ q?: string;
383
+ /**
384
+ * - Filters items based on given size
385
+ */
386
+ size?: string;
387
+ /**
388
+ * - Filters items based on given package_type
389
+ */
390
+ packageType?: string;
179
391
  };
180
- type GetEntityRegionViewParam = {
181
- body: ServiceabilityPlatformModel.EntityRegionView_Request;
392
+ type GetPackageMaterialRuleParam = {
393
+ /**
394
+ * - A `package_material_rule_id` is a unique
395
+ * identifier for a Package Material Rule
396
+ */
397
+ ruleId: string;
182
398
  };
183
- type GetListViewParam = {
399
+ type GetPackageMaterialRulesParam = {
184
400
  /**
185
401
  * - Index of the item to start returning with
186
402
  */
187
- pageNumber?: number;
403
+ pageNo?: number;
188
404
  /**
189
405
  * - Determines the items to be displayed in a page
190
406
  */
191
407
  pageSize?: number;
192
408
  /**
193
- * - Name of particular zone in the seller account
409
+ * - Filters items based on given is_active
194
410
  */
195
- name?: string;
411
+ isActive?: string;
412
+ };
413
+ type GetPackageMaterialsParam = {
196
414
  /**
197
- * - Status of zone whether active or inactive
415
+ * - A `package_material_id` is a unique
416
+ * identifier for a Package Material
198
417
  */
199
- isActive?: boolean;
418
+ packageMaterialId: string;
419
+ };
420
+ type GetServiceabilityParam = {
200
421
  /**
201
- * - Zones associated with the given channel ids'
422
+ * - Unique Identifier of CP Extension
202
423
  */
203
- channelIds?: string;
424
+ extensionId: string;
204
425
  /**
205
- * - Search with name as a free text
426
+ * - Unique identifier of a scheme
206
427
  */
207
- q?: string;
208
- };
209
- type GetOptimalLocationsParam = {
210
- body: ServiceabilityPlatformModel.ReAssignStoreRequest;
211
- };
212
- type GetStoreParam = {
428
+ schemeId: string;
213
429
  /**
214
- * - A `store_uid` contains a specific ID of a store.
430
+ * - Unique identifier of a region
215
431
  */
216
- storeUid: number;
432
+ regionId: string;
217
433
  };
218
- type GetZoneDataViewParam = {
434
+ type GetZoneByIdParam = {
219
435
  /**
220
436
  * - A `zone_id` is a unique identifier for a particular zone.
221
437
  */
222
438
  zoneId: string;
223
439
  };
224
- type GetZoneListViewParam = {
225
- /**
226
- * - Index of the item to start returning with
227
- */
228
- pageNumber?: number;
440
+ type GetZonesParam = {
229
441
  /**
230
442
  * - Index of the item to start returning with
231
443
  */
@@ -235,49 +447,86 @@ type GetZoneListViewParam = {
235
447
  */
236
448
  pageSize?: number;
237
449
  /**
238
- * - Name of particular zone in the seller account
239
- */
240
- name?: string;
241
- /**
242
- * - Status of zone whether active or inactive
450
+ * - Status of Zone (either active or inactive)
243
451
  */
244
452
  isActive?: boolean;
245
453
  /**
246
- * - Zones associated with the given channel ids'
454
+ * - Zones filtered by an application
247
455
  */
248
- channelIds?: string;
456
+ channelId?: string;
249
457
  /**
250
458
  * - Search with name as a free text
251
459
  */
252
460
  q?: string;
253
461
  /**
254
- * - List of zones to query for
462
+ * - ISO2 code of the country
463
+ */
464
+ country?: string;
465
+ /**
466
+ * - State name
467
+ */
468
+ state?: string;
469
+ /**
470
+ * - City name
471
+ */
472
+ city?: string;
473
+ /**
474
+ * - Pincode value to search zones
475
+ */
476
+ pincode?: string;
477
+ /**
478
+ * - Sector value to search zones
255
479
  */
256
- zoneId?: string[];
480
+ sector?: string;
257
481
  };
258
- type UpdateDpRuleParam = {
482
+ type UpdateCompanyConfigurationParam = {
483
+ body: ServiceabilityPlatformModel.CompanyConfig;
484
+ };
485
+ type UpdateCourierPartnerAccountParam = {
259
486
  /**
260
- * - A `rule_uid` is a unique identifier for a particular Dp.
487
+ * - Unique ID of courier account
261
488
  */
262
- ruleUid: string;
263
- body: ServiceabilityPlatformModel.DpRulesUpdateRequest;
489
+ accountId: string;
490
+ body: ServiceabilityPlatformModel.CourierAccount;
264
491
  };
265
- type UpdateZoneControllerViewParam = {
492
+ type UpdatePackageMaterialRuleParam = {
266
493
  /**
267
- * - A `zone_id` is a unique identifier for a particular zone.
494
+ * - A `package_material_rule_id` is a unique
495
+ * identifier for a Package Material Rule
268
496
  */
269
- zoneId: string;
270
- body: ServiceabilityPlatformModel.ZoneUpdateRequest;
497
+ ruleId: string;
498
+ body: ServiceabilityPlatformModel.PackageRule;
271
499
  };
272
- type UpsertDpAccountParam = {
273
- body: ServiceabilityPlatformModel.CompanyDpAccountRequest;
500
+ type UpdatePackageMaterialsParam = {
501
+ /**
502
+ * - A `package_material_id` is a unique
503
+ * identifier for a Package Material
504
+ */
505
+ packageMaterialId: string;
506
+ body: ServiceabilityPlatformModel.PackageMaterial;
274
507
  };
275
- type UpsertDpCompanyRulesParam = {
276
- body: ServiceabilityPlatformModel.DPCompanyRuleRequest;
508
+ type UpdateServiceabilityParam = {
509
+ /**
510
+ * - Unique Identifier of CP Extension
511
+ */
512
+ extensionId: string;
513
+ /**
514
+ * - Unique identifier of a scheme
515
+ */
516
+ schemeId: string;
517
+ /**
518
+ * - Unique identifier of a region
519
+ */
520
+ regionId: string;
521
+ body: ServiceabilityPlatformModel.ServiceabilityModel;
277
522
  };
278
- type UpsertDpRulesParam = {
279
- body: ServiceabilityPlatformModel.DpRuleRequest;
523
+ type UpdateZoneByIdParam = {
524
+ /**
525
+ * - A `zone_id` is a unique identifier for a particular zone.
526
+ */
527
+ zoneId: string;
528
+ body: ServiceabilityPlatformModel.UpdateZoneData;
280
529
  };
281
530
  type GetAllStoresParam = any;
282
- type GetDpCompanyRulesParam = any;
531
+ type GetCompanyConfigurationParam = any;
283
532
  import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");