@gofynd/fdk-client-javascript 1.4.3 → 1.4.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 (193) hide show
  1. package/README.md +1 -10
  2. package/application.d.ts +3 -3
  3. package/common.d.ts +3 -3
  4. package/index.d.ts +15 -15
  5. package/package.json +1 -1
  6. package/partner.d.ts +3 -3
  7. package/platform.d.ts +3 -3
  8. package/public.d.ts +2 -2
  9. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  10. package/sdk/application/ApplicationClient.d.ts +17 -17
  11. package/sdk/application/ApplicationConfig.d.ts +3 -3
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +50 -50
  13. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  14. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
  15. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
  16. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
  18. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  19. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
  20. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  21. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  22. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
  23. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  24. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
  25. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
  26. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  27. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
  28. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  29. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  30. package/sdk/application/Lead/LeadApplicationClient.d.ts +11 -11
  31. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  32. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
  33. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
  34. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  35. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
  36. package/sdk/application/Order/OrderApplicationClient.d.ts +16 -27
  37. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  38. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
  39. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  40. package/sdk/application/Payment/PaymentApplicationClient.d.ts +73 -73
  41. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  42. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +1 -1
  43. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +2 -2
  44. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
  45. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +3 -3
  46. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  47. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
  48. package/sdk/application/Share/ShareApplicationClient.d.ts +3 -3
  49. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  50. package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
  51. package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
  52. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  53. package/sdk/application/User/UserApplicationClient.d.ts +76 -76
  54. package/sdk/application/User/UserApplicationClient.js +74 -74
  55. package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
  56. package/sdk/application/index.d.ts +18 -18
  57. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -1
  58. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
  60. package/sdk/partner/OAuthClient.d.ts +4 -4
  61. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  62. package/sdk/partner/PartnerClient.d.ts +6 -6
  63. package/sdk/partner/PartnerConfig.d.ts +4 -4
  64. package/sdk/partner/Theme/ThemePartnerClient.d.ts +1 -1
  65. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +1 -1
  66. package/sdk/partner/index.d.ts +7 -7
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +7 -7
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  70. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  71. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  72. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +104 -104
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  75. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
  76. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +135 -134
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
  79. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +133 -133
  80. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  81. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
  82. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -4
  83. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  84. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +120 -120
  85. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  86. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
  87. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -3
  88. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  89. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +25 -25
  90. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  91. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
  92. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +43 -43
  93. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  94. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
  95. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +28 -28
  96. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  97. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
  98. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +96 -96
  99. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  100. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -1
  101. package/sdk/platform/Content/ContentPlatformClient.d.ts +31 -31
  102. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  103. package/sdk/platform/Content/ContentPlatformValidator.d.ts +1 -1
  104. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +20 -20
  105. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  106. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
  107. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -19
  108. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  110. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  113. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
  114. package/sdk/platform/Finance/FinancePlatformClient.d.ts +6 -6
  115. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  116. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
  117. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +14 -14
  118. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  119. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
  120. package/sdk/platform/Lead/LeadPlatformClient.d.ts +17 -17
  121. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  122. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
  123. package/sdk/platform/OAuthClient.d.ts +3 -3
  124. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
  125. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  126. package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -108
  127. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  128. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  129. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  130. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
  131. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  132. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
  133. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  134. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
  135. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +79 -79
  136. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  137. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
  138. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +4 -4
  139. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  140. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  141. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  142. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
  143. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  144. package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
  145. package/sdk/platform/PlatformClient.d.ts +19 -21
  146. package/sdk/platform/PlatformClient.js +0 -4
  147. package/sdk/platform/PlatformConfig.d.ts +4 -4
  148. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +9 -9
  149. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  150. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  151. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
  152. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  153. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
  154. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -52
  155. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  156. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
  157. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
  158. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  159. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  160. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  161. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  162. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -106
  163. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  164. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
  165. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  166. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
  167. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  168. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
  169. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
  170. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  171. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
  172. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -8
  173. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  174. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
  175. package/sdk/platform/index.d.ts +24 -25
  176. package/sdk/platform/index.js +0 -2
  177. package/sdk/public/Billing/BillingPublicClient.d.ts +2 -2
  178. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  179. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  180. package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
  181. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
  182. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  183. package/sdk/public/PublicAPIClient.d.ts +1 -1
  184. package/sdk/public/PublicClient.d.ts +7 -7
  185. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  186. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
  187. package/sdk/public/index.d.ts +8 -8
  188. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  189. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  190. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  191. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  192. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  193. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -24,8 +24,8 @@ class Serviceability {
24
24
  * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
25
25
  * Success response
26
26
  * @name createCourierPartnerRule
27
- * @summary: Create Courier Rules
28
- * @description: Creates Courier Rules with rule configuration and dp priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerRule/).
27
+ * @summary: Create rourier rule
28
+ * @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerRule/).
29
29
  */
