@gofynd/fdk-client-javascript 1.6.4 → 2.0.0

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 (146) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +5 -5
  4. package/sdk/application/Cart/CartApplicationClient.js +26 -268
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +20 -20
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +98 -347
  7. package/sdk/application/Common/CommonApplicationClient.js +1 -16
  8. package/sdk/application/Communication/CommunicationApplicationClient.js +1 -24
  9. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +24 -2
  10. package/sdk/application/Configuration/ConfigurationApplicationClient.js +58 -137
  11. package/sdk/application/Content/ContentApplicationClient.d.ts +47 -7
  12. package/sdk/application/Content/ContentApplicationClient.js +222 -191
  13. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  14. package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
  15. package/sdk/application/Finance/FinanceApplicationClient.js +1 -16
  16. package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
  17. package/sdk/application/Lead/LeadApplicationClient.js +21 -52
  18. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -56
  19. package/sdk/application/Logistic/LogisticApplicationClient.js +57 -332
  20. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
  21. package/sdk/application/Order/OrderApplicationClient.js +68 -153
  22. package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -12
  23. package/sdk/application/Payment/PaymentApplicationClient.js +7 -487
  24. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  25. package/sdk/application/Rewards/RewardsApplicationClient.js +6 -59
  26. package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
  27. package/sdk/application/Share/ShareApplicationClient.js +21 -75
  28. package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
  29. package/sdk/application/Theme/ThemeApplicationClient.js +19 -47
  30. package/sdk/application/User/UserApplicationClient.js +1 -407
  31. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -8
  32. package/sdk/common/Utility.d.ts +1 -1
  33. package/sdk/common/Utility.js +4 -4
  34. package/sdk/common/Validator.d.ts +1 -0
  35. package/sdk/common/Validator.js +20 -0
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -55
  37. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +1 -408
  38. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -5
  39. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -37
  40. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -0
  41. package/sdk/partner/Lead/LeadPartnerModel.js +2 -0
  42. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +29 -25
  43. package/sdk/partner/Logistics/LogisticsPartnerClient.js +65 -42
  44. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1008 -794
  45. package/sdk/partner/Logistics/LogisticsPartnerModel.js +573 -460
  46. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +10 -5
  47. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
  48. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
  49. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  50. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +2 -0
  51. package/sdk/platform/Cart/CartPlatformModel.d.ts +67 -9
  52. package/sdk/platform/Cart/CartPlatformModel.js +38 -5
  53. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -1
  54. package/sdk/platform/Catalog/CatalogPlatformClient.js +4 -4
  55. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +47 -13
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -7
  57. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +2 -2
  58. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +7 -4
  59. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +71 -7
  60. package/sdk/platform/Communication/CommunicationPlatformModel.js +70 -6
  61. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +0 -27
  62. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +8 -60
  63. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +31 -20
  64. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +18 -18
  65. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +1 -1
  66. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -3
  67. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +13 -0
  68. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -1
  69. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +68 -11
  70. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +49 -7
  71. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +169 -0
  72. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1279 -132
  73. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +156 -1
  74. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +180 -0
  75. package/sdk/platform/Content/ContentPlatformClient.d.ts +162 -0
  76. package/sdk/platform/Content/ContentPlatformClient.js +1697 -497
  77. package/sdk/platform/Content/ContentPlatformModel.d.ts +1053 -35
  78. package/sdk/platform/Content/ContentPlatformModel.js +717 -34
  79. package/sdk/platform/Content/ContentPlatformValidator.d.ts +127 -1
  80. package/sdk/platform/Content/ContentPlatformValidator.js +171 -0
  81. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +34 -0
  82. package/sdk/platform/Discount/DiscountPlatformClient.js +59 -0
  83. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +365 -93
  84. package/sdk/platform/Discount/DiscountPlatformModel.js +98 -93
  85. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +54 -34
  86. package/sdk/platform/Discount/DiscountPlatformValidator.js +27 -17
  87. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +0 -156
  88. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +0 -1072
  89. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -137
  90. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -173
  91. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +1 -1105
  92. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +0 -1125
  93. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -0
  94. package/sdk/platform/Lead/LeadPlatformModel.js +2 -0
  95. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
  96. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
  97. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  98. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  99. package/sdk/platform/Order/OrderPlatformClient.d.ts +212 -0
  100. package/sdk/platform/Order/OrderPlatformClient.js +397 -0
  101. package/sdk/platform/Order/OrderPlatformModel.d.ts +41 -9
  102. package/sdk/platform/Order/OrderPlatformModel.js +20 -7
  103. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
  104. package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
  105. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +58 -10
  106. package/sdk/platform/Partner/PartnerPlatformModel.js +19 -10
  107. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -2
  108. package/sdk/platform/Payment/PaymentPlatformModel.js +8 -2
  109. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +5 -0
  110. package/sdk/platform/Rewards/RewardsPlatformModel.js +2 -0
  111. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +240 -24
  112. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +1753 -277
  113. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +320 -22
  114. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +269 -19
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -104
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +201 -629
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +5720 -2891
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3414 -2181
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +138 -216
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +81 -148
  121. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
  122. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  123. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +10 -0
  124. package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
  125. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +13 -1
  126. package/sdk/platform/User/UserPlatformApplicationValidator.js +12 -0
  127. package/sdk/platform/User/UserPlatformModel.d.ts +52 -1
  128. package/sdk/platform/User/UserPlatformModel.js +36 -0
  129. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -0
  130. package/sdk/platform/Webhook/WebhookPlatformModel.js +2 -0
  131. package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
  132. package/sdk/public/Catalog/CatalogPublicClient.js +6 -11
  133. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -16
  134. package/sdk/public/Content/ContentPublicClient.d.ts +36 -3
  135. package/sdk/public/Content/ContentPublicClient.js +261 -104
  136. package/sdk/public/Content/ContentPublicModel.d.ts +155 -1
  137. package/sdk/public/Content/ContentPublicModel.js +102 -0
  138. package/sdk/public/Content/ContentPublicValidator.d.ts +18 -1
  139. package/sdk/public/Content/ContentPublicValidator.js +26 -0
  140. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  141. package/sdk/public/Partner/PartnerPublicClient.js +6 -11
  142. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  143. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  144. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  145. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  146. package/sdk/public/Webhook/WebhookPublicClient.js +1 -40
