@gofynd/fdk-client-javascript 3.3.6 → 3.4.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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +193 -1
- package/sdk/platform/Cart/CartPlatformModel.js +123 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -1
- package/sdk/platform/Order/OrderPlatformModel.js +22 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
|
@@ -11,6 +11,10 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
11
11
|
* @typedef CreateCourierPartnerRuleParam
|
|
12
12
|
* @property {ServiceabilityPlatformModel.CourierPartnerRule} body
|
|
13
13
|
*/
|
|
14
|
+
/**
|
|
15
|
+
* @typedef CreateFulfillmentOptionParam
|
|
16
|
+
* @property {ServiceabilityPlatformModel.FulfillmentOption} body
|
|
17
|
+
*/
|
|
14
18
|
/**
|
|
15
19
|
* @typedef CreateGeoAreaParam
|
|
16
20
|
* @property {ServiceabilityPlatformModel.GeoAreaRequestBody} body
|
|
@@ -27,6 +31,10 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
27
31
|
* @typedef CreateZoneParam
|
|
28
32
|
* @property {ServiceabilityPlatformModel.CreateZoneDataSchema} body
|
|
29
33
|
*/
|
|
34
|
+
/**
|
|
35
|
+
* @typedef DeleteFulfillmentOptionsParam
|
|
36
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
37
|
+
*/
|
|
30
38
|
/**
|
|
31
39
|
* @typedef DeleteZoneParam
|
|
32
40
|
* @property {string} zoneId - Unique identifier for a particular zone
|
|
@@ -38,6 +46,10 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
38
46
|
* @typedef GetBulkExportParam
|
|
39
47
|
* @property {string} batchId - A `batch_id` is a unique identifier for a particular zone.
|
|
40
48
|
*/
|
|
49
|
+
/**
|
|
50
|
+
* @typedef GetBulkFulfillmentValidationStatusParam
|
|
51
|
+
* @property {string} bulkId - Unique id created by validate api.
|
|
52
|
+
*/
|
|
41
53
|
/**
|
|
42
54
|
* @typedef GetBulkGeoAreaParam
|
|
43
55
|
* @property {string} geoareaId - A unique identifier for the GeoArea.
|
|
@@ -56,6 +68,23 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
56
68
|
* @typedef GetCourierPartnersParam
|
|
57
69
|
* @property {ServiceabilityPlatformModel.ShipmentCourierPartnerDetails} body
|
|
58
70
|
*/
|
|
71
|
+
/**
|
|
72
|
+
* @typedef GetFulfillmentOptionProductsParam
|
|
73
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
74
|
+
* @property {string} [q] - Query to search product by name.
|
|
75
|
+
* @property {number} storeId - The unique identifier of the store.
|
|
76
|
+
*/
|
|
77
|
+
/**
|
|
78
|
+
* @typedef GetFulfillmentOptionStoresParam
|
|
79
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
80
|
+
* @property {string} [q] - Query to search product by name.
|
|
81
|
+
*/
|
|
82
|
+
/**
|
|
83
|
+
* @typedef GetFulfillmentOptionsParam
|
|
84
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
85
|
+
* @property {number} [productId] - The unique identifier of the product.
|
|
86
|
+
* @property {number} [storeId] - The unique identifier of the store.
|
|
87
|
+
*/
|
|
59
88
|
/**
|
|
60
89
|
* @typedef GetGeoAreaParam
|
|
61
90
|
* @property {string} geoareaId - A unique identifier for the GeoArea.
|
|
@@ -98,6 +127,8 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
98
127
|
* @property {string} [stage] - Identifies the specific stage of zone bing requested.
|
|
99
128
|
* @property {number} [pageSize] - Defines the number of items displayed per page.
|
|
100
129
|
* @property {number} [pageNo] - Current page number.
|
|
130
|
+
* @property {string} [fulfillmentOptionSlug] - Slug identifier for filtering by
|
|
131
|
+
* fulfillment option.
|
|
101
132
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
102
133
|
* @property {string} [q] - Used to search for matching results based on the
|
|
103
134
|
* provided input.
|
|
@@ -115,6 +146,11 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
115
146
|
* @typedef PatchApplicationConfigurationParam
|
|
116
147
|
* @property {ServiceabilityPlatformModel.ApplicationConfigPatch} body
|
|
117
148
|
*/
|
|
149
|
+
/**
|
|
150
|
+
* @typedef PutFulfillmentOptionParam
|
|
151
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
152
|
+
* @property {ServiceabilityPlatformModel.FulfillmentOption} body
|
|
153
|
+
*/
|
|
118
154
|
/**
|
|
119
155
|
* @typedef UpdateApplicationConfigurationParam
|
|
120
156
|
* @property {ServiceabilityPlatformModel.ApplicationConfigPutDetail} body
|
|
@@ -177,6 +213,15 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
177
213
|
* @property {string} zoneId - Unique identifier for a particular zone
|
|
178
214
|
* @property {ServiceabilityPlatformModel.UpdateZoneData} body
|
|
179
215
|
*/
|
|
216
|
+
/**
|
|
217
|
+
* @typedef UploadBulkFulfillmentOptionsParam
|
|
218
|
+
* @property {ServiceabilityPlatformModel.FulfillmentOptionBulk} body
|
|
219
|
+
*/
|
|
220
|
+
/**
|
|
221
|
+
* @typedef ValidateBulkFulfillmentOptionsParam
|
|
222
|
+
* @property {string} type - Type of entity being validated (stores or products).
|
|
223
|
+
* @property {ServiceabilityPlatformModel.FulfillmentOptionBulkValidate} body
|
|
224
|
+
*/
|
|
180
225
|
declare class ServiceabilityPlatformApplicationValidator {
|
|
181
226
|
/** @returns {CreateBulkExportParam} */
|
|
182
227
|
static createBulkExport(): CreateBulkExportParam;
|
|
@@ -184,6 +229,8 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
184
229
|
static createBulkGeoArea(): CreateBulkGeoAreaParam;
|
|
185
230
|
/** @returns {CreateCourierPartnerRuleParam} */
|
|
186
231
|
static createCourierPartnerRule(): CreateCourierPartnerRuleParam;
|
|
232
|
+
/** @returns {CreateFulfillmentOptionParam} */
|
|
233
|
+
static createFulfillmentOption(): CreateFulfillmentOptionParam;
|
|
187
234
|
/** @returns {CreateGeoAreaParam} */
|
|
188
235
|
static createGeoArea(): CreateGeoAreaParam;
|
|
189
236
|
/** @returns {CreateGeoAreaExportJobParam} */
|
|
@@ -192,6 +239,8 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
192
239
|
static createStoreRules(): CreateStoreRulesParam;
|
|
193
240
|
/** @returns {CreateZoneParam} */
|
|
194
241
|
static createZone(): CreateZoneParam;
|
|
242
|
+
/** @returns {DeleteFulfillmentOptionsParam} */
|
|
243
|
+
static deleteFulfillmentOptions(): DeleteFulfillmentOptionsParam;
|
|
195
244
|
/** @returns {DeleteZoneParam} */
|
|
196
245
|
static deleteZone(): DeleteZoneParam;
|
|
197
246
|
/** @returns {DownloadGeoareaSampleFileParam} */
|
|
@@ -202,6 +251,8 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
202
251
|
static getApplicationConfiguration(): any;
|
|
203
252
|
/** @returns {GetBulkExportParam} */
|
|
204
253
|
static getBulkExport(): GetBulkExportParam;
|
|
254
|
+
/** @returns {GetBulkFulfillmentValidationStatusParam} */
|
|
255
|
+
static getBulkFulfillmentValidationStatus(): GetBulkFulfillmentValidationStatusParam;
|
|
205
256
|
/** @returns {GetBulkGeoAreaParam} */
|
|
206
257
|
static getBulkGeoArea(): GetBulkGeoAreaParam;
|
|
207
258
|
/** @returns {GetCourierPartnerRuleParam} */
|
|
@@ -210,6 +261,12 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
210
261
|
static getCourierPartnerRules(): GetCourierPartnerRulesParam;
|
|
211
262
|
/** @returns {GetCourierPartnersParam} */
|
|
212
263
|
static getCourierPartners(): GetCourierPartnersParam;
|
|
264
|
+
/** @returns {GetFulfillmentOptionProductsParam} */
|
|
265
|
+
static getFulfillmentOptionProducts(): GetFulfillmentOptionProductsParam;
|
|
266
|
+
/** @returns {GetFulfillmentOptionStoresParam} */
|
|
267
|
+
static getFulfillmentOptionStores(): GetFulfillmentOptionStoresParam;
|
|
268
|
+
/** @returns {GetFulfillmentOptionsParam} */
|
|
269
|
+
static getFulfillmentOptions(): GetFulfillmentOptionsParam;
|
|
213
270
|
/** @returns {GetGeoAreaParam} */
|
|
214
271
|
static getGeoArea(): GetGeoAreaParam;
|
|
215
272
|
/** @returns {GetGeoAreaExportJobStatusParam} */
|
|
@@ -228,6 +285,8 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
228
285
|
static insertApplicationConfig(): InsertApplicationConfigParam;
|
|
229
286
|
/** @returns {PatchApplicationConfigurationParam} */
|
|
230
287
|
static patchApplicationConfiguration(): PatchApplicationConfigurationParam;
|
|
288
|
+
/** @returns {PutFulfillmentOptionParam} */
|
|
289
|
+
static putFulfillmentOption(): PutFulfillmentOptionParam;
|
|
231
290
|
/** @returns {UpdateApplicationConfigurationParam} */
|
|
232
291
|
static updateApplicationConfiguration(): UpdateApplicationConfigurationParam;
|
|
233
292
|
/** @returns {UpdateBulkGeoAreaParam} */
|
|
@@ -254,9 +313,13 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
254
313
|
static updateStoreRulesConfig(): UpdateStoreRulesConfigParam;
|
|
255
314
|
/** @returns {UpdateZoneParam} */
|
|
256
315
|
static updateZone(): UpdateZoneParam;
|
|
316
|
+
/** @returns {UploadBulkFulfillmentOptionsParam} */
|
|
317
|
+
static uploadBulkFulfillmentOptions(): UploadBulkFulfillmentOptionsParam;
|
|
318
|
+
/** @returns {ValidateBulkFulfillmentOptionsParam} */
|
|
319
|
+
static validateBulkFulfillmentOptions(): ValidateBulkFulfillmentOptionsParam;
|
|
257
320
|
}
|
|
258
321
|
declare namespace ServiceabilityPlatformApplicationValidator {
|
|
259
|
-
export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateStoreRulesParam, CreateZoneParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, UpdateApplicationConfigurationParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam };
|
|
322
|
+
export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateStoreRulesParam, CreateZoneParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PutFulfillmentOptionParam, UpdateApplicationConfigurationParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
|
|
260
323
|
}
|
|
261
324
|
type CreateBulkExportParam = {
|
|
262
325
|
body: ServiceabilityPlatformModel.BulkCreateZoneExport;
|
|
@@ -267,6 +330,9 @@ type CreateBulkGeoAreaParam = {
|
|
|
267
330
|
type CreateCourierPartnerRuleParam = {
|
|
268
331
|
body: ServiceabilityPlatformModel.CourierPartnerRule;
|
|
269
332
|
};
|
|
333
|
+
type CreateFulfillmentOptionParam = {
|
|
334
|
+
body: ServiceabilityPlatformModel.FulfillmentOption;
|
|
335
|
+
};
|
|
270
336
|
type CreateGeoAreaParam = {
|
|
271
337
|
body: ServiceabilityPlatformModel.GeoAreaRequestBody;
|
|
272
338
|
};
|
|
@@ -282,6 +348,12 @@ type CreateStoreRulesParam = {
|
|
|
282
348
|
type CreateZoneParam = {
|
|
283
349
|
body: ServiceabilityPlatformModel.CreateZoneDataSchema;
|
|
284
350
|
};
|
|
351
|
+
type DeleteFulfillmentOptionsParam = {
|
|
352
|
+
/**
|
|
353
|
+
* - Slug of the fulfillment option for retrieving details.
|
|
354
|
+
*/
|
|
355
|
+
slug: string;
|
|
356
|
+
};
|
|
285
357
|
type DeleteZoneParam = {
|
|
286
358
|
/**
|
|
287
359
|
* - Unique identifier for a particular zone
|
|
@@ -294,6 +366,12 @@ type GetBulkExportParam = {
|
|
|
294
366
|
*/
|
|
295
367
|
batchId: string;
|
|
296
368
|
};
|
|
369
|
+
type GetBulkFulfillmentValidationStatusParam = {
|
|
370
|
+
/**
|
|
371
|
+
* - Unique id created by validate api.
|
|
372
|
+
*/
|
|
373
|
+
bulkId: string;
|
|
374
|
+
};
|
|
297
375
|
type GetBulkGeoAreaParam = {
|
|
298
376
|
/**
|
|
299
377
|
* - A unique identifier for the GeoArea.
|
|
@@ -323,6 +401,44 @@ type GetCourierPartnerRulesParam = {
|
|
|
323
401
|
type GetCourierPartnersParam = {
|
|
324
402
|
body: ServiceabilityPlatformModel.ShipmentCourierPartnerDetails;
|
|
325
403
|
};
|
|
404
|
+
type GetFulfillmentOptionProductsParam = {
|
|
405
|
+
/**
|
|
406
|
+
* - Slug of the fulfillment option for retrieving details.
|
|
407
|
+
*/
|
|
408
|
+
slug: string;
|
|
409
|
+
/**
|
|
410
|
+
* - Query to search product by name.
|
|
411
|
+
*/
|
|
412
|
+
q?: string;
|
|
413
|
+
/**
|
|
414
|
+
* - The unique identifier of the store.
|
|
415
|
+
*/
|
|
416
|
+
storeId: number;
|
|
417
|
+
};
|
|
418
|
+
type GetFulfillmentOptionStoresParam = {
|
|
419
|
+
/**
|
|
420
|
+
* - Slug of the fulfillment option for retrieving details.
|
|
421
|
+
*/
|
|
422
|
+
slug: string;
|
|
423
|
+
/**
|
|
424
|
+
* - Query to search product by name.
|
|
425
|
+
*/
|
|
426
|
+
q?: string;
|
|
427
|
+
};
|
|
428
|
+
type GetFulfillmentOptionsParam = {
|
|
429
|
+
/**
|
|
430
|
+
* - Slug of the fulfillment option for retrieving details.
|
|
431
|
+
*/
|
|
432
|
+
slug: string;
|
|
433
|
+
/**
|
|
434
|
+
* - The unique identifier of the product.
|
|
435
|
+
*/
|
|
436
|
+
productId?: number;
|
|
437
|
+
/**
|
|
438
|
+
* - The unique identifier of the store.
|
|
439
|
+
*/
|
|
440
|
+
storeId?: number;
|
|
441
|
+
};
|
|
326
442
|
type GetGeoAreaParam = {
|
|
327
443
|
/**
|
|
328
444
|
* - A unique identifier for the GeoArea.
|
|
@@ -418,6 +534,11 @@ type GetZonesParam = {
|
|
|
418
534
|
* - Current page number.
|
|
419
535
|
*/
|
|
420
536
|
pageNo?: number;
|
|
537
|
+
/**
|
|
538
|
+
* - Slug identifier for filtering by
|
|
539
|
+
* fulfillment option.
|
|
540
|
+
*/
|
|
541
|
+
fulfillmentOptionSlug?: string;
|
|
421
542
|
/**
|
|
422
543
|
* - Status of Zone (either active or inactive)
|
|
423
544
|
*/
|
|
@@ -454,6 +575,13 @@ type InsertApplicationConfigParam = {
|
|
|
454
575
|
type PatchApplicationConfigurationParam = {
|
|
455
576
|
body: ServiceabilityPlatformModel.ApplicationConfigPatch;
|
|
456
577
|
};
|
|
578
|
+
type PutFulfillmentOptionParam = {
|
|
579
|
+
/**
|
|
580
|
+
* - Slug of the fulfillment option for retrieving details.
|
|
581
|
+
*/
|
|
582
|
+
slug: string;
|
|
583
|
+
body: ServiceabilityPlatformModel.FulfillmentOption;
|
|
584
|
+
};
|
|
457
585
|
type UpdateApplicationConfigurationParam = {
|
|
458
586
|
body: ServiceabilityPlatformModel.ApplicationConfigPutDetail;
|
|
459
587
|
};
|
|
@@ -530,6 +658,16 @@ type UpdateZoneParam = {
|
|
|
530
658
|
zoneId: string;
|
|
531
659
|
body: ServiceabilityPlatformModel.UpdateZoneData;
|
|
532
660
|
};
|
|
661
|
+
type UploadBulkFulfillmentOptionsParam = {
|
|
662
|
+
body: ServiceabilityPlatformModel.FulfillmentOptionBulk;
|
|
663
|
+
};
|
|
664
|
+
type ValidateBulkFulfillmentOptionsParam = {
|
|
665
|
+
/**
|
|
666
|
+
* - Type of entity being validated (stores or products).
|
|
667
|
+
*/
|
|
668
|
+
type: string;
|
|
669
|
+
body: ServiceabilityPlatformModel.FulfillmentOptionBulkValidate;
|
|
670
|
+
};
|
|
533
671
|
type DownloadGeoareaSampleFileParam = any;
|
|
534
672
|
type GetApplicationConfigParam = any;
|
|
535
673
|
type GetApplicationConfigurationParam = any;
|
|
@@ -17,6 +17,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
17
17
|
* @property {ServiceabilityPlatformModel.CourierPartnerRule} body
|
|
18
18
|
*/
|
|
19
19
|
|
|
20
|
+
/**
|
|
21
|
+
* @typedef CreateFulfillmentOptionParam
|
|
22
|
+
* @property {ServiceabilityPlatformModel.FulfillmentOption} body
|
|
23
|
+
*/
|
|
24
|
+
|
|
20
25
|
/**
|
|
21
26
|
* @typedef CreateGeoAreaParam
|
|
22
27
|
* @property {ServiceabilityPlatformModel.GeoAreaRequestBody} body
|
|
@@ -37,6 +42,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
37
42
|
* @property {ServiceabilityPlatformModel.CreateZoneDataSchema} body
|
|
38
43
|
*/
|
|
39
44
|
|
|
45
|
+
/**
|
|
46
|
+
* @typedef DeleteFulfillmentOptionsParam
|
|
47
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
48
|
+
*/
|
|
49
|
+
|
|
40
50
|
/**
|
|
41
51
|
* @typedef DeleteZoneParam
|
|
42
52
|
* @property {string} zoneId - Unique identifier for a particular zone
|
|
@@ -53,6 +63,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
53
63
|
* @property {string} batchId - A `batch_id` is a unique identifier for a particular zone.
|
|
54
64
|
*/
|
|
55
65
|
|
|
66
|
+
/**
|
|
67
|
+
* @typedef GetBulkFulfillmentValidationStatusParam
|
|
68
|
+
* @property {string} bulkId - Unique id created by validate api.
|
|
69
|
+
*/
|
|
70
|
+
|
|
56
71
|
/**
|
|
57
72
|
* @typedef GetBulkGeoAreaParam
|
|
58
73
|
* @property {string} geoareaId - A unique identifier for the GeoArea.
|
|
@@ -75,6 +90,26 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
75
90
|
* @property {ServiceabilityPlatformModel.ShipmentCourierPartnerDetails} body
|
|
76
91
|
*/
|
|
77
92
|
|
|
93
|
+
/**
|
|
94
|
+
* @typedef GetFulfillmentOptionProductsParam
|
|
95
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
96
|
+
* @property {string} [q] - Query to search product by name.
|
|
97
|
+
* @property {number} storeId - The unique identifier of the store.
|
|
98
|
+
*/
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* @typedef GetFulfillmentOptionStoresParam
|
|
102
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
103
|
+
* @property {string} [q] - Query to search product by name.
|
|
104
|
+
*/
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* @typedef GetFulfillmentOptionsParam
|
|
108
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
109
|
+
* @property {number} [productId] - The unique identifier of the product.
|
|
110
|
+
* @property {number} [storeId] - The unique identifier of the store.
|
|
111
|
+
*/
|
|
112
|
+
|
|
78
113
|
/**
|
|
79
114
|
* @typedef GetGeoAreaParam
|
|
80
115
|
* @property {string} geoareaId - A unique identifier for the GeoArea.
|
|
@@ -123,6 +158,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
123
158
|
* @property {string} [stage] - Identifies the specific stage of zone bing requested.
|
|
124
159
|
* @property {number} [pageSize] - Defines the number of items displayed per page.
|
|
125
160
|
* @property {number} [pageNo] - Current page number.
|
|
161
|
+
* @property {string} [fulfillmentOptionSlug] - Slug identifier for filtering by
|
|
162
|
+
* fulfillment option.
|
|
126
163
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
127
164
|
* @property {string} [q] - Used to search for matching results based on the
|
|
128
165
|
* provided input.
|
|
@@ -143,6 +180,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
143
180
|
* @property {ServiceabilityPlatformModel.ApplicationConfigPatch} body
|
|
144
181
|
*/
|
|
145
182
|
|
|
183
|
+
/**
|
|
184
|
+
* @typedef PutFulfillmentOptionParam
|
|
185
|
+
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
186
|
+
* @property {ServiceabilityPlatformModel.FulfillmentOption} body
|
|
187
|
+
*/
|
|
188
|
+
|
|
146
189
|
/**
|
|
147
190
|
* @typedef UpdateApplicationConfigurationParam
|
|
148
191
|
* @property {ServiceabilityPlatformModel.ApplicationConfigPutDetail} body
|
|
@@ -218,6 +261,17 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
218
261
|
* @property {ServiceabilityPlatformModel.UpdateZoneData} body
|
|
219
262
|
*/
|
|
220
263
|
|
|
264
|
+
/**
|
|
265
|
+
* @typedef UploadBulkFulfillmentOptionsParam
|
|
266
|
+
* @property {ServiceabilityPlatformModel.FulfillmentOptionBulk} body
|
|
267
|
+
*/
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* @typedef ValidateBulkFulfillmentOptionsParam
|
|
271
|
+
* @property {string} type - Type of entity being validated (stores or products).
|
|
272
|
+
* @property {ServiceabilityPlatformModel.FulfillmentOptionBulkValidate} body
|
|
273
|
+
*/
|
|
274
|
+
|
|
221
275
|
class ServiceabilityPlatformApplicationValidator {
|
|
222
276
|
/** @returns {CreateBulkExportParam} */
|
|
223
277
|
static createBulkExport() {
|
|
@@ -240,6 +294,13 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
240
294
|
}).required();
|
|
241
295
|
}
|
|
242
296
|
|
|
297
|
+
/** @returns {CreateFulfillmentOptionParam} */
|
|
298
|
+
static createFulfillmentOption() {
|
|
299
|
+
return Joi.object({
|
|
300
|
+
body: ServiceabilityPlatformModel.FulfillmentOption().required(),
|
|
301
|
+
}).required();
|
|
302
|
+
}
|
|
303
|
+
|
|
243
304
|
/** @returns {CreateGeoAreaParam} */
|
|
244
305
|
static createGeoArea() {
|
|
245
306
|
return Joi.object({
|
|
@@ -268,6 +329,13 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
268
329
|
}).required();
|
|
269
330
|
}
|
|
270
331
|
|
|
332
|
+
/** @returns {DeleteFulfillmentOptionsParam} */
|
|
333
|
+
static deleteFulfillmentOptions() {
|
|
334
|
+
return Joi.object({
|
|
335
|
+
slug: Joi.string().allow("").required(),
|
|
336
|
+
}).required();
|
|
337
|
+
}
|
|
338
|
+
|
|
271
339
|
/** @returns {DeleteZoneParam} */
|
|
272
340
|
static deleteZone() {
|
|
273
341
|
return Joi.object({
|
|
@@ -297,6 +365,13 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
297
365
|
}).required();
|
|
298
366
|
}
|
|
299
367
|
|
|
368
|
+
/** @returns {GetBulkFulfillmentValidationStatusParam} */
|
|
369
|
+
static getBulkFulfillmentValidationStatus() {
|
|
370
|
+
return Joi.object({
|
|
371
|
+
bulkId: Joi.string().allow("").required(),
|
|
372
|
+
}).required();
|
|
373
|
+
}
|
|
374
|
+
|
|
300
375
|
/** @returns {GetBulkGeoAreaParam} */
|
|
301
376
|
static getBulkGeoArea() {
|
|
302
377
|
return Joi.object({
|
|
@@ -327,6 +402,32 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
327
402
|
}).required();
|
|
328
403
|
}
|
|
329
404
|
|
|
405
|
+
/** @returns {GetFulfillmentOptionProductsParam} */
|
|
406
|
+
static getFulfillmentOptionProducts() {
|
|
407
|
+
return Joi.object({
|
|
408
|
+
slug: Joi.string().allow("").required(),
|
|
409
|
+
q: Joi.string().allow(""),
|
|
410
|
+
storeId: Joi.number().required(),
|
|
411
|
+
}).required();
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
/** @returns {GetFulfillmentOptionStoresParam} */
|
|
415
|
+
static getFulfillmentOptionStores() {
|
|
416
|
+
return Joi.object({
|
|
417
|
+
slug: Joi.string().allow("").required(),
|
|
418
|
+
q: Joi.string().allow(""),
|
|
419
|
+
}).required();
|
|
420
|
+
}
|
|
421
|
+
|
|
422
|
+
/** @returns {GetFulfillmentOptionsParam} */
|
|
423
|
+
static getFulfillmentOptions() {
|
|
424
|
+
return Joi.object({
|
|
425
|
+
slug: Joi.string().allow("").required(),
|
|
426
|
+
productId: Joi.number(),
|
|
427
|
+
storeId: Joi.number(),
|
|
428
|
+
}).required();
|
|
429
|
+
}
|
|
430
|
+
|
|
330
431
|
/** @returns {GetGeoAreaParam} */
|
|
331
432
|
static getGeoArea() {
|
|
332
433
|
return Joi.object({
|
|
@@ -386,6 +487,7 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
386
487
|
stage: Joi.string().allow(""),
|
|
387
488
|
pageSize: Joi.number(),
|
|
388
489
|
pageNo: Joi.number(),
|
|
490
|
+
fulfillmentOptionSlug: Joi.string().allow(""),
|
|
389
491
|
isActive: Joi.boolean(),
|
|
390
492
|
q: Joi.string().allow(""),
|
|
391
493
|
countryIsoCode: Joi.string().allow(""),
|
|
@@ -410,6 +512,14 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
410
512
|
}).required();
|
|
411
513
|
}
|
|
412
514
|
|
|
515
|
+
/** @returns {PutFulfillmentOptionParam} */
|
|
516
|
+
static putFulfillmentOption() {
|
|
517
|
+
return Joi.object({
|
|
518
|
+
slug: Joi.string().allow("").required(),
|
|
519
|
+
body: ServiceabilityPlatformModel.FulfillmentOption().required(),
|
|
520
|
+
}).required();
|
|
521
|
+
}
|
|
522
|
+
|
|
413
523
|
/** @returns {UpdateApplicationConfigurationParam} */
|
|
414
524
|
static updateApplicationConfiguration() {
|
|
415
525
|
return Joi.object({
|
|
@@ -511,6 +621,21 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
511
621
|
body: ServiceabilityPlatformModel.UpdateZoneData().required(),
|
|
512
622
|
}).required();
|
|
513
623
|
}
|
|
624
|
+
|
|
625
|
+
/** @returns {UploadBulkFulfillmentOptionsParam} */
|
|
626
|
+
static uploadBulkFulfillmentOptions() {
|
|
627
|
+
return Joi.object({
|
|
628
|
+
body: ServiceabilityPlatformModel.FulfillmentOptionBulk().required(),
|
|
629
|
+
}).required();
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
/** @returns {ValidateBulkFulfillmentOptionsParam} */
|
|
633
|
+
static validateBulkFulfillmentOptions() {
|
|
634
|
+
return Joi.object({
|
|
635
|
+
type: Joi.string().allow("").required(),
|
|
636
|
+
body: ServiceabilityPlatformModel.FulfillmentOptionBulkValidate().required(),
|
|
637
|
+
}).required();
|
|
638
|
+
}
|
|
514
639
|
}
|
|
515
640
|
|
|
516
641
|
module.exports = ServiceabilityPlatformApplicationValidator;
|
|
@@ -179,7 +179,7 @@ declare class Serviceability {
|
|
|
179
179
|
* @summary: Get created Schemes for courier partner
|
|
180
180
|
* @description: Get created Schemes for courier partner - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerSchemes/).
|
|
181
181
|
*/
|
|
182
|
-
getCourierPartnerSchemes({ schemeType, paymentMode, capabilities, schemeIds, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeList>;
|
|
182
|
+
getCourierPartnerSchemes({ schemeType, paymentMode, capabilities, schemeIds, q, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeList>;
|
|
183
183
|
/**
|
|
184
184
|
* @param {ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam} arg
|
|
185
185
|
* - Arg object
|
|
@@ -290,7 +290,7 @@ declare class Serviceability {
|
|
|
290
290
|
* @summary: Update delivery configuration
|
|
291
291
|
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCompanyConfiguration/).
|
|
292
292
|
*/
|
|
293
|
-
updateCompanyConfiguration({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
293
|
+
updateCompanyConfiguration({ fulfillmentOptionSlug, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
294
294
|
/**
|
|
295
295
|
* @param {ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam} arg
|
|
296
296
|
* - Arg object
|
|
@@ -1247,7 +1247,7 @@ class Serviceability {
|
|
|
1247
1247
|
* @description: Get created Schemes for courier partner - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerSchemes/).
|
|
1248
1248
|
*/
|
|
1249
1249
|
async getCourierPartnerSchemes(
|
|
1250
|
-
{ schemeType, paymentMode, capabilities, schemeIds, requestHeaders } = {
|
|
1250
|
+
{ schemeType, paymentMode, capabilities, schemeIds, q, requestHeaders } = {
|
|
1251
1251
|
requestHeaders: {},
|
|
1252
1252
|
},
|
|
1253
1253
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -1260,6 +1260,7 @@ class Serviceability {
|
|
|
1260
1260
|
paymentMode,
|
|
1261
1261
|
capabilities,
|
|
1262
1262
|
schemeIds,
|
|
1263
|
+
q,
|
|
1263
1264
|
},
|
|
1264
1265
|
{ abortEarly: false, allowUnknown: true }
|
|
1265
1266
|
);
|
|
@@ -1276,6 +1277,7 @@ class Serviceability {
|
|
|
1276
1277
|
paymentMode,
|
|
1277
1278
|
capabilities,
|
|
1278
1279
|
schemeIds,
|
|
1280
|
+
q,
|
|
1279
1281
|
},
|
|
1280
1282
|
{ abortEarly: false, allowUnknown: false }
|
|
1281
1283
|
);
|
|
@@ -1291,6 +1293,7 @@ class Serviceability {
|
|
|
1291
1293
|
query_params["payment_mode"] = paymentMode;
|
|
1292
1294
|
query_params["capabilities"] = capabilities;
|
|
1293
1295
|
query_params["scheme_ids"] = schemeIds;
|
|
1296
|
+
query_params["q"] = q;
|
|
1294
1297
|
|
|
1295
1298
|
const xHeaders = {};
|
|
1296
1299
|
|
|
@@ -2034,13 +2037,14 @@ class Serviceability {
|
|
|
2034
2037
|
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCompanyConfiguration/).
|
|
2035
2038
|
*/
|
|
2036
2039
|
async updateCompanyConfiguration(
|
|
2037
|
-
{ body, requestHeaders } = { requestHeaders: {} },
|
|
2040
|
+
{ fulfillmentOptionSlug, body, requestHeaders } = { requestHeaders: {} },
|
|
2038
2041
|
{ responseHeaders } = { responseHeaders: false }
|
|
2039
2042
|
) {
|
|
2040
2043
|
const {
|
|
2041
2044
|
error,
|
|
2042
2045
|
} = ServiceabilityPlatformValidator.updateCompanyConfiguration().validate(
|
|
2043
2046
|
{
|
|
2047
|
+
fulfillmentOptionSlug,
|
|
2044
2048
|
body,
|
|
2045
2049
|
},
|
|
2046
2050
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -2054,6 +2058,7 @@ class Serviceability {
|
|
|
2054
2058
|
error: warrning,
|
|
2055
2059
|
} = ServiceabilityPlatformValidator.updateCompanyConfiguration().validate(
|
|
2056
2060
|
{
|
|
2061
|
+
fulfillmentOptionSlug,
|
|
2057
2062
|
body,
|
|
2058
2063
|
},
|
|
2059
2064
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -2066,6 +2071,7 @@ class Serviceability {
|
|
|
2066
2071
|
}
|
|
2067
2072
|
|
|
2068
2073
|
const query_params = {};
|
|
2074
|
+
query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
|
|
2069
2075
|
|
|
2070
2076
|
const xHeaders = {};
|
|
2071
2077
|
|