@gofynd/fdk-client-javascript 1.6.3 → 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 +64 -1
  48. package/sdk/partner/Webhook/WebhookPartnerModel.js +36 -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 +66 -10
  102. package/sdk/platform/Order/OrderPlatformModel.js +39 -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 +73 -0
  124. package/sdk/platform/User/UserPlatformApplicationClient.js +543 -0
  125. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +129 -1
  126. package/sdk/platform/User/UserPlatformApplicationValidator.js +97 -0
  127. package/sdk/platform/User/UserPlatformModel.d.ts +269 -6
  128. package/sdk/platform/User/UserPlatformModel.js +187 -5
  129. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +64 -1
  130. package/sdk/platform/Webhook/WebhookPlatformModel.js +36 -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
@@ -5,14 +5,16 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
5
5
  /**
6
6
  * @typedef BulkServiceabilityParam
7
7
  * @property {string} extensionId - Unique Identifier of courier partner extension.
8
- * @property {string} schemeId - Unique identifier of courier partner scheme.
8
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
9
+ * or modify scheme details.
9
10
  * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
10
11
  */
11
12
 
12
13
  /**
13
14
  * @typedef BulkTatParam
14
15
  * @property {string} extensionId - Unique Identifier of courier partner extension.
15
- * @property {string} schemeId - Unique identifier of courier partner scheme.
16
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
17
+ * or modify scheme details.
16
18
  * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
17
19
  */
18
20
 
@@ -23,11 +25,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
23
25
 
24
26
  /**
25
27
  * @typedef CreateCourierPartnerSchemeParam
26
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
28
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel} body
27
29
  */
28
30
 
29
31
  /**
30
32
  * @typedef CreatePackageMaterialParam
33
+ * @property {number} [pageNo] - The current page number for paginated results.
31
34
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
32
35
  */
33
36
 
@@ -36,18 +39,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
36
39
  * @property {ServiceabilityPlatformModel.PackageRule} body
37
40
  */
38
41
 
39
- /**
40
- * @typedef CreateZoneParam
41
- * @property {ServiceabilityPlatformModel.CreateZoneData} body
42
- */
43
-
44
- /** @typedef GetAllStoresParam */
45
-
46
42
  /**
47
43
  * @typedef GetBulkServiceabilityParam
48
44
  * @property {string} extensionId - Unique Identifier of courier partner extension.
49
- * @property {string} schemeId - Unique identifier of courier partner scheme.
50
- * @property {number} [pageNo] - Index of the item to start returning with
45
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
46
+ * or modify scheme details.
47
+ * @property {number} [pageNo] - The current page number for paginated results.
51
48
  * @property {number} [pageSize] - Determines the items to be displayed in a page
52
49
  * @property {string} [batchId] - Unique identifier of bulk job
53
50
  * @property {string} [action] - Import or export bulk type
@@ -61,8 +58,9 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
61
58
  /**
62
59
  * @typedef GetBulkTatParam
63
60
  * @property {string} extensionId - Unique Identifier of courier partner extension.
64
- * @property {string} schemeId - Unique identifier of courier partner scheme.
65
- * @property {number} [pageNo] - Index of the item to start returning with
61
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
62
+ * or modify scheme details.
63
+ * @property {number} [pageNo] - The current page number for paginated results.
66
64
  * @property {number} [pageSize] - Determines the items to be displayed in a page
67
65
  * @property {string} [batchId] - Unique identifier of bulk job
68
66
  * @property {string} [action] - Import or export bulk type
@@ -77,31 +75,40 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
77
75
 
78
76
  /**
79
77
  * @typedef GetCountriesParam
80
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
78
+ * @property {boolean} [onboard] - Only fetch countries which allowed for
81
79
  * onboard on Platform.
82
- * @property {number} [pageNo] - Page number.
83
- * @property {number} [pageSize] - Page size.
84
- * @property {string} [q] - Search.
85
- * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
80
+ * @property {number} [pageNo] - The page number to navigate through the given
81
+ * set of results. Default value is 1.
82
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
83
+ * Default value is 12
84
+ * @property {string} [q] - The search string to search in the list of countries by name.
85
+ * @property {string} [hierarchy] - The search filter to filter countries based
86
+ * on their available hierarchy.
86
87
  */