@@ -2,13 +2,15 @@ export = ServiceabilityPlatformValidator;
2
2
  /**
3
3
  * @typedef BulkServiceabilityParam
4
4
  * @property {string} extensionId - Unique Identifier of courier partner extension.
5
- * @property {string} schemeId - Unique identifier of courier partner scheme.
5
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
6
+ * or modify scheme details.
6
7
  * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
7
8
  */
8
9
  /**
9
10
  * @typedef BulkTatParam
10
11
  * @property {string} extensionId - Unique Identifier of courier partner extension.
11
- * @property {string} schemeId - Unique identifier of courier partner scheme.
12
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
13
+ * or modify scheme details.
12
14
  * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
13
15
  */
14
16
  /**
@@ -17,26 +19,23 @@ export = ServiceabilityPlatformValidator;
17
19
  */
18
20
  /**
19
21
  * @typedef CreateCourierPartnerSchemeParam
20
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
22
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel} body
21
23
  */
22
24
  /**
23
25
  * @typedef CreatePackageMaterialParam
26
+ * @property {number} [pageNo] - The current page number for paginated results.
24
27
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
25
28
  */
26
29
  /**
27
30
  * @typedef CreatePackageMaterialRuleParam
28
31
  * @property {ServiceabilityPlatformModel.PackageRule} body
29
32
  */
