@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -3,34 +3,202 @@ declare class Serviceability {
|
|
|
3
3
|
constructor(config: any, applicationId: any);
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
|
+
/**
|
|
7
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateBulkExportParam} arg
|
|
8
|
+
* - Arg object
|
|
9
|
+
*
|
|
10
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
11
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneBulkExport>} - Success response
|
|
13
|
+
* @name createBulkExport
|
|
14
|
+
* @summary: Create Bulk Export of Zones
|
|
15
|
+
* @description: Export zones defined at the application level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createBulkExport/).
|
|
16
|
+
*/
|
|
17
|
+
createBulkExport({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateBulkExportParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneBulkExport>;
|
|
18
|
+
/**
|
|
19
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateBulkGeoAreaParam} arg
|
|
20
|
+
* - Arg object
|
|
21
|
+
*
|
|
22
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
+
* @returns {Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>} -
|
|
25
|
+
* Success response
|
|
26
|
+
* @name createBulkGeoArea
|
|
27
|
+
* @summary: Bulk Creation of GeoArea Regions
|
|
28
|
+
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createBulkGeoArea/).
|
|
29
|
+
*/
|
|
30
|
+
createBulkGeoArea({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>;
|
|
6
31
|
/**
|
|
7
32
|
* @param {ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam} arg
|
|
8
33
|
* - Arg object
|
|
9
34
|
*
|
|
10
35
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
11
36
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
37
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>}
|
|
13
38
|
* - Success response
|
|
14
39
|
*
|
|
15
40
|
* @name createCourierPartnerRule
|
|
16
|
-
* @summary: Create
|
|
17
|
-
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://
|
|
41
|
+
* @summary: Create courier rule
|
|
42
|
+
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerRule/).
|
|
18
43
|
*/
|
|
19
|
-
createCourierPartnerRule({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
44
|
+
createCourierPartnerRule({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
20
45
|
/**
|
|
21
|
-
* @param {ServiceabilityPlatformApplicationValidator.
|
|
46
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateFulfillmentOptionParam} arg
|
|
47
|
+
* - Arg object
|
|
48
|
+
*
|
|
49
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
51
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
52
|
+
* Success response
|
|
53
|
+
* @name createFulfillmentOption
|
|
54
|
+
* @summary: Create a new fulfillment option
|
|
55
|
+
* @description: Creates a new fulfillment option for the specified company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createFulfillmentOption/).
|
|
56
|
+
*/
|
|
57
|
+
createFulfillmentOption({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateFulfillmentOptionParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
58
|
+
/**
|
|
59
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam} arg
|
|
60
|
+
* - Arg object
|
|
61
|
+
*
|
|
62
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
63
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaResponseBody>} -
|
|
65
|
+
* Success response
|
|
66
|
+
* @name createGeoArea
|
|
67
|
+
* @summary: Creation of GeoArea
|
|
68
|
+
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createGeoArea/).
|
|
69
|
+
*/
|
|
70
|
+
createGeoArea({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaResponseBody>;
|
|
71
|
+
/**
|
|
72
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateGeoAreaExportJobParam} arg
|
|
73
|
+
* - Arg object
|
|
74
|
+
*
|
|
75
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
76
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
77
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaBulkCreationResult>}
|
|
78
|
+
* - Success response
|
|
79
|
+
*
|
|
80
|
+
* @name createGeoAreaExportJob
|
|
81
|
+
* @summary: Create job for exporting Geoarea regions
|
|
82
|
+
* @description: Create the job for exporting the regions in Geoarea in CSV format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createGeoAreaExportJob/).
|
|
83
|
+
*/
|
|
84
|
+
createGeoAreaExportJob({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaExportJobParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkCreationResult>;
|
|
85
|
+
/**
|
|
86
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreatePolygonParam} arg
|
|
22
87
|
* - Arg object
|
|
23
88
|
*
|
|
24
89
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
25
90
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
91
|
+
* @returns {Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityResult>}
|
|
27
92
|
* - Success response
|
|
28
93
|
*
|
|
94
|
+
* @name createPolygon
|
|
95
|
+
* @summary: Create polygon-based serviceability for stores
|
|
96
|
+
* @description: Creates polygon-based serviceability regions for one or more stores for quick commerce. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPolygon/).
|
|
97
|
+
*/
|
|
98
|
+
createPolygon({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreatePolygonParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityResult>;
|
|
99
|
+
/**
|
|
100
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateShipmentsParam} arg
|
|
101
|
+
* - Arg object
|
|
102
|
+
*
|
|
103
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
104
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
105
|
+
* @returns {Promise<ServiceabilityPlatformModel.PlatformShipmentsResponseSchema>}
|
|
106
|
+
* - Success response
|
|
107
|
+
*
|
|
108
|
+
* @name createShipments
|
|
109
|
+
* @summary: Create and return shipments
|
|
110
|
+
* @description: Create and return shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createShipments/).
|
|
111
|
+
*/
|
|
112
|
+
createShipments({ body, xOrderingSource, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateShipmentsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PlatformShipmentsResponseSchema>;
|
|
113
|
+
/**
|
|
114
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam} arg
|
|
115
|
+
* - Arg object
|
|
116
|
+
*
|
|
117
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
118
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
119
|
+
* @returns {Promise<ServiceabilityPlatformModel.StoreRuleResultSchema>} -
|
|
120
|
+
* Success response
|
|
29
121
|
* @name createStoreRules
|
|
30
122
|
* @summary: Create store rule
|
|
31
|
-
* @description: Create a rule within the order routing rules - Check out [method documentation](https://
|
|
123
|
+
* @description: Create a rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createStoreRules/).
|
|
124
|
+
*/
|
|
125
|
+
createStoreRules({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleResultSchema>;
|
|
126
|
+
/**
|
|
127
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateZoneParam} arg
|
|
128
|
+
* - Arg object
|
|
129
|
+
*
|
|
130
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
131
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
132
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneSchema>} - Success response
|
|
133
|
+
* @name createZone
|
|
134
|
+
* @summary: Create zone
|
|
135
|
+
* @description: Creates a delivery zone. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZone/).
|
|
32
136
|
*/
|
|
33
|
-
|
|
137
|
+
createZone({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneSchema>;
|
|
138
|
+
/**
|
|
139
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateZoneProductsBulkPatchJobParam} arg
|
|
140
|
+
* - Arg object
|
|
141
|
+
*
|
|
142
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
143
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
144
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneBulkExport>} - Success response
|
|
145
|
+
* @name createZoneProductsBulkPatchJob
|
|
146
|
+
* @summary: Create bulk zone products patch job
|
|
147
|
+
* @description: Initiates a bulk zone products patch operation by accepting a CSV file URL. The file is validated and a background job is created for processing zone product additions or removals. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZoneProductsBulkPatchJob/).
|
|
148
|
+
*/
|
|
149
|
+
createZoneProductsBulkPatchJob({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateZoneProductsBulkPatchJobParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneBulkExport>;
|
|
150
|
+
/**
|
|
151
|
+
* @param {ServiceabilityPlatformApplicationValidator.DeleteFulfillmentOptionsParam} arg
|
|
152
|
+
* - Arg object
|
|
153
|
+
*
|
|
154
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
|
+
* @returns {Promise<ServiceabilityPlatformModel.OperationResponseSchema>}
|
|
157
|
+
* - Success response
|
|
158
|
+
*
|
|
159
|
+
* @name deleteFulfillmentOptions
|
|
160
|
+
* @summary: Delete fulfillment options
|
|
161
|
+
* @description: Deletes fulfillment options for provided slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteFulfillmentOptions/).
|
|
162
|
+
*/
|
|
163
|
+
deleteFulfillmentOptions({ slug, requestHeaders }?: ServiceabilityPlatformApplicationValidator.DeleteFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OperationResponseSchema>;
|
|
164
|
+
/**
|
|
165
|
+
* @param {ServiceabilityPlatformApplicationValidator.DeleteZoneParam} arg
|
|
166
|
+
* - Arg object
|
|
167
|
+
*
|
|
168
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
169
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
170
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneDeleteSuccessResult>}
|
|
171
|
+
* - Success response
|
|
172
|
+
*
|
|
173
|
+
* @name deleteZone
|
|
174
|
+
* @summary: Delete a Specific Zone
|
|
175
|
+
* @description: Delete a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteZone/).
|
|
176
|
+
*/
|
|
177
|
+
deleteZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.DeleteZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneDeleteSuccessResult>;
|
|
178
|
+
/**
|
|
179
|
+
* @param {ServiceabilityPlatformApplicationValidator.DownloadGeoareaSampleFileParam} arg
|
|
180
|
+
* - Arg object
|
|
181
|
+
*
|
|
182
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
+
* @returns {Promise<string>} - Success response
|
|
185
|
+
* @name downloadGeoareaSampleFile
|
|
186
|
+
* @summary: Download geoarea sample file
|
|
187
|
+
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/downloadGeoareaSampleFile/).
|
|
188
|
+
*/
|
|
189
|
+
downloadGeoareaSampleFile({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
|
|
190
|
+
/**
|
|
191
|
+
* @param {ServiceabilityPlatformApplicationValidator.DownloadZoneProductsBulkSampleFileParam} arg
|
|
192
|
+
* - Arg object
|
|
193
|
+
*
|
|
194
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
195
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
196
|
+
* @returns {Promise<string>} - Success response
|
|
197
|
+
* @name downloadZoneProductsBulkSampleFile
|
|
198
|
+
* @summary: Download zone products bulk patch sample file
|
|
199
|
+
* @description: Downloads a CSV sample template file for bulk patching zone products. The template includes headers for zone_id, product_type, products, and action. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/downloadZoneProductsBulkSampleFile/).
|
|
200
|
+
*/
|
|
201
|
+
downloadZoneProductsBulkSampleFile({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
|
|
34
202
|
/**
|
|
35
203
|
* @param {ServiceabilityPlatformApplicationValidator.GetApplicationConfigParam} arg
|
|
36
204
|
* - Arg object
|
|
@@ -41,7 +209,7 @@ declare class Serviceability {
|
|
|
41
209
|
* Success response
|
|
42
210
|
* @name getApplicationConfig
|
|
43
211
|
* @summary: Get store rule configuration
|
|
44
|
-
* @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://
|
|
212
|
+
* @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationConfig/).
|
|
45
213
|
*/
|
|
46
214
|
getApplicationConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
47
215
|
/**
|
|
@@ -50,55 +218,217 @@ declare class Serviceability {
|
|
|
50
218
|
*
|
|
51
219
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
220
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
53
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
54
|
-
* Success response
|
|
221
|
+
* @returns {Promise<ServiceabilityPlatformModel.ApplicationConfigGetResult>}
|
|
222
|
+
* - Success response
|
|
223
|
+
*
|
|
55
224
|
* @name getApplicationConfiguration
|
|
56
225
|
* @summary: Get delivery configuration
|
|
57
|
-
* @description:
|
|
226
|
+
* @description: This API returns all the Application config that has been applied to the given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationConfiguration/).
|
|
58
227
|
*/
|
|
59
|
-
getApplicationConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
228
|
+
getApplicationConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigGetResult>;
|
|
60
229
|
/**
|
|
61
|
-
* @param {ServiceabilityPlatformApplicationValidator.
|
|
230
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetApplicationCourierPartnersListParam} arg
|
|
62
231
|
* - Arg object
|
|
63
232
|
*
|
|
64
233
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
65
234
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
66
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
235
|
+
* @returns {Promise<ServiceabilityPlatformModel.GenerateShipmentsAndCourierPartnerResult>}
|
|
67
236
|
* - Success response
|
|
68
237
|
*
|
|
69
|
-
* @name
|
|
70
|
-
* @summary: Get
|
|
71
|
-
* @description: Retrieves
|
|
238
|
+
* @name getApplicationCourierPartnersList
|
|
239
|
+
* @summary: Get available application courier partners
|
|
240
|
+
* @description: Retrieves a list of courier partners available for shipping based on serviceability criteria, shipment details, and delivery rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationCourierPartnersList/).
|
|
72
241
|
*/
|
|
73
|
-
|
|
242
|
+
getApplicationCourierPartnersList({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetApplicationCourierPartnersListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GenerateShipmentsAndCourierPartnerResult>;
|
|
243
|
+
/**
|
|
244
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetBulkExportParam} arg
|
|
245
|
+
* - Arg object
|
|
246
|
+
*
|
|
247
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
248
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
249
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetZoneBulkExport>} -
|
|
250
|
+
* Success response
|
|
251
|
+
* @name getBulkExport
|
|
252
|
+
* @summary: Get Bulk Export of Zones
|
|
253
|
+
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkExport/).
|
|
254
|
+
*/
|
|
255
|
+
getBulkExport({ batchId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkExportParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneBulkExport>;
|
|
256
|
+
/**
|
|
257
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetBulkFulfillmentValidationStatusParam} arg
|
|
258
|
+
* - Arg object
|
|
259
|
+
*
|
|
260
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
261
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidate>}
|
|
263
|
+
* - Success response
|
|
264
|
+
*
|
|
265
|
+
* @name getBulkFulfillmentValidationStatus
|
|
266
|
+
* @summary: Validate bulk fulfillment options.
|
|
267
|
+
* @description: Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkFulfillmentValidationStatus/).
|
|
268
|
+
*/
|
|
269
|
+
getBulkFulfillmentValidationStatus({ bulkId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkFulfillmentValidationStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidate>;
|
|
270
|
+
/**
|
|
271
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam} arg
|
|
272
|
+
* - Arg object
|
|
273
|
+
*
|
|
274
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
275
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
276
|
+
* @returns {Promise<ServiceabilityPlatformModel.BulkGeoAreaGetResult>} -
|
|
277
|
+
* Success response
|
|
278
|
+
* @name getBulkGeoArea
|
|
279
|
+
* @summary: Get status of GeoAreas created in bulk
|
|
280
|
+
* @description: Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkGeoArea/).
|
|
281
|
+
*/
|
|
282
|
+
getBulkGeoArea({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaGetResult>;
|
|
74
283
|
/**
|
|
75
284
|
* @param {ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam} arg
|
|
76
285
|
* - Arg object
|
|
77
286
|
*
|
|
78
287
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
288
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
289
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>}
|
|
81
290
|
* - Success response
|
|
82
291
|
*
|
|
83
292
|
* @name getCourierPartnerRule
|
|
84
293
|
* @summary: Get courier rule
|
|
85
|
-
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://
|
|
294
|
+
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRule/).
|
|
86
295
|
*/
|
|
87
|
-
getCourierPartnerRule({
|
|
296
|
+
getCourierPartnerRule({ ruleUid, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
88
297
|
/**
|
|
89
298
|
* @param {ServiceabilityPlatformApplicationValidator.GetCourierPartnerRulesParam} arg
|
|
90
299
|
* - Arg object
|
|
91
300
|
*
|
|
92
301
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
93
302
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
94
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
303
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRulesListResult>}
|
|
95
304
|
* - Success response
|
|
96
305
|
*
|
|
97
306
|
* @name getCourierPartnerRules
|
|
98
307
|
* @summary: Get courier rules
|
|
99
|
-
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://
|
|
308
|
+
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRules/).
|
|
309
|
+
*/
|
|
310
|
+
getCourierPartnerRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRulesListResult>;
|
|
311
|
+
/**
|
|
312
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetCourierPartnersParam} arg
|
|
313
|
+
* - Arg object
|
|
314
|
+
*
|
|
315
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
316
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
317
|
+
* @returns {Promise<ServiceabilityPlatformModel.ShipmentCourierPartnerResult>}
|
|
318
|
+
* - Success response
|
|
319
|
+
*
|
|
320
|
+
* @name getCourierPartners
|
|
321
|
+
* @summary: Serviceable Courier Partners
|
|
322
|
+
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartners/).
|
|
100
323
|
*/
|
|
101
|
-
|
|
324
|
+
getCourierPartners({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnersParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ShipmentCourierPartnerResult>;
|
|
325
|
+
/**
|
|
326
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionProductsParam} arg
|
|
327
|
+
* - Arg object
|
|
328
|
+
*
|
|
329
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
331
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionProducts>}
|
|
332
|
+
* - Success response
|
|
333
|
+
*
|
|
334
|
+
* @name getFulfillmentOptionProducts
|
|
335
|
+
* @summary: Get products for a specific fulfillment option.
|
|
336
|
+
* @description: Retrieves products available for a specific fulfillment option in an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionProducts/).
|
|
337
|
+
*/
|
|
338
|
+
getFulfillmentOptionProducts({ slug, storeId, q, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionProductsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionProducts>;
|
|
339
|
+
/**
|
|
340
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionStoresParam} arg
|
|
341
|
+
* - Arg object
|
|
342
|
+
*
|
|
343
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
344
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
345
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionStores>}
|
|
346
|
+
* - Success response
|
|
347
|
+
*
|
|
348
|
+
* @name getFulfillmentOptionStores
|
|
349
|
+
* @summary: Get stores for a specific fulfillment option.
|
|
350
|
+
* @description: Retrieves stores available for a specific fulfillment option in an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionStores/).
|
|
351
|
+
*/
|
|
352
|
+
getFulfillmentOptionStores({ slug, q, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionStoresParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionStores>;
|
|
353
|
+
/**
|
|
354
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsParam} arg
|
|
355
|
+
* - Arg object
|
|
356
|
+
*
|
|
357
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
358
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
359
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
360
|
+
* Success response
|
|
361
|
+
* @name getFulfillmentOptions
|
|
362
|
+
* @summary: Get fulfillment options
|
|
363
|
+
* @description: Fetches available fulfillment options for a given product and store. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptions/).
|
|
364
|
+
*/
|
|
365
|
+
getFulfillmentOptions({ slug, productId, storeId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
366
|
+
/**
|
|
367
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsListParam} arg
|
|
368
|
+
* - Arg object
|
|
369
|
+
*
|
|
370
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
371
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
372
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionsList>} -
|
|
373
|
+
* Success response
|
|
374
|
+
* @name getFulfillmentOptionsList
|
|
375
|
+
* @summary: Retrieve fulfillment options with optional filters.
|
|
376
|
+
* @description: Fetches fulfillment options for an application. Queryable by product_slug, store_id, and status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionsList/).
|
|
377
|
+
*/
|
|
378
|
+
getFulfillmentOptionsList({ productSlug, storeId, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionsList>;
|
|
379
|
+
/**
|
|
380
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreaParam} arg
|
|
381
|
+
* - Arg object
|
|
382
|
+
*
|
|
383
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
384
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
385
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaDetails>} - Success response
|
|
386
|
+
* @name getGeoArea
|
|
387
|
+
* @summary: Get details of the specific geoarea
|
|
388
|
+
* @description: This API Returns the data of the specific GeoArea which exists on the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoArea/).
|
|
389
|
+
*/
|
|
390
|
+
getGeoArea({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaDetails>;
|
|
391
|
+
/**
|
|
392
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreaExportJobStatusParam} arg
|
|
393
|
+
* - Arg object
|
|
394
|
+
*
|
|
395
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
396
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
397
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaBulkExportResult>}
|
|
398
|
+
* - Success response
|
|
399
|
+
*
|
|
400
|
+
* @name getGeoAreaExportJobStatus
|
|
401
|
+
* @summary: Get status of Geoarea export job
|
|
402
|
+
* @description: Get the status and details of the Geoarea bulk export process. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreaExportJobStatus/).
|
|
403
|
+
*/
|
|
404
|
+
getGeoAreaExportJobStatus({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetGeoAreaExportJobStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkExportResult>;
|
|
405
|
+
/**
|
|
406
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreasParam} arg
|
|
407
|
+
* - Arg object
|
|
408
|
+
*
|
|
409
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
410
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
411
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaGetResponseBody>} -
|
|
412
|
+
* Success response
|
|
413
|
+
* @name getGeoAreas
|
|
414
|
+
* @summary: Get all geoareas in the current application
|
|
415
|
+
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreas/).
|
|
416
|
+
*/
|
|
417
|
+
getGeoAreas({ pageSize, isActive, pageNo, type, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetGeoAreasParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaGetResponseBody>;
|
|
418
|
+
/**
|
|
419
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetPolygonParam} arg
|
|
420
|
+
* - Arg object
|
|
421
|
+
*
|
|
422
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
423
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
424
|
+
* @returns {Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityGetResult>}
|
|
425
|
+
* - Success response
|
|
426
|
+
*
|
|
427
|
+
* @name getPolygon
|
|
428
|
+
* @summary: Get polygon-based serviceability for stores
|
|
429
|
+
* @description: Retrieves polygon-based serviceability configurations for stores for quick commerce. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPolygon/).
|
|
430
|
+
*/
|
|
431
|
+
getPolygon({ pageNumber, pageSize, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetPolygonParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityGetResult>;
|
|
102
432
|
/**
|
|
103
433
|
* @param {ServiceabilityPlatformApplicationValidator.GetStoreRuleParam} arg
|
|
104
434
|
* - Arg object
|
|
@@ -109,7 +439,7 @@ declare class Serviceability {
|
|
|
109
439
|
* Success response
|
|
110
440
|
* @name getStoreRule
|
|
111
441
|
* @summary: Get store rule
|
|
112
|
-
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://
|
|
442
|
+
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getStoreRule/).
|
|
113
443
|
*/
|
|
114
444
|
getStoreRule({ ruleUid, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleDataSchema>;
|
|
115
445
|
/**
|
|
@@ -118,14 +448,48 @@ declare class Serviceability {
|
|
|
118
448
|
*
|
|
119
449
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
120
450
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
121
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
122
|
-
*
|
|
123
|
-
*
|
|
451
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetStoreRulesApiResult>} -
|
|
452
|
+
* Success response
|
|
124
453
|
* @name getStoreRules
|
|
125
454
|
* @summary: Get store rules
|
|
126
|
-
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://
|
|
455
|
+
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getStoreRules/).
|
|
456
|
+
*/
|
|
457
|
+
getStoreRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoreRulesApiResult>;
|
|
458
|
+
/**
|
|
459
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetZoneParam} arg - Arg object
|
|
460
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
461
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
462
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>} -
|
|
463
|
+
* Success response
|
|
464
|
+
* @name getZone
|
|
465
|
+
* @summary: Get zone details
|
|
466
|
+
* @description: Retrieves a single delivery zone - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZone/).
|
|
467
|
+
*/
|
|
468
|
+
getZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
|
|
469
|
+
/**
|
|
470
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetZoneProductsBulkPatchJobStatusParam} arg
|
|
471
|
+
* - Arg object
|
|
472
|
+
*
|
|
473
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
474
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
475
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetZoneProductsBulkPatchResult>}
|
|
476
|
+
* - Success response
|
|
477
|
+
*
|
|
478
|
+
* @name getZoneProductsBulkPatchJobStatus
|
|
479
|
+
* @summary: Get bulk zone products patch job status
|
|
480
|
+
* @description: Retrieves the status and details of a specific bulk zone products patch job by its batch identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZoneProductsBulkPatchJobStatus/).
|
|
127
481
|
*/
|
|
128
|
-
|
|
482
|
+
getZoneProductsBulkPatchJobStatus({ batchId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetZoneProductsBulkPatchJobStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneProductsBulkPatchResult>;
|
|
483
|
+
/**
|
|
484
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetZonesParam} arg - Arg object
|
|
485
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
486
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
487
|
+
* @returns {Promise<ServiceabilityPlatformModel.ListViewSchema>} - Success response
|
|
488
|
+
* @name getZones
|
|
489
|
+
* @summary: Get zones
|
|
490
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZones/).
|
|
491
|
+
*/
|
|
492
|
+
getZones({ stage, pageSize, pageNo, fulfillmentOptionSlug, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewSchema>;
|
|
129
493
|
/**
|
|
130
494
|
* @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
|
|
131
495
|
* - Arg object
|
|
@@ -136,132 +500,183 @@ declare class Serviceability {
|
|
|
136
500
|
* Success response
|
|
137
501
|
* @name insertApplicationConfig
|
|
138
502
|
* @summary: Create store rule configuration
|
|
139
|
-
* @description: Creates a order routing setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://
|
|
503
|
+
* @description: Creates a order routing setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/insertApplicationConfig/).
|
|
140
504
|
*/
|
|
141
505
|
insertApplicationConfig({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
142
506
|
/**
|
|
143
|
-
* @param {ServiceabilityPlatformApplicationValidator.
|
|
507
|
+
* @param {ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam} arg
|
|
144
508
|
* - Arg object
|
|
145
509
|
*
|
|
146
510
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
147
511
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
148
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
512
|
+
* @returns {Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>}
|
|
149
513
|
* - Success response
|
|
150
514
|
*
|
|
151
|
-
* @name
|
|
152
|
-
* @summary:
|
|
153
|
-
* @description:
|
|
515
|
+
* @name patchApplicationConfiguration
|
|
516
|
+
* @summary: To patch any config which can be applied to application
|
|
517
|
+
* @description: Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchApplicationConfiguration/).
|
|
154
518
|
*/
|
|
155
|
-
|
|
519
|
+
patchApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>;
|
|
156
520
|
/**
|
|
157
|
-
* @param {ServiceabilityPlatformApplicationValidator.
|
|
521
|
+
* @param {ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam} arg
|
|
158
522
|
* - Arg object
|
|
159
523
|
*
|
|
160
524
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
161
525
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
162
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
526
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
163
527
|
* Success response
|
|
164
|
-
* @name
|
|
165
|
-
* @summary: Update
|
|
166
|
-
* @description: Updates
|
|
528
|
+
* @name putFulfillmentOption
|
|
529
|
+
* @summary: Update an existing fulfillment option
|
|
530
|
+
* @description: Updates the details of an existing fulfillment option for the specified company and application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/putFulfillmentOption/).
|
|
167
531
|
*/
|
|
168
|
-
|
|
532
|
+
putFulfillmentOption({ slug, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
533
|
+
/**
|
|
534
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdateBulkGeoAreaParam} arg
|
|
535
|
+
* - Arg object
|
|
536
|
+
*
|
|
537
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
538
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
539
|
+
* @returns {Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>} -
|
|
540
|
+
* Success response
|
|
541
|
+
* @name updateBulkGeoArea
|
|
542
|
+
* @summary: Update geoareas and their associated regions in bulk
|
|
543
|
+
* @description: Update geoarea details and their associated regions through a CSV file in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateBulkGeoArea/).
|
|
544
|
+
*/
|
|
545
|
+
updateBulkGeoArea({ geoareaId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>;
|
|
169
546
|
/**
|
|
170
547
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateCourierPartnerRulePriorityParam} arg
|
|
171
548
|
* - Arg object
|
|
172
549
|
*
|
|
173
550
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
174
551
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
175
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
552
|
+
* @returns {Promise<ServiceabilityPlatformModel.RulePriorityResult>} -
|
|
176
553
|
* Success response
|
|
177
554
|
* @name updateCourierPartnerRulePriority
|
|
178
555
|
* @summary: Update courier partner rule priority
|
|
179
|
-
* @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://
|
|
556
|
+
* @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerRulePriority/).
|
|
180
557
|
*/
|
|
181
|
-
updateCourierPartnerRulePriority({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierPartnerRulePriorityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
558
|
+
updateCourierPartnerRulePriority({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierPartnerRulePriorityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.RulePriorityResult>;
|
|
182
559
|
/**
|
|
183
560
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateCourierRuleParam} arg
|
|
184
561
|
* - Arg object
|
|
185
562
|
*
|
|
186
563
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
187
564
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
188
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
565
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>}
|
|
189
566
|
* - Success response
|
|
190
567
|
*
|
|
191
568
|
* @name updateCourierRule
|
|
192
569
|
* @summary: Update courier rule
|
|
193
|
-
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://
|
|
570
|
+
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierRule/).
|
|
194
571
|
*/
|
|
195
|
-
updateCourierRule({
|
|
572
|
+
updateCourierRule({ ruleUid, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
573
|
+
/**
|
|
574
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdateGeoAreaParam} arg
|
|
575
|
+
* - Arg object
|
|
576
|
+
*
|
|
577
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
578
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
579
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaPutResponseBody>} -
|
|
580
|
+
* Success response
|
|
581
|
+
* @name updateGeoArea
|
|
582
|
+
* @summary: Update the details of existing GeoArea
|
|
583
|
+
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateGeoArea/).
|
|
584
|
+
*/
|
|
585
|
+
updateGeoArea({ geoareaId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaPutResponseBody>;
|
|
196
586
|
/**
|
|
197
587
|
* @param {ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam} arg
|
|
198
588
|
* - Arg object
|
|
199
589
|
*
|
|
200
590
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
201
591
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
202
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
592
|
+
* @returns {Promise<ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResultData>}
|
|
203
593
|
* - Success response
|
|
204
594
|
*
|
|
205
595
|
* @name updatePincodeAuditHistory
|
|
206
596
|
* @summary: Get audit trail
|
|
207
|
-
* @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://
|
|
597
|
+
* @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeAuditHistory/).
|
|
208
598
|
*/
|
|
209
|
-
updatePincodeAuditHistory({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
599
|
+
updatePincodeAuditHistory({ body, pageNumber, pageSize, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResultData>;
|
|
210
600
|
/**
|
|
211
601
|
* @param {ServiceabilityPlatformApplicationValidator.UpdatePincodeBulkViewParam} arg
|
|
212
602
|
* - Arg object
|
|
213
603
|
*
|
|
214
604
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
215
605
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
216
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
217
|
-
*
|
|
218
|
-
*
|
|
606
|
+
* @returns {Promise<ServiceabilityPlatformModel.PincodeBulkViewResult>} -
|
|
607
|
+
* Success response
|
|
219
608
|
* @name updatePincodeBulkView
|
|
220
609
|
* @summary: Bulk update pincode COD support
|
|
221
|
-
* @description: Updates the cash on delivery settings for multiple specified pin codes simultaneously. - Check out [method documentation](https://
|
|
610
|
+
* @description: Updates the cash on delivery settings for multiple specified pin codes simultaneously. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeBulkView/).
|
|
222
611
|
*/
|
|
223
|
-
updatePincodeBulkView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeBulkViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
612
|
+
updatePincodeBulkView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeBulkViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeBulkViewResult>;
|
|
224
613
|
/**
|
|
225
614
|
* @param {ServiceabilityPlatformApplicationValidator.UpdatePincodeCoDListingParam} arg
|
|
226
615
|
* - Arg object
|
|
227
616
|
*
|
|
228
617
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
229
618
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
230
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
619
|
+
* @returns {Promise<ServiceabilityPlatformModel.PincodeCodStatusListingResult>}
|
|
231
620
|
* - Success response
|
|
232
621
|
*
|
|
233
622
|
* @name updatePincodeCoDListing
|
|
234
623
|
* @summary: Get COD enabled pincodes
|
|
235
|
-
* @description: Retrieves a list of pincodes along with the count based on whether cash on delivery settings. - Check out [method documentation](https://
|
|
624
|
+
* @description: Retrieves a list of pincodes along with the count based on whether cash on delivery settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeCoDListing/).
|
|
236
625
|
*/
|
|
237
|
-
updatePincodeCoDListing({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeCoDListingParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
626
|
+
updatePincodeCoDListing({ body, pageNumber, pageSize, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeCoDListingParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeCodStatusListingResult>;
|
|
238
627
|
/**
|
|
239
628
|
* @param {ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam} arg
|
|
240
629
|
* - Arg object
|
|
241
630
|
*
|
|
242
631
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
243
632
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
244
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
245
|
-
* Success response
|
|
633
|
+
* @returns {Promise<ServiceabilityPlatformModel.PincodeMOPResult>} - Success response
|
|
246
634
|
* @name updatePincodeMopView
|
|
247
635
|
* @summary: Update pincode COD support
|
|
248
|
-
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://
|
|
636
|
+
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeMopView/).
|
|
249
637
|
*/
|
|
250
|
-
updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
638
|
+
updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMOPResult>;
|
|
639
|
+
/**
|
|
640
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdatePolygonParam} arg
|
|
641
|
+
* - Arg object
|
|
642
|
+
*
|
|
643
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
644
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
645
|
+
* @returns {Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityResult>}
|
|
646
|
+
* - Success response
|
|
647
|
+
*
|
|
648
|
+
* @name updatePolygon
|
|
649
|
+
* @summary: Update polygon-based serviceability for stores
|
|
650
|
+
* @description: Updates polygon-based serviceability regions for one or more stores for quick commerce. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePolygon/).
|
|
651
|
+
*/
|
|
652
|
+
updatePolygon({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePolygonParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityResult>;
|
|
653
|
+
/**
|
|
654
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdateStoreRulePriorityParam} arg
|
|
655
|
+
* - Arg object
|
|
656
|
+
*
|
|
657
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
658
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
659
|
+
* @returns {Promise<ServiceabilityPlatformModel.RulePriorityResult>} -
|
|
660
|
+
* Success response
|
|
661
|
+
* @name updateStoreRulePriority
|
|
662
|
+
* @summary: Update Store Rule priority
|
|
663
|
+
* @description: Update Store Rule priority - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRulePriority/).
|
|
664
|
+
*/
|
|
665
|
+
updateStoreRulePriority({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulePriorityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.RulePriorityResult>;
|
|
251
666
|
/**
|
|
252
667
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateStoreRulesParam} arg
|
|
253
668
|
* - Arg object
|
|
254
669
|
*
|
|
255
670
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
256
671
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
257
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
672
|
+
* @returns {Promise<ServiceabilityPlatformModel.StoreRuleUpdateResultSchema>}
|
|
258
673
|
* - Success response
|
|
259
674
|
*
|
|
260
675
|
* @name updateStoreRules
|
|
261
676
|
* @summary: Update store rule
|
|
262
|
-
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://
|
|
677
|
+
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRules/).
|
|
263
678
|
*/
|
|
264
|
-
updateStoreRules({ ruleUid, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
679
|
+
updateStoreRules({ ruleUid, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleUpdateResultSchema>;
|
|
265
680
|
/**
|
|
266
681
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateStoreRulesConfigParam} arg
|
|
267
682
|
* - Arg object
|
|
@@ -272,9 +687,51 @@ declare class Serviceability {
|
|
|
272
687
|
* Success response
|
|
273
688
|
* @name updateStoreRulesConfig
|
|
274
689
|
* @summary: Update store rules configuration
|
|
275
|
-
* @description: Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://
|
|
690
|
+
* @description: Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRulesConfig/).
|
|
276
691
|
*/
|
|
277
692
|
updateStoreRulesConfig({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulesConfigParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
693
|
+
/**
|
|
694
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdateZoneParam} arg
|
|
695
|
+
* - Arg object
|
|
696
|
+
*
|
|
697
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
698
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
699
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneUpdateSuccessResult>}
|
|
700
|
+
* - Success response
|
|
701
|
+
*
|
|
702
|
+
* @name updateZone
|
|
703
|
+
* @summary: Update details of a Zone to enable or disable
|
|
704
|
+
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateZone/).
|
|
705
|
+
*/
|
|
706
|
+
updateZone({ zoneId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneUpdateSuccessResult>;
|
|
707
|
+
/**
|
|
708
|
+
* @param {ServiceabilityPlatformApplicationValidator.UploadBulkFulfillmentOptionsParam} arg
|
|
709
|
+
* - Arg object
|
|
710
|
+
*
|
|
711
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
712
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
713
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkData>}
|
|
714
|
+
* - Success response
|
|
715
|
+
*
|
|
716
|
+
* @name uploadBulkFulfillmentOptions
|
|
717
|
+
* @summary: Upload bulk fulfillment options.
|
|
718
|
+
* @description: Uploads a bulk list of fulfillment options for an application, allowing multiple fulfillment configurations to be processed at once. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/uploadBulkFulfillmentOptions/).
|
|
719
|
+
*/
|
|
720
|
+
uploadBulkFulfillmentOptions({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UploadBulkFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkData>;
|
|
721
|
+
/**
|
|
722
|
+
* @param {ServiceabilityPlatformApplicationValidator.ValidateBulkFulfillmentOptionsParam} arg
|
|
723
|
+
* - Arg object
|
|
724
|
+
*
|
|
725
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
726
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
727
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidateData>}
|
|
728
|
+
* - Success response
|
|
729
|
+
*
|
|
730
|
+
* @name validateBulkFulfillmentOptions
|
|
731
|
+
* @summary: Validate bulk fulfillment options.
|
|
732
|
+
* @description: Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/validateBulkFulfillmentOptions/).
|
|
733
|
+
*/
|
|
734
|
+
validateBulkFulfillmentOptions({ type, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.ValidateBulkFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidateData>;
|
|
278
735
|
}
|
|
279
736
|
import ServiceabilityPlatformApplicationValidator = require("./ServiceabilityPlatformApplicationValidator");
|
|
280
737
|
import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|