30
30
  async createCourierPartnerRule(
31
31
  { body, requestHeaders } = { requestHeaders: {} },
@@ -107,8 +107,8 @@ class Serviceability {
107
107
  * - Success response
108
108
  *
109
109
  * @name createStoreRules
110
- * @summary: Create Store Rule
111
- * @description: Create Store Rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createStoreRules/).
110
+ * @summary: Create store rule
111
+ * @description: Create a rule within the order routing rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createStoreRules/).
112
112
  */
113
113
  async createStoreRules(
114
114
  { body, requestHeaders } = { requestHeaders: {} },
@@ -189,8 +189,8 @@ class Serviceability {
189
189
  * @returns {Promise<ServiceabilityPlatformModel.StoreRuleConfigData>} -
190
190
  * Success response
191
191
  * @name getApplicationConfig
192
- * @summary: Get Application Configuration
193
- * @description: Get Application Configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationConfig/).
192
+ * @summary: Get store rule configuration
193
+ * @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationConfig/).
194
194
  */
195
195
  async getApplicationConfig(
196
196
  { requestHeaders } = { requestHeaders: {} },
@@ -267,8 +267,8 @@ class Serviceability {
267
267
  * @returns {Promise<ServiceabilityPlatformModel.ApplicationConfig>} -
268
268
  * Success response
269
269
  * @name getApplicationConfiguration
270
- * @summary: Get All Courier Rules applied to application
271
- * @description: This API returns all the Courier Rules applied to an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationConfiguration/).
270
+ * @summary: Get delivery configuration
271
+ * @description: Retrieves information about the delivery setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationConfiguration/).
272
272
  */
273
273
  async getApplicationConfiguration(
274
274
  { requestHeaders } = { requestHeaders: {} },
@@ -346,8 +346,8 @@ class Serviceability {
346
346
  * - Success response
347
347
  *
348
348
  * @name getApplicationServiceabilitySelfShipment
349
- * @summary: Self-ship configuration of application
350
- * @description: This API returns Self-ship configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationServiceabilitySelfShipment/).
349
+ * @summary: Get self ship configuration
350
+ * @description: Retrieves the self ship setup for a single application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationServiceabilitySelfShipment/).
351
351
  */
352
352
  async getApplicationServiceabilitySelfShipment(
353
353
  { requestHeaders } = { requestHeaders: {} },
@@ -424,8 +424,8 @@ class Serviceability {
424
424
  * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
425
425
  * Success response
426
426
  * @name getCourierPartnerRule
427
- * @summary: Fetch of Courier Rule
428
- * @description: This API returns Courier Rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRule/).
427
+ * @summary: Get courier rule
428
+ * @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRule/).
429
429
  */
430
430
  async getCourierPartnerRule(
431
431
  { ruleId, requestHeaders } = { requestHeaders: {} },
@@ -507,8 +507,8 @@ class Serviceability {
507
507
  * - Success response
508
508
  *
509
509
  * @name getCourierPartnerRules
510
- * @summary: Fetch Courier Rules List
511
- * @description: This API returns Courier Rules List - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRules/).
510
+ * @summary: Get courier rules
511
+ * @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRules/).
512
512
  */
513
513
  async getCourierPartnerRules(
514
514
  { pageNo, pageSize, status, requestHeaders } = { requestHeaders: {} },
@@ -596,8 +596,8 @@ class Serviceability {
596
596
  * @returns {Promise<ServiceabilityPlatformModel.StoreRuleDataSchema>} -
597
597
  * Success response
598
598
  * @name getStoreRule
599
- * @summary: Get Single Store Rule
600
- * @description: Get Single Store Rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getStoreRule/).
599
+ * @summary: Get store rule
600
+ * @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getStoreRule/).
601
601
  */