30
- /**
31
- * @typedef CreateZoneParam
32
- * @property {ServiceabilityPlatformModel.CreateZoneData} body
33
- */
34
- /** @typedef GetAllStoresParam */
35
33
  /**
36
34
  * @typedef GetBulkServiceabilityParam
37
35
  * @property {string} extensionId - Unique Identifier of courier partner extension.
38
- * @property {string} schemeId - Unique identifier of courier partner scheme.
39
- * @property {number} [pageNo] - Index of the item to start returning with
36
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
37
+ * or modify scheme details.
38
+ * @property {number} [pageNo] - The current page number for paginated results.
40
39
  * @property {number} [pageSize] - Determines the items to be displayed in a page
41
40
  * @property {string} [batchId] - Unique identifier of bulk job
42
41
  * @property {string} [action] - Import or export bulk type
@@ -49,8 +48,9 @@ export = ServiceabilityPlatformValidator;
49
48
  /**
50
49
  * @typedef GetBulkTatParam
51
50
  * @property {string} extensionId - Unique Identifier of courier partner extension.
52
- * @property {string} schemeId - Unique identifier of courier partner scheme.
53
- * @property {number} [pageNo] - Index of the item to start returning with
51
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
52
+ * or modify scheme details.
53
+ * @property {number} [pageNo] - The current page number for paginated results.
54
54
  * @property {number} [pageSize] - Determines the items to be displayed in a page
55
55
  * @property {string} [batchId] - Unique identifier of bulk job
56
56
  * @property {string} [action] - Import or export bulk type
@@ -63,28 +63,37 @@ export = ServiceabilityPlatformValidator;
63
63
  /** @typedef GetCompanyConfigurationParam */
64
64
  /**
65
65
  * @typedef GetCountriesParam
66
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
66
+ * @property {boolean} [onboard] - Only fetch countries which allowed for
67
67
  * onboard on Platform.
68
- * @property {number} [pageNo] - Page number.
69
- * @property {number} [pageSize] - Page size.
70
- * @property {string} [q] - Search.
71
- * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
68
+ * @property {number} [pageNo] - The page number to navigate through the given
69
+ * set of results. Default value is 1.
70
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
71
+ * Default value is 12
72
+ * @property {string} [q] - The search string to search in the list of countries by name.
73
+ * @property {string} [hierarchy] - The search filter to filter countries based
74
+ * on their available hierarchy.
72
75
  */
73
76
  /**
74
77
  * @typedef GetCourierPartnerAccountParam
75
- * @property {string} accountId - Unique ID of courier partner account
78
+ * @property {string} accountId - Unique ID of courier account
76
79
  */
77
80
  /**
78
81
  * @typedef GetCourierPartnerAccountsParam
79
- * @property {number} [pageNo] - Index of the item to start returning with
82
+ * @property {number} [pageNo] - The current page number for paginated results.
80
83
  * @property {number} [pageSize] - Determines the items to be displayed in a page
81
- * @property {string} [stage] - Stage of the account. enabled/disabled
84
+ * @property {string} [stage] - Stage of the account.
82
85
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
83
86
  * @property {string} [transportType] - Filters dp accounts based on transport_type
87
+ * @property {string[]} [accountIds] - Filters dp accounts based on their ids
88
+ * @property {boolean} [selfShip] - To filter self ship/non self ship dp accounts
89
+ * @property {boolean} [ownAccount] - Filters seller owned or Fynd Managed dp accounts
90
+ * @property {string} [q] - Filters dp accounts based on case sensitive partial
91
+ * account name
84
92
  */
85
93
  /**
86
94
  * @typedef GetCourierPartnerSchemeParam
87
- * @property {string} schemeId - Unique Identifier of Scheme
95
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
96
+ * or modify scheme details.
88
97
  */
89
98
  /**
90
99
  * @typedef GetCourierPartnerSchemesParam
@@ -96,15 +105,22 @@ export = ServiceabilityPlatformValidator;
96
105
  * @property {string[]} [schemeIds] - List of scheme ids which need to be
97
106
  * returned in the response.
98
107
  */
108
+ /**
109
+ * @typedef GetInstalledCourierPartnerExtensionsParam
110
+ * @property {number} [pageNo] - The current page number for paginated results.
111
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
112
+ * @property {string} [isInstalled] - Filter to get installed extensions only
113
+ */
99
114
  /**
100
115
  * @typedef GetOptimalLocationsParam
101
- * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
116
+ * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
102
117
  */
103
118
  /**
104
119
  * @typedef GetPackageMaterialListParam
105
- * @property {number} [pageNo] - Index of the item to start returning with
120
+ * @property {number} [pageNo] - The current page number for paginated results.
106
121
  * @property {number} [pageSize] - Determines the items to be displayed in a page
107
- * @property {string} [q] - Perform regex search on items matching name for given value
122
+ * @property {string} [q] - Used to search for matching results based on the
123
+ * provided input.
108
124
  * @property {string} [size] - Filters items based on given size
109
125
  * @property {string} [packageType] - Filters items based on given package_type
110
126
  */
