@gofynd/fdk-client-javascript 3.3.5 → 3.4.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 +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- 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 +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -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 +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- 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 +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -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 +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -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 +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- 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 +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -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 +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -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 +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -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 +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- 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 +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -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,9 +39,22 @@ 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
|
+
/**
|
|
46
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateFulfillmentOptionParam} arg
|
|
47
|
+
* - Arg object
|
|
48
|
+
*
|
|
49
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
51
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
52
|
+
* Success response
|
|
53
|
+
* @name createFulfillmentOption
|
|
54
|
+
* @summary: Create a new fulfillment option
|
|
55
|
+
* @description: Creates a new fulfillment option for the specified company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createFulfillmentOption/).
|
|
56
|
+
*/
|
|
57
|
+
createFulfillmentOption({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateFulfillmentOptionParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
45
58
|
/**
|
|
46
59
|
* @param {ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam} arg
|
|
47
60
|
* - Arg object
|
|
@@ -52,7 +65,7 @@ declare class Serviceability {
|
|
|
52
65
|
* Success response
|
|
53
66
|
* @name createGeoArea
|
|
54
67
|
* @summary: Creation of GeoArea
|
|
55
|
-
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions. - Check out [method documentation](https://
|
|
68
|
+
* @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
69
|
*/
|
|
57
70
|
createGeoArea({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaResponseBody>;
|
|
58
71
|
/**
|
|
@@ -66,7 +79,7 @@ declare class Serviceability {
|
|
|
66
79
|
*
|
|
67
80
|
* @name createGeoAreaExportJob
|
|
68
81
|
* @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://
|
|
82
|
+
* @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
83
|
*/
|
|
71
84
|
createGeoAreaExportJob({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaExportJobParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkCreationResult>;
|
|
72
85
|
/**
|
|
@@ -79,7 +92,7 @@ declare class Serviceability {
|
|
|
79
92
|
* Success response
|
|
80
93
|
* @name createStoreRules
|
|
81
94
|
* @summary: Create store rule
|
|
82
|
-
* @description: Create a rule within the order routing rules - Check out [method documentation](https://
|
|
95
|
+
* @description: Create a rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createStoreRules/).
|
|
83
96
|
*/
|
|
84
97
|
createStoreRules({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleResultSchema>;
|
|
85
98
|
/**
|
|
@@ -91,9 +104,23 @@ declare class Serviceability {
|
|
|
91
104
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneSchema>} - Success response
|
|
92
105
|
* @name createZone
|
|
93
106
|
* @summary: Create zone
|
|
94
|
-
* @description: Creates a delivery zone. - Check out [method documentation](https://
|
|
107
|
+
* @description: Creates a delivery zone. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZone/).
|
|
95
108
|
*/
|
|
96
109
|
createZone({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneSchema>;
|
|
110
|
+
/**
|
|
111
|
+
* @param {ServiceabilityPlatformApplicationValidator.DeleteFulfillmentOptionsParam} arg
|
|
112
|
+
* - Arg object
|
|
113
|
+
*
|
|
114
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
115
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
116
|
+
* @returns {Promise<ServiceabilityPlatformModel.OperationResponseSchema>}
|
|
117
|
+
* - Success response
|
|
118
|
+
*
|
|
119
|
+
* @name deleteFulfillmentOptions
|
|
120
|
+
* @summary: Delete fulfillment options
|
|
121
|
+
* @description: Deletes fulfillment options for provided slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteFulfillmentOptions/).
|
|
122
|
+
*/
|
|
123
|
+
deleteFulfillmentOptions({ slug, requestHeaders }?: ServiceabilityPlatformApplicationValidator.DeleteFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OperationResponseSchema>;
|
|
97
124
|
/**
|
|
98
125
|
* @param {ServiceabilityPlatformApplicationValidator.DeleteZoneParam} arg
|
|
99
126
|
* - Arg object
|
|
@@ -105,7 +132,7 @@ declare class Serviceability {
|
|
|
105
132
|
*
|
|
106
133
|
* @name deleteZone
|
|
107
134
|
* @summary: Delete a Specific Zone
|
|
108
|
-
* @description: Delete a Zone under that application. - Check out [method documentation](https://
|
|
135
|
+
* @description: Delete a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteZone/).
|
|
109
136
|
*/
|
|
110
137
|
deleteZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.DeleteZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneDeleteSuccessResult>;
|
|
111
138
|
/**
|
|
@@ -117,7 +144,7 @@ declare class Serviceability {
|
|
|
117
144
|
* @returns {Promise<string>} - Success response
|
|
118
145
|
* @name downloadGeoareaSampleFile
|
|
119
146
|
* @summary: Download geoarea sample file
|
|
120
|
-
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://
|
|
147
|
+
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/downloadGeoareaSampleFile/).
|
|
121
148
|
*/
|
|
122
149
|
downloadGeoareaSampleFile({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
|
|
123
150
|
/**
|
|
@@ -130,7 +157,7 @@ declare class Serviceability {
|
|
|
130
157
|
* Success response
|
|
131
158
|
* @name getApplicationConfig
|
|
132
159
|
* @summary: Get store rule configuration
|
|
133
|
-
* @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://
|
|
160
|
+
* @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
161
|
*/
|
|
135
162
|
getApplicationConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
136
163
|
/**
|
|
@@ -144,7 +171,7 @@ declare class Serviceability {
|
|
|
144
171
|
*
|
|
145
172
|
* @name getApplicationConfiguration
|
|
146
173
|
* @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://
|
|
174
|
+
* @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
175
|
*/
|
|
149
176
|
getApplicationConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigGetResult>;
|
|
150
177
|
/**
|
|
@@ -157,9 +184,23 @@ declare class Serviceability {
|
|
|
157
184
|
* Success response
|
|
158
185
|
* @name getBulkExport
|
|
159
186
|
* @summary: Get Bulk Export of Zones
|
|
160
|
-
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://
|
|
187
|
+
* @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
188
|
*/
|
|
162
189
|
getBulkExport({ batchId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkExportParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneBulkExport>;
|
|
190
|
+
/**
|
|
191
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetBulkFulfillmentValidationStatusParam} arg
|
|
192
|
+
* - Arg object
|
|
193
|
+
*
|
|
194
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
195
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
196
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidate>}
|
|
197
|
+
* - Success response
|
|
198
|
+
*
|
|
199
|
+
* @name getBulkFulfillmentValidationStatus
|
|
200
|
+
* @summary: Validate bulk fulfillment options.
|
|
201
|
+
* @description: Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkFulfillmentValidationStatus/).
|
|
202
|
+
*/
|
|
203
|
+
getBulkFulfillmentValidationStatus({ bulkId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkFulfillmentValidationStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidate>;
|
|
163
204
|
/**
|
|
164
205
|
* @param {ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam} arg
|
|
165
206
|
* - Arg object
|
|
@@ -170,7 +211,7 @@ declare class Serviceability {
|
|
|
170
211
|
* Success response
|
|
171
212
|
* @name getBulkGeoArea
|
|
172
213
|
* @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://
|
|
214
|
+
* @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
215
|
*/
|
|
175
216
|
getBulkGeoArea({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaGetResult>;
|
|
176
217
|
/**
|
|
@@ -184,7 +225,7 @@ declare class Serviceability {
|
|
|
184
225
|
*
|
|
185
226
|
* @name getCourierPartnerRule
|
|
186
227
|
* @summary: Get courier rule
|
|
187
|
-
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://
|
|
228
|
+
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRule/).
|
|
188
229
|
*/
|
|
189
230
|
getCourierPartnerRule({ ruleUid, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
190
231
|
/**
|
|
@@ -198,7 +239,7 @@ declare class Serviceability {
|
|
|
198
239
|
*
|
|
199
240
|
* @name getCourierPartnerRules
|
|
200
241
|
* @summary: Get courier rules
|
|
201
|
-
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://
|
|
242
|
+
* @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
243
|
*/
|
|
203
244
|
getCourierPartnerRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRulesListResult>;
|
|
204
245
|
/**
|
|
@@ -212,9 +253,50 @@ declare class Serviceability {
|
|
|
212
253
|
*
|
|
213
254
|
* @name getCourierPartners
|
|
214
255
|
* @summary: Serviceable Courier Partners
|
|
215
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://
|
|
256
|
+
* @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
257
|
*/
|
|
217
258
|
getCourierPartners({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnersParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ShipmentCourierPartnerResult>;
|
|
259
|
+
/**
|
|
260
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionProductsParam} arg
|
|
261
|
+
* - Arg object
|
|
262
|
+
*
|
|
263
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
264
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
265
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionProducts>}
|
|
266
|
+
* - Success response
|
|
267
|
+
*
|
|
268
|
+
* @name getFulfillmentOptionProducts
|
|
269
|
+
* @summary: Get products for a specific fulfillment option.
|
|
270
|
+
* @description: Retrieves products available for a specific fulfillment option in an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionProducts/).
|
|
271
|
+
*/
|
|
272
|
+
getFulfillmentOptionProducts({ slug, storeId, q, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionProductsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionProducts>;
|
|
273
|
+
/**
|
|
274
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionStoresParam} arg
|
|
275
|
+
* - Arg object
|
|
276
|
+
*
|
|
277
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
278
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
279
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionStores>}
|
|
280
|
+
* - Success response
|
|
281
|
+
*
|
|
282
|
+
* @name getFulfillmentOptionStores
|
|
283
|
+
* @summary: Get stores for a specific fulfillment option.
|
|
284
|
+
* @description: Retrieves stores available for a specific fulfillment option in an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionStores/).
|
|
285
|
+
*/
|
|
286
|
+
getFulfillmentOptionStores({ slug, q, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionStoresParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionStores>;
|
|
287
|
+
/**
|
|
288
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsParam} arg
|
|
289
|
+
* - Arg object
|
|
290
|
+
*
|
|
291
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
292
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
293
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
294
|
+
* Success response
|
|
295
|
+
* @name getFulfillmentOptions
|
|
296
|
+
* @summary: Get fulfillment options
|
|
297
|
+
* @description: Fetches available fulfillment options for a given product and store. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptions/).
|
|
298
|
+
*/
|
|
299
|
+
getFulfillmentOptions({ slug, productId, storeId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
218
300
|
/**
|
|
219
301
|
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreaParam} arg
|
|
220
302
|
* - Arg object
|
|
@@ -224,7 +306,7 @@ declare class Serviceability {
|
|
|
224
306
|
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaDetails>} - Success response
|
|
225
307
|
* @name getGeoArea
|
|
226
308
|
* @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://
|
|
309
|
+
* @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
310
|
*/
|
|
229
311
|
getGeoArea({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaDetails>;
|
|
230
312
|
/**
|
|
@@ -238,7 +320,7 @@ declare class Serviceability {
|
|
|
238
320
|
*
|
|
239
321
|
* @name getGeoAreaExportJobStatus
|
|
240
322
|
* @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://
|
|
323
|
+
* @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
324
|
*/
|
|
243
325
|
getGeoAreaExportJobStatus({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetGeoAreaExportJobStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkExportResult>;
|
|
244
326
|
/**
|
|
@@ -251,7 +333,7 @@ declare class Serviceability {
|
|
|
251
333
|
* Success response
|
|
252
334
|
* @name getGeoAreas
|
|
253
335
|
* @summary: Get all geoareas in the current application
|
|
254
|
-
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://
|
|
336
|
+
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreas/).
|
|
255
337
|
*/
|
|
256
338
|
getGeoAreas({ pageSize, isActive, pageNo, type, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetGeoAreasParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaGetResponseBody>;
|
|
257
339
|
/**
|
|
@@ -264,7 +346,7 @@ declare class Serviceability {
|
|
|
264
346
|
* Success response
|
|
265
347
|
* @name getStoreRule
|
|
266
348
|
* @summary: Get store rule
|
|
267
|
-
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://
|
|
349
|
+
* @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
350
|
*/
|
|
269
351
|
getStoreRule({ ruleUid, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleDataSchema>;
|
|
270
352
|
/**
|
|
@@ -277,7 +359,7 @@ declare class Serviceability {
|
|
|
277
359
|
* Success response
|
|
278
360
|
* @name getStoreRules
|
|
279
361
|
* @summary: Get store rules
|
|
280
|
-
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://
|
|
362
|
+
* @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
363
|
*/
|
|
282
364
|
getStoreRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoreRulesApiResult>;
|
|
283
365
|
/**
|
|
@@ -288,7 +370,7 @@ declare class Serviceability {
|
|
|
288
370
|
* Success response
|
|
289
371
|
* @name getZone
|
|
290
372
|
* @summary: Get zone details
|
|
291
|
-
* @description: Retrieves a single delivery zone - Check out [method documentation](https://
|
|
373
|
+
* @description: Retrieves a single delivery zone - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZone/).
|
|
292
374
|
*/
|
|
293
375
|
getZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
|
|
294
376
|
/**
|
|
@@ -298,9 +380,9 @@ declare class Serviceability {
|
|
|
298
380
|
* @returns {Promise<ServiceabilityPlatformModel.ListViewSchema>} - Success response
|
|
299
381
|
* @name getZones
|
|
300
382
|
* @summary: Get zones
|
|
301
|
-
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://
|
|
383
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZones/).
|
|
302
384
|
*/
|
|
303
|
-
getZones({ stage, pageSize, pageNo, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewSchema>;
|
|
385
|
+
getZones({ stage, pageSize, pageNo, fulfillmentOptionSlug, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewSchema>;
|
|
304
386
|
/**
|
|
305
387
|
* @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
|
|
306
388
|
* - Arg object
|
|
@@ -311,7 +393,7 @@ declare class Serviceability {
|
|
|
311
393
|
* Success response
|
|
312
394
|
* @name insertApplicationConfig
|
|
313
395
|
* @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://
|
|
396
|
+
* @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
397
|
*/
|
|
316
398
|
insertApplicationConfig({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
317
399
|
/**
|
|
@@ -325,9 +407,22 @@ declare class Serviceability {
|
|
|
325
407
|
*
|
|
326
408
|
* @name patchApplicationConfiguration
|
|
327
409
|
* @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://
|
|
410
|
+
* @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
411
|
*/
|
|
330
412
|
patchApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>;
|
|
413
|
+
/**
|
|
414
|
+
* @param {ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam} arg
|
|
415
|
+
* - Arg object
|
|
416
|
+
*
|
|
417
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
418
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
419
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
420
|
+
* Success response
|
|
421
|
+
* @name putFulfillmentOption
|
|
422
|
+
* @summary: Update an existing fulfillment option
|
|
423
|
+
* @description: Updates the details of an existing fulfillment option for the specified company and application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/putFulfillmentOption/).
|
|
424
|
+
*/
|
|
425
|
+
putFulfillmentOption({ slug, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
331
426
|
/**
|
|
332
427
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam} arg
|
|
333
428
|
* - Arg object
|
|
@@ -338,7 +433,7 @@ declare class Serviceability {
|
|
|
338
433
|
* Success response
|
|
339
434
|
* @name updateApplicationConfiguration
|
|
340
435
|
* @summary: Apply configuration to an application
|
|
341
|
-
* @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://
|
|
436
|
+
* @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
437
|
*/
|
|
343
438
|
updateApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPut>;
|
|
344
439
|
/**
|
|
@@ -351,7 +446,7 @@ declare class Serviceability {
|
|
|
351
446
|
* Success response
|
|
352
447
|
* @name updateBulkGeoArea
|
|
353
448
|
* @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://
|
|
449
|
+
* @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
450
|
*/
|
|
356
451
|
updateBulkGeoArea({ geoareaId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateBulkGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkGeoAreaResult>;
|
|
357
452
|
/**
|
|
@@ -364,7 +459,7 @@ declare class Serviceability {
|
|
|
364
459
|
* Success response
|
|
365
460
|
* @name updateCourierPartnerRulePriority
|
|
366
461
|
* @summary: Update courier partner rule priority
|
|
367
|
-
* @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://
|
|
462
|
+
* @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
463
|
*/
|
|
369
464
|
updateCourierPartnerRulePriority({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierPartnerRulePriorityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.RulePriorityResult>;
|
|
370
465
|
/**
|
|
@@ -378,7 +473,7 @@ declare class Serviceability {
|
|
|
378
473
|
*
|
|
379
474
|
* @name updateCourierRule
|
|
380
475
|
* @summary: Update courier rule
|
|
381
|
-
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://
|
|
476
|
+
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierRule/).
|
|
382
477
|
*/
|
|
383
478
|
updateCourierRule({ ruleUid, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
384
479
|
/**
|
|
@@ -391,7 +486,7 @@ declare class Serviceability {
|
|
|
391
486
|
* Success response
|
|
392
487
|
* @name updateGeoArea
|
|
393
488
|
* @summary: Update the details of existing GeoArea
|
|
394
|
-
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://
|
|
489
|
+
* @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
490
|
*/
|
|
396
491
|
updateGeoArea({ geoareaId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateGeoAreaParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaPutResponseBody>;
|
|
397
492
|
/**
|
|
@@ -405,7 +500,7 @@ declare class Serviceability {
|
|
|
405
500
|
*
|
|
406
501
|
* @name updatePincodeAuditHistory
|
|
407
502
|
* @summary: Get audit trail
|
|
408
|
-
* @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://
|
|
503
|
+
* @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
504
|
*/
|
|
410
505
|
updatePincodeAuditHistory({ body, pageNumber, pageSize, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResultData>;
|
|
411
506
|
/**
|
|
@@ -418,7 +513,7 @@ declare class Serviceability {
|
|
|
418
513
|
* Success response
|
|
419
514
|
* @name updatePincodeBulkView
|
|
420
515
|
* @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://
|
|
516
|
+
* @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
517
|
*/
|
|
423
518
|
updatePincodeBulkView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeBulkViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeBulkViewResult>;
|
|
424
519
|
/**
|
|
@@ -432,7 +527,7 @@ declare class Serviceability {
|
|
|
432
527
|
*
|
|
433
528
|
* @name updatePincodeCoDListing
|
|
434
529
|
* @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://
|
|
530
|
+
* @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
531
|
*/
|
|
437
532
|
updatePincodeCoDListing({ body, pageNumber, pageSize, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeCoDListingParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeCodStatusListingResult>;
|
|
438
533
|
/**
|
|
@@ -444,7 +539,7 @@ declare class Serviceability {
|
|
|
444
539
|
* @returns {Promise<ServiceabilityPlatformModel.PincodeMOPResult>} - Success response
|
|
445
540
|
* @name updatePincodeMopView
|
|
446
541
|
* @summary: Update pincode COD support
|
|
447
|
-
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://
|
|
542
|
+
* @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
543
|
*/
|
|
449
544
|
updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMOPResult>;
|
|
450
545
|
/**
|
|
@@ -457,7 +552,7 @@ declare class Serviceability {
|
|
|
457
552
|
* Success response
|
|
458
553
|
* @name updateStoreRulePriority
|
|
459
554
|
* @summary: Update Store Rule priority
|
|
460
|
-
* @description: Update Store Rule priority - Check out [method documentation](https://
|
|
555
|
+
* @description: Update Store Rule priority - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRulePriority/).
|
|
461
556
|
*/
|
|
462
557
|
updateStoreRulePriority({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulePriorityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.RulePriorityResult>;
|
|
463
558
|
/**
|
|
@@ -471,7 +566,7 @@ declare class Serviceability {
|
|
|
471
566
|
*
|
|
472
567
|
* @name updateStoreRules
|
|
473
568
|
* @summary: Update store rule
|
|
474
|
-
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://
|
|
569
|
+
* @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
570
|
*/
|
|
476
571
|
updateStoreRules({ ruleUid, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleUpdateResultSchema>;
|
|
477
572
|
/**
|
|
@@ -484,7 +579,7 @@ declare class Serviceability {
|
|
|
484
579
|
* Success response
|
|
485
580
|
* @name updateStoreRulesConfig
|
|
486
581
|
* @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://
|
|
582
|
+
* @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
583
|
*/
|
|
489
584
|
updateStoreRulesConfig({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateStoreRulesConfigParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StoreRuleConfigData>;
|
|
490
585
|
/**
|
|
@@ -498,9 +593,37 @@ declare class Serviceability {
|
|
|
498
593
|
*
|
|
499
594
|
* @name updateZone
|
|
500
595
|
* @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://
|
|
596
|
+
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateZone/).
|
|
502
597
|
*/
|
|
503
598
|
updateZone({ zoneId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneUpdateSuccessResult>;
|
|
599
|
+
/**
|
|
600
|
+
* @param {ServiceabilityPlatformApplicationValidator.UploadBulkFulfillmentOptionsParam} arg
|
|
601
|
+
* - Arg object
|
|
602
|
+
*
|
|
603
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
604
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
605
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkData>}
|
|
606
|
+
* - Success response
|
|
607
|
+
*
|
|
608
|
+
* @name uploadBulkFulfillmentOptions
|
|
609
|
+
* @summary: Upload bulk fulfillment options.
|
|
610
|
+
* @description: Uploads a bulk list of fulfillment options for an application, allowing multiple fulfillment configurations to be processed at once. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/uploadBulkFulfillmentOptions/).
|
|
611
|
+
*/
|
|
612
|
+
uploadBulkFulfillmentOptions({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UploadBulkFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkData>;
|
|
613
|
+
/**
|
|
614
|
+
* @param {ServiceabilityPlatformApplicationValidator.ValidateBulkFulfillmentOptionsParam} arg
|
|
615
|
+
* - Arg object
|
|
616
|
+
*
|
|
617
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
618
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
619
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidateData>}
|
|
620
|
+
* - Success response
|
|
621
|
+
*
|
|
622
|
+
* @name validateBulkFulfillmentOptions
|
|
623
|
+
* @summary: Validate bulk fulfillment options.
|
|
624
|
+
* @description: Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/validateBulkFulfillmentOptions/).
|
|
625
|
+
*/
|
|
626
|
+
validateBulkFulfillmentOptions({ type, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.ValidateBulkFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidateData>;
|
|
504
627
|
}
|
|
505
628
|
import ServiceabilityPlatformApplicationValidator = require("./ServiceabilityPlatformApplicationValidator");
|
|
506
629
|
import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|