@gofynd/fdk-client-javascript 1.4.3 → 1.4.5
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 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -10,8 +10,8 @@ declare class Serviceability {
|
|
|
10
10
|
* - Success response
|
|
11
11
|
*
|
|
12
12
|
* @name bulkServiceability
|
|
13
|
-
* @summary:
|
|
14
|
-
* @description:
|
|
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
15
|
*/
|
|
16
16
|
bulkServiceability({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResponseItemData>;
|
|
17
17
|
/**
|
|
@@ -22,8 +22,9 @@ declare class Serviceability {
|
|
|
22
22
|
* - Success response
|
|
23
23
|
*
|
|
24
24
|
* @name bulkTat
|
|
25
|
-
* @summary:
|
|
26
|
-
* @description:
|
|
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/).
|
|
27
28
|
*/
|
|
28
29
|
bulkTat({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkTatParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResponseItemData>;
|
|
29
30
|
/**
|
|
@@ -34,8 +35,8 @@ declare class Serviceability {
|
|
|
34
35
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
35
36
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccount>} - Success response
|
|
36
37
|
* @name createCourierPartnerAccount
|
|
37
|
-
* @summary:
|
|
38
|
-
* @description:
|
|
38
|
+
* @summary: Create courier account
|
|
39
|
+
* @description: Creates a courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerAccount/).
|
|
39
40
|
*/
|
|
40
41
|
createCourierPartnerAccount({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccount>;
|
|
41
42
|
/**
|
|
@@ -48,8 +49,8 @@ declare class Serviceability {
|
|
|
48
49
|
* - Success response
|
|
49
50
|
*
|
|
50
51
|
* @name createPackageMaterial
|
|
51
|
-
* @summary:
|
|
52
|
-
* @description:
|
|
52
|
+
* @summary: Create packaging material
|
|
53
|
+
* @description: Creates a packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterial/).
|
|
53
54
|
*/
|
|
54
55
|
createPackageMaterial({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
55
56
|
/**
|
|
@@ -61,8 +62,8 @@ declare class Serviceability {
|
|
|
61
62
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
62
63
|
* Success response
|
|
63
64
|
* @name createPackageMaterialRule
|
|
64
|
-
* @summary:
|
|
65
|
-
* @description:
|
|
65
|
+
* @summary: Create packaging rule
|
|
66
|
+
* @description: Creates a packaging rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
66
67
|
*/
|
|
67
68
|
createPackageMaterialRule({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
|
|
68
69
|
/**
|
|
@@ -72,7 +73,7 @@ declare class Serviceability {
|
|
|
72
73
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
|
|
73
74
|
* @name createZone
|
|
74
75
|
* @summary: Create zone
|
|
75
|
-
* @description:
|
|
76
|
+
* @description: Creates a delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
|
|
76
77
|
*/
|
|
77
78
|
createZone({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneResponse>;
|
|
78
79
|
/**
|
|
@@ -83,7 +84,7 @@ declare class Serviceability {
|
|
|
83
84
|
* Success response
|
|
84
85
|
* @name getAllStores
|
|
85
86
|
* @summary: Get all stores
|
|
86
|
-
* @description:
|
|
87
|
+
* @description: Retrieves a list of locations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
|
|
87
88
|
*/
|
|
88
89
|
getAllStores({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoresViewResponse>;
|
|
89
90
|
/**
|
|
@@ -95,8 +96,8 @@ declare class Serviceability {
|
|
|
95
96
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResponse>} -
|
|
96
97
|
* Success response
|
|
97
98
|
* @name getBulkServiceability
|
|
98
|
-
* @summary:
|
|
99
|
-
* @description:
|
|
99
|
+
* @summary: Bulk update history
|
|
100
|
+
* @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/).
|
|
100
101
|
*/
|
|
101
102
|
getBulkServiceability({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResponse>;
|
|
102
103
|
/**
|
|
@@ -106,8 +107,8 @@ declare class Serviceability {
|
|
|
106
107
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResponse>} -
|
|
107
108
|
* Success response
|
|
108
109
|
* @name getBulkTat
|
|
109
|
-
* @summary:
|
|
110
|
-
* @description:
|
|
110
|
+
* @summary: Locality TAT change history
|
|
111
|
+
* @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/).
|
|
111
112
|
*/
|
|
112
113
|
getBulkTat({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkTatParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResponse>;
|
|
113
114
|
/**
|
|
@@ -118,8 +119,8 @@ declare class Serviceability {
|
|
|
118
119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
119
120
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
120
121
|
* @name getCompanyConfiguration
|
|
121
|
-
* @summary: Get
|
|
122
|
-
* @description:
|
|
122
|
+
* @summary: Get delivery configuration
|
|
123
|
+
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
123
124
|
*/
|
|
124
125
|
getCompanyConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
125
126
|
/**
|
|
@@ -131,8 +132,8 @@ declare class Serviceability {
|
|
|
131
132
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
132
133
|
* Success response
|
|
133
134
|
* @name getCourierPartnerAccount
|
|
134
|
-
* @summary:
|
|
135
|
-
* @description:
|
|
135
|
+
* @summary: Get courier account
|
|
136
|
+
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccount/).
|
|
136
137
|
*/
|
|
137
138
|
getCourierPartnerAccount({ accountId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResponse>;
|
|
138
139
|
/**
|
|
@@ -145,8 +146,8 @@ declare class Serviceability {
|
|
|
145
146
|
* - Success response
|
|
146
147
|
*
|
|
147
148
|
* @name getCourierPartnerAccounts
|
|
148
|
-
* @summary:
|
|
149
|
-
* @description:
|
|
149
|
+
* @summary: List courier accounts
|
|
150
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
150
151
|
*/
|
|
151
152
|
getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResponse>;
|
|
152
153
|
/**
|
|
@@ -157,8 +158,8 @@ declare class Serviceability {
|
|
|
157
158
|
* - Success response
|
|
158
159
|
*
|
|
159
160
|
* @name getOptimalLocations
|
|
160
|
-
* @summary:
|
|
161
|
-
* @description:
|
|
161
|
+
* @summary: Get selling locations
|
|
162
|
+
* @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/).
|
|
162
163
|
*/
|
|
163
164
|
getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>;
|
|
164
165
|
/**
|
|
@@ -170,8 +171,8 @@ declare class Serviceability {
|
|
|
170
171
|
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialList>} -
|
|
171
172
|
* Success response
|
|
172
173
|
* @name getPackageMaterialList
|
|
173
|
-
* @summary:
|
|
174
|
-
* @description:
|
|
174
|
+
* @summary: Get packaging materials
|
|
175
|
+
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialList/).
|
|
175
176
|
*/
|
|
176
177
|
getPackageMaterialList({ pageNo, pageSize, q, size, packageType, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialList>;
|
|
177
178
|
/**
|
|
@@ -183,8 +184,8 @@ declare class Serviceability {
|
|
|
183
184
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
184
185
|
* Success response
|
|
185
186
|
* @name getPackageMaterialRule
|
|
186
|
-
* @summary:
|
|
187
|
-
* @description:
|
|
187
|
+
* @summary: Get packaging material rule
|
|
188
|
+
* @description: Retrieve packaging rule details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRule/).
|
|
188
189
|
*/
|
|
189
190
|
getPackageMaterialRule({ ruleId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
|
|
190
191
|
/**
|
|
@@ -197,8 +198,8 @@ declare class Serviceability {
|
|
|
197
198
|
* - Success response
|
|
198
199
|
*
|
|
199
200
|
* @name getPackageMaterialRules
|
|
200
|
-
* @summary:
|
|
201
|
-
* @description:
|
|
201
|
+
* @summary: Get packaging rules
|
|
202
|
+
* @description: Retrieve packaging rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRules/).
|
|
202
203
|
*/
|
|
203
204
|
getPackageMaterialRules({ pageNo, pageSize, isActive, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialRuleList>;
|
|
204
205
|
/**
|
|
@@ -209,8 +210,8 @@ declare class Serviceability {
|
|
|
209
210
|
* - Success response
|
|
210
211
|
*
|
|
211
212
|
* @name getPackageMaterials
|
|
212
|
-
* @summary:
|
|
213
|
-
* @description:
|
|
213
|
+
* @summary: Get packaging material
|
|
214
|
+
* @description: Retrieve a single packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
|
|
214
215
|
*/
|
|
215
216
|
getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
216
217
|
/**
|
|
@@ -220,8 +221,8 @@ declare class Serviceability {
|
|
|
220
221
|
* @returns {Promise<ServiceabilityPlatformModel.ServiceabilityModel>} -
|
|
221
222
|
* Success response
|
|
222
223
|
* @name getServiceability
|
|
223
|
-
* @summary: Get
|
|
224
|
-
* @description:
|
|
224
|
+
* @summary: Get serviceability of a locality
|
|
225
|
+
* @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/).
|
|
225
226
|
*/
|
|
226
227
|
getServiceability({ extensionId, schemeId, regionId, requestHeaders }?: ServiceabilityPlatformValidator.GetServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ServiceabilityModel>;
|
|
227
228
|
/**
|
|
@@ -231,8 +232,8 @@ declare class Serviceability {
|
|
|
231
232
|
* @returns {Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>} -
|
|
232
233
|
* Success response
|
|
233
234
|
* @name getZoneById
|
|
234
|
-
* @summary: Get details
|
|
235
|
-
* @description:
|
|
235
|
+
* @summary: Get zone details
|
|
236
|
+
* @description: Retrieves a single delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZoneById/).
|
|
236
237
|
*/
|
|
237
238
|
getZoneById({ zoneId, requestHeaders }?: ServiceabilityPlatformValidator.GetZoneByIdParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
|
|
238
239
|
/**
|
|
@@ -241,8 +242,8 @@ declare class Serviceability {
|
|
|
241
242
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
242
243
|
* @returns {Promise<ServiceabilityPlatformModel.ListViewResponse>} - Success response
|
|
243
244
|
* @name getZones
|
|
244
|
-
* @summary:
|
|
245
|
-
* @description:
|
|
245
|
+
* @summary: Get zones
|
|
246
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
|
|
246
247
|
*/
|
|
247
248
|
getZones({ pageNo, pageSize, isActive, channelId, q, country, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
|
|
248
249
|
/**
|
|
@@ -253,8 +254,8 @@ declare class Serviceability {
|
|
|
253
254
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
254
255
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
255
256
|
* @name updateCompanyConfiguration
|
|
256
|
-
* @summary:
|
|
257
|
-
* @description:
|
|
257
|
+
* @summary: Update delivery configuration
|
|
258
|
+
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCompanyConfiguration/).
|
|
258
259
|
*/
|
|
259
260
|
updateCompanyConfiguration({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
260
261
|
/**
|
|
@@ -266,8 +267,8 @@ declare class Serviceability {
|
|
|
266
267
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
267
268
|
* Success response
|
|
268
269
|
* @name updateCourierPartnerAccount
|
|
269
|
-
* @summary: Update
|
|
270
|
-
* @description: Updates
|
|
270
|
+
* @summary: Update courier account
|
|
271
|
+
* @description: Updates an existing courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
271
272
|
*/
|
|
272
273
|
updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResponse>;
|
|
273
274
|
/**
|
|
@@ -279,8 +280,8 @@ declare class Serviceability {
|
|
|
279
280
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
280
281
|
* Success response
|
|
281
282
|
* @name updatePackageMaterialRule
|
|
282
|
-
* @summary:
|
|
283
|
-
* @description:
|
|
283
|
+
* @summary: Update packaging rule
|
|
284
|
+
* @description: Update an existing packaging rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterialRule/).
|
|
284
285
|
*/
|
|
285
286
|
updatePackageMaterialRule({ ruleId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
|
|
286
287
|
/**
|
|
@@ -293,8 +294,8 @@ declare class Serviceability {
|
|
|
293
294
|
* - Success response
|
|
294
295
|
*
|
|
295
296
|
* @name updatePackageMaterials
|
|
296
|
-
* @summary: Update
|
|
297
|
-
* @description:
|
|
297
|
+
* @summary: Update packaging material
|
|
298
|
+
* @description: Update an existing packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterials/).
|
|
298
299
|
*/
|
|
299
300
|
updatePackageMaterials({ packageMaterialId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
300
301
|
/**
|
|
@@ -304,8 +305,8 @@ declare class Serviceability {
|
|
|
304
305
|
* @returns {Promise<ServiceabilityPlatformModel.ServiceabilityModel>} -
|
|
305
306
|
* Success response
|
|
306
307
|
* @name updateServiceability
|
|
307
|
-
* @summary: Serviceability
|
|
308
|
-
* @description:
|
|
308
|
+
* @summary: Update Serviceability of a locality
|
|
309
|
+
* @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/).
|
|
309
310
|
*/
|
|
310
311
|
updateServiceability({ extensionId, schemeId, regionId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ServiceabilityModel>;
|
|
311
312
|
/**
|
|
@@ -315,8 +316,8 @@ declare class Serviceability {
|
|
|
315
316
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneSuccessResponse>} -
|
|
316
317
|
* Success response
|
|
317
318
|
* @name updateZoneById
|
|
318
|
-
* @summary: Update
|
|
319
|
-
* @description:
|
|
319
|
+
* @summary: Update a zone
|
|
320
|
+
* @description: Update an existing delivery zone . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateZoneById/).
|
|
320
321
|
*/
|
|
321
322
|
updateZoneById({ zoneId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateZoneByIdParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneSuccessResponse>;
|
|
322
323
|
}
|
|
@@ -22,8 +22,8 @@ class Serviceability {
|
|
|
22
22
|
* - Success response
|
|
23
23
|
*
|
|
24
24
|
* @name bulkServiceability
|
|
25
|
-
* @summary:
|
|
26
|
-
* @description:
|
|
25
|
+
* @summary: Bulk update serviceability of localities
|
|
26
|
+
* @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/).
|
|
27
27
|
*/
|
|
28
28
|
async bulkServiceability(
|
|
29
29
|
{ extensionId, schemeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -109,8 +109,9 @@ class Serviceability {
|
|
|
109
109
|
* - Success response
|
|
110
110
|
*
|
|
111
111
|
* @name bulkTat
|
|
112
|
-
* @summary:
|
|
113
|
-
* @description:
|
|
112
|
+
* @summary: Locality TAT import or export
|
|
113
|
+
* @description: Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file.
|
|
114
|
+
* Export locality wise CSV files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/bulkTat/).
|
|
114
115
|
*/
|
|
115
116
|
async bulkTat(
|
|
116
117
|
{ extensionId, schemeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -194,8 +195,8 @@ class Serviceability {
|
|
|
194
195
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
195
196
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccount>} - Success response
|
|
196
197
|
* @name createCourierPartnerAccount
|
|
197
|
-
* @summary:
|
|
198
|
-
* @description:
|
|
198
|
+
* @summary: Create courier account
|
|
199
|
+
* @description: Creates a courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerAccount/).
|
|
199
200
|
*/
|
|
200
201
|
async createCourierPartnerAccount(
|
|
201
202
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -279,8 +280,8 @@ class Serviceability {
|
|
|
279
280
|
* - Success response
|
|
280
281
|
*
|
|
281
282
|
* @name createPackageMaterial
|
|
282
|
-
* @summary:
|
|
283
|
-
* @description:
|
|
283
|
+
* @summary: Create packaging material
|
|
284
|
+
* @description: Creates a packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterial/).
|
|
284
285
|
*/
|
|
285
286
|
async createPackageMaterial(
|
|
286
287
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -363,8 +364,8 @@ class Serviceability {
|
|
|
363
364
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
364
365
|
* Success response
|
|
365
366
|
* @name createPackageMaterialRule
|
|
366
|
-
* @summary:
|
|
367
|
-
* @description:
|
|
367
|
+
* @summary: Create packaging rule
|
|
368
|
+
* @description: Creates a packaging rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
368
369
|
*/
|
|
369
370
|
async createPackageMaterialRule(
|
|
370
371
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -445,7 +446,7 @@ class Serviceability {
|
|
|
445
446
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
|
|
446
447
|
* @name createZone
|
|
447
448
|
* @summary: Create zone
|
|
448
|
-
* @description:
|
|
449
|
+
* @description: Creates a delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
|
|
449
450
|
*/
|
|
450
451
|
async createZone(
|
|
451
452
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -525,7 +526,7 @@ class Serviceability {
|
|
|
525
526
|
* Success response
|
|
526
527
|
* @name getAllStores
|
|
527
528
|
* @summary: Get all stores
|
|
528
|
-
* @description:
|
|
529
|
+
* @description: Retrieves a list of locations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
|
|
529
530
|
*/
|
|
530
531
|
async getAllStores(
|
|
531
532
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -602,8 +603,8 @@ class Serviceability {
|
|
|
602
603
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResponse>} -
|
|
603
604
|
* Success response
|
|
604
605
|
* @name getBulkServiceability
|
|
605
|
-
* @summary:
|
|
606
|
-
* @description:
|
|
606
|
+
* @summary: Bulk update history
|
|
607
|
+
* @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/).
|
|
607
608
|
*/
|
|
608
609
|
async getBulkServiceability(
|
|
609
610
|
{
|
|
@@ -726,8 +727,8 @@ class Serviceability {
|
|
|
726
727
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResponse>} -
|
|
727
728
|
* Success response
|
|
728
729
|
* @name getBulkTat
|
|
729
|
-
* @summary:
|
|
730
|
-
* @description:
|
|
730
|
+
* @summary: Locality TAT change history
|
|
731
|
+
* @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/).
|
|
731
732
|
*/
|
|
732
733
|
async getBulkTat(
|
|
733
734
|
{
|
|
@@ -849,8 +850,8 @@ class Serviceability {
|
|
|
849
850
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
850
851
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
851
852
|
* @name getCompanyConfiguration
|
|
852
|
-
* @summary: Get
|
|
853
|
-
* @description:
|
|
853
|
+
* @summary: Get delivery configuration
|
|
854
|
+
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
854
855
|
*/
|
|
855
856
|
async getCompanyConfiguration(
|
|
856
857
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -929,8 +930,8 @@ class Serviceability {
|
|
|
929
930
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
930
931
|
* Success response
|
|
931
932
|
* @name getCourierPartnerAccount
|
|
932
|
-
* @summary:
|
|
933
|
-
* @description:
|
|
933
|
+
* @summary: Get courier account
|
|
934
|
+
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccount/).
|
|
934
935
|
*/
|
|
935
936
|
async getCourierPartnerAccount(
|
|
936
937
|
{ accountId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1014,8 +1015,8 @@ class Serviceability {
|
|
|
1014
1015
|
* - Success response
|
|
1015
1016
|
*
|
|
1016
1017
|
* @name getCourierPartnerAccounts
|
|
1017
|
-
* @summary:
|
|
1018
|
-
* @description:
|
|
1018
|
+
* @summary: List courier accounts
|
|
1019
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
1019
1020
|
*/
|
|
1020
1021
|
async getCourierPartnerAccounts(
|
|
1021
1022
|
{ pageNo, pageSize, stage, paymentMode, transportType, requestHeaders } = {
|
|
@@ -1112,8 +1113,8 @@ class Serviceability {
|
|
|
1112
1113
|
* - Success response
|
|
1113
1114
|
*
|
|
1114
1115
|
* @name getOptimalLocations
|
|
1115
|
-
* @summary:
|
|
1116
|
-
* @description:
|
|
1116
|
+
* @summary: Get selling locations
|
|
1117
|
+
* @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/).
|
|
1117
1118
|
*/
|
|
1118
1119
|
async getOptimalLocations(
|
|
1119
1120
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1196,8 +1197,8 @@ class Serviceability {
|
|
|
1196
1197
|
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialList>} -
|
|
1197
1198
|
* Success response
|
|
1198
1199
|
* @name getPackageMaterialList
|
|
1199
|
-
* @summary:
|
|
1200
|
-
* @description:
|
|
1200
|
+
* @summary: Get packaging materials
|
|
1201
|
+
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialList/).
|
|
1201
1202
|
*/
|
|
1202
1203
|
async getPackageMaterialList(
|
|
1203
1204
|
{ pageNo, pageSize, q, size, packageType, requestHeaders } = {
|
|
@@ -1295,8 +1296,8 @@ class Serviceability {
|
|
|
1295
1296
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
1296
1297
|
* Success response
|
|
1297
1298
|
* @name getPackageMaterialRule
|
|
1298
|
-
* @summary:
|
|
1299
|
-
* @description:
|
|
1299
|
+
* @summary: Get packaging material rule
|
|
1300
|
+
* @description: Retrieve packaging rule details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRule/).
|
|
1300
1301
|
*/
|
|
1301
1302
|
async getPackageMaterialRule(
|
|
1302
1303
|
{ ruleId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1380,8 +1381,8 @@ class Serviceability {
|
|
|
1380
1381
|
* - Success response
|
|
1381
1382
|
*
|
|
1382
1383
|
* @name getPackageMaterialRules
|
|
1383
|
-
* @summary:
|
|
1384
|
-
* @description:
|
|
1384
|
+
* @summary: Get packaging rules
|
|
1385
|
+
* @description: Retrieve packaging rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRules/).
|
|
1385
1386
|
*/
|
|
1386
1387
|
async getPackageMaterialRules(
|
|
1387
1388
|
{ pageNo, pageSize, isActive, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1470,8 +1471,8 @@ class Serviceability {
|
|
|
1470
1471
|
* - Success response
|
|
1471
1472
|
*
|
|
1472
1473
|
* @name getPackageMaterials
|
|
1473
|
-
* @summary:
|
|
1474
|
-
* @description:
|
|
1474
|
+
* @summary: Get packaging material
|
|
1475
|
+
* @description: Retrieve a single packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
|
|
1475
1476
|
*/
|
|
1476
1477
|
async getPackageMaterials(
|
|
1477
1478
|
{ packageMaterialId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1552,8 +1553,8 @@ class Serviceability {
|
|
|
1552
1553
|
* @returns {Promise<ServiceabilityPlatformModel.ServiceabilityModel>} -
|
|
1553
1554
|
* Success response
|
|
1554
1555
|
* @name getServiceability
|
|
1555
|
-
* @summary: Get
|
|
1556
|
-
* @description:
|
|
1556
|
+
* @summary: Get serviceability of a locality
|
|
1557
|
+
* @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/).
|
|
1557
1558
|
*/
|
|
1558
1559
|
async getServiceability(
|
|
1559
1560
|
{ extensionId, schemeId, regionId, requestHeaders } = {
|
|
@@ -1640,8 +1641,8 @@ class Serviceability {
|
|
|
1640
1641
|
* @returns {Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>} -
|
|
1641
1642
|
* Success response
|
|
1642
1643
|
* @name getZoneById
|
|
1643
|
-
* @summary: Get details
|
|
1644
|
-
* @description:
|
|
1644
|
+
* @summary: Get zone details
|
|
1645
|
+
* @description: Retrieves a single delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZoneById/).
|
|
1645
1646
|
*/
|
|
1646
1647
|
async getZoneById(
|
|
1647
1648
|
{ zoneId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1719,8 +1720,8 @@ class Serviceability {
|
|
|
1719
1720
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1720
1721
|
* @returns {Promise<ServiceabilityPlatformModel.ListViewResponse>} - Success response
|
|
1721
1722
|
* @name getZones
|
|
1722
|
-
* @summary:
|
|
1723
|
-
* @description:
|
|
1723
|
+
* @summary: Get zones
|
|
1724
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
|
|
1724
1725
|
*/
|
|
1725
1726
|
async getZones(
|
|
1726
1727
|
{
|
|
@@ -1840,8 +1841,8 @@ class Serviceability {
|
|
|
1840
1841
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1841
1842
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
1842
1843
|
* @name updateCompanyConfiguration
|
|
1843
|
-
* @summary:
|
|
1844
|
-
* @description:
|
|
1844
|
+
* @summary: Update delivery configuration
|
|
1845
|
+
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCompanyConfiguration/).
|
|
1845
1846
|
*/
|
|
1846
1847
|
async updateCompanyConfiguration(
|
|
1847
1848
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1924,8 +1925,8 @@ class Serviceability {
|
|
|
1924
1925
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
1925
1926
|
* Success response
|
|
1926
1927
|
* @name updateCourierPartnerAccount
|
|
1927
|
-
* @summary: Update
|
|
1928
|
-
* @description: Updates
|
|
1928
|
+
* @summary: Update courier account
|
|
1929
|
+
* @description: Updates an existing courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
1929
1930
|
*/
|
|
1930
1931
|
async updateCourierPartnerAccount(
|
|
1931
1932
|
{ accountId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2010,8 +2011,8 @@ class Serviceability {
|
|
|
2010
2011
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
2011
2012
|
* Success response
|
|
2012
2013
|
* @name updatePackageMaterialRule
|
|
2013
|
-
* @summary:
|
|
2014
|
-
* @description:
|
|
2014
|
+
* @summary: Update packaging rule
|
|
2015
|
+
* @description: Update an existing packaging rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterialRule/).
|
|
2015
2016
|
*/
|
|
2016
2017
|
async updatePackageMaterialRule(
|
|
2017
2018
|
{ ruleId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2097,8 +2098,8 @@ class Serviceability {
|
|
|
2097
2098
|
* - Success response
|
|
2098
2099
|
*
|
|
2099
2100
|
* @name updatePackageMaterials
|
|
2100
|
-
* @summary: Update
|
|
2101
|
-
* @description:
|
|
2101
|
+
* @summary: Update packaging material
|
|
2102
|
+
* @description: Update an existing packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterials/).
|
|
2102
2103
|
*/
|
|
2103
2104
|
async updatePackageMaterials(
|
|
2104
2105
|
{ packageMaterialId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2181,8 +2182,8 @@ class Serviceability {
|
|
|
2181
2182
|
* @returns {Promise<ServiceabilityPlatformModel.ServiceabilityModel>} -
|
|
2182
2183
|
* Success response
|
|
2183
2184
|
* @name updateServiceability
|
|
2184
|
-
* @summary: Serviceability
|
|
2185
|
-
* @description:
|
|
2185
|
+
* @summary: Update Serviceability of a locality
|
|
2186
|
+
* @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/).
|
|
2186
2187
|
*/
|
|
2187
2188
|
async updateServiceability(
|
|
2188
2189
|
{ extensionId, schemeId, regionId, body, requestHeaders } = {
|
|
@@ -2271,8 +2272,8 @@ class Serviceability {
|
|
|
2271
2272
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneSuccessResponse>} -
|
|
2272
2273
|
* Success response
|
|
2273
2274
|
* @name updateZoneById
|
|
2274
|
-
* @summary: Update
|
|
2275
|
-
* @description:
|
|
2275
|
+
* @summary: Update a zone
|
|
2276
|
+
* @description: Update an existing delivery zone . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateZoneById/).
|
|
2276
2277
|
*/
|
|
2277
2278
|
async updateZoneById(
|
|
2278
2279
|
{ zoneId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -53,7 +53,7 @@ declare class Share {
|
|
|
53
53
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
55
55
|
* @name updateShortLinkById
|
|
56
|
-
* @summary: Update short link
|
|
56
|
+
* @summary: Update short link
|
|
57
57
|
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
|
|
58
58
|
*/
|
|
59
59
|
updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
@@ -366,7 +366,7 @@ class Share {
|
|
|
366
366
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
367
367
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
368
368
|
* @name updateShortLinkById
|
|
369
|
-
* @summary: Update short link
|
|
369
|
+
* @summary: Update short link
|
|
370
370
|
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
|
|
371
371
|
*/
|
|
372
372
|
async updateShortLinkById(
|
|
@@ -60,6 +60,7 @@ export = SharePlatformModel;
|
|
|
60
60
|
* @typedef UrlInfo
|
|
61
61
|
* @property {string} [original]
|
|
62
62
|
* @property {string} [hash]
|
|
63
|
+
* @property {string} [short_url]
|
|
63
64
|
*/
|
|
64
65
|
/**
|
|
65
66
|
* @typedef ShortLinkRes
|
|
@@ -197,6 +198,7 @@ declare function UrlInfo(): UrlInfo;
|
|
|
197
198
|
type UrlInfo = {
|
|
198
199
|
original?: string;
|
|
199
200
|
hash?: string;
|
|
201
|
+
short_url?: string;
|
|
200
202
|
};
|
|
201
203
|
/** @returns {ShortLinkRes} */
|
|
202
204
|
declare function ShortLinkRes(): ShortLinkRes;
|