87
88
 
88
89
  /**
89
90
  * @typedef GetCourierPartnerAccountParam
90
- * @property {string} accountId - Unique ID of courier partner account
91
+ * @property {string} accountId - Unique ID of courier account
91
92
  */
92
93
 
93
94
  /**
94
95
  * @typedef GetCourierPartnerAccountsParam
95
- * @property {number} [pageNo] - Index of the item to start returning with
96
+ * @property {number} [pageNo] - The current page number for paginated results.
96
97
  * @property {number} [pageSize] - Determines the items to be displayed in a page
97
- * @property {string} [stage] - Stage of the account. enabled/disabled
98
+ * @property {string} [stage] - Stage of the account.
98
99
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
99
100
  * @property {string} [transportType] - Filters dp accounts based on transport_type
101
+ * @property {string[]} [accountIds] - Filters dp accounts based on their ids
102
+ * @property {boolean} [selfShip] - To filter self ship/non self ship dp accounts
103
+ * @property {boolean} [ownAccount] - Filters seller owned or Fynd Managed dp accounts
104
+ * @property {string} [q] - Filters dp accounts based on case sensitive partial
105
+ * account name
100
106
  */
101
107
 
102
108
  /**
103
109
  * @typedef GetCourierPartnerSchemeParam
104
- * @property {string} schemeId - Unique Identifier of Scheme
110
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
111
+ * or modify scheme details.
105
112
  */
106
113
 
107
114
  /**
@@ -115,16 +122,24 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
115
122
  * returned in the response.
116
123
  */
117
124
 
125
+ /**
126
+ * @typedef GetInstalledCourierPartnerExtensionsParam
127
+ * @property {number} [pageNo] - The current page number for paginated results.
128
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
129
+ * @property {string} [isInstalled] - Filter to get installed extensions only
130
+ */
131
+
118
132
  /**
119
133
  * @typedef GetOptimalLocationsParam
120
- * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
134
+ * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
121
135
  */
122
136
 
123
137
  /**
124
138
  * @typedef GetPackageMaterialListParam
125
- * @property {number} [pageNo] - Index of the item to start returning with
139
+ * @property {number} [pageNo] - The current page number for paginated results.
126
140
  * @property {number} [pageSize] - Determines the items to be displayed in a page
127
- * @property {string} [q] - Perform regex search on items matching name for given value
141
+ * @property {string} [q] - Used to search for matching results based on the
142
+ * provided input.
128
143
  * @property {string} [size] - Filters items based on given size
129
144
  * @property {string} [packageType] - Filters items based on given package_type
130
145
  */
@@ -135,50 +150,20 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
135
150
  * identifier for a Package Material Rule
136
151
  */
137
152
 
138
- /**
139
- * @typedef GetPackageMaterialRulesParam
140
- * @property {number} [pageNo] - Index of the item to start returning with
141
- * @property {number} [pageSize] - Determines the items to be displayed in a page
142
- * @property {string} [isActive] - Filters items based on given is_active
143
- */
144
-
145
153
  /**
146
154
  * @typedef GetPackageMaterialsParam
147
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
155
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
156
+ * identifier for a Package Material
148
157
  */
149
158
 
150
159
  /**
151
160
  * @typedef GetSampleFileServiceabilityStatusParam
152
- * @property {number} [pageNo] - Index of the item to start returning with
161
+ * @property {number} [pageNo] - The current page number for paginated results.
153
162
  * @property {number} [pageSize] - Determines the items to be displayed in a page
154
163
  * @property {string} [batchId] - Batch id of the execution
155
164
  */
156
165
 