@@ -113,62 +129,36 @@ export = ServiceabilityPlatformValidator;
113
129
  * @property {string} ruleId - A `package_material_rule_id` is a unique
114
130
  * identifier for a Package Material Rule
115
131
  */
116
- /**
117
- * @typedef GetPackageMaterialRulesParam
118
- * @property {number} [pageNo] - Index of the item to start returning with
119
- * @property {number} [pageSize] - Determines the items to be displayed in a page
120
- * @property {string} [isActive] - Filters items based on given is_active
121
- */
122
132
  /**
123
133
  * @typedef GetPackageMaterialsParam
124
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
134
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
135
+ * identifier for a Package Material
125
136
  */
126
137
  /**
127
138
  * @typedef GetSampleFileServiceabilityStatusParam
128
- * @property {number} [pageNo] - Index of the item to start returning with
139
+ * @property {number} [pageNo] - The current page number for paginated results.
129
140
  * @property {number} [pageSize] - Determines the items to be displayed in a page
130
141
  * @property {string} [batchId] - Batch id of the execution
131
142
  */
132
- /**
133
- * @typedef GetServiceabilityParam
134
- * @property {string} extensionId - Unique Identifier of courier partner extension.
135
- * @property {string} schemeId - Unique identifier of courier partner scheme.
136
- * @property {string} regionId - Unique identifier of a region
137
- */
138
- /**
139
- * @typedef GetZoneByIdParam
140
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
141
- */
142
- /**
143
- * @typedef GetZonesParam
144
- * @property {number} [pageNo] - Index of the item to start returning with
145
- * @property {number} [pageSize] - Determines the items to be displayed in a page
146
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
147
- * @property {string} [channelId] - Zones filtered by an application
148
- * @property {string} [q] - Search with name as a free text
149
- * @property {string} [countryIsoCode] - ISO2 code of the country
150
- * @property {string} [state] - State name
151
- * @property {string} [city] - City name
152
- * @property {string} [pincode] - Pincode value to search zones
153
- * @property {string} [sector] - Sector value to search zones
154
- */
143
+ /** @typedef GetSelfShipDetailsParam */
155
144
  /**
156
145
  * @typedef SampleFileServiceabilityParam
157
146
  * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
158
147
  */
159
148
  /**
160
149
  * @typedef UpdateCompanyConfigurationParam
161
- * @property {ServiceabilityPlatformModel.CompanyConfig} body
150
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
162
151
  */
163
152
  /**
164
153
  * @typedef UpdateCourierPartnerAccountParam
165
- * @property {string} accountId - Unique ID of courier partner account
166
- * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
154
+ * @property {string} accountId - Unique ID of courier account
155
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
167
156
  */
168
157
  /**
169
158
  * @typedef UpdateCourierPartnerSchemeParam
170
- * @property {string} schemeId - Unique Identifier of Scheme
171
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
159
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
160
+ * or modify scheme details.
161
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema} body
172
162
  */
173
163
  /**
174
164
  * @typedef UpdatePackageMaterialRuleParam
@@ -178,20 +168,13 @@ export = ServiceabilityPlatformValidator;
178
168
  */
179
169
  /**
180
170
  * @typedef UpdatePackageMaterialsParam
181
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
171
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
172
+ * identifier for a Package Material
182
173
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
183
174
  */
184
175
  /**
185
- * @typedef UpdateServiceabilityParam
186
- * @property {string} extensionId - Unique Identifier of courier partner extension.
187
- * @property {string} schemeId - Unique identifier of courier partner scheme.
188
- * @property {string} regionId - Unique identifier of a region
189
- * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
190
- */
191
- /**
192
- * @typedef UpdateZoneByIdParam
193
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
194
- * @property {ServiceabilityPlatformModel.UpdateZoneData} body
176
+ * @typedef UpdateSelfShipDetailsParam
177
+ * @property {ServiceabilityPlatformModel.SelfshipSchema} body
195
178
  */
