@gofynd/fdk-client-javascript 1.4.15 → 1.4.16-beta.1
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 +11 -11
- package/sdk/application/Cart/CartApplicationClient.js +343 -48
- package/sdk/application/Catalog/CatalogApplicationClient.js +408 -0
- package/sdk/application/Common/CommonApplicationClient.js +21 -0
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +147 -0
- package/sdk/application/Content/ContentApplicationClient.d.ts +20 -0
- package/sdk/application/Content/ContentApplicationClient.js +327 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +43 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +21 -0
- package/sdk/application/Lead/LeadApplicationClient.js +73 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.js +182 -2
- package/sdk/application/Order/OrderApplicationClient.js +202 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -10
- package/sdk/application/Payment/PaymentApplicationClient.js +445 -38
- package/sdk/application/Rewards/RewardsApplicationClient.js +68 -0
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.js +64 -0
- package/sdk/application/User/UserApplicationClient.js +412 -0
- package/sdk/application/Webhook/WebhookApplicationClient.js +13 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +12 -33
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +38 -209
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +19 -399
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +11 -212
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -3
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -22
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
- package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +12 -3
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -1
- package/sdk/platform/Cart/CartPlatformModel.d.ts +14 -28
- package/sdk/platform/Cart/CartPlatformModel.js +7 -13
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -24
- package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -176
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +29 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.js +32 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -45
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -35
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +52 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +411 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +85 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +73 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +90 -1
- package/sdk/platform/Content/ContentPlatformModel.js +104 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformClient.js +0 -8
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3 -75
- package/sdk/platform/Order/OrderPlatformModel.js +2 -43
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +0 -22
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +118 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +53 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +29 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +0 -104
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +74 -816
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +23 -598
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +20 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -191
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +0 -138
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
- package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
- package/sdk/public/Configuration/ConfigurationPublicClient.js +16 -0
- package/sdk/public/Content/ContentPublicClient.js +116 -0
- package/sdk/public/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +40 -0
|
@@ -15,10 +15,6 @@ export = ServiceabilityPlatformValidator;
|
|
|
15
15
|
* @typedef CreateCourierPartnerAccountParam
|
|
16
16
|
* @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
|
|
17
17
|
*/
|
|
18
|
-
/**
|
|
19
|
-
* @typedef CreateCourierPartnerSchemeParam
|
|
20
|
-
* @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
|
|
21
|
-
*/
|
|
22
18
|
/**
|
|
23
19
|
* @typedef CreatePackageMaterialParam
|
|
24
20
|
* @property {ServiceabilityPlatformModel.PackageMaterial} body
|
|
@@ -61,15 +57,6 @@ export = ServiceabilityPlatformValidator;
|
|
|
61
57
|
* @property {string} [endDate] - Fetch job history before a particule date
|
|
62
58
|
*/
|
|
63
59
|
/** @typedef GetCompanyConfigurationParam */
|
|
64
|
-
/**
|
|
65
|
-
* @typedef GetCountriesParam
|
|
66
|
-
* @property {boolean} [onboarding] - Only fetch countries which allowed for
|
|
67
|
-
* onboard on Platform.
|
|
68
|
-
* @property {number} [pageNo] - Page number.
|
|
69
|
-
* @property {number} [pageSize] - Page size.
|
|
70
|
-
* @property {string} [q] - Search.
|
|
71
|
-
* @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
|
|
72
|
-
*/
|
|
73
60
|
/**
|
|
74
61
|
* @typedef GetCourierPartnerAccountParam
|
|
75
62
|
* @property {string} accountId - Unique ID of courier partner account
|
|
@@ -82,20 +69,6 @@ export = ServiceabilityPlatformValidator;
|
|
|
82
69
|
* @property {string} [paymentMode] - Filters dp accounts based on payment mode
|
|
83
70
|
* @property {string} [transportType] - Filters dp accounts based on transport_type
|
|
84
71
|
*/
|
|
85
|
-
/**
|
|
86
|
-
* @typedef GetCourierPartnerSchemeParam
|
|
87
|
-
* @property {string} schemeId - Unique Identifier of Scheme
|
|
88
|
-
*/
|
|
89
|
-
/**
|
|
90
|
-
* @typedef GetCourierPartnerSchemesParam
|
|
91
|
-
* @property {string} [schemeType] - Indicates whether a scheme is created by an
|
|
92
|
-
* admin for global purposes or customized for a specific company.
|
|
93
|
-
* @property {string} [paymentMode] - Indicates payment mode for a scheme.
|
|
94
|
-
* @property {string[]} [capabilities] - Indicates whether the scheme possesses
|
|
95
|
-
* certain capabilities.
|
|
96
|
-
* @property {string[]} [schemeIds] - List of scheme ids which need to be
|
|
97
|
-
* returned in the response.
|
|
98
|
-
*/
|
|
99
72
|
/**
|
|
100
73
|
* @typedef GetOptimalLocationsParam
|
|
101
74
|
* @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
|
|
@@ -123,12 +96,6 @@ export = ServiceabilityPlatformValidator;
|
|
|
123
96
|
* @typedef GetPackageMaterialsParam
|
|
124
97
|
* @property {string} packageMaterialId - Unique identifier for a Package. Material
|
|
125
98
|
*/
|
|
126
|
-
/**
|
|
127
|
-
* @typedef GetSampleFileServiceabilityStatusParam
|
|
128
|
-
* @property {number} [pageNo] - Index of the item to start returning with
|
|
129
|
-
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
130
|
-
* @property {string} [batchId] - Batch id of the execution
|
|
131
|
-
*/
|
|
132
99
|
/**
|
|
133
100
|
* @typedef GetServiceabilityParam
|
|
134
101
|
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
@@ -139,23 +106,6 @@ export = ServiceabilityPlatformValidator;
|
|
|
139
106
|
* @typedef GetZoneByIdParam
|
|
140
107
|
* @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
|
|
141
108
|
*/
|
|
142
|
-
/**
|
|
143
|
-
* @typedef GetZonesParam
|
|
144
|
-
* @property {number} [pageNo] - Index of the item to start returning with
|
|
145
|
-
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
146
|
-
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
147
|
-
* @property {string} [channelId] - Zones filtered by an application
|
|
148
|
-
* @property {string} [q] - Search with name as a free text
|
|
149
|
-
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
150
|
-
* @property {string} [state] - State name
|
|
151
|
-
* @property {string} [city] - City name
|
|
152
|
-
* @property {string} [pincode] - Pincode value to search zones
|
|
153
|
-
* @property {string} [sector] - Sector value to search zones
|
|
154
|
-
*/
|
|
155
|
-
/**
|
|
156
|
-
* @typedef SampleFileServiceabilityParam
|
|
157
|
-
* @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
|
|
158
|
-
*/
|
|
159
109
|
/**
|
|
160
110
|
* @typedef UpdateCompanyConfigurationParam
|
|
161
111
|
* @property {ServiceabilityPlatformModel.CompanyConfig} body
|
|
@@ -165,11 +115,6 @@ export = ServiceabilityPlatformValidator;
|
|
|
165
115
|
* @property {string} accountId - Unique ID of courier partner account
|
|
166
116
|
* @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
|
|
167
117
|
*/
|
|
168
|
-
/**
|
|
169
|
-
* @typedef UpdateCourierPartnerSchemeParam
|
|
170
|
-
* @property {string} schemeId - Unique Identifier of Scheme
|
|
171
|
-
* @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
|
|
172
|
-
*/
|
|
173
118
|
/**
|
|
174
119
|
* @typedef UpdatePackageMaterialRuleParam
|
|
175
120
|
* @property {string} ruleId - A `package_material_rule_id` is a unique
|
|
@@ -200,8 +145,6 @@ declare class ServiceabilityPlatformValidator {
|
|
|
200
145
|
static bulkTat(): BulkTatParam;
|
|
201
146
|
/** @returns {CreateCourierPartnerAccountParam} */
|
|
202
147
|
static createCourierPartnerAccount(): CreateCourierPartnerAccountParam;
|
|
203
|
-
/** @returns {CreateCourierPartnerSchemeParam} */
|
|
204
|
-
static createCourierPartnerScheme(): CreateCourierPartnerSchemeParam;
|
|
205
148
|
/** @returns {CreatePackageMaterialParam} */
|
|
206
149
|
static createPackageMaterial(): CreatePackageMaterialParam;
|
|
207
150
|
/** @returns {CreatePackageMaterialRuleParam} */
|
|
@@ -216,16 +159,10 @@ declare class ServiceabilityPlatformValidator {
|
|
|
216
159
|
static getBulkTat(): GetBulkTatParam;
|
|
217
160
|
/** @returns {GetCompanyConfigurationParam} */
|
|
218
161
|
static getCompanyConfiguration(): any;
|
|
219
|
-
/** @returns {GetCountriesParam} */
|
|
220
|
-
static getCountries(): GetCountriesParam;
|
|
221
162
|
/** @returns {GetCourierPartnerAccountParam} */
|
|
222
163
|
static getCourierPartnerAccount(): GetCourierPartnerAccountParam;
|
|
223
164
|
/** @returns {GetCourierPartnerAccountsParam} */
|
|
224
165
|
static getCourierPartnerAccounts(): GetCourierPartnerAccountsParam;
|
|
225
|
-
/** @returns {GetCourierPartnerSchemeParam} */
|
|
226
|
-
static getCourierPartnerScheme(): GetCourierPartnerSchemeParam;
|
|
227
|
-
/** @returns {GetCourierPartnerSchemesParam} */
|
|
228
|
-
static getCourierPartnerSchemes(): GetCourierPartnerSchemesParam;
|
|
229
166
|
/** @returns {GetOptimalLocationsParam} */
|
|
230
167
|
static getOptimalLocations(): GetOptimalLocationsParam;
|
|
231
168
|
/** @returns {GetPackageMaterialListParam} */
|
|
@@ -236,22 +173,14 @@ declare class ServiceabilityPlatformValidator {
|
|
|
236
173
|
static getPackageMaterialRules(): GetPackageMaterialRulesParam;
|
|
237
174
|
/** @returns {GetPackageMaterialsParam} */
|
|
238
175
|
static getPackageMaterials(): GetPackageMaterialsParam;
|
|
239
|
-
/** @returns {GetSampleFileServiceabilityStatusParam} */
|
|
240
|
-
static getSampleFileServiceabilityStatus(): GetSampleFileServiceabilityStatusParam;
|
|
241
176
|
/** @returns {GetServiceabilityParam} */
|
|
242
177
|
static getServiceability(): GetServiceabilityParam;
|
|
243
178
|
/** @returns {GetZoneByIdParam} */
|
|
244
179
|
static getZoneById(): GetZoneByIdParam;
|
|
245
|
-
/** @returns {GetZonesParam} */
|
|
246
|
-
static getZones(): GetZonesParam;
|
|
247
|
-
/** @returns {SampleFileServiceabilityParam} */
|
|
248
|
-
static sampleFileServiceability(): SampleFileServiceabilityParam;
|
|
249
180
|
/** @returns {UpdateCompanyConfigurationParam} */
|
|
250
181
|
static updateCompanyConfiguration(): UpdateCompanyConfigurationParam;
|
|
251
182
|
/** @returns {UpdateCourierPartnerAccountParam} */
|
|
252
183
|
static updateCourierPartnerAccount(): UpdateCourierPartnerAccountParam;
|
|
253
|
-
/** @returns {UpdateCourierPartnerSchemeParam} */
|
|
254
|
-
static updateCourierPartnerScheme(): UpdateCourierPartnerSchemeParam;
|
|
255
184
|
/** @returns {UpdatePackageMaterialRuleParam} */
|
|
256
185
|
static updatePackageMaterialRule(): UpdatePackageMaterialRuleParam;
|
|
257
186
|
/** @returns {UpdatePackageMaterialsParam} */
|
|
@@ -262,7 +191,7 @@ declare class ServiceabilityPlatformValidator {
|
|
|
262
191
|
static updateZoneById(): UpdateZoneByIdParam;
|
|
263
192
|
}
|
|
264
193
|
declare namespace ServiceabilityPlatformValidator {
|
|
265
|
-
export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam,
|
|
194
|
+
export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetServiceabilityParam, GetZoneByIdParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
|
|
266
195
|
}
|
|
267
196
|
type BulkServiceabilityParam = {
|
|
268
197
|
/**
|
|
@@ -289,9 +218,6 @@ type BulkTatParam = {
|
|
|
289
218
|
type CreateCourierPartnerAccountParam = {
|
|
290
219
|
body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
|
|
291
220
|
};
|
|
292
|
-
type CreateCourierPartnerSchemeParam = {
|
|
293
|
-
body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel;
|
|
294
|
-
};
|
|
295
221
|
type CreatePackageMaterialParam = {
|
|
296
222
|
body: ServiceabilityPlatformModel.PackageMaterial;
|
|
297
223
|
};
|
|
@@ -393,29 +319,6 @@ type GetBulkTatParam = {
|
|
|
393
319
|
*/
|
|
394
320
|
endDate?: string;
|
|
395
321
|
};
|
|
396
|
-
type GetCountriesParam = {
|
|
397
|
-
/**
|
|
398
|
-
* - Only fetch countries which allowed for
|
|
399
|
-
* onboard on Platform.
|
|
400
|
-
*/
|
|
401
|
-
onboarding?: boolean;
|
|
402
|
-
/**
|
|
403
|
-
* - Page number.
|
|
404
|
-
*/
|
|
405
|
-
pageNo?: number;
|
|
406
|
-
/**
|
|
407
|
-
* - Page size.
|
|
408
|
-
*/
|
|
409
|
-
pageSize?: number;
|
|
410
|
-
/**
|
|
411
|
-
* - Search.
|
|
412
|
-
*/
|
|
413
|
-
q?: string;
|
|
414
|
-
/**
|
|
415
|
-
* - Fetch countries that has certain heirarchy present.
|
|
416
|
-
*/
|
|
417
|
-
hierarchy?: string;
|
|
418
|
-
};
|
|
419
322
|
type GetCourierPartnerAccountParam = {
|
|
420
323
|
/**
|
|
421
324
|
* - Unique ID of courier partner account
|
|
@@ -444,33 +347,6 @@ type GetCourierPartnerAccountsParam = {
|
|
|
444
347
|
*/
|
|
445
348
|
transportType?: string;
|
|
446
349
|
};
|
|
447
|
-
type GetCourierPartnerSchemeParam = {
|
|
448
|
-
/**
|
|
449
|
-
* - Unique Identifier of Scheme
|
|
450
|
-
*/
|
|
451
|
-
schemeId: string;
|
|
452
|
-
};
|
|
453
|
-
type GetCourierPartnerSchemesParam = {
|
|
454
|
-
/**
|
|
455
|
-
* - Indicates whether a scheme is created by an
|
|
456
|
-
* admin for global purposes or customized for a specific company.
|
|
457
|
-
*/
|
|
458
|
-
schemeType?: string;
|
|
459
|
-
/**
|
|
460
|
-
* - Indicates payment mode for a scheme.
|
|
461
|
-
*/
|
|
462
|
-
paymentMode?: string;
|
|
463
|
-
/**
|
|
464
|
-
* - Indicates whether the scheme possesses
|
|
465
|
-
* certain capabilities.
|
|
466
|
-
*/
|
|
467
|
-
capabilities?: string[];
|
|
468
|
-
/**
|
|
469
|
-
* - List of scheme ids which need to be
|
|
470
|
-
* returned in the response.
|
|
471
|
-
*/
|
|
472
|
-
schemeIds?: string[];
|
|
473
|
-
};
|
|
474
350
|
type GetOptimalLocationsParam = {
|
|
475
351
|
body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema;
|
|
476
352
|
};
|
|
@@ -523,20 +399,6 @@ type GetPackageMaterialsParam = {
|
|
|
523
399
|
*/
|
|
524
400
|
packageMaterialId: string;
|
|
525
401
|
};
|
|
526
|
-
type GetSampleFileServiceabilityStatusParam = {
|
|
527
|
-
/**
|
|
528
|
-
* - Index of the item to start returning with
|
|
529
|
-
*/
|
|
530
|
-
pageNo?: number;
|
|
531
|
-
/**
|
|
532
|
-
* - Determines the items to be displayed in a page
|
|
533
|
-
*/
|
|
534
|
-
pageSize?: number;
|
|
535
|
-
/**
|
|
536
|
-
* - Batch id of the execution
|
|
537
|
-
*/
|
|
538
|
-
batchId?: string;
|
|
539
|
-
};
|
|
540
402
|
type GetServiceabilityParam = {
|
|
541
403
|
/**
|
|
542
404
|
* - Unique Identifier of courier partner extension.
|
|
@@ -557,51 +419,6 @@ type GetZoneByIdParam = {
|
|
|
557
419
|
*/
|
|
558
420
|
zoneId: string;
|
|
559
421
|
};
|
|
560
|
-
type GetZonesParam = {
|
|
561
|
-
/**
|
|
562
|
-
* - Index of the item to start returning with
|
|
563
|
-
*/
|
|
564
|
-
pageNo?: number;
|
|
565
|
-
/**
|
|
566
|
-
* - Determines the items to be displayed in a page
|
|
567
|
-
*/
|
|
568
|
-
pageSize?: number;
|
|
569
|
-
/**
|
|
570
|
-
* - Status of Zone (either active or inactive)
|
|
571
|
-
*/
|
|
572
|
-
isActive?: boolean;
|
|
573
|
-
/**
|
|
574
|
-
* - Zones filtered by an application
|
|
575
|
-
*/
|
|
576
|
-
channelId?: string;
|
|
577
|
-
/**
|
|
578
|
-
* - Search with name as a free text
|
|
579
|
-
*/
|
|
580
|
-
q?: string;
|
|
581
|
-
/**
|
|
582
|
-
* - ISO2 code of the country
|
|
583
|
-
*/
|
|
584
|
-
countryIsoCode?: string;
|
|
585
|
-
/**
|
|
586
|
-
* - State name
|
|
587
|
-
*/
|
|
588
|
-
state?: string;
|
|
589
|
-
/**
|
|
590
|
-
* - City name
|
|
591
|
-
*/
|
|
592
|
-
city?: string;
|
|
593
|
-
/**
|
|
594
|
-
* - Pincode value to search zones
|
|
595
|
-
*/
|
|
596
|
-
pincode?: string;
|
|
597
|
-
/**
|
|
598
|
-
* - Sector value to search zones
|
|
599
|
-
*/
|
|
600
|
-
sector?: string;
|
|
601
|
-
};
|
|
602
|
-
type SampleFileServiceabilityParam = {
|
|
603
|
-
body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
|
|
604
|
-
};
|
|
605
422
|
type UpdateCompanyConfigurationParam = {
|
|
606
423
|
body: ServiceabilityPlatformModel.CompanyConfig;
|
|
607
424
|
};
|
|
@@ -612,13 +429,6 @@ type UpdateCourierPartnerAccountParam = {
|
|
|
612
429
|
accountId: string;
|
|
613
430
|
body: ServiceabilityPlatformModel.CourierAccountUpdateDetails;
|
|
614
431
|
};
|
|
615
|
-
type UpdateCourierPartnerSchemeParam = {
|
|
616
|
-
/**
|
|
617
|
-
* - Unique Identifier of Scheme
|
|
618
|
-
*/
|
|
619
|
-
schemeId: string;
|
|
620
|
-
body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails;
|
|
621
|
-
};
|
|
622
432
|
type UpdatePackageMaterialRuleParam = {
|
|
623
433
|
/**
|
|
624
434
|
* - A `package_material_rule_id` is a unique
|
|
@@ -21,11 +21,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
21
21
|
* @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
/**
|
|
25
|
-
* @typedef CreateCourierPartnerSchemeParam
|
|
26
|
-
* @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
|
|
27
|
-
*/
|
|
28
|
-
|
|
29
24
|
/**
|
|
30
25
|
* @typedef CreatePackageMaterialParam
|
|
31
26
|
* @property {ServiceabilityPlatformModel.PackageMaterial} body
|
|
@@ -75,16 +70,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
75
70
|
|
|
76
71
|
/** @typedef GetCompanyConfigurationParam */
|
|
77
72
|
|
|
78
|
-
/**
|
|
79
|
-
* @typedef GetCountriesParam
|
|
80
|
-
* @property {boolean} [onboarding] - Only fetch countries which allowed for
|
|
81
|
-
* 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.
|
|
86
|
-
*/
|
|
87
|
-
|
|
88
73
|
/**
|
|
89
74
|
* @typedef GetCourierPartnerAccountParam
|
|
90
75
|
* @property {string} accountId - Unique ID of courier partner account
|
|
@@ -99,22 +84,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
99
84
|
* @property {string} [transportType] - Filters dp accounts based on transport_type
|
|
100
85
|
*/
|
|
101
86
|
|
|
102
|
-
/**
|
|
103
|
-
* @typedef GetCourierPartnerSchemeParam
|
|
104
|
-
* @property {string} schemeId - Unique Identifier of Scheme
|
|
105
|
-
*/
|
|
106
|
-
|
|
107
|
-
/**
|
|
108
|
-
* @typedef GetCourierPartnerSchemesParam
|
|
109
|
-
* @property {string} [schemeType] - Indicates whether a scheme is created by an
|
|
110
|
-
* admin for global purposes or customized for a specific company.
|
|
111
|
-
* @property {string} [paymentMode] - Indicates payment mode for a scheme.
|
|
112
|
-
* @property {string[]} [capabilities] - Indicates whether the scheme possesses
|
|
113
|
-
* certain capabilities.
|
|
114
|
-
* @property {string[]} [schemeIds] - List of scheme ids which need to be
|
|
115
|
-
* returned in the response.
|
|
116
|
-
*/
|
|
117
|
-
|
|
118
87
|
/**
|
|
119
88
|
* @typedef GetOptimalLocationsParam
|
|
120
89
|
* @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
|
|
@@ -147,13 +116,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
147
116
|
* @property {string} packageMaterialId - Unique identifier for a Package. Material
|
|
148
117
|
*/
|
|
149
118
|
|
|
150
|
-
/**
|
|
151
|
-
* @typedef GetSampleFileServiceabilityStatusParam
|
|
152
|
-
* @property {number} [pageNo] - Index of the item to start returning with
|
|
153
|
-
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
154
|
-
* @property {string} [batchId] - Batch id of the execution
|
|
155
|
-
*/
|
|
156
|
-
|
|
157
119
|
/**
|
|
158
120
|
* @typedef GetServiceabilityParam
|
|
159
121
|
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
@@ -166,25 +128,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
166
128
|
* @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
|
|
167
129
|
*/
|
|
168
130
|
|
|
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
|
-
*/
|
|
182
|
-
|
|
183
|
-
/**
|
|
184
|
-
* @typedef SampleFileServiceabilityParam
|
|
185
|
-
* @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
|
|
186
|
-
*/
|
|
187
|
-
|
|
188
131
|
/**
|
|
189
132
|
* @typedef UpdateCompanyConfigurationParam
|
|
190
133
|
* @property {ServiceabilityPlatformModel.CompanyConfig} body
|
|
@@ -196,12 +139,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
196
139
|
* @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
|
|
197
140
|
*/
|
|
198
141
|
|
|
199
|
-
/**
|
|
200
|
-
* @typedef UpdateCourierPartnerSchemeParam
|
|
201
|
-
* @property {string} schemeId - Unique Identifier of Scheme
|
|
202
|
-
* @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
|
|
203
|
-
*/
|
|
204
|
-
|
|
205
142
|
/**
|
|
206
143
|
* @typedef UpdatePackageMaterialRuleParam
|
|
207
144
|
* @property {string} ruleId - A `package_material_rule_id` is a unique
|
|
@@ -255,13 +192,6 @@ class ServiceabilityPlatformValidator {
|
|
|
255
192
|
}).required();
|
|
256
193
|
}
|
|
257
194
|
|
|
258
|
-
/** @returns {CreateCourierPartnerSchemeParam} */
|
|
259
|
-
static createCourierPartnerScheme() {
|
|
260
|
-
return Joi.object({
|
|
261
|
-
body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel().required(),
|
|
262
|
-
}).required();
|
|
263
|
-
}
|
|
264
|
-
|
|
265
195
|
/** @returns {CreatePackageMaterialParam} */
|
|
266
196
|
static createPackageMaterial() {
|
|
267
197
|
return Joi.object({
|
|
@@ -327,17 +257,6 @@ class ServiceabilityPlatformValidator {
|
|
|
327
257
|
return Joi.object({}).required();
|
|
328
258
|
}
|
|
329
259
|
|
|
330
|
-
/** @returns {GetCountriesParam} */
|
|
331
|
-
static getCountries() {
|
|
332
|
-
return Joi.object({
|
|
333
|
-
onboarding: Joi.boolean(),
|
|
334
|
-
pageNo: Joi.number(),
|
|
335
|
-
pageSize: Joi.number(),
|
|
336
|
-
q: Joi.string().allow(""),
|
|
337
|
-
hierarchy: Joi.string().allow(""),
|
|
338
|
-
}).required();
|
|
339
|
-
}
|
|
340
|
-
|
|
341
260
|
/** @returns {GetCourierPartnerAccountParam} */
|
|
342
261
|
static getCourierPartnerAccount() {
|
|
343
262
|
return Joi.object({
|
|
@@ -356,23 +275,6 @@ class ServiceabilityPlatformValidator {
|
|
|
356
275
|
}).required();
|
|
357
276
|
}
|
|
358
277
|
|
|
359
|
-
/** @returns {GetCourierPartnerSchemeParam} */
|
|
360
|
-
static getCourierPartnerScheme() {
|
|
361
|
-
return Joi.object({
|
|
362
|
-
schemeId: Joi.string().allow("").required(),
|
|
363
|
-
}).required();
|
|
364
|
-
}
|
|
365
|
-
|
|
366
|
-
/** @returns {GetCourierPartnerSchemesParam} */
|
|
367
|
-
static getCourierPartnerSchemes() {
|
|
368
|
-
return Joi.object({
|
|
369
|
-
schemeType: Joi.string().allow(""),
|
|
370
|
-
paymentMode: Joi.string().allow(""),
|
|
371
|
-
capabilities: Joi.array().items(Joi.string().allow("")),
|
|
372
|
-
schemeIds: Joi.array().items(Joi.string().allow("")),
|
|
373
|
-
}).required();
|
|
374
|
-
}
|
|
375
|
-
|
|
376
278
|
/** @returns {GetOptimalLocationsParam} */
|
|
377
279
|
static getOptimalLocations() {
|
|
378
280
|
return Joi.object({
|
|
@@ -414,15 +316,6 @@ class ServiceabilityPlatformValidator {
|
|
|
414
316
|
}).required();
|
|
415
317
|
}
|
|
416
318
|
|
|
417
|
-
/** @returns {GetSampleFileServiceabilityStatusParam} */
|
|
418
|
-
static getSampleFileServiceabilityStatus() {
|
|
419
|
-
return Joi.object({
|
|
420
|
-
pageNo: Joi.number(),
|
|
421
|
-
pageSize: Joi.number(),
|
|
422
|
-
batchId: Joi.string().allow(""),
|
|
423
|
-
}).required();
|
|
424
|
-
}
|
|
425
|
-
|
|
426
319
|
/** @returns {GetServiceabilityParam} */
|
|
427
320
|
static getServiceability() {
|
|
428
321
|
return Joi.object({
|
|
@@ -439,29 +332,6 @@ class ServiceabilityPlatformValidator {
|
|
|
439
332
|
}).required();
|
|
440
333
|
}
|
|
441
334
|
|
|
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();
|
|
456
|
-
}
|
|
457
|
-
|
|
458
|
-
/** @returns {SampleFileServiceabilityParam} */
|
|
459
|
-
static sampleFileServiceability() {
|
|
460
|
-
return Joi.object({
|
|
461
|
-
body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails().required(),
|
|
462
|
-
}).required();
|
|
463
|
-
}
|
|
464
|
-
|
|
465
335
|
/** @returns {UpdateCompanyConfigurationParam} */
|
|
466
336
|
static updateCompanyConfiguration() {
|
|
467
337
|
return Joi.object({
|
|
@@ -477,14 +347,6 @@ class ServiceabilityPlatformValidator {
|
|
|
477
347
|
}).required();
|
|
478
348
|
}
|
|
479
349
|
|
|
480
|
-
/** @returns {UpdateCourierPartnerSchemeParam} */
|
|
481
|
-
static updateCourierPartnerScheme() {
|
|
482
|
-
return Joi.object({
|
|
483
|
-
schemeId: Joi.string().allow("").required(),
|
|
484
|
-
body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails().required(),
|
|
485
|
-
}).required();
|
|
486
|
-
}
|
|
487
|
-
|
|
488
350
|
/** @returns {UpdatePackageMaterialRuleParam} */
|
|
489
351
|
static updatePackageMaterialRule() {
|
|
490
352
|
return Joi.object({
|
|
@@ -387,16 +387,7 @@ export = ThemePlatformModel;
|
|
|
387
387
|
*/
|
|
388
388
|
/**
|
|
389
389
|
* @typedef GlobalSchema
|
|
390
|
-
* @property {
|
|
391
|
-
*/
|
|
392
|
-
/**
|
|
393
|
-
* @typedef Prop
|
|
394
|
-
* @property {string} [type] - The type of the property
|
|
395
|
-
* @property {string} [category] - The category of the property
|
|
396
|
-
* @property {string} [value] - The value of the property
|
|
397
|
-
* @property {string} [id] - The ID of the property
|
|
398
|
-
* @property {string} [label] - The label of the property
|
|
399
|
-
* @property {string} [info] - Additional information about the property
|
|
390
|
+
* @property {Object[]} [props]
|
|
400
391
|
*/
|
|
401
392
|
/**
|
|
402
393
|
* @typedef Assets
|
|
@@ -598,7 +589,7 @@ export = ThemePlatformModel;
|
|
|
598
589
|
declare class ThemePlatformModel {
|
|
599
590
|
}
|
|
600
591
|
declare namespace ThemePlatformModel {
|
|
601
|
-
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema,
|
|
592
|
+
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyTheme, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
|
|
602
593
|
}
|
|
603
594
|
/** @returns {GetExtensionSectionRes} */
|
|
604
595
|
declare function GetExtensionSectionRes(): GetExtensionSectionRes;
|
|
@@ -1312,35 +1303,7 @@ type CustomProps = {
|
|
|
1312
1303
|
/** @returns {GlobalSchema} */
|
|
1313
1304
|
declare function GlobalSchema(): GlobalSchema;
|
|
1314
1305
|
type GlobalSchema = {
|
|
1315
|
-
props?:
|
|
1316
|
-
};
|
|
1317
|
-
/** @returns {Prop} */
|
|
1318
|
-
declare function Prop(): Prop;
|
|
1319
|
-
type Prop = {
|
|
1320
|
-
/**
|
|
1321
|
-
* - The type of the property
|
|
1322
|
-
*/
|
|
1323
|
-
type?: string;
|
|
1324
|
-
/**
|
|
1325
|
-
* - The category of the property
|
|
1326
|
-
*/
|
|
1327
|
-
category?: string;
|
|
1328
|
-
/**
|
|
1329
|
-
* - The value of the property
|
|
1330
|
-
*/
|
|
1331
|
-
value?: string;
|
|
1332
|
-
/**
|
|
1333
|
-
* - The ID of the property
|
|
1334
|
-
*/
|
|
1335
|
-
id?: string;
|
|
1336
|
-
/**
|
|
1337
|
-
* - The label of the property
|
|
1338
|
-
*/
|
|
1339
|
-
label?: string;
|
|
1340
|
-
/**
|
|
1341
|
-
* - Additional information about the property
|
|
1342
|
-
*/
|
|
1343
|
-
info?: string;
|
|
1306
|
+
props?: any[];
|
|
1344
1307
|
};
|
|
1345
1308
|
/** @returns {Assets} */
|
|
1346
1309
|
declare function Assets(): Assets;
|
|
@@ -441,17 +441,7 @@ const Joi = require("joi");
|
|
|
441
441
|
|
|
442
442
|
/**
|
|
443
443
|
* @typedef GlobalSchema
|
|
444
|
-
* @property {
|
|
445
|
-
*/
|
|
446
|
-
|
|
447
|
-
/**
|
|
448
|
-
* @typedef Prop
|
|
449
|
-
* @property {string} [type] - The type of the property
|
|
450
|
-
* @property {string} [category] - The category of the property
|
|
451
|
-
* @property {string} [value] - The value of the property
|
|
452
|
-
* @property {string} [id] - The ID of the property
|
|
453
|
-
* @property {string} [label] - The label of the property
|
|
454
|
-
* @property {string} [info] - Additional information about the property
|
|
444
|
+
* @property {Object[]} [props]
|
|
455
445
|
*/
|
|
456
446
|
|
|
457
447
|
/**
|
|
@@ -1224,19 +1214,7 @@ class ThemePlatformModel {
|
|
|
1224
1214
|
/** @returns {GlobalSchema} */
|
|
1225
1215
|
static GlobalSchema() {
|
|
1226
1216
|
return Joi.object({
|
|
1227
|
-
props: Joi.array().items(
|
|
1228
|
-
});
|
|
1229
|
-
}
|
|
1230
|
-
|
|
1231
|
-
/** @returns {Prop} */
|
|
1232
|
-
static Prop() {
|
|
1233
|
-
return Joi.object({
|
|
1234
|
-
type: Joi.string().allow(""),
|
|
1235
|
-
category: Joi.string().allow(""),
|
|
1236
|
-
value: Joi.string().allow(""),
|
|
1237
|
-
id: Joi.string().allow(""),
|
|
1238
|
-
label: Joi.string().allow(""),
|
|
1239
|
-
info: Joi.string().allow(""),
|
|
1217
|
+
props: Joi.array().items(Joi.any()),
|
|
1240
1218
|
});
|
|
1241
1219
|
}
|
|
1242
1220
|
|
|
@@ -49,6 +49,14 @@ class Configuration {
|
|
|
49
49
|
{ locationType, id, requestHeaders } = { requestHeaders: {} },
|
|
50
50
|
{ responseHeaders } = { responseHeaders: false }
|
|
51
51
|
) {
|
|
52
|
+
let invalidInput = [];
|
|
53
|
+
if (invalidInput.length) {
|
|
54
|
+
const error = new Error();
|
|
55
|
+
error.message = "Missing required field";
|
|
56
|
+
error.details = invalidInput;
|
|
57
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
58
|
+
}
|
|
59
|
+
|
|
52
60
|
const { error } = ConfigurationPublicValidator.getLocations().validate(
|
|
53
61
|
{ locationType, id },
|
|
54
62
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -130,6 +138,14 @@ class Configuration {
|
|
|
130
138
|
{ authorization, query, requestHeaders } = { requestHeaders: {} },
|
|
131
139
|
{ responseHeaders } = { responseHeaders: false }
|
|
132
140
|
) {
|
|
141
|
+
let invalidInput = [];
|
|
142
|
+
if (invalidInput.length) {
|
|
143
|
+
const error = new Error();
|
|
144
|
+
error.message = "Missing required field";
|
|
145
|
+
error.details = invalidInput;
|
|
146
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
147
|
+
}
|
|
148
|
+
|
|
133
149
|
const { error } = ConfigurationPublicValidator.searchApplication().validate(
|
|
134
150
|
{ authorization, query },
|
|
135
151
|
{ abortEarly: false, allowUnknown: true }
|