@gofynd/fdk-client-javascript 1.6.4 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +5 -5
- package/sdk/application/Cart/CartApplicationClient.js +26 -268
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +20 -20
- package/sdk/application/Catalog/CatalogApplicationClient.js +98 -347
- package/sdk/application/Common/CommonApplicationClient.js +1 -16
- package/sdk/application/Communication/CommunicationApplicationClient.js +1 -24
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +24 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +58 -137
- package/sdk/application/Content/ContentApplicationClient.d.ts +47 -7
- package/sdk/application/Content/ContentApplicationClient.js +222 -191
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.js +1 -16
- package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
- package/sdk/application/Lead/LeadApplicationClient.js +21 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -56
- package/sdk/application/Logistic/LogisticApplicationClient.js +57 -332
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
- package/sdk/application/Order/OrderApplicationClient.js +68 -153
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -12
- package/sdk/application/Payment/PaymentApplicationClient.js +7 -487
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -59
- package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationClient.js +21 -75
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +19 -47
- package/sdk/application/User/UserApplicationClient.js +1 -407
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -8
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -55
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +1 -408
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -37
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +2 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +29 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +65 -42
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1008 -794
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +573 -460
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +10 -5
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +67 -9
- package/sdk/platform/Cart/CartPlatformModel.js +38 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +4 -4
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +47 -13
- package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -7
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +7 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +71 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +70 -6
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +0 -27
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +8 -60
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -3
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +13 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +68 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +49 -7
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +169 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1279 -132
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +156 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +180 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +162 -0
- package/sdk/platform/Content/ContentPlatformClient.js +1697 -497
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1053 -35
- package/sdk/platform/Content/ContentPlatformModel.js +717 -34
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +127 -1
- package/sdk/platform/Content/ContentPlatformValidator.js +171 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +34 -0
- package/sdk/platform/Discount/DiscountPlatformClient.js +59 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +365 -93
- package/sdk/platform/Discount/DiscountPlatformModel.js +98 -93
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +54 -34
- package/sdk/platform/Discount/DiscountPlatformValidator.js +27 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +0 -156
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +0 -1072
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -137
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -173
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +1 -1105
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +0 -1125
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -0
- package/sdk/platform/Lead/LeadPlatformModel.js +2 -0
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +212 -0
- package/sdk/platform/Order/OrderPlatformClient.js +397 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +41 -9
- package/sdk/platform/Order/OrderPlatformModel.js +20 -7
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +58 -10
- package/sdk/platform/Partner/PartnerPlatformModel.js +19 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +8 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +5 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.js +2 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +240 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +1753 -277
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +320 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +269 -19
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -104
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +201 -629
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +5720 -2891
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3414 -2181
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +138 -216
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +81 -148
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +13 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +12 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +52 -1
- package/sdk/platform/User/UserPlatformModel.js +36 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +2 -0
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +6 -11
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -16
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -3
- package/sdk/public/Content/ContentPublicClient.js +261 -104
- package/sdk/public/Content/ContentPublicModel.d.ts +155 -1
- package/sdk/public/Content/ContentPublicModel.js +102 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -1
- package/sdk/public/Content/ContentPublicValidator.js +26 -0
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- 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/Webhook/WebhookPublicClient.js +1 -40
|
@@ -3,6 +3,31 @@ 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://partners.fynd.com/help/docs/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://partners.fynd.com/help/docs/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
|
|
@@ -17,6 +42,33 @@ declare class Serviceability {
|
|
|
17
42
|
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerRule/).
|
|
18
43
|
*/
|
|
19
44
|
createCourierPartnerRule({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
45
|
+
/**
|
|
46
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam} arg
|
|
47
|
+
* - Arg object
|
|
48
|
+
*
|
|
49
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
51
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaResponseBody>} -
|
|
52
|
+
* Success response
|
|
53
|
+
* @name createGeoArea
|
|
54
|
+
* @summary: Creation of GeoArea
|
|
55
|
+
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createGeoArea/).
|
|
56
|
+
*/
|
|
57
|
+
createGeoArea({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaResponseBody>;
|
|
58
|
+
/**
|
|
59
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateGeoAreaExportJobParam} arg
|
|
60
|
+
* - Arg object
|
|
61
|
+
*
|
|
62
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
63
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaBulkCreationResult>}
|
|
65
|
+
* - Success response
|
|
66
|
+
*
|
|
67
|
+
* @name createGeoAreaExportJob
|
|
68
|
+
* @summary: Create job for exporting Geoarea regions
|
|
69
|
+
* @description: Create the job for exporting the regions in Geoarea in CSV format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createGeoAreaExportJob/).
|
|
70
|
+
*/
|
|
71
|
+
createGeoAreaExportJob({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaExportJobParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkCreationResult>;
|
|
20
72
|
/**
|
|
21
73
|
* @param {ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam} arg
|
|
22
74
|
* - Arg object
|
|
@@ -30,6 +82,44 @@ declare class Serviceability {
|
|
|
30
82
|
* @description: Create a rule within the order routing rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createStoreRules/).
|
|
31
83
|
*/
|
|
32
84
|
createStoreRules({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleResultSchema>;
|
|
85
|
+
/**
|
|
86
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateZoneParam} arg
|
|
87
|
+
* - Arg object
|
|
88
|
+
*
|
|
89
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneSchema>} - Success response
|
|
92
|
+
* @name createZone
|
|
93
|
+
* @summary: Create zone
|
|
94
|
+
* @description: Creates a delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
|
|
95
|
+
*/
|
|
96
|
+
createZone({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneSchema>;
|
|
97
|
+
/**
|
|
98
|
+
* @param {ServiceabilityPlatformApplicationValidator.DeleteZoneParam} arg
|
|
99
|
+
* - Arg object
|
|
100
|
+
*
|
|
101
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
102
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneDeleteSuccessResult>}
|
|
104
|
+
* - Success response
|
|
105
|
+
*
|
|
106
|
+
* @name deleteZone
|
|
107
|
+
* @summary: Delete a Specific Zone
|
|
108
|
+
* @description: Delete a Zone under that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/deleteZone/).
|
|
109
|
+
*/
|
|
110
|
+
deleteZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.DeleteZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneDeleteSuccessResult>;
|
|
111
|
+
/**
|
|
112
|
+
* @param {ServiceabilityPlatformApplicationValidator.DownloadGeoareaSampleFileParam} arg
|
|
113
|
+
* - Arg object
|
|
114
|
+
*
|
|
115
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
116
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
117
|
+
* @returns {Promise<string>} - Success response
|
|
118
|
+
* @name downloadGeoareaSampleFile
|
|
119
|
+
* @summary: Download geoarea sample file
|
|
120
|
+
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/downloadGeoareaSampleFile/).
|
|
121
|
+
*/
|
|
122
|
+
downloadGeoareaSampleFile({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
|
|
33
123
|
/**
|
|
34
124
|
* @param {ServiceabilityPlatformApplicationValidator.GetApplicationConfigParam} arg
|
|
35
125
|
* - Arg object
|
|
@@ -49,27 +139,40 @@ declare class Serviceability {
|
|
|
49
139
|
*
|
|
50
140
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
141
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
52
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
53
|
-
* Success response
|
|
142
|
+
* @returns {Promise<ServiceabilityPlatformModel.ApplicationConfigGetResult>}
|
|
143
|
+
* - Success response
|
|
144
|
+
*
|
|
54
145
|
* @name getApplicationConfiguration
|
|
55
146
|
* @summary: Get delivery configuration
|
|
56
|
-
* @description:
|
|
147
|
+
* @description: This API returns all the Application config that has been applied to the given company and application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationConfiguration/).
|
|
57
148
|
*/
|
|
58
|
-
getApplicationConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
149
|
+
getApplicationConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigGetResult>;
|
|
59
150
|
/**
|
|
60
|
-
* @param {ServiceabilityPlatformApplicationValidator.
|
|
151
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetBulkExportParam} arg
|
|
61
152
|
* - Arg object
|
|
62
153
|
*
|
|
63
154
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
64
155
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
65
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
66
|
-
*
|
|
156
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetZoneBulkExport>} -
|
|
157
|
+
* Success response
|
|
158
|
+
* @name getBulkExport
|
|
159
|
+
* @summary: Get Bulk Export of Zones
|
|
160
|
+
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getBulkExport/).
|
|
161
|
+
*/
|
|
162
|
+
getBulkExport({ batchId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkExportParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneBulkExport>;
|
|
163
|
+
/**
|
|
164
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam} arg
|
|
165
|
+
* - Arg object
|
|
67
166
|
*
|
|
68
|
-
* @
|
|
69
|
-
* @
|
|
70
|
-
* @
|
|
167
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
168
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
169
|
+
* @returns {Promise<ServiceabilityPlatformModel.BulkGeoAreaGetResult>} -
|
|
170
|
+
* Success response
|
|
171
|
+
* @name getBulkGeoArea
|
|
172
|
+
* @summary: Get status of GeoAreas created in bulk
|
|
173
|
+
* @description: Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getBulkGeoArea/).
|
|
71
174
|
*/
|
|
72
|
-
|
|
175
|
+
getBulkGeoArea({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaGetResult>;
|
|
73
176
|
/**
|
|
74
177
|
* @param {ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam} arg
|
|
75
178
|
* - Arg object
|
|
@@ -83,7 +186,7 @@ declare class Serviceability {
|
|
|
83
186
|
* @summary: Get courier rule
|
|
84
187
|
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRule/).
|
|
85
188
|
*/
|
|
86
|
-
getCourierPartnerRule({
|
|
189
|
+
getCourierPartnerRule({ ruleUid, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
87
190
|
/**
|
|
88
191
|
* @param {ServiceabilityPlatformApplicationValidator.GetCourierPartnerRulesParam} arg
|
|
89
192
|
* - Arg object
|
|
@@ -108,10 +211,49 @@ declare class Serviceability {
|
|
|
108
211
|
* - Success response
|
|
109
212
|
*
|
|
110
213
|
* @name getCourierPartners
|
|
111
|
-
* @summary: Serviceable Courier Partners
|
|
214
|
+
* @summary: Serviceable Courier Partners
|
|
112
215
|
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartners/).
|
|
113
216
|
*/
|
|
114
217
|
getCourierPartners({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnersParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ShipmentCourierPartnerResult>;
|
|
218
|
+
/**
|
|
219
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreaParam} arg
|
|
220
|
+
* - Arg object
|
|
221
|
+
*
|
|
222
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
223
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
224
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaDetails>} - Success response
|
|
225
|
+
* @name getGeoArea
|
|
226
|
+
* @summary: Get details of the specific geoarea
|
|
227
|
+
* @description: This API Returns the data of the specific GeoArea which exists on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getGeoArea/).
|
|
228
|
+
*/
|
|
229
|
+
getGeoArea({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaDetails>;
|
|
230
|
+
/**
|
|
231
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreaExportJobStatusParam} arg
|
|
232
|
+
* - Arg object
|
|
233
|
+
*
|
|
234
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
235
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
236
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaBulkExportResult>}
|
|
237
|
+
* - Success response
|
|
238
|
+
*
|
|
239
|
+
* @name getGeoAreaExportJobStatus
|
|
240
|
+
* @summary: Get status of Geoarea export job
|
|
241
|
+
* @description: Get the status and details of the Geoarea bulk export process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getGeoAreaExportJobStatus/).
|
|
242
|
+
*/
|
|
243
|
+
getGeoAreaExportJobStatus({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetGeoAreaExportJobStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkExportResult>;
|
|
244
|
+
/**
|
|
245
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreasParam} arg
|
|
246
|
+
* - Arg object
|
|
247
|
+
*
|
|
248
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
249
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
250
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaGetResponseBody>} -
|
|
251
|
+
* Success response
|
|
252
|
+
* @name getGeoAreas
|
|
253
|
+
* @summary: Get all geoareas in the current application
|
|
254
|
+
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getGeoAreas/).
|
|
255
|
+
*/
|
|
256
|
+
getGeoAreas({ pageSize, isActive, pageNo, type, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetGeoAreasParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaGetResponseBody>;
|
|
115
257
|
/**
|
|
116
258
|
* @param {ServiceabilityPlatformApplicationValidator.GetStoreRuleParam} arg
|
|
117
259
|
* - Arg object
|
|
@@ -138,6 +280,27 @@ declare class Serviceability {
|
|
|
138
280
|
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getStoreRules/).
|
|
139
281
|
*/
|
|
140
282
|
getStoreRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoreRulesApiResult>;
|
|
283
|
+
/**
|
|
284
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetZoneParam} arg - Arg object
|
|
285
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
286
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
287
|
+
* @returns {Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>} -
|
|
288
|
+
* Success response
|
|
289
|
+
* @name getZone
|
|
290
|
+
* @summary: Get zone details
|
|
291
|
+
* @description: Retrieves a single delivery zone - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZone/).
|
|
292
|
+
*/
|
|
293
|
+
getZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
|
|
294
|
+
/**
|
|
295
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetZonesParam} arg - Arg object
|
|
296
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
297
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
298
|
+
* @returns {Promise<ServiceabilityPlatformModel.ListViewSchema>} - Success response
|
|
299
|
+
* @name getZones
|
|
300
|
+
* @summary: Get zones
|
|
301
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
|
|
302
|
+
*/
|
|
303
|
+
getZones({ stage, pageSize, pageNo, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewSchema>;
|
|
141
304
|
/**
|
|
142
305
|
* @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
|
|
143
306
|
* - Arg object
|
|
@@ -152,32 +315,45 @@ declare class Serviceability {
|
|
|
152
315
|
*/
|
|
153
316
|
insertApplicationConfig({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
154
317
|
/**
|
|
155
|
-
* @param {ServiceabilityPlatformApplicationValidator.
|
|
318
|
+
* @param {ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam} arg
|
|
156
319
|
* - Arg object
|
|
157
320
|
*
|
|
158
321
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
159
322
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
160
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
323
|
+
* @returns {Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>}
|
|
161
324
|
* - Success response
|
|
162
325
|
*
|
|
163
|
-
* @name
|
|
164
|
-
* @summary:
|
|
165
|
-
* @description:
|
|
326
|
+
* @name patchApplicationConfiguration
|
|
327
|
+
* @summary: To patch any config which can be applied to application
|
|
328
|
+
* @description: Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/patchApplicationConfiguration/).
|
|
166
329
|
*/
|
|
167
|
-
|
|
330
|
+
patchApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>;
|
|
168
331
|
/**
|
|
169
332
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam} arg
|
|
170
333
|
* - Arg object
|
|
171
334
|
*
|
|
172
335
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
173
336
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
174
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
337
|
+
* @returns {Promise<ServiceabilityPlatformModel.ApplicationConfigPut>} -
|
|
175
338
|
* Success response
|
|
176
339
|
* @name updateApplicationConfiguration
|
|
177
|
-
* @summary:
|
|
178
|
-
* @description:
|
|
340
|
+
* @summary: Apply configuration to an application
|
|
341
|
+
* @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateApplicationConfiguration/).
|
|
179
342
|
*/
|
|
180
|
-
updateApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
343
|
+
updateApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPut>;
|
|
344
|
+
/**
|
|
345
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdateBulkGeoAreaParam} arg
|
|
346
|
+
* - Arg object
|
|
347
|
+
*
|
|
348
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
349
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
350
|
+
* @returns {Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>} -
|
|
351
|
+
* Success response
|
|
352
|
+
* @name updateBulkGeoArea
|
|
353
|
+
* @summary: Update geoareas and their associated regions in bulk
|
|
354
|
+
* @description: Update geoarea details and their associated regions through a CSV file in bulk. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateBulkGeoArea/).
|
|
355
|
+
*/
|
|
356
|
+
updateBulkGeoArea({ geoareaId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>;
|
|
181
357
|
/**
|
|
182
358
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateCourierPartnerRulePriorityParam} arg
|
|
183
359
|
* - Arg object
|
|
@@ -204,7 +380,20 @@ declare class Serviceability {
|
|
|
204
380
|
* @summary: Update courier rule
|
|
205
381
|
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierRule/).
|
|
206
382
|
*/
|
|
207
|
-
updateCourierRule({
|
|
383
|
+
updateCourierRule({ ruleUid, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
384
|
+
/**
|
|
385
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdateGeoAreaParam} arg
|
|
386
|
+
* - Arg object
|
|
387
|
+
*
|
|
388
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
389
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
390
|
+
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaPutResponseBody>} -
|
|
391
|
+
* Success response
|
|
392
|
+
* @name updateGeoArea
|
|
393
|
+
* @summary: Update the details of existing GeoArea
|
|
394
|
+
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateGeoArea/).
|
|
395
|
+
*/
|
|
396
|
+
updateGeoArea({ geoareaId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaPutResponseBody>;
|
|
208
397
|
/**
|
|
209
398
|
* @param {ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam} arg
|
|
210
399
|
* - Arg object
|
|
@@ -258,6 +447,19 @@ declare class Serviceability {
|
|
|
258
447
|
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
|
|
259
448
|
*/
|
|
260
449
|
updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMOPResult>;
|
|
450
|
+
/**
|
|
451
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdateStoreRulePriorityParam} arg
|
|
452
|
+
* - Arg object
|
|
453
|
+
*
|
|
454
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
455
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
456
|
+
* @returns {Promise<ServiceabilityPlatformModel.RulePriorityResult>} -
|
|
457
|
+
* Success response
|
|
458
|
+
* @name updateStoreRulePriority
|
|
459
|
+
* @summary: Update Store Rule priority
|
|
460
|
+
* @description: Update Store Rule priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateStoreRulePriority/).
|
|
461
|
+
*/
|
|
462
|
+
updateStoreRulePriority({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulePriorityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.RulePriorityResult>;
|
|
261
463
|
/**
|
|
262
464
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateStoreRulesParam} arg
|
|
263
465
|
* - Arg object
|
|
@@ -285,6 +487,20 @@ declare class Serviceability {
|
|
|
285
487
|
* @description: Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateStoreRulesConfig/).
|
|
286
488
|
*/
|
|
287
489
|
updateStoreRulesConfig({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulesConfigParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
490
|
+
/**
|
|
491
|
+
* @param {ServiceabilityPlatformApplicationValidator.UpdateZoneParam} arg
|
|
492
|
+
* - Arg object
|
|
493
|
+
*
|
|
494
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
495
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
496
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneUpdateSuccessResult>}
|
|
497
|
+
* - Success response
|
|
498
|
+
*
|
|
499
|
+
* @name updateZone
|
|
500
|
+
* @summary: Update details of a Zone to enable or disable
|
|
501
|
+
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateZone/).
|
|
502
|
+
*/
|
|
503
|
+
updateZone({ zoneId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneUpdateSuccessResult>;
|
|
288
504
|
}
|
|
289
505
|
import ServiceabilityPlatformApplicationValidator = require("./ServiceabilityPlatformApplicationValidator");
|
|
290
506
|
import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|