@gofynd/fdk-client-javascript 3.3.3 → 3.3.6
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 +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -12,7 +12,7 @@ declare class Serviceability {
|
|
|
12
12
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneBulkExport>} - Success response
|
|
13
13
|
* @name createBulkExport
|
|
14
14
|
* @summary: Create Bulk Export of Zones
|
|
15
|
-
* @description: Export zones defined at the application level. - Check out [method documentation](https://
|
|
15
|
+
* @description: Export zones defined at the application level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createBulkExport/).
|
|
16
16
|
*/
|
|
17
17
|
createBulkExport({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateBulkExportParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneBulkExport>;
|
|
18
18
|
/**
|
|
@@ -25,7 +25,7 @@ declare class Serviceability {
|
|
|
25
25
|
* Success response
|
|
26
26
|
* @name createBulkGeoArea
|
|
27
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://
|
|
28
|
+
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createBulkGeoArea/).
|
|
29
29
|
*/
|
|
30
30
|
createBulkGeoArea({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>;
|
|
31
31
|
/**
|
|
@@ -39,7 +39,7 @@ declare class Serviceability {
|
|
|
39
39
|
*
|
|
40
40
|
* @name createCourierPartnerRule
|
|
41
41
|
* @summary: Create courier rule
|
|
42
|
-
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://
|
|
42
|
+
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerRule/).
|
|
43
43
|
*/
|
|
44
44
|
createCourierPartnerRule({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
45
45
|
/**
|
|
@@ -52,7 +52,7 @@ declare class Serviceability {
|
|
|
52
52
|
* Success response
|
|
53
53
|
* @name createGeoArea
|
|
54
54
|
* @summary: Creation of GeoArea
|
|
55
|
-
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions. - Check out [method documentation](https://
|
|
55
|
+
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createGeoArea/).
|
|
56
56
|
*/
|
|
57
57
|
createGeoArea({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaResponseBody>;
|
|
58
58
|
/**
|
|
@@ -66,7 +66,7 @@ declare class Serviceability {
|
|
|
66
66
|
*
|
|
67
67
|
* @name createGeoAreaExportJob
|
|
68
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://
|
|
69
|
+
* @description: Create the job for exporting the regions in Geoarea in CSV format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createGeoAreaExportJob/).
|
|
70
70
|
*/
|
|
71
71
|
createGeoAreaExportJob({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaExportJobParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkCreationResult>;
|
|
72
72
|
/**
|
|
@@ -79,7 +79,7 @@ declare class Serviceability {
|
|
|
79
79
|
* Success response
|
|
80
80
|
* @name createStoreRules
|
|
81
81
|
* @summary: Create store rule
|
|
82
|
-
* @description: Create a rule within the order routing rules - Check out [method documentation](https://
|
|
82
|
+
* @description: Create a rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createStoreRules/).
|
|
83
83
|
*/
|
|
84
84
|
createStoreRules({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleResultSchema>;
|
|
85
85
|
/**
|
|
@@ -91,7 +91,7 @@ declare class Serviceability {
|
|
|
91
91
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneSchema>} - Success response
|
|
92
92
|
* @name createZone
|
|
93
93
|
* @summary: Create zone
|
|
94
|
-
* @description: Creates a delivery zone. - Check out [method documentation](https://
|
|
94
|
+
* @description: Creates a delivery zone. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZone/).
|
|
95
95
|
*/
|
|
96
96
|
createZone({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneSchema>;
|
|
97
97
|
/**
|
|
@@ -105,7 +105,7 @@ declare class Serviceability {
|
|
|
105
105
|
*
|
|
106
106
|
* @name deleteZone
|
|
107
107
|
* @summary: Delete a Specific Zone
|
|
108
|
-
* @description: Delete a Zone under that application. - Check out [method documentation](https://
|
|
108
|
+
* @description: Delete a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteZone/).
|
|
109
109
|
*/
|
|
110
110
|
deleteZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.DeleteZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneDeleteSuccessResult>;
|
|
111
111
|
/**
|
|
@@ -117,7 +117,7 @@ declare class Serviceability {
|
|
|
117
117
|
* @returns {Promise<string>} - Success response
|
|
118
118
|
* @name downloadGeoareaSampleFile
|
|
119
119
|
* @summary: Download geoarea sample file
|
|
120
|
-
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://
|
|
120
|
+
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/downloadGeoareaSampleFile/).
|
|
121
121
|
*/
|
|
122
122
|
downloadGeoareaSampleFile({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
|
|
123
123
|
/**
|
|
@@ -130,7 +130,7 @@ declare class Serviceability {
|
|
|
130
130
|
* Success response
|
|
131
131
|
* @name getApplicationConfig
|
|
132
132
|
* @summary: Get store rule configuration
|
|
133
|
-
* @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://
|
|
133
|
+
* @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationConfig/).
|
|
134
134
|
*/
|
|
135
135
|
getApplicationConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
136
136
|
/**
|
|
@@ -144,7 +144,7 @@ declare class Serviceability {
|
|
|
144
144
|
*
|
|
145
145
|
* @name getApplicationConfiguration
|
|
146
146
|
* @summary: Get delivery configuration
|
|
147
|
-
* @description: This API returns all the Application config that has been applied to the given company and application. - Check out [method documentation](https://
|
|
147
|
+
* @description: This API returns all the Application config that has been applied to the given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationConfiguration/).
|
|
148
148
|
*/
|
|
149
149
|
getApplicationConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigGetResult>;
|
|
150
150
|
/**
|
|
@@ -157,7 +157,7 @@ declare class Serviceability {
|
|
|
157
157
|
* Success response
|
|
158
158
|
* @name getBulkExport
|
|
159
159
|
* @summary: Get Bulk Export of Zones
|
|
160
|
-
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://
|
|
160
|
+
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkExport/).
|
|
161
161
|
*/
|
|
162
162
|
getBulkExport({ batchId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkExportParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneBulkExport>;
|
|
163
163
|
/**
|
|
@@ -170,7 +170,7 @@ declare class Serviceability {
|
|
|
170
170
|
* Success response
|
|
171
171
|
* @name getBulkGeoArea
|
|
172
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://
|
|
173
|
+
* @description: Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkGeoArea/).
|
|
174
174
|
*/
|
|
175
175
|
getBulkGeoArea({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaGetResult>;
|
|
176
176
|
/**
|
|
@@ -184,7 +184,7 @@ declare class Serviceability {
|
|
|
184
184
|
*
|
|
185
185
|
* @name getCourierPartnerRule
|
|
186
186
|
* @summary: Get courier rule
|
|
187
|
-
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://
|
|
187
|
+
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRule/).
|
|
188
188
|
*/
|
|
189
189
|
getCourierPartnerRule({ ruleUid, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
190
190
|
/**
|
|
@@ -198,7 +198,7 @@ declare class Serviceability {
|
|
|
198
198
|
*
|
|
199
199
|
* @name getCourierPartnerRules
|
|
200
200
|
* @summary: Get courier rules
|
|
201
|
-
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://
|
|
201
|
+
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRules/).
|
|
202
202
|
*/
|
|
203
203
|
getCourierPartnerRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRulesListResult>;
|
|
204
204
|
/**
|
|
@@ -212,7 +212,7 @@ declare class Serviceability {
|
|
|
212
212
|
*
|
|
213
213
|
* @name getCourierPartners
|
|
214
214
|
* @summary: Serviceable Courier Partners
|
|
215
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://
|
|
215
|
+
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartners/).
|
|
216
216
|
*/
|
|
217
217
|
getCourierPartners({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnersParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ShipmentCourierPartnerResult>;
|
|
218
218
|
/**
|
|
@@ -224,7 +224,7 @@ declare class Serviceability {
|
|
|
224
224
|
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaDetails>} - Success response
|
|
225
225
|
* @name getGeoArea
|
|
226
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://
|
|
227
|
+
* @description: This API Returns the data of the specific GeoArea which exists on the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoArea/).
|
|
228
228
|
*/
|
|
229
229
|
getGeoArea({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaDetails>;
|
|
230
230
|
/**
|
|
@@ -238,7 +238,7 @@ declare class Serviceability {
|
|
|
238
238
|
*
|
|
239
239
|
* @name getGeoAreaExportJobStatus
|
|
240
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://
|
|
241
|
+
* @description: Get the status and details of the Geoarea bulk export process. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreaExportJobStatus/).
|
|
242
242
|
*/
|
|
243
243
|
getGeoAreaExportJobStatus({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetGeoAreaExportJobStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkExportResult>;
|
|
244
244
|
/**
|
|
@@ -251,7 +251,7 @@ declare class Serviceability {
|
|
|
251
251
|
* Success response
|
|
252
252
|
* @name getGeoAreas
|
|
253
253
|
* @summary: Get all geoareas in the current application
|
|
254
|
-
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://
|
|
254
|
+
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreas/).
|
|
255
255
|
*/
|
|
256
256
|
getGeoAreas({ pageSize, isActive, pageNo, type, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetGeoAreasParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaGetResponseBody>;
|
|
257
257
|
/**
|
|
@@ -264,7 +264,7 @@ declare class Serviceability {
|
|
|
264
264
|
* Success response
|
|
265
265
|
* @name getStoreRule
|
|
266
266
|
* @summary: Get store rule
|
|
267
|
-
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://
|
|
267
|
+
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getStoreRule/).
|
|
268
268
|
*/
|
|
269
269
|
getStoreRule({ ruleUid, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleDataSchema>;
|
|
270
270
|
/**
|
|
@@ -277,7 +277,7 @@ declare class Serviceability {
|
|
|
277
277
|
* Success response
|
|
278
278
|
* @name getStoreRules
|
|
279
279
|
* @summary: Get store rules
|
|
280
|
-
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://
|
|
280
|
+
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getStoreRules/).
|
|
281
281
|
*/
|
|
282
282
|
getStoreRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoreRulesApiResult>;
|
|
283
283
|
/**
|
|
@@ -288,7 +288,7 @@ declare class Serviceability {
|
|
|
288
288
|
* Success response
|
|
289
289
|
* @name getZone
|
|
290
290
|
* @summary: Get zone details
|
|
291
|
-
* @description: Retrieves a single delivery zone - Check out [method documentation](https://
|
|
291
|
+
* @description: Retrieves a single delivery zone - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZone/).
|
|
292
292
|
*/
|
|
293
293
|
getZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
|
|
294
294
|
/**
|
|
@@ -298,7 +298,7 @@ declare class Serviceability {
|
|
|
298
298
|
* @returns {Promise<ServiceabilityPlatformModel.ListViewSchema>} - Success response
|
|
299
299
|
* @name getZones
|
|
300
300
|
* @summary: Get zones
|
|
301
|
-
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://
|
|
301
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZones/).
|
|
302
302
|
*/
|
|
303
303
|
getZones({ stage, pageSize, pageNo, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewSchema>;
|
|
304
304
|
/**
|
|
@@ -311,7 +311,7 @@ declare class Serviceability {
|
|
|
311
311
|
* Success response
|
|
312
312
|
* @name insertApplicationConfig
|
|
313
313
|
* @summary: Create store rule configuration
|
|
314
|
-
* @description: Creates a order routing setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://
|
|
314
|
+
* @description: Creates a order routing setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/insertApplicationConfig/).
|
|
315
315
|
*/
|
|
316
316
|
insertApplicationConfig({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
317
317
|
/**
|
|
@@ -325,7 +325,7 @@ declare class Serviceability {
|
|
|
325
325
|
*
|
|
326
326
|
* @name patchApplicationConfiguration
|
|
327
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchApplicationConfiguration/).
|
|
329
329
|
*/
|
|
330
330
|
patchApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>;
|
|
331
331
|
/**
|
|
@@ -338,7 +338,7 @@ declare class Serviceability {
|
|
|
338
338
|
* Success response
|
|
339
339
|
* @name updateApplicationConfiguration
|
|
340
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://
|
|
341
|
+
* @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateApplicationConfiguration/).
|
|
342
342
|
*/
|
|
343
343
|
updateApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPut>;
|
|
344
344
|
/**
|
|
@@ -351,7 +351,7 @@ declare class Serviceability {
|
|
|
351
351
|
* Success response
|
|
352
352
|
* @name updateBulkGeoArea
|
|
353
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://
|
|
354
|
+
* @description: Update geoarea details and their associated regions through a CSV file in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateBulkGeoArea/).
|
|
355
355
|
*/
|
|
356
356
|
updateBulkGeoArea({ geoareaId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>;
|
|
357
357
|
/**
|
|
@@ -364,7 +364,7 @@ declare class Serviceability {
|
|
|
364
364
|
* Success response
|
|
365
365
|
* @name updateCourierPartnerRulePriority
|
|
366
366
|
* @summary: Update courier partner rule priority
|
|
367
|
-
* @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://
|
|
367
|
+
* @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerRulePriority/).
|
|
368
368
|
*/
|
|
369
369
|
updateCourierPartnerRulePriority({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierPartnerRulePriorityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.RulePriorityResult>;
|
|
370
370
|
/**
|
|
@@ -378,7 +378,7 @@ declare class Serviceability {
|
|
|
378
378
|
*
|
|
379
379
|
* @name updateCourierRule
|
|
380
380
|
* @summary: Update courier rule
|
|
381
|
-
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://
|
|
381
|
+
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierRule/).
|
|
382
382
|
*/
|
|
383
383
|
updateCourierRule({ ruleUid, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
384
384
|
/**
|
|
@@ -391,7 +391,7 @@ declare class Serviceability {
|
|
|
391
391
|
* Success response
|
|
392
392
|
* @name updateGeoArea
|
|
393
393
|
* @summary: Update the details of existing GeoArea
|
|
394
|
-
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://
|
|
394
|
+
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateGeoArea/).
|
|
395
395
|
*/
|
|
396
396
|
updateGeoArea({ geoareaId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaPutResponseBody>;
|
|
397
397
|
/**
|
|
@@ -405,7 +405,7 @@ declare class Serviceability {
|
|
|
405
405
|
*
|
|
406
406
|
* @name updatePincodeAuditHistory
|
|
407
407
|
* @summary: Get audit trail
|
|
408
|
-
* @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://
|
|
408
|
+
* @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeAuditHistory/).
|
|
409
409
|
*/
|
|
410
410
|
updatePincodeAuditHistory({ body, pageNumber, pageSize, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResultData>;
|
|
411
411
|
/**
|
|
@@ -418,7 +418,7 @@ declare class Serviceability {
|
|
|
418
418
|
* Success response
|
|
419
419
|
* @name updatePincodeBulkView
|
|
420
420
|
* @summary: Bulk update pincode COD support
|
|
421
|
-
* @description: Updates the cash on delivery settings for multiple specified pin codes simultaneously. - Check out [method documentation](https://
|
|
421
|
+
* @description: Updates the cash on delivery settings for multiple specified pin codes simultaneously. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeBulkView/).
|
|
422
422
|
*/
|
|
423
423
|
updatePincodeBulkView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeBulkViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeBulkViewResult>;
|
|
424
424
|
/**
|
|
@@ -432,7 +432,7 @@ declare class Serviceability {
|
|
|
432
432
|
*
|
|
433
433
|
* @name updatePincodeCoDListing
|
|
434
434
|
* @summary: Get COD enabled pincodes
|
|
435
|
-
* @description: Retrieves a list of pincodes along with the count based on whether cash on delivery settings. - Check out [method documentation](https://
|
|
435
|
+
* @description: Retrieves a list of pincodes along with the count based on whether cash on delivery settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeCoDListing/).
|
|
436
436
|
*/
|
|
437
437
|
updatePincodeCoDListing({ body, pageNumber, pageSize, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeCoDListingParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeCodStatusListingResult>;
|
|
438
438
|
/**
|
|
@@ -444,7 +444,7 @@ declare class Serviceability {
|
|
|
444
444
|
* @returns {Promise<ServiceabilityPlatformModel.PincodeMOPResult>} - Success response
|
|
445
445
|
* @name updatePincodeMopView
|
|
446
446
|
* @summary: Update pincode COD support
|
|
447
|
-
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://
|
|
447
|
+
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeMopView/).
|
|
448
448
|
*/
|
|
449
449
|
updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMOPResult>;
|
|
450
450
|
/**
|
|
@@ -457,7 +457,7 @@ declare class Serviceability {
|
|
|
457
457
|
* Success response
|
|
458
458
|
* @name updateStoreRulePriority
|
|
459
459
|
* @summary: Update Store Rule priority
|
|
460
|
-
* @description: Update Store Rule priority - Check out [method documentation](https://
|
|
460
|
+
* @description: Update Store Rule priority - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRulePriority/).
|
|
461
461
|
*/
|
|
462
462
|
updateStoreRulePriority({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulePriorityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.RulePriorityResult>;
|
|
463
463
|
/**
|
|
@@ -471,7 +471,7 @@ declare class Serviceability {
|
|
|
471
471
|
*
|
|
472
472
|
* @name updateStoreRules
|
|
473
473
|
* @summary: Update store rule
|
|
474
|
-
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://
|
|
474
|
+
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRules/).
|
|
475
475
|
*/
|
|
476
476
|
updateStoreRules({ ruleUid, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleUpdateResultSchema>;
|
|
477
477
|
/**
|
|
@@ -484,7 +484,7 @@ declare class Serviceability {
|
|
|
484
484
|
* Success response
|
|
485
485
|
* @name updateStoreRulesConfig
|
|
486
486
|
* @summary: Update store rules configuration
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRulesConfig/).
|
|
488
488
|
*/
|
|
489
489
|
updateStoreRulesConfig({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulesConfigParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
490
490
|
/**
|
|
@@ -498,7 +498,7 @@ declare class Serviceability {
|
|
|
498
498
|
*
|
|
499
499
|
* @name updateZone
|
|
500
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://
|
|
501
|
+
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateZone/).
|
|
502
502
|
*/
|
|
503
503
|
updateZone({ zoneId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneUpdateSuccessResult>;
|
|
504
504
|
}
|