196
179
  declare class ServiceabilityPlatformValidator {
197
180
  /** @returns {BulkServiceabilityParam} */
@@ -206,10 +189,6 @@ declare class ServiceabilityPlatformValidator {
206
189
  static createPackageMaterial(): CreatePackageMaterialParam;
207
190
  /** @returns {CreatePackageMaterialRuleParam} */
208
191
  static createPackageMaterialRule(): CreatePackageMaterialRuleParam;
209
- /** @returns {CreateZoneParam} */
210
- static createZone(): CreateZoneParam;
211
- /** @returns {GetAllStoresParam} */
212
- static getAllStores(): any;
213
192
  /** @returns {GetBulkServiceabilityParam} */
214
193
  static getBulkServiceability(): GetBulkServiceabilityParam;
215
194
  /** @returns {GetBulkTatParam} */
@@ -226,24 +205,20 @@ declare class ServiceabilityPlatformValidator {
226
205
  static getCourierPartnerScheme(): GetCourierPartnerSchemeParam;
227
206
  /** @returns {GetCourierPartnerSchemesParam} */
228
207
  static getCourierPartnerSchemes(): GetCourierPartnerSchemesParam;
208
+ /** @returns {GetInstalledCourierPartnerExtensionsParam} */
209
+ static getInstalledCourierPartnerExtensions(): GetInstalledCourierPartnerExtensionsParam;
229
210
  /** @returns {GetOptimalLocationsParam} */
230
211
  static getOptimalLocations(): GetOptimalLocationsParam;
231
212
  /** @returns {GetPackageMaterialListParam} */
232
213
  static getPackageMaterialList(): GetPackageMaterialListParam;
233
214
  /** @returns {GetPackageMaterialRuleParam} */
234
215
  static getPackageMaterialRule(): GetPackageMaterialRuleParam;
235
- /** @returns {GetPackageMaterialRulesParam} */
236
- static getPackageMaterialRules(): GetPackageMaterialRulesParam;
237
216
  /** @returns {GetPackageMaterialsParam} */
238
217
  static getPackageMaterials(): GetPackageMaterialsParam;
239
218
  /** @returns {GetSampleFileServiceabilityStatusParam} */
240
219
  static getSampleFileServiceabilityStatus(): GetSampleFileServiceabilityStatusParam;
241
- /** @returns {GetServiceabilityParam} */
242
- static getServiceability(): GetServiceabilityParam;
243
- /** @returns {GetZoneByIdParam} */
244
- static getZoneById(): GetZoneByIdParam;
245
- /** @returns {GetZonesParam} */
246
- static getZones(): GetZonesParam;
220
+ /** @returns {GetSelfShipDetailsParam} */
221
+ static getSelfShipDetails(): any;
247
222
  /** @returns {SampleFileServiceabilityParam} */
248
223
  static sampleFileServiceability(): SampleFileServiceabilityParam;
249
224
  /** @returns {UpdateCompanyConfigurationParam} */
@@ -256,13 +231,11 @@ declare class ServiceabilityPlatformValidator {
256
231
  static updatePackageMaterialRule(): UpdatePackageMaterialRuleParam;
257
232
  /** @returns {UpdatePackageMaterialsParam} */
258
233
  static updatePackageMaterials(): UpdatePackageMaterialsParam;
259
- /** @returns {UpdateServiceabilityParam} */
260
- static updateServiceability(): UpdateServiceabilityParam;
261
- /** @returns {UpdateZoneByIdParam} */
262
- static updateZoneById(): UpdateZoneByIdParam;
234
+ /** @returns {UpdateSelfShipDetailsParam} */
235
+ static updateSelfShipDetails(): UpdateSelfShipDetailsParam;
263
236
  }
264
237
  declare namespace ServiceabilityPlatformValidator {
265
- export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreateCourierPartnerSchemeParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCountriesParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetCourierPartnerSchemeParam, GetCourierPartnerSchemesParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetSampleFileServiceabilityStatusParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, SampleFileServiceabilityParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdateCourierPartnerSchemeParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
238
+ export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreateCourierPartnerSchemeParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCountriesParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetCourierPartnerSchemeParam, GetCourierPartnerSchemesParam, GetInstalledCourierPartnerExtensionsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialsParam, GetSampleFileServiceabilityStatusParam, GetSelfShipDetailsParam, SampleFileServiceabilityParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdateCourierPartnerSchemeParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateSelfShipDetailsParam };
266
239
  }
267
240
  type BulkServiceabilityParam = {
268
241
  /**
@@ -270,7 +243,8 @@ type BulkServiceabilityParam = {
270
243
  */
271
244
  extensionId: string;
272
245
  /**
273
- * - Unique identifier of courier partner scheme.
246
+ * - Unique identifier for the scheme, used to fetch
247
+ * or modify scheme details.
274
248
  */
275
249
  schemeId: string;
276
250
  body: ServiceabilityPlatformModel.BulkRegionJobDetails;
@@ -281,7 +255,8 @@ type BulkTatParam = {
281
255
  */
282
256
  extensionId: string;
283
257
  /**
284
- * - Unique identifier of courier partner scheme.
258
+ * - Unique identifier for the scheme, used to fetch
259
+ * or modify scheme details.
285
260
  */
286
261
  schemeId: string;
287
262
  body: ServiceabilityPlatformModel.BulkRegionJobDetails;
@@ -290,28 +265,30 @@ type CreateCourierPartnerAccountParam = {
290
265
  body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
291
266
  };
292
267
  type CreateCourierPartnerSchemeParam = {
293
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel;
268
+ body: ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel;
294
269
  };
295
270
  type CreatePackageMaterialParam = {
271
+ /**
272
+ * - The current page number for paginated results.
273
+ */
274
+ pageNo?: number;
296
275
  body: ServiceabilityPlatformModel.PackageMaterial;
297
276
  };
298
277
  type CreatePackageMaterialRuleParam = {
299
278
  body: ServiceabilityPlatformModel.PackageRule;
300
279
  };
301
- type CreateZoneParam = {
302
- body: ServiceabilityPlatformModel.CreateZoneData;
303
- };
304
280
  type GetBulkServiceabilityParam = {
305
281
  /**
306
282
  * - Unique Identifier of courier partner extension.
307
283
  */
308
284
  extensionId: string;
309
285
  /**
310
- * - Unique identifier of courier partner scheme.
286
+ * - Unique identifier for the scheme, used to fetch
287
+ * or modify scheme details.
311
288
  */
312
289
  schemeId: string;
313
290
  /**
314
- * - Index of the item to start returning with
291
+ * - The current page number for paginated results.
315
292
  */
316
293
  pageNo?: number;
317
294
  /**
@@ -353,11 +330,12 @@ type GetBulkTatParam = {
353
330
  */
354
331
  extensionId: string;
355
332
  /**
356
- * - Unique identifier of courier partner scheme.
333
+ * - Unique identifier for the scheme, used to fetch
334
+ * or modify scheme details.
357
335
  */
358
336
  schemeId: string;
359
337
  /**
360
- * - Index of the item to start returning with
338
+ * - The current page number for paginated results.
361
339
  */
362
340
  pageNo?: number;
363
341
  /**
@@ -398,33 +376,36 @@ type GetCountriesParam = {
398
376
  * - Only fetch countries which allowed for
399
377
  * onboard on Platform.
400
378
  */
401
- onboarding?: boolean;
379
+ onboard?: boolean;
402
380
  /**
403
- * - Page number.
381
+ * - The page number to navigate through the given
382
+ * set of results. Default value is 1.
404
383
  */
405
384
  pageNo?: number;
406
385
  /**
407
- * - Page size.
386
+ * - The number of items to retrieve in each page.
387
+ * Default value is 12
408
388
  */
409
389
  pageSize?: number;
410
390
  /**
411
- * - Search.
391
+ * - The search string to search in the list of countries by name.
412
392
  */
413
393
  q?: string;
414
394
  /**
415
- * - Fetch countries that has certain heirarchy present.
395
+ * - The search filter to filter countries based
396
+ * on their available hierarchy.
416
397
  */
417
398
  hierarchy?: string;
418
399
  };
419
400
  type GetCourierPartnerAccountParam = {
420
401
  /**
421
- * - Unique ID of courier partner account
402
+ * - Unique ID of courier account
422
403
  */
423
404
  accountId: string;
424
405
  };
425
406
  type GetCourierPartnerAccountsParam = {
426
407
  /**
427
- * - Index of the item to start returning with
408
+ * - The current page number for paginated results.
428
409
  */
429
410
  pageNo?: number;
430
411
  /**
@@ -432,7 +413,7 @@ type GetCourierPartnerAccountsParam = {
432
413
  */
433
414
  pageSize?: number;
434
415
  /**
435
- * - Stage of the account. enabled/disabled
416
+ * - Stage of the account.
436
417
  */
437
418
  stage?: string;
438
419
  /**
@@ -443,10 +424,28 @@ type GetCourierPartnerAccountsParam = {
443
424
  * - Filters dp accounts based on transport_type
444
425
  */
445
426
  transportType?: string;
427
+ /**
428
+ * - Filters dp accounts based on their ids
429
+ */
430
+ accountIds?: string[];
431
+ /**
432
+ * - To filter self ship/non self ship dp accounts
433
+ */
434
+ selfShip?: boolean;
435
+ /**
436
+ * - Filters seller owned or Fynd Managed dp accounts
437
+ */
438
+ ownAccount?: boolean;
439
+ /**
440
+ * - Filters dp accounts based on case sensitive partial
441
+ * account name
442
+ */
443
+ q?: string;
446
444
  };
447
445
  type GetCourierPartnerSchemeParam = {
448
446
  /**
449
- * - Unique Identifier of Scheme
447
+ * - Unique identifier for the scheme, used to fetch
448
+ * or modify scheme details.
450
449
  */
451
450
  schemeId: string;
452
451
  };
@@ -471,12 +470,26 @@ type GetCourierPartnerSchemesParam = {
471
470
  */
472
471
  schemeIds?: string[];
473
472
  };
473
+ type GetInstalledCourierPartnerExtensionsParam = {
474
+ /**
475
+ * - The current page number for paginated results.
476
+ */
477
+ pageNo?: number;
478
+ /**
479
+ * - Determines the items to be displayed in a page
480
+ */
481
+ pageSize?: number;
482
+ /**
483
+ * - Filter to get installed extensions only
484
+ */
485
+ isInstalled?: string;
486
+ };
474
487
  type GetOptimalLocationsParam = {
475
- body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema;
488
+ body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
476
489
  };
477
490
  type GetPackageMaterialListParam = {
478
491
  /**
479
- * - Index of the item to start returning with
492
+ * - The current page number for paginated results.
480
493
  */
481
494
  pageNo?: number;
482
495
  /**
@@ -484,7 +497,8 @@ type GetPackageMaterialListParam = {
484
497
  */
485
498
  pageSize?: number;
486
499
  /**
487
- * - Perform regex search on items matching name for given value
500
+ * - Used to search for matching results based on the
501
+ * provided input.
488
502
  */
489
503
  q?: string;
490
504
  /**
@@ -503,29 +517,16 @@ type GetPackageMaterialRuleParam = {
503
517
  */
504
518
  ruleId: string;
505
519
  };
506
- type GetPackageMaterialRulesParam = {
507
- /**
508
- * - Index of the item to start returning with
509
- */
510
- pageNo?: number;
511
- /**
512
- * - Determines the items to be displayed in a page
513
- */
514
- pageSize?: number;
515
- /**
516
- * - Filters items based on given is_active
517
- */
518
- isActive?: string;
519
- };
520
520
  type GetPackageMaterialsParam = {
521
521
  /**
522
- * - Unique identifier for a Package. Material
522
+ * - A `package_material_id` is a unique
523
+ * identifier for a Package Material
523
524
  */
524
525
  packageMaterialId: string;
525
526
  };
526
527
  type GetSampleFileServiceabilityStatusParam = {
527
528
  /**
528
- * - Index of the item to start returning with
529
+ * - The current page number for paginated results.
529
530
  */
530
531
  pageNo?: number;
531
532
  /**
@@ -537,87 +538,26 @@ type GetSampleFileServiceabilityStatusParam = {
537
538
  */
538
539
  batchId?: string;
539
540
  };
540
- type GetServiceabilityParam = {
541
- /**
542
- * - Unique Identifier of courier partner extension.
543
- */
544
- extensionId: string;
545
- /**
546
- * - Unique identifier of courier partner scheme.
547
- */
548
- schemeId: string;
549
- /**
550
- * - Unique identifier of a region
551
- */
552
- regionId: string;
553
- };
554
- type GetZoneByIdParam = {
555
- /**
556
- * - A `zone_id` is a unique identifier for a particular zone.
557
- */
558
- zoneId: string;
559
- };
560
- type GetZonesParam = {
561
- /**
562
- * - Index of the item to start returning with
563
- */
564
- pageNo?: number;
565
- /**
566
- * - Determines the items to be displayed in a page
567
- */
568
- pageSize?: number;
569
- /**
570
- * - Status of Zone (either active or inactive)
571
- */
572
- isActive?: boolean;
573
- /**
574
- * - Zones filtered by an application
575
- */
576
- channelId?: string;
577
- /**
578
- * - Search with name as a free text
579
- */
580
- q?: string;
581
- /**
582
- * - ISO2 code of the country
583
- */
584
- countryIsoCode?: string;
585
- /**
586
- * - State name
587
- */
588
- state?: string;
589
- /**
590
- * - City name
591
- */
592
- city?: string;
593
- /**
594
- * - Pincode value to search zones
595
- */
596
- pincode?: string;
597
- /**
598
- * - Sector value to search zones
599
- */
600
- sector?: string;
601
- };
602
541
  type SampleFileServiceabilityParam = {
603
542
  body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
604
543
  };
605
544
  type UpdateCompanyConfigurationParam = {
606
- body: ServiceabilityPlatformModel.CompanyConfig;
545
+ body: ServiceabilityPlatformModel.CompanyConfigurationSchema;
607
546
  };
608
547
  type UpdateCourierPartnerAccountParam = {
609
548
  /**
610
- * - Unique ID of courier partner account
549
+ * - Unique ID of courier account
611
550
  */
612
551
  accountId: string;
613
- body: ServiceabilityPlatformModel.CourierAccountUpdateDetails;
552
+ body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
614
553
  };
615
554
  type UpdateCourierPartnerSchemeParam = {
616
555
  /**
617
- * - Unique Identifier of Scheme
556
+ * - Unique identifier for the scheme, used to fetch
557
+ * or modify scheme details.
618
558
  */
619
559
  schemeId: string;
620
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails;
560
+ body: ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema;
621
561
  };
622
562
  type UpdatePackageMaterialRuleParam = {
623
563
  /**
@@ -629,33 +569,15 @@ type UpdatePackageMaterialRuleParam = {
629
569
  };
630
570
  type UpdatePackageMaterialsParam = {
631
571
  /**
632
- * - Unique identifier for a Package. Material
572
+ * - A `package_material_id` is a unique
573
+ * identifier for a Package Material
633
574
  */
634
575
  packageMaterialId: string;
635
576
  body: ServiceabilityPlatformModel.PackageMaterial;
636
577
  };
637
- type UpdateServiceabilityParam = {
638
- /**
639
- * - Unique Identifier of courier partner extension.
640
- */
641
- extensionId: string;
642
- /**
643
- * - Unique identifier of courier partner scheme.
644
- */
645
- schemeId: string;
646
- /**
647
- * - Unique identifier of a region
648
- */
649
- regionId: string;
650
- body: ServiceabilityPlatformModel.ServiceabilityModel;
651
- };
652
- type UpdateZoneByIdParam = {
653
- /**
654
- * - A `zone_id` is a unique identifier for a particular zone.
655
- */
656
- zoneId: string;
657
- body: ServiceabilityPlatformModel.UpdateZoneData;
578
+ type UpdateSelfShipDetailsParam = {
579
+ body: ServiceabilityPlatformModel.SelfshipSchema;
658
580
  };
659
- type GetAllStoresParam = any;
660
581
  type GetCompanyConfigurationParam = any;
582
+ type GetSelfShipDetailsParam = any;
661
583
  import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");