602
602
  async getStoreRule(
603
603
  { ruleUid, requestHeaders } = { requestHeaders: {} },
@@ -679,8 +679,8 @@ class Serviceability {
679
679
  * - Success response
680
680
  *
681
681
  * @name getStoreRules
682
- * @summary: Get Multiple Store Rules
683
- * @description: Get Multiple Store Rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getStoreRules/).
682
+ * @summary: Get store rules
683
+ * @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getStoreRules/).
684
684
  */
685
685
  async getStoreRules(
686
686
  { pageNo, pageSize, status, requestHeaders } = { requestHeaders: {} },
@@ -768,8 +768,8 @@ class Serviceability {
768
768
  * @returns {Promise<ServiceabilityPlatformModel.StoreRuleConfigData>} -
769
769
  * Success response
770
770
  * @name insertApplicationConfig
771
- * @summary: Insert Application Configuration
772
- * @description: Insert Application Configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/insertApplicationConfig/).
771
+ * @summary: Create store rule configuration
772
+ * @description: Creates a order routing setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/insertApplicationConfig/).
773
773
  */
774
774
  async insertApplicationConfig(
775
775
  { body, requestHeaders } = { requestHeaders: {} },
@@ -851,8 +851,8 @@ class Serviceability {
851
851
  * - Success response
852
852
  *
853
853
  * @name patchApplicationServiceabilitySelfShipment
854
- * @summary: Self-ship configuration of application
855
- * @description: This API updates Self-ship configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/patchApplicationServiceabilitySelfShipment/).
854
+ * @summary: Update self ship configuration
855
+ * @description: Updates self ship setup for an existing application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/patchApplicationServiceabilitySelfShipment/).
856
856
  */
857
857
  async patchApplicationServiceabilitySelfShipment(
858
858
  { body, requestHeaders } = { requestHeaders: {} },
@@ -933,8 +933,8 @@ class Serviceability {
933
933
  * @returns {Promise<ServiceabilityPlatformModel.ApplicationConfig>} -
934
934
  * Success response
935
935
  * @name updateApplicationConfiguration
936
- * @summary: Apply configuration to an application
937
- * @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateApplicationConfiguration/).
936
+ * @summary: Update delivery configuration
937
+ * @description: Updates an existing delivery setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateApplicationConfiguration/).
938
938
  */
939
939
  async updateApplicationConfiguration(
940
940
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1015,8 +1015,8 @@ class Serviceability {
1015
1015
  * @returns {Promise<ServiceabilityPlatformModel.RulePriorityResponse>} -
1016
1016
  * Success response
1017
1017
  * @name updateCourierPartnerRulePriority
1018
- * @summary: Updates Courier Partner Rules Priority for a sales channel
1019
- * @description: Updates Courier Partner Rules Priority for a sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerRulePriority/).
1018
+ * @summary: Update courier partner rule priority
1019
+ * @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerRulePriority/).
1020
1020
  */
1021
1021
  async updateCourierPartnerRulePriority(
1022
1022
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1097,8 +1097,8 @@ class Serviceability {
1097
1097
  * @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
1098
1098
  * Success response
1099
1099
  * @name updateCourierRule
1100
- * @summary: Updating of Courier Rule
1101
- * @description: This API updates and returns Courier Rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierRule/).
1100
+ * @summary: Update courier rule
1101
+ * @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierRule/).
1102
1102
  */
