@gofynd/fdk-client-javascript 1.6.4 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +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 +4 -4
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- 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
|
@@ -33,26 +33,28 @@ declare class Serviceability {
|
|
|
33
33
|
*
|
|
34
34
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
35
35
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
36
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountDetailsBody>}
|
|
37
|
+
* - Success response
|
|
38
|
+
*
|
|
37
39
|
* @name createCourierPartnerAccount
|
|
38
40
|
* @summary: Create courier account
|
|
39
|
-
* @description:
|
|
41
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerAccount/).
|
|
40
42
|
*/
|
|
41
|
-
createCourierPartnerAccount({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
43
|
+
createCourierPartnerAccount({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountDetailsBody>;
|
|
42
44
|
/**
|
|
43
45
|
* @param {ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam} arg
|
|
44
46
|
* - Arg object
|
|
45
47
|
*
|
|
46
48
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
49
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
50
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>}
|
|
49
51
|
* - Success response
|
|
50
52
|
*
|
|
51
53
|
* @name createCourierPartnerScheme
|
|
52
54
|
* @summary: Create Scheme for courier partner extension
|
|
53
55
|
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerScheme/).
|
|
54
56
|
*/
|
|
55
|
-
createCourierPartnerScheme({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
57
|
+
createCourierPartnerScheme({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>;
|
|
56
58
|
/**
|
|
57
59
|
* @param {ServiceabilityPlatformValidator.CreatePackageMaterialParam} arg
|
|
58
60
|
* - Arg object
|
|
@@ -65,7 +67,7 @@ declare class Serviceability {
|
|
|
65
67
|
* @summary: Create packaging material
|
|
66
68
|
* @description: Creates a packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterial/).
|
|
67
69
|
*/
|
|
68
|
-
createPackageMaterial({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResult>;
|
|
70
|
+
createPackageMaterial({ body, pageNo, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResult>;
|
|
69
71
|
/**
|
|
70
72
|
* @param {ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam} arg
|
|
71
73
|
* - Arg object
|
|
@@ -79,27 +81,6 @@ declare class Serviceability {
|
|
|
79
81
|
* @description: Creates a packaging rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
80
82
|
*/
|
|
81
83
|
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
84
|
/**
|
|
104
85
|
* @param {ServiceabilityPlatformValidator.GetBulkServiceabilityParam} arg
|
|
105
86
|
* - Arg object
|
|
@@ -140,10 +121,10 @@ declare class Serviceability {
|
|
|
140
121
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
141
122
|
* @returns {Promise<ServiceabilityPlatformModel.GetCountries>} - Success response
|
|
142
123
|
* @name getCountries
|
|
143
|
-
* @summary: Get countries
|
|
124
|
+
* @summary: Get all countries and associated data
|
|
144
125
|
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCountries/).
|
|
145
126
|
*/
|
|
146
|
-
getCountries({
|
|
127
|
+
getCountries({ onboard, pageNo, pageSize, q, hierarchy, requestHeaders }?: ServiceabilityPlatformValidator.GetCountriesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetCountries>;
|
|
147
128
|
/**
|
|
148
129
|
* @param {ServiceabilityPlatformValidator.GetCourierPartnerAccountParam} arg
|
|
149
130
|
* - Arg object
|
|
@@ -170,35 +151,49 @@ declare class Serviceability {
|
|
|
170
151
|
* @summary: List courier accounts
|
|
171
152
|
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
172
153
|
*/
|
|
173
|
-
getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResult>;
|
|
154
|
+
getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, accountIds, selfShip, ownAccount, q, requestHeaders, }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResult>;
|
|
174
155
|
/**
|
|
175
156
|
* @param {ServiceabilityPlatformValidator.GetCourierPartnerSchemeParam} arg
|
|
176
157
|
* - Arg object
|
|
177
158
|
*
|
|
178
159
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
160
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
161
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>}
|
|
181
162
|
* - Success response
|
|
182
163
|
*
|
|
183
164
|
* @name getCourierPartnerScheme
|
|
184
165
|
* @summary: Get Scheme for courier partner extension by Id
|
|
185
166
|
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerScheme/).
|
|
186
167
|
*/
|
|
187
|
-
getCourierPartnerScheme({ schemeId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
168
|
+
getCourierPartnerScheme({ schemeId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>;
|
|
188
169
|
/**
|
|
189
170
|
* @param {ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam} arg
|
|
190
171
|
* - Arg object
|
|
191
172
|
*
|
|
192
173
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
193
174
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
194
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
175
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerSchemeList>}
|
|
195
176
|
* - Success response
|
|
196
177
|
*
|
|
197
178
|
* @name getCourierPartnerSchemes
|
|
198
179
|
* @summary: Get created Schemes for courier partner
|
|
199
180
|
* @description: Get created Schemes for courier partner - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerSchemes/).
|
|
200
181
|
*/
|
|
201
|
-
getCourierPartnerSchemes({ schemeType, paymentMode, capabilities, schemeIds, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
182
|
+
getCourierPartnerSchemes({ schemeType, paymentMode, capabilities, schemeIds, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeList>;
|
|
183
|
+
/**
|
|
184
|
+
* @param {ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam} arg
|
|
185
|
+
* - Arg object
|
|
186
|
+
*
|
|
187
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
188
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
189
|
+
* @returns {Promise<ServiceabilityPlatformModel.InstallCourierPartnerResponseSchema>}
|
|
190
|
+
* - Success response
|
|
191
|
+
*
|
|
192
|
+
* @name getInstalledCourierPartnerExtensions
|
|
193
|
+
* @summary: Fetching of Package Material Rules from database.
|
|
194
|
+
* @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/).
|
|
195
|
+
*/
|
|
196
|
+
getInstalledCourierPartnerExtensions({ pageNo, pageSize, isInstalled, requestHeaders }?: ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.InstallCourierPartnerResponseSchema>;
|
|
202
197
|
/**
|
|
203
198
|
* @param {ServiceabilityPlatformValidator.GetOptimalLocationsParam} arg - Arg object
|
|
204
199
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -216,13 +211,13 @@ declare class Serviceability {
|
|
|
216
211
|
*
|
|
217
212
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
218
213
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
219
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
214
|
+
* @returns {Promise<ServiceabilityPlatformModel.PackagesListResult>} -
|
|
220
215
|
* Success response
|
|
221
216
|
* @name getPackageMaterialList
|
|
222
217
|
* @summary: Get packaging materials
|
|
223
218
|
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialList/).
|
|
224
219
|
*/
|
|
225
|
-
getPackageMaterialList({ pageNo, pageSize, q, size, packageType, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
220
|
+
getPackageMaterialList({ pageNo, pageSize, q, size, packageType, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackagesListResult>;
|
|
226
221
|
/**
|
|
227
222
|
* @param {ServiceabilityPlatformValidator.GetPackageMaterialRuleParam} arg
|
|
228
223
|
* - Arg object
|
|
@@ -236,31 +231,16 @@ declare class Serviceability {
|
|
|
236
231
|
* @description: Retrieve packaging rule details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRule/).
|
|
237
232
|
*/
|
|
238
233
|
getPackageMaterialRule({ ruleId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResult>;
|
|
239
|
-
/**
|
|
240
|
-
* @param {ServiceabilityPlatformValidator.GetPackageMaterialRulesParam} arg
|
|
241
|
-
* - Arg object
|
|
242
|
-
*
|
|
243
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
244
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
245
|
-
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialRuleList>}
|
|
246
|
-
* - Success response
|
|
247
|
-
*
|
|
248
|
-
* @name getPackageMaterialRules
|
|
249
|
-
* @summary: Get packaging rules
|
|
250
|
-
* @description: Retrieve packaging rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRules/).
|
|
251
|
-
*/
|
|
252
|
-
getPackageMaterialRules({ pageNo, pageSize, isActive, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialRuleList>;
|
|
253
234
|
/**
|
|
254
235
|
* @param {ServiceabilityPlatformValidator.GetPackageMaterialsParam} arg - Arg object
|
|
255
236
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
256
237
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
257
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
258
|
-
* Success response
|
|
238
|
+
* @returns {Promise<ServiceabilityPlatformModel.PackageItem>} - Success response
|
|
259
239
|
* @name getPackageMaterials
|
|
260
240
|
* @summary: Get packaging material
|
|
261
241
|
* @description: Retrieve a single packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
|
|
262
242
|
*/
|
|
263
|
-
getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
243
|
+
getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageItem>;
|
|
264
244
|
/**
|
|
265
245
|
* @param {ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam} arg
|
|
266
246
|
* - Arg object
|
|
@@ -276,37 +256,15 @@ declare class Serviceability {
|
|
|
276
256
|
*/
|
|
277
257
|
getSampleFileServiceabilityStatus({ pageNo, pageSize, batchId, requestHeaders }?: ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResult>;
|
|
278
258
|
/**
|
|
279
|
-
* @param {ServiceabilityPlatformValidator.
|
|
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
|
|
259
|
+
* @param {ServiceabilityPlatformValidator.GetSelfShipDetailsParam} arg - Arg object
|
|
302
260
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
261
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
304
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
305
|
-
* @name
|
|
306
|
-
* @summary: Get
|
|
307
|
-
* @description:
|
|
262
|
+
* @returns {Promise<ServiceabilityPlatformModel.SelfshipSchema>} - Success response
|
|
263
|
+
* @name getSelfShipDetails
|
|
264
|
+
* @summary: Get self-ship details
|
|
265
|
+
* @description: Get the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getSelfShipDetails/).
|
|
308
266
|
*/
|
|
309
|
-
|
|
267
|
+
getSelfShipDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.SelfshipSchema>;
|
|
310
268
|
/**
|
|
311
269
|
* @param {ServiceabilityPlatformValidator.SampleFileServiceabilityParam} arg
|
|
312
270
|
* - Arg object
|
|
@@ -339,27 +297,28 @@ declare class Serviceability {
|
|
|
339
297
|
*
|
|
340
298
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
341
299
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
342
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
343
|
-
* Success response
|
|
300
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountDetailsBody>}
|
|
301
|
+
* - Success response
|
|
302
|
+
*
|
|
344
303
|
* @name updateCourierPartnerAccount
|
|
345
304
|
* @summary: Update courier account
|
|
346
305
|
* @description: Updates an existing courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
347
306
|
*/
|
|
348
|
-
updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
307
|
+
updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountDetailsBody>;
|
|
349
308
|
/**
|
|
350
309
|
* @param {ServiceabilityPlatformValidator.UpdateCourierPartnerSchemeParam} arg
|
|
351
310
|
* - Arg object
|
|
352
311
|
*
|
|
353
312
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
354
313
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
355
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
314
|
+
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>}
|
|
356
315
|
* - Success response
|
|
357
316
|
*
|
|
358
317
|
* @name updateCourierPartnerScheme
|
|
359
318
|
* @summary: Update Scheme for courier partner extension
|
|
360
319
|
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerScheme/).
|
|
361
320
|
*/
|
|
362
|
-
updateCourierPartnerScheme({ schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.
|
|
321
|
+
updateCourierPartnerScheme({ schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>;
|
|
363
322
|
/**
|
|
364
323
|
* @param {ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam} arg
|
|
365
324
|
* - Arg object
|
|
@@ -387,27 +346,17 @@ declare class Serviceability {
|
|
|
387
346
|
*/
|
|
388
347
|
updatePackageMaterials({ packageMaterialId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResult>;
|
|
389
348
|
/**
|
|
390
|
-
* @param {ServiceabilityPlatformValidator.
|
|
391
|
-
*
|
|
392
|
-
*
|
|
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>;
|
|
400
|
-
/**
|
|
401
|
-
* @param {ServiceabilityPlatformValidator.UpdateZoneByIdParam} arg - Arg object
|
|
349
|
+
* @param {ServiceabilityPlatformValidator.UpdateSelfShipDetailsParam} arg
|
|
350
|
+
* - Arg object
|
|
351
|
+
*
|
|
402
352
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
403
353
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
404
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
405
|
-
*
|
|
406
|
-
* @
|
|
407
|
-
* @
|
|
408
|
-
* @description: Update an existing delivery zone . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateZoneById/).
|
|
354
|
+
* @returns {Promise<ServiceabilityPlatformModel.SelfshipSchema>} - Success response
|
|
355
|
+
* @name updateSelfShipDetails
|
|
356
|
+
* @summary: Update self-ship details
|
|
357
|
+
* @description: Updates the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateSelfShipDetails/).
|
|
409
358
|
*/
|
|
410
|
-
|
|
359
|
+
updateSelfShipDetails({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateSelfShipDetailsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.SelfshipSchema>;
|
|
411
360
|
}
|
|
412
361
|
import ServiceabilityPlatformValidator = require("./ServiceabilityPlatformValidator");
|
|
413
362
|
import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|