157
- /**
158
- * @typedef GetServiceabilityParam
159
- * @property {string} extensionId - Unique Identifier of courier partner extension.
160
- * @property {string} schemeId - Unique identifier of courier partner scheme.
161
- * @property {string} regionId - Unique identifier of a region
162
- */
163
-
164
- /**
165
- * @typedef GetZoneByIdParam
166
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
167
- */
168
-
169
- /**
170
- * @typedef GetZonesParam
171
- * @property {number} [pageNo] - Index of the item to start returning with
172
- * @property {number} [pageSize] - Determines the items to be displayed in a page
173
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
174
- * @property {string} [channelId] - Zones filtered by an application
175
- * @property {string} [q] - Search with name as a free text
176
- * @property {string} [countryIsoCode] - ISO2 code of the country
177
- * @property {string} [state] - State name
178
- * @property {string} [city] - City name
179
- * @property {string} [pincode] - Pincode value to search zones
180
- * @property {string} [sector] - Sector value to search zones
181
- */
166
+ /** @typedef GetSelfShipDetailsParam */
182
167
 
183
168
  /**
184
169
  * @typedef SampleFileServiceabilityParam
@@ -187,19 +172,20 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
187
172
 
188
173
  /**
189
174
  * @typedef UpdateCompanyConfigurationParam
190
- * @property {ServiceabilityPlatformModel.CompanyConfig} body
175
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
191
176
  */
192
177
 
193
178
  /**
194
179
  * @typedef UpdateCourierPartnerAccountParam
195
- * @property {string} accountId - Unique ID of courier partner account
196
- * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
180
+ * @property {string} accountId - Unique ID of courier account
181
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
197
182
  */
198
183
 
199
184
  /**
200
185
  * @typedef UpdateCourierPartnerSchemeParam
201
- * @property {string} schemeId - Unique Identifier of Scheme
202
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
186
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
187
+ * or modify scheme details.
188
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema} body
203
189
  */
204
190
 
205
191
  /**
@@ -211,22 +197,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
211
197
 
212
198
  /**
213
199
  * @typedef UpdatePackageMaterialsParam
214
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
200
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
201
+ * identifier for a Package Material
215
202
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
216
203
  */
217
204
 
218
205
  /**
219
- * @typedef UpdateServiceabilityParam
220
- * @property {string} extensionId - Unique Identifier of courier partner extension.
221
- * @property {string} schemeId - Unique identifier of courier partner scheme.
222
- * @property {string} regionId - Unique identifier of a region
223
- * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
224
- */
225
-
226
- /**
227
- * @typedef UpdateZoneByIdParam
228
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
229
- * @property {ServiceabilityPlatformModel.UpdateZoneData} body
206
+ * @typedef UpdateSelfShipDetailsParam
207
+ * @property {ServiceabilityPlatformModel.SelfshipSchema} body
230
208
  */
231
209
 
232
210
  class ServiceabilityPlatformValidator {
@@ -258,13 +236,14 @@ class ServiceabilityPlatformValidator {
258
236
  /** @returns {CreateCourierPartnerSchemeParam} */
259
237
  static createCourierPartnerScheme() {
260
238
  return Joi.object({
261
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel().required(),
239
+ body: ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel().required(),
262
240
  }).required();
263
241
  }
264
242
 
265
243
  /** @returns {CreatePackageMaterialParam} */
266
244
  static createPackageMaterial() {
267
245
  return Joi.object({
246
+ pageNo: Joi.number(),
268
247
  body: ServiceabilityPlatformModel.PackageMaterial().required(),
269
248
  }).required();
270
249
  }
@@ -276,18 +255,6 @@ class ServiceabilityPlatformValidator {
276
255
  }).required();
277
256
  }
278
257
 
279
- /** @returns {CreateZoneParam} */
280
- static createZone() {
281
- return Joi.object({
282
- body: ServiceabilityPlatformModel.CreateZoneData().required(),
283
- }).required();
284
- }
285
-
286
- /** @returns {GetAllStoresParam} */
287
- static getAllStores() {
288
- return Joi.object({}).required();
289
- }
290
-
291
258
  /** @returns {GetBulkServiceabilityParam} */