1103
1103
  async updateCourierRule(
1104
1104
  { ruleId, body, requestHeaders } = { requestHeaders: {} },
@@ -1182,8 +1182,8 @@ class Serviceability {
1182
1182
  * - Success response
1183
1183
  *
1184
1184
  * @name updatePincodeAuditHistory
1185
- * @summary: Update pincode audit history
1186
- * @description: Modify and update audit history records for pincode-related activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
1185
+ * @summary: Get audit trail
1186
+ * @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
1187
1187
  */
1188
1188
  async updatePincodeAuditHistory(
1189
1189
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1265,8 +1265,8 @@ class Serviceability {
1265
1265
  * - Success response
1266
1266
  *
1267
1267
  * @name updatePincodeBulkView
1268
- * @summary: Update pincode bulk view
1269
- * @description: Modify and update views related to bulk operations on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
1268
+ * @summary: Bulk update pincode COD support
1269
+ * @description: Updates the cash on delivery settings for multiple specified pin codes simultaneously. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
1270
1270
  */
1271
1271
  async updatePincodeBulkView(
1272
1272
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1348,8 +1348,8 @@ class Serviceability {
1348
1348
  * - Success response
1349
1349
  *
1350
1350
  * @name updatePincodeCoDListing
1351
- * @summary: Update pincode CoD (Cash on Delivery) listing
1352
- * @description: Modify and update listings for CoD based on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
1351
+ * @summary: Get COD enabled pincodes
1352
+ * @description: Retrieves a list of pincodes along with the count based on whether cash on delivery settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
1353
1353
  */
1354
1354
  async updatePincodeCoDListing(
1355
1355
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1430,8 +1430,8 @@ class Serviceability {
1430
1430
  * @returns {Promise<ServiceabilityPlatformModel.PincodeMOPresponse>} -
1431
1431
  * Success response
1432
1432
  * @name updatePincodeMopView
1433
- * @summary: Update pincode MOP (Mode of Payment) view
1434
- * @description: Modify and update views related to pincode MOP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
1433
+ * @summary: Update pincode COD support
1434
+ * @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
1435
1435
  */
1436
1436
  async updatePincodeMopView(
1437
1437
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1513,8 +1513,8 @@ class Serviceability {
1513
1513
  * - Success response
1514
1514
  *
1515
1515
  * @name updateStoreRules
1516
- * @summary: Update Store Rule
1517
- * @description: Update Store Rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateStoreRules/).
1516
+ * @summary: Update store rule
1517
+ * @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateStoreRules/).
1518
1518
  */
1519
1519
  async updateStoreRules(
1520
1520
  { ruleUid, body, requestHeaders } = { requestHeaders: {} },
@@ -1597,8 +1597,8 @@ class Serviceability {
1597
1597
  * @returns {Promise<ServiceabilityPlatformModel.StoreRuleConfigData>} -
1598
1598
  * Success response
1599
1599
  * @name updateStoreRulesConfig
1600
- * @summary: Update Store Rule Configuration
1601
- * @description: Update Store Rule Configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateStoreRulesConfig/).
1600
+ * @summary: Update store rules configuration
1601
+ * @description: Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateStoreRulesConfig/).
1602
1602
  */
1603
1603
  async updateStoreRulesConfig(
1604
1604
  { body, requestHeaders } = { requestHeaders: {} },
@@ -206,4 +206,4 @@ type UpdateStoreRulesConfigParam = {
206
206
  type GetApplicationConfigParam = any;
207
207
  type GetApplicationConfigurationParam = any;
208
208
  type GetApplicationServiceabilitySelfShipmentParam = any;
209
- import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
209
+ import ServiceabilityPlatformModel = require("sdk/output/javascript/code/sdk/platform/Serviceability/ServiceabilityPlatformModel");
@@ -10,8 +10,8 @@ declare class Serviceability {
10
10
  * - Success response
11
11
  *
12
12
  * @name bulkServiceability
13
- * @summary: Serviceability Import or Export
14
- * @description: Serviceability Import or Export - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/bulkServiceability/).
13
+ * @summary: Bulk update serviceability of localities
14
+ * @description: Bulk operations involve either new serviceability settings or updating existing ones in large quantities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/bulkServiceability/).
15
15
  */
16
16
  bulkServiceability({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResponseItemData>;
17
17
  /**
@@ -22,8 +22,9 @@ declare class Serviceability {
22
22
  * - Success response
23
23
  *
24
24
  * @name bulkTat
25
- * @summary: Region TAT Import or Export
26
- * @description: Region TAT Import or Export - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/bulkTat/).
25
+ * @summary: Locality TAT import or export
26
+ * @description: Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file.
27
+ * Export locality wise CSV files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/bulkTat/).
27
28
  */
28
29
  bulkTat({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkTatParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResponseItemData>;
29
30
  /**
@@ -34,8 +35,8 @@ declare class Serviceability {
34
35
  * @param {import("../PlatformAPIClient").Options} - Options
35
36
  * @returns {Promise<ServiceabilityPlatformModel.CourierAccount>} - Success response
36
37
  * @name createCourierPartnerAccount
37
- * @summary: Creation of Courier Account
38
- * @description: This API Creates a new Courier Account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerAccount/).
38
+ * @summary: Create courier account
39
+ * @description: Creates a courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerAccount/).
39
40
  */
40
41
  createCourierPartnerAccount({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccount>;
41
42
  /**
@@ -48,8 +49,8 @@ declare class Serviceability {
48
49
  * - Success response
49
50
  *
50
51
  * @name createPackageMaterial
51
- * @summary: Upsert of PackageMaterial in database
52
- * @description: This API returns response of upsert of PackageMaterial in mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterial/).
52
+ * @summary: Create packaging material
53
+ * @description: Creates a packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterial/).
53
54
  */
54
55
  createPackageMaterial({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
55
56
  /**
@@ -61,8 +62,8 @@ declare class Serviceability {
61
62
  * @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
62
63
  * Success response
63
64
  * @name createPackageMaterialRule
64
- * @summary: Upsert of Package Material Rule in database
65
- * @description: This API returns response of upsert of Package Material Rule in mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterialRule/).
65
+ * @summary: Create packaging rule
66
+ * @description: Creates a packaging rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterialRule/).
66
67
  */
67
68
  createPackageMaterialRule({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
68
69
  /**
@@ -72,7 +73,7 @@ declare class Serviceability {
72
73
  * @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
73
74
  * @name createZone
74
75
  * @summary: Create zone
75
- * @description: Generate and add a new zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
76
+ * @description: Creates a delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
76
77
  */
77
78
  createZone({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneResponse>;
78
79
  /**
@@ -83,7 +84,7 @@ declare class Serviceability {
83
84
  * Success response
84
85
  * @name getAllStores
85
86
  * @summary: Get all stores
86
- * @description: Retrieve a list of all available stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
87
+ * @description: Retrieves a list of locations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
87
88
  */
88
89
  getAllStores({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoresViewResponse>;
89
90
  /**
@@ -95,8 +96,8 @@ declare class Serviceability {
95
96
  * @returns {Promise<ServiceabilityPlatformModel.BulkRegionResponse>} -
96
97
  * Success response
97
98
  * @name getBulkServiceability
98
- * @summary: Get Region Serviceability Bulk History
99
- * @description: Get Region Serviceability Bulk History - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getBulkServiceability/).
99
+ * @summary: Bulk update history
100
+ * @description: Retrieves the history of changes made to serviceability settings for a scheme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getBulkServiceability/).
100
101
  */
101
102
  getBulkServiceability({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResponse>;
102
103
  /**
@@ -106,8 +107,8 @@ declare class Serviceability {
106
107
  * @returns {Promise<ServiceabilityPlatformModel.BulkRegionResponse>} -
107
108
  * Success response
108
109
  * @name getBulkTat
109
- * @summary: Get region tat bulk history
110
- * @description: Get region tat bulk history - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getBulkTat/).
110
+ * @summary: Locality TAT change history
111
+ * @description: Retrieves the history of changes made to TAT(Turn Around Time) for scheme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getBulkTat/).
111
112
  */
112
113
  getBulkTat({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkTatParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResponse>;
113
114
  /**
@@ -118,8 +119,8 @@ declare class Serviceability {
118
119
  * @param {import("../PlatformAPIClient").Options} - Options
119
120
  * @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
120
121
  * @name getCompanyConfiguration
121
- * @summary: Get All Courier Rules applied to company
122
- * @description: This API returns all Courier Rules applied for company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanyConfiguration/).
122
+ * @summary: Get delivery configuration
123
+ * @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanyConfiguration/).
123
124
  */
124
125
  getCompanyConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
125
126
  /**
@@ -131,8 +132,8 @@ declare class Serviceability {
131
132
  * @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
132
133
  * Success response
133
134
  * @name getCourierPartnerAccount
134
- * @summary: Getting Courier Account of a company from database
135
- * @description: This API returns response DpAccount of a company from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccount/).
135
+ * @summary: Get courier account
136
+ * @description: Retrieves a single courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccount/).
136
137
  */
137
138
  getCourierPartnerAccount({ accountId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResponse>;
138
139
  /**
@@ -145,8 +146,8 @@ declare class Serviceability {
145
146
  * - Success response
146
147
  *
147
148
  * @name getCourierPartnerAccounts
148
- * @summary: Getting Courier Account list of a company
149
- * @description: This API returns Courier Account of a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
149
+ * @summary: List courier accounts
150
+ * @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
150
151
  */
151
152
  getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResponse>;
152
153
  /**
@@ -157,8 +158,8 @@ declare class Serviceability {
157
158
  * - Success response
158
159
  *
159
160
  * @name getOptimalLocations
160
- * @summary: Retrieve optimal locations
161
- * @description: Retrieve optimal locations based on the specific criteria - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
161
+ * @summary: Get selling locations
162
+ * @description: Retrieves a list selling locations which are best suited to fullfil an order for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
162
163
  */
163
164
  getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>;
164
165
  /**
@@ -170,8 +171,8 @@ declare class Serviceability {
170
171
  * @returns {Promise<ServiceabilityPlatformModel.PackageMaterialList>} -
171
172
  * Success response
172
173
  * @name getPackageMaterialList
173
- * @summary: Fetching of PackageMaterials from database
174
- * @description: This API returns response of PackageMaterials from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialList/).
174
+ * @summary: Get packaging materials
175
+ * @description: Retrieves a list of packaging materials - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialList/).
175
176
  */
176
177
  getPackageMaterialList({ pageNo, pageSize, q, size, packageType, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialList>;
177
178
  /**
@@ -183,8 +184,8 @@ declare class Serviceability {
183
184
  * @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
184
185
  * Success response
185
186
  * @name getPackageMaterialRule
186
- * @summary: Fetching of Package Material from database
187
- * @description: This API returns response of Package Material from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRule/).
187
+ * @summary: Get packaging material rule
188
+ * @description: Retrieve packaging rule details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRule/).
188
189
  */
189
190
  getPackageMaterialRule({ ruleId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
190
191
  /**
@@ -197,8 +198,8 @@ declare class Serviceability {
197
198
  * - Success response
198
199
  *
199
200
  * @name getPackageMaterialRules
200
- * @summary: Fetching of Package Material Rules from database
201
- * @description: This API returns response of Package Materials Rules from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRules/).
201
+ * @summary: Get packaging rules
202
+ * @description: Retrieve packaging rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRules/).
202
203
  */
203
204
  getPackageMaterialRules({ pageNo, pageSize, isActive, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialRuleList>;
204
205
  /**
@@ -209,8 +210,8 @@ declare class Serviceability {
209
210
  * - Success response
210
211
  *
211
212
  * @name getPackageMaterials
212
- * @summary: Fetching of Package Material from database
213
- * @description: This API returns response of Package Material from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
213
+ * @summary: Get packaging material
214
+ * @description: Retrieve a single packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
214
215
  */
215
216
  getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
216
217
  /**
@@ -220,8 +221,8 @@ declare class Serviceability {
220
221
  * @returns {Promise<ServiceabilityPlatformModel.ServiceabilityModel>} -
221
222
  * Success response
222
223
  * @name getServiceability
223
- * @summary: Get Serviceability of a region
224
- * @description: Get Serviceability of a region - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getServiceability/).
224
+ * @summary: Get serviceability of a locality
225
+ * @description: Rerieves serviceability settings of a single courier scheme for a given locality - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getServiceability/).
225
226
  */
226
227
  getServiceability({ extensionId, schemeId, regionId, requestHeaders }?: ServiceabilityPlatformValidator.GetServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ServiceabilityModel>;
227
228
  /**
@@ -231,8 +232,8 @@ declare class Serviceability {
231
232
  * @returns {Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>} -
232
233
  * Success response
233
234
  * @name getZoneById
234
- * @summary: Get details of the Zone
235
- * @description: Returns the region, application, store mapping and other details in the Zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZoneById/).
235
+ * @summary: Get zone details
236
+ * @description: Retrieves a single delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZoneById/).
236
237
  */
237
238
  getZoneById({ zoneId, requestHeaders }?: ServiceabilityPlatformValidator.GetZoneByIdParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
238
239
  /**
@@ -241,8 +242,8 @@ declare class Serviceability {
241
242
  * @param {import("../PlatformAPIClient").Options} - Options
242
243
  * @returns {Promise<ServiceabilityPlatformModel.ListViewResponse>} - Success response
243
244
  * @name getZones
244
- * @summary: Shows zones defined at the company level
245
- * @description: Return the list of zones that are defined at the company level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
245
+ * @summary: Get zones
246
+ * @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
246
247
  */
247
248
  getZones({ pageNo, pageSize, isActive, channelId, q, country, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
248
249
  /**
@@ -253,8 +254,8 @@ declare class Serviceability {
253
254
  * @param {import("../PlatformAPIClient").Options} - Options
254
255
  * @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
255
256
  * @name updateCompanyConfiguration
256
- * @summary: Apply Courier Rule to company
257
- * @description: Apply Courier Rule to company with rules priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCompanyConfiguration/).
257
+ * @summary: Update delivery configuration
258
+ * @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCompanyConfiguration/).
258
259
  */
259
260
  updateCompanyConfiguration({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
260
261
  /**
@@ -266,8 +267,8 @@ declare class Serviceability {
266
267
  * @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
267
268
  * Success response
268
269
  * @name updateCourierPartnerAccount
269
- * @summary: Update Courier Account in database
270
- * @description: Updates Courier Account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
270
+ * @summary: Update courier account
271
+ * @description: Updates an existing courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
271
272
  */
272
273
  updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResponse>;
273
274
  /**
@@ -279,8 +280,8 @@ declare class Serviceability {
279
280
  * @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
280
281
  * Success response
281
282
  * @name updatePackageMaterialRule
282
- * @summary: Fetching of Package Material Rules into database
283
- * @description: This API updates Package Material Rules into mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterialRule/).
283
+ * @summary: Update packaging rule
284
+ * @description: Update an existing packaging rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterialRule/).
284
285
  */
285
286
  updatePackageMaterialRule({ ruleId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
286
287
  /**
@@ -293,8 +294,8 @@ declare class Serviceability {
293
294
  * - Success response
294
295
  *
295
296
  * @name updatePackageMaterials
296
- * @summary: Update Package Material to database
297
- * @description: This API updates Package Materials from into mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterials/).
297
+ * @summary: Update packaging material
298
+ * @description: Update an existing packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterials/).
298
299
  */
299
300
  updatePackageMaterials({ packageMaterialId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
300
301
  /**
@@ -304,8 +305,8 @@ declare class Serviceability {
304
305
  * @returns {Promise<ServiceabilityPlatformModel.ServiceabilityModel>} -
305
306
  * Success response
306
307
  * @name updateServiceability
307
- * @summary: Serviceability Update for a region
308
- * @description: Serviceability Update for a region - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateServiceability/).
308
+ * @summary: Update Serviceability of a locality
309
+ * @description: Updates serviceability settings of a single courier scheme for a given locality - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateServiceability/).
309
310
  */
310
311
  updateServiceability({ extensionId, schemeId, regionId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ServiceabilityModel>;
311
312
  /**
@@ -315,10 +316,10 @@ declare class Serviceability {
315
316
  * @returns {Promise<ServiceabilityPlatformModel.ZoneSuccessResponse>} -
316
317
  * Success response
317
318
  * @name updateZoneById
318
- * @summary: Update details of a Zone
319
- * @description: Updates the region, application, store mapping and other details in the Zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateZoneById/).
319
+ * @summary: Update a zone
320
+ * @description: Update an existing delivery zone . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateZoneById/).
320
321
  */
321
322
  updateZoneById({ zoneId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateZoneByIdParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneSuccessResponse>;
322
323
  }
323
- import ServiceabilityPlatformValidator = require("./ServiceabilityPlatformValidator");
324
- import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
324
+ import ServiceabilityPlatformValidator = require("sdk/output/javascript/code/sdk/platform/Serviceability/ServiceabilityPlatformValidator");
325
+ import ServiceabilityPlatformModel = require("sdk/output/javascript/code/sdk/platform/Serviceability/ServiceabilityPlatformModel");