@gofynd/fdk-client-javascript 3.22.0 → 3.23.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/Cart/CartApplicationClient.d.ts +2 -2
- package/sdk/application/Cart/CartApplicationClient.js +5 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +94 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +574 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +70 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +81 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +14 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +85 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1364 -192
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +941 -159
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +10 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +12 -0
|
@@ -23,6 +23,10 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
23
23
|
* @typedef CreateGeoAreaExportJobParam
|
|
24
24
|
* @property {string} geoareaId - The unique identifier of the Geoarea.
|
|
25
25
|
*/
|
|
26
|
+
/**
|
|
27
|
+
* @typedef CreatePolygonParam
|
|
28
|
+
* @property {ServiceabilityPlatformModel.StorePolygonServiceabilityRequestBody} body
|
|
29
|
+
*/
|
|
26
30
|
/**
|
|
27
31
|
* @typedef CreateShipmentsParam
|
|
28
32
|
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
@@ -37,6 +41,10 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
37
41
|
* @typedef CreateZoneParam
|
|
38
42
|
* @property {ServiceabilityPlatformModel.CreateZoneDataSchema} body
|
|
39
43
|
*/
|
|
44
|
+
/**
|
|
45
|
+
* @typedef CreateZoneProductsBulkPatchJobParam
|
|
46
|
+
* @property {ServiceabilityPlatformModel.ZoneProductsBulkPatchDetails} body
|
|
47
|
+
*/
|
|
40
48
|
/**
|
|
41
49
|
* @typedef DeleteFulfillmentOptionsParam
|
|
42
50
|
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
@@ -46,8 +54,13 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
46
54
|
* @property {string} zoneId - Unique identifier for a particular zone
|
|
47
55
|
*/
|
|
48
56
|
/** @typedef DownloadGeoareaSampleFileParam */
|
|
57
|
+
/** @typedef DownloadZoneProductsBulkSampleFileParam */
|
|
49
58
|
/** @typedef GetApplicationConfigParam */
|
|
50
59
|
/** @typedef GetApplicationConfigurationParam */
|
|
60
|
+
/**
|
|
61
|
+
* @typedef GetApplicationCourierPartnersListParam
|
|
62
|
+
* @property {ServiceabilityPlatformModel.CourierPartnerDetails} body
|
|
63
|
+
*/
|
|
51
64
|
/**
|
|
52
65
|
* @typedef GetBulkExportParam
|
|
53
66
|
* @property {string} batchId - A `batch_id` is a unique identifier for a particular zone.
|
|
@@ -120,6 +133,11 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
120
133
|
* @property {string} [pincode] - Pincode value to search geoareas
|
|
121
134
|
* @property {string} [sector] - Sector value to search geoareas
|
|
122
135
|
*/
|
|
136
|
+
/**
|
|
137
|
+
* @typedef GetPolygonParam
|
|
138
|
+
* @property {number} [pageNumber] - Page number to be fetched.
|
|
139
|
+
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
140
|
+
*/
|
|
123
141
|
/**
|
|
124
142
|
* @typedef GetStoreRuleParam
|
|
125
143
|
* @property {string} ruleUid - A `rule_uid` is a unique identifier for a
|
|
@@ -135,6 +153,10 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
135
153
|
* @typedef GetZoneParam
|
|
136
154
|
* @property {string} zoneId - Unique identifier for a particular zone
|
|
137
155
|
*/
|
|
156
|
+
/**
|
|
157
|
+
* @typedef GetZoneProductsBulkPatchJobStatusParam
|
|
158
|
+
* @property {string} batchId - A unique identifier for the bulk zone products patch job.
|
|
159
|
+
*/
|
|
138
160
|
/**
|
|
139
161
|
* @typedef GetZonesParam
|
|
140
162
|
* @property {string} [stage] - Identifies the specific stage of zone bing requested.
|
|
@@ -203,6 +225,10 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
203
225
|
* @typedef UpdatePincodeMopViewParam
|
|
204
226
|
* @property {ServiceabilityPlatformModel.PincodeMopData} body
|
|
205
227
|
*/
|
|
228
|
+
/**
|
|
229
|
+
* @typedef UpdatePolygonParam
|
|
230
|
+
* @property {ServiceabilityPlatformModel.StorePolygonServiceabilityRequestBody} body
|
|
231
|
+
*/
|
|
206
232
|
/**
|
|
207
233
|
* @typedef UpdateStoreRulePriorityParam
|
|
208
234
|
* @property {ServiceabilityPlatformModel.RulePriorityDetails} body
|
|
@@ -244,22 +270,30 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
244
270
|
static createGeoArea(): CreateGeoAreaParam;
|
|
245
271
|
/** @returns {CreateGeoAreaExportJobParam} */
|
|
246
272
|
static createGeoAreaExportJob(): CreateGeoAreaExportJobParam;
|
|
273
|
+
/** @returns {CreatePolygonParam} */
|
|
274
|
+
static createPolygon(): CreatePolygonParam;
|
|
247
275
|
/** @returns {CreateShipmentsParam} */
|
|
248
276
|
static createShipments(): CreateShipmentsParam;
|
|
249
277
|
/** @returns {CreateStoreRulesParam} */
|
|
250
278
|
static createStoreRules(): CreateStoreRulesParam;
|
|
251
279
|
/** @returns {CreateZoneParam} */
|
|
252
280
|
static createZone(): CreateZoneParam;
|
|
281
|
+
/** @returns {CreateZoneProductsBulkPatchJobParam} */
|
|
282
|
+
static createZoneProductsBulkPatchJob(): CreateZoneProductsBulkPatchJobParam;
|
|
253
283
|
/** @returns {DeleteFulfillmentOptionsParam} */
|
|
254
284
|
static deleteFulfillmentOptions(): DeleteFulfillmentOptionsParam;
|
|
255
285
|
/** @returns {DeleteZoneParam} */
|
|
256
286
|
static deleteZone(): DeleteZoneParam;
|
|
257
287
|
/** @returns {DownloadGeoareaSampleFileParam} */
|
|
258
288
|
static downloadGeoareaSampleFile(): any;
|
|
289
|
+
/** @returns {DownloadZoneProductsBulkSampleFileParam} */
|
|
290
|
+
static downloadZoneProductsBulkSampleFile(): any;
|
|
259
291
|
/** @returns {GetApplicationConfigParam} */
|
|
260
292
|
static getApplicationConfig(): any;
|
|
261
293
|
/** @returns {GetApplicationConfigurationParam} */
|
|
262
294
|
static getApplicationConfiguration(): any;
|
|
295
|
+
/** @returns {GetApplicationCourierPartnersListParam} */
|
|
296
|
+
static getApplicationCourierPartnersList(): GetApplicationCourierPartnersListParam;
|
|
263
297
|
/** @returns {GetBulkExportParam} */
|
|
264
298
|
static getBulkExport(): GetBulkExportParam;
|
|
265
299
|
/** @returns {GetBulkFulfillmentValidationStatusParam} */
|
|
@@ -286,12 +320,16 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
286
320
|
static getGeoAreaExportJobStatus(): GetGeoAreaExportJobStatusParam;
|
|
287
321
|
/** @returns {GetGeoAreasParam} */
|
|
288
322
|
static getGeoAreas(): GetGeoAreasParam;
|
|
323
|
+
/** @returns {GetPolygonParam} */
|
|
324
|
+
static getPolygon(): GetPolygonParam;
|
|
289
325
|
/** @returns {GetStoreRuleParam} */
|
|
290
326
|
static getStoreRule(): GetStoreRuleParam;
|
|
291
327
|
/** @returns {GetStoreRulesParam} */
|
|
292
328
|
static getStoreRules(): GetStoreRulesParam;
|
|
293
329
|
/** @returns {GetZoneParam} */
|
|
294
330
|
static getZone(): GetZoneParam;
|
|
331
|
+
/** @returns {GetZoneProductsBulkPatchJobStatusParam} */
|
|
332
|
+
static getZoneProductsBulkPatchJobStatus(): GetZoneProductsBulkPatchJobStatusParam;
|
|
295
333
|
/** @returns {GetZonesParam} */
|
|
296
334
|
static getZones(): GetZonesParam;
|
|
297
335
|
/** @returns {InsertApplicationConfigParam} */
|
|
@@ -316,6 +354,8 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
316
354
|
static updatePincodeCoDListing(): UpdatePincodeCoDListingParam;
|
|
317
355
|
/** @returns {UpdatePincodeMopViewParam} */
|
|
318
356
|
static updatePincodeMopView(): UpdatePincodeMopViewParam;
|
|
357
|
+
/** @returns {UpdatePolygonParam} */
|
|
358
|
+
static updatePolygon(): UpdatePolygonParam;
|
|
319
359
|
/** @returns {UpdateStoreRulePriorityParam} */
|
|
320
360
|
static updateStoreRulePriority(): UpdateStoreRulePriorityParam;
|
|
321
361
|
/** @returns {UpdateStoreRulesParam} */
|
|
@@ -330,7 +370,7 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
330
370
|
static validateBulkFulfillmentOptions(): ValidateBulkFulfillmentOptionsParam;
|
|
331
371
|
}
|
|
332
372
|
declare namespace ServiceabilityPlatformApplicationValidator {
|
|
333
|
-
export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateShipmentsParam, CreateStoreRulesParam, CreateZoneParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetFulfillmentOptionsListParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PutFulfillmentOptionParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
|
|
373
|
+
export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreatePolygonParam, CreateShipmentsParam, CreateStoreRulesParam, CreateZoneParam, CreateZoneProductsBulkPatchJobParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, DownloadZoneProductsBulkSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationCourierPartnersListParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetFulfillmentOptionsListParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetPolygonParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZoneProductsBulkPatchJobStatusParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PutFulfillmentOptionParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdatePolygonParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
|
|
334
374
|
}
|
|
335
375
|
type CreateBulkExportParam = {
|
|
336
376
|
body: ServiceabilityPlatformModel.BulkCreateZoneExport;
|
|
@@ -353,6 +393,9 @@ type CreateGeoAreaExportJobParam = {
|
|
|
353
393
|
*/
|
|
354
394
|
geoareaId: string;
|
|
355
395
|
};
|
|
396
|
+
type CreatePolygonParam = {
|
|
397
|
+
body: ServiceabilityPlatformModel.StorePolygonServiceabilityRequestBody;
|
|
398
|
+
};
|
|
356
399
|
type CreateShipmentsParam = {
|
|
357
400
|
/**
|
|
358
401
|
* - Ordering source header, to be used to
|
|
@@ -367,6 +410,9 @@ type CreateStoreRulesParam = {
|
|
|
367
410
|
type CreateZoneParam = {
|
|
368
411
|
body: ServiceabilityPlatformModel.CreateZoneDataSchema;
|
|
369
412
|
};
|
|
413
|
+
type CreateZoneProductsBulkPatchJobParam = {
|
|
414
|
+
body: ServiceabilityPlatformModel.ZoneProductsBulkPatchDetails;
|
|
415
|
+
};
|
|
370
416
|
type DeleteFulfillmentOptionsParam = {
|
|
371
417
|
/**
|
|
372
418
|
* - Slug of the fulfillment option for retrieving details.
|
|
@@ -379,6 +425,9 @@ type DeleteZoneParam = {
|
|
|
379
425
|
*/
|
|
380
426
|
zoneId: string;
|
|
381
427
|
};
|
|
428
|
+
type GetApplicationCourierPartnersListParam = {
|
|
429
|
+
body: ServiceabilityPlatformModel.CourierPartnerDetails;
|
|
430
|
+
};
|
|
382
431
|
type GetBulkExportParam = {
|
|
383
432
|
/**
|
|
384
433
|
* - A `batch_id` is a unique identifier for a particular zone.
|
|
@@ -528,6 +577,16 @@ type GetGeoAreasParam = {
|
|
|
528
577
|
*/
|
|
529
578
|
sector?: string;
|
|
530
579
|
};
|
|
580
|
+
type GetPolygonParam = {
|
|
581
|
+
/**
|
|
582
|
+
* - Page number to be fetched.
|
|
583
|
+
*/
|
|
584
|
+
pageNumber?: number;
|
|
585
|
+
/**
|
|
586
|
+
* - Determines the items to be displayed in a page
|
|
587
|
+
*/
|
|
588
|
+
pageSize?: number;
|
|
589
|
+
};
|
|
531
590
|
type GetStoreRuleParam = {
|
|
532
591
|
/**
|
|
533
592
|
* - A `rule_uid` is a unique identifier for a
|
|
@@ -555,6 +614,12 @@ type GetZoneParam = {
|
|
|
555
614
|
*/
|
|
556
615
|
zoneId: string;
|
|
557
616
|
};
|
|
617
|
+
type GetZoneProductsBulkPatchJobStatusParam = {
|
|
618
|
+
/**
|
|
619
|
+
* - A unique identifier for the bulk zone products patch job.
|
|
620
|
+
*/
|
|
621
|
+
batchId: string;
|
|
622
|
+
};
|
|
558
623
|
type GetZonesParam = {
|
|
559
624
|
/**
|
|
560
625
|
* - Identifies the specific stage of zone bing requested.
|
|
@@ -668,6 +733,9 @@ type UpdatePincodeCoDListingParam = {
|
|
|
668
733
|
type UpdatePincodeMopViewParam = {
|
|
669
734
|
body: ServiceabilityPlatformModel.PincodeMopData;
|
|
670
735
|
};
|
|
736
|
+
type UpdatePolygonParam = {
|
|
737
|
+
body: ServiceabilityPlatformModel.StorePolygonServiceabilityRequestBody;
|
|
738
|
+
};
|
|
671
739
|
type UpdateStoreRulePriorityParam = {
|
|
672
740
|
body: ServiceabilityPlatformModel.RulePriorityDetails;
|
|
673
741
|
};
|
|
@@ -700,6 +768,7 @@ type ValidateBulkFulfillmentOptionsParam = {
|
|
|
700
768
|
body: ServiceabilityPlatformModel.FulfillmentOptionBulkValidate;
|
|
701
769
|
};
|
|
702
770
|
type DownloadGeoareaSampleFileParam = any;
|
|
771
|
+
type DownloadZoneProductsBulkSampleFileParam = any;
|
|
703
772
|
type GetApplicationConfigParam = any;
|
|
704
773
|
type GetApplicationConfigurationParam = any;
|
|
705
774
|
import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
@@ -32,6 +32,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
32
32
|
* @property {string} geoareaId - The unique identifier of the Geoarea.
|
|
33
33
|
*/
|
|
34
34
|
|
|
35
|
+
/**
|
|
36
|
+
* @typedef CreatePolygonParam
|
|
37
|
+
* @property {ServiceabilityPlatformModel.StorePolygonServiceabilityRequestBody} body
|
|
38
|
+
*/
|
|
39
|
+
|
|
35
40
|
/**
|
|
36
41
|
* @typedef CreateShipmentsParam
|
|
37
42
|
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
@@ -49,6 +54,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
49
54
|
* @property {ServiceabilityPlatformModel.CreateZoneDataSchema} body
|
|
50
55
|
*/
|
|
51
56
|
|
|
57
|
+
/**
|
|
58
|
+
* @typedef CreateZoneProductsBulkPatchJobParam
|
|
59
|
+
* @property {ServiceabilityPlatformModel.ZoneProductsBulkPatchDetails} body
|
|
60
|
+
*/
|
|
61
|
+
|
|
52
62
|
/**
|
|
53
63
|
* @typedef DeleteFulfillmentOptionsParam
|
|
54
64
|
* @property {string} slug - Slug of the fulfillment option for retrieving details.
|
|
@@ -61,10 +71,17 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
61
71
|
|
|
62
72
|
/** @typedef DownloadGeoareaSampleFileParam */
|
|
63
73
|
|
|
74
|
+
/** @typedef DownloadZoneProductsBulkSampleFileParam */
|
|
75
|
+
|
|
64
76
|
/** @typedef GetApplicationConfigParam */
|
|
65
77
|
|
|
66
78
|
/** @typedef GetApplicationConfigurationParam */
|
|
67
79
|
|
|
80
|
+
/**
|
|
81
|
+
* @typedef GetApplicationCourierPartnersListParam
|
|
82
|
+
* @property {ServiceabilityPlatformModel.CourierPartnerDetails} body
|
|
83
|
+
*/
|
|
84
|
+
|
|
68
85
|
/**
|
|
69
86
|
* @typedef GetBulkExportParam
|
|
70
87
|
* @property {string} batchId - A `batch_id` is a unique identifier for a particular zone.
|
|
@@ -150,6 +167,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
150
167
|
* @property {string} [sector] - Sector value to search geoareas
|
|
151
168
|
*/
|
|
152
169
|
|
|
170
|
+
/**
|
|
171
|
+
* @typedef GetPolygonParam
|
|
172
|
+
* @property {number} [pageNumber] - Page number to be fetched.
|
|
173
|
+
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
174
|
+
*/
|
|
175
|
+
|
|
153
176
|
/**
|
|
154
177
|
* @typedef GetStoreRuleParam
|
|
155
178
|
* @property {string} ruleUid - A `rule_uid` is a unique identifier for a
|
|
@@ -168,6 +191,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
168
191
|
* @property {string} zoneId - Unique identifier for a particular zone
|
|
169
192
|
*/
|
|
170
193
|
|
|
194
|
+
/**
|
|
195
|
+
* @typedef GetZoneProductsBulkPatchJobStatusParam
|
|
196
|
+
* @property {string} batchId - A unique identifier for the bulk zone products patch job.
|
|
197
|
+
*/
|
|
198
|
+
|
|
171
199
|
/**
|
|
172
200
|
* @typedef GetZonesParam
|
|
173
201
|
* @property {string} [stage] - Identifies the specific stage of zone bing requested.
|
|
@@ -248,6 +276,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
248
276
|
* @property {ServiceabilityPlatformModel.PincodeMopData} body
|
|
249
277
|
*/
|
|
250
278
|
|
|
279
|
+
/**
|
|
280
|
+
* @typedef UpdatePolygonParam
|
|
281
|
+
* @property {ServiceabilityPlatformModel.StorePolygonServiceabilityRequestBody} body
|
|
282
|
+
*/
|
|
283
|
+
|
|
251
284
|
/**
|
|
252
285
|
* @typedef UpdateStoreRulePriorityParam
|
|
253
286
|
* @property {ServiceabilityPlatformModel.RulePriorityDetails} body
|
|
@@ -325,6 +358,13 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
325
358
|
}).required();
|
|
326
359
|
}
|
|
327
360
|
|
|
361
|
+
/** @returns {CreatePolygonParam} */
|
|
362
|
+
static createPolygon() {
|
|
363
|
+
return Joi.object({
|
|
364
|
+
body: ServiceabilityPlatformModel.StorePolygonServiceabilityRequestBody().required(),
|
|
365
|
+
}).required();
|
|
366
|
+
}
|
|
367
|
+
|
|
328
368
|
/** @returns {CreateShipmentsParam} */
|
|
329
369
|
static createShipments() {
|
|
330
370
|
return Joi.object({
|
|
@@ -348,6 +388,13 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
348
388
|
}).required();
|
|
349
389
|
}
|
|
350
390
|
|
|
391
|
+
/** @returns {CreateZoneProductsBulkPatchJobParam} */
|
|
392
|
+
static createZoneProductsBulkPatchJob() {
|
|
393
|
+
return Joi.object({
|
|
394
|
+
body: ServiceabilityPlatformModel.ZoneProductsBulkPatchDetails().required(),
|
|
395
|
+
}).required();
|
|
396
|
+
}
|
|
397
|
+
|
|
351
398
|
/** @returns {DeleteFulfillmentOptionsParam} */
|
|
352
399
|
static deleteFulfillmentOptions() {
|
|
353
400
|
return Joi.object({
|
|
@@ -367,6 +414,11 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
367
414
|
return Joi.object({}).required();
|
|
368
415
|
}
|
|
369
416
|
|
|
417
|
+
/** @returns {DownloadZoneProductsBulkSampleFileParam} */
|
|
418
|
+
static downloadZoneProductsBulkSampleFile() {
|
|
419
|
+
return Joi.object({}).required();
|
|
420
|
+
}
|
|
421
|
+
|
|
370
422
|
/** @returns {GetApplicationConfigParam} */
|
|
371
423
|
static getApplicationConfig() {
|
|
372
424
|
return Joi.object({}).required();
|
|
@@ -377,6 +429,13 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
377
429
|
return Joi.object({}).required();
|
|
378
430
|
}
|
|
379
431
|
|
|
432
|
+
/** @returns {GetApplicationCourierPartnersListParam} */
|
|
433
|
+
static getApplicationCourierPartnersList() {
|
|
434
|
+
return Joi.object({
|
|
435
|
+
body: ServiceabilityPlatformModel.CourierPartnerDetails().required(),
|
|
436
|
+
}).required();
|
|
437
|
+
}
|
|
438
|
+
|
|
380
439
|
/** @returns {GetBulkExportParam} */
|
|
381
440
|
static getBulkExport() {
|
|
382
441
|
return Joi.object({
|
|
@@ -486,6 +545,14 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
486
545
|
}).required();
|
|
487
546
|
}
|
|
488
547
|
|
|
548
|
+
/** @returns {GetPolygonParam} */
|
|
549
|
+
static getPolygon() {
|
|
550
|
+
return Joi.object({
|
|
551
|
+
pageNumber: Joi.number(),
|
|
552
|
+
pageSize: Joi.number(),
|
|
553
|
+
}).required();
|
|
554
|
+
}
|
|
555
|
+
|
|
489
556
|
/** @returns {GetStoreRuleParam} */
|
|
490
557
|
static getStoreRule() {
|
|
491
558
|
return Joi.object({
|
|
@@ -509,6 +576,13 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
509
576
|
}).required();
|
|
510
577
|
}
|
|
511
578
|
|
|
579
|
+
/** @returns {GetZoneProductsBulkPatchJobStatusParam} */
|
|
580
|
+
static getZoneProductsBulkPatchJobStatus() {
|
|
581
|
+
return Joi.object({
|
|
582
|
+
batchId: Joi.string().allow("").required(),
|
|
583
|
+
}).required();
|
|
584
|
+
}
|
|
585
|
+
|
|
512
586
|
/** @returns {GetZonesParam} */
|
|
513
587
|
static getZones() {
|
|
514
588
|
return Joi.object({
|
|
@@ -612,6 +686,13 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
612
686
|
}).required();
|
|
613
687
|
}
|
|
614
688
|
|
|
689
|
+
/** @returns {UpdatePolygonParam} */
|
|
690
|
+
static updatePolygon() {
|
|
691
|
+
return Joi.object({
|
|
692
|
+
body: ServiceabilityPlatformModel.StorePolygonServiceabilityRequestBody().required(),
|
|
693
|
+
}).required();
|
|
694
|
+
}
|
|
695
|
+
|
|
615
696
|
/** @returns {UpdateStoreRulePriorityParam} */
|
|
616
697
|
static updateStoreRulePriority() {
|
|
617
698
|
return Joi.object({
|
|
@@ -115,6 +115,20 @@ declare class Serviceability {
|
|
|
115
115
|
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
116
116
|
*/
|
|
117
117
|
getCompanyConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
118
|
+
/**
|
|
119
|
+
* @param {ServiceabilityPlatformValidator.GetCompanyCourierPartnersListParam} arg
|
|
120
|
+
* - Arg object
|
|
121
|
+
*
|
|
122
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
|
+
* @returns {Promise<ServiceabilityPlatformModel.GenerateShipmentsAndCourierPartnerResult>}
|
|
125
|
+
* - Success response
|
|
126
|
+
*
|
|
127
|
+
* @name getCompanyCourierPartnersList
|
|
128
|
+
* @summary: Get available company courier partners
|
|
129
|
+
* @description: Retrieves a list of courier partners available for shipping based on serviceability criteria, shipment details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCompanyCourierPartnersList/).
|
|
130
|
+
*/
|
|
131
|
+
getCompanyCourierPartnersList({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetCompanyCourierPartnersListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GenerateShipmentsAndCourierPartnerResult>;
|
|
118
132
|
/**
|
|
119
133
|
* @param {ServiceabilityPlatformValidator.GetCountriesParam} arg - Arg object
|
|
120
134
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -853,6 +853,91 @@ class Serviceability {
|
|
|
853
853
|
return response;
|
|
854
854
|
}
|
|
855
855
|
|
|
856
|
+
/**
|
|
857
|
+
* @param {ServiceabilityPlatformValidator.GetCompanyCourierPartnersListParam} arg
|
|
858
|
+
* - Arg object
|
|
859
|
+
*
|
|
860
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
861
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
862
|
+
* @returns {Promise<ServiceabilityPlatformModel.GenerateShipmentsAndCourierPartnerResult>}
|
|
863
|
+
* - Success response
|
|
864
|
+
*
|
|
865
|
+
* @name getCompanyCourierPartnersList
|
|
866
|
+
* @summary: Get available company courier partners
|
|
867
|
+
* @description: Retrieves a list of courier partners available for shipping based on serviceability criteria, shipment details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCompanyCourierPartnersList/).
|
|
868
|
+
*/
|
|
869
|
+
async getCompanyCourierPartnersList(
|
|
870
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
871
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
872
|
+
) {
|
|
873
|
+
const {
|
|
874
|
+
error,
|
|
875
|
+
} = ServiceabilityPlatformValidator.getCompanyCourierPartnersList().validate(
|
|
876
|
+
{
|
|
877
|
+
body,
|
|
878
|
+
},
|
|
879
|
+
{ abortEarly: false, allowUnknown: true }
|
|
880
|
+
);
|
|
881
|
+
if (error) {
|
|
882
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
883
|
+
}
|
|
884
|
+
|
|
885
|
+
// Showing warrnings if extra unknown parameters are found
|
|
886
|
+
const {
|
|
887
|
+
error: warrning,
|
|
888
|
+
} = ServiceabilityPlatformValidator.getCompanyCourierPartnersList().validate(
|
|
889
|
+
{
|
|
890
|
+
body,
|
|
891
|
+
},
|
|
892
|
+
{ abortEarly: false, allowUnknown: false }
|
|
893
|
+
);
|
|
894
|
+
if (warrning) {
|
|
895
|
+
Logger({
|
|
896
|
+
level: "WARN",
|
|
897
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getCompanyCourierPartnersList \n ${warrning}`,
|
|
898
|
+
});
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
const query_params = {};
|
|
902
|
+
|
|
903
|
+
const xHeaders = {};
|
|
904
|
+
|
|
905
|
+
const response = await PlatformAPIClient.execute(
|
|
906
|
+
this.config,
|
|
907
|
+
"post",
|
|
908
|
+
`/service/platform/logistics/v2.0/company/${this.config.companyId}/courier-partners`,
|
|
909
|
+
query_params,
|
|
910
|
+
body,
|
|
911
|
+
{ ...xHeaders, ...requestHeaders },
|
|
912
|
+
{ responseHeaders }
|
|
913
|
+
);
|
|
914
|
+
|
|
915
|
+
let responseData = response;
|
|
916
|
+
if (responseHeaders) {
|
|
917
|
+
responseData = response[0];
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
const {
|
|
921
|
+
error: res_error,
|
|
922
|
+
} = ServiceabilityPlatformModel.GenerateShipmentsAndCourierPartnerResult().validate(
|
|
923
|
+
responseData,
|
|
924
|
+
{ abortEarly: false, allowUnknown: true }
|
|
925
|
+
);
|
|
926
|
+
|
|
927
|
+
if (res_error) {
|
|
928
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
929
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
930
|
+
} else {
|
|
931
|
+
Logger({
|
|
932
|
+
level: "WARN",
|
|
933
|
+
message: `Response Validation Warnings for platform > Serviceability > getCompanyCourierPartnersList \n ${res_error}`,
|
|
934
|
+
});
|
|
935
|
+
}
|
|
936
|
+
}
|
|
937
|
+
|
|
938
|
+
return response;
|
|
939
|
+
}
|
|
940
|
+
|
|
856
941
|
/**
|
|
857
942
|
* @param {ServiceabilityPlatformValidator.GetCountriesParam} arg - Arg object
|
|
858
943
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|