@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-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/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -2,31 +2,6 @@ export = Serviceability;
|
|
|
2
2
|
declare class Serviceability {
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
|
-
/**
|
|
6
|
-
* @param {ServiceabilityPlatformValidator.BulkServiceabilityParam} arg - Arg object
|
|
7
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResultItemData>}
|
|
10
|
-
* - Success response
|
|
11
|
-
*
|
|
12
|
-
* @name bulkServiceability
|
|
13
|
-
* @summary: Bulk update serviceability of localities
|
|
14
|
-
* @description: Bulk operations involve either new serviceability settings or updating existing ones in large quantities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/bulkServiceability/).
|
|
15
|
-
*/
|
|
16
|
-
bulkServiceability({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResultItemData>;
|
|
17
|
-
/**
|
|
18
|
-
* @param {ServiceabilityPlatformValidator.BulkTatParam} arg - Arg object
|
|
19
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
20
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
|
-
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResultItemData>}
|
|
22
|
-
* - Success response
|
|
23
|
-
*
|
|
24
|
-
* @name bulkTat
|
|
25
|
-
* @summary: Locality TAT import or export
|
|
26
|
-
* @description: Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file.
|
|
27
|
-
* Export locality wise CSV files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/bulkTat/).
|
|
28
|
-
*/
|
|
29
|
-
bulkTat({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkTatParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResultItemData>;
|
|
30
5
|
/**
|
|
31
6
|
* @param {ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam} arg
|
|
32
7
|
* - Arg object
|
|
@@ -36,36 +11,23 @@ declare class Serviceability {
|
|
|
36
11
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccount>} - Success response
|
|
37
12
|
* @name createCourierPartnerAccount
|
|
38
13
|
* @summary: Create courier account
|
|
39
|
-
* @description:
|
|
14
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerAccount/).
|
|
40
15
|
*/
|
|
41
16
|
createCourierPartnerAccount({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccount>;
|
|
42
17
|
/**
|
|
43
|
-
* @param {ServiceabilityPlatformValidator.
|
|
18
|
+
* @param {ServiceabilityPlatformValidator.CreatePackageMaterialParam} arg
|
|
44
19
|
* - Arg object
|
|
45
20
|
*
|
|
46
21
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
22
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
23
|
+
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialResponse>}
|
|
49
24
|
* - Success response
|
|
50
25
|
*
|
|
51
|
-
* @name createCourierPartnerScheme
|
|
52
|
-
* @summary: Create Scheme for courier partner extension
|
|
53
|
-
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerScheme/).
|
|
54
|
-
*/
|
|
55
|
-
createCourierPartnerScheme({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerV2SchemeModel>;
|
|
56
|
-
/**
|
|
57
|
-
* @param {ServiceabilityPlatformValidator.CreatePackageMaterialParam} arg
|
|
58
|
-
* - Arg object
|
|
59
|
-
*
|
|
60
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
61
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
62
|
-
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialResult>} -
|
|
63
|
-
* Success response
|
|
64
26
|
* @name createPackageMaterial
|
|
65
27
|
* @summary: Create packaging material
|
|
66
28
|
* @description: Creates a packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterial/).
|
|
67
29
|
*/
|
|
68
|
-
createPackageMaterial({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
30
|
+
createPackageMaterial({ body, pageNo, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
69
31
|
/**
|
|
70
32
|
* @param {ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam} arg
|
|
71
33
|
* - Arg object
|
|
@@ -79,49 +41,6 @@ declare class Serviceability {
|
|
|
79
41
|
* @description: Creates a packaging rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
80
42
|
*/
|
|
81
43
|
createPackageMaterialRule({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResult>;
|
|
82
|
-
/**
|
|
83
|
-
* @param {ServiceabilityPlatformValidator.CreateZoneParam} arg - Arg object
|
|
84
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
|
-
* @returns {Promise<ServiceabilityPlatformModel.ZoneResult>} - Success response
|
|
87
|
-
* @name createZone
|
|
88
|
-
* @summary: Create zone
|
|
89
|
-
* @description: Creates a delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
|
|
90
|
-
*/
|
|
91
|
-
createZone({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneResult>;
|
|
92
|
-
/**
|
|
93
|
-
* @param {ServiceabilityPlatformValidator.GetAllStoresParam} arg - Arg object
|
|
94
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
-
* @returns {Promise<ServiceabilityPlatformModel.GetStoresViewResult>} -
|
|
97
|
-
* Success response
|
|
98
|
-
* @name getAllStores
|
|
99
|
-
* @summary: Get all stores
|
|
100
|
-
* @description: Retrieves a list of locations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
|
|
101
|
-
*/
|
|
102
|
-
getAllStores({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoresViewResult>;
|
|
103
|
-
/**
|
|
104
|
-
* @param {ServiceabilityPlatformValidator.GetBulkServiceabilityParam} arg
|
|
105
|
-
* - Arg object
|
|
106
|
-
*
|
|
107
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
108
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
|
-
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResult>} - Success response
|
|
110
|
-
* @name getBulkServiceability
|
|
111
|
-
* @summary: Bulk update history
|
|
112
|
-
* @description: Retrieves the history of changes made to serviceability settings for a scheme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getBulkServiceability/).
|
|
113
|
-
*/
|
|
114
|
-
getBulkServiceability({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResult>;
|
|
115
|
-
/**
|
|
116
|
-
* @param {ServiceabilityPlatformValidator.GetBulkTatParam} arg - Arg object
|
|
117
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
118
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
119
|
-
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResult>} - Success response
|
|
120
|
-
* @name getBulkTat
|
|
121
|
-
* @summary: Locality TAT change history
|
|
122
|
-
* @description: Retrieves the history of changes made to TAT(Turn Around Time) for scheme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getBulkTat/).
|
|
123
|
-
*/
|
|
124
|
-
getBulkTat({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkTatParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResult>;
|
|
125
44
|
/**
|
|
126
45
|
* @param {ServiceabilityPlatformValidator.GetCompanyConfigurationParam} arg
|
|
127
46
|
* - Arg object
|
|
@@ -134,82 +53,173 @@ declare class Serviceability {
|
|
|
134
53
|
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
135
54
|
*/
|
|
136
55
|
getCompanyConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
56
|
+
/**
|
|
57
|
+
* @param {ServiceabilityPlatformValidator.GetCompanySelfShipParam} arg - Arg object
|
|
58
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
|
+
* @returns {Promise<ServiceabilityPlatformModel.CompanySelfShip>} - Success response
|
|
61
|
+
* @name getCompanySelfShip
|
|
62
|
+
* @summary: Update Company Self Ship
|
|
63
|
+
* @description: Updates Self Ship at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanySelfShip/).
|
|
64
|
+
*/
|
|
65
|
+
getCompanySelfShip({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanySelfShip>;
|
|
137
66
|
/**
|
|
138
67
|
* @param {ServiceabilityPlatformValidator.GetCountriesParam} arg - Arg object
|
|
139
68
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
140
69
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
141
70
|
* @returns {Promise<ServiceabilityPlatformModel.GetCountries>} - Success response
|
|
142
71
|
* @name getCountries
|
|
143
|
-
* @summary: Get countries
|
|
72
|
+
* @summary: Get all countries and associated data.
|
|
144
73
|
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCountries/).
|
|
145
74
|
*/
|
|
146
|
-
getCountries({
|
|
75
|
+
getCountries({ onboard, pageNo, pageSize, q, hierarchy, requestHeaders }?: ServiceabilityPlatformValidator.GetCountriesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetCountries>;
|
|
76
|
+
/**
|
|
77
|
+
* @param {ServiceabilityPlatformValidator.GetCountryParam} arg - Arg object
|
|
78
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetCountry>} - Success response
|
|
81
|
+
* @name getCountry
|
|
82
|
+
* @summary: Get single country and associated data.
|
|
83
|
+
* @description: Retrieve data for a single country and address format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCountry/).
|
|
84
|
+
*/
|
|
85
|
+
getCountry({ countryIsoCode, requestHeaders }?: ServiceabilityPlatformValidator.GetCountryParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetCountry>;
|
|
147
86
|
/**
|
|
148
87
|
* @param {ServiceabilityPlatformValidator.GetCourierPartnerAccountParam} arg
|
|
149
88
|
* - Arg object
|
|
150
89
|
*
|
|
151
90
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
152
91
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
153
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
92
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
154
93
|
* Success response
|
|
155
94
|
* @name getCourierPartnerAccount
|
|
156
95
|
* @summary: Get courier account
|
|
157
96
|
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccount/).
|
|
158
97
|
*/
|
|
159
|
-
getCourierPartnerAccount({ accountId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
98
|
+
getCourierPartnerAccount({ accountId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResponse>;
|
|
160
99
|
/**
|
|
161
100
|
* @param {ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam} arg
|
|
162
101
|
* - Arg object
|
|
163
102
|
*
|
|
164
103
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
165
104
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
166
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
105
|
+
* @returns {Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResponse>}
|
|
167
106
|
* - Success response
|
|
168
107
|
*
|
|
169
108
|
* @name getCourierPartnerAccounts
|
|
170
109
|
* @summary: List courier accounts
|
|
171
110
|
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
172
111
|
*/
|
|
173
|
-
getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
112
|
+
getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, accountIds, selfShip, ownAccount, q, requestHeaders, }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResponse>;
|
|
174
113
|
/**
|
|
175
|
-
* @param {ServiceabilityPlatformValidator.
|
|
114
|
+
* @param {ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam} arg
|
|
176
115
|
* - Arg object
|
|
177
116
|
*
|
|
178
117
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
118
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
119
|
+
* @returns {Promise<ServiceabilityPlatformModel.InstallCourierPartnerResponseSchema>}
|
|
181
120
|
* - Success response
|
|
182
121
|
*
|
|
183
|
-
* @name
|
|
184
|
-
* @summary:
|
|
185
|
-
* @description:
|
|
122
|
+
* @name getInstalledCourierPartnerExtensions
|
|
123
|
+
* @summary: Fetching of Package Material Rules from database.
|
|
124
|
+
* @description: This API returns response of Package Materials Rules from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/).
|
|
186
125
|
*/
|
|
187
|
-
|
|
126
|
+
getInstalledCourierPartnerExtensions({ pageNo, pageSize, isInstalled, requestHeaders }?: ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.InstallCourierPartnerResponseSchema>;
|
|
188
127
|
/**
|
|
189
|
-
* @param {ServiceabilityPlatformValidator.
|
|
128
|
+
* @param {ServiceabilityPlatformValidator.GetListPackageMaterialRuleDetailsParam} arg
|
|
190
129
|
* - Arg object
|
|
191
130
|
*
|
|
192
131
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
193
132
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
194
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
133
|
+
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialRuleList>}
|
|
195
134
|
* - Success response
|
|
196
135
|
*
|
|
197
|
-
* @name
|
|
198
|
-
* @summary:
|
|
199
|
-
* @description:
|
|
136
|
+
* @name getListPackageMaterialRuleDetails
|
|
137
|
+
* @summary: Fetching of Package Material Rules from database.
|
|
138
|
+
* @description: This API returns response of Package Materials Rules from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getListPackageMaterialRuleDetails/).
|
|
139
|
+
*/
|
|
140
|
+
getListPackageMaterialRuleDetails({ pageNo, pageSize, isActive, requestHeaders }?: ServiceabilityPlatformValidator.GetListPackageMaterialRuleDetailsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialRuleList>;
|
|
141
|
+
/**
|
|
142
|
+
* @param {ServiceabilityPlatformValidator.GetLocalitiesParam} arg - Arg object
|
|
143
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
144
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
145
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetLocalities>} - Success response
|
|
146
|
+
* @name getLocalities
|
|
147
|
+
* @summary: Get Localities.
|
|
148
|
+
* @description: Get Localities data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getLocalities/).
|
|
149
|
+
*/
|
|
150
|
+
getLocalities({ localityType, country, state, city, pageNo, pageSize, q, name, requestHeaders, }?: ServiceabilityPlatformValidator.GetLocalitiesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetLocalities>;
|
|
151
|
+
/**
|
|
152
|
+
* @param {Object} arg - Arg object.
|
|
153
|
+
* @param {string} arg.localityType - A `locality_type` contains unique
|
|
154
|
+
* geographical division.
|
|
155
|
+
* @param {string} [arg.country] - A `country` contains a specific value of
|
|
156
|
+
* the country iso2 code.
|
|
157
|
+
* @param {string} [arg.state] - A `state` contains a specific value of the
|
|
158
|
+
* state, province.
|
|
159
|
+
* @param {string} [arg.city] - A `city` contains a specific value of the city.
|
|
160
|
+
* @param {number} [arg.pageSize] - Page size.
|
|
161
|
+
* @param {string} [arg.q] - Search.
|
|
162
|
+
* @param {string} [arg.name] - Search for localities. Either provide a full
|
|
163
|
+
* name or a search term.
|
|
164
|
+
* @returns {Paginator<ServiceabilityPlatformModel.GetLocalities>}
|
|
165
|
+
* @summary: Get Localities.
|
|
166
|
+
* @description: Get Localities data.
|
|
167
|
+
*/
|
|
168
|
+
getLocalitiesPaginator({ localityType, country, state, city, pageSize, q, name, }?: {
|
|
169
|
+
localityType: string;
|
|
170
|
+
country?: string;
|
|
171
|
+
state?: string;
|
|
172
|
+
city?: string;
|
|
173
|
+
pageSize?: number;
|
|
174
|
+
q?: string;
|
|
175
|
+
name?: string;
|
|
176
|
+
}): Paginator<ServiceabilityPlatformModel.GetLocalities>;
|
|
177
|
+
/**
|
|
178
|
+
* @param {ServiceabilityPlatformValidator.GetLocalitiesByPrefixParam} arg
|
|
179
|
+
* - Arg object
|
|
180
|
+
*
|
|
181
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
182
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
183
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetLocalities>} - Success response
|
|
184
|
+
* @name getLocalitiesByPrefix
|
|
185
|
+
* @summary: Get Localities by Name Prefix
|
|
186
|
+
* @description: Get localities that start with a specified prefix. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getLocalitiesByPrefix/).
|
|
200
187
|
*/
|
|
201
|
-
|
|
188
|
+
getLocalitiesByPrefix({ pageNo, pageSize, q, requestHeaders }?: ServiceabilityPlatformValidator.GetLocalitiesByPrefixParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetLocalities>;
|
|
189
|
+
/**
|
|
190
|
+
* @param {Object} arg - Arg object.
|
|
191
|
+
* @param {number} [arg.pageSize] - Number of items per page.
|
|
192
|
+
* @param {string} [arg.q] - Localities starting with the specified prefix.
|
|
193
|
+
* @returns {Paginator<ServiceabilityPlatformModel.GetLocalities>}
|
|
194
|
+
* @summary: Get Localities by Name Prefix
|
|
195
|
+
* @description: Get localities that start with a specified prefix.
|
|
196
|
+
*/
|
|
197
|
+
getLocalitiesByPrefixPaginator({ pageSize, q }?: {
|
|
198
|
+
pageSize?: number;
|
|
199
|
+
q?: string;
|
|
200
|
+
}): Paginator<ServiceabilityPlatformModel.GetLocalities>;
|
|
201
|
+
/**
|
|
202
|
+
* @param {ServiceabilityPlatformValidator.GetLocalityParam} arg - Arg object
|
|
203
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
204
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
205
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetLocality>} - Success response
|
|
206
|
+
* @name getLocality
|
|
207
|
+
* @summary: Get Locality API
|
|
208
|
+
* @description: Get Locality data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getLocality/).
|
|
209
|
+
*/
|
|
210
|
+
getLocality({ localityType, localityValue, country, state, city, requestHeaders }?: ServiceabilityPlatformValidator.GetLocalityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetLocality>;
|
|
202
211
|
/**
|
|
203
212
|
* @param {ServiceabilityPlatformValidator.GetOptimalLocationsParam} arg - Arg object
|
|
204
213
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
205
214
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
206
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
207
|
-
* Success response
|
|
215
|
+
* @returns {Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>}
|
|
216
|
+
* - Success response
|
|
217
|
+
*
|
|
208
218
|
* @name getOptimalLocations
|
|
209
219
|
* @summary: Get selling locations
|
|
210
220
|
* @description: Retrieves a list selling locations which are best suited to fullfil an order for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
|
|
211
221
|
*/
|
|
212
|
-
getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
222
|
+
getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>;
|
|
213
223
|
/**
|
|
214
224
|
* @param {ServiceabilityPlatformValidator.GetPackageMaterialListParam} arg
|
|
215
225
|
* - Arg object
|
|
@@ -237,90 +247,30 @@ declare class Serviceability {
|
|
|
237
247
|
*/
|
|
238
248
|
getPackageMaterialRule({ ruleId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResult>;
|
|
239
249
|
/**
|
|
240
|
-
* @param {ServiceabilityPlatformValidator.
|
|
250
|
+
* @param {ServiceabilityPlatformValidator.GetPackageMaterialRuleDetailsParam} arg
|
|
241
251
|
* - Arg object
|
|
242
252
|
*
|
|
243
253
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
244
254
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
245
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
* @
|
|
249
|
-
* @
|
|
250
|
-
* @description: Retrieve packaging rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRules/).
|
|
255
|
+
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResult>} -
|
|
256
|
+
* Success response
|
|
257
|
+
* @name getPackageMaterialRuleDetails
|
|
258
|
+
* @summary: Fetching of Package Material Rule from database.
|
|
259
|
+
* @description: This API returns details of package materials rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRuleDetails/).
|
|
251
260
|
*/
|
|
252
|
-
|
|
261
|
+
getPackageMaterialRuleDetails({ ruleId, pageNo, pageSize, isActive, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRuleDetailsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResult>;
|
|
253
262
|
/**
|
|
254
263
|
* @param {ServiceabilityPlatformValidator.GetPackageMaterialsParam} arg - Arg object
|
|
255
264
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
256
265
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
257
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
258
|
-
* Success response
|
|
266
|
+
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialResponse>}
|
|
267
|
+
* - Success response
|
|
268
|
+
*
|
|
259
269
|
* @name getPackageMaterials
|
|
260
270
|
* @summary: Get packaging material
|
|
261
271
|
* @description: Retrieve a single packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
|
|
262
272
|
*/
|
|
263
|
-
getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
264
|
-
/**
|
|
265
|
-
* @param {ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam} arg
|
|
266
|
-
* - Arg object
|
|
267
|
-
*
|
|
268
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
269
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
|
-
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResult>}
|
|
271
|
-
* - Success response
|
|
272
|
-
*
|
|
273
|
-
* @name getSampleFileServiceabilityStatus
|
|
274
|
-
* @summary: Get Serviceability TAT sample files generator status
|
|
275
|
-
* @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getSampleFileServiceabilityStatus/).
|
|
276
|
-
*/
|
|
277
|
-
getSampleFileServiceabilityStatus({ pageNo, pageSize, batchId, requestHeaders }?: ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResult>;
|
|
278
|
-
/**
|
|
279
|
-
* @param {ServiceabilityPlatformValidator.GetServiceabilityParam} arg - Arg object
|
|
280
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
281
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
282
|
-
* @returns {Promise<ServiceabilityPlatformModel.ServiceabilityModel>} -
|
|
283
|
-
* Success response
|
|
284
|
-
* @name getServiceability
|
|
285
|
-
* @summary: Get serviceability of a locality
|
|
286
|
-
* @description: Rerieves serviceability settings of a single courier scheme for a given locality - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getServiceability/).
|
|
287
|
-
*/
|
|
288
|
-
getServiceability({ extensionId, schemeId, regionId, requestHeaders }?: ServiceabilityPlatformValidator.GetServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ServiceabilityModel>;
|
|
289
|
-
/**
|
|
290
|
-
* @param {ServiceabilityPlatformValidator.GetZoneByIdParam} arg - Arg object
|
|
291
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
292
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
293
|
-
* @returns {Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>} -
|
|
294
|
-
* Success response
|
|
295
|
-
* @name getZoneById
|
|
296
|
-
* @summary: Get zone details
|
|
297
|
-
* @description: Retrieves a single delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZoneById/).
|
|
298
|
-
*/
|
|
299
|
-
getZoneById({ zoneId, requestHeaders }?: ServiceabilityPlatformValidator.GetZoneByIdParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
|
|
300
|
-
/**
|
|
301
|
-
* @param {ServiceabilityPlatformValidator.GetZonesParam} arg - Arg object
|
|
302
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
304
|
-
* @returns {Promise<ServiceabilityPlatformModel.ListViewResult>} - Success response
|
|
305
|
-
* @name getZones
|
|
306
|
-
* @summary: Get zones
|
|
307
|
-
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
|
|
308
|
-
*/
|
|
309
|
-
getZones({ pageNo, pageSize, isActive, channelId, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResult>;
|
|
310
|
-
/**
|
|
311
|
-
* @param {ServiceabilityPlatformValidator.SampleFileServiceabilityParam} arg
|
|
312
|
-
* - Arg object
|
|
313
|
-
*
|
|
314
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
316
|
-
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResultItemData>}
|
|
317
|
-
* - Success response
|
|
318
|
-
*
|
|
319
|
-
* @name sampleFileServiceability
|
|
320
|
-
* @summary: Sample File Download
|
|
321
|
-
* @description: Sample File Download - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/sampleFileServiceability/).
|
|
322
|
-
*/
|
|
323
|
-
sampleFileServiceability({ body, requestHeaders }?: ServiceabilityPlatformValidator.SampleFileServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResultItemData>;
|
|
273
|
+
getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
324
274
|
/**
|
|
325
275
|
* @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
|
|
326
276
|
* - Arg object
|
|
@@ -334,32 +284,29 @@ declare class Serviceability {
|
|
|
334
284
|
*/
|
|
335
285
|
updateCompanyConfiguration({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
336
286
|
/**
|
|
337
|
-
* @param {ServiceabilityPlatformValidator.
|
|
287
|
+
* @param {ServiceabilityPlatformValidator.UpdateCompanySelfShipParam} arg
|
|
338
288
|
* - Arg object
|
|
339
289
|
*
|
|
340
290
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
341
291
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
342
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
343
|
-
*
|
|
344
|
-
* @
|
|
345
|
-
* @
|
|
346
|
-
* @description: Updates an existing courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
292
|
+
* @returns {Promise<ServiceabilityPlatformModel.CompanySelfShip>} - Success response
|
|
293
|
+
* @name updateCompanySelfShip
|
|
294
|
+
* @summary: Update Company Self Ship
|
|
295
|
+
* @description: Updates Self Ship at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCompanySelfShip/).
|
|
347
296
|
*/
|
|
348
|
-
|
|
297
|
+
updateCompanySelfShip({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanySelfShipParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanySelfShip>;
|
|
349
298
|
/**
|
|
350
|
-
* @param {ServiceabilityPlatformValidator.
|
|
299
|
+
* @param {ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam} arg
|
|
351
300
|
* - Arg object
|
|
352
301
|
*
|
|
353
302
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
354
303
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
355
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
356
|
-
*
|
|
357
|
-
*
|
|
358
|
-
* @
|
|
359
|
-
* @summary: Update Scheme for courier partner extension
|
|
360
|
-
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerScheme/).
|
|
304
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierAccount>} - Success response
|
|
305
|
+
* @name updateCourierPartnerAccount
|
|
306
|
+
* @summary: Update courier account
|
|
307
|
+
* @description: Updates an existing courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
361
308
|
*/
|
|
362
|
-
|
|
309
|
+
updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccount>;
|
|
363
310
|
/**
|
|
364
311
|
* @param {ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam} arg
|
|
365
312
|
* - Arg object
|
|
@@ -379,35 +326,26 @@ declare class Serviceability {
|
|
|
379
326
|
*
|
|
380
327
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
381
328
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
382
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
383
|
-
* Success response
|
|
329
|
+
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialResponse>}
|
|
330
|
+
* - Success response
|
|
331
|
+
*
|
|
384
332
|
* @name updatePackageMaterials
|
|
385
333
|
* @summary: Update packaging material
|
|
386
334
|
* @description: Update an existing packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterials/).
|
|
387
335
|
*/
|
|
388
|
-
updatePackageMaterials({ packageMaterialId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
389
|
-
/**
|
|
390
|
-
* @param {ServiceabilityPlatformValidator.UpdateServiceabilityParam} arg - Arg object
|
|
391
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
392
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
393
|
-
* @returns {Promise<ServiceabilityPlatformModel.ServiceabilityModel>} -
|
|
394
|
-
* Success response
|
|
395
|
-
* @name updateServiceability
|
|
396
|
-
* @summary: Update Serviceability of a locality
|
|
397
|
-
* @description: Updates serviceability settings of a single courier scheme for a given locality - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateServiceability/).
|
|
398
|
-
*/
|
|
399
|
-
updateServiceability({ extensionId, schemeId, regionId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ServiceabilityModel>;
|
|
336
|
+
updatePackageMaterials({ packageMaterialId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
400
337
|
/**
|
|
401
|
-
* @param {ServiceabilityPlatformValidator.
|
|
338
|
+
* @param {ServiceabilityPlatformValidator.ValidateAddressParam} arg - Arg object
|
|
402
339
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
403
340
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
404
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
341
|
+
* @returns {Promise<ServiceabilityPlatformModel.ValidateAddressRequest>} -
|
|
405
342
|
* Success response
|
|
406
|
-
* @name
|
|
407
|
-
* @summary:
|
|
408
|
-
* @description:
|
|
343
|
+
* @name validateAddress
|
|
344
|
+
* @summary: Validate given address wrt template
|
|
345
|
+
* @description: Validate given address wrt template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/validateAddress/).
|
|
409
346
|
*/
|
|
410
|
-
|
|
347
|
+
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: ServiceabilityPlatformValidator.ValidateAddressParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ValidateAddressRequest>;
|
|
411
348
|
}
|
|
412
349
|
import ServiceabilityPlatformValidator = require("./ServiceabilityPlatformValidator");
|
|
413
350
|
import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
351
|
+
import Paginator = require("../../common/Paginator");
|