292
259
  static getBulkServiceability() {
293
260
  return Joi.object({
@@ -330,7 +297,7 @@ class ServiceabilityPlatformValidator {
330
297
  /** @returns {GetCountriesParam} */
331
298
  static getCountries() {
332
299
  return Joi.object({
333
- onboarding: Joi.boolean(),
300
+ onboard: Joi.boolean(),
334
301
  pageNo: Joi.number(),
335
302
  pageSize: Joi.number(),
336
303
  q: Joi.string().allow(""),
@@ -353,6 +320,10 @@ class ServiceabilityPlatformValidator {
353
320
  stage: Joi.string().allow(""),
354
321
  paymentMode: Joi.string().allow(""),
355
322
  transportType: Joi.string().allow(""),
323
+ accountIds: Joi.array().items(Joi.string().allow("")),
324
+ selfShip: Joi.boolean(),
325
+ ownAccount: Joi.boolean(),
326
+ q: Joi.string().allow(""),
356
327
  }).required();
357
328
  }
358
329
 
@@ -373,10 +344,19 @@ class ServiceabilityPlatformValidator {
373
344
  }).required();
374
345
  }
375
346
 
347
+ /** @returns {GetInstalledCourierPartnerExtensionsParam} */
348
+ static getInstalledCourierPartnerExtensions() {
349
+ return Joi.object({
350
+ pageNo: Joi.number(),
351
+ pageSize: Joi.number(),
352
+ isInstalled: Joi.string().allow(""),
353
+ }).required();
354
+ }
355
+
376
356
  /** @returns {GetOptimalLocationsParam} */
377
357
  static getOptimalLocations() {
378
358
  return Joi.object({
379
- body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema().required(),
359
+ body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema().required(),
380
360
  }).required();
381
361
  }
382
362
 
@@ -398,15 +378,6 @@ class ServiceabilityPlatformValidator {
398
378
  }).required();
399
379
  }
400
380
 
401
- /** @returns {GetPackageMaterialRulesParam} */
402
- static getPackageMaterialRules() {
403
- return Joi.object({
404
- pageNo: Joi.number(),
405
- pageSize: Joi.number(),
406
- isActive: Joi.string().allow(""),
407
- }).required();
408
- }
409
-
410
381
  /** @returns {GetPackageMaterialsParam} */
411
382
  static getPackageMaterials() {
412
383
  return Joi.object({
@@ -423,36 +394,9 @@ class ServiceabilityPlatformValidator {
423
394
  }).required();
424
395
  }
425
396
 
426
- /** @returns {GetServiceabilityParam} */
427
- static getServiceability() {
428
- return Joi.object({
429
- extensionId: Joi.string().allow("").required(),
430
- schemeId: Joi.string().allow("").required(),
431
- regionId: Joi.string().allow("").required(),
432
- }).required();
433
- }
434
-
435
- /** @returns {GetZoneByIdParam} */
436
- static getZoneById() {
437
- return Joi.object({
438
- zoneId: Joi.string().allow("").required(),
439
- }).required();
440
- }
441
-
442
- /** @returns {GetZonesParam} */
443
- static getZones() {
444
- return Joi.object({
445
- pageNo: Joi.number(),
446
- pageSize: Joi.number(),
447
- isActive: Joi.boolean(),
448
- channelId: Joi.string().allow(""),
449
- q: Joi.string().allow(""),
450
- countryIsoCode: Joi.string().allow(""),
451
- state: Joi.string().allow(""),
452
- city: Joi.string().allow(""),
453
- pincode: Joi.string().allow(""),
454
- sector: Joi.string().allow(""),
455
- }).required();
397
+ /** @returns {GetSelfShipDetailsParam} */
398
+ static getSelfShipDetails() {
399
+ return Joi.object({}).required();
456
400
  }
457
401
 
458
402
  /** @returns {SampleFileServiceabilityParam} */
@@ -465,7 +409,7 @@ class ServiceabilityPlatformValidator {
465
409
  /** @returns {UpdateCompanyConfigurationParam} */
466
410
  static updateCompanyConfiguration() {
467
411
  return Joi.object({
468
- body: ServiceabilityPlatformModel.CompanyConfig().required(),
412
+ body: ServiceabilityPlatformModel.CompanyConfigurationSchema().required(),
469
413
  }).required();
470
414
  }
471
415
 
@@ -473,7 +417,7 @@ class ServiceabilityPlatformValidator {
473
417
  static updateCourierPartnerAccount() {
474
418
  return Joi.object({
475
419
  accountId: Joi.string().allow("").required(),
476
- body: ServiceabilityPlatformModel.CourierAccountUpdateDetails().required(),
420
+ body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
477
421
  }).required();
478
422
  }
479
423
 
@@ -481,7 +425,7 @@ class ServiceabilityPlatformValidator {
481
425
  static updateCourierPartnerScheme() {
482
426
  return Joi.object({
483
427
  schemeId: Joi.string().allow("").required(),
484
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails().required(),
428
+ body: ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema().required(),
485
429
  }).required();
486
430
  }
487
431
 
@@ -501,21 +445,10 @@ class ServiceabilityPlatformValidator {
501
445
  }).required();
502
446
  }
503
447
 
504
- /** @returns {UpdateServiceabilityParam} */
505
- static updateServiceability() {
506
- return Joi.object({
507
- extensionId: Joi.string().allow("").required(),
508
- schemeId: Joi.string().allow("").required(),
509
- regionId: Joi.string().allow("").required(),
510
- body: ServiceabilityPlatformModel.ServiceabilityModel().required(),
511
- }).required();
512
- }
513
-
514
- /** @returns {UpdateZoneByIdParam} */
515
- static updateZoneById() {
448
+ /** @returns {UpdateSelfShipDetailsParam} */
449
+ static updateSelfShipDetails() {
516
450
  return Joi.object({
517
- zoneId: Joi.string().allow("").required(),
518
- body: ServiceabilityPlatformModel.UpdateZoneData().required(),
451
+ body: ServiceabilityPlatformModel.SelfshipSchema().required(),
519
452
  }).required();
520
453
  }
521
454
  }
@@ -106,6 +106,7 @@ export = SharePlatformModel;
106
106
  * @property {number} [current] - The current page number.
107
107
  * @property {string} type - The type of the page, such as 'PageType'.
108
108
  * @property {number} [size] - The number of items per page.
109
+ * @property {number} [page_size] - The number of items per page.
109
110
  */
110
111
  /**
111
112
  * @typedef ShortLinkList
@@ -289,6 +290,10 @@ type Page = {
289
290
  * - The number of items per page.
290
291
  */
291
292
  size?: number;
293
+ /**
294
+ * - The number of items per page.
295
+ */
296
+ page_size?: number;
292
297
  };
293
298
  /** @returns {ShortLinkList} */
294
299
  declare function ShortLinkList(): ShortLinkList;
@@ -119,6 +119,7 @@ const Joi = require("joi");
119
119
  * @property {number} [current] - The current page number.
120
120
  * @property {string} type - The type of the page, such as 'PageType'.
121
121
  * @property {number} [size] - The number of items per page.
122
+ * @property {number} [page_size] - The number of items per page.
122
123
  */
123
124
 
124
125
  /**
@@ -273,6 +274,7 @@ class SharePlatformModel {
273
274
  current: Joi.number(),
274
275
  type: Joi.string().allow("").required(),
275
276
  size: Joi.number(),
277
+ page_size: Joi.number(),
276
278
  });
277
279
  }
278
280
 
@@ -23,6 +23,30 @@ declare class User {
23
23
  * @description: Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
24
24
  */
25
25
  blockOrUnblockUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BlockOrUnblockUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BlockUserSuccess>;
26
+ /**
27
+ * @param {UserPlatformApplicationValidator.BulkImportStoreFrontUsersParam} arg
28
+ * - Arg object
29
+ *
30
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
31
+ * @param {import("../PlatformAPIClient").Options} - Options
32
+ * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
33
+ * @name bulkImportStoreFrontUsers
34
+ * @summary: Bulk import storefront customers using CSV and XLSX files.
35
+ * @description: The API allows bulk import of storefront customers using CSV or XLSX files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/bulkImportStoreFrontUsers/).
36
+ */
37
+ bulkImportStoreFrontUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BulkImportStoreFrontUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
38
+ /**
39
+ * @param {UserPlatformApplicationValidator.CreateBulkExportUsersParam} arg
40
+ * - Arg object
41
+ *
42
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
43
+ * @param {import("../PlatformAPIClient").Options} - Options
44
+ * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
45
+ * @name createBulkExportUsers
46
+ * @summary: Bulk export storefront customers using CSV and XLSX files.
47
+ * @description: This API allows bulk export of storefront users by requesting files in CSV or XLSX format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createBulkExportUsers/).
48
+ */
49
+ createBulkExportUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateBulkExportUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
26
50
  /**
27
51
  * @param {UserPlatformApplicationValidator.CreateUserParam} arg - Arg object
28
52
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -123,6 +147,34 @@ declare class User {
123
147
  * @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
124
148
  */
125
149
  getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
150
+ /**
151
+ * @param {UserPlatformApplicationValidator.GetBulkExportUsersListParam} arg
152
+ * - Arg object
153
+ *
154
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
155
+ * @param {import("../PlatformAPIClient").Options} - Options
156
+ * @returns {Promise<UserPlatformModel.BulkActionPaginationSchema>} - Success response
157
+ * @name getBulkExportUsersList
158
+ * @summary: Get Bulk User's Export Lists for a specific Application.
159
+ * @description: This API allows fetching the list of bulk user exports for a specific application and company.
160
+ * It supports pagination and filtering based on various parameters.
161
+ * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkExportUsersList/).
162
+ */
163
+ getBulkExportUsersList({ pageNo, pageSize, fileFormat, search, startDate, endDate, status, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkExportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
164
+ /**
165
+ * @param {UserPlatformApplicationValidator.GetBulkImportUsersListParam} arg
166
+ * - Arg object
167
+ *
168
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
169
+ * @param {import("../PlatformAPIClient").Options} - Options
170
+ * @returns {Promise<UserPlatformModel.BulkActionPaginationSchema>} - Success response
171
+ * @name getBulkImportUsersList
172
+ * @summary: Get Bulk User's Import Lists for a specific Application.
173
+ * @description: This API allows fetching the list of bulk user imports for a specific application and company.
174
+ * It supports pagination and filtering based on various parameters.
175
+ * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkImportUsersList/).
176
+ */
177
+ getBulkImportUsersList({ pageNo, pageSize, search, startDate, endDate, status, fileFormat, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkImportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
126
178
  /**
127
179
  * @param {UserPlatformApplicationValidator.GetCustomersParam} arg - Arg object
128
180
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -222,6 +274,27 @@ declare class User {
222
274
  * @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
223
275
  */
224
276
  getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
277
+ /**
278
+ * @param {UserPlatformApplicationValidator.GetUserTimelineParam} arg - Arg object
279
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
280
+ * @param {import("../PlatformAPIClient").Options} - Options
281
+ * @returns {Promise<UserPlatformModel.GetUserTimeline>} - Success response
282
+ * @name getUserTimeline
283
+ * @summary: Get Deleted User Timeline
284
+ * @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserTimeline/).
285
+ */
286
+ getUserTimeline({ userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserTimelineParam, { responseHeaders }?: object): Promise<UserPlatformModel.GetUserTimeline>;
287
+ /**
288
+ * @param {UserPlatformApplicationValidator.GetUsersJobByJobIdParam} arg - Arg object
289
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
290
+ * @param {import("../PlatformAPIClient").Options} - Options
291
+ * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
292
+ * @name getUsersJobByJobId
293
+ * @summary: Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
294
+ * @description: This endpoint retrieves the details of a specific user's import and export related jobs associated with a given `job_id`, `application_id`, and `company_id`.
295
+ * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUsersJobByJobId/).
296
+ */
297
+ getUsersJobByJobId({ jobId, requestHeaders }?: UserPlatformApplicationValidator.GetUsersJobByJobIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
225
298
  /**
226
299
  * @param {UserPlatformApplicationValidator.SearchUsersParam} arg - Arg object
